OpenCMISS-Iron Python Bindings API Documentation
iron Namespace Reference

Classes

class  AnalyticParamIndices
 
class  Basis
 
class  BasisInterpolationSpecifications
 
class  BasisQuadratureSchemes
 
class  BasisQuadratureTypes
 
class  BasisTypes
 
class  BasisXiCollapse
 
class  BoundaryConditions
 
class  BoundaryConditionSparsityTypes
 
class  BoundaryConditionsTypes
 
class  BurgersAnalyticFunctionTypes
 
class  CellML
 
class  CellMLEquations
 
class  CellMLFieldTypes
 
class  ComputationalWorkGroup
 
class  ControlLoop
 
class  ControlLoopIdentifiers
 
class  ControlLoopOutputTypes
 
class  CoordinateRadialInterpolations
 
class  CoordinateSystem
 
class  CoordinateSystemTypes
 
class  DAESolverTypes
 
class  DAETypes
 
class  DarcyAnalyticFunctionTypes
 
class  DataPoints
 
class  DataProjection
 
class  DataProjectionProjectionTypes
 
class  DataTypeConstants
 
class  Decomposition
 
class  DecompositionTypes
 
class  DiagnosticTypes
 
class  DiffusionAnalyticFunctionTypes
 
class  DirectLinearSolverTypes
 
class  DistributedMatrix
 
class  DistributedVector
 
class  DynamicDegreeTypes
 
class  DynamicLinearityTypes
 
class  DynamicOrderTypes
 
class  DynamicSchemeTypes
 
class  Equations
 
class  EquationsJacobianCalculated
 
class  EquationsLinearityTypes
 
class  EquationsLumpingTypes
 
class  EquationsOutputTypes
 
class  EquationsSet
 
class  EquationsSetClasses
 
class  EquationsSetDerivedTypes
 
class  EquationsSetDynamicMatrixTypes
 
class  EquationsSetFiniteElasticityAnalyticFunctionTypes
 
class  EquationsSetHelmholtzAnalyticFunctionTypes
 
class  EquationsSetLaplaceAnalyticFunctionTypes
 
class  EquationsSetLinearElasticityAnalyticFunctionTypes
 
class  EquationsSetSolutionMethods
 
class  EquationsSetSubtypes
 
class  EquationsSetTensorEvaluateTypes
 
class  EquationsSetTypes
 
class  EquationsSparsityTypes
 
class  ErrorHandlingModes
 
class  EulerDAESolverTypes
 
class  Field
 
class  FieldDataTypes
 
class  FieldDependentTypes
 
class  FieldDimensionTypes
 
class  FieldDOFOrderTypes
 
class  FieldInterpolationTypes
 
class  FieldMLIO
 
class  FieldParameterSetTypes
 
class  Fields
 
class  FieldScalingTypes
 
class  FieldTypes
 
class  FieldVariableTypes
 
class  GeneratedMesh
 
class  GeneratedMeshSurfaceTypes
 
class  GeneratedMeshTypes
 
class  GlobalDerivativeConstants
 
class  History
 
class  Interface
 
class  InterfaceCondition
 
class  InterfaceConditionIntegrationTypes
 
class  InterfaceConditionMethods
 
class  InterfaceConditionOperators
 
class  InterfaceEquations
 
class  InterfaceMeshConnectivity
 
class  InterfacePointsConnectivity
 
class  IterativeLinearSolverTypes
 
class  IterativePreconditionerTypes
 
class  JacobianCalculationTypes
 
class  LinearSolverTypes
 
class  MatrixStorageTypes
 
class  MatrixVectorDataTypes
 
class  Mesh
 
class  MeshElements
 
class  MeshEmbedding
 
class  MeshNodes
 
class  NavierStokesAnalyticFunctionTypes
 
class  NewtonConvergenceTypes
 
class  NewtonLineSearchTypes
 
class  NewtonSolverTypes
 
class  Nodes
 
class  NonlinearSolverTypes
 
class  PoiseuilleAnalyticFunctionTypes
 
class  PoissonAnalyticFunctionTypes
 
class  Problem
 
class  ProblemClasses
 
class  ProblemControlLoopTypes
 
class  ProblemSubtypes
 
class  ProblemTypes
 
class  Quadrature
 
class  QuasiNewtonLineSearchTypes
 
class  QuasiNewtonRestartTypes
 
class  QuasiNewtonScaleTypes
 
class  QuasiNewtonSolverTypes
 
class  QuasiNewtonTypes
 
class  Region
 
class  SolutionInitialiseTypes
 
class  Solver
 
class  SolverEquations
 
class  SolverEquationsSparsityTypes
 
class  SolverLibraries
 
class  SolverOutputTypes
 
class  SolverTypes
 
class  StokesAnalyticFunctionTypes
 
class  TimingTypes
 

Functions

def AnalyticAnalysis_AbsoluteErrorGetConstantNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def AnalyticAnalysis_AbsoluteErrorGetConstant (field, variableType, componentNumber)
 
def AnalyticAnalysis_AbsoluteErrorGetElementNum (regionUserNumber, fieldUserNumber, variableType, elementNumber, componentNumber)
 
def AnalyticAnalysis_AbsoluteErrorGetElement (field, variableType, elementNumber, componentNumber)
 
def AnalyticAnalysis_AbsoluteErrorGetNodeNum (regionUserNumber, fieldUserNumber, variableType, versionNumber, derivativeNumber, nodeNumber, componentNumber)
 
def AnalyticAnalysis_AbsoluteErrorGetNode (field, variableType, versionNumber, derivativeNumber, nodeNumber, componentNumber)
 
def AnalyticAnalysis_IntegralAbsoluteErrorGetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralAbsoluteErrorGet (field, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralAnalyticValueGetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralAnalyticValueGet (field, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralNIDErrorGetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralNIDErrorGet (field, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralNIDNumericalValueGetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralNIDNumericalValueGet (field, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralNumericalValueGetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralNumericalValueGet (field, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralPercentageErrorGetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralPercentageErrorGet (field, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralRelativeErrorGetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def AnalyticAnalysis_IntegralRelativeErrorGet (field, variableType, componentNumber)
 
def AnalyticAnalysis_OutputNum (regionUserNumber, fieldUserNumber, fileName)
 
def AnalyticAnalysis_Output (field, fileName)
 
def AnalyticAnalysis_PercentageErrorGetConstantNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def AnalyticAnalysis_PercentageErrorGetConstant (field, variableType, componentNumber)
 
def AnalyticAnalysis_PercentageErrorGetElementNum (regionUserNumber, fieldUserNumber, variableType, elementNumber, componentNumber)
 
def AnalyticAnalysis_PercentageErrorGetElement (field, variableType, elementNumber, componentNumber)
 
def AnalyticAnalysis_PercentageErrorGetNodeNum (regionUserNumber, fieldUserNumber, variableType, versionNumber, derivativeNumber, nodeNumber, componentNumber)
 
def AnalyticAnalysis_PercentageErrorGetNode (field, variableType, versionNumber, derivativeNumber, nodeNumber, componentNumber)
 
def AnalyticAnalysis_RMSErrorGetElementNum (regionUserNumber, fieldUserNumber, variableType, componentNumber, errorType)
 
def AnalyticAnalysis_RMSErrorGetElement (field, variableType, componentNumber, errorType)
 
def AnalyticAnalysis_RMSErrorGetNodeNum (regionUserNumber, fieldUserNumber, variableType, componentNumber, errorType)
 
def AnalyticAnalysis_RMSErrorGetNode (field, variableType, componentNumber, errorType)
 
def AnalyticAnalysis_RelativeErrorGetConstantNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def AnalyticAnalysis_RelativeErrorGetConstant (field, variableType, componentNumber)
 
def AnalyticAnalysis_RelativeErrorGetElementNum (regionUserNumber, fieldUserNumber, variableType, elementNumber, componentNumber)
 
def AnalyticAnalysis_RelativeErrorGetElement (field, variableType, elementNumber, componentNumber)
 
def AnalyticAnalysis_RelativeErrorGetNodeNum (regionUserNumber, fieldUserNumber, variableType, versionNumber, derivativeNumber, nodeNumber, componentNumber)
 
def AnalyticAnalysis_RelativeErrorGetNode (field, variableType, versionNumber, derivativeNumber, nodeNumber, componentNumber)
 
def Basis_CollapsedXiGetNum (userNumber, collapsedXiSize)
 
def Basis_CollapsedXiSetNum (userNumber, collapsedXi)
 
def Basis_CreateFinishNum (userNumber)
 
def Basis_CreateStartNum (userNumber)
 
def Basis_DestroyNum (userNumber)
 
def Basis_InterpolationXiGetNum (userNumber, interpolationXiSize)
 
def Basis_InterpolationXiSetNum (userNumber, interpolationXi)
 
def Basis_NumberOfLocalNodesGetNum (userNumber)
 
def Basis_NumberOfXiGetNum (userNumber)
 
def Basis_NumberOfXiSetNum (userNumber, numberOfXi)
 
def Basis_QuadratureLocalFaceGaussEvaluateSetNum (userNumber, faceGaussEvaluate)
 
def Basis_QuadratureMultipleGaussXiGetNum (userNumber, quadratureScheme, GaussPoints, GaussXiSizes)
 
def Basis_QuadratureNumberOfGaussXiGetNum (userNumber, numberOfGaussXiSize)
 
def Basis_QuadratureNumberOfGaussXiSetNum (userNumber, numberOfGaussXi)
 
def Basis_QuadratureOrderGetNum (userNumber)
 
def Basis_QuadratureOrderSetNum (userNumber, quadratureOrder)
 
def Basis_QuadratureSingleGaussXiGetNum (userNumber, quadratureScheme, GaussPoint, GaussXiSize)
 
def Basis_QuadratureTypeGetNum (userNumber)
 
def Basis_QuadratureTypeSetNum (userNumber, quadratureType)
 
def Basis_TypeGetNum (userNumber)
 
def Basis_TypeSetNum (userNumber, basisType)
 
def BioelectricsFiniteElasticity_UpdateGeometricField (controlLoop, calcClosestGaussPoint)
 
def BoundaryConditions_AddConstantNum (regionUserNumber, problemUserNumber, controlLoopIdentifiers, solverIndex, fieldUserNumber, variableType, componentNumber, condition, value)
 
def BoundaryConditions_AddElementNum (regionUserNumber, problemUserNumber, controlLoopIdentifiers, solverIndex, fieldUserNumber, variableType, elementUserNumber, componentNumber, condition, value)
 
def BoundaryConditions_AddNodeNum (regionUserNumber, problemUserNumber, controlLoopIdentifiers, solverIndex, fieldUserNumber, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, condition, value)
 
def BoundaryConditions_ConstrainNodeDofsEqualNum (regionUserNumber, problemUserNumber, controlLoopIdentifier, solverIndex, fieldUserNumber, fieldVariableType, versionNumber, derivativeNumber, component, nodes, coefficient)
 
def BoundaryConditions_DestroyNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def BoundaryConditions_NeumannSparsityTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, sparsityType)
 
def BoundaryConditions_SetConstantNum (regionUserNumber, problemUserNumber, controlLoopIdentifiers, solverIndex, variableType, fieldUserNumber, componentNumber, condition, value)
 
def BoundaryConditions_SetElementNum (regionUserNumber, problemUserNumber, controlLoopIdentifiers, solverIndex, fieldUserNumber, variableType, elementUserNumber, componentNumber, condition, value)
 
def BoundaryConditions_SetNodeNum (regionUserNumber, problemUserNumber, controlLoopIdentifiers, solverIndex, fieldUserNumber, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, condition, value)
 
def CellMLEquations_CellMLAddNum (problemUserNumber, controlLoopIdentifiers, solverIndex, regionUserNumber, CellMLUserNumber)
 
def CellML_CreateCellMLToFieldMapNum (regionUserNumber, CellMLUserNumber, CellMLModelUserNumber, variableID, CellMLParameterSet, fieldUserNumber, variableType, componentNumber, fieldParameterSet)
 
def CellML_CreateFieldToCellMLMapNum (regionUserNumber, CellMLUserNumber, fieldUserNumber, variableType, componentNumber, fieldParameterSet, CellMLModelUserNumber, variableID, CellMLParameterSet)
 
def CellML_CreateFinishNum (regionUserNumber, CellMLUserNumber)
 
def CellML_CreateStartNum (CellMLUserNumber, regionUserNumber)
 
def CellML_DestroyNum (regionUserNumber, CellMLUserNumber)
 
def CellML_FieldComponentGetNum (regionUserNumber, CellMLUserNumber, CellMLModelUserNumber, CellMLFieldType, variableID)
 
def CellML_FieldMapsCreateFinishNum (regionUserNumber, CellMLUserNumber)
 
def CellML_FieldMapsCreateStartNum (regionUserNumber, CellMLUserNumber)
 
def CellML_GenerateNum (regionUserNumber, CellMLUserNumber)
 
def CellML_IntermediateFieldCreateFinishNum (regionUserNumber, CellMLUserNumber)
 
def CellML_IntermediateFieldCreateStartNum (regionUserNumber, CellMLUserNumber, CellMLIntermediateFieldUserNumber)
 
def CellML_IntermediateFieldGetNum (regionUserNumber, CellMLUserNumber)
 
def CellML_ModelImportNum (regionUserNumber, CellMLUserNumber, URI)
 
def CellML_ModelsFieldCreateFinishNum (regionUserNumber, CellMLUserNumber)
 
def CellML_ModelsFieldCreateStartNum (regionUserNumber, CellMLUserNumber, CellMLModelsFieldUserNumber)
 
def CellML_ModelsFieldGetNum (regionUserNumber, CellMLUserNumber)
 
def CellML_ParametersFieldCreateFinishNum (regionUserNumber, CellMLUserNumber)
 
def CellML_ParametersFieldCreateStartNum (regionUserNumber, CellMLUserNumber, CellMLParametersFieldUserNumber)
 
def CellML_ParametersFieldGetNum (regionUserNumber, CellMLUserNumber)
 
def CellML_StateFieldCreateFinishNum (regionUserNumber, CellMLUserNumber)
 
def CellML_StateFieldCreateStartNum (regionUserNumber, CellMLUserNumber, CellMLStateFieldUserNumber)
 
def CellML_StateFieldGetNum (regionUserNumber, CellMLUserNumber)
 
def CellML_VariableSetAsKnownNum (regionUserNumber, CellMLUserNumber, CellMLModelUserNumber, variableID)
 
def CellML_VariableSetAsWantedNum (regionUserNumber, CellMLUserNumber, CellMLModelUserNumber, variableID)
 
def ComputationalNodeNumberGet ()
 
def ComputationalNumberOfNodesGet ()
 
def ControlLoop_AbsoluteToleranceSetNum (problemUserNumber, controlLoopIdentifiers, absoluteTolerance)
 
def ControlLoop_ControlLoopGetNum (problemUserNumber, controlLoopRootIdentifiers, controlLoopIdentifiers, controlLoop)
 
def ControlLoop_CurrentTimesGetNum (problemUserNumber, controlLoopIdentifiers)
 
def ControlLoop_DestroyNum (problemUserNumber, controlLoopIdentifiers)
 
def ControlLoop_IterationsSetNum (problemUserNumber, controlLoopIdentifiers, startIteration, stopIteration, iterationIncrement)
 
def ControlLoop_LabelGetNum (problemUserNumber, controlLoopIdentifiers)
 
def ControlLoop_LabelSetNum (problemUserNumber, controlLoopIdentifiers, label)
 
def ControlLoop_MaximumIterationsSetNum (problemUserNumber, controlLoopIdentifiers, maximumIterations)
 
def ControlLoop_NumberOfIterationsGetNum (problemUserNumber, controlLoopIdentifiers)
 
def ControlLoop_NumberOfIterationsSetNum (problemUserNumber, controlLoopIdentifiers, numberOfIterations)
 
def ControlLoop_NumberOfSubLoopsGetNum (problemUserNumber, controlLoopIdentifiers)
 
def ControlLoop_NumberOfSubLoopsSetNum (problemUserNumber, controlLoopIdentifiers, numberOfSubLoops)
 
def ControlLoop_OutputTypeGetNum (problemUserNumber, controlLoopIdentifiers)
 
def ControlLoop_OutputTypeSetNum (problemUserNumber, controlLoopIdentifiers, outputType)
 
def ControlLoop_TimeInputSetNum (problemUserNumber, controlLoopIdentifiers, inputOption)
 
def ControlLoop_TimeOutputSetNum (problemUserNumber, controlLoopIdentifiers, outputFrequency)
 
def ControlLoop_TimesGetNum (problemUserNumber, controlLoopIdentifiers)
 
def ControlLoop_TimesSetNum (problemUserNumber, controlLoopIdentifiers, startTime, stopTime, timeIncrement)
 
def ControlLoop_TypeSetNum (problemUserNumber, controlLoopIdentifiers, loopType)
 
def CoordinateSystem_CreateFinishNum (coordinateSystemUserNumber)
 
def CoordinateSystem_CreateStartNum (coordinateSystemUserNumber)
 
def CoordinateSystem_DestroyNum (coordinateSystemUserNumber)
 
def CoordinateSystem_DimensionGetNum (coordinateSystemUserNumber)
 
def CoordinateSystem_DimensionSetNum (coordinateSystemUserNumber, coordinateSystemDimension)
 
def CoordinateSystem_FocusGetNum (coordinateSystemUserNumber)
 
def CoordinateSystem_FocusSetNum (coordinateSystemUserNumber, focus)
 
def CoordinateSystem_OrientationGetNum (coordinateSystemUserNumber, orientationSizes)
 
def CoordinateSystem_OrientationSetNum (coordinateSystemUserNumber, orientation)
 
def CoordinateSystem_OriginGetNum (coordinateSystemUserNumber, originSize)
 
def CoordinateSystem_OriginSetNum (coordinateSystemUserNumber, origin)
 
def CoordinateSystem_RadialInterpolationGetNum (coordinateSystemUserNumber)
 
def CoordinateSystem_RadialInterpolationSetNum (coordinateSystemUserNumber, radialInterpolationType)
 
def CoordinateSystem_TypeGetNum (coordinateSystemUserNumber)
 
def CoordinateSystem_TypeSetNum (coordinateSystemUserNumber, coordinateSystemType)
 
def DataPoints_CreateFinishNum (regionUserNumber)
 
def DataPoints_CreateStartNum (regionUserNumber, numberOfDataPoints)
 
def DataPoints_DestroyNum (regionUserNumber)
 
def DataPoints_LabelGetNum (regionUserNumber, dataPointGlobalNumber)
 
def DataPoints_LabelSetNum (regionUserNumber, dataPointGlobalNumber, label)
 
def DataPoints_NumberOfDataPointsGetNum (regionUserNumber)
 
def DataPoints_UserNumberGetNum (regionUserNumber, dataPointGlobalNumber)
 
def DataPoints_UserNumberSetNum (regionUserNumber, dataPointGlobalNumber, dataPointUserNumber)
 
def DataPoints_ValuesGetNum (regionUserNumber, dataPointGlobalNumber, dataPointValuesSize)
 
def DataPoints_ValuesSetNum (regionUserNumber, dataPointGlobalNumber, dataPointValues)
 
def DataPoints_WeightsGetNum (regionUserNumber, dataPointGlobalNumber, dataPointWeightsSize)
 
def DataPoints_WeightsSetNum (regionUserNumber, dataPointGlobalNumber, dataPointWeights)
 
def DataProjection_AbsoluteToleranceGetNum (dataProjectionUserNumber, regionUserNumber)
 
def DataProjection_AbsoluteToleranceSetNum (dataProjectionUserNumber, regionUserNumber, absoluteTolerance)
 
def DataProjection_CreateFinishNum (dataProjectionUserNumber, regionUserNumber)
 
def DataProjection_CreateStartNum (dataProjectionUserNumber, dataPointRegionUserNumber, meshUserNumber, meshRegionUserNumber)
 
def DataProjection_DataPointsPositionEvaluateInterfaceNum (dataProjectionUserNumber, parentRegionUserNumber, interfaceUserNumber, fieldUserNumber, fieldVariableType)
 
def DataProjection_DataPointsPositionEvaluateRegionNum (dataProjectionUserNumber, regionUserNumber, fieldUserNumber, fieldVariableType)
 
def DataProjection_DataPointsProjectionEvaluateNum (dataProjectionUserNumber, dataPointsRegionUserNumber, projectionFieldUserNumber, projectionFieldRegionUserNumber)
 
def DataProjection_DestroyNum (dataProjectionUserNumber, regionUserNumber)
 
def DataProjection_ElementSetInterfaceNum (dataProjectionUserNumber, parentRegionUserNumber, interfaceUserNumber, dataPointNumber, elementNumber)
 
def DataProjection_ElementSetRegionNum (dataProjectionUserNumber, regionUserNumber, dataPointNumber, elementNumber)
 
def DataProjection_LabelGetCInterfaceNum (dataProjectionUserNumber, parentRegionUserNumber, interfaceUserNumber)
 
def DataProjection_LabelGetCRegionNum (dataProjectionUserNumber, regionUserNumber)
 
def DataProjection_LabelSetCInterfaceNum (dataProjectionUserNumber, parentRegionUserNumber, interfaceUserNumber, label)
 
def DataProjection_LabelSetCRegionNum (dataProjectionUserNumber, regionUserNumber, label)
 
def DataProjection_MaximumIterationUpdateGetNum (dataProjectionUserNumber, regionUserNumber)
 
def DataProjection_MaximumIterationUpdateSetNum (dataProjectionUserNumber, regionUserNumber, maximumIterationUpdate)
 
def DataProjection_MaximumNumberOfIterationsGetNum (dataProjectionUserNumber, regionUserNumber)
 
def DataProjection_MaximumNumberOfIterationsSetNum (dataProjectionUserNumber, regionUserNumber, maximumNumberOfIterations)
 
def DataProjection_NumberOfClosestElementsGetNum (dataProjectionUserNumber, regionUserNumber)
 
def DataProjection_NumberOfClosestElementsSetNum (dataProjectionUserNumber, regionUserNumber, numberOfClosestElements)
 
def DataProjection_ProjectionCandidatesSetInterfaceNum (dataProjectionUserNumber, parentRegionUserNumber, interfaceUserNumber, candidateElements, localFaceLineNumbers)
 
def DataProjection_ProjectionCandidatesSetRegionNum (dataProjectionUserNumber, regionUserNumber, candidateElements, localFaceLineNumbers)
 
def DataProjection_ProjectionTypeGetNum (dataProjectionUserNumber, regionUserNumber)
 
def DataProjection_ProjectionTypeSetNum (dataProjectionUserNumber, regionUserNumber, projectionType)
 
def DataProjection_RelativeToleranceGetNum (dataProjectionUserNumber, regionUserNumber)
 
def DataProjection_RelativeToleranceSetNum (dataProjectionUserNumber, regionUserNumber, relativeTolerance)
 
def DataProjection_ResultDistanceGetNum (regionUserNumber, dataProjectionUserNumber, dataPointUserNumber)
 
def DataProjection_ResultElementFaceNumberGetNum (regionUserNumber, dataProjectionUserNumber, dataPointUserNumber)
 
def DataProjection_ResultElementLineNumberGetNum (regionUserNumber, dataProjectionUserNumber, dataPointUserNumber)
 
def DataProjection_ResultElementNumberGetNum (regionUserNumber, dataProjectionUserNumber, dataPointUserNumber)
 
def DataProjection_ResultExitTagGetNum (regionUserNumber, dataProjectionUserNumber, dataPointUserNumber)
 
def DataProjection_ResultProjectionVectorGetNum (regionUserNumber, dataProjectionUserNumber, dataPointUserNumber, projectionVectorSize)
 
def DataProjection_ResultXiGetNum (regionUserNumber, dataProjectionUserNumber, dataPointUserNumber, ProjectionXiSize)
 
def DataProjection_ResultXiSetNum (regionUserNumber, dataProjectionUserNumber, dataPointUserNumber, ProjectionXi)
 
def DataProjection_StartingXiGetNum (dataProjectionUserNumber, regionUserNumber, startingXiSize)
 
def DataProjection_StartingXiSetNum (dataProjectionUserNumber, regionUserNumber, startingXi)
 
def Decomposition_CalculateFacesSetNum (regionUserNumber, meshUserNumber, decompositionUserNumber, calculateFacesFlag)
 
def Decomposition_CalculateLinesSetNum (regionUserNumber, meshUserNumber, decompositionUserNumber, calculateLinesFlag)
 
def Decomposition_CreateFinishNum (regionUserNumber, meshUserNumber, decompositionUserNumber)
 
def Decomposition_CreateStartNum (decompositionUserNumber, regionUserNumber, meshUserNumber)
 
def Decomposition_DestroyNum (regionUserNumber, meshUserNumber, decompositionUserNumber)
 
def Decomposition_ElementDomainCalculateNum (regionUserNumber, meshUserNumber, decompositionUserNumber)
 
def Decomposition_ElementDomainGetNum (regionUserNumber, meshUserNumber, decompositionUserNumber, elementUserNumber)
 
def Decomposition_ElementDomainSetNum (regionUserNumber, meshUserNumber, decompositionUserNumber, elementUserNumber, domain)
 
def Decomposition_MeshComponentGetNum (regionUserNumber, meshUserNumber, decompositionUserNumber)
 
def Decomposition_MeshComponentSetNum (regionUserNumber, meshUserNumber, decompositionUserNumber, meshComponentNumber)
 
def Decomposition_NodeDomainGetNum (regionUserNumber, meshUserNumber, decompositionUserNumber, nodeUserNumber, meshComponentNumber)
 
def Decomposition_NumberOfDomainsGetNum (regionUserNumber, meshUserNumber, decompositionUserNumber)
 
def Decomposition_NumberOfDomainsSetNum (regionUserNumber, meshUserNumber, decompositionUserNumber, numberOfDomains)
 
def Decomposition_TypeGetNum (regionUserNumber, meshUserNumber, decompositionUserNumber)
 
def Decomposition_TypeSetNum (regionUserNumber, meshUserNumber, decompositionUserNumber, decompositionType)
 
def DiagnosticsSetOff ()
 
def DiagnosticsSetOn (diagType, levelList, diagFilename, routineList)
 
def EquationsSet_AnalyticCreateFinishNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_AnalyticCreateStartNum (regionUserNumber, equationsSetUserNumber, analyticFunctionType, analyticFieldUserNumber)
 
def EquationsSet_AnalyticDestroyNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_AnalyticEvaluateNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_AnalyticTimeGetNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_AnalyticTimeSetNum (regionUserNumber, equationsSetUserNumber, time)
 
def EquationsSet_AnalyticUserParamGetNum (regionUserNumber, equationsSetUserNumber, paramIdx)
 
def EquationsSet_AnalyticUserParamSetNum (regionUserNumber, equationsSetUserNumber, paramIdx, param)
 
def EquationsSet_CreateFinishNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_CreateStartNum (equationsSetUserNumber, regionUserNumber, geomFibreFieldUserNumber, equationsSetSpecification, equationsSetFieldUserNumber)
 
def EquationsSet_DependentCreateFinishNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_DependentCreateStartNum (regionUserNumber, equationsSetUserNumber, dependentFieldUserNumber)
 
def EquationsSet_DependentDestroyNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_DerivedCreateFinishNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_DerivedCreateStartNum (regionUserNumber, equationsSetUserNumber, derivedFieldUserNumber)
 
def EquationsSet_DerivedDestroyNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_DerivedVariableCalculateNum (regionUserNumber, equationsSetUserNumber, derivedType)
 
def EquationsSet_DerivedVariableSetNum (regionUserNumber, equationsSetUserNumber, derivedType, fieldVariableType)
 
def EquationsSet_DestroyNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_EquationsCreateFinishNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_EquationsCreateStartNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_EquationsDestroyNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_IndependentCreateFinishNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_IndependentCreateStartNum (regionUserNumber, equationsSetUserNumber, independentFieldUserNumber)
 
def EquationsSet_IndependentDestroyNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_MaterialsCreateFinishNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_MaterialsCreateStartNum (regionUserNumber, equationsSetUserNumber, materialsFieldUserNumber)
 
def EquationsSet_MaterialsDestroyNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_SolutionMethodGetNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_SolutionMethodSetNum (regionUserNumber, equationsSetUserNumber, solutionMethod)
 
def EquationsSet_SourceCreateFinishNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_SourceCreateStartNum (regionUserNumber, equationsSetUserNumber, sourceFieldUserNumber)
 
def EquationsSet_SourceDestroyNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_SpecificationGetNum (regionUserNumber, equationsSetUserNumber, equationsSetSpecification)
 
def EquationsSet_SpecificationSizeGetNum (regionUserNumber, equationsSetUserNumber)
 
def EquationsSet_TensorInterpolateXiNum (regionUserNumber, equationsSetUserNumber, tensorEvaluateType, userElementNumber, xi, valuesSizes)
 
def Equations_DestroyNum (regionUserNumber, equationsSetUserNumber)
 
def Equations_LinearityTypeGetNum (regionUserNumber, equationsSetUserNumber)
 
def Equations_LumpingTypeGetNum (regionUserNumber, equationsSetUserNumber)
 
def Equations_LumpingTypeSetNum (regionUserNumber, equationsSetUserNumber, lumpingType)
 
def Equations_OutputTypeGetNum (regionUserNumber, equationsSetUserNumber)
 
def Equations_OutputTypeSetNum (regionUserNumber, equationsSetUserNumber, outputType)
 
def Equations_SparsityTypeGetNum (regionUserNumber, equationsSetUserNumber)
 
def Equations_SparsityTypeSetNum (regionUserNumber, equationsSetUserNumber, sparsityType)
 
def Equations_TimeDependenceTypeGetNum (regionUserNumber, equationsSetUserNumber)
 
def ErrorHandlingModeGet ()
 
def ErrorHandlingModeSet (errorHandlingMode)
 
def ExtractErrorMessage ()
 
def Field_ComponentInterpolationGetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def Field_ComponentInterpolationSetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber, interpolationType)
 
def Field_ComponentLabelGetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def Field_ComponentLabelSetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber, label)
 
def Field_ComponentMeshComponentGetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber)
 
def Field_ComponentMeshComponentSetNum (regionUserNumber, fieldUserNumber, variableType, componentNumber, meshComponent)
 
def Field_ComponentValuesInitialiseDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_ComponentValuesInitialiseIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_ComponentValuesInitialiseLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_ComponentValuesInitialiseSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_CreateFinishNum (regionUserNumber, fieldUserNumber)
 
def Field_CreateStartNum (fieldUserNumber, regionUserNumber)
 
def Field_DOFOrderTypeGetNum (regionUserNumber, fieldUserNumber, variableType)
 
def Field_DOFOrderTypeSetNum (regionUserNumber, fieldUserNumber, variableType, DOFOrderType)
 
def Field_DataProjectionSetNum (regionUserNumber, fieldUserNumber, dataProjectionUserNumber)
 
def Field_DataTypeGetNum (regionUserNumber, fieldUserNumber, variableType)
 
def Field_DataTypeSetNum (regionUserNumber, fieldUserNumber, variableType, dataType)
 
def Field_DependentTypeGetNum (regionUserNumber, fieldUserNumber)
 
def Field_DependentTypeSetNum (regionUserNumber, fieldUserNumber, dependentType)
 
def Field_DestroyNum (regionUserNumber, fieldUserNumber)
 
def Field_DimensionGetNum (regionUserNumber, fieldUserNumber, variableType)
 
def Field_DimensionSetNum (regionUserNumber, fieldUserNumber, variableType, dimension)
 
def Field_GeometricFieldGetNum (regionUserNumber, fieldUserNumber)
 
def Field_GeometricFieldSetNum (regionUserNumber, fieldUserNumber, geometricFieldUserNumber)
 
def Field_GeometricParametersElementLineLengthGetNum (regionUserNumber, geometricFieldUserNumber, elementNumber, elementLineNumber)
 
def Field_GeometricParametersElementVolumeGetNum (regionUserNumber, geometricFieldUserNumber, elementNumber)
 
def Field_LabelGetNum (regionUserNumber, fieldUserNumber)
 
def Field_LabelSetNum (regionUserNumber, fieldUserNumber, label)
 
def Field_MeshDecompositionGetNum (regionUserNumber, fieldUserNumber)
 
def Field_MeshDecompositionSetNum (regionUserNumber, fieldUserNumber, meshUserNumber, decompositionUserNumber)
 
def Field_NumberOfComponentsGetNum (regionUserNumber, fieldUserNumber, variableType)
 
def Field_NumberOfComponentsSetNum (regionUserNumber, fieldUserNumber, variableType, numberOfComponents)
 
def Field_NumberOfVariablesGetNum (regionUserNumber, fieldUserNumber)
 
def Field_NumberOfVariablesSetNum (regionUserNumber, fieldUserNumber, numberOfVariables)
 
def Field_ParameterSetAddConstantDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_ParameterSetAddConstantIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_ParameterSetAddConstantLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_ParameterSetAddConstantSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_ParameterSetAddElementDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber, value)
 
def Field_ParameterSetAddElementIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber, value)
 
