OpenCMISS-Iron Python Bindings API Documentation
iron.Decomposition Class Reference
Inheritance diagram for iron.Decomposition:
Collaboration diagram for iron.Decomposition:

Public Member Functions

def __init__ (self)
 
def CalculateFacesSet (self, calculateFacesFlag)
 
def CalculateLinesSet (self, calculateLinesFlag)
 
def CreateFinish (self)
 
def CreateStart (self, decompositionUserNumber, mesh)
 
def Destroy (self)
 
def ElementDomainCalculate (self)
 
def ElementDomainGet (self, elementUserNumber)
 
def ElementDomainSet (self, elementUserNumber, domain)
 
def Finalise (self)
 
def MeshComponentGet (self)
 
def MeshComponentSet (self, meshComponentNumber)
 
def NodeDomainGet (self, nodeUserNumber, meshComponentNumber)
 
def NumberOfDomainsGet (self)
 
def NumberOfDomainsSet (self, numberOfDomains)
 
def TopologyDataProjectionCalculate (self)
 
def TopologyElementDataPointLocalNumberGet (self, elementNumber, dataPointIndex)
 
def TopologyElementDataPointUserNumberGet (self, elementNumber, dataPointIndex)
 
def TopologyNumberOfElementDataPointsGet (self, elementNumber)
 
def TypeGet (self)
 
def TypeSet (self, decompositionType)
 
def WorldWorkGroupSet (self, worldWorkGroup)
 

Public Attributes

 cmiss_type
 

Properties

 worldWorkGroup = property(None, WorldWorkGroupSet, None, )
 
 calculateFaces = property(None, CalculateFacesSet, None, )
 
 type = property(TypeGet, TypeSet, None, )
 
 calculateLines = property(None, CalculateLinesSet, None, )
 
 numberOfDomains = property(NumberOfDomainsGet, NumberOfDomainsSet, None, )
 
 meshComponent = property(MeshComponentGet, MeshComponentSet, None, )
 

Detailed Description

Contains information on the mesh decomposition.

Definition at line 1883 of file iron.py.

Constructor & Destructor Documentation

def iron.Decomposition.__init__ (   self)
Initialise a null cmfe_DecompositionType

Definition at line 1887 of file iron.py.

Member Function Documentation

def iron.Decomposition.CalculateFacesSet (   self,
  calculateFacesFlag 
)
Sets whether faces should be calculated

:param calculateFacesFlag: Boolean to determine whether to set faces to be calculated.
:type calculateFacesFlag: bool
:rtype: None

Definition at line 1892 of file iron.py.

def iron.Decomposition.CalculateLinesSet (   self,
  calculateLinesFlag 
)
Sets whether lines should be calculated

:param calculateLinesFlag: Boolean to determine whether to set lines to be calculated.
:type calculateLinesFlag: bool
:rtype: None

Definition at line 1903 of file iron.py.

def iron.Decomposition.CreateFinish (   self)
Finishes the creation of a domain decomposition for a decomposition identified by an object.

:rtype: None

Definition at line 1914 of file iron.py.

def iron.Decomposition.CreateStart (   self,
  decompositionUserNumber,
  mesh 
)
Starts the creation of a domain decomposition for a decomposition identified by an object.

:param decompositionUserNumber: The user number of the decomposition to create.
:type decompositionUserNumber: int
:param mesh: The mesh to create the decomposition for.
:type mesh: Mesh
:rtype: None

Definition at line 1923 of file iron.py.

def iron.Decomposition.Destroy (   self)
Destroys a decomposition identified by an object.

:rtype: None

Definition at line 1936 of file iron.py.

def iron.Decomposition.ElementDomainCalculate (   self)
Calculates the element domains for a decomposition identified by an object.

:rtype: None

Definition at line 1945 of file iron.py.

def iron.Decomposition.ElementDomainGet (   self,
  elementUserNumber 
)
Returns the domain for a given element in a decomposition identified by an object.

:param elementUserNumber: The user number of the element to get the domain for.
:type elementUserNumber: int
:returns: domain. The computational domain of the element.
:rtype: int

Definition at line 1954 of file iron.py.

def iron.Decomposition.ElementDomainSet (   self,
  elementUserNumber,
  domain 
)
Sets/changes the domain for a given element in a decomposition identified by an object.

:param elementUserNumber: The user number of the element to set the domain for.
:type elementUserNumber: int
:param domain: The computational domain of the element to set.
:type domain: int
:rtype: None

Definition at line 1966 of file iron.py.

def iron.Decomposition.Finalise (   self)
Finalises a cmfe_DecompositionType object.

:rtype: None

Definition at line 1979 of file iron.py.

def iron.Decomposition.MeshComponentGet (   self)
Returns the mesh component number used for the decomposition of a mesh for a decomposition identified by an object.

