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

Public Member Functions

def __init__ (self)
 
def CollapsedXiGet (self, collapsedXiSize)
 
def CollapsedXiSet (self, collapsedXi)
 
def CreateFinish (self)
 
def CreateStart (self, userNumber)
 
def Destroy (self)
 
def Finalise (self)
 
def InterpolationXiGet (self, interpolationXiSize)
 
def InterpolationXiSet (self, interpolationXi)
 
def NumberOfLocalNodesGet (self)
 
def NumberOfXiGet (self)
 
def NumberOfXiSet (self, numberOfXi)
 
def QuadratureLocalFaceGaussEvaluateSet (self, faceGaussEvaluate)
 
def QuadratureMultipleGaussXiGet (self, quadratureScheme, GaussPoints, GaussXiSizes)
 
def QuadratureNumberOfGaussXiGet (self, numberOfGaussXiSize)
 
def QuadratureNumberOfGaussXiSet (self, numberOfGaussXi)
 
def QuadratureOrderGet (self)
 
def QuadratureOrderSet (self, quadratureOrder)
 
def QuadratureSingleGaussXiGet (self, quadratureScheme, GaussPoint, GaussXiSize)
 
def QuadratureTypeGet (self)
 
def QuadratureTypeSet (self, quadratureType)
 
def TypeGet (self)
 
def TypeSet (self, basisType)
 

Public Attributes

 cmiss_type
 

Properties

 interpolationXi = property(InterpolationXiGet, InterpolationXiSet, None, )
 
 quadratureNumberOfGaussXi = property(QuadratureNumberOfGaussXiGet, QuadratureNumberOfGaussXiSet, None, )
 
 quadratureLocalFaceGaussEvaluate = property(None, QuadratureLocalFaceGaussEvaluateSet, None, )
 
 quadratureType = property(QuadratureTypeGet, QuadratureTypeSet, None, )
 
 collapsedXi = property(CollapsedXiGet, CollapsedXiSet, None, )
 
 numberOfXi = property(NumberOfXiGet, NumberOfXiSet, None, )
 
 type = property(TypeGet, TypeSet, None, )
 
 numberOfLocalNodes = property(NumberOfLocalNodesGet, None, None, )
 
 quadratureOrder = property(QuadratureOrderGet, QuadratureOrderSet, None, )
 

Detailed Description

Contains information about a basis function.

Definition at line 20 of file iron.py.

Constructor & Destructor Documentation

def iron.Basis.__init__ (   self)
Initialise a null cmfe_BasisType

Definition at line 24 of file iron.py.

Member Function Documentation

def iron.Basis.CollapsedXiGet (   self,
  collapsedXiSize 
)
Returns the collapsed Xi flags of a basis identified by an object.

:param collapsedXiSize: Size of collapsedXi to allocate.
:returns: collapsedXi. collapsedXi(ni). On return, the collapsed Xi parameter for the ni'th Xi direction. Will be a value from the BasisXiCollapse enum.
:rtype: Array of ints

Definition at line 29 of file iron.py.

def iron.Basis.CollapsedXiSet (   self,
  collapsedXi 
)
Sets/changes the collapsed Xi flags of a basis identified by an object.

:param collapsedXi: collapsedXi(ni). The collapsed Xi parameter for the ni'th Xi direction to set. Must be a value from the BasisXiCollapse enum.
:type collapsedXi: Array of ints
:rtype: None

Definition at line 40 of file iron.py.

def iron.Basis.CreateFinish (   self)
Finishes the creation of a new basis identified by an object.

:rtype: None

Definition at line 51 of file iron.py.

def iron.Basis.CreateStart (   self,
  userNumber 
)
Starts the creation of a new basis for a basis identified by an object.

:param userNumber: The user number of the basis to start the creation of.
:type userNumber: int
:rtype: None

Definition at line 60 of file iron.py.

def iron.Basis.Destroy (   self)
Destroys a basis identified by an object.

:rtype: None

Definition at line 71 of file iron.py.

def iron.Basis.Finalise (   self)
Finalises a cmfe_BasisType object.

:rtype: None

Definition at line 80 of file iron.py.

def iron.Basis.InterpolationXiGet (   self,
  interpolationXiSize 
)
Get the interpolation type in each xi directions for a basis indentified by an object.

:param interpolationXiSize: Size of interpolationXi to allocate.
:returns: interpolationXi. The interpolation xi parameters for each Xi direction. Will be a value from the BasisInterpolationSpecifications enum.
:rtype: Array of ints

Definition at line 89 of file iron.py.

def iron.Basis.InterpolationXiSet (   self,
  interpolationXi 
)
Sets/changes the interpolation type in each xi directions for a basis indentified by an object.

:param interpolationXi: The interpolation xi parameters for each Xi direction. Must be a value from the BasisInterpolationSpecifications enum.
:type interpolationXi: Array of ints
:rtype: None

Definition at line 100 of file iron.py.

def iron.Basis.NumberOfLocalNodesGet (   self)
Returns the number of local nodes in a basis identified by an object.

:returns: numberOfLocalNodes. The number of local nodes in the specified basis.
:rtype: int

Definition at line 111 of file iron.py.

def iron.Basis.NumberOfXiGet (   self)
Returns the number of Xi directions in a basis identified by an object.

:returns: numberOfXi. The number of xi directions in the specified basis.
:rtype: int

Definition at line 121 of file iron.py.

def iron.Basis.NumberOfXiSet (   self,
  numberOfXi 
)
Sets/changes the number of Xi directions in a basis identified by an object.

:param numberOfXi: The number of xi directions in the specified basis to set.
:type numberOfXi: int
:rtype: None

Definition at line 131 of file iron.py.