def Field_ParameterSetAddElementLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber, value)
 
def Field_ParameterSetAddElementSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber, value)
 
def Field_ParameterSetAddNodeDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
 
def Field_ParameterSetAddNodeIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
 
def Field_ParameterSetAddNodeLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
 
def Field_ParameterSetAddNodeSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
 
def Field_ParameterSetCreateNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType)
 
def Field_ParameterSetDataGetDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType)
 
def Field_ParameterSetDataGetIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType)
 
def Field_ParameterSetDataGetLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType)
 
def Field_ParameterSetDataGetSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType)
 
def Field_ParameterSetDataRestoreDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, parameters)
 
def Field_ParameterSetDataRestoreIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, parameters)
 
def Field_ParameterSetDataRestoreLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, parameters)
 
def Field_ParameterSetDataRestoreSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, parameters)
 
def Field_ParameterSetDestroyNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType)
 
def Field_ParameterSetGetConstantDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber)
 
def Field_ParameterSetGetConstantIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber)
 
def Field_ParameterSetGetConstantLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber)
 
def Field_ParameterSetGetConstantSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber)
 
def Field_ParameterSetGetDataPointDPNumberI (parentRegionUserNumber, interfaceUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber)
 
def Field_ParameterSetGetDataPointDPNumberR (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber)
 
def Field_ParameterSetGetDataPointIntgNumberI (parentRegionUserNumber, interfaceUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber)
 
def Field_ParameterSetGetDataPointIntgNumberR (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber)
 
def Field_ParameterSetGetDataPointLNumberI (parentRegionUserNumber, interfaceUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber)
 
def Field_ParameterSetGetDataPointLNumberR (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber)
 
def Field_ParameterSetGetDataPointSPNumberI (parentRegionUserNumber, interfaceUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber)
 
def Field_ParameterSetGetDataPointSPNumberR (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber)
 
def Field_ParameterSetGetElementDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber)
 
def Field_ParameterSetGetElementIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber)
 
def Field_ParameterSetGetElementLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber)
 
def Field_ParameterSetGetElementSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber)
 
def Field_ParameterSetGetGaussPointCoord (meshEmbedding, componentNumber, coordsSize)
 
def Field_ParameterSetGetNodeDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber)
 
def Field_ParameterSetGetNodeIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber)
 
def Field_ParameterSetGetNodeLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber)
 
def Field_ParameterSetGetNodeSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber)
 
def Field_ParameterSetInterpolateMultipleGaussDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, derivativeNumber, userElementNumber, quadratureScheme, GaussPoints, valuesSizes)
 
def Field_ParameterSetInterpolateMultipleXiDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, derivativeNumber, userElementNumber, xi, valuesSizes)
 
def Field_ParameterSetInterpolateSingleGaussDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, derivativeNumber, userElementNumber, quadratureScheme, GaussPoint, valuesSize)
 
def Field_ParameterSetInterpolateSingleXiDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, derivativeNumber, userElementNumber, xi, valuesSize)
 
def Field_ParameterSetNodeNumberOfScaleFactorDofsGetNum (regionUserNumber, fieldUserNumber, variableType, meshComponentNumber)
 
def Field_ParameterSetNodeScaleFactorGetNum (regionUserNumber, fieldUserNumber, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber)
 
def Field_ParameterSetNodeScaleFactorSetNum (regionUserNumber, fieldUserNumber, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, scaleFactor)
 
def Field_ParameterSetNodeScaleFactorsGetNum (regionUserNumber, fieldUserNumber, variableType, meshComponentNumber, scaleFactorsSize)
 
def Field_ParameterSetNodeScaleFactorsSetNum (regionUserNumber, fieldUserNumber, variableType, meshComponentNumber, scaleFactors)
 
def Field_ParameterSetUpdateConstantDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_ParameterSetUpdateConstantIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_ParameterSetUpdateConstantLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_ParameterSetUpdateConstantSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, componentNumber, value)
 
def Field_ParameterSetUpdateDataPointDPNumberI (parentRegionUserNumber, interfaceUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
 
def Field_ParameterSetUpdateDataPointDPNumberR (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
 
def Field_ParameterSetUpdateDataPointIntgNumberI (parentRegionUserNumber, interfaceUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
 
def Field_ParameterSetUpdateDataPointIntgNumberR (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
 
def Field_ParameterSetUpdateDataPointLNumberI (parentRegionUserNumber, interfaceUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
 
def Field_ParameterSetUpdateDataPointLNumberR (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
 
def Field_ParameterSetUpdateDataPointSPNumberI (parentRegionUserNumber, interfaceUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
 
def Field_ParameterSetUpdateDataPointSPNumberR (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
 
def Field_ParameterSetUpdateElementDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber, value)
 
def Field_ParameterSetUpdateElementIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber, value)
 
def Field_ParameterSetUpdateElementLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber, value)
 
def Field_ParameterSetUpdateElementSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, userElementNumber, componentNumber, value)
 
def Field_ParameterSetUpdateFinishNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType)
 
def Field_ParameterSetUpdateGaussPointDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value)
 
def Field_ParameterSetUpdateGaussPointIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value)
 
def Field_ParameterSetUpdateGaussPointLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value)
 
def Field_ParameterSetUpdateGaussPointSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value)
 
def Field_ParameterSetUpdateNodeDPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
 
def Field_ParameterSetUpdateNodeIntgNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
 
def Field_ParameterSetUpdateNodeLNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
 
def Field_ParameterSetUpdateNodeSPNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
 
def Field_ParameterSetUpdateStartNum (regionUserNumber, fieldUserNumber, variableType, fieldSetType)
 
def Field_ParametersToFieldParametersComponentCopyNum (fromRegionUserNumber, fromFieldUserNumber, fromVariableType, fromParameterSetType, fromComponentNumber, toRegionUserNumber, toFieldUserNumber, toVariableType, toParameterSetType, toComponentNumber)
 
def Field_PositionNormalTangentCalculateNodeNum (regionUserNumber, fieldUserNumber, variableType, componentNumber, localNodeNumber, positionSize, normalSize, tangentsSizes)
 
def Field_ScalingTypeGetNum (regionUserNumber, fieldUserNumber)
 
def Field_ScalingTypeSetNum (regionUserNumber, fieldUserNumber, scalingType)
 
def Field_TypeGetNum (regionUserNumber, fieldUserNumber)
 
def Field_TypeSetNum (regionUserNumber, fieldUserNumber, fieldType)
 
def Field_VariableLabelGetNum (regionUserNumber, fieldUserNumber, variableType)
 
def Field_VariableLabelSetNum (regionUserNumber, fieldUserNumber, variableType, label)
 
def Field_VariableTypesGetNum (regionUserNumber, fieldUserNumber, variableTypesSize)
 
def Field_VariableTypesSetNum (regionUserNumber, fieldUserNumber, variableTypes)
 
def Finalise ()
 
def GeneratedMesh_BaseVectorsSetNum (regionUserNumber, generatedMeshUserNumber, baseVectors)
 
def GeneratedMesh_BasisGetNum (regionUserNumber, generatedMeshUserNumber, basisUserNumbers)
 
def GeneratedMesh_BasisSetNum (regionUserNumber, generatedMeshUserNumber, basisUserNumbers)
 
def GeneratedMesh_CreateFinishNum (regionUserNumber, generatedMeshUserNumber, meshUserNumber)
 
def GeneratedMesh_CreateStartNum (generatedMeshUserNumber, regionUserNumber)
 
def GeneratedMesh_DestroyNum (regionUserNumber, generatedMeshUserNumber)
 
def GeneratedMesh_ExtentGetNum (regionUserNumber, generatedMeshUserNumber, extentSize)
 
def GeneratedMesh_ExtentSetNum (regionUserNumber, generatedMeshUserNumber, extent)
 
def GeneratedMesh_GeometricParametersCalculateNum (regionUserNumber, generatedMeshUserNumber, fieldUserNumber)
 
def GeneratedMesh_NumberOfElementsGetNum (regionUserNumber, generatedMeshUserNumber, numberOfElementsSize)
 
def GeneratedMesh_NumberOfElementsSetNum (regionUserNumber, generatedMeshUserNumber, numberOfElements)
 
def GeneratedMesh_OriginGetNum (regionUserNumber, generatedMeshUserNumber, originSize)
 
def GeneratedMesh_OriginSetNum (regionUserNumber, generatedMeshUserNumber, origin)
 
def GeneratedMesh_TypeGetNum (regionUserNumber, generatedMeshUserNumber)
 
def GeneratedMesh_TypeSetNum (regionUserNumber, generatedMeshUserNumber, generatedMeshType)
 
def InitialiseNum ()
 
def Initialise (worldCoordinateSystem, worldRegion)
 
def InterfaceCondition_CreateFinishNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def InterfaceCondition_CreateStartNum (interfaceConditionUserNumber, regionUserNumber, interfaceUserNumber, geometricFieldUserNumber)
 
def InterfaceCondition_DependentVariableAddNum (interfaceRegionUserNumber, interfaceUserNumber, interfaceConditionUserNumber, meshIndex, equationsSetRegionUserNumber, equationsSetUserNumber, variableType)
 
def InterfaceCondition_DestroyNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def InterfaceCondition_EquationsCreateFinishNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def InterfaceCondition_EquationsCreateStartNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def InterfaceCondition_EquationsDestroyNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def InterfaceCondition_IntegrationTypeGetNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def InterfaceCondition_IntegrationTypeSetNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber, interfaceConditionIntegrationType)
 
def InterfaceCondition_LagrangeFieldCreateFinishNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def InterfaceCondition_LagrangeFieldCreateStartNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber, lagrangeFieldUserNumber)
 
def InterfaceCondition_MethodGetNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def InterfaceCondition_MethodSetNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber, interfaceConditionMethod)
 
def InterfaceCondition_OperatorGetNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def InterfaceCondition_OperatorSetNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber, interfaceConditionOperator)
 
def InterfaceCondition_PenaltyFieldCreateFinishNum (RegionUserNumber, InterfaceUserNumber, InterfaceConditionUserNumber)
 
def InterfaceCondition_PenaltyFieldCreateStartNum (RegionUserNumber, InterfaceUserNumber, InterfaceConditionUserNumber, PenaltyFieldUserNumber)
 
def InterfaceEquations_OutputTypeGetNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def InterfaceEquations_OutputTypeSetNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber, outputType)
 
def InterfaceEquations_SparsityGetNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def InterfaceEquations_SparsitySetNum (regionUserNumber, interfaceUserNumber, interfaceConditionUserNumber, sparsityType)
 
def InterfaceMatrices_TimeDependenceTypeGet (interfaceCondition, interfaceMatrixIndex, hasTranspose, timeDependenceTypesSize)
 
def InterfaceMatrices_TimeDependenceTypeSet (interfaceCondition, interfaceMatrixIndex, hasTranspose, timeDependenceTypes)
 
def InterfaceMeshConnectivity_BasisSetNum (regionUserNumber, interfaceUserNumber, interfaceBasisNumber)
 
def InterfaceMeshConnectivity_CreateFinishNum (regionUserNumber, interfaceUserNumber)
 
def InterfaceMeshConnectivity_CreateStartNum (regionUserNumber, interfaceUserNumber, meshNumber)
 
def InterfaceMeshConnectivity_DestroyNum (regionUserNumber, interfaceUserNumber)
 
def InterfaceMeshConnectivity_ElementNumberSetNum (regionUserNumber, interfaceUserNumber, interfaceElementNumber, coupledMeshIndexNumber, coupledMeshElementNumber)
 
def InterfaceMeshConnectivity_ElementXiSetNum (regionUserNumber, interfaceUserNumber, interfaceElementNumber, coupledMeshIndexNumber, coupledMeshElementNumber, interfaceMeshLocalNodeNumber, interfaceMeshComponentNodeNumber, xi)
 
def InterfaceMeshConnectivity_NodeNumberSetNum (regionUserNumber, interfaceUserNumber, interfaceElementNumber, coupledMeshIndexNumber, coupledMeshElementNumber)
 
def InterfacePointsConnectivity_CreateFinishNum (regionUserNumber, interfaceUserNumber)
 
def InterfacePointsConnectivity_CreateStartNum (regionUserNumber, interfaceUserNumber, MeshNumber)
 
def InterfacePointsConnectivity_DestroyNum (regionUserNumber, interfaceUserNumber)
 
def InterfacePointsConnectivity_ElementNumberGetNum (regionUserNumber, interfaceUserNumber, interfaceDataPointIndexNumber, coupledMeshIndexNumber, meshComponentNumber)
 
def InterfacePointsConnectivity_ElementNumberSetNum (regionUserNumber, interfaceUserNumber, interfaceDataPointIndexNumber, coupledMeshIndexNumber, coupledMeshElementNumber, meshComponentNumber)
 
def InterfacePointsConnectivity_PointXiGetNum (regionUserNumber, interfaceUserNumber, interfaceDataPointIndexNumber, coupledMeshIndexNumber, xiSize)
 
def InterfacePointsConnectivity_PointXiSetNum (regionUserNumber, interfaceUserNumber, interfaceDataPointIndexNumber, coupledMeshIndexNumber, xi)
 
def InterfacePointsConnectivity_UpdateFromProjectionINum (regionUserNumber, interfaceUserNumber, dataPointsRegionUserNumber, dataPointsInterfaceUserNumber, dataProjectionUserNumber, coupledMeshIndex)
 
def InterfacePointsConnectivity_UpdateFromProjectionRNum (regionUserNumber, interfaceUserNumber, dataPointsRegionUserNumber, dataProjectionUserNumber, coupledMeshIndex)
 
def Interface_CoordinateSystemGetNum (parentRegionUserNumber, interfaceUserNumber)
 
def Interface_CoordinateSystemSetNum (parentRegionUserNumber, interfaceUserNumber, coordinateSystemUserNumber)
 
def Interface_CreateFinishNum (regionUserNumber, interfaceUserNumber)
 
def Interface_CreateStartNum (interfaceUserNumber, regionUserNumber)
 
def Interface_DestroyNum (regionUserNumber, interfaceUserNumber)
 
def Interface_LabelGetNum (parentRegionUserNumber, interfaceUserNumber)
 
def Interface_LabelSetNum (parentRegionUserNumber, interfaceUserNumber, label)
 
def Interface_MeshAddNum (interfaceRegionUserNumber, interfaceUserNumber, meshRegionUserNumber, meshUserNumber)
 
def MeshElements_AdjacentElementGetNum (regionUserNumber, meshUserNumber, meshComponentNumber, globalElementNumber, adjacentElementXi)
 
def MeshElements_BasisGetNum (regionUserNumber, meshUserNumber, meshComponentNumber, globalElementNumber)
 
def MeshElements_BasisSetNum (regionUserNumber, meshUserNumber, meshComponentNumber, globalElementNumber, basisUserNumber)
 
def MeshElements_CreateFinishNum (regionUserNumber, meshUserNumber, meshComponentNumber)
 
def MeshElements_CreateStartNum (regionUserNumber, meshUserNumber, meshComponentNumber, basisUserNumber)
 
def MeshElements_LocalElementNodeVersionSetNum (regionUserNumber, meshUserNumber, globalElementNumber, versionNumber, derivativeNumber, localElementNodeNumber, meshComponentNumber)
 
def MeshElements_NodesGetNum (regionUserNumber, meshUserNumber, meshComponentNumber, globalElementNumber, elementUserNodesSize)
 
def MeshElements_NodesSetNum (regionUserNumber, meshUserNumber, meshComponentNumber, globalElementNumber, elementUserNodes)
 
def MeshElements_UserNodeVersionSetNum (regionUserNumber, meshUserNumber, globalElementNumber, versionNumber, derivativeNumber, userNodeNumber, meshComponentNumber)
 
def MeshElements_UserNumberGetNum (regionUserNumber, meshUserNumber, meshComponentNumber, elementGlobalNumber)
 
def MeshElements_UserNumberSetNum (regionUserNumber, meshUserNumber, meshComponentNumber, elementGlobalNumber, elementUserNumber)
 
def MeshElements_UserNumbersAllSetNum (regionUserNumber, meshUserNumber, meshComponentNumber, elementUserNumbers)
 
def MeshEmbedding_CreateNum (regionOneUserNumber, regionTwoUserNumber, meshEmbedding, parentMeshUserNumber, childMeshUserNumber)
 
def MeshNodes_DerivativesGetNum (regionUserNumber, meshUserNumber, meshComponentNumber, userNodeNumber, derivativesSize)
 
def MeshNodes_NumberOfDerivativesGetNum (regionUserNumber, meshUserNumber, meshComponentNumber, userNodeNumber)
 
def MeshNodes_NumberOfNodesGetNum (regionUserNumber, meshUserNumber, meshComponentNumber)
 
def MeshNodes_NumberOfVersionsGetNum (regionUserNumber, meshUserNumber, meshComponentNumber, derivativeNumber, userNodeNumber)
 
def Mesh_CreateFinishNum (regionUserNumber, meshUserNumber)
 
def Mesh_CreateStartNum (meshUserNumber, regionUserNumber, numberOfDimensions)
 
def Mesh_DestroyNum (regionUserNumber, meshUserNumber)
 
def Mesh_ElementExistsNum (regionUserNumber, meshUserNumber, meshComponentNumber, elementUserNumber)
 
def Mesh_ElementsGetNum (regionUserNumber, meshUserNumber, meshComponentNumber, meshElements)
 
def Mesh_NodeExistsNum (regionUserNumber, meshUserNumber, meshComponentNumber, nodeUserNumber)
 
def Mesh_NodesGetNum (regionUserNumber, meshUserNumber, meshComponentNumber, meshNodes)
 
def Mesh_NumberOfComponentsGetNum (regionUserNumber, meshUserNumber)
 
def Mesh_NumberOfComponentsSetNum (regionUserNumber, meshUserNumber, numberOfComponents)
 
def Mesh_NumberOfElementsGetNum (regionUserNumber, meshUserNumber)
 
def Mesh_NumberOfElementsSetNum (regionUserNumber, meshUserNumber, numberOfElements)
 
def Mesh_SurroundingElementsCalculateSetNum (regionUserNumber, meshUserNumber, surroundingElementsCalculateFlag)
 
def Mesh_TopologyDataPointsCalculateProjectionInterfaceNum (parentRegionUserNumber, interfaceUserNumber, MeshUserNumber, DataProjection)
 
def Mesh_TopologyDataPointsCalculateProjectionRegionNum (regionUserNumber, MeshUserNumber, DataProjection)
 
def Nodes_CreateFinishNum (regionUserNumber)
 
def Nodes_CreateStartNum (regionUserNumber, numberOfNodes)
 
def Nodes_DestroyNum (regionUserNumber)
 
def Nodes_LabelGetNum (regionUserNumber, nodeGlobalNumber)
 
def Nodes_LabelSetNum (regionUserNumber, nodeGlobalNumber, label)
 
def Nodes_NumberOfNodesGetNum (regionUserNumber)
 
def Nodes_UserNumberGetNum (regionUserNumber, nodeGlobalNumber)
 
def Nodes_UserNumberSetNum (regionUserNumber, nodeGlobalNumber, nodeUserNumber)
 
def Nodes_UserNumbersAllSetNum (regionUserNumber, nodeUserNumbers)
 
def OutputSetOff ()
 
def OutputSetOn (echoFilename)
 
def Problem_CellMLEquationsCreateFinishNum (problemUserNumber)
 
def Problem_CellMLEquationsCreateStartNum (problemUserNumber)
 
def Problem_CellMLEquationsGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, CellMLEquations)
 
def Problem_ControlLoopCreateFinishNum (problemUserNumber)
 
def Problem_ControlLoopCreateStartNum (problemUserNumber)
 
def Problem_ControlLoopDestroyNum (problemUserNumber)
 
def Problem_ControlLoopGetNum (problemUserNumber, controlLoopIdentifiers, controlLoop)
 
def Problem_CreateFinishNum (problemUserNumber)
 
def Problem_CreateStartNum (problemUserNumber, problemSpecification)
 
def Problem_DestroyNum (problemUserNumber)
 
def Problem_SolveNum (problemUserNumber)
 
def Problem_SolverEquationsCreateFinishNum (problemUserNumber)
 
def Problem_SolverEquationsCreateStartNum (problemUserNumber)
 
def Problem_SolverEquationsDestroyNum (problemUserNumber)
 
def Problem_SolverEquationsGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, solverEquations)
 
def Problem_SolverGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, solver)
 
def Problem_SolversCreateFinishNum (problemUserNumber)
 
def Problem_SolversCreateStartNum (problemUserNumber)
 
def Problem_SolversDestroyNum (problemUserNumber)
 
def Problem_SpecificationGetNum (problemUserNumber, problemSpecification)
 
def Problem_SpecificationSizeGetNum (problemUserNumber)
 
def RandomSeedsGet (randomSeedsSize)
 
def RandomSeedsSet (randomSeeds)
 
def RandomSeedsSizeGet ()
 
def Region_CoordinateSystemGetNum (regionUserNumber)
 
def Region_CoordinateSystemSetNum (regionUserNumber, coordinateSystemUserNumber)
 
def Region_CreateFinishNum (regionUserNumber)
 
def Region_CreateStartNum (regionUserNumber, parentRegionUserNumber)
 
def Region_DestroyNum (regionUserNumber)
 
def Region_LabelGetNum (regionUserNumber)
 
def Region_LabelSetNum (regionUserNumber, label)
 
def SolverEquations_BoundaryConditionsAnalyticNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def SolverEquations_BoundaryConditionsCreateFinishNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def SolverEquations_BoundaryConditionsCreateStartNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def SolverEquations_BoundaryConditionsGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, boundaryConditions)
 
def SolverEquations_EquationsSetAddNum (problemUserNumber, controlLoopIdentifiers, solverIndex, regionUserNumber, equationsSetUserNumber)
 
def SolverEquations_InterfaceConditionAddNum (problemUserNumber, controlLoopIdentifiers, solverIndex, interfaceRegionUserNumber, interfaceUserNumber, interfaceConditionUserNumber)
 
def SolverEquations_SparsityTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, sparsityType)
 
def Solver_CellMLEquationsGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, CellMLEquations)
 
def Solver_DAEEulerSolverTypeGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_DAEEulerSolverTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, DAEEulerSolverType)
 
def Solver_DAESolverTypeGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_DAESolverTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, DAESolverType)
 
def Solver_DAETimeStepSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, timeStep)
 
def Solver_DAETimesSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, startTime, endTime)
 
def Solver_DynamicDegreeGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_DynamicDegreeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, degree)
 
def Solver_DynamicLinearSolverGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_DynamicLinearityTypeGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_DynamicNonlinearSolverGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_DynamicSchemeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, scheme)
 
def Solver_DynamicThetaSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, thetas)
 
def Solver_DynamicTimesSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, currentTime, timeIncrement)
 
def Solver_GeometricTransformationArbitraryPathSetNum (problemUserNumber, controlLoopIdentifier, solverIndex, arbitraryPath)
 
def Solver_GeometricTransformationClearNum (problemUserNumber, controlLoopIdentifier, solverIndex)
 
def Solver_GeometricTransformationFieldSetNum (problemUserNumber, controlLoopIdentifier, solverIndex, regionUserNumber, fieldUserNumber, variableType)
 
def Solver_GeometricTransformationMatrixSetNum (problemUserNumber, controlLoopIdentifier, solverIndex, matrix, loadIncrementIdx)
 
def Solver_GeometricTransformationNoLoadIncrementsSetNum (problemUserNumber, controlLoopIdentifier, solverIndex, numberOfIncrements)
 
def Solver_GeometricTransformationRotationSetNum (problemUserNumber, controlLoopIdentifier, solverIndex, pivotPoint, axis, angle, loadIncrementIdx)
 
def Solver_GeometricTransformationScalingsSetNum (problemUserNumber, controlLoopIdentifier, solverIndex, scalings)
 
def Solver_GeometricTransformationTranslationSetNum (problemUserNumber, controlLoopIdentifier, solverIndex, translation, loadIncrementIdx)
 
def Solver_LabelGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_LabelSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, label)
 
def Solver_LibraryTypeGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_LibraryTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, libraryType)
 
def Solver_LinearDirectTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, directSolverType)
 
def Solver_LinearIterativeAbsoluteToleranceSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, absoluteTolerance)
 
def Solver_LinearIterativeDivergenceToleranceSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, divergenceTolerance)
 
def Solver_LinearIterativeGMRESRestartSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, GMRESRestart)
 
def Solver_LinearIterativeMaximumIterationsSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, maximumIterations)
 
def Solver_LinearIterativePreconditionerTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, preconditionerType)
 
def Solver_LinearIterativeRelativeToleranceSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, relativeTolerance)
 
def Solver_LinearIterativeTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, iterativeSolverType)
 
def Solver_LinearTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, linearSolverType)
 
def Solver_NewtonAbsoluteToleranceSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, absoluteTolerance)
 
def Solver_NewtonCellMLSolverGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_NewtonConvergenceTestTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, convergenceTestType)
 
def Solver_NewtonJacobianCalculationTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, jacobianCalculationType)
 
def Solver_NewtonLineSearchAlphaSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, alpha)
 
def Solver_NewtonLineSearchMaxStepSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, maxStep)
 
def Solver_NewtonLineSearchMonitorOutputSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, monitorLinesearchFlag)
 
def Solver_NewtonLineSearchStepTolSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, stepTol)
 
def Solver_NewtonLineSearchTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, lineSearchType)
 
def Solver_NewtonLinearSolverGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_NewtonMaximumFunctionEvaluationsSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, maximumFunctionEvaluations)
 
def Solver_NewtonMaximumIterationsSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, maximumIterations)
 
def Solver_NewtonRelativeToleranceSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, relativeTolerance)
 
def Solver_NewtonSolutionToleranceSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, solutionTolerance)
 
def Solver_NewtonTrustRegionDelta0SetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, delta0)
 
def Solver_NewtonTrustRegionToleranceSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, tolerance)
 
def Solver_NewtonTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, newtonSolveType)
 
def Solver_NonlinearTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, nonlinearSolveType)
 
def Solver_OutputTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, outputType)
 
def Solver_QuasiNewtonAbsoluteToleranceSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, absoluteTolerance)
 
def Solver_QuasiNewtonCellMLSolverGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_QuasiNewtonConvergenceTestTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, convergenceTestType)
 
def Solver_QuasiNewtonJacobianCalculationTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, jacobianCalculationType)
 
def Solver_QuasiNewtonLineSearchMaxStepSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, maxStep)
 
def Solver_QuasiNewtonLineSearchMonitorOutputSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, monitorLinesearchFlag)
 
def Solver_QuasiNewtonLineSearchStepTolSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, stepTol)
 
def Solver_QuasiNewtonLineSearchTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, lineSearchType)
 
def Solver_QuasiNewtonLinearSolverGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex)
 
def Solver_QuasiNewtonMaximumFunctionEvaluationsSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, maximumFunctionEvaluations)
 
def Solver_QuasiNewtonMaximumIterationsSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, maximumIterations)
 
def Solver_QuasiNewtonRelativeToleranceSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, relativeTolerance)
 
def Solver_QuasiNewtonRestartSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, quasiNewtonRestart)
 
def Solver_QuasiNewtonRestartTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, quasiNewtonRestartType)
 
def Solver_QuasiNewtonScaleTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, quasiNewtonScaleType)
 
def Solver_QuasiNewtonSolutionToleranceSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, solutionTolerance)
 
def Solver_QuasiNewtonSolveTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, quasiNewtonSolveType)
 
def Solver_QuasiNewtonTrustRegionDelta0SetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, delta0)
 
def Solver_QuasiNewtonTrustRegionToleranceSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, tolerance)
 
def Solver_QuasiNewtonTypeSetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, quasiNewtonType)
 
def Solver_SolverEquationsGetNum (problemUserNumber, controlLoopIdentifiers, solverIndex, solverEquations)
 
def TimingSetOff ()
 
def TimingSetOn (timingType, timingSummaryFlag, timingFilename, routineList)
 
def TimingSummaryOutput ()
 
def UserNumberGetBasis (basis)
 
def UserNumberGetMesh (mesh)
 
def UserNumberGetRegion (region)
 
def WorkingRealPrecisionGet ()
 
def Field_ParameterSetDataGet (self, args)
 
def Field_ParameterSetDataRestore (self, args)
 
def Field_ComponentValuesInitialise (self, args)
 
def Field_ParameterSetGetConstant (self, args)
 
def Field_ParameterSetGetElement (self, args)
 
def Field_ParameterSetGetGaussPoint (self, args)
 
def Field_ParameterSetGetNode (self, args)
 
def Field_ParameterSetUpdateConstant (self, args)
 
def Field_ParameterSetUpdateElement (self, args)
 
def Field_ParameterSetUpdateGaussPoint (self, args)
 
def Field_ParameterSetUpdateNode (self, args)
 
def Field_ParameterSetAddConstant (self, args)
 
def Field_ParameterSetAddElement (self, args)
 
def Field_ParameterSetAddNode (self, args)
 
def Field_ParameterSetInterpolateGauss (self, args)
 
def DistributedMatrix_DataGet (self, args)
 
def DistributedMatrix_DataRestore (self, args)
 
def DistributedVector_DataGet (self, args)
 
def DistributedVector_DataRestore (self, args)
 
def DistributedMatrix_ToSciPy (self)
 
def DistributedMatrix_SciPyRestore (self, matrix)
 

Variables

 WorldCoordinateSystem = CoordinateSystem()
 
 WorldRegion = Region()
 

Detailed Description

OpenCMISS-Iron

OpenCMISS (Open Continuum Mechanics, Imaging, Signal processing and System
identification) is a mathematical modelling environment that enables the
application of finite element analysis techniques to a variety of complex
bioengineering problems.

OpenCMISS-Iron is the computational backend component of OpenCMISS.
This Python module wraps the underlying OpenCMISS-Iron Fortran library.

http://www.opencmiss.org

Function Documentation

def iron.AnalyticAnalysis_AbsoluteErrorGetConstant (   field,
  variableType,
  componentNumber 
)
Get absolute error value for the constant in a field identified by an object compared to the analytic value.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: VALUE. The absolute error
:rtype: float

Definition at line 8700 of file iron.py.

def iron.AnalyticAnalysis_AbsoluteErrorGetConstantNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Get absolute error value for the constant in a field specified by a user number compared to the analytic value.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The absolute error
:rtype: float

Definition at line 8682 of file iron.py.

def iron.AnalyticAnalysis_AbsoluteErrorGetElement (   field,
  variableType,
  elementNumber,
  componentNumber 
)
Get absolute error value for the element in a field identified by an object compared to the analytic value.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param elementNumber: element number
:type elementNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: VALUE. The absolute error
:rtype: float

Definition at line 8736 of file iron.py.

def iron.AnalyticAnalysis_AbsoluteErrorGetElementNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  elementNumber,
  componentNumber 
)
Get absolute error value for the element in a field specified by a user number compared to the analytic value.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param elementNumber: element number
:type elementNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The absolute error
:rtype: float

Definition at line 8716 of file iron.py.

def iron.AnalyticAnalysis_AbsoluteErrorGetNode (   field,
  variableType,
  versionNumber,
  derivativeNumber,
  nodeNumber,
  componentNumber 
)
Get absolute error value for the node in a field identified by an object compared to the analytic value.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param versionNumber: derivative version number
:type versionNumber: int
:param derivativeNumber: derivative number
:type derivativeNumber: int
:param nodeNumber: node number
:type nodeNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The absolute error
:rtype: float

Definition at line 8778 of file iron.py.

def iron.AnalyticAnalysis_AbsoluteErrorGetNodeNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  versionNumber,
  derivativeNumber,
  nodeNumber,
  componentNumber 
)
Get absolute error value for the node in a field specified by a user number compared to the analytic value.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param versionNumber: derivative version number
:type versionNumber: int
:param derivativeNumber: derivative number
:type derivativeNumber: int
:param nodeNumber: node number
:type nodeNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The absolute error
:rtype: float

Definition at line 8754 of file iron.py.

def iron.AnalyticAnalysis_IntegralAbsoluteErrorGet (   field,
  variableType,
  componentNumber 
)
Get integral value for the absolute errors.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8818 of file iron.py.

def iron.AnalyticAnalysis_IntegralAbsoluteErrorGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Get integral value for the absolute errors.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8800 of file iron.py.

def iron.AnalyticAnalysis_IntegralAnalyticValueGet (   field,
  variableType,
  componentNumber 
)
Get integral value for the analytic values.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8852 of file iron.py.

def iron.AnalyticAnalysis_IntegralAnalyticValueGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Get integral value for the analytic values.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8834 of file iron.py.

def iron.AnalyticAnalysis_IntegralNIDErrorGet (   field,
  variableType,
  componentNumber 
)
Get integral value for the nid error.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8886 of file iron.py.

def iron.AnalyticAnalysis_IntegralNIDErrorGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Get integral value for the nid error.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8868 of file iron.py.

def iron.AnalyticAnalysis_IntegralNIDNumericalValueGet (   field,
  variableType,
  componentNumber 
)
Get integral value for the nid numerical.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8920 of file iron.py.

def iron.AnalyticAnalysis_IntegralNIDNumericalValueGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Get integral value for the nid numerical.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8902 of file iron.py.

def iron.AnalyticAnalysis_IntegralNumericalValueGet (   field,
  variableType,
  componentNumber 
)
Get integral value for the numerical values.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8954 of file iron.py.

def iron.AnalyticAnalysis_IntegralNumericalValueGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Get integral value for the numerical values.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8936 of file iron.py.

def iron.AnalyticAnalysis_IntegralPercentageErrorGet (   field,
  variableType,
  componentNumber 
)
Get integral value for the percentage errors.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8988 of file iron.py.

def iron.AnalyticAnalysis_IntegralPercentageErrorGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Get integral value for the percentage errors.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 8970 of file iron.py.

def iron.AnalyticAnalysis_IntegralRelativeErrorGet (   field,
  variableType,
  componentNumber 
)
Get integral value for the relative error.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 9022 of file iron.py.

def iron.AnalyticAnalysis_IntegralRelativeErrorGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Get integral value for the relative error.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: (The integral value, Ghost integral value)
:rtype: tuple. (Array of floats, Array of floats)

Definition at line 9004 of file iron.py.

def iron.AnalyticAnalysis_Output (   field,
  fileName 
)
Output the analytic error analysis for a field identified by an object compared to the analytic values parameter set.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param fileName: If not empty, the filename to output the analytic analysis to. If empty, the analysis will be output to the standard output.
:type fileName: string
:rtype: None

Definition at line 9053 of file iron.py.

def iron.AnalyticAnalysis_OutputNum (   regionUserNumber,
  fieldUserNumber,
  fileName 
)
Output the analytic error analysis for a field specified by a user number compared to the analytic values parameter set.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param fileName: If not empty, the filename to output the analytic analysis to. If empty, the analysis will be output to the standard output.
:type fileName: string
:rtype: None

Definition at line 9038 of file iron.py.

def iron.AnalyticAnalysis_PercentageErrorGetConstant (   field,
  variableType,
  componentNumber 
)
Get percentage error value for the constant in a field identified by an object compared to the analytic value.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: VALUE. The percentage error
:rtype: float

Definition at line 9084 of file iron.py.

def iron.AnalyticAnalysis_PercentageErrorGetConstantNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Get percentage error value for the constant in a field specified by a user number compared to the analytic value.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The percentage error
:rtype: float

Definition at line 9066 of file iron.py.

def iron.AnalyticAnalysis_PercentageErrorGetElement (   field,
  variableType,
  elementNumber,
  componentNumber 
)
Get percentage error value for the element in a field identified by an object compared to the analytic value.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param elementNumber: element number
:type elementNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: VALUE. The percentage error
:rtype: float

Definition at line 9120 of file iron.py.

def iron.AnalyticAnalysis_PercentageErrorGetElementNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  elementNumber,
  componentNumber 
)
Get percentage error value for the element in a field specified by a user number compared to the analytic value.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param elementNumber: element number
:type elementNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The percentage error
:rtype: float

Definition at line 9100 of file iron.py.

def iron.AnalyticAnalysis_PercentageErrorGetNode (   field,
  variableType,
  versionNumber,
  derivativeNumber,
  nodeNumber,
  componentNumber 
)
Get percentage error value for the node in a field identified by an object compared to the analytic value.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param versionNumber: derivative version number
:type versionNumber: int
:param derivativeNumber: derivative number
:type derivativeNumber: int
:param nodeNumber: node number
:type nodeNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The percentage error
:rtype: float

Definition at line 9162 of file iron.py.

def iron.AnalyticAnalysis_PercentageErrorGetNodeNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  versionNumber,
  derivativeNumber,
  nodeNumber,
  componentNumber 
)
Get percentage error value for the node in a field specified by a user number compared to the analytic value.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param versionNumber: derivative version number
:type versionNumber: int
:param derivativeNumber: derivative number
:type derivativeNumber: int
:param nodeNumber: node number
:type nodeNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The percentage error
:rtype: float

Definition at line 9138 of file iron.py.

def iron.AnalyticAnalysis_RelativeErrorGetConstant (   field,
  variableType,
  componentNumber 
)
Get relative error value for the constant in a field identified by an object compared to the analytic value.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: VALUE. The relative error
:rtype: float

Definition at line 9278 of file iron.py.

def iron.AnalyticAnalysis_RelativeErrorGetConstantNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Get relative error value for the constant in a field specified by a user number compared to the analytic value.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The relative error
:rtype: float

Definition at line 9260 of file iron.py.

def iron.AnalyticAnalysis_RelativeErrorGetElement (   field,
  variableType,
  elementNumber,
  componentNumber 
)
Get relative error value for the element in a field identified by an object compared to the analytic value.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param elementNumber: element number
:type elementNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: VALUE. The relative error
:rtype: float

Definition at line 9314 of file iron.py.

def iron.AnalyticAnalysis_RelativeErrorGetElementNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  elementNumber,
  componentNumber 
)
Get relative error value for the element in a field specified by a user number compared to the analytic value.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param elementNumber: element number
:type elementNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The relative error
:rtype: float

Definition at line 9294 of file iron.py.

def iron.AnalyticAnalysis_RelativeErrorGetNode (   field,
  variableType,
  versionNumber,
  derivativeNumber,
  nodeNumber,
  componentNumber 
)
Get relative error value for the node in a field identified by an object compared to the analytic value.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param versionNumber: derivative version number
:type versionNumber: int
:param derivativeNumber: derivative number
:type derivativeNumber: int
:param nodeNumber: node number
:type nodeNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The relative error
:rtype: float

Definition at line 9356 of file iron.py.

def iron.AnalyticAnalysis_RelativeErrorGetNodeNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  versionNumber,
  derivativeNumber,
  nodeNumber,
  componentNumber 
)
Get relative error value for the node in a field specified by a user number compared to the analytic value.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param versionNumber: derivative version number
:type versionNumber: int
:param derivativeNumber: derivative number
:type derivativeNumber: int
:param nodeNumber: node number
:type nodeNumber: int
:param componentNumber: component number
:type componentNumber: int
:returns: value. The relative error
:rtype: float

Definition at line 9332 of file iron.py.

def iron.AnalyticAnalysis_RMSErrorGetElement (   field,
  variableType,
  componentNumber,
  errorType 
)
Get relative error value for the constant in a field identified by an object compared to the analytic value.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:param errorType: error type
:type errorType: int
:returns: (The local error, The local ghost error, The global error)
:rtype: tuple. (float, float, float)

Definition at line 9204 of file iron.py.

def iron.AnalyticAnalysis_RMSErrorGetElementNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber,
  errorType 
)
Get rms error value for elements in a field compared to the analytic value.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:param errorType: error type
:type errorType: int
:returns: (The local error, The local ghost error, The global error)
:rtype: tuple. (float, float, float)

Definition at line 9184 of file iron.py.

def iron.AnalyticAnalysis_RMSErrorGetNode (   field,
  variableType,
  componentNumber,
  errorType 
)
Get rms error value for nodes in a field identified by an object compared to the analytic value.

:param field: The dependent field to calculate the analytic error analysis for.
:type field: Field
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:param errorType: error type
:type errorType: int
:returns: (The local error, The local ghost error, The global error)
:rtype: tuple. (Array of floats, Array of floats, Array of floats)

Definition at line 9242 of file iron.py.

def iron.AnalyticAnalysis_RMSErrorGetNodeNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber,
  errorType 
)
Get rms error value for nodes in a field compared to the analytic value.

:param regionUserNumber: The user number of the region containing the field for analytic error analysis.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to calculate the analytic error analysis for.
:type fieldUserNumber: int
:param variableType: variable type
:type variableType: int
:param componentNumber: component number
:type componentNumber: int
:param errorType: error type
:type errorType: int
:returns: (The local error, The local ghost error, The global error)
:rtype: tuple. (Array of floats, Array of floats, Array of floats)

Definition at line 9222 of file iron.py.

def iron.Basis_CollapsedXiGetNum (   userNumber,
  collapsedXiSize 
)
Returns the collapsed Xi flags of a basis identified by a user number.

:param userNumber: The user number of the basis to get the collapsed Xi flags for.
:type userNumber: int
: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 9378 of file iron.py.

def iron.Basis_CollapsedXiSetNum (   userNumber,
  collapsedXi 
)
Sets/changes the collapsed Xi flags of a basis identified by a user number.

:param userNumber: The user number of the basis to set the collapsed Xi flags for.
:type userNumber: int
: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 9391 of file iron.py.

def iron.Basis_CreateFinishNum (   userNumber)
Finishes the creation of a new basis identified by a user number.

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

Definition at line 9404 of file iron.py.

def iron.Basis_CreateStartNum (   userNumber)
Starts the creation of a new basis for a basis identified by a user number.

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

Definition at line 9415 of file iron.py.

def iron.Basis_DestroyNum (   userNumber)
Destroys a basis identified by its basis user number.

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

Definition at line 9426 of file iron.py.

def iron.Basis_InterpolationXiGetNum (   userNumber,
  interpolationXiSize 
)
Get the interpolation type in each xi directions for a basis identified by a user number.

:param userNumber: The user number of the basis to get the interpolation xi for.
:type userNumber: int
: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 9437 of file iron.py.

def iron.Basis_InterpolationXiSetNum (   userNumber,
  interpolationXi 
)
Sets/changes the interpolation type in each xi directions for a basis identified by a user number.

:param userNumber: The user number of the basis to get the interpolation xi for.
:type userNumber: int
: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 9450 of file iron.py.

def iron.Basis_NumberOfLocalNodesGetNum (   userNumber)
Returns the number of local nodes in a basis identified by a user number.

:param userNumber: The user number of the basis to get the interpolation xi for.
:type userNumber: int
:returns: numberOfLocalNodes. The number of local nodes in the specified basis.
:rtype: int

Definition at line 9463 of file iron.py.

def iron.Basis_NumberOfXiGetNum (   userNumber)
Returns the number of Xi directions in a basis identified by a user number.

:param userNumber: The user number of the basis to get the number xi for.
:type userNumber: int
:returns: numberOfXi. The number of xi directions in the specified basis.
:rtype: int

Definition at line 9475 of file iron.py.

def iron.Basis_NumberOfXiSetNum (   userNumber,
  numberOfXi 
)
Sets/changes the number of Xi directions in a basis identified by a user number.

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

Definition at line 9487 of file iron.py.

def iron.Basis_QuadratureLocalFaceGaussEvaluateSetNum (   userNumber,
  faceGaussEvaluate 
)
Sets/changes the local face Gauss scheme calculation, on a basis identified by a user number.

:param userNumber: The user number of the basis to get the quadrature type for.
:type userNumber: int
:param faceGaussEvaluate: The value to set face Gauss evaluation flag to.
:type faceGaussEvaluate: bool
:rtype: None

Definition at line 9500 of file iron.py.

def iron.Basis_QuadratureMultipleGaussXiGetNum (   userNumber,
  quadratureScheme,
  GaussPoints,
  GaussXiSizes 
)
Returns the xi positions of Gauss points on a basis quadrature identified by a user number.

:param userNumber: The user number of the basis to get the Gauss Xi positions for.
:type userNumber: int
:param quadratureScheme: The quadrature scheme to return the Gauss 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 9513 of file iron.py.

def iron.Basis_QuadratureNumberOfGaussXiGetNum (   userNumber,
  numberOfGaussXiSize 
)
Returns the number of Gauss points in each Xi directions for a basis quadrature identified by a user number.

:param userNumber: The user number of the basis to get the number of Gauss Xi for.
:type userNumber: int
: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 9530 of file iron.py.

def iron.Basis_QuadratureNumberOfGaussXiSetNum (   userNumber,
  numberOfGaussXi 
)
Sets/changes the number of Gauss points in each Xi directions for a basis quadrature identified by a user number.

:param userNumber: The user number of the basis to set the number of Gauss Xi for.
:type userNumber: int
: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 9543 of file iron.py.

def iron.Basis_QuadratureOrderGetNum (   userNumber)
Returns the order of quadrature a basis quadrature identified by a user number.

:param userNumber: The user number of the basis to get the quadrature order for.
:type userNumber: int
:returns: quadratureOrder. The order of quadrature in the specified basis.
:rtype: int

Definition at line 9556 of file iron.py.

def iron.Basis_QuadratureOrderSetNum (   userNumber,
  quadratureOrder 
)
Sets/changes the order of quadrature a basis quadrature identified by a user number.

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

Definition at line 9568 of file iron.py.

def iron.Basis_QuadratureSingleGaussXiGetNum (   userNumber,
  quadratureScheme,
  GaussPoint,
  GaussXiSize 
)
Returns the xi position of a Gauss point on a basis quadrature identified by a user number.

:param userNumber: The user number of the basis to get the Gauss Xi positions for.
:type userNumber: int
:param quadratureScheme: The quadrature scheme to return the Gauss 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 9581 of file iron.py.

def iron.Basis_QuadratureTypeGetNum (   userNumber)
Returns the type of quadrature a basis quadrature identified by a user number.

:param userNumber: The user number of the basis to get the quadrature type for.
:type userNumber: int
:returns: quadratureType. The type of quadrature in the specified basis. Will be a value from the QuadratureTypes enum.
:rtype: int

Definition at line 9598 of file iron.py.

def iron.Basis_QuadratureTypeSetNum (   userNumber,
  quadratureType 
)
Sets/changes the type of quadrature a basis quadrature identified by a user number.

:param userNumber: The user number of the basis to get the quadrature type for.
:type userNumber: int
: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 9610 of file iron.py.

def iron.Basis_TypeGetNum (   userNumber)
Returns the type of a basis identified by a user number.

:param userNumber: The user number of the basis to get the type for.
:type userNumber: int
:returns: basisType. The type of the specified basis. Will be a value from the BasisTypes enum.
:rtype: int

Definition at line 9623 of file iron.py.

def iron.Basis_TypeSetNum (   userNumber,
  basisType 
)
Sets/changes the type of a basis identified by a user number.

:param userNumber: The user number of the basis to set the type for.
:type userNumber: int
: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 9635 of file iron.py.

def iron.BioelectricsFiniteElasticity_UpdateGeometricField (   controlLoop,
  calcClosestGaussPoint 
)
Update the bioelectrics geometric field by interpolating the finite elasticity geometric field

:param controlLoop: The bioelectrics control loop
:type controlLoop: ControlLoop
:param calcClosestGaussPoint:
:type calcClosestGaussPoint: bool
:rtype: None

Definition at line 9648 of file iron.py.

def iron.BoundaryConditions_AddConstantNum (   regionUserNumber,
  problemUserNumber,
  controlLoopIdentifiers,
  solverIndex,
  fieldUserNumber,
  variableType,
  componentNumber,
  condition,
  value 
)
Adds to the value of the specified constant and sets this as a boundary condition on the specified constant for boundary conditions identified by a user number.

:param regionUserNumber: The user number of the region containing the dependent field to add the boundary conditions for.
:type regionUserNumber: int
:param problemUserNumber: The user number of the problem containing the solver equations to add the boundary conditions for.
:type problemUserNumber: int
:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the solver equations boundary conditions for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to get the solver equations for.
:type solverIndex: int
:param fieldUserNumber: The user number of the dependent field for the boundary condition.
:type fieldUserNumber: int
:param variableType: The variable type of the dependent field to add the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param componentNumber: The component number of the dependent field to add the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to add.
:type value: float
:rtype: None

Definition at line 9661 of file iron.py.

def iron.BoundaryConditions_AddElementNum (   regionUserNumber,
  problemUserNumber,
  controlLoopIdentifiers,
  solverIndex,
  fieldUserNumber,
  variableType,
  elementUserNumber,
  componentNumber,
  condition,
  value 
)
Adds the value to the specified element and sets this as a boundary condition on the specified element for boundary conditions identified by a user number.