:returns: meshComponentNumber. The mesh component number for the decomposition.
:rtype: int

Definition at line 1988 of file iron.py.

def iron.Decomposition.MeshComponentSet (   self,
  meshComponentNumber 
)
Sets/changes the mesh component number used for the decomposition of a mesh for a decomposition identified by an object.

:param meshComponentNumber: The mesh component number for the decomposition to set.
:type meshComponentNumber: int
:rtype: None

Definition at line 1998 of file iron.py.

def iron.Decomposition.NodeDomainGet (   self,
  nodeUserNumber,
  meshComponentNumber 
)
Returns the domain for a given node in a decomposition identified by an object. \todo Maybe swap Node and MeshComponent?

:param nodeUserNumber: The user number of the node to get the domain for.
:type nodeUserNumber: int
:param meshComponentNumber: The user number of the mesh component to get the domain for.
:type meshComponentNumber: int
:returns: domain. The computational domain of the node.
:rtype: int

Definition at line 2009 of file iron.py.

def iron.Decomposition.NumberOfDomainsGet (   self)
Returns the number of domains for a decomposition identified by an object.

:returns: numberOfDomains. The number of domains in the decomposition.
:rtype: int

Definition at line 2023 of file iron.py.

def iron.Decomposition.NumberOfDomainsSet (   self,
  numberOfDomains 
)
Sets/changes the number of domains for a decomposition identified by an object.

:param numberOfDomains: The number of domains in the decomposition to set.
:type numberOfDomains: int
:rtype: None

Definition at line 2033 of file iron.py.

def iron.Decomposition.TopologyDataProjectionCalculate (   self)
Calculates the decomposition topology for data points

:rtype: None

Definition at line 2044 of file iron.py.

def iron.Decomposition.TopologyElementDataPointLocalNumberGet (   self,
  elementNumber,
  dataPointIndex 
)
Gets the local data point number for data points projected on an element

:param elementNumber: The element number to get the data point for
:type elementNumber: int
:param dataPointIndex: The data point index to get the number for
:type dataPointIndex: int
:returns: dataPointLocalNumber. The data point local number to retu
:rtype: int

Definition at line 2053 of file iron.py.

def iron.Decomposition.TopologyElementDataPointUserNumberGet (   self,
  elementNumber,
  dataPointIndex 
)
Gets the user data point number for data points projected on an element

:param elementNumber: The element number to get the data point for
:type elementNumber: int
:param dataPointIndex: The data point index to get the number for
:type dataPointIndex: int
:returns: dataPointUserNumber. The data point user number to retu
:rtype: int

Definition at line 2067 of file iron.py.

def iron.Decomposition.TopologyNumberOfElementDataPointsGet (   self,
  elementNumber 
)
Gets the number of data points projected on an element

:param elementNumber: The element number to get the data point for
:type elementNumber: int
:returns: numberOfDataPoints. The data point local number to return
:rtype: int

Definition at line 2081 of file iron.py.

def iron.Decomposition.TypeGet (   self)
Returns the type of a decomposition identified by an object.

:returns: decompositionType. The type of the decomposition.
:rtype: int

Definition at line 2093 of file iron.py.

def iron.Decomposition.TypeSet (   self,
  decompositionType 
)
Sets/changes the type of a decomposition identified by an object.

:param decompositionType: The type of the decomposition to set.
:type decompositionType: int
:rtype: None

Definition at line 2103 of file iron.py.

def iron.Decomposition.WorldWorkGroupSet (   self,
  worldWorkGroup 
)
Set the working group tree in order to performe mesh decomposition

:param worldWorkGroup:
:type worldWorkGroup: ComputationalWorkGroup
:rtype: None

Definition at line 2114 of file iron.py.

Member Data Documentation

iron.Decomposition.cmiss_type

Definition at line 1890 of file iron.py.

Property Documentation

iron.Decomposition.calculateFaces = property(None, CalculateFacesSet, None, )
static

Definition at line 2127 of file iron.py.

iron.Decomposition.calculateLines = property(None, CalculateLinesSet, None, )
static

Definition at line 2131 of file iron.py.

iron.Decomposition.meshComponent = property(MeshComponentGet, MeshComponentSet, None, )
static

Definition at line 2135 of file iron.py.

iron.Decomposition.numberOfDomains = property(NumberOfDomainsGet, NumberOfDomainsSet, None, )
static

Definition at line 2133 of file iron.py.

iron.Decomposition.type = property(TypeGet, TypeSet, None, )
static

Definition at line 2129 of file iron.py.

iron.Decomposition.worldWorkGroup = property(None, WorldWorkGroupSet, None, )
static

Definition at line 2125 of file iron.py.