OpenCMISS-Iron Python Bindings API Documentation
|
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, ) | |
def iron.Decomposition.__init__ | ( | self | ) |
def iron.Decomposition.CalculateFacesSet | ( | self, | |
calculateFacesFlag | |||
) |
def iron.Decomposition.CalculateLinesSet | ( | self, | |
calculateLinesFlag | |||
) |
def iron.Decomposition.CreateFinish | ( | self | ) |
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
def iron.Decomposition.Destroy | ( | self | ) |
def iron.Decomposition.ElementDomainCalculate | ( | self | ) |
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
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
def iron.Decomposition.Finalise | ( | self | ) |
def iron.Decomposition.MeshComponentGet | ( | self | ) |
def iron.Decomposition.MeshComponentSet | ( | self, | |
meshComponentNumber | |||
) |
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
def iron.Decomposition.NumberOfDomainsGet | ( | self | ) |
def iron.Decomposition.NumberOfDomainsSet | ( | self, | |
numberOfDomains | |||
) |
def iron.Decomposition.TopologyDataProjectionCalculate | ( | self | ) |
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
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
def iron.Decomposition.TopologyNumberOfElementDataPointsGet | ( | self, | |
elementNumber | |||
) |
def iron.Decomposition.TypeGet | ( | self | ) |
def iron.Decomposition.TypeSet | ( | self, | |
decompositionType | |||
) |
def iron.Decomposition.WorldWorkGroupSet | ( | self, | |
worldWorkGroup | |||
) |
|
static |
|
static |
|
static |
|
static |
|
static |