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

Public Member Functions

def __init__ (self)
 
def Create (self, parentMesh, childMesh)
 
def PullGaussPointData (self, parentField, parentComponent, childField, childComponent)
 
def PushData (self, parentField, parentComponent, childField, childComponent)
 
def SetChildNodePosition (self, elementNumber, nodeNumbers, xiCoords)
 
def SetGaussPointData (self, parentElementNumber, gaussPointNumber, parentXiCoords, childElementNumber, childXiCoords)
 

Public Attributes

 cmiss_type
 

Detailed Description

Contains information on an embedded mesh

Definition at line 6623 of file iron.py.

Constructor & Destructor Documentation

def iron.MeshEmbedding.__init__ (   self)
Initialise a null cmfe_MeshEmbeddingType

Definition at line 6627 of file iron.py.

Member Function Documentation

def iron.MeshEmbedding.Create (   self,
  parentMesh,
  childMesh 
)
Creates a mesh embedding

:param parentMesh: The parent and child meshes
:type parentMesh: Mesh
:param childMesh: The parent and child meshes
:type childMesh: Mesh
:rtype: None

Definition at line 6632 of file iron.py.

def iron.MeshEmbedding.PullGaussPointData (   self,
  parentField,
  parentComponent,
  childField,
  childComponent 
)
:param parentField: Fields associated with parent and child mesh to get/set data from
:type parentField: Field
:param parentComponent: Component numbers in respective fields
:type parentComponent: int
:param childField: Fields associated with parent and child mesh to get/set data from
:type childField: Field
:param childComponent: Component numbers in respective fields
:type childComponent: int
:rtype: None

Definition at line 6645 of file iron.py.

def iron.MeshEmbedding.PushData (   self,
  parentField,
  parentComponent,
  childField,
  childComponent 
)
Pushes data to embedded mesh. Will generally be used at library and not API level. /TODO: Parameter set etc, function name?

:param parentField: Fields associated with parent and child mesh to get/set data from
:type parentField: Field
:param parentComponent: Component numbers in respective fields
:type parentComponent: int
:param childField: Fields associated with parent and child mesh to get/set data from
:type childField: Field
:param childComponent: Component numbers in respective fields
:type childComponent: int
:rtype: None

Definition at line 6660 of file iron.py.

def iron.MeshEmbedding.SetChildNodePosition (   self,
  elementNumber,
  nodeNumbers,
  xiCoords 
)
Sets the embedded nodes for one parent element

:param elementNumber: Parent element number
:type elementNumber: int
:param nodeNumbers: Node numbers in child mesh
:type nodeNumbers: Array of ints
:param xiCoords: Xi coordinates of embedded nodes wrt parent element
:type xiCoords: 2d array of floats
:rtype: None

Definition at line 6677 of file iron.py.

def iron.MeshEmbedding.SetGaussPointData (   self,
  parentElementNumber,
  gaussPointNumber,
  parentXiCoords,
  childElementNumber,
  childXiCoords 
)
:param parentElementNumber: Parent element number
:type parentElementNumber: int
:param gaussPointNumber: Gauss point number in this element
:type gaussPointNumber: int
:param parentXiCoords: Xi coordinates of embedded nodes wrt parent element
:type parentXiCoords: Array of floats
:param childElementNumber: Child element number
:type childElementNumber: int
:param childXiCoords: Xi coordinates of embedded nodes wrt Child element
:type childXiCoords: Array of floats
:rtype: None

Definition at line 6692 of file iron.py.

Member Data Documentation

iron.MeshEmbedding.cmiss_type

Definition at line 6630 of file iron.py.