OpenCMISSIron Python Bindings API Documentation

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, )  
Contains information on an equations set defined on a region.
def iron.EquationsSet.__init__  (  self  ) 
def iron.EquationsSet.AnalyticCreateFinish  (  self  ) 
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
def iron.EquationsSet.AnalyticDestroy  (  self  ) 
def iron.EquationsSet.AnalyticEvaluate  (  self  ) 
def iron.EquationsSet.AnalyticTimeGet  (  self  ) 
def iron.EquationsSet.AnalyticTimeSet  (  self,  
time  
) 
def iron.EquationsSet.AnalyticUserParamGet  (  self,  
paramIdx  
) 
def iron.EquationsSet.AnalyticUserParamSet  (  self,  
paramIdx,  
param  
) 
def iron.EquationsSet.CreateFinish  (  self  ) 
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
def iron.EquationsSet.DependentCreateFinish  (  self  ) 
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
def iron.EquationsSet.DependentDestroy  (  self  ) 
def iron.EquationsSet.DerivedCreateFinish  (  self  ) 
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
def iron.EquationsSet.DerivedDestroy  (  self  ) 
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
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
def iron.EquationsSet.Destroy  (  self  ) 
def iron.EquationsSet.EquationsCreateFinish  (  self  ) 
def iron.EquationsSet.EquationsCreateStart  (  self,  
equations  
) 
def iron.EquationsSet.EquationsDestroy  (  self  ) 
def iron.EquationsSet.Finalise  (  self  ) 
def iron.EquationsSet.IndependentCreateFinish  (  self  ) 
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
def iron.EquationsSet.IndependentDestroy  (  self  ) 
def iron.EquationsSet.MaterialsCreateFinish  (  self  ) 
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
def iron.EquationsSet.MaterialsDestroy  (  self  ) 
def iron.EquationsSet.SolutionMethodGet  (  self  ) 
def iron.EquationsSet.SolutionMethodSet  (  self,  
solutionMethod  
) 
def iron.EquationsSet.SourceCreateFinish  (  self  ) 
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
def iron.EquationsSet.SourceDestroy  (  self  ) 
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
def iron.EquationsSet.SpecificationSizeGet  (  self  ) 
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

static 

static 

static 

static 