|
OpenCMISS-Iron Python Bindings API Documentation
|
|
OpenCMISS-Iron Python Bindings API Documentation
|
Public Member Functions | |
| def | __init__ (self) |
| def | Destroy (self) |
| def | DynamicMatrixGet (self, matrixIndex, matrix) |
| def | DynamicMatrixGetByType (self, matrixType, matrix) |
| def | DynamicMatrixTypeGet (self, matrixIndex) |
| def | Finalise (self) |
| def | JacobianMatricesTypesSet (self, jacobianTypes) |
| def | JacobianMatrixGet (self, residualIndex, variableType, matrix) |
| def | LinearMatrixGet (self, matrixIndex, matrix) |
| def | LinearityTypeGet (self) |
| def | LumpingTypeGet (self) |
| def | LumpingTypeSet (self, lumpingType) |
| def | NumberOfDynamicMatricesGet (self) |
| def | NumberOfJacobianMatricesGet (self) |
| def | NumberOfLinearMatricesGet (self) |
| def | OutputTypeGet (self) |
| def | OutputTypeSet (self, outputType) |
| def | ResidualNumberOfVariablesGet (self, residualIndex) |
| def | ResidualVariablesGet (self, residualIndex, residualVariablesSize) |
| def | ResidualVectorGet (self, residualIndex, residualVector) |
| def | RhsVectorGet (self, rhsVector) |
| def | SourceVectorGet (self, sourceVector) |
| def | SparsityTypeGet (self) |
| def | SparsityTypeSet (self, sparsityType) |
| def | TimeDependenceTypeGet (self) |
Public Attributes | |
| cmiss_type | |
Properties | |
| rhsVector = property(RhsVectorGet, None, None, ) | |
| timeDependenceType = property(TimeDependenceTypeGet, None, None, ) | |
| sourceVector = property(SourceVectorGet, None, None, ) | |
| outputType = property(OutputTypeGet, OutputTypeSet, None, ) | |
| sparsityType = property(SparsityTypeGet, SparsityTypeSet, None, ) | |
| linearityType = property(LinearityTypeGet, None, None, ) | |
| jacobianMatricesTypes = property(None, JacobianMatricesTypesSet, None, ) | |
| numberOfJacobianMatrices = property(NumberOfJacobianMatricesGet, None, None, ) | |
| numberOfDynamicMatrices = property(NumberOfDynamicMatricesGet, None, None, ) | |
| lumpingType = property(LumpingTypeGet, LumpingTypeSet, None, ) | |
| numberOfLinearMatrices = property(NumberOfLinearMatricesGet, None, None, ) | |
Contains information about the equations in an equations set.
| def iron.Equations.__init__ | ( | self | ) |
| def iron.Equations.Destroy | ( | self | ) |
| def iron.Equations.DynamicMatrixGet | ( | self, | |
| matrixIndex, | |||
| matrix | |||
| ) |
Get a dynamic equations matrix from equations using the dynamic matrix index :param matrixIndex: The number of the dynamic matrix to get :type matrixIndex: int :param matrix: On return, the requested dynamic matrix :type matrix: DistributedMatrix :rtype: None
| def iron.Equations.DynamicMatrixGetByType | ( | self, | |
| matrixType, | |||
| matrix | |||
| ) |
Get a dynamic equations matrix from equations using the dynamic matrix type :param matrixType: The type of the dynamic matrix to get. Must be a value from the EquationsSetDynamicMatrixTypes enum. :type matrixType: int :param matrix: On return, the requested dynamic matrix :type matrix: DistributedMatrix :rtype: None
| def iron.Equations.DynamicMatrixTypeGet | ( | self, | |
| matrixIndex | |||
| ) |
Get the type of a dynamic matrix from equations set equations :param matrixIndex: The number of the dynamic matrix to get the type of :type matrixIndex: int :returns: matrixType. The dynamic matrix type. Will be a value from the EquationsSetDynamicMatrixTypes enum. :rtype: int
| def iron.Equations.Finalise | ( | self | ) |
| def iron.Equations.JacobianMatricesTypesSet | ( | self, | |
| jacobianTypes | |||
| ) |
| def iron.Equations.JacobianMatrixGet | ( | self, | |
| residualIndex, | |||
| variableType, | |||
| matrix | |||
| ) |
Get a Jacobian matrix from the equations :param residualIndex: The index of the residual vector to get the Jacobian matrix for :type residualIndex: int :param variableType: The field variable type that the residual is differentiated with respect to for this Jacobian. Must be a value from the FieldVariableTypes enum. :type variableType: int :param matrix: On return, the requested Jacobian matrix :type matrix: DistributedMatrix :rtype: None
| def iron.Equations.LinearityTypeGet | ( | self | ) |
| def iron.Equations.LinearMatrixGet | ( | self, | |
| matrixIndex, | |||
| matrix | |||
| ) |
| def iron.Equations.LumpingTypeGet | ( | self | ) |
| def iron.Equations.LumpingTypeSet | ( | self, | |
| lumpingType | |||
| ) |
| def iron.Equations.NumberOfDynamicMatricesGet | ( | self | ) |
| def iron.Equations.NumberOfJacobianMatricesGet | ( | self | ) |
| def iron.Equations.NumberOfLinearMatricesGet | ( | self | ) |
| def iron.Equations.OutputTypeGet | ( | self | ) |
| def iron.Equations.OutputTypeSet | ( | self, | |
| outputType | |||
| ) |
| def iron.Equations.ResidualNumberOfVariablesGet | ( | self, | |
| residualIndex | |||
| ) |
Get the number of field variables that contribute to the residual vector :param residualIndex: The index of the residual vector to get the number of variables for :type residualIndex: int :returns: numberOfVariables. The number of variables that contribute to the residual vector :rtype: int
| def iron.Equations.ResidualVariablesGet | ( | self, | |
| residualIndex, | |||
| residualVariablesSize | |||
| ) |
Get the field variables that contribute to the residual vector :param residualIndex: The index of the residual vector to get the variables for :type residualIndex: int :param residualVariablesSize: Size of residualVariables to allocate. :returns: residualVariables. residualVariables(varIdx). On return, the field variable type for the varIdx'th residual variable. Will be a value from the FieldVariableTypes enum. :rtype: Array of ints
| def iron.Equations.ResidualVectorGet | ( | self, | |
| residualIndex, | |||
| residualVector | |||
| ) |
| def iron.Equations.RhsVectorGet | ( | self, | |
| rhsVector | |||
| ) |
| def iron.Equations.SourceVectorGet | ( | self, | |
| sourceVector | |||
| ) |
| def iron.Equations.SparsityTypeGet | ( | self | ) |
| def iron.Equations.SparsityTypeSet | ( | self, | |
| sparsityType | |||
| ) |
| def iron.Equations.TimeDependenceTypeGet | ( | self | ) |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
1.8.11 
