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

Public Member Functions

def __init__ (self)
 
def AnalyticCreateFinish (self)
 
def AnalyticCreateStart (self, analyticFunctionType, analyticFieldUserNumber, analyticField)
 
def AnalyticDestroy (self)
 
def AnalyticEvaluate (self)
 
def AnalyticTimeGet (self)
 
def AnalyticTimeSet (self, time)
 
def AnalyticUserParamGet (self, paramIdx)
 
def AnalyticUserParamSet (self, paramIdx, param)
 
def CreateFinish (self)
 
def CreateStart (self, equationsSetUserNumber, region, geomFibreField, equationsSetSpecification, equationsSetFieldUserNumber, equationsSetFieldField)
 
def DependentCreateFinish (self)
 
def DependentCreateStart (self, dependentFieldUserNumber, dependentField)
 
def DependentDestroy (self)
 
def DerivedCreateFinish (self)
 
def DerivedCreateStart (self, derivedFieldUserNumber, derivedField)
 
def DerivedDestroy (self)
 
def DerivedVariableCalculate (self, derivedType)
 
def DerivedVariableSet (self, derivedType, fieldVariableType)
 
def Destroy (self)
 
def EquationsCreateFinish (self)
 
def EquationsCreateStart (self, equations)
 
def EquationsDestroy (self)
 
def Finalise (self)
 
def IndependentCreateFinish (self)
 
def IndependentCreateStart (self, independentFieldUserNumber, independentField)
 
def IndependentDestroy (self)
 
def MaterialsCreateFinish (self)
 
def MaterialsCreateStart (self, materialsFieldUserNumber, materialsField)
 
def MaterialsDestroy (self)
 
def SolutionMethodGet (self)
 
def SolutionMethodSet (self, solutionMethod)
 
def SourceCreateFinish (self)
 
def SourceCreateStart (self, sourceFieldUserNumber, sourceField)
 
def SourceDestroy (self)
 
def SpecificationGet (self, equationsSetSpecification)
 
def SpecificationSizeGet (self)
 
def TensorInterpolateXi (self, tensorEvaluateType, userElementNumber, xi, valuesSizes)
 

Public Attributes

 cmiss_type
 

Properties

 specificationSize = property(SpecificationSizeGet, None, None, )
 
 analyticTime = property(AnalyticTimeGet, AnalyticTimeSet, None, )
 
 solutionMethod = property(SolutionMethodGet, SolutionMethodSet, None, )
 
 specification = property(SpecificationGet, None, None, )
 

Detailed Description

Contains information on an equations set defined on a region.

Definition at line 2393 of file iron.py.

Constructor & Destructor Documentation

def iron.EquationsSet.__init__ (   self)
Initialise a null cmfe_EquationsSetType

Definition at line 2397 of file iron.py.

Member Function Documentation

def iron.EquationsSet.AnalyticCreateFinish (   self)
Finish the creation of a analytic solution for an equations set identified by an object.

:rtype: None

Definition at line 2402 of file iron.py.

def iron.EquationsSet.AnalyticCreateStart (   self,
  analyticFunctionType,
  analyticFieldUserNumber,
  analyticField 
)
Start the creation of an analytic solution for an equations set identified by an object.

:param analyticFunctionType: The analytic function type to use. Must be a value from the EquationsSetAnalyticFunctionTypes enum.
:type analyticFunctionType: int
:param analyticFieldUserNumber: The user number of the field for the analytic function
:type analyticFieldUserNumber: int
:param analyticField: If associated on entry, the user created analytic field which has the same user number as the specified analytic field user number. If not associated on entry, on return, the created analytic field for the equations set.
:type analyticField: Field
:rtype: None

Definition at line 2411 of file iron.py.

def iron.EquationsSet.AnalyticDestroy (   self)
Destroy the analytic solution for an equations set identified by an object.

:rtype: None

Definition at line 2426 of file iron.py.

def iron.EquationsSet.AnalyticEvaluate (   self)
Evaluates the current analytic solution for an equations set identified by an object.

:rtype: None

Definition at line 2435 of file iron.py.

def iron.EquationsSet.AnalyticTimeGet (   self)
Returns the analytic time for an equations set identified by an object.

:returns: time. The analytic time for the equations set.
:rtype: float

Definition at line 2444 of file iron.py.

def iron.EquationsSet.AnalyticTimeSet (   self,
  time 
)
Sets/changes the analytic time for an equations set identified by an object.

:param time: The analytic time to set.
:type time: float
:rtype: None

Definition at line 2454 of file iron.py.

def iron.EquationsSet.AnalyticUserParamGet (   self,
  paramIdx 
)
Sets the analytic problem user parameter

:param paramIdx: The index of the analytic user parameter to set
:type paramIdx: int
:returns: param. Value of the parameter to set
:rtype: float

Definition at line 2465 of file iron.py.

def iron.EquationsSet.AnalyticUserParamSet (   self,
  paramIdx,
  param 
)
Sets the analytic problem user parameter