:param regionUserNumber: The user number of the region containing the equations set to add the boundary conditions for.
:type regionUserNumber: int
:param problemUserNumber: The user number of the problem containing the solver equations to destroy the boundary conditions for.
:type problemUserNumber: int
:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the solver equations boundary conditions for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to get the solver equations for.
:type solverIndex: int
:param fieldUserNumber: The user number of the dependent field for the boundary condition.
:type fieldUserNumber: int
:param variableType: The variable type of the dependent field to add the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param elementUserNumber: The user number of the element to add the boundary conditions for.
:type elementUserNumber: int
:param componentNumber: The component number of the dependent field to add the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to add.
:type value: float
:rtype: None

Definition at line 9688 of file iron.py.

def iron.BoundaryConditions_AddNodeNum (   regionUserNumber,
  problemUserNumber,
  controlLoopIdentifiers,
  solverIndex,
  fieldUserNumber,
  variableType,
  versionNumber,
  derivativeNumber,
  nodeUserNumber,
  componentNumber,
  condition,
  value 
)
Adds the value to the specified node and sets this as a boundary condition on the specified node for boundary conditions identified by a user number.

:param regionUserNumber: The user number of the region containing the equations set to add the boundary conditions for.
:type regionUserNumber: int
:param problemUserNumber: The user number of the problem containing the solver equations to destroy the boundary conditions for.
:type problemUserNumber: int
:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the solver equations boundary conditions for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to get the solver equations for.
:type solverIndex: int
:param fieldUserNumber: The user number of the dependent field for the boundary condition.
:type fieldUserNumber: int
:param variableType: The variable type of the dependent field to add the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param versionNumber: The user number of the node derivative version to add the boundary conditions for.
:type versionNumber: int
:param derivativeNumber: The user number of the node derivative to add the boundary conditions for.
:type derivativeNumber: int
:param nodeUserNumber: The user number of the node to add the boundary conditions for.
:type nodeUserNumber: int
:param componentNumber: The component number of the dependent field to add the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to add.
:type value: float
:rtype: None

Definition at line 9717 of file iron.py.

def iron.BoundaryConditions_ConstrainNodeDofsEqualNum (   regionUserNumber,
  problemUserNumber,
  controlLoopIdentifier,
  solverIndex,
  fieldUserNumber,
  fieldVariableType,
  versionNumber,
  derivativeNumber,
  component,
  nodes,
  coefficient 
)
Constrain multiple nodal equations dependent field DOFs to be a single solver DOF in the solver equations

:param regionUserNumber: The user number of the region containing the field DOFs to constrain.
:type regionUserNumber: int
:param problemUserNumber: The user number of the problem containing the solver equations.
:type problemUserNumber: int
:param controlLoopIdentifier: The control loop identifier to get the solver equations.
:type controlLoopIdentifier: int
:param solverIndex: The solver index of the solver equations.
:type solverIndex: int
:param fieldUserNumber: The user number of the dependent field containing the DOFs to contrain.
:type fieldUserNumber: int
:param fieldVariableType: The variable type of the dependent field containing the DOFs to constrain. Must be a value from the FieldVariableTypes enum.
:type fieldVariableType: int
:param versionNumber: The derivative version number.
:type versionNumber: int
:param derivativeNumber: The derivative number.
:type derivativeNumber: int
:param component: The field component number of the DOFs to be constrained.
:type component: int
:param nodes: The user numbers of the nodes to be constrained to be equal.
:type nodes: Array of ints
:param coefficient: The coefficient of constraint, applied to all but the first node.
:type coefficient: float
:rtype: None

Definition at line 9750 of file iron.py.

def iron.BoundaryConditions_DestroyNum (   problemUserNumber,
  controlLoopIdentifiers,
  solverIndex 
)
Destroys the boundary conditions for solver equations identified by a control loop identifier.

:param problemUserNumber: The user number of the problem containing the solver equations to destroy the boundary conditions for.
:type problemUserNumber: int
:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the solver equations boundary conditions for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to get the solver equations for.
:type solverIndex: int
:rtype: None

Definition at line 9781 of file iron.py.

def iron.BoundaryConditions_NeumannSparsityTypeSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  solverIndex,
  sparsityType 
)
Sets the Neumann integration matrix sparsity for boundary conditions identified by a control loop identifier.

:param problemUserNumber: The user number of the problem containing the solver equations to destroy the boundary conditions for.
:type problemUserNumber: int
:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the solver equations boundary conditions for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to get the solver equations for.
:type solverIndex: int
:param sparsityType: The sparsity type for the Neumann integration matrices. Must be a value from the BoundaryConditionSparsityTypes enum.
:type sparsityType: int
:rtype: None

Definition at line 9796 of file iron.py.

def iron.BoundaryConditions_SetConstantNum (   regionUserNumber,
  problemUserNumber,
  controlLoopIdentifiers,
  solverIndex,
  variableType,
  fieldUserNumber,
  componentNumber,
  condition,
  value 
)
Sets the value of the specified constant as a boundary condition on the specified constant for boundary conditions identified by a user number.

:param regionUserNumber: The user number of the region containing the equations set to set the boundary conditions for.
:type regionUserNumber: int
:param problemUserNumber: The user number of the problem containing the solver equations to destroy the boundary conditions for.
:type problemUserNumber: int
:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the solver equations boundary conditions for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to get the solver equations for.
:type solverIndex: int
:param variableType: The variable type of the dependent field to set the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldUserNumber: The user number of the dependent field for the boundary condition.
:type fieldUserNumber: int
:param componentNumber: The component number of the dependent field to set the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to set.
:type value: float
:rtype: None

Definition at line 9813 of file iron.py.

def iron.BoundaryConditions_SetElementNum (   regionUserNumber,
  problemUserNumber,
  controlLoopIdentifiers,
  solverIndex,
  fieldUserNumber,
  variableType,
  elementUserNumber,
  componentNumber,
  condition,
  value 
)
Sets the value of the specified element as a boundary condition on the specified element for boundary conditions identified by a user number.

:param regionUserNumber: The user number of the region containing the equations set to set the boundary conditions for.
:type regionUserNumber: int
:param problemUserNumber: The user number of the problem containing the solver equations to destroy the boundary conditions for.
:type problemUserNumber: int
:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the solver equations boundary conditions for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to get the solver equations for.
:type solverIndex: int
:param fieldUserNumber: The user number of the dependent field for the boundary condition.
:type fieldUserNumber: int
:param variableType: The variable type of the dependent field to set the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param elementUserNumber: The user number of the element to set the boundary conditions for.
:type elementUserNumber: int
:param componentNumber: The component number of the dependent field to set the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to set.
:type value: float
:rtype: None

Definition at line 9840 of file iron.py.

def iron.BoundaryConditions_SetNodeNum (   regionUserNumber,
  problemUserNumber,
  controlLoopIdentifiers,
  solverIndex,
  fieldUserNumber,
  variableType,
  versionNumber,
  derivativeNumber,
  nodeUserNumber,
  componentNumber,
  condition,
  value 
)
Sets the value of the specified node as a boundary condition on the specified node for boundary conditions identified by a user number.

:param regionUserNumber: The user number of the region containing the equations set to set the boundary conditions for.
:type regionUserNumber: int
:param problemUserNumber: The user number of the problem containing the solver equations to destroy the boundary conditions for.
:type problemUserNumber: int
:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the solver equations boundary conditions for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to get the solver equations for.
:type solverIndex: int
:param fieldUserNumber: The user number of the dependent field for the boundary condition.
:type fieldUserNumber: int
:param variableType: The variable type of the dependent field to set the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param versionNumber: The user number of the node derivative version to set the boundary conditions for.
:type versionNumber: int
:param derivativeNumber: The user number of the node derivative to set the boundary conditions for.
:type derivativeNumber: int
:param nodeUserNumber: The user number of the node to set the boundary conditions for.
:type nodeUserNumber: int
:param componentNumber: The component number of the dependent field to set the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to set.
:type value: float
:rtype: None

Definition at line 9869 of file iron.py.

def iron.CellML_CreateCellMLToFieldMapNum (   regionUserNumber,
  CellMLUserNumber,
  CellMLModelUserNumber,
  variableID,
  CellMLParameterSet,
  fieldUserNumber,
  variableType,
  componentNumber,
  fieldParameterSet 
)
Defines a CellML model variable to field variable component map by user number

:param regionUserNumber: The user number of the region containing the CellML enviroment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment.
:type CellMLUserNumber: int
:param CellMLModelUserNumber: The user number of the CellML model to map fom.
:type CellMLModelUserNumber: int
:param variableID: The of the CellML variable in the given model to map from.
:type variableID: string
:param CellMLParameterSet: The CellML variable parameter set to map from.
:type CellMLParameterSet: int
:param fieldUserNumber: The user number of the field to map to
:type fieldUserNumber: int
:param variableType: The field variable type to map to.
:type variableType: int
:param componentNumber: The field variable component number to map to.
:type componentNumber: int
:param fieldParameterSet: The field variable parameter set to map to.
:type fieldParameterSet: int
:rtype: None

Definition at line 9922 of file iron.py.

def iron.CellML_CreateFieldToCellMLMapNum (   regionUserNumber,
  CellMLUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber,
  fieldParameterSet,
  CellMLModelUserNumber,
  variableID,
  CellMLParameterSet 
)
Defines a field variable component to CellML model variable map by user number.

:param regionUserNumber: The user number of the region containing the CellML enviroment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment.
:type CellMLUserNumber: int
:param fieldUserNumber: The user number of the field to map from.
:type fieldUserNumber: int
:param variableType: The field variable type to map from.
:type variableType: int
:param componentNumber: The field variable component number to map from.
:type componentNumber: int
:param fieldParameterSet: The field variable parameter set to map from.
:type fieldParameterSet: int
:param CellMLModelUserNumber: The user number of the CellML model to map to.
:type CellMLModelUserNumber: int
:param variableID: The of the CellML variable in the given model to map to.
:type variableID: string
:param CellMLParameterSet: The CellML variable parameter set to map to.
:type CellMLParameterSet: int
:rtype: None

Definition at line 9949 of file iron.py.

def iron.CellML_CreateFinishNum (   regionUserNumber,
  CellMLUserNumber 
)
Finishes the creation of a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to finish creating.
:type CellMLUserNumber: int
:rtype: None

Definition at line 9976 of file iron.py.

def iron.CellML_CreateStartNum (   CellMLUserNumber,
  regionUserNumber 
)
Starts the creation of a CellML environment identified by a user number.

:param CellMLUserNumber: The user number of the CellML enviroment to start creating.
:type CellMLUserNumber: int
:param regionUserNumber: The user number of the Region containing the field to start the CellML enviroment creation on.
:type regionUserNumber: int
:rtype: None

Definition at line 9989 of file iron.py.

def iron.CellML_DestroyNum (   regionUserNumber,
  CellMLUserNumber 
)
Destroys a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML enviroment to destroy.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to destroy.
:type CellMLUserNumber: int
:rtype: None

Definition at line 10002 of file iron.py.

def iron.CellML_FieldComponentGetNum (   regionUserNumber,
  CellMLUserNumber,
  CellMLModelUserNumber,
  CellMLFieldType,
  variableID 
)
Returns the field component number that corresponds to a character string VariableID for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to get the field component for.
:type CellMLUserNumber: int
:param CellMLModelUserNumber: The user number of the CellML model to map fom.
:type CellMLModelUserNumber: int
:param CellMLFieldType: The type of CellML field to get the component for. Must be a value from the CellMLFieldTypes enum.
:type CellMLFieldType: int
:param variableID: The variable ID to get the corresponding field component for.
:type variableID: string
:returns: fieldComponent. The field component corresponding to the ID.
:rtype: int

Definition at line 10015 of file iron.py.

def iron.CellML_FieldMapsCreateFinishNum (   regionUserNumber,
  CellMLUserNumber 
)
Finishes the creation of field maps for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to finish creating.
:type CellMLUserNumber: int
:rtype: None

Definition at line 10035 of file iron.py.

def iron.CellML_FieldMapsCreateStartNum (   regionUserNumber,
  CellMLUserNumber 
)
Starts the creation of field maps for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the Region containing the CellML enviroment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to start creating the maps for.
:type CellMLUserNumber: int
:rtype: None

Definition at line 10048 of file iron.py.

def iron.CellML_GenerateNum (   regionUserNumber,
  CellMLUserNumber 
)
Validiate and instantiate a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to generate.
:type CellMLUserNumber: int
:rtype: None

Definition at line 10061 of file iron.py.

def iron.CellML_IntermediateFieldCreateFinishNum (   regionUserNumber,
  CellMLUserNumber 
)
Finishes the creation of CellML intermediate field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to finish creating the intermediate field for.
:type CellMLUserNumber: int
:rtype: None

Definition at line 10074 of file iron.py.

def iron.CellML_IntermediateFieldCreateStartNum (   regionUserNumber,
  CellMLUserNumber,
  CellMLIntermediateFieldUserNumber 
)
Starts the creation of CellML intermediate field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML environment to start creating the intermediate field for.
:type CellMLUserNumber: int
:param CellMLIntermediateFieldUserNumber: The user number of the CellML intermediate field to start creating.
:type CellMLIntermediateFieldUserNumber: int
:rtype: None

Definition at line 10087 of file iron.py.

def iron.CellML_IntermediateFieldGetNum (   regionUserNumber,
  CellMLUserNumber 
)
Returns the CellML intermediate field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to get the CellML intermediate field for.
:type CellMLUserNumber: int
:returns: CellMLIntermediateFieldUserNumber. The user number of the CellML intermediate field.
:rtype: int

Definition at line 10102 of file iron.py.

def iron.CellML_ModelImportNum (   regionUserNumber,
  CellMLUserNumber,
  URI 
)
Imports a specified CellML model as specified by a character URI into a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML enviroment to import the model into.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to import the model into.
:type CellMLUserNumber: int
:param URI: The URI of the CellML model to import.
:type URI: string
:returns: modelIndex. The index of the imported model.
:rtype: int

Definition at line 10116 of file iron.py.

def iron.CellML_ModelsFieldCreateFinishNum (   regionUserNumber,
  CellMLUserNumber 
)
Finishes the creation of CellML models field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML enviroment to finish creating.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to finish creating the models field for.
:type CellMLUserNumber: int
:rtype: None

Definition at line 10132 of file iron.py.

def iron.CellML_ModelsFieldCreateStartNum (   regionUserNumber,
  CellMLUserNumber,
  CellMLModelsFieldUserNumber 
)
Starts the creation of CellML models field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML enviroment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML environment to start creating the models field for.
:type CellMLUserNumber: int
:param CellMLModelsFieldUserNumber: The user number of the CellML models field to start creating.
:type CellMLModelsFieldUserNumber: int
:rtype: None

Definition at line 10145 of file iron.py.

def iron.CellML_ModelsFieldGetNum (   regionUserNumber,
  CellMLUserNumber 
)
Returns the CellML models field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML enviroment to get the CellML models field for.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to get the CellML models field for.
:type CellMLUserNumber: int
:returns: CellMLModelsFieldUserNumber. The user number of the CellML models field.
:rtype: int

Definition at line 10160 of file iron.py.

def iron.CellML_ParametersFieldCreateFinishNum (   regionUserNumber,
  CellMLUserNumber 
)
Finishes the creation of CellML parameters field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to finish creating the parameters field for.
:type CellMLUserNumber: int
:rtype: None

Definition at line 10174 of file iron.py.

def iron.CellML_ParametersFieldCreateStartNum (   regionUserNumber,
  CellMLUserNumber,
  CellMLParametersFieldUserNumber 
)
Starts the creation of CellML parameters field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML environment to start creating the parameters field for.
:type CellMLUserNumber: int
:param CellMLParametersFieldUserNumber: The user number of the CellML parameters field to start creating.
:type CellMLParametersFieldUserNumber: int
:rtype: None

Definition at line 10187 of file iron.py.

def iron.CellML_ParametersFieldGetNum (   regionUserNumber,
  CellMLUserNumber 
)
Returns the CellML parameters field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to get the CellML parameters field for.
:type CellMLUserNumber: int
:returns: CellMLParametersFieldUserNumber. The user number of the CellML parameters field.
:rtype: int

Definition at line 10202 of file iron.py.

def iron.CellML_StateFieldCreateFinishNum (   regionUserNumber,
  CellMLUserNumber 
)
Finishes the creation of CellML state field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to finish creating the state field for.
:type CellMLUserNumber: int
:rtype: None

Definition at line 10216 of file iron.py.

def iron.CellML_StateFieldCreateStartNum (   regionUserNumber,
  CellMLUserNumber,
  CellMLStateFieldUserNumber 
)
Starts the creation of CellML state field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML environment to start creating the state field for.
:type CellMLUserNumber: int
:param CellMLStateFieldUserNumber: The user number of the CellML state field to start creating.
:type CellMLStateFieldUserNumber: int
:rtype: None

Definition at line 10229 of file iron.py.

def iron.CellML_StateFieldGetNum (   regionUserNumber,
  CellMLUserNumber 
)
Returns the CellML state field for a CellML environment identified by a user number.

:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment to get the CellML state field for.
:type CellMLUserNumber: int
:returns: CellMLStateFieldUserNumber. The user number of the CellML state field.
:rtype: int

Definition at line 10244 of file iron.py.

def iron.CellML_VariableSetAsKnownNum (   regionUserNumber,
  CellMLUserNumber,
  CellMLModelUserNumber,
  variableID 
)
Sets a CellML model variable to be known by user number.

:param regionUserNumber: The user number of the region containing the CellML enviroment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment.
:type CellMLUserNumber: int
:param CellMLModelUserNumber: The user number of the CellML model in which to find the given variable.
:type CellMLModelUserNumber: int
:param variableID: The CellML variable to set as known (in the format 'component_name/variable_name').
:type variableID: string
:rtype: None

Definition at line 10258 of file iron.py.

def iron.CellML_VariableSetAsWantedNum (   regionUserNumber,
  CellMLUserNumber,
  CellMLModelUserNumber,
  variableID 
)
Sets a CellML model variable to be wanted by user number.

:param regionUserNumber: The user number of the region containing the CellML enviroment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML enviroment.
:type CellMLUserNumber: int
:param CellMLModelUserNumber: The user number of the CellML model in which to find the given variable.
:type CellMLModelUserNumber: int
:param variableID: The CellML variable to set as wanted (in the format 'component_name/variable_name').
:type variableID: string
:rtype: None

Definition at line 10275 of file iron.py.

def iron.CellMLEquations_CellMLAddNum (   problemUserNumber,
  controlLoopIdentifiers,
  solverIndex,
  regionUserNumber,
  CellMLUserNumber 
)
Adds a CellML environment to CellML equations identified by an user number.

:param problemUserNumber: The user number of the problem number with the solver to add the CellML environment for.
:type problemUserNumber: int
:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to add the CellML environment for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to add the CellML environment for.
:type solverIndex: int
:param regionUserNumber: The user number of the region containing the CellML environment.
:type regionUserNumber: int
:param CellMLUserNumber: The user number of the CellML environment to add.
:type CellMLUserNumber: int
:returns: CellMLIndex. The index of the added CellML environment.
:rtype: int

Definition at line 9902 of file iron.py.

def iron.ComputationalNodeNumberGet ( )
Returns the computational node number of the running process.

:returns: nodeNumber. The computational node number.
:rtype: int

Definition at line 10292 of file iron.py.

def iron.ComputationalNumberOfNodesGet ( )
Returns the number of computational nodes for the running process.

:returns: numberOfNodes. The number of computational nodes.
:rtype: int

Definition at line 10302 of file iron.py.

def iron.ControlLoop_AbsoluteToleranceSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  absoluteTolerance 
)
Sets/changes the maximum iterations for a while control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to set the maximum iterations for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers.
:type controlLoopIdentifiers: Array of ints
:param absoluteTolerance: The absolute tolerance value for a control loop.
:type absoluteTolerance: float
:rtype: None

Definition at line 10312 of file iron.py.

def iron.ControlLoop_ControlLoopGetNum (   problemUserNumber,
  controlLoopRootIdentifiers,
  controlLoopIdentifiers,
  controlLoop 
)
Returns the specified control loop as indexed by the control loop identifier from the control loop root identified by user numbers.

:param problemUserNumber: The user number of the problem to get the control loop for.
:type problemUserNumber: int
:param controlLoopRootIdentifiers: The root control loop identifiers.
:type controlLoopRootIdentifiers: Array of ints
:param controlLoopIdentifiers: The control loop identifiers.
:type controlLoopIdentifiers: Array of ints
:param controlLoop: On return, the specified control loop.
:type controlLoop: ControlLoop
:rtype: None

Definition at line 10327 of file iron.py.

def iron.ControlLoop_CurrentTimesGetNum (   problemUserNumber,
  controlLoopIdentifiers 
)
Gets the current time parameters for a time control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to get the control loop for.
:type problemUserNumber: int
:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the control loop for.
:type controlLoopIdentifiers: Array of ints
:returns: (The current time of the time control loop, The current time increment of the time control loop)
:rtype: tuple. (float, float)

Definition at line 10344 of file iron.py.

def iron.ControlLoop_DestroyNum (   problemUserNumber,
  controlLoopIdentifiers 
)
Destroys a control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to destroy the control loop for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers.
:type controlLoopIdentifiers: Array of ints
:rtype: None

Definition at line 10358 of file iron.py.

def iron.ControlLoop_IterationsSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  startIteration,
  stopIteration,
  iterationIncrement 
)
Sets/changes the iteration parameters for a fixed control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to set the iteration parameters for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers.
:type controlLoopIdentifiers: Array of ints
:param startIteration: The start iteration of the fixed control loop to set.
:type startIteration: int
:param stopIteration: The stop iteration of the fixed control loop to set.
:type stopIteration: int
:param iterationIncrement: The iteration increment of the fixed control loop to set.
:type iterationIncrement: int
:rtype: None

Definition at line 10371 of file iron.py.

def iron.ControlLoop_LabelGetNum (   problemUserNumber,
  controlLoopIdentifiers 
)
Returns the character string label for a control loop identified by an user number.

:param problemUserNumber: The user number of the problem to set the label for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers.
:type controlLoopIdentifiers: Array of ints
:returns: label. The control loop label.
:rtype: string

Definition at line 10390 of file iron.py.

def iron.ControlLoop_LabelSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  label 
)
Sets/changes the character string label for a control loop identified by an user number.

:param problemUserNumber: The user number of the problem to set the label for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers.
:type controlLoopIdentifiers: Array of ints
:param label: The region label to set.
:type label: string
:rtype: None

Definition at line 10404 of file iron.py.

def iron.ControlLoop_MaximumIterationsSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  maximumIterations 
)
Sets/changes the maximum iterations for a while control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to set the maximum iterations for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers.
:type controlLoopIdentifiers: Array of ints
:param maximumIterations: The maximum iterations of the while control loop to set.
:type maximumIterations: int
:rtype: None

Definition at line 10419 of file iron.py.

def iron.ControlLoop_NumberOfIterationsGetNum (   problemUserNumber,
  controlLoopIdentifiers 
)
Gets the number of iterations for a time control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to get the number of iterations for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers to get the number of iterations for.
:type controlLoopIdentifiers: Array of ints
:returns: numberOfIterations. The number of iterations
:rtype: int

Definition at line 10434 of file iron.py.

def iron.ControlLoop_NumberOfIterationsSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  numberOfIterations 
)
Sets the number of iterations for a time control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to set the number of iterations for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers to set the number of iterations for.
:type controlLoopIdentifiers: Array of ints
:param numberOfIterations: The number of iterations to set
:type numberOfIterations: int
:rtype: None

Definition at line 10448 of file iron.py.

def iron.ControlLoop_NumberOfSubLoopsGetNum (   problemUserNumber,
  controlLoopIdentifiers 
)
Returns the number of sub-control loops for a control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to get the number of sub loops for for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers.
:type controlLoopIdentifiers: Array of ints
:returns: numberOfSubLoops. The number of sub loops for the specified control loop.
:rtype: int

Definition at line 10463 of file iron.py.

def iron.ControlLoop_NumberOfSubLoopsSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  numberOfSubLoops 
)
Sets/changes the number of sub-control loops for a control loop identified by user numbers. \todo is this really public???

:param problemUserNumber: The user number of the problem to set the number of sub loops for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers.
:type controlLoopIdentifiers: Array of ints
:param numberOfSubLoops: The number of sub loops for the specified control loop to set.
:type numberOfSubLoops: int
:rtype: None

Definition at line 10477 of file iron.py.

def iron.ControlLoop_OutputTypeGetNum (   problemUserNumber,
  controlLoopIdentifiers 
)
Returns the output type for a control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to get the output type for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers to get the output type for.
:type controlLoopIdentifiers: Array of ints
:returns: outputType. The output type of the control loop. Will be a value from the ControlLoopOutputTypes enum.
:rtype: int

Definition at line 10492 of file iron.py.

def iron.ControlLoop_OutputTypeSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  outputType 
)
Sets the output type for a control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to set the output type for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers to set the output type for.
:type controlLoopIdentifiers: Array of ints
:param outputType: The output type to set. Must be a value from the ControlLoopOutputTypes enum.
:type outputType: int
:rtype: None

Definition at line 10506 of file iron.py.

def iron.ControlLoop_TimeInputSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  inputOption 
)
Sets/changes the input parameters for a time control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to get the output parameters for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifier.
:type controlLoopIdentifiers: Array of ints
:param inputOption: The output frequency modulo to set.
:type inputOption: int
:rtype: None

Definition at line 10521 of file iron.py.

def iron.ControlLoop_TimeOutputSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  outputFrequency 
)
Sets/changes the output parameters for a time control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to get the output parameters for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifier.
:type controlLoopIdentifiers: Array of ints
:param outputFrequency: The output frequency modulo to set.
:type outputFrequency: int
:rtype: None

Definition at line 10536 of file iron.py.

def iron.ControlLoop_TimesGetNum (   problemUserNumber,
  controlLoopIdentifiers 
)
Returns the time parameters for a time control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to get the time parameters for for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifier.
:type controlLoopIdentifiers: Array of ints
:returns: (The start time for the time control loop, The stop time for the time control loop, The time increment for the time control loop, The current time for the time control loop, The iteration number for the current loop, The iteration number for the time control loop)
:rtype: tuple. (float, float, float, float, int, int)

Definition at line 10551 of file iron.py.

def iron.ControlLoop_TimesSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  startTime,
  stopTime,
  timeIncrement 
)
Sets/changes the time parameters for a time control loop identified by user numbers.

:param problemUserNumber: The user number of the problem to get the time parameters for for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifier.
:type controlLoopIdentifiers: Array of ints
:param startTime: The start time for the time control loop to set.
:type startTime: float
:param stopTime: The stop time for the time control loop to set.
:type stopTime: float
:param timeIncrement: The time increment for the time control loop to set.
:type timeIncrement: float
:rtype: None

Definition at line 10565 of file iron.py.

def iron.ControlLoop_TypeSetNum (   problemUserNumber,
  controlLoopIdentifiers,
  loopType 
)
Sets/changes the loop type for a control loop identified by user numbers. \todo is this really public???

:param problemUserNumber: The user number of the problem to set the loop type for.
:type problemUserNumber: int
:param controlLoopIdentifiers: The control loop identifiers.
:type controlLoopIdentifiers: Array of ints
:param loopType: The type of control loop to set. Must be a value from the ProblemControlLoopTypes enum.
:type loopType: int
:rtype: None

Definition at line 10584 of file iron.py.