def iron.Basis.QuadratureLocalFaceGaussEvaluateSet (   self,
  faceGaussEvaluate 
)
Sets/changes the local face Gauss scheme calculation, on a basis identified by an object.

:param faceGaussEvaluate: The type of quadrature in the specified basis to set.
:type faceGaussEvaluate: bool
:rtype: None

Definition at line 142 of file iron.py.

def iron.Basis.QuadratureMultipleGaussXiGet (   self,
  quadratureScheme,
  GaussPoints,
  GaussXiSizes 
)
Returns the xi positions of Gauss points on a basis quadrature identified by an object.

:param quadratureScheme: The quadrature scheme to return the Gauss xi positions for.
:type quadratureScheme: int
:param GaussPoints: The Gauss points to return the element xi positions for.
:type GaussPoints: Array of ints
:param GaussXiSizes: Tuple of dimensions of GaussXi to allocate, with length 2.
:returns: GaussXi. GaussXi(Gauss_point,xi_direction) the Gauss xi positions for the specified quadrature scheme.
:rtype: 2d array of floats

Definition at line 153 of file iron.py.

def iron.Basis.QuadratureNumberOfGaussXiGet (   self,
  numberOfGaussXiSize 
)
Returns the number Gauss points in each Xi directions for a basis quadrature identified by an object.

:param numberOfGaussXiSize: Size of numberOfGaussXi to allocate.
:returns: numberOfGaussXi. The number of Gauss points in each Xi directions in the specified basis.
:rtype: Array of ints

Definition at line 168 of file iron.py.

def iron.Basis.QuadratureNumberOfGaussXiSet (   self,
  numberOfGaussXi 
)
Sets the number Gauss points in each Xi directions for a basis quadrature identified by an object.

:param numberOfGaussXi: The number of Gauss points in each Xi directions in the specified basis to set.
:type numberOfGaussXi: Array of ints
:rtype: None

Definition at line 179 of file iron.py.

def iron.Basis.QuadratureOrderGet (   self)
Returns the the order of quadrature for a basis quadrature identified by an object.

:returns: quadratureOrder. The order of quadrature in the specified basis.
:rtype: int

Definition at line 190 of file iron.py.

def iron.Basis.QuadratureOrderSet (   self,
  quadratureOrder 
)
Sets/changes the the order of quadrature for a basis quadrature identified by an object.

:param quadratureOrder: The order of quadrature in the specified basis to set.
:type quadratureOrder: int
:rtype: None

Definition at line 200 of file iron.py.

def iron.Basis.QuadratureSingleGaussXiGet (   self,
  quadratureScheme,
  GaussPoint,
  GaussXiSize 
)
Returns the xi position of a Gauss point on a basis quadrature identified by an object.

:param quadratureScheme: The quadrature scheme to return the Gauss xi positions for.
:type quadratureScheme: int
:param GaussPoint: The Gauss point to return the element xi positions for.
:type GaussPoint: int
:param GaussXiSize: Size of GaussXi to allocate.
:returns: GaussXi. GaussXi(xi_direction) the xi position of the specified Gauss point for the specified quadrature scheme.
:rtype: Array of floats

Definition at line 211 of file iron.py.

def iron.Basis.QuadratureTypeGet (   self)
Returns the the type of quadrature for a basis quadrature identified by an object.

:returns: quadratureType. The type of quadrature in the specified basis. Will be a value from the QuadratureTypes enum.
:rtype: int

Definition at line 226 of file iron.py.

def iron.Basis.QuadratureTypeSet (   self,
  quadratureType 
)
Sets/changes the the type of quadrature for a basis quadrature identified by an object.

:param quadratureType: The type of quadrature in the specified basis to set. Must be a value from the QuadratureTypes enum.
:type quadratureType: int
:rtype: None

Definition at line 236 of file iron.py.

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

:returns: basisType. The type of the specified basis. Will be a value from the BasisTypes enum.
:rtype: int

Definition at line 247 of file iron.py.

def iron.Basis.TypeSet (   self,
  basisType 
)
Sets/changes the type of a basis identified by an object.

:param basisType: The type of the specified basis to set. Must be a value from the BasisTypes enum.
:type basisType: int
:rtype: None

Definition at line 257 of file iron.py.

Member Data Documentation

iron.Basis.cmiss_type

Definition at line 27 of file iron.py.

Property Documentation

iron.Basis.collapsedXi = property(CollapsedXiGet, CollapsedXiSet, None, )
static

Definition at line 276 of file iron.py.

iron.Basis.interpolationXi = property(InterpolationXiGet, InterpolationXiSet, None, )
static

Definition at line 268 of file iron.py.

iron.Basis.numberOfLocalNodes = property(NumberOfLocalNodesGet, None, None, )
static

Definition at line 282 of file iron.py.

iron.Basis.numberOfXi = property(NumberOfXiGet, NumberOfXiSet, None, )
static

Definition at line 278 of file iron.py.

iron.Basis.quadratureLocalFaceGaussEvaluate = property(None, QuadratureLocalFaceGaussEvaluateSet, None, )
static

Definition at line 272 of file iron.py.

iron.Basis.quadratureNumberOfGaussXi = property(QuadratureNumberOfGaussXiGet, QuadratureNumberOfGaussXiSet, None, )
static

Definition at line 270 of file iron.py.

iron.Basis.quadratureOrder = property(QuadratureOrderGet, QuadratureOrderSet, None, )
static

Definition at line 284 of file iron.py.

iron.Basis.quadratureType = property(QuadratureTypeGet, QuadratureTypeSet, None, )
static

Definition at line 274 of file iron.py.

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

Definition at line 280 of file iron.py.