:param paramIdx: The index of the analytic user parameter to set
:type paramIdx: int
:param param: Value of the parameter to set
:type param: float
:rtype: None

Definition at line 2477 of file iron.py.

def iron.EquationsSet.CreateFinish (   self)
Finish the creation of an equations set identified by an object.

:rtype: None

Definition at line 2490 of file iron.py.

def iron.EquationsSet.CreateStart (   self,
  equationsSetUserNumber,
  region,
  geomFibreField,
  equationsSetSpecification,
  equationsSetFieldUserNumber,
  equationsSetFieldField 
)
Start the creation of an equations set identified by an object.

:param equationsSetUserNumber: The user number of the equations set to be created.
:type equationsSetUserNumber: int
:param region: The region to create the equations set on.
:type region: Region
:param geomFibreField: The Geometric/Fibre field for the creation of the equations set.
:type geomFibreField: Field
:param equationsSetSpecification: The equations set specification array, containing the equations class, type etc
:type equationsSetSpecification: Array of ints
:param equationsSetFieldUserNumber: The user number of the equations set field
:type equationsSetFieldUserNumber: int
:param equationsSetFieldField: On return, a pointer to the equations set field
:type equationsSetFieldField: Field
:rtype: None

Definition at line 2499 of file iron.py.

def iron.EquationsSet.DependentCreateFinish (   self)
Finish the creation of dependent variables for an equations set identified by an object.

:rtype: None

Definition at line 2520 of file iron.py.

def iron.EquationsSet.DependentCreateStart (   self,
  dependentFieldUserNumber,
  dependentField 
)
Start the creation of dependent variables for an equations set identified by an object.

:param dependentFieldUserNumber: The user number of the dependent field.
:type dependentFieldUserNumber: int
:param dependentField: If associated on entry, the user created dependent field which has the same user number as the specified dependent field user number. If not associated on entry, on return, the created dependent field for the equations set.
:type dependentField: Field
:rtype: None

Definition at line 2529 of file iron.py.

def iron.EquationsSet.DependentDestroy (   self)
Destroy the dependent variables for an equations set identified by an object.

:rtype: None

Definition at line 2542 of file iron.py.

def iron.EquationsSet.DerivedCreateFinish (   self)
Finish the creation of derived variables for an equations set identified by an object.

:rtype: None

Definition at line 2551 of file iron.py.

def iron.EquationsSet.DerivedCreateStart (   self,
  derivedFieldUserNumber,
  derivedField 
)
Start the creation of derived variables for an equations set identified by an object.

:param derivedFieldUserNumber: The user number of the derived field.
:type derivedFieldUserNumber: int
:param derivedField: If associated on entry, the user created derived field which has the same user number as the specified derived field user number. If not associated on entry, on return, the created derived field for the equations set.
:type derivedField: Field
:rtype: None

Definition at line 2560 of file iron.py.

def iron.EquationsSet.DerivedDestroy (   self)
Destroy the derived variables for an equations set identified by an object.

:rtype: None

Definition at line 2573 of file iron.py.

def iron.EquationsSet.DerivedVariableCalculate (   self,
  derivedType 
)
Calculates a derived field value for the equations set and stores the result in the derived field previously set up

:param derivedType: The derived field type to calculate. Must be a value from the EquationsSetDerivedTypes enum.
:type derivedType: int
:rtype: None

Definition at line 2582 of file iron.py.

def iron.EquationsSet.DerivedVariableSet (   self,
  derivedType,
  fieldVariableType 
)
Sets the field variable type of the derived field to be used to store a derived variable

:param derivedType: The derived field type to calculate. Must be a value from the EquationsSetDerivedTypes enum.
:type derivedType: int
:param fieldVariableType: The field variable type to store the calculated values in.
:type fieldVariableType: int
:rtype: None

Definition at line 2593 of file iron.py.

def iron.EquationsSet.Destroy (   self)
Destroy an equations set identified by an object.

:rtype: None

Definition at line 2606 of file iron.py.

def iron.EquationsSet.EquationsCreateFinish (   self)
Finish the creation of equations for an equations set identified by an object.

:rtype: None

Definition at line 2615 of file iron.py.

def iron.EquationsSet.EquationsCreateStart (   self,
  equations 
)
Start the creation of equations for an equations set identified by an object.

:param equations: On return, the created equations.
:type equations: Equations
:rtype: None

Definition at line 2624 of file iron.py.

def iron.EquationsSet.EquationsDestroy (   self)
Destroy the equations for an equations set identified by an object.

:rtype: None

Definition at line 2635 of file iron.py.

def iron.EquationsSet.Finalise (   self)
Finalises a cmfe_EquationsSetType object.

:rtype: None

Definition at line 2644 of file iron.py.

def iron.EquationsSet.IndependentCreateFinish (   self)
Finish the creation of independent variables for an equations set identified by an object.

:rtype: None

Definition at line 2653 of file iron.py.