def iron.CoordinateSystem_CreateFinishNum (   coordinateSystemUserNumber)
Finishes the creation of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to finish creating.
:type coordinateSystemUserNumber: int
:rtype: None

Definition at line 10599 of file iron.py.

def iron.CoordinateSystem_CreateStartNum (   coordinateSystemUserNumber)
Starts the creation of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to start creating.
:type coordinateSystemUserNumber: int
:rtype: None

Definition at line 10610 of file iron.py.

def iron.CoordinateSystem_DestroyNum (   coordinateSystemUserNumber)
Destroys a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to destroy.
:type coordinateSystemUserNumber: int
:rtype: None

Definition at line 10621 of file iron.py.

def iron.CoordinateSystem_DimensionGetNum (   coordinateSystemUserNumber)
Returns the dimension of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to get the dimension for.
:type coordinateSystemUserNumber: int
:returns: coordinateSystemDimension. The dimension of the coordinate system
:rtype: int

Definition at line 10632 of file iron.py.

def iron.CoordinateSystem_DimensionSetNum (   coordinateSystemUserNumber,
  coordinateSystemDimension 
)
Sets/changes the dimension of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to set the dimension for.
:type coordinateSystemUserNumber: int
:param coordinateSystemDimension: The dimension of the coordinate system to set.
:type coordinateSystemDimension: int
:rtype: None

Definition at line 10644 of file iron.py.

def iron.CoordinateSystem_FocusGetNum (   coordinateSystemUserNumber)
Returns the focus of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to get the focus for.
:type coordinateSystemUserNumber: int
:returns: focus. The focus of the coordinate system
:rtype: float

Definition at line 10657 of file iron.py.

def iron.CoordinateSystem_FocusSetNum (   coordinateSystemUserNumber,
  focus 
)
Sets/changes the focus of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to set the focus for.
:type coordinateSystemUserNumber: int
:param focus: The focus of the coordinate system to set.
:type focus: float
:rtype: None

Definition at line 10669 of file iron.py.

def iron.CoordinateSystem_OrientationGetNum (   coordinateSystemUserNumber,
  orientationSizes 
)
Returns the orientation of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to get the orientation for.
:type coordinateSystemUserNumber: int
:param orientationSizes: Tuple of dimensions of orientation to allocate, with length 2.
:returns: orientation. The orientation of the coordinate system.
:rtype: 2d array of floats

Definition at line 10682 of file iron.py.

def iron.CoordinateSystem_OrientationSetNum (   coordinateSystemUserNumber,
  orientation 
)
Sets/changes the orientation of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to set the orientation for.
:type coordinateSystemUserNumber: int
:param orientation: The orientation of the coordinate system to set.
:type orientation: 2d array of floats
:rtype: None

Definition at line 10695 of file iron.py.

def iron.CoordinateSystem_OriginGetNum (   coordinateSystemUserNumber,
  originSize 
)
Returns the origin of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to get the origin for.
:type coordinateSystemUserNumber: int
:param originSize: Size of origin to allocate.
:returns: origin. The orign of the coordinate system.
:rtype: Array of floats

Definition at line 10708 of file iron.py.

def iron.CoordinateSystem_OriginSetNum (   coordinateSystemUserNumber,
  origin 
)
Sets/changes the origin of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to set the origin for.
:type coordinateSystemUserNumber: int
:param origin: The orign of the coordinate system to set.
:type origin: Array of floats
:rtype: None

Definition at line 10721 of file iron.py.

def iron.CoordinateSystem_RadialInterpolationGetNum (   coordinateSystemUserNumber)
Returns the radial interpolation type of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to get the radial interpolation for.
:type coordinateSystemUserNumber: int
:returns: radialInterpolationType. The radial interpolation type of the coordinate system. Will be a value from the CoordinateRadialInterpolations enum.
:rtype: int

Definition at line 10734 of file iron.py.

def iron.CoordinateSystem_RadialInterpolationSetNum (   coordinateSystemUserNumber,
  radialInterpolationType 
)
Sets/changes the radial interpolation type of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to set the radial interpolation for.
:type coordinateSystemUserNumber: int
:param radialInterpolationType: The radial interpolation type of the coordinate system to set. Must be a value from the CoordinateRadialInterpolations enum.
:type radialInterpolationType: int
:rtype: None

Definition at line 10746 of file iron.py.

def iron.CoordinateSystem_TypeGetNum (   coordinateSystemUserNumber)
Returns the type of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to get the type for.
:type coordinateSystemUserNumber: int
:returns: coordinateSystemType. The type of the coordinate system. Will be a value from the CoordinateSystemTypes enum.
:rtype: int

Definition at line 10759 of file iron.py.

def iron.CoordinateSystem_TypeSetNum (   coordinateSystemUserNumber,
  coordinateSystemType 
)
Sets/changes the type of a coordinate system identified by a user number.

:param coordinateSystemUserNumber: The user number of the coordinate system to set the type for.
:type coordinateSystemUserNumber: int
:param coordinateSystemType: The type of the coordinate system to set. Must be a value from the CoordinateSystemTypes enum.
:type coordinateSystemType: int
:rtype: None

Definition at line 10771 of file iron.py.

def iron.DataPoints_CreateFinishNum (   regionUserNumber)
Finishes the process of creating data points in a region for data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to finish the creation of.
:type regionUserNumber: int
:rtype: None

Definition at line 10784 of file iron.py.

def iron.DataPoints_CreateStartNum (   regionUserNumber,
  numberOfDataPoints 
)
Starts the process of creating data points in a region for data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to start the creation of.
:type regionUserNumber: int
:param numberOfDataPoints: The number of data points to create.
:type numberOfDataPoints: int
:rtype: None

Definition at line 10795 of file iron.py.

def iron.DataPoints_DestroyNum (   regionUserNumber)
Destroys the data points in a region for data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to destroy.
:type regionUserNumber: int
:rtype: None

Definition at line 10808 of file iron.py.

def iron.DataPoints_LabelGetNum (   regionUserNumber,
  dataPointGlobalNumber 
)
Returns the character label for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to get the label for.
:type regionUserNumber: int
:param dataPointGlobalNumber: The global number of the data points to get the label for.
:type dataPointGlobalNumber: int
:returns: label. The label for the data point.
:rtype: string

Definition at line 10819 of file iron.py.

def iron.DataPoints_LabelSetNum (   regionUserNumber,
  dataPointGlobalNumber,
  label 
)
Sets/changes the character label for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to set the label for.
:type regionUserNumber: int
:param dataPointGlobalNumber: The global number of the data points to set the label for.
:type dataPointGlobalNumber: int
:param label: The label for the data point to set.
:type label: string
:rtype: None

Definition at line 10833 of file iron.py.

def iron.DataPoints_NumberOfDataPointsGetNum (   regionUserNumber)
Returns the number of data points

:param regionUserNumber: The user number of the region containing the data points to get data point count for.
:type regionUserNumber: int
:returns: numberOfDataPoints. The number of data points
:rtype: int

Definition at line 10848 of file iron.py.

def iron.DataPoints_UserNumberGetNum (   regionUserNumber,
  dataPointGlobalNumber 
)
Returns the user number for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to get the data point user number for.
:type regionUserNumber: int
:param dataPointGlobalNumber: The global number of the data points to get the data point user number for.
:type dataPointGlobalNumber: int
:returns: dataPointUserNumber. The user number for the data point.
:rtype: int

Definition at line 10860 of file iron.py.

def iron.DataPoints_UserNumberSetNum (   regionUserNumber,
  dataPointGlobalNumber,
  dataPointUserNumber 
)
Sets/changes the user number for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to set the data point user number for.
:type regionUserNumber: int
:param dataPointGlobalNumber: The global number of the data points to set the data point user number for.
:type dataPointGlobalNumber: int
:param dataPointUserNumber: The user number for the data point to set.
:type dataPointUserNumber: int
:rtype: None

Definition at line 10874 of file iron.py.

def iron.DataPoints_ValuesGetNum (   regionUserNumber,
  dataPointGlobalNumber,
  dataPointValuesSize 
)
Returns the values for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to get the data point user number for.
:type regionUserNumber: int
:param dataPointGlobalNumber: The global number of the data points to get the data point values for.
:type dataPointGlobalNumber: int
:param dataPointValuesSize: Size of dataPointValues to allocate.
:returns: dataPointValues. The values for the data point.
:rtype: Array of floats

Definition at line 10889 of file iron.py.

def iron.DataPoints_ValuesSetNum (   regionUserNumber,
  dataPointGlobalNumber,
  dataPointValues 
)
Sets/changes the values for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to set the data point user number for.
:type regionUserNumber: int
:param dataPointGlobalNumber: The global number of the data points to set the data point user number for.
:type dataPointGlobalNumber: int
:param dataPointValues: The values for the data point to set.
:type dataPointValues: Array of floats
:rtype: None

Definition at line 10904 of file iron.py.

def iron.DataPoints_WeightsGetNum (   regionUserNumber,
  dataPointGlobalNumber,
  dataPointWeightsSize 
)
Returns the weights for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to get the data point user number for.
:type regionUserNumber: int
:param dataPointGlobalNumber: The global number of the data points to get the data point user number for.
:type dataPointGlobalNumber: int
:param dataPointWeightsSize: Size of dataPointWeights to allocate.
:returns: dataPointWeights. The weights for the data point.
:rtype: Array of floats

Definition at line 10919 of file iron.py.

def iron.DataPoints_WeightsSetNum (   regionUserNumber,
  dataPointGlobalNumber,
  dataPointWeights 
)
Sets/changes the weights for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to set the data point user number for.
:type regionUserNumber: int
:param dataPointGlobalNumber: The global number of the data points to set the data point user number for.
:type dataPointGlobalNumber: int
:param dataPointWeights: The weights for the data point to set.
:type dataPointWeights: Array of floats
:rtype: None

Definition at line 10934 of file iron.py.

def iron.DataProjection_AbsoluteToleranceGetNum (   dataProjectionUserNumber,
  regionUserNumber 
)
Returns the absolute tolerance of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of the data projection to get tolerance for.
:type regionUserNumber: int
:returns: absoluteTolerance. On exit, the absolute tolerance of the specified data projection
:rtype: float

Definition at line 10949 of file iron.py.

def iron.DataProjection_AbsoluteToleranceSetNum (   dataProjectionUserNumber,
  regionUserNumber,
  absoluteTolerance 
)
Sets/changes the absolute tolerance of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region use number of data projection to set tolerance for.
:type regionUserNumber: int
:param absoluteTolerance: the absolute tolerance to set
:type absoluteTolerance: float
:rtype: None

Definition at line 10963 of file iron.py.

def iron.DataProjection_CreateFinishNum (   dataProjectionUserNumber,
  regionUserNumber 
)
Finishes the creation of a new data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The user number of the region containing the data points which associates to the data projection to finish the creation of.
:type regionUserNumber: int
:rtype: None

Definition at line 10978 of file iron.py.

def iron.DataProjection_CreateStartNum (   dataProjectionUserNumber,
  dataPointRegionUserNumber,
  meshUserNumber,
  meshRegionUserNumber 
)
Starts the creation of a new data projection for a data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number.
:type dataProjectionUserNumber: int
:param dataPointRegionUserNumber: The region user number of the data points to be projected.
:type dataPointRegionUserNumber: int
:param meshUserNumber: The field user number of the geometric field data points are be projected on.
:type meshUserNumber: int
:param meshRegionUserNumber: The region user number of the geometric field data points are be projected on.
:type meshRegionUserNumber: int
:rtype: None

Definition at line 10991 of file iron.py.

def iron.DataProjection_DataPointsPositionEvaluateInterfaceNum (   dataProjectionUserNumber,
  parentRegionUserNumber,
  interfaceUserNumber,
  fieldUserNumber,
  fieldVariableType 
)
Evaluate the data points position in a field based on data projection in an interface, identified by user number

:param dataProjectionUserNumber: The data projection user number of the data projection
:type dataProjectionUserNumber: int
:param parentRegionUserNumber: The parent region number of the interface for the data projection
:type parentRegionUserNumber: int
:param interfaceUserNumber: The interface number for the data projection
:type interfaceUserNumber: int
:param fieldUserNumber: The field user number of the field to be interpolated
:type fieldUserNumber: int
:param fieldVariableType: The field variable type to be interpolated
:type fieldVariableType: int
:rtype: None

Definition at line 11008 of file iron.py.

def iron.DataProjection_DataPointsPositionEvaluateRegionNum (   dataProjectionUserNumber,
  regionUserNumber,
  fieldUserNumber,
  fieldVariableType 
)
Evaluate the data points position in a field based on data projection in a region, identified by user number

:param dataProjectionUserNumber: The data projection user number of the data projection
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of the data projection and field
:type regionUserNumber: int
:param fieldUserNumber: The field user number of the field to be interpolated
:type fieldUserNumber: int
:param fieldVariableType: The field variable type to be interpolated
:type fieldVariableType: int
:rtype: None

Definition at line 11027 of file iron.py.

def iron.DataProjection_DataPointsProjectionEvaluateNum (   dataProjectionUserNumber,
  dataPointsRegionUserNumber,
  projectionFieldUserNumber,
  projectionFieldRegionUserNumber 
)
Evaluate a data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param dataPointsRegionUserNumber: The region user number of the data projection to evaluate.
:type dataPointsRegionUserNumber: int
:param projectionFieldUserNumber: The field user number of the field data points are be projected on.
:type projectionFieldUserNumber: int
:param projectionFieldRegionUserNumber: The region user number of the field data points are be projected on.
:type projectionFieldRegionUserNumber: int
:rtype: None

Definition at line 11044 of file iron.py.

def iron.DataProjection_DestroyNum (   dataProjectionUserNumber,
  regionUserNumber 
)
Destroys a data projection identified by region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of the data projection to destroy.
:type regionUserNumber: int
:rtype: None

Definition at line 11061 of file iron.py.

def iron.DataProjection_ElementSetInterfaceNum (   dataProjectionUserNumber,
  parentRegionUserNumber,
  interfaceUserNumber,
  dataPointNumber,
  elementNumber 
)
Sets/changes the starting xi of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param parentRegionUserNumber: The user number of the parent region.
:type parentRegionUserNumber: int
:param interfaceUserNumber: The user number of the interface.
:type interfaceUserNumber: int
:param dataPointNumber: The data point number to set xi position for
:type dataPointNumber: int
:param elementNumber: the element number to set
:type elementNumber: int
:rtype: None

Definition at line 11074 of file iron.py.

def iron.DataProjection_ElementSetRegionNum (   dataProjectionUserNumber,
  regionUserNumber,
  dataPointNumber,
  elementNumber 
)
Sets/changes the starting xi of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of data projection to set starting xi for.
:type regionUserNumber: int
:param dataPointNumber: The data point number to set xi position for
:type dataPointNumber: int
:param elementNumber: the element number to set
:type elementNumber: int
:rtype: None

Definition at line 11093 of file iron.py.

def iron.DataProjection_LabelGetCInterfaceNum (   dataProjectionUserNumber,
  parentRegionUserNumber,
  interfaceUserNumber 
)
Get the character string label of a data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get the label for.
:type dataProjectionUserNumber: int
:param parentRegionUserNumber: The user number of the parent region.
:type parentRegionUserNumber: int
:param interfaceUserNumber: The user number of the interface.
:type interfaceUserNumber: int
:returns: label. the label to get
:rtype: string

Definition at line 11110 of file iron.py.

def iron.DataProjection_LabelGetCRegionNum (   dataProjectionUserNumber,
  regionUserNumber 
)
Get the character string label of a data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get the label for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of data projection to get the label for.
:type regionUserNumber: int
:returns: label. the label to get
:rtype: string

Definition at line 11126 of file iron.py.

def iron.DataProjection_LabelSetCInterfaceNum (   dataProjectionUserNumber,
  parentRegionUserNumber,
  interfaceUserNumber,
  label 
)
Sets/changes the character string label of a data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to set the label for.
:type dataProjectionUserNumber: int
:param parentRegionUserNumber: The user number of the parent region.
:type parentRegionUserNumber: int
:param interfaceUserNumber: The user number of the interface.
:type interfaceUserNumber: int
:param label: the label to set
:type label: string
:rtype: None

Definition at line 11140 of file iron.py.

def iron.DataProjection_LabelSetCRegionNum (   dataProjectionUserNumber,
  regionUserNumber,
  label 
)
Sets/changes the character string label of a data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to set the label for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of data projection to set the label for.
:type regionUserNumber: int
:param label: the label to set
:type label: string
:rtype: None

Definition at line 11157 of file iron.py.

def iron.DataProjection_MaximumIterationUpdateGetNum (   dataProjectionUserNumber,
  regionUserNumber 
)
Returns the relative tolerance of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of the data projection to get tolerance for.
:type regionUserNumber: int
:returns: maximumIterationUpdate. On exit, the maximum iteration update of the specified data projection
:rtype: float

Definition at line 11172 of file iron.py.

def iron.DataProjection_MaximumIterationUpdateSetNum (   dataProjectionUserNumber,
  regionUserNumber,
  maximumIterationUpdate 
)
Sets/changes the relative tolerance of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region use number of data projection to set tolerance for.
:type regionUserNumber: int
:param maximumIterationUpdate: the maximum iteration update to set
:type maximumIterationUpdate: float
:rtype: None

Definition at line 11186 of file iron.py.

def iron.DataProjection_MaximumNumberOfIterationsGetNum (   dataProjectionUserNumber,
  regionUserNumber 
)
Returns the maximum number of iterations of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of the data projection to get maximum number of iterations for.
:type regionUserNumber: int
:returns: maximumNumberOfIterations. On exit, the maximum number of iterations of the specified data projection
:rtype: int

Definition at line 11201 of file iron.py.

def iron.DataProjection_MaximumNumberOfIterationsSetNum (   dataProjectionUserNumber,
  regionUserNumber,
  maximumNumberOfIterations 
)
Sets/changes the maximum number of iterations of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region use number of data projection to set maximum number of iterations for.
:type regionUserNumber: int
:param maximumNumberOfIterations: the maximum number of iterations to set
:type maximumNumberOfIterations: int
:rtype: None

Definition at line 11215 of file iron.py.

def iron.DataProjection_NumberOfClosestElementsGetNum (   dataProjectionUserNumber,
  regionUserNumber 
)
Returns the number of closest elements of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of the data projection to get number of closest elements for.
:type regionUserNumber: int
:returns: numberOfClosestElements. On exit, the number of closest elements of the specified data projection
:rtype: int

Definition at line 11230 of file iron.py.

def iron.DataProjection_NumberOfClosestElementsSetNum (   dataProjectionUserNumber,
  regionUserNumber,
  numberOfClosestElements 
)
Sets/changes the number of closest elements of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region use number of data projection to set number of closest elements for.
:type regionUserNumber: int
:param numberOfClosestElements: the number of closest elements to set
:type numberOfClosestElements: int
:rtype: None

Definition at line 11244 of file iron.py.

def iron.DataProjection_ProjectionCandidatesSetInterfaceNum (   dataProjectionUserNumber,
  parentRegionUserNumber,
  interfaceUserNumber,
  candidateElements,
  localFaceLineNumbers 
)
Evaluate the data points position in a field based on data projection in an interface, identified by user number

:param dataProjectionUserNumber: The data projection user number of the data projection
:type dataProjectionUserNumber: int
:param parentRegionUserNumber: The parent region number of the interface for the data projection
:type parentRegionUserNumber: int
:param interfaceUserNumber: The interface number for the data projection
:type interfaceUserNumber: int
:param candidateElements: The candidate element for the projection
:type candidateElements: Array of ints
:param localFaceLineNumbers: The local face/line number for the candidate elements
:type localFaceLineNumbers: Array of ints
:rtype: None

Definition at line 11259 of file iron.py.

def iron.DataProjection_ProjectionCandidatesSetRegionNum (   dataProjectionUserNumber,
  regionUserNumber,
  candidateElements,
  localFaceLineNumbers 
)
Evaluate the data points position in a field based on data projection in a region, identified by user number

:param dataProjectionUserNumber: The data projection user number of the data projection
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of the data projection and field
:type regionUserNumber: int
:param candidateElements: The candidate element for the projection
:type candidateElements: Array of ints
:param localFaceLineNumbers: The local face/line number for the candidate elements
:type localFaceLineNumbers: Array of ints
:rtype: None

Definition at line 11278 of file iron.py.

def iron.DataProjection_ProjectionTypeGetNum (   dataProjectionUserNumber,
  regionUserNumber 
)
Returns the projection type of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of the data projection to get projection type for.
:type regionUserNumber: int
:returns: projectionType. On exit, the projection type of the specified data projection
:rtype: int

Definition at line 11295 of file iron.py.

def iron.DataProjection_ProjectionTypeSetNum (   dataProjectionUserNumber,
  regionUserNumber,
  projectionType 
)
Sets/changes the projection type of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region use number of data projection to set projection type for.
:type regionUserNumber: int
:param projectionType: the projection type to set
:type projectionType: int
:rtype: None

Definition at line 11309 of file iron.py.

def iron.DataProjection_RelativeToleranceGetNum (   dataProjectionUserNumber,
  regionUserNumber 
)
Returns the relative tolerance of data projection identified by a data projection user number and a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of the data projection to get relative tolerance for.
:type regionUserNumber: int
:returns: relativeTolerance. On exit, the absolute relative tolerance of the specified data projection
:rtype: float

Definition at line 11324 of file iron.py.

def iron.DataProjection_RelativeToleranceSetNum (   dataProjectionUserNumber,
  regionUserNumber,
  relativeTolerance 
)
Sets/changes the relative tolerance of data projection identified by a data projection user number and a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region use number of data projection to set relative tolerance for.
:type regionUserNumber: int
:param relativeTolerance: the absolute relative tolerance to set
:type relativeTolerance: float
:rtype: None

Definition at line 11338 of file iron.py.

def iron.DataProjection_ResultDistanceGetNum (   regionUserNumber,
  dataProjectionUserNumber,
  dataPointUserNumber 
)
Returns the projection distance for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to get attributes for.
:type regionUserNumber: int
:param dataProjectionUserNumber: The user number of the data projection containing the data points to get attributes for.
:type dataProjectionUserNumber: int
:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:returns: ProjectionDistance. The projection distance for the data point.
:rtype: float

Definition at line 11353 of file iron.py.

def iron.DataProjection_ResultElementFaceNumberGetNum (   regionUserNumber,
  dataProjectionUserNumber,
  dataPointUserNumber 
)
Returns the projection element face number for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to get attributes for.
:type regionUserNumber: int
:param dataProjectionUserNumber: The user number of the data projection containing the data points to get attributes for.
:type dataProjectionUserNumber: int
:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:returns: ProjectionElementFaceNumber. The projection element face number for the data point.
:rtype: int

Definition at line 11369 of file iron.py.

def iron.DataProjection_ResultElementLineNumberGetNum (   regionUserNumber,
  dataProjectionUserNumber,
  dataPointUserNumber 
)
Returns the projection element line number for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to get attributes for.
:type regionUserNumber: int
:param dataProjectionUserNumber: The user number of the data projection containing the data points to get attributes for.
:type dataProjectionUserNumber: int
:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:returns: ProjectionElementLineNumber. The projection element line number for the data point.
:rtype: int

Definition at line 11385 of file iron.py.

def iron.DataProjection_ResultElementNumberGetNum (   regionUserNumber,
  dataProjectionUserNumber,
  dataPointUserNumber 
)
Returns the projection element number for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to get attributes for.
:type regionUserNumber: int
:param dataProjectionUserNumber: The user number of the data projection containing the data points to get attributes for.
:type dataProjectionUserNumber: int
:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:returns: ProjectionElementNumber. The projection element number for the data point.
:rtype: int

Definition at line 11401 of file iron.py.

def iron.DataProjection_ResultExitTagGetNum (   regionUserNumber,
  dataProjectionUserNumber,
  dataPointUserNumber 
)
Returns the projection exit tag for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to get attributes for.
:type regionUserNumber: int
:param dataProjectionUserNumber: The user number of the data projection containing the data points to get attributes for.
:type dataProjectionUserNumber: int
:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:returns: ProjectionExitTag. The projection exit tag for the data point.
:rtype: int

Definition at line 11417 of file iron.py.

def iron.DataProjection_ResultProjectionVectorGetNum (   regionUserNumber,
  dataProjectionUserNumber,
  dataPointUserNumber,
  projectionVectorSize 
)
Returns the projection vector for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to get attributes for.
:type regionUserNumber: int
:param dataProjectionUserNumber: The user number of the data projection containing the data points to get attributes for.
:type dataProjectionUserNumber: int
:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:param projectionVectorSize: Size of projectionVector to allocate.
:returns: projectionVector. The projection vector for the data point.
:rtype: Array of floats

Definition at line 11433 of file iron.py.

def iron.DataProjection_ResultXiGetNum (   regionUserNumber,
  dataProjectionUserNumber,
  dataPointUserNumber,
  ProjectionXiSize 
)
Returns the projection xi for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to get attributes for.
:type regionUserNumber: int
:param dataProjectionUserNumber: The user number of the data projection containing the data points to get attributes for.
:type dataProjectionUserNumber: int
:param dataPointUserNumber: The user number of the data points to get attributes for.
:type dataPointUserNumber: int
:param ProjectionXiSize: Size of ProjectionXi to allocate.
:returns: ProjectionXi. The projection xi for the data point.
:rtype: Array of floats

Definition at line 11450 of file iron.py.

def iron.DataProjection_ResultXiSetNum (   regionUserNumber,
  dataProjectionUserNumber,
  dataPointUserNumber,
  ProjectionXi 
)
Sets the projection xi for a data point in a set of data points identified by user number.

:param regionUserNumber: The user number of the region containing the data points to set attributes for.
:type regionUserNumber: int
:param dataProjectionUserNumber: The user number of the data projection containing the data points to set attributes for.
:type dataProjectionUserNumber: int
:param dataPointUserNumber: The user number of the data points to set attributes for.
:type dataPointUserNumber: int
:param ProjectionXi: On return, the projection xi for the data point.
:type ProjectionXi: Array of floats
:rtype: None

Definition at line 11467 of file iron.py.

def iron.DataProjection_StartingXiGetNum (   dataProjectionUserNumber,
  regionUserNumber,
  startingXiSize 
)
Returns the starting xi of data projection identified by a data projection user number and region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region user number of the data projection to get starting xi for.
:type regionUserNumber: int
:param startingXiSize: Size of startingXi to allocate.
:returns: startingXi. On exit, the absolute starting xi of the specified data projection
:rtype: Array of floats

Definition at line 11484 of file iron.py.

def iron.DataProjection_StartingXiSetNum (   dataProjectionUserNumber,
  regionUserNumber,
  startingXi 
)
Sets/changes the starting xi of data projection identified by a region user number.

:param dataProjectionUserNumber: The data projection user number of the data projection to get starting xi for.
:type dataProjectionUserNumber: int
:param regionUserNumber: The region use number of data projection to set starting xi for.
:type regionUserNumber: int
:param startingXi: the absolute starting xi to set
:type startingXi: Array of floats
:rtype: None

Definition at line 11499 of file iron.py.

def iron.Decomposition_CalculateFacesSetNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber,
  calculateFacesFlag 
)
Sets whether faces should be calculated

:param regionUserNumber: The user number of the region.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to set the decomposition type for.
:type decompositionUserNumber: int
:param calculateFacesFlag: Boolean to determine whether to set faces to be calculated.
:type calculateFacesFlag: bool
:rtype: None

