|
OpenCMISS-Iron Python Bindings API Documentation
|
|
OpenCMISS-Iron Python Bindings API Documentation
|
Public Member Functions | |
| def | __init__ (self) |
| def | Finalise (self) |
| def | GetSession (self) |
| def | InputBasisCreateStartNum (self, evaluatorName, userNumber) |
| def | InputBasisCreateStart (self, evaluatorName, userNumber, basis) |
| def | InputCoordinateSystemCreateStartNum (self, evaluatorName, userNumber) |
| def | InputCoordinateSystemCreateStart (self, evaluatorName, coordinateSystem, userNumber) |
| def | InputCreateFromFile (self, filename) |
| def | InputCreateMeshComponentNum (self, regionNumber, meshNumber, componentNumber, evaluatorName) |
| def | InputCreateMeshComponent (self, mesh, componentNumber, evaluatorName) |
| def | InputFieldCreateStartNum (self, regionNumber, meshNumber, decompositionNumber, fieldNumber, variableType, evaluatorName) |
| def | InputFieldCreateStart (self, region, decomposition, fieldNumber, field, variableType, evaluatorName) |
| def | InputFieldParametersUpdateNum (self, regionNumber, fieldNumber, evaluatorName, variableType, setType) |
| def | InputFieldParametersUpdate (self, field, evaluatorName, variableType, setType) |
| def | InputMeshCreateStartNum (self, meshArgumentName, meshNumber, regionNumber) |
| def | InputMeshCreateStart (self, meshArgumentName, mesh, meshNumber, region) |
| def | InputNodesCreateStartNum (self, nodesArgumentName, regionNumber, nodes) |
| def | InputNodesCreateStart (self, nodesArgumentName, region, nodes) |
| def | OutputAddFieldComponentsNum (self, typeHandle, baseName, dofFormat, regionNumber, fieldNumber, fieldComponentNumbers, variableType, setType) |
| def | OutputAddFieldComponents (self, typeHandle, baseName, dofFormat, field, fieldComponentNumbers, variableType, setType) |
| def | OutputAddFieldNoTypeNum (self, baseName, dofFormat, regionNumber, fieldNumber, variableType, setType) |
| def | OutputAddFieldNoType (self, baseName, dofFormat, field, variableType, setType) |
| def | OutputAddFieldWithTypeNum (self, baseName, dofFormat, regionNumber, fieldNumber, variableType, setType, typeHandle) |
| def | OutputAddFieldWithType (self, baseName, dofFormat, field, variableType, setType, typeHandle) |
| def | OutputAddImport (self, name) |
| def | OutputCreateNum (self, regionNumber, meshNumber, location, baseName, connectivityFormat) |
| def | OutputCreate (self, mesh, location, baseName, connectivityFormat) |
| def | OutputWrite (self, filename) |
Public Attributes | |
| cmiss_type | |
Provides input and output of fields through the FieldML API
| def iron.FieldMLIO.__init__ | ( | self | ) |
| def iron.FieldMLIO.Finalise | ( | self | ) |
| def iron.FieldMLIO.GetSession | ( | self | ) |
| def iron.FieldMLIO.InputBasisCreateStart | ( | self, | |
| evaluatorName, | |||
| userNumber, | |||
| basis | |||
| ) |
Create a basis using the given FieldML evaluator. :param evaluatorName: The name of the argument evaluator to create the basis from. :type evaluatorName: string :param userNumber: The user number to assign to the new basis. :type userNumber: int :param basis: On return, the newly created basis. :type basis: Basis :rtype: None
| def iron.FieldMLIO.InputBasisCreateStartNum | ( | self, | |
| evaluatorName, | |||
| userNumber | |||
| ) |
| def iron.FieldMLIO.InputCoordinateSystemCreateStart | ( | self, | |
| evaluatorName, | |||
| coordinateSystem, | |||
| userNumber | |||
| ) |
Create a coordinate system using the given FieldML evaluator. :param evaluatorName: The name of the argument evaluator to create the coordinate system from. :type evaluatorName: string :param coordinateSystem: On return, the newly created coordinate system. :type coordinateSystem: CoordinateSystem :param userNumber: The user number to assign to the new coordinate system. :type userNumber: int :rtype: None
| def iron.FieldMLIO.InputCoordinateSystemCreateStartNum | ( | self, | |
| evaluatorName, | |||
| userNumber | |||
| ) |
Create a coordinate system using the given FieldML evaluator. :param evaluatorName: The name of the argument evaluator to create the coordinate system from. :type evaluatorName: string :param userNumber: The user number to assign to the new coordinate system. :type userNumber: int :rtype: None
| def iron.FieldMLIO.InputCreateFromFile | ( | self, | |
| filename | |||
| ) |
| def iron.FieldMLIO.InputCreateMeshComponent | ( | self, | |
| mesh, | |||
| componentNumber, | |||
| evaluatorName | |||
| ) |
Use the given FieldML evaluator as a template to create a component on the given mesh. :param mesh: The mesh for which to create the mesh component. :type mesh: Mesh :param componentNumber: The number of the mesh component to create. :type componentNumber: int :param evaluatorName: The name of the argument evaluator to create the mesh from. :type evaluatorName: string :rtype: None
| def iron.FieldMLIO.InputCreateMeshComponentNum | ( | self, | |
| regionNumber, | |||
| meshNumber, | |||
| componentNumber, | |||
| evaluatorName | |||
| ) |
Use the given FieldML evaluator as a template to create a component on the mesh identified by the given user number. :param regionNumber: The user number of the region in which the mesh component is to be created. :type regionNumber: int :param meshNumber: The user number of the mesh for which the mesh component is to be created. :type meshNumber: int :param componentNumber: The number of the mesh component to create. :type componentNumber: int :param evaluatorName: The name of the argument evaluator to create the basis from. :type evaluatorName: string :rtype: None
| def iron.FieldMLIO.InputFieldCreateStart | ( | self, | |
| region, | |||
| decomposition, | |||
| fieldNumber, | |||
| field, | |||
| variableType, | |||
| evaluatorName | |||
| ) |
Create a field using the given FieldML evaluator. :param region: The region in which the field is to be created. :type region: Region :param decomposition: The decomposition to use when creating the field. :type decomposition: Decomposition :param fieldNumber: The user number to assign to the new field. :type fieldNumber: int :param field: On return, the newly created field. :type field: Field :param variableType: The OpenCMISS variable type. :type variableType: int :param evaluatorName: The name of the argument evaluator to create the field from. :type evaluatorName: string :rtype: None
| def iron.FieldMLIO.InputFieldCreateStartNum | ( | self, | |
| regionNumber, | |||
| meshNumber, | |||
| decompositionNumber, | |||
| fieldNumber, | |||
| variableType, | |||
| evaluatorName | |||
| ) |
Create a field with the given user number using the given FieldML evaluator. :param regionNumber: The user number of the region in which to create the field. :type regionNumber: int :param meshNumber: The user number of the mesh to use when creating the field. :type meshNumber: int :param decompositionNumber: The user number of the decomposition to use when creating the field. :type decompositionNumber: int :param fieldNumber: The user number to assign to the new field. :type fieldNumber: int :param variableType: The OpenCMISS variable type. :type variableType: int :param evaluatorName: The name of the argument evaluator to create the field from. :type evaluatorName: string :rtype: None
| def iron.FieldMLIO.InputFieldParametersUpdate | ( | self, | |
| field, | |||
| evaluatorName, | |||
| variableType, | |||
| setType | |||
| ) |
Update the DOF parameters of the given field, using the given FieldML evaluator. :param field: On return, the field object. :type field: Field :param evaluatorName: The name of the argument evaluator to get the parameters from. :type evaluatorName: string :param variableType: The OpenCMISS variable type. :type variableType: int :param setType: The parameter set type. :type setType: int :rtype: None
| def iron.FieldMLIO.InputFieldParametersUpdateNum | ( | self, | |
| regionNumber, | |||
| fieldNumber, | |||
| evaluatorName, | |||
| variableType, | |||
| setType | |||
| ) |
Update the DOF parameters of field with the given user number, using the given FieldML evaluator. :param regionNumber: The user number of the region of the field for which parameters are to be updated. :type regionNumber: int :param fieldNumber: The user number of the field for which parameters are to be updated. :type fieldNumber: int :param evaluatorName: The name of the argument evaluator to get the parameters from. :type evaluatorName: string :param variableType: The OpenCMISS variable type. :type variableType: int :param setType: The parameter set type. :type setType: int :rtype: None
| def iron.FieldMLIO.InputMeshCreateStart | ( | self, | |
| meshArgumentName, | |||
| mesh, | |||
| meshNumber, | |||
| region | |||
| ) |
Creates a mesh using the given FieldML evaluator. :param meshArgumentName: The name of the argument evaluator to create a mesh from. :type meshArgumentName: string :param mesh: On return, the newly created mesh. :type mesh: Mesh :param meshNumber: The user number to assign to the new mesh. :type meshNumber: int :param region: The region in which to create the mesh. :type region: Region :rtype: None
| def iron.FieldMLIO.InputMeshCreateStartNum | ( | self, | |
| meshArgumentName, | |||
| meshNumber, | |||
| regionNumber | |||
| ) |
Creates a mesh with the given user number using the given FieldML evaluator. :param meshArgumentName: The name of the mesh argument evaluator to create a mesh from. :type meshArgumentName: string :param meshNumber: The user number to assign to the new mesh. :type meshNumber: int :param regionNumber: The user number of the region in which to create the mesh. :type regionNumber: int :rtype: None
| def iron.FieldMLIO.InputNodesCreateStart | ( | self, | |
| nodesArgumentName, | |||
| region, | |||
| nodes | |||
| ) |
Creates a region's nodes using the given FieldML evaluator. :param nodesArgumentName: The name of the argument evaluator to create the basis from. :type nodesArgumentName: string :param region: The user number of the region to create to the nodes in. :type region: Region :param nodes: On return, the newly created nodes. :type nodes: Nodes :rtype: None
| def iron.FieldMLIO.InputNodesCreateStartNum | ( | self, | |
| nodesArgumentName, | |||
| regionNumber, | |||
| nodes | |||
| ) |
Creates a region's nodes using the given FieldML evaluator. :param nodesArgumentName: The name of the argument evaluator to create the nodes from. :type nodesArgumentName: string :param regionNumber: The user number of the region to create to the nodes in. :type regionNumber: int :param nodes: On return, the newly created nodes. :type nodes: Nodes :rtype: None
| def iron.FieldMLIO.OutputAddFieldComponents | ( | self, | |
| typeHandle, | |||
| baseName, | |||
| dofFormat, | |||
| field, | |||
| fieldComponentNumbers, | |||
| variableType, | |||
| setType | |||
| ) |
Add the given field to the current FieldML context, only including the given components. :param typeHandle: The FieldML type to assign to the new FieldML field. :type typeHandle: int :param baseName: The prefix to use when naming automatically created FieldML objects in the context. :type baseName: string :param dofFormat: The name of the format to use when writing dof data. :type dofFormat: string :param field: The field whose components are to be added. :type field: Field :param fieldComponentNumbers: :type fieldComponentNumbers: Array of ints :param variableType: The variable type of the field to add to the FieldML context. :type variableType: int :param setType: The parameter set type. :type setType: int :rtype: None
| def iron.FieldMLIO.OutputAddFieldComponentsNum | ( | self, | |
| typeHandle, | |||
| baseName, | |||
| dofFormat, | |||
| regionNumber, | |||
| fieldNumber, | |||
| fieldComponentNumbers, | |||
| variableType, | |||
| setType | |||
| ) |
Add the field with the given user number to the current FieldML context, only including the given components. :param typeHandle: The FieldML type to assign to the new FieldML field. :type typeHandle: int :param baseName: The prefix to use when naming automatically created FieldML objects in the context. :type baseName: string :param dofFormat: The name of the format to use when writing dof data. :type dofFormat: string :param regionNumber: The user number of the region owning the field to add. :type regionNumber: int :param fieldNumber: The user number of the field whose components are to be added. :type fieldNumber: int :param fieldComponentNumbers: The component numbers to add. :type fieldComponentNumbers: Array of ints :param variableType: The variable type of the field to add to the FieldML context. :type variableType: int :param setType: The parameter set type. :type setType: int :rtype: None
| def iron.FieldMLIO.OutputAddFieldNoType | ( | self, | |
| baseName, | |||
| dofFormat, | |||
| field, | |||
| variableType, | |||
| setType | |||
| ) |
Add the given field to the given FieldML context. The FieldML type will be inferred. :param baseName: The prefix to use when naming automatically created FieldML objects in the context. :type baseName: string :param dofFormat: The name of the format to use when writing dof data. :type dofFormat: string :param field: The field to add. :type field: Field :param variableType: The variable type of the field to add. :type variableType: int :param setType: The parameter set type. :type setType: int :rtype: None
| def iron.FieldMLIO.OutputAddFieldNoTypeNum | ( | self, | |
| baseName, | |||
| dofFormat, | |||
| regionNumber, | |||
| fieldNumber, | |||
| variableType, | |||
| setType | |||
| ) |
Add the field with the given user number to the given FieldML context. The FieldML type will be inferred. :param baseName: The prefix to use when naming automatically created FieldML objects in the context. :type baseName: string :param dofFormat: The name of the format to use when writing dof data. :type dofFormat: string :param regionNumber: The user number of the region containing the field to add to the FieldML context. :type regionNumber: int :param fieldNumber: The user number of the field to add to the FieldML context. :type fieldNumber: int :param variableType: The variable type of the field to add to the FieldML context. :type variableType: int :param setType: The parameter set type. :type setType: int :rtype: None
| def iron.FieldMLIO.OutputAddFieldWithType | ( | self, | |
| baseName, | |||
| dofFormat, | |||
| field, | |||
| variableType, | |||
| setType, | |||
| typeHandle | |||
| ) |
Add the given field to the given FieldML context, using the given FieldML type. :param baseName: The prefix to use when naming automatically created FieldML objects in the context. :type baseName: string :param dofFormat: The name of the format to use when writing dof data. :type dofFormat: string :param field: The field to add to the FieldML context. :type field: Field :param variableType: The variable type of the field to add to the FieldML context. :type variableType: int :param setType: The parameter set type. :type setType: int :param typeHandle: The FieldML type to assign to the new FieldML field. :type typeHandle: int :rtype: None
| def iron.FieldMLIO.OutputAddFieldWithTypeNum | ( | self, | |
| baseName, | |||
| dofFormat, | |||
| regionNumber, | |||
| fieldNumber, | |||
| variableType, | |||
| setType, | |||
| typeHandle | |||
| ) |
Add the given field to the given FieldML context, using the given FieldML type. :param baseName: The prefix to use when naming automatically created FieldML objects in the context. :type baseName: string :param dofFormat: The name of the format to use when writing dof data. :type dofFormat: string :param regionNumber: The user number of the region owning the field to add. :type regionNumber: int :param fieldNumber: The user number of the field to add. :type fieldNumber: int :param variableType: The variable type of the field to add to the FieldML context. :type variableType: int :param setType: The parameter set type. :type setType: int :param typeHandle: The FieldML type to assign to the new FieldML field. :type typeHandle: int :rtype: None
| def iron.FieldMLIO.OutputAddImport | ( | self, | |
| name | |||
| ) |
| def iron.FieldMLIO.OutputCreate | ( | self, | |
| mesh, | |||
| location, | |||
| baseName, | |||
| connectivityFormat | |||
| ) |
Initialise the given FieldML context using the given mesh. :param mesh: The mesh to use when initialising the FieldML context. :type mesh: Mesh :param location: The root directory in which associated data files should be created. :type location: string :param baseName: The prefix to use when naming automatically created FieldML objects in the context. :type baseName: string :param connectivityFormat: The name of the format to use when writing connectivity data. :type connectivityFormat: string :rtype: None
| def iron.FieldMLIO.OutputCreateNum | ( | self, | |
| regionNumber, | |||
| meshNumber, | |||
| location, | |||
| baseName, | |||
| connectivityFormat | |||
| ) |
Initialise the given FieldML context using the mesh with the given user number. :param regionNumber: The user number of the region owning the mesh to use when initialising the FieldML context. :type regionNumber: int :param meshNumber: The user number of the mesh to use when initialising the FieldML context. :type meshNumber: int :param location: The root directory in which associated data files should be created. :type location: string :param baseName: The prefix to use when naming automatically created FieldML objects in the context. :type baseName: string :param connectivityFormat: The name of the format to use when writing connectivity data. :type connectivityFormat: string :rtype: None
| def iron.FieldMLIO.OutputWrite | ( | self, | |
| filename | |||
| ) |
1.8.11 