def iron.EquationsSet.IndependentCreateStart (   self,
  independentFieldUserNumber,
  independentField 
)
Start the creation of independent variables for an equations set identified by an object.

:param independentFieldUserNumber: The user number of the dependent field.
:type independentFieldUserNumber: int
:param independentField: If associated on entry, the user created independent field which has the same user number as the specified independent field user number. If not associated on entry, on return, the created independent field for the equations set.
:type independentField: Field
:rtype: None

Definition at line 2662 of file iron.py.

def iron.EquationsSet.IndependentDestroy (   self)
Destroy the independent variables for an equations set identified by an object.

:rtype: None

Definition at line 2675 of file iron.py.

def iron.EquationsSet.MaterialsCreateFinish (   self)
Finish the creation of materials for an equations set identified by an object.

:rtype: None

Definition at line 2684 of file iron.py.

def iron.EquationsSet.MaterialsCreateStart (   self,
  materialsFieldUserNumber,
  materialsField 
)
Start the creation of materials for an equations set identified by an object.

:param materialsFieldUserNumber: The user number of the materials field.
:type materialsFieldUserNumber: int
:param materialsField: If associated on entry, the user created materials field which has the same user number as the specified materials field user number. If not associated on entry, on return, the created materials field for the equations set.
:type materialsField: Field
:rtype: None

Definition at line 2693 of file iron.py.

def iron.EquationsSet.MaterialsDestroy (   self)
Destroy the materials for an equations set identified by an object.

:rtype: None

Definition at line 2706 of file iron.py.

def iron.EquationsSet.SolutionMethodGet (   self)
Returns the solution method for an equations set identified by an object.

:returns: solutionMethod. The solution method. Will be a value from the EquationsSetSolutionMethods enum.
:rtype: int

Definition at line 2715 of file iron.py.

def iron.EquationsSet.SolutionMethodSet (   self,
  solutionMethod 
)
Sets/changes the solution method for an equations set identified by an object.

:param solutionMethod: The solution method to set. Must be a value from the EquationsSetSolutionMethods enum.
:type solutionMethod: int
:rtype: None

Definition at line 2725 of file iron.py.

def iron.EquationsSet.SourceCreateFinish (   self)
Finish the creation of a source for an equations set identified by an object.

:rtype: None

Definition at line 2736 of file iron.py.

def iron.EquationsSet.SourceCreateStart (   self,
  sourceFieldUserNumber,
  sourceField 
)
Start the creation of a source for an equations set identified by an object.

:param sourceFieldUserNumber: The user number of the source field.
:type sourceFieldUserNumber: int
:param sourceField: If associated on entry, the user created source field which has the same user number as the specified source field user number. If not associated on entry, on return, the created source field for the equations set.
:type sourceField: Field
:rtype: None

Definition at line 2745 of file iron.py.

def iron.EquationsSet.SourceDestroy (   self)
Destroy the source for an equations set identified by an object.

:rtype: None

Definition at line 2758 of file iron.py.

def iron.EquationsSet.SpecificationGet (   self,
  equationsSetSpecification 
)
Returns the equations set specification array for an equations set identified by an object.

:param equationsSetSpecification: On return, the equations set specification array. Must be allocated and large enough to contain the specification on entry.
:type equationsSetSpecification: Array of ints
:rtype: None

Definition at line 2767 of file iron.py.

def iron.EquationsSet.SpecificationSizeGet (   self)
Returns the size of the equations set specification array for an equations set identified by an object.

:returns: specificationSize. The size of the equations set specification array.
:rtype: int

Definition at line 2778 of file iron.py.

def iron.EquationsSet.TensorInterpolateXi (   self,
  tensorEvaluateType,
  userElementNumber,
  xi,
  valuesSizes 
)
Evaluate a tensor at a given element xi location, for an equations set identified by an object.

:param tensorEvaluateType: The type of tensor to evaluate.
:type tensorEvaluateType: int
:param userElementNumber: The user element number of the field to interpolate.
:type userElementNumber: int
:param xi: The element xi to interpolate the field at.
:type xi: Array of floats
:param valuesSizes: Tuple of dimensions of values to allocate, with length 2.
:returns: values. The interpolated strain tensor values.
:rtype: 2d array of floats

Definition at line 2788 of file iron.py.

Member Data Documentation

iron.EquationsSet.cmiss_type

Definition at line 2400 of file iron.py.

Property Documentation

iron.EquationsSet.analyticTime = property(AnalyticTimeGet, AnalyticTimeSet, None, )
static

Definition at line 2807 of file iron.py.

iron.EquationsSet.solutionMethod = property(SolutionMethodGet, SolutionMethodSet, None, )
static

Definition at line 2809 of file iron.py.

iron.EquationsSet.specification = property(SpecificationGet, None, None, )
static

Definition at line 2811 of file iron.py.

iron.EquationsSet.specificationSize = property(SpecificationSizeGet, None, None, )
static

Definition at line 2805 of file iron.py.