Definition at line 11514 of file iron.py.

def iron.Decomposition_CalculateLinesSetNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber,
  calculateLinesFlag 
)
Sets whether lines should be calculated

:param regionUserNumber: The user number of the region.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to set the calculate lines flag for.
:type decompositionUserNumber: int
:param calculateLinesFlag: Boolean to determine whether to set lines to be calculated.
:type calculateLinesFlag: bool
:rtype: None

Definition at line 11531 of file iron.py.

def iron.Decomposition_CreateFinishNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber 
)
Finishes the creation of a domain decomposition for a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to finish the decomposition for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to finish the decomposition for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to finish.
:type decompositionUserNumber: int
:rtype: None

Definition at line 11548 of file iron.py.

def iron.Decomposition_CreateStartNum (   decompositionUserNumber,
  regionUserNumber,
  meshUserNumber 
)
Starts the creation of a domain decomposition for a decomposition identified by a user number.

:param decompositionUserNumber: The user number of the decomposition to create.
:type decompositionUserNumber: int
:param regionUserNumber: The user number of the region containing the mesh to create the decomposition for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to create the decomposition for.
:type meshUserNumber: int
:rtype: None

Definition at line 11563 of file iron.py.

def iron.Decomposition_DestroyNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber 
)
Destroys a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to destroy the decomposition for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to destroy the decomposition for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to destroy.
:type decompositionUserNumber: int
:rtype: None

Definition at line 11578 of file iron.py.

def iron.Decomposition_ElementDomainCalculateNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber 
)
Calculates the element domains for a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to calculate the element domains for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to calculate the element domains for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to calculate the element domains for.
:type decompositionUserNumber: int
:rtype: None

Definition at line 11593 of file iron.py.

def iron.Decomposition_ElementDomainGetNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber,
  elementUserNumber 
)
Returns the domain for a given element in a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to get the element domain for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to get the element domain for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to get the element domain for.
:type decompositionUserNumber: int
:param elementUserNumber: The user number of the element to get the domain for.
:type elementUserNumber: int
:returns: domain. The computational domain of the element.
:rtype: int

Definition at line 11608 of file iron.py.

def iron.Decomposition_ElementDomainSetNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber,
  elementUserNumber,
  domain 
)
Sets/changes the domain for a given element in a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to set the element domain for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to set the element domain for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to set the element domain for.
:type decompositionUserNumber: int
:param elementUserNumber: The user number of the element to set the domain for.
:type elementUserNumber: int
:param domain: The computational domain of the element to set.
:type domain: int
:rtype: None

Definition at line 11626 of file iron.py.

def iron.Decomposition_MeshComponentGetNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber 
)
Returns the mesh component number used for the decomposition of a mesh for a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to get the decomposition mesh component for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to get the decomposition mesh component for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to get the mesh component for.
:type decompositionUserNumber: int
:returns: meshComponentNumber. The mesh component number for the decomposition.
:rtype: int

Definition at line 11645 of file iron.py.

def iron.Decomposition_MeshComponentSetNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber,
  meshComponentNumber 
)
Sets/changes the mesh component number used for the decomposition of a mesh for a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to set the decomposition mesh component for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to set the decomposition mesh component for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to set the mesh component for.
:type decompositionUserNumber: int
:param meshComponentNumber: The mesh component number for the decomposition to set.
:type meshComponentNumber: int
:rtype: None

Definition at line 11661 of file iron.py.

def iron.Decomposition_NodeDomainGetNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber,
  nodeUserNumber,
  meshComponentNumber 
)
Returns the domain for a given node in a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to get the node domain for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to get the node domain for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to get the node domain for.
:type decompositionUserNumber: int
:param nodeUserNumber: The user number of the node to get the domain for.
:type nodeUserNumber: int
:param meshComponentNumber: The user number of the mesh component to get the domain for.
:type meshComponentNumber: int
:returns: domain. The computational domain of the node.
:rtype: int

Definition at line 11678 of file iron.py.

def iron.Decomposition_NumberOfDomainsGetNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber 
)
Returns the number of domains for a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to get the number of domains for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to get the number of domains for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to get the number of domains for.
:type decompositionUserNumber: int
:returns: numberOfDomains. The number of domains in the decomposition.
:rtype: int

Definition at line 11698 of file iron.py.

def iron.Decomposition_NumberOfDomainsSetNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber,
  numberOfDomains 
)
Sets/changes the number of domains for a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to set the number of domains for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to set the number of domains for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to set the number of domains for.
:type decompositionUserNumber: int
:param numberOfDomains: The number of domains in the decomposition to set.
:type numberOfDomains: int
:rtype: None

Definition at line 11714 of file iron.py.

def iron.Decomposition_TypeGetNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber 
)
Returns the type of a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to get the decomposition type for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to get the decomposition type for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to get the decomposition type for.
:type decompositionUserNumber: int
:returns: decompositionType. The type of the decomposition.
:rtype: int

Definition at line 11731 of file iron.py.

def iron.Decomposition_TypeSetNum (   regionUserNumber,
  meshUserNumber,
  decompositionUserNumber,
  decompositionType 
)
Sets/changes the type of a decomposition identified by a user number.

:param regionUserNumber: The user number of the region containing the mesh to set the decomposition type for.
:type regionUserNumber: int
:param meshUserNumber: The user number of the mesh to set the decomposition type for.
:type meshUserNumber: int
:param decompositionUserNumber: The user number of the decomposition to set the decomposition type for.
:type decompositionUserNumber: int
:param decompositionType: The type of the decomposition to set.
:type decompositionType: int
:rtype: None

Definition at line 11747 of file iron.py.

def iron.DiagnosticsSetOff ( )
Sets diagnostics off

:rtype: None

Definition at line 11764 of file iron.py.

def iron.DiagnosticsSetOn (   diagType,
  levelList,
  diagFilename,
  routineList 
)
Sets diagnostics on

:param diagType: The type of diagnostics to set on. Must be a value from the DiagnosticTypes enum.
:type diagType: int
:param levelList: The list of diagnostic levels to set on.
:type levelList: Array of ints
:param diagFilename: If present the name of the file to output diagnostic information to. If omitted the diagnostic output is sent to the screen.
:type diagFilename: string
:param routineList: The list of routines to set diagnostics on in.
:type routineList: Array of strings
:rtype: None

Definition at line 11773 of file iron.py.

def iron.DistributedMatrix_DataGet (   self,
  args 
)

Definition at line 20077 of file iron.py.

def iron.DistributedMatrix_DataRestore (   self,
  args 
)

Definition at line 20088 of file iron.py.

def iron.DistributedMatrix_SciPyRestore (   self,
  matrix 
)
Restores the data pointers used when creating a SciPy matrix

Trying to use the SciPy matrix after this will not work

Definition at line 20188 of file iron.py.

def iron.DistributedMatrix_ToSciPy (   self)
Return a SciPy matrix representation of this matrix

This works with sparse and full matrices and uses a view
of the matrix data so there is no copying.
Once finished with the matrix you should call the
SciPyRestore method.

Definition at line 20127 of file iron.py.

def iron.DistributedVector_DataGet (   self,
  args 
)

Definition at line 20099 of file iron.py.

def iron.DistributedVector_DataRestore (   self,
  args 
)

Definition at line 20110 of file iron.py.

def iron.Equations_DestroyNum (   regionUserNumber,
  equationsSetUserNumber 
)
Destroys equations for equations identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations to destroy.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to destroy the equations for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12308 of file iron.py.

def iron.Equations_LinearityTypeGetNum (   regionUserNumber,
  equationsSetUserNumber 
)
Gets the linearity type for equations identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations to get the linearity type for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to get the linearity type for.
:type equationsSetUserNumber: int
:returns: linearityType. The linearity type of the equations. Will be a value from the EquationsLinearityTypes enum.
:rtype: int

Definition at line 12321 of file iron.py.

def iron.Equations_LumpingTypeGetNum (   regionUserNumber,
  equationsSetUserNumber 
)
Gets the lumping type for equations identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations to get the lumping type for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to get the lumping type for.
:type equationsSetUserNumber: int
:returns: lumpingType. The lumping type of the equations. Will be a value from the EquationsLumpingTypes enum.
:rtype: int

Definition at line 12335 of file iron.py.

def iron.Equations_LumpingTypeSetNum (   regionUserNumber,
  equationsSetUserNumber,
  lumpingType 
)
Sets/changes the lumping type for equations identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations to set the lumping type for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to set the lumping type for.
:type equationsSetUserNumber: int
:param lumpingType: The lumping type of the equations to set. Must be a value from the EquationsLumpingTypes enum.
:type lumpingType: int
:rtype: None

Definition at line 12349 of file iron.py.

def iron.Equations_OutputTypeGetNum (   regionUserNumber,
  equationsSetUserNumber 
)
Gets the output type for equations identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations to get the output type for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to get the output type for.
:type equationsSetUserNumber: int
:returns: outputType. The output type of the equations. Will be a value from the EquationsOutputTypes enum.
:rtype: int

Definition at line 12364 of file iron.py.

def iron.Equations_OutputTypeSetNum (   regionUserNumber,
  equationsSetUserNumber,
  outputType 
)
Sets/changes the output type for equations identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations to set the output type for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to set the output type for.
:type equationsSetUserNumber: int
:param outputType: The output type of the equations to set. Must be a value from the EquationsOutputTypes enum.
:type outputType: int
:rtype: None

Definition at line 12378 of file iron.py.

def iron.Equations_SparsityTypeGetNum (   regionUserNumber,
  equationsSetUserNumber 
)
Gets the sparsity type for equations identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations to get the sparsity type for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to get the sparsity type for.
:type equationsSetUserNumber: int
:returns: sparsityType. The sparsity type of the equations. Will be a value from the EquationsSparsityTypes enum.
:rtype: int

Definition at line 12393 of file iron.py.

def iron.Equations_SparsityTypeSetNum (   regionUserNumber,
  equationsSetUserNumber,
  sparsityType 
)
Sets/changes the sparsity type for equations identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations to set the sparsity type for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to set the sparsity type for.
:type equationsSetUserNumber: int
:param sparsityType: The sparsity type of the equations to set. Must be a value from the EquationsSparsityTypes enum.
:type sparsityType: int
:rtype: None

Definition at line 12407 of file iron.py.

def iron.Equations_TimeDependenceTypeGetNum (   regionUserNumber,
  equationsSetUserNumber 
)
Gets the time dependence type for equations identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations to get the time dependence type for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to get the time dependence type for.
:type equationsSetUserNumber: int
:returns: timeDependenceType. The time dependence type of the equations. Will be a value from the EquationsTimeDependenceTypes enum.
:rtype: int

Definition at line 12422 of file iron.py.

def iron.EquationsSet_AnalyticCreateFinishNum (   regionUserNumber,
  equationsSetUserNumber 
)
Finish the creation of a analytic solution for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to finish.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to finish the creation of.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 11790 of file iron.py.

def iron.EquationsSet_AnalyticCreateStartNum (   regionUserNumber,
  equationsSetUserNumber,
  analyticFunctionType,
  analyticFieldUserNumber 
)
Start the creation of a analytic solution for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to finish.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to finish the creation of.
:type equationsSetUserNumber: int
: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
:rtype: None

Definition at line 11803 of file iron.py.

def iron.EquationsSet_AnalyticDestroyNum (   regionUserNumber,
  equationsSetUserNumber 
)
Destroy the analytic solution for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to destroy.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to destroy.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 11820 of file iron.py.

def iron.EquationsSet_AnalyticEvaluateNum (   regionUserNumber,
  equationsSetUserNumber 
)
Evaluates the current analytic solution for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to evaluate.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to evaluate.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 11833 of file iron.py.

def iron.EquationsSet_AnalyticTimeGetNum (   regionUserNumber,
  equationsSetUserNumber 
)
Returns the analytic time for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set get the analytic time for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to get the analytic time get.
:type equationsSetUserNumber: int
:returns: time. The analytic time for the equations set.
:rtype: float

Definition at line 11846 of file iron.py.

def iron.EquationsSet_AnalyticTimeSetNum (   regionUserNumber,
  equationsSetUserNumber,
  time 
)
Sets/changes the analytic time for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set get the analytic time for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to get the analytic time get.
:type equationsSetUserNumber: int
:param time: The analytic time to set.
:type time: float
:rtype: None

Definition at line 11860 of file iron.py.

def iron.EquationsSet_AnalyticUserParamGetNum (   regionUserNumber,
  equationsSetUserNumber,
  paramIdx 
)
Sets the analytic problem user parameter

:param regionUserNumber: The user number of the Region containing the equations set
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set
:type equationsSetUserNumber: int
: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 11875 of file iron.py.

def iron.EquationsSet_AnalyticUserParamSetNum (   regionUserNumber,
  equationsSetUserNumber,
  paramIdx,
  param 
)
Sets the analytic problem user parameter

:param regionUserNumber: The user number of the Region containing the equations set
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set
:type equationsSetUserNumber: int
: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 11891 of file iron.py.

def iron.EquationsSet_CreateFinishNum (   regionUserNumber,
  equationsSetUserNumber 
)
Finish the creation of an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to finish.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to finish the creation of.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 11908 of file iron.py.

def iron.EquationsSet_CreateStartNum (   equationsSetUserNumber,
  regionUserNumber,
  geomFibreFieldUserNumber,
  equationsSetSpecification,
  equationsSetFieldUserNumber 
)
Start the creation of an equations set identified by a user number.

:param equationsSetUserNumber: The user number of the equations set to be created.
:type equationsSetUserNumber: int
:param regionUserNumber: The user number of the region to start the creation of an equations set on.
:type regionUserNumber: int
:param geomFibreFieldUserNumber: The user number of the Geometric/Fibre field for the equations set.
:type geomFibreFieldUserNumber: int
: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
:rtype: None

Definition at line 11921 of file iron.py.

def iron.EquationsSet_DependentCreateFinishNum (   regionUserNumber,
  equationsSetUserNumber 
)
Finish the creation of dependent variables for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to finish the creation of dependent variables for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to finish the creation of dependent variables for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 11940 of file iron.py.

def iron.EquationsSet_DependentCreateStartNum (   regionUserNumber,
  equationsSetUserNumber,
  dependentFieldUserNumber 
)
Start the creation of dependent variables for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to start the creation of dependent variables for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to start the creation of dependent variables for.
:type equationsSetUserNumber: int
:param dependentFieldUserNumber: The user number of the dependent field.
:type dependentFieldUserNumber: int
:rtype: None

Definition at line 11953 of file iron.py.

def iron.EquationsSet_DependentDestroyNum (   regionUserNumber,
  equationsSetUserNumber 
)
Destroy the dependent variables for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to destroy the dependent variables for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to destroy the dependent variables for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 11968 of file iron.py.

def iron.EquationsSet_DerivedCreateFinishNum (   regionUserNumber,
  equationsSetUserNumber 
)
Finish the creation of derived variables for an equations set identified by a user number.

:param regionUserNumber: The user number of the region containing the equations set to finish the creation of derived variables for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to finish the creation of derived variables for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 11981 of file iron.py.

def iron.EquationsSet_DerivedCreateStartNum (   regionUserNumber,
  equationsSetUserNumber,
  derivedFieldUserNumber 
)
Start the creation of derived variables for an equations set identified by a user number.

:param regionUserNumber: The user number of the region containing the equations set to start the creation of derived variables for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to start the creation of derived variables for.
:type equationsSetUserNumber: int
:param derivedFieldUserNumber: The user number of the derived field.
:type derivedFieldUserNumber: int
:rtype: None

Definition at line 11994 of file iron.py.

def iron.EquationsSet_DerivedDestroyNum (   regionUserNumber,
  equationsSetUserNumber 
)
Destroy the derived variables for an equations set identified by a user number.

:param regionUserNumber: The user number of the region containing the equations set to destroy the derived variables for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to destroy the derived variables for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12009 of file iron.py.

def iron.EquationsSet_DerivedVariableCalculateNum (   regionUserNumber,
  equationsSetUserNumber,
  derivedType 
)
Calculates a derived field value for the equations set and stores the result in the derived field previously set up

:param regionUserNumber: The user number of the region containing the equations set.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to calculate the output for.
:type equationsSetUserNumber: int
:param derivedType: The derived variable type to calculate. Must be a value from the EquationsSetDerivedTypes enum.
:type derivedType: int
:rtype: None

Definition at line 12022 of file iron.py.

def iron.EquationsSet_DerivedVariableSetNum (   regionUserNumber,
  equationsSetUserNumber,
  derivedType,
  fieldVariableType 
)
Sets the field variable type of the derived field to be used to store a derived variable

:param regionUserNumber: The user number of the region containing the equations set.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to calculate the output for.
:type equationsSetUserNumber: int
:param derivedType: The derived variable 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 12037 of file iron.py.

def iron.EquationsSet_DestroyNum (   regionUserNumber,
  equationsSetUserNumber 
)
Destroy an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to destory.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to destroy.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12054 of file iron.py.

def iron.EquationsSet_EquationsCreateFinishNum (   regionUserNumber,
  equationsSetUserNumber 
)
Finish the creation of equations for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to finish the creation of equations for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to finish the creation of equations for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12067 of file iron.py.

def iron.EquationsSet_EquationsCreateStartNum (   regionUserNumber,
  equationsSetUserNumber 
)
Start the creation of equations for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to start the creation of equations for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to start the creation of equations for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12080 of file iron.py.

def iron.EquationsSet_EquationsDestroyNum (   regionUserNumber,
  equationsSetUserNumber 
)
Destroy the equations for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to destroy the equations for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to destroy the equations for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12093 of file iron.py.

def iron.EquationsSet_IndependentCreateFinishNum (   regionUserNumber,
  equationsSetUserNumber 
)
Finish the creation of independent variables for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to finish the creation of independent variables for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to finish the creation of independent variables for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12106 of file iron.py.

def iron.EquationsSet_IndependentCreateStartNum (   regionUserNumber,
  equationsSetUserNumber,
  independentFieldUserNumber 
)
Start the creation of independent variables for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to start the creation of independent variables for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to start the creation of independent variables for.
:type equationsSetUserNumber: int
:param independentFieldUserNumber: The user number of the independent field.
:type independentFieldUserNumber: int
:rtype: None

Definition at line 12119 of file iron.py.

def iron.EquationsSet_IndependentDestroyNum (   regionUserNumber,
  equationsSetUserNumber 
)
Destroy the independent variables for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to destroy the independent variables for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to destroy the independent variables for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12134 of file iron.py.

def iron.EquationsSet_MaterialsCreateFinishNum (   regionUserNumber,
  equationsSetUserNumber 
)
Finish the creation of materials for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to finish the creation of materials for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to finish the creation of materials for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12147 of file iron.py.

def iron.EquationsSet_MaterialsCreateStartNum (   regionUserNumber,
  equationsSetUserNumber,
  materialsFieldUserNumber 
)
Start the creation of materials for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to start the creation of materials for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to start the creation of materials for.
:type equationsSetUserNumber: int
:param materialsFieldUserNumber: The user number of the materials field.
:type materialsFieldUserNumber: int
:rtype: None

Definition at line 12160 of file iron.py.

def iron.EquationsSet_MaterialsDestroyNum (   regionUserNumber,
  equationsSetUserNumber 
)
Destroy the materials for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to destroy the materials for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to destroy the materials for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12175 of file iron.py.

def iron.EquationsSet_SolutionMethodGetNum (   regionUserNumber,
  equationsSetUserNumber 
)
Returns the solution method for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to get the solution method for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to get the solution method for.
:type equationsSetUserNumber: int
:returns: solutionMethod. The solution method. Will be a value from the EquationsSetSolutionMethods enum.
:rtype: int

Definition at line 12188 of file iron.py.

def iron.EquationsSet_SolutionMethodSetNum (   regionUserNumber,
  equationsSetUserNumber,
  solutionMethod 
)
Sets/changes the solution method for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to set the solution method for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to set the solution method for.
:type equationsSetUserNumber: int
:param solutionMethod: The solution method to set. Must be a value from the EquationsSetSolutionMethods enum.
:type solutionMethod: int
:rtype: None

Definition at line 12202 of file iron.py.

def iron.EquationsSet_SourceCreateFinishNum (   regionUserNumber,
  equationsSetUserNumber 
)
Finish the creation of a source for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to finish the creation of a source for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to finish the creation of a source for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12217 of file iron.py.

def iron.EquationsSet_SourceCreateStartNum (   regionUserNumber,
  equationsSetUserNumber,
  sourceFieldUserNumber 
)
Start the creation of a source for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to start the creation of a source for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to start the creation of a source for.
:type equationsSetUserNumber: int
:param sourceFieldUserNumber: The user number of the source field.
:type sourceFieldUserNumber: int
:rtype: None

Definition at line 12230 of file iron.py.

def iron.EquationsSet_SourceDestroyNum (   regionUserNumber,
  equationsSetUserNumber 
)
Destroy the source for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to destroy the source for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to destroy the source for.
:type equationsSetUserNumber: int
:rtype: None

Definition at line 12245 of file iron.py.

def iron.EquationsSet_SpecificationGetNum (   regionUserNumber,
  equationsSetUserNumber,
  equationsSetSpecification 
)
Returns the equations set specification array for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to get the specification for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to get the specification for.
:type equationsSetUserNumber: int
: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 12258 of file iron.py.

def iron.EquationsSet_SpecificationSizeGetNum (   regionUserNumber,
  equationsSetUserNumber 
)
Returns the size of the equations set specification array for an equations set identified by a user number.

:param regionUserNumber: The user number of the Region containing the equations set to get the specification size for.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to get the specification size for.
:type equationsSetUserNumber: int
:returns: specificationSize. The size of the equations set specification array.
:rtype: int

Definition at line 12273 of file iron.py.

def iron.EquationsSet_TensorInterpolateXiNum (   regionUserNumber,
  equationsSetUserNumber,
  tensorEvaluateType,
  userElementNumber,
  xi,
  valuesSizes 
)
Evaluate a tensor at a given element xi location, for an equations set identified by a user number.

:param regionUserNumber: The user number of the region containing the equations set.
:type regionUserNumber: int
:param equationsSetUserNumber: The user number of the equations set to evalaute the tensor for.
:type equationsSetUserNumber: int
: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 tensor values.
:rtype: 2d array of floats

Definition at line 12287 of file iron.py.

def iron.ErrorHandlingModeGet ( )
Returns the error handling mode for OpenCMISS

:returns: errorHandlingMode. The error handling mode. Will be a value from the CMISSErrorHandlingModes enum.
:rtype: int

Definition at line 12436 of file iron.py.

def iron.ErrorHandlingModeSet (   errorHandlingMode)
Sets the error handling mode for OpenCMISS

:param errorHandlingMode: The error handling mode to set. Must be a value from the CMISSErrorHandlingModes enum.
:type errorHandlingMode: int
:rtype: None

Definition at line 12446 of file iron.py.

def iron.ExtractErrorMessage ( )
Extracts the most recent error string for OpenCMISS

:returns: errorMessage. The extracted error message.
:rtype: string

Definition at line 12457 of file iron.py.

def iron.Field_ComponentInterpolationGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Returns the interpolation type for a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the interpolation type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the interpolation type for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the interpolation type for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param componentNumber: The component number of the field variable to get the interpolation type for.
:type componentNumber: int
:returns: interpolationType. The interpolation type. Will be a value from the FieldInterpolationTypes enum.
:rtype: int

Definition at line 12467 of file iron.py.

def iron.Field_ComponentInterpolationSetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber,
  interpolationType 
)
Sets/changes the interpolation type for a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the interpolation type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the interpolation type for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to set the interpolation type for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param componentNumber: The component number of the field variable to set the interpolation type for.
:type componentNumber: int
:param interpolationType: The interpolation type to set. Must be a value from the FieldInterpolationTypes enum.
:type interpolationType: int
:rtype: None

Definition at line 12485 of file iron.py.

def iron.Field_ComponentLabelGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Returns the character string label for a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the label for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the label for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the label for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param componentNumber: The component number of the field variable to get the label for.
:type componentNumber: int
:returns: label. The field variable component label.
:rtype: string

Definition at line 12504 of file iron.py.

def iron.Field_ComponentLabelSetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber,
  label 
)
Sets/changes the character string label for a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the label for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the label for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to set the label for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param componentNumber: The component number of the field variable to set the label for.
:type componentNumber: int
:param label: The field variable component label to set.
:type label: string
:rtype: None

Definition at line 12522 of file iron.py.

def iron.Field_ComponentMeshComponentGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber 
)
Returns the mesh component number for a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the mesh component number for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the mesh component number for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the mesh component number for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param componentNumber: The component number of the field variable to get the mesh component number for.
:type componentNumber: int
:returns: meshComponent. The mesh component number.
:rtype: int

Definition at line 12541 of file iron.py.

def iron.Field_ComponentMeshComponentSetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber,
  meshComponent 
)
Sets/changes the mesh component number for a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the mesh component number for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the mesh component number for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to set the mesh component number for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param componentNumber: The component number of the field variable to set the mesh component number for.
:type componentNumber: int
:param meshComponent: The mesh component number to set.
:type meshComponent: int
:rtype: None

Definition at line 12559 of file iron.py.

def iron.Field_ComponentValuesInitialise (   self,
  args 
)

Definition at line 19906 of file iron.py.

def iron.Field_ComponentValuesInitialiseDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Initialises the values of parameter set of a field variable component to a double precision constant value for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to initialise the field variable component for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to initialise the field variable component for for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to initialise the field variable component for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to initialise the field variable component for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to initialise the field variable component for.
:type componentNumber: int
:param value: The value to initialise the parameter set for.
:type value: float
:rtype: None

Definition at line 12578 of file iron.py.

def iron.Field_ComponentValuesInitialiseIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Initialises the values of parameter set of a field variable component to an integer constant value for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to initialise the field variable component for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to initialise the field variable component for for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to initialise the field variable component for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to initialise the field variable component for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to initialise the field variable component for.
:type componentNumber: int
:param value: The value to initialise the parameter set for.
:type value: int
:rtype: None

Definition at line 12599 of file iron.py.

def iron.Field_ComponentValuesInitialiseLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Initialises the values of parameter set of a field variable component to a logical constant value for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to initialise the field variable component for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to initialise the field variable component for for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to initialise the field variable component for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to initialise the field variable component for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to initialise the field variable component for.
:type componentNumber: int
:param value: The value to initialise the parameter set for.
:type value: bool
:rtype: None

Definition at line 12620 of file iron.py.

def iron.Field_ComponentValuesInitialiseSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Initialises the values of parameter set of a field variable component to a single precision constant value for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to initialise the field variable component for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to initialise the field variable component for for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to initialise the field variable component for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to initialise the field variable component for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to initialise the field variable component for.
:type componentNumber: int
:param value: The value to initialise the parameter set for.
:type value: float
:rtype: None

Definition at line 12641 of file iron.py.

def iron.Field_CreateFinishNum (   regionUserNumber,
  fieldUserNumber 
)
Finishes the creation of a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to finish the creation of.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to finish the creation of.
:type fieldUserNumber: int
:rtype: None

Definition at line 12662 of file iron.py.

def iron.Field_CreateStartNum (   fieldUserNumber,
  regionUserNumber 
)
Starts the creation of a field identified by a user number.

:param fieldUserNumber: The user number of the field to start the creation of.
:type fieldUserNumber: int
:param regionUserNumber: The user number of the region containing the field to start the creation of.
:type regionUserNumber: int
:rtype: None

Definition at line 12675 of file iron.py.

def iron.Field_DataProjectionSetNum (   regionUserNumber,
  fieldUserNumber,
  dataProjectionUserNumber 
)
Sets/changes the data projection for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the mesh decomposition for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the mesh decomposition for.
:type fieldUserNumber: int
:param dataProjectionUserNumber: The field data projection user number to set.
:type dataProjectionUserNumber: int
:rtype: None

Definition at line 12721 of file iron.py.

def iron.Field_DataTypeGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType 
)
Returns the data type for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the data type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the data type for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the data type for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:returns: dataType. The field variable data type. Will be a value from the FieldDataTypes enum.
:rtype: int

Definition at line 12736 of file iron.py.

def iron.Field_DataTypeSetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  dataType 
)
Sets/changes the data type for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the data type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the data type for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to set the data type for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param dataType: The field variable data type to set. Must be a value from the FieldDataTypes enum.
:type dataType: int
:rtype: None

Definition at line 12752 of file iron.py.

def iron.Field_DependentTypeGetNum (   regionUserNumber,
  fieldUserNumber 
)
Returns the dependent type for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the dependent type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the dependent type for.
:type fieldUserNumber: int
:returns: dependentType. The field dependent type. Will be a value from the FieldDependentTypes enum.
:rtype: int

Definition at line 12769 of file iron.py.

def iron.Field_DependentTypeSetNum (   regionUserNumber,
  fieldUserNumber,
  dependentType 
)
Sets/changes the dependent type for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the dependent type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the dependent type for.
:type fieldUserNumber: int
:param dependentType: The field dependent type to set. Must be a value from the FieldDependentTypes enum.
:type dependentType: int
:rtype: None

Definition at line 12783 of file iron.py.

def iron.Field_DestroyNum (   regionUserNumber,
  fieldUserNumber 
)
Destroys a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to destroy.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to destroy.
:type fieldUserNumber: int
:rtype: None

Definition at line 12798 of file iron.py.

def iron.Field_DimensionGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType 
)
Returns the dimension for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the dimension for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the dimension for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the dimension for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:returns: dimension. The field dimension. Will be a value from the FieldDimensionTypes enum.
:rtype: int

Definition at line 12811 of file iron.py.

def iron.Field_DimensionSetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  dimension 
)
Sets/changes the dimension for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the dimension for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the dimension for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the dimension for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param dimension: The field dimension to set. Must be a value from the FieldDimensionTypes enum.
:type dimension: int
:rtype: None

Definition at line 12827 of file iron.py.

def iron.Field_DOFOrderTypeGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType 
)
Returns the DOF order type for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the DOF Order type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the DOF Order type for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the DOF Order type for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:returns: DOFOrderType. The field variable DOF Order type. Will be a value from the FieldDOFOrderTypes enum.
:rtype: int

Definition at line 12688 of file iron.py.

def iron.Field_DOFOrderTypeSetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  DOFOrderType 
)
Sets/changes the DOF order type for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the DOF Order type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the DOF Order type for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to set the DOF Order type for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param DOFOrderType: The field variable DOF Order type to set. Must be a value from the FieldDOFOrderTypes enum.
:type DOFOrderType: int
:rtype: None

Definition at line 12704 of file iron.py.

def iron.Field_GeometricFieldGetNum (   regionUserNumber,
  fieldUserNumber 
)
Returns the geometric field for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the geometric field for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the geometric field for.
:type fieldUserNumber: int
:returns: geometricFieldUserNumber. The field geometric field user number.
:rtype: int

Definition at line 12844 of file iron.py.

def iron.Field_GeometricFieldSetNum (   regionUserNumber,
  fieldUserNumber,
  geometricFieldUserNumber 
)
Sets/changes the geometric field for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the geometric field for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the geometric field for.
:type fieldUserNumber: int
:param geometricFieldUserNumber: The field geometric field user number to set.
:type geometricFieldUserNumber: int
:rtype: None

Definition at line 12858 of file iron.py.

def iron.Field_GeometricParametersElementLineLengthGetNum (   regionUserNumber,
  geometricFieldUserNumber,
  elementNumber,
  elementLineNumber 
)
Gets the line length between nodes of a geometric field for a given element number and element basis line number by a user number.

:param regionUserNumber: The user number of the region containing the field to obtain the line length from
:type regionUserNumber: int
:param geometricFieldUserNumber: The geometric field user number to obtain the line length from
:type geometricFieldUserNumber: int
:param elementNumber: The element to get the line length for
:type elementNumber: int
:param elementLineNumber: The element basis line to get the length for
:type elementLineNumber: int
:returns: lineLength. The line length of the chosen element line number
:rtype: float

Definition at line 12873 of file iron.py.

def iron.Field_GeometricParametersElementVolumeGetNum (   regionUserNumber,
  geometricFieldUserNumber,
  elementNumber 
)
Gets the volume for a given element number by a user number.

:param regionUserNumber: The user number of the region containing the field to obtain the volume from
:type regionUserNumber: int
:param geometricFieldUserNumber: The geometric field user number to obtain the volume from
:type geometricFieldUserNumber: int
:param elementNumber: The element to get the volume for
:type elementNumber: int
:returns: elementVolume. The volume of the chosen element number
:rtype: float

Definition at line 12891 of file iron.py.

def iron.Field_LabelGetNum (   regionUserNumber,
  fieldUserNumber 
)
Returns the character string label for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the label for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the label for.
:type fieldUserNumber: int
:returns: label. The field label.
:rtype: string

Definition at line 12907 of file iron.py.

def iron.Field_LabelSetNum (   regionUserNumber,
  fieldUserNumber,
  label 
)
Sets/changes the character string label for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the label for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the label for.
:type fieldUserNumber: int
:param label: The field label to set.
:type label: string
:rtype: None

Definition at line 12921 of file iron.py.

def iron.Field_MeshDecompositionGetNum (   regionUserNumber,
  fieldUserNumber 
)
Returns the mesh decomposition for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the mesh decomposition for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the mesh decomposition for.
:type fieldUserNumber: int
:returns: decompositionUserNumber. The field decomposition user number.
:rtype: int

Definition at line 12936 of file iron.py.

def iron.Field_MeshDecompositionSetNum (   regionUserNumber,
  fieldUserNumber,
  meshUserNumber,
  decompositionUserNumber 
)
Sets/changes the mesh decomposition for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the mesh decomposition for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the mesh decomposition for.
:type fieldUserNumber: int
:param meshUserNumber: The user number of the mesh to set the mesh decomposition for.
:type meshUserNumber: int
:param decompositionUserNumber: The field mesh decomposition user number to set.
:type decompositionUserNumber: int
:rtype: None

Definition at line 12950 of file iron.py.

def iron.Field_NumberOfComponentsGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType 
)
Returns the number of componenets for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the number of components for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the number of components for.
:type fieldUserNumber: int
:param variableType: The variable type of the dependent field to get the number of components for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:returns: numberOfComponents. The number of components in the field variable.
:rtype: int

Definition at line 12967 of file iron.py.

def iron.Field_NumberOfComponentsSetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  numberOfComponents 
)
Sets/changes the number of componenets for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the number of components for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the number of components for.
:type fieldUserNumber: int
:param variableType: The variable type of the dependent field to set the number of components for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param numberOfComponents: The number of components in the field variable to set.
:type numberOfComponents: int
:rtype: None

Definition at line 12983 of file iron.py.

def iron.Field_NumberOfVariablesGetNum (   regionUserNumber,
  fieldUserNumber 
)
Returns the number of variables for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the number of variables for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the number of variables for.
:type fieldUserNumber: int
:returns: numberOfVariables. The number of variables in the field.
:rtype: int

Definition at line 13000 of file iron.py.

def iron.Field_NumberOfVariablesSetNum (   regionUserNumber,
  fieldUserNumber,
  numberOfVariables 
)
Sets/chnages the number of variables for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the number of variables for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the number of variables for.
:type fieldUserNumber: int
:param numberOfVariables: The number of variables in the field to set.
:type numberOfVariables: int
:rtype: None

Definition at line 13014 of file iron.py.

def iron.Field_ParameterSetAddConstant (   self,
  args 
)

Definition at line 20011 of file iron.py.

def iron.Field_ParameterSetAddConstantDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Adds the given double precision value to the given parameter set for the constant of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the constant to the field parameter set for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the constant to the field parameter set for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the constant to the field parameter set for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the constant to the field parameter set for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to add the constant to the field parameter set for.
:type componentNumber: int
:param value: The value to add to the field parameter set.
:type value: float
:rtype: None

Definition at line 13029 of file iron.py.

def iron.Field_ParameterSetAddConstantIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Adds the given integer value to the given parameter set for the constant of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the constant to the field parameter set for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the constant to the field parameter set for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the constant to the field parameter set for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the constant to the field parameter set for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to add the constant to the field parameter set for.
:type componentNumber: int
:param value: The value to add to the field parameter set.
:type value: int
:rtype: None

Definition at line 13050 of file iron.py.

def iron.Field_ParameterSetAddConstantLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Adds the given logical value to the given parameter set for the constant of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the constant to the field parameter set for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the constant to the field parameter set for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the constant to the field parameter set for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the constant to the field parameter set for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to add the constant to the field parameter set for.
:type componentNumber: int
:param value: The value to add to the field parameter set.
:type value: bool
:rtype: None

Definition at line 13071 of file iron.py.

def iron.Field_ParameterSetAddConstantSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Adds the given single precision value to the given parameter set for the constant of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the constant to the field parameter set for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the constant to the field parameter set for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the constant to the field parameter set for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the constant to the field parameter set for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to add the constant to the field parameter set for.
:type componentNumber: int
:param value: The value to add to the field parameter set.
:type value: float
:rtype: None

Definition at line 13092 of file iron.py.

def iron.Field_ParameterSetAddElement (   self,
  args 
)

Definition at line 20023 of file iron.py.

def iron.Field_ParameterSetAddElementDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber,
  value 
)
Adds the given double precision value to an element in the given parameter set for field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the value to the element in the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the value to the element in the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the value to the element in the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the value to the element. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number to add the value to.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to add the value to the element to in the field parameter set.
:type componentNumber: int
:param value: The value to add to the element in the field parameter set.
:type value: float
:rtype: None

Definition at line 13113 of file iron.py.

def iron.Field_ParameterSetAddElementIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber,
  value 
)
Adds the given integer value to an element in the given parameter set for field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the value to the element in the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the value to the element in the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the value to the element in the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the value to the element. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number to add the value to.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to add the value to the element to in the field parameter set.
:type componentNumber: int
:param value: The value to add to the element in the field parameter set.
:type value: int
:rtype: None

Definition at line 13136 of file iron.py.

def iron.Field_ParameterSetAddElementLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber,
  value 
)
Adds the given logical value to an element in the given parameter set for field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the value to the element in the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the value to the element in the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the value to the element in the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the value to the element. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number to add the value to.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to add the value to the element to in the field parameter set.
:type componentNumber: int
:param value: The value to add to the element in the field parameter set.
:type value: bool
:rtype: None

Definition at line 13159 of file iron.py.

def iron.Field_ParameterSetAddElementSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber,
  value 
)
Adds the given single precision value to an element in the given parameter set for field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the value to the element in the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the value to the element in the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the value to the element in the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the value to the element. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number to add the value to.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to add the value to the element to in the field parameter set.
:type componentNumber: int
:param value: The value to add to the element in the field parameter set.
:type value: float
:rtype: None

Definition at line 13182 of file iron.py.

def iron.Field_ParameterSetAddNode (   self,
  args 
)

Definition at line 20035 of file iron.py.

def iron.Field_ParameterSetAddNodeDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber,
  value 
)
Adds the given double precision value to an node in the given parameter set for field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the value to the node in the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the value to the node in the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the value to the node in the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the value to the node. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The node derivative version number of the node to add the value to.
:type versionNumber: int
:param derivativeNumber: The node derivative number of the node to add the value to.
:type derivativeNumber: int
:param userNodeNumber: The user node number to add the value to.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to add the value to the node to in the field parameter set.
:type componentNumber: int
:param value: The value to add to the node in the field parameter set.
:type value: float
:rtype: None

Definition at line 13205 of file iron.py.

def iron.Field_ParameterSetAddNodeIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber,
  value 
)
Adds the given integer value to an node in the given parameter set for field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the value to the node in the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the value to the node in the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the value to the node in the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the value to the node. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The node derivative version number of the node to add the value to.
:type versionNumber: int
:param derivativeNumber: The node derivative number of the node to add the value to.
:type derivativeNumber: int
:param userNodeNumber: The user node number to add the value to.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to add the value to the node to in the field parameter set.
:type componentNumber: int
:param value: The value to add to the node in the field parameter set.
:type value: int
:rtype: None

Definition at line 13232 of file iron.py.

def iron.Field_ParameterSetAddNodeLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber,
  value 
)
Adds the given logical value to an node in the given parameter set for field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the value to the node in the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the value to the node in the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the value to the node in the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the value to the node. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The node derivative version number of the node to add the value to.
:type versionNumber: int
:param derivativeNumber: The node derivative number of the node to add the value to.
:type derivativeNumber: int
:param userNodeNumber: The user node number to add the value to.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to add the value to the node to in the field parameter set.
:type componentNumber: int
:param value: The value to add to the node in the field parameter set.
:type value: bool
:rtype: None

Definition at line 13259 of file iron.py.

def iron.Field_ParameterSetAddNodeSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber,
  value 
)
Adds the given single precision value to an node in the given parameter set for field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to add the value to the node in the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to add the value to the node in the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to add the value to the node in the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to add the value to the node. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The node derivative version number of the node to add the value to.
:type versionNumber: int
:param derivativeNumber: The node derivative number of the node to add the value to.
:type derivativeNumber: int
:param userNodeNumber: The user node number to add the value to.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to add the value to the node to in the field parameter set.
:type componentNumber: int
:param value: The value to add to the node in the field parameter set.
:type value: float
:rtype: None

Definition at line 13286 of file iron.py.

def iron.Field_ParameterSetCreateNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType 
)
Creates a new parameter set of type set type for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to create the parameter set on.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to create the parameter set on.
:type fieldUserNumber: int
:param variableType: The variable type of the field to create the parameter set on. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to create. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:rtype: None

Definition at line 13313 of file iron.py.

def iron.Field_ParameterSetDataGet (   self,
  args 
)

Definition at line 19882 of file iron.py.

def iron.Field_ParameterSetDataGetDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType 
)
Returns a pointer to the specified field parameter set local double precision data array for a field identified by an user number. The pointer must be restored with a call to OpenCMISS::Iron::cmfe_Field_ParameterSetDataRestore call. Note: the values can be used for read operations but a field parameter set update or add calls must be used to change any values.

:param regionUserNumber: The user number of the region containing the field to get the parameter set data for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the parameter set data for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the parameter set data for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the parameter set data to get. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param parametersSize: Size of parameters to allocate.
:returns: parameters. A pointer to the parameter set data.
:rtype: Array of floats

Definition at line 13330 of file iron.py.

def iron.Field_ParameterSetDataGetIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType 
)
Returns a pointer to the specified field parameter set local integer data array for a field identified by an user number. The pointer must be restored with a call to OpenCMISS::Iron::cmfe_Field_ParameterSetDataRestore call. Note: the values can be used for read operations but a field parameter set update or add calls must be used to change any values.

:param regionUserNumber: The user number of the region containing the field to get the parameter set data for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the parameter set data for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the parameter set data for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the parameter set data to get. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param parametersSize: Size of parameters to allocate.
:returns: parameters. A pointer to the parameter set data.
:rtype: Array of ints

Definition at line 13349 of file iron.py.

def iron.Field_ParameterSetDataGetLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType 
)
Returns a pointer to the specified field parameter set local logical data array for a field identified by an user number. The pointer must be restored with a call to OpenCMISS::Iron::cmfe_Field_ParameterSetDataRestore call. Note: the values can be used for read operations but a field parameter set update or add calls must be used to change any values.

:param regionUserNumber: The user number of the region containing the field to get the parameter set data for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the parameter set data for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the parameter set data for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the parameter set data to get. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param parametersSize: Size of parameters to allocate.
:returns: parameters. A pointer to the parameter set data.
:rtype: Array of bools

Definition at line 13368 of file iron.py.

def iron.Field_ParameterSetDataGetSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType 
)
Returns a pointer to the specified field parameter set local single precision data array for a field identified by an user number. The pointer must be restored with a call to OpenCMISS::Iron::cmfe_Field_ParameterSetDataRestore call. Note: the values can be used for read operations but a field parameter set update or add calls must be used to change any values.

:param regionUserNumber: The user number of the region containing the field to get the parameter set data for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the parameter set data for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the parameter set data for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the parameter set data to get. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param parametersSize: Size of parameters to allocate.
:returns: parameters. A pointer to the parameter set data.
:rtype: Array of floats

Definition at line 13387 of file iron.py.

def iron.Field_ParameterSetDataRestore (   self,
  args 
)

Definition at line 19894 of file iron.py.

def iron.Field_ParameterSetDataRestoreDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  parameters 
)
Restores the specified field variable parameter set local double precision array that was obtained with an OpenCMISS::Iron::cmfe_Field_ParameterSetDataGet call for a field that is specified with an user number.

:param regionUserNumber: The user number of the region containing the field to restore the parameter set data for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to restore the parameter set data for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to restore the parameter set data for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the parameter set data to restore. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param parameters: A pointer to the parameter set data. On return this pointer is null.
:type parameters: Array of floats
:rtype: None

Definition at line 13406 of file iron.py.

def iron.Field_ParameterSetDataRestoreIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  parameters 
)
Restores the specified field variable parameter set local integer array that was obtained with an OpenCMISS::Iron::cmfe_Field_ParameterSetDataGet call for a field that is specified with an user number.

:param regionUserNumber: The user number of the region containing the field to restore the parameter set data for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to restore the parameter set data for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to restore the parameter set data for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the parameter set data to restore. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param parameters: A pointer to the parameter set data. On return this pointer is null.
:type parameters: Array of ints
:rtype: None

Definition at line 13425 of file iron.py.

def iron.Field_ParameterSetDataRestoreLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  parameters 
)
Restores the specified field variable parameter set local logical array that was obtained with an OpenCMISS::Iron::cmfe_Field_ParameterSetDataGet call for a field that is specified with an user number.

:param regionUserNumber: The user number of the region containing the field to restore the parameter set data for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to restore the parameter set data for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to restore the parameter set data for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the parameter set data to restore. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param parameters: A pointer to the parameter set data. On return this pointer is null.
:type parameters: Array of bools
:rtype: None

Definition at line 13444 of file iron.py.

def iron.Field_ParameterSetDataRestoreSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  parameters 
)
Restores the specified field variable parameter set local single precision array that was obtained with an OpenCMISS::Iron::cmfe_Field_ParameterSetDataGet call for a field that is specified with an user number.

:param regionUserNumber: The user number of the region containing the field to restore the parameter set data for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to restore the parameter set data for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to restore the parameter set data for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the parameter set data to restore. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param parameters: A pointer to the parameter set data. On return this pointer is null.
:type parameters: Array of floats
:rtype: None

Definition at line 13463 of file iron.py.

def iron.Field_ParameterSetDestroyNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType 
)
Destroys the specified parameter set type for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to destroy the parameter set for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to destroy the parameter set for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to destroy the parameter set for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to destroy. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:rtype: None

Definition at line 13482 of file iron.py.

def iron.Field_ParameterSetGetConstant (   self,
  args 
)

Definition at line 19918 of file iron.py.

def iron.Field_ParameterSetGetConstantDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber 
)
Returns from the given parameter set a double precision value for the specified constant of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the constant value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the constant value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the constant value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the constant value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to get the constant value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: float

Definition at line 13499 of file iron.py.

def iron.Field_ParameterSetGetConstantIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber 
)
Returns from the given parameter set an integer value for the specified constant of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the constant value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the constant value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the constant value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the constant value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to get the constant value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: int

Definition at line 13519 of file iron.py.

def iron.Field_ParameterSetGetConstantLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber 
)
Returns from the given parameter set a logical value for the specified constant of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the constant value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the constant value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the constant value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the constant value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to get the constant value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: bool

Definition at line 13539 of file iron.py.

def iron.Field_ParameterSetGetConstantSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber 
)
Returns from the given parameter set a single precision value for the specified constant of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the constant value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the constant value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the constant value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the constant value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to get the constant value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: float

Definition at line 13559 of file iron.py.

def iron.Field_ParameterSetGetDataPointDPNumberI (   parentRegionUserNumber,
  interfaceUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber 
)
Returns from the given parameter set a double precision value for the specified data point of a field variable component for a field identified by a user number.

:param parentRegionUserNumber: The user number of the parent region for the interface.
:type parentRegionUserNumber: int
:param interfaceUserNumber: The user number of the interface containing the field to get the data point value from the field parameter set.
:type interfaceUserNumber: int
:param fieldUserNumber: The user number of the field to get the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to get the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: float

Definition at line 13579 of file iron.py.

def iron.Field_ParameterSetGetDataPointDPNumberR (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber 
)
Returns from the given parameter set a double precision value for the specified data point of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the data point value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to get the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: float

Definition at line 13603 of file iron.py.

def iron.Field_ParameterSetGetDataPointIntgNumberI (   parentRegionUserNumber,
  interfaceUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber 
)
Returns from the given parameter set a integer value for the specified data point of a field variable component for a field identified by a user number.

:param parentRegionUserNumber: The user number of the parent region for the interface.
:type parentRegionUserNumber: int
:param interfaceUserNumber: The user number of the interface containing the field to get the data point value from the field parameter set.
:type interfaceUserNumber: int
:param fieldUserNumber: The user number of the field to get the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to get the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: int

Definition at line 13625 of file iron.py.

def iron.Field_ParameterSetGetDataPointIntgNumberR (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber 
)
Returns from the given parameter set a integer value for the specified data point of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the data point value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to get the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: int

Definition at line 13649 of file iron.py.

def iron.Field_ParameterSetGetDataPointLNumberI (   parentRegionUserNumber,
  interfaceUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber 
)
Returns from the given parameter set a logical value for the specified data point of a field variable component for a field identified by a user number.

:param parentRegionUserNumber: The user number of the parent region for the interface.
:type parentRegionUserNumber: int
:param interfaceUserNumber: The user number of the interface containing the field to get the data point value from the field parameter set.
:type interfaceUserNumber: int
:param fieldUserNumber: The user number of the field to get the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to get the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: bool

Definition at line 13671 of file iron.py.

def iron.Field_ParameterSetGetDataPointLNumberR (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber 
)
Returns from the given parameter set a logical value for the specified data point of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the data point value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to get the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: bool

Definition at line 13695 of file iron.py.

def iron.Field_ParameterSetGetDataPointSPNumberI (   parentRegionUserNumber,
  interfaceUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber 
)
Returns from the given parameter set a single precision value for the specified data point of a field variable component for a field identified by a user number.

:param parentRegionUserNumber: The user number of the parent region for the interface.
:type parentRegionUserNumber: int
:param interfaceUserNumber: The user number of the interface containing the field to get the data point value from the field parameter set.
:type interfaceUserNumber: int
:param fieldUserNumber: The user number of the field to get the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to get the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: float

Definition at line 13717 of file iron.py.

def iron.Field_ParameterSetGetDataPointSPNumberR (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber 
)
Returns from the given parameter set a single precision value for the specified data point of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the data point value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to get the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: float

Definition at line 13741 of file iron.py.

def iron.Field_ParameterSetGetElement (   self,
  args 
)

Definition at line 19930 of file iron.py.

def iron.Field_ParameterSetGetElementDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber 
)
Returns from the given parameter set a double precision value for the specified element of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the element value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the element value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the element value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the element value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number to get the value from the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to get the element value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: float

Definition at line 13763 of file iron.py.

def iron.Field_ParameterSetGetElementIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber 
)
Returns from the given parameter set an integer value for the specified element of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the element value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the element value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the element value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the element value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number to get the value from the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to get the element value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: int

Definition at line 13785 of file iron.py.

def iron.Field_ParameterSetGetElementLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber 
)
Returns from the given parameter set a logical value for the specified element of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the element value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the element value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the element value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the element value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number to get the value from the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to get the element value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: bool

Definition at line 13807 of file iron.py.

def iron.Field_ParameterSetGetElementSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber 
)
Returns from the given parameter set a single precision value for the specified element of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the element value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the element value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the element value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the element value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number to get the value from the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to get the element value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: float

Definition at line 13829 of file iron.py.

def iron.Field_ParameterSetGetGaussPoint (   self,
  args 
)

Definition at line 19942 of file iron.py.

def iron.Field_ParameterSetGetGaussPointCoord (   meshEmbedding,
  componentNumber,
  coordsSize 
)
:param meshEmbedding: The embedding
:type meshEmbedding: MeshEmbedding
:param componentNumber:
:type componentNumber: int
:param coordsSize: Size of coords to allocate.
:returns: (No description, Xi coordinates of embedded nodes wrt Child element)
:rtype: tuple. (int, Array of floats)

Definition at line 13851 of file iron.py.

def iron.Field_ParameterSetGetNode (   self,
  args 
)

Definition at line 19951 of file iron.py.

def iron.Field_ParameterSetGetNodeDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber 
)
Returns from the given parameter set a double precision value for the specified node and derivative of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the nodal value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the nodal value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the nodal value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the nodal value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The derivative version number to get the value from the field parameter set.
:type versionNumber: int
:param derivativeNumber: The derivative number to get the value from the field parameter set.
:type derivativeNumber: int
:param userNodeNumber: The user node number to get the value from the field parameter set.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to get the nodal value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: float

Definition at line 13864 of file iron.py.

def iron.Field_ParameterSetGetNodeIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber 
)
Returns from the given parameter set an integer value for the specified node and derivative of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the nodal value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the nodal value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the nodal value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the nodal value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The derivative version number to get the value from the field parameter set.
:type versionNumber: int
:param derivativeNumber: The derivative number to get the value from the field parameter set.
:type derivativeNumber: int
:param userNodeNumber: The user node number to get the value from the field parameter set.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to get the nodal value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: int

Definition at line 13890 of file iron.py.

def iron.Field_ParameterSetGetNodeLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber 
)
Returns from the given parameter set a logical value for the specified node and derivative of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the nodal value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the nodal value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the nodal value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the nodal value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The derivative version number to get the value from the field parameter set.
:type versionNumber: int
:param derivativeNumber: The derivative number to get the value from the field parameter set.
:type derivativeNumber: int
:param userNodeNumber: The user node number to get the value from the field parameter set.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to get the nodal value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: bool

Definition at line 13916 of file iron.py.

def iron.Field_ParameterSetGetNodeSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber 
)
Returns from the given parameter set a single precision value for the specified node and derivative of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the nodal value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the nodal value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the nodal value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to get the nodal value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The derivative version number to get the value from the field parameter set.
:type versionNumber: int
:param derivativeNumber: The derivative number to get the value from the field parameter set.
:type derivativeNumber: int
:param userNodeNumber: The user node number to get the value from the field parameter set.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to get the nodal value from the field parameter set.
:type componentNumber: int
:returns: value. The value from the field parameter set.
:rtype: float

Definition at line 13942 of file iron.py.

def iron.Field_ParameterSetInterpolateGauss (   self,
  args 
)

Definition at line 20047 of file iron.py.

def iron.Field_ParameterSetInterpolateMultipleGaussDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  derivativeNumber,
  userElementNumber,
  quadratureScheme,
  GaussPoints,
  valuesSizes 
)
Interpolates the given parameter set at a specified set of Gauss points for the specified element and derviative and returns double precision values for a or a field identified by a user number. If no Gauss points are specified then all Gauss points are interpolated.

:param regionUserNumber: The user number of the region containing the field whose parameter set is to be interpolated.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field whose parameter set is to be interpolated.
:type fieldUserNumber: int
:param variableType: The variable type of the field to interpolate. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to interpolate. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param derivativeNumber: The derivative number of the field to interpolate.
:type derivativeNumber: int
:param userElementNumber: The user element number of the field to interpolate.
:type userElementNumber: int
:param quadratureScheme: The quadrature scheme to interpolate the field for.
:type quadratureScheme: int
:param GaussPoints: The Gauss points to interpolate the field at.
:type GaussPoints: Array of ints
:param valuesSizes: Tuple of dimensions of values to allocate, with length 2.
:returns: values. The interpolated values.
:rtype: 2d array of floats

Definition at line 13968 of file iron.py.

def iron.Field_ParameterSetInterpolateMultipleXiDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  derivativeNumber,
  userElementNumber,
  xi,
  valuesSizes 
)
Interpolates the given parameter set at a specified set of xi locations for the specified element and derviative and returns double precision values for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field whose parameter set is to be interpolated.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field whose parameter set is to be interpolated.
:type fieldUserNumber: int
:param variableType: The variable type of the field to interpolate. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to interpolate. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param derivativeNumber: The derivative number of the field to interpolate.
:type derivativeNumber: int
:param userElementNumber: The user element number of the field to interpolate.
:type userElementNumber: int
:param xi: The sets of element xi to interpolate the field at.
:type xi: 2d array of floats
:param valuesSizes: Tuple of dimensions of values to allocate, with length 2.
:returns: values. The interpolated values.
:rtype: 2d array of floats

Definition at line 13995 of file iron.py.

def iron.Field_ParameterSetInterpolateSingleGaussDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  derivativeNumber,
  userElementNumber,
  quadratureScheme,
  GaussPoint,
  valuesSize 
)
Interpolates the given parameter set at a specified Gauss point for the specified element and derviative and returns double precision values for a or a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field whose parameter set is to be interpolated.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field whose parameter set is to be interpolated.
:type fieldUserNumber: int
:param variableType: The variable type of the field to interpolate. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to interpolate. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param derivativeNumber: The derivative number of the field to interpolate.
:type derivativeNumber: int
:param userElementNumber: The user element number of the field to interpolate.
:type userElementNumber: int
:param quadratureScheme: The quadrature scheme to interpolate the field for.
:type quadratureScheme: int
:param GaussPoint: The Gauss point to interpolate the field at.
:type GaussPoint: int
:param valuesSize: Size of values to allocate.
:returns: values. The interpolated values.
:rtype: Array of floats

Definition at line 14020 of file iron.py.

def iron.Field_ParameterSetInterpolateSingleXiDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  derivativeNumber,
  userElementNumber,
  xi,
  valuesSize 
)
Interpolates the given parameter set at a specified xi location for the specified element and derviative and returns double precision values for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field whose parameter set is to be interpolated.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field whose parameter set is to be interpolated.
:type fieldUserNumber: int
:param variableType: The variable type of the field to interpolate. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to interpolate. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param derivativeNumber: The derivative number of the field to interpolate.
:type derivativeNumber: 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 valuesSize: Size of values to allocate.
:returns: values. The interpolated values.
:rtype: Array of floats

Definition at line 14047 of file iron.py.

def iron.Field_ParameterSetNodeNumberOfScaleFactorDofsGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  meshComponentNumber 
)
Gets the number of scale factor dofs, identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the number of scalefactors for
:type regionUserNumber: int
:param fieldUserNumber: The field to get the number of scale factor dofs for
:type fieldUserNumber: int
:param variableType: The field variable type to get the number of scale factor dofs for
:type variableType: int
:param meshComponentNumber: The mesh component number of the field to get the number of scale factor dofs for
:type meshComponentNumber: int
:returns: numberOfScaleFactorsDofs. The number of scale factor dofs
:rtype: int

Definition at line 14072 of file iron.py.

def iron.Field_ParameterSetNodeScaleFactorGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  versionNumber,
  derivativeNumber,
  nodeUserNumber,
  componentNumber 
)
Gets the scale factor for a particular node identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the scalefactor for
:type regionUserNumber: int
:param fieldUserNumber: The field to get scale factor for
:type fieldUserNumber: int
:param variableType: The field variable type to get the scale factor for
:type variableType: int
:param versionNumber: The user number of the node derivative version to get the scale factor for
:type versionNumber: int
:param derivativeNumber: The user number of the node derivative to get the scale factor for
:type derivativeNumber: int
:param nodeUserNumber: The user number of the node to get the scale factor for
:type nodeUserNumber: int
:param componentNumber: The component number of the field to get the scale factor for
:type componentNumber: int
:returns: scaleFactor. The scale factor of the specified node
:rtype: float

Definition at line 14090 of file iron.py.

def iron.Field_ParameterSetNodeScaleFactorSetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  versionNumber,
  derivativeNumber,
  nodeUserNumber,
  componentNumber,
  scaleFactor 
)
Sets the scale factor for a particular node identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the scalefactor for
:type regionUserNumber: int
:param fieldUserNumber: The field to set scale factor for
:type fieldUserNumber: int
:param variableType: The field variable type to set the scale factor for
:type variableType: int
:param versionNumber: The user number of the node derivative version to set the scale factor for
:type versionNumber: int
:param derivativeNumber: The user number of the node derivative to set the scale factor for
:type derivativeNumber: int
:param nodeUserNumber: The user number of the node to set the scale factor for
:type nodeUserNumber: int
:param componentNumber: The component number of the field to set the scale factor for
:type componentNumber: int
:param scaleFactor: The scale factor of the specified node
:type scaleFactor: float
:rtype: None

Definition at line 14114 of file iron.py.

def iron.Field_ParameterSetNodeScaleFactorsGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  meshComponentNumber,
  scaleFactorsSize 
)
Gets the scale factors for all nodes identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the scalefactor for
:type regionUserNumber: int
:param fieldUserNumber: The field to get scale factor for
:type fieldUserNumber: int
:param variableType: The field variable type to get the scale factor for
:type variableType: int
:param meshComponentNumber: The mesh omponent number of the field to set the scale factor for
:type meshComponentNumber: int
:param scaleFactorsSize: Size of scaleFactors to allocate.
:returns: scaleFactors. The scale factors
:rtype: Array of floats

Definition at line 14139 of file iron.py.

def iron.Field_ParameterSetNodeScaleFactorsSetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  meshComponentNumber,
  scaleFactors 
)
Sets the scale factors for all nodes identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the scalefactor for
:type regionUserNumber: int
:param fieldUserNumber: The field to set scale factor for
:type fieldUserNumber: int
:param variableType: The field variable type to set the scale factor for
:type variableType: int
:param meshComponentNumber: The mesh omponent number of the field to set the scale factor for
:type meshComponentNumber: int
:param scaleFactors: The scale factors
:type scaleFactors: Array of floats
:rtype: None

Definition at line 14158 of file iron.py.

def iron.Field_ParameterSetUpdateConstant (   self,
  args 
)

Definition at line 19963 of file iron.py.

def iron.Field_ParameterSetUpdateConstantDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Updates the given parameter set with the given double precision value for the constant of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the constant value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the constant value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the constant value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: float
:rtype: None

Definition at line 14177 of file iron.py.

def iron.Field_ParameterSetUpdateConstantIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Updates the given parameter set with the given integer value for the constant of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the constant value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the constant value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the constant value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: int
:rtype: None

Definition at line 14198 of file iron.py.

def iron.Field_ParameterSetUpdateConstantLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Updates the given parameter set with the given logical value for the constant of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the constant value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the constant value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the constant value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: bool
:rtype: None

Definition at line 14219 of file iron.py.

def iron.Field_ParameterSetUpdateConstantSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  componentNumber,
  value 
)
Updates the given parameter set with the given single precision value for the constant of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the constant value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the constant value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the constant value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: float
:rtype: None

Definition at line 14240 of file iron.py.

def iron.Field_ParameterSetUpdateDataPointDPNumberI (   parentRegionUserNumber,
  interfaceUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber,
  value 
)
Update the given parameter set a double precision value for the specified data point of a field variable component for a field identified by a user number.

:param parentRegionUserNumber: The user number of the parent region for the interface.
:type parentRegionUserNumber: int
:param interfaceUserNumber: The user number of the interface containing the field to update the data point value from the field parameter set.
:type interfaceUserNumber: int
:param fieldUserNumber: The user number of the field to update the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to update the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update
:type value: float
:rtype: None

Definition at line 14261 of file iron.py.

def iron.Field_ParameterSetUpdateDataPointDPNumberR (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber,
  value 
)
Update the given parameter set a double precision value for the specified data point of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the data point value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to update the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update
:type value: float
:rtype: None

Definition at line 14286 of file iron.py.

def iron.Field_ParameterSetUpdateDataPointIntgNumberI (   parentRegionUserNumber,
  interfaceUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber,
  value 
)
Update the given parameter set a integer value for the specified data point of a field variable component for a field identified by a user number.

:param parentRegionUserNumber: The user number of the parent region for the interface.
:type parentRegionUserNumber: int
:param interfaceUserNumber: The user number of the interface containing the field to update the data point value from the field parameter set.
:type interfaceUserNumber: int
:param fieldUserNumber: The user number of the field to update the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to update the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update
:type value: int
:rtype: None

Definition at line 14309 of file iron.py.

def iron.Field_ParameterSetUpdateDataPointIntgNumberR (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber,
  value 
)
Update the given parameter set a integer value for the specified data point of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the data point value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to update the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update
:type value: int
:rtype: None

Definition at line 14334 of file iron.py.

def iron.Field_ParameterSetUpdateDataPointLNumberI (   parentRegionUserNumber,
  interfaceUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber,
  value 
)
Update the given parameter set a logical value for the specified data point of a field variable component for a field identified by a user number.

:param parentRegionUserNumber: The user number of the parent region for the interface.
:type parentRegionUserNumber: int
:param interfaceUserNumber: The user number of the interface containing the field to update the data point value from the field parameter set.
:type interfaceUserNumber: int
:param fieldUserNumber: The user number of the field to update the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to update the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update
:type value: bool
:rtype: None

Definition at line 14357 of file iron.py.

def iron.Field_ParameterSetUpdateDataPointLNumberR (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber,
  value 
)
Update the given parameter set a logical value for the specified data point of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the data point value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to update the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update
:type value: bool
:rtype: None

Definition at line 14382 of file iron.py.

def iron.Field_ParameterSetUpdateDataPointSPNumberI (   parentRegionUserNumber,
  interfaceUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber,
  value 
)
Update the given parameter set a single precision value for the specified data point of a field variable component for a field identified by a user number.

:param parentRegionUserNumber: The user number of the parent region for the interface.
:type parentRegionUserNumber: int
:param interfaceUserNumber: The user number of the interface containing the field to update the data point value from the field parameter set.
:type interfaceUserNumber: int
:param fieldUserNumber: The user number of the field to update the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to update the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update
:type value: float
:rtype: None

Definition at line 14405 of file iron.py.

def iron.Field_ParameterSetUpdateDataPointSPNumberR (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userDataPointNumber,
  componentNumber,
  value 
)
Update the given parameter set a single precision value for the specified data point of a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the data point value from the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the data point value from the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the data point value from the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userDataPointNumber: The user data point number to update the value for
:type userDataPointNumber: int
:param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update
:type value: float
:rtype: None

Definition at line 14430 of file iron.py.

def iron.Field_ParameterSetUpdateElement (   self,
  args 
)

Definition at line 19975 of file iron.py.

def iron.Field_ParameterSetUpdateElementDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given double precision value for the element of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the element value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the element value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the element value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the element value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number of the field variable component to update for the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to update the element value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: float
:rtype: None

Definition at line 14453 of file iron.py.

def iron.Field_ParameterSetUpdateElementIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given integer value for the element of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the element value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the element value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the element value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the element value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number of the field variable component to update for the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to update the element value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: int
:rtype: None

Definition at line 14476 of file iron.py.

def iron.Field_ParameterSetUpdateElementLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given logical value for the element of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the element value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the element value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the element value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the element value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number of the field variable component to update for the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to update the element value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: bool
:rtype: None

Definition at line 14499 of file iron.py.

def iron.Field_ParameterSetUpdateElementSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  userElementNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given single precision value for the element of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the element value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the element value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the element value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the element value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param userElementNumber: The user element number of the field variable component to update for the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to update the element value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: float
:rtype: None

Definition at line 14522 of file iron.py.

def iron.Field_ParameterSetUpdateFinishNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType 
)
Finishes the parameter set update for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to finish the parameter set update for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to finish the parameter set update for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to finish the parameter set update for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type to finish the update for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:rtype: None

Definition at line 14545 of file iron.py.

def iron.Field_ParameterSetUpdateGaussPoint (   self,
  args 
)

Definition at line 19987 of file iron.py.

def iron.Field_ParameterSetUpdateGaussPointDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  gaussPointNumber,
  userElementNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given double precision value for the element Gauss point of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the Gauss point value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the Gauss point value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the Gauss point value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the Gauss point value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param gaussPointNumber: The user element number of the field variable component to update for the field parameter set.
:type gaussPointNumber: int
:param userElementNumber: The user element number of the field variable component to update for the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to update the Gauss point value for the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update.
:type value: float
:rtype: None

Definition at line 14562 of file iron.py.

def iron.Field_ParameterSetUpdateGaussPointIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  gaussPointNumber,
  userElementNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given integer value for the element Gauss point of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the Gauss point value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the Gauss point value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the Gauss point value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the Gauss point value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param gaussPointNumber: The user element number of the field variable component to update for the field parameter set.
:type gaussPointNumber: int
:param userElementNumber: The user element number of the field variable component to update for the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to update the Gauss point value for the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update.
:type value: int
:rtype: None

Definition at line 14587 of file iron.py.

def iron.Field_ParameterSetUpdateGaussPointLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  gaussPointNumber,
  userElementNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given logical value for the element Gauss point of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the Gauss point value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the Gauss point value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the Gauss point value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the Gauss point value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param gaussPointNumber: The user element number of the field variable component to update for the field parameter set.
:type gaussPointNumber: int
:param userElementNumber: The user element number of the field variable component to update for the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to update the Gauss point value for the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update.
:type value: bool
:rtype: None

Definition at line 14612 of file iron.py.

def iron.Field_ParameterSetUpdateGaussPointSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  gaussPointNumber,
  userElementNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given single precision value for the element Gauss point of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the Gauss point value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the Gauss point value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the Gauss point value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the Gauss point value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param gaussPointNumber: The user element number of the field variable component to update for the field parameter set.
:type gaussPointNumber: int
:param userElementNumber: The user element number of the field variable component to update for the field parameter set.
:type userElementNumber: int
:param componentNumber: The component number of the field variable to update the Gauss point value for the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update.
:type value: float
:rtype: None

Definition at line 14637 of file iron.py.

def iron.Field_ParameterSetUpdateNode (   self,
  args 
)

Definition at line 19999 of file iron.py.

def iron.Field_ParameterSetUpdateNodeDPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given double precision value for the node and derivative of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the nodal value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the nodal value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the nodal value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the nodal value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The derivative version number of the field variable component to update for the field parameter set.
:type versionNumber: int
:param derivativeNumber: The derivative number of the field variable component to update for the field parameter set.
:type derivativeNumber: int
:param userNodeNumber: The user node number of the field variable component to update for the field parameter set.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to update the nodal value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: float
:rtype: None

Definition at line 14662 of file iron.py.

def iron.Field_ParameterSetUpdateNodeIntgNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given integer value for the node and derivative of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the nodal value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the nodal value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the nodal value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the nodal value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The derivative version number of the field variable component to update for the field parameter set.
:type versionNumber: int
:param derivativeNumber: The derivative number of the field variable component to update for the field parameter set.
:type derivativeNumber: int
:param userNodeNumber: The user node number of the field variable component to update for the field parameter set.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to update the nodal value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: int
:rtype: None

Definition at line 14689 of file iron.py.

def iron.Field_ParameterSetUpdateNodeLNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given logical value for the node and derivative of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the nodal value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the nodal value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the nodal value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the nodal value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The derivative version number of the field variable component to update for the field parameter set.
:type versionNumber: int
:param derivativeNumber: The derivative number of the field variable component to update for the field parameter set.
:type derivativeNumber: int
:param userNodeNumber: The user node number of the field variable component to update for the field parameter set.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to update the nodal value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: bool
:rtype: None

Definition at line 14716 of file iron.py.

def iron.Field_ParameterSetUpdateNodeSPNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType,
  versionNumber,
  derivativeNumber,
  userNodeNumber,
  componentNumber,
  value 
)
Updates the given parameter set with the given single precision value for the node and derivative of the field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to update the nodal value for the field parameter set.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to update the nodal value for the field parameter set.
:type fieldUserNumber: int
:param variableType: The variable type of the field to update the nodal value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the nodal value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param versionNumber: The derivative version number of the field variable component to update for the field parameter set.
:type versionNumber: int
:param derivativeNumber: The derivative number of the field variable component to update for the field parameter set.
:type derivativeNumber: int
:param userNodeNumber: The user node number of the field variable component to update for the field parameter set.
:type userNodeNumber: int
:param componentNumber: The component number of the field variable to update the nodal value for the field parameter set.
:type componentNumber: int
:param value: The value to update the field parameter set to.
:type value: float
:rtype: None

Definition at line 14743 of file iron.py.

def iron.Field_ParameterSetUpdateStartNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  fieldSetType 
)
Starts the parameter set update for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to start the parameter set update for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to start the parameter set update for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to start the parameter set update for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type to start the update for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:rtype: None

Definition at line 14770 of file iron.py.

def iron.Field_ParametersToFieldParametersComponentCopyNum (   fromRegionUserNumber,
  fromFieldUserNumber,
  fromVariableType,
  fromParameterSetType,
  fromComponentNumber,
  toRegionUserNumber,
  toFieldUserNumber,
  toVariableType,
  toParameterSetType,
  toComponentNumber 
)
Copy the parameters from the parameter set of a component of a field variable to the paramters of a parameter set of
a component of another field variable, where both fields are identified by user numbers.

:param fromRegionUserNumber: The user number of the region containing the field to copy from
:type fromRegionUserNumber: int
:param fromFieldUserNumber: The field to copy from
:type fromFieldUserNumber: int
:param fromVariableType: The field variable type to copy from
:type fromVariableType: int
:param fromParameterSetType: The field parameter set type to copy from
:type fromParameterSetType: int
:param fromComponentNumber: The field variable component number to copy from
:type fromComponentNumber: int
:param toRegionUserNumber: The user number of the region containing the field to copy to
:type toRegionUserNumber: int
:param toFieldUserNumber: The field to copy to
:type toFieldUserNumber: int
:param toVariableType: The field variable type to copy to
:type toVariableType: int
:param toParameterSetType: The parameter set type to copy to
:type toParameterSetType: int
:param toComponentNumber: The field variable component to copy to
:type toComponentNumber: int
:rtype: None

Definition at line 14787 of file iron.py.

def iron.Field_PositionNormalTangentCalculateNodeNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  componentNumber,
  localNodeNumber,
  positionSize,
  normalSize,
  tangentsSizes 
)
Returns the interpolation type for a field variable component for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the interpolation type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the interpolation type for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the interpolation type for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param componentNumber: The component number of the field variable to get the interpolation type for.
:type componentNumber: int
:param localNodeNumber: The local node number of the field variable to get the data type for.
:type localNodeNumber: int
:param positionSize: Size of position to allocate.
:param normalSize: Size of normal to allocate.
:param tangentsSizes: Tuple of dimensions of tangents to allocate, with length 2.
:returns: (Actual useful outputs, Actual useful outputs, Actual useful outputs)
:rtype: tuple. (Array of floats, Array of floats, 2d array of floats)

Definition at line 14817 of file iron.py.

def iron.Field_ScalingTypeGetNum (   regionUserNumber,
  fieldUserNumber 
)
Returns the scaling type for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the scaling type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the scaling type for.
:type fieldUserNumber: int
:returns: scalingType. The field scaling type. Will be a value from the FieldScalingTypes enum.
:rtype: int

Definition at line 14840 of file iron.py.

def iron.Field_ScalingTypeSetNum (   regionUserNumber,
  fieldUserNumber,
  scalingType 
)
Sets/changes the scaling type for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the scaling type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the scaling type for.
:type fieldUserNumber: int
:param scalingType: The field scaling type to set. Must be a value from the FieldScalingTypes enum.
:type scalingType: int
:rtype: None

Definition at line 14854 of file iron.py.

def iron.Field_TypeGetNum (   regionUserNumber,
  fieldUserNumber 
)
Returns the field type for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the field type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the field type for.
:type fieldUserNumber: int
:returns: fieldType. The field type. Will be a value from the FieldTypes enum.
:rtype: int

Definition at line 14869 of file iron.py.

def iron.Field_TypeSetNum (   regionUserNumber,
  fieldUserNumber,
  fieldType 
)
Sets/changes the field type for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the field type for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the field type for.
:type fieldUserNumber: int
:param fieldType: The field type to set. Must be a value from the FieldTypes enum.
:type fieldType: int
:rtype: None

Definition at line 14883 of file iron.py.

def iron.Field_VariableLabelGetNum (   regionUserNumber,
  fieldUserNumber,
  variableType 
)
Returns the character string label for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the label for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the label for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to get the field variable label. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:returns: label. The field variable label.
:rtype: string

Definition at line 14898 of file iron.py.

def iron.Field_VariableLabelSetNum (   regionUserNumber,
  fieldUserNumber,
  variableType,
  label 
)
Sets/changes the character string label for a field variable for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the label for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the label for.
:type fieldUserNumber: int
:param variableType: The variable type of the field to set the field variable label. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param label: The field variable label to set.
:type label: string
:rtype: None

Definition at line 14914 of file iron.py.

def iron.Field_VariableTypesGetNum (   regionUserNumber,
  fieldUserNumber,
  variableTypesSize 
)
Returns the field variable types for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to get the field variable types for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to get the field variable types for.
:type fieldUserNumber: int
:param variableTypesSize: Size of variableTypes to allocate.
:returns: variableTypes. variableTypes(variable_idx). On return, the field variable types for the variable_idx'th field variable. Will be a value from the FieldVariableTypes enum.
:rtype: Array of ints

Definition at line 14931 of file iron.py.

def iron.Field_VariableTypesSetNum (   regionUserNumber,
  fieldUserNumber,
  variableTypes 
)
Sets/changes the field variable types for a field identified by a user number.

:param regionUserNumber: The user number of the region containing the field to set the field variable types for.
:type regionUserNumber: int
:param fieldUserNumber: The user number of the field to set the field variable types for.
:type fieldUserNumber: int
:param variableTypes: variableTypes(variable_idx). The field variable types for the variable_idx'th field variable to set. Must be a value from the FieldVariableTypes enum.
:type variableTypes: Array of ints
:rtype: None

Definition at line 14946 of file iron.py.

def iron.Finalise ( )
Finalises CMISS.

:rtype: None

Definition at line 14961 of file iron.py.

def iron.GeneratedMesh_BaseVectorsSetNum (   regionUserNumber,
  generatedMeshUserNumber,
  baseVectors 
)
Sets/changes the base vectors for a generated mesh on a region identified by a user number.

:param regionUserNumber: The user number of the region containing the generated mesh to set the base vectors for.
:type regionUserNumber: int
:param generatedMeshUserNumber: The user number of the generated mesh to set the base vectors for.
:type generatedMeshUserNumber: int
:param baseVectors: baseVectors(coordinate_idx,xi_idx). The base vectors to set.
:type baseVectors: 2d array of floats
:rtype: None

Definition at line 14970 of file iron.py.

def iron.GeneratedMesh_BasisGetNum (   regionUserNumber,
  generatedMeshUserNumber,
  basisUserNumbers 
)
Returns the basis for a generated mesh on a region identified by a user number.

:param regionUserNumber: The user number of the region containing the generated mesh to get the basis for.
:type regionUserNumber: int
:param generatedMeshUserNumber: The user number of the generated mesh to get the basis for.
:type generatedMeshUserNumber: int
:param basisUserNumbers: On return, the user numbers of the bases.
:type basisUserNumbers: Array of ints
:rtype: None

Definition at line 14985 of file iron.py.

def iron.GeneratedMesh_BasisSetNum (   regionUserNumber,
  generatedMeshUserNumber,
  basisUserNumbers 
)
Sets/changes the basis for a generated mesh on a region identified by a user number.

:param regionUserNumber: The user number of the region containing the generated mesh to set the basis for.
:type regionUserNumber: int
:param generatedMeshUserNumber: The user number of the generated mesh to set the basis for.
:type generatedMeshUserNumber: int
:param basisUserNumbers: The user numbers of the bases to set.
:type basisUserNumbers: Array of ints
:rtype: None

Definition at line 15000 of file iron.py.

def iron.GeneratedMesh_CreateFinishNum (   regionUserNumber,
  generatedMeshUserNumber,
  meshUserNumber 
)
Finishes the creation of a generated mesh on a region identified by a user number.

:param regionUserNumber: The user number of the region containing the generated mesh to finish the creation of.
:type regionUserNumber: int
:param generatedMeshUserNumber: The user number of the generated mesh to finish the creation of.
:type generatedMeshUserNumber: int
:param meshUserNumber: The user number of the mesh to generate.
:type meshUserNumber: int
:rtype: None

Definition at line 15015 of file iron.py.

def iron.GeneratedMesh_CreateStartNum (   generatedMeshUserNumber,
  regionUserNumber 
)
Starts the creation of a generated mesh on a region identified by a user number.

:param generatedMeshUserNumber: The user number of the generated mesh to create.
:type generatedMeshUserNumber: int
:param regionUserNumber: The user number of the region to create the generated mesh in.
:type regionUserNumber: int
:rtype: None

Definition at line 15030 of file iron.py.

def iron.GeneratedMesh_DestroyNum (   regionUserNumber,
  generatedMeshUserNumber 
)
Destroys a generated mesh on a region identified by a user number.

:param regionUserNumber: The user number of the region containing the generated mesh to destroy.
:type regionUserNumber: int
:param generatedMeshUserNumber: The user number of the generated mesh to destroy.
:type generatedMeshUserNumber: int
:rtype: None

Definition at line 15043 of file iron.py.

def iron.GeneratedMesh_ExtentGetNum (   regionUserNumber,
  generatedMeshUserNumber,
  extentSize 
)
Returns the extent for a generated mesh on a region identified by a user number.

:param regionUserNumber: The user number of the region containing the generated mesh to get the extent for.
:type regionUserNumber: int
:param generatedMeshUserNumber: The user number of the generated mesh to get the extent for.
:type generatedMeshUserNumber: int
:param extentSize: Size of extent to allocate.
:returns: extent. extent(i). On return, the extent for the i'th dimension of the generated mesh.
:rtype: Array of floats

Definition at line 15056 of file iron.py.

def iron.GeneratedMesh_ExtentSetNum (   regionUserNumber,