OpenCMISS-Iron Python Bindings API Documentation
iron.py
Go to the documentation of this file.
1 """OpenCMISS-Iron
2 
3 OpenCMISS (Open Continuum Mechanics, Imaging, Signal processing and System
4 identification) is a mathematical modelling environment that enables the
5 application of finite element analysis techniques to a variety of complex
6 bioengineering problems.
7 
8 OpenCMISS-Iron is the computational backend component of OpenCMISS.
9 This Python module wraps the underlying OpenCMISS-Iron Fortran library.
10 
11 http://www.opencmiss.org
12 """
13 
14 from . import _iron_python
15 import signal
16 from ._utils import (CMFEError, CMFEType, Enum,
17  wrap_cmiss_routine as _wrap_routine)
18 
19 
20 class Basis(CMFEType):
21  """Contains information about a basis function.
22  """
23 
24  def __init__(self):
25  """Initialise a null cmfe_BasisType"""
26 
27  self.cmiss_type = _wrap_routine(_iron_python.cmfe_Basis_Initialise, None)
28 
29  def CollapsedXiGet(self, collapsedXiSize):
30  """Returns the collapsed Xi flags of a basis identified by an object.
31 
32  :param collapsedXiSize: Size of collapsedXi to allocate.
33  :returns: collapsedXi. collapsedXi(ni). On return, the collapsed Xi parameter for the ni'th Xi direction. Will be a value from the BasisXiCollapse enum.
34  :rtype: Array of ints
35  """
36 
37  basis = self
38  return _wrap_routine(_iron_python.cmfe_Basis_CollapsedXiGet, [basis, collapsedXiSize])
39 
40  def CollapsedXiSet(self, collapsedXi):
41  """Sets/changes the collapsed Xi flags of a basis identified by an object.
42 
43  :param collapsedXi: collapsedXi(ni). The collapsed Xi parameter for the ni'th Xi direction to set. Must be a value from the BasisXiCollapse enum.
44  :type collapsedXi: Array of ints
45  :rtype: None
46  """
47 
48  basis = self
49  return _wrap_routine(_iron_python.cmfe_Basis_CollapsedXiSet, [basis, collapsedXi])
50 
51  def CreateFinish(self):
52  """Finishes the creation of a new basis identified by an object.
53 
54  :rtype: None
55  """
56 
57  basis = self
58  return _wrap_routine(_iron_python.cmfe_Basis_CreateFinish, [basis])
59 
60  def CreateStart(self, userNumber):
61  """Starts the creation of a new basis for a basis identified by an object.
62 
63  :param userNumber: The user number of the basis to start the creation of.
64  :type userNumber: int
65  :rtype: None
66  """
67 
68  basis = self
69  return _wrap_routine(_iron_python.cmfe_Basis_CreateStart, [userNumber, basis])
70 
71  def Destroy(self):
72  """Destroys a basis identified by an object.
73 
74  :rtype: None
75  """
76 
77  basis = self
78  return _wrap_routine(_iron_python.cmfe_Basis_Destroy, [basis])
79 
80  def Finalise(self):
81  """Finalises a cmfe_BasisType object.
82 
83  :rtype: None
84  """
85 
86  cmfe_Basis = self
87  return _wrap_routine(_iron_python.cmfe_Basis_Finalise, [cmfe_Basis])
88 
89  def InterpolationXiGet(self, interpolationXiSize):
90  """Get the interpolation type in each xi directions for a basis indentified by an object.
91 
92  :param interpolationXiSize: Size of interpolationXi to allocate.
93  :returns: interpolationXi. The interpolation xi parameters for each Xi direction. Will be a value from the BasisInterpolationSpecifications enum.
94  :rtype: Array of ints
95  """
96 
97  basis = self
98  return _wrap_routine(_iron_python.cmfe_Basis_InterpolationXiGet, [basis, interpolationXiSize])
99 
100  def InterpolationXiSet(self, interpolationXi):
101  """Sets/changes the interpolation type in each xi directions for a basis indentified by an object.
102 
103  :param interpolationXi: The interpolation xi parameters for each Xi direction. Must be a value from the BasisInterpolationSpecifications enum.
104  :type interpolationXi: Array of ints
105  :rtype: None
106  """
107 
108  basis = self
109  return _wrap_routine(_iron_python.cmfe_Basis_InterpolationXiSet, [basis, interpolationXi])
110 
112  """Returns the number of local nodes in a basis identified by an object.
113 
114  :returns: numberOfLocalNodes. The number of local nodes in the specified basis.
115  :rtype: int
116  """
117 
118  basis = self
119  return _wrap_routine(_iron_python.cmfe_Basis_NumberOfLocalNodesGet, [basis])
120 
121  def NumberOfXiGet(self):
122  """Returns the number of Xi directions in a basis identified by an object.
123 
124  :returns: numberOfXi. The number of xi directions in the specified basis.
125  :rtype: int
126  """
127 
128  basis = self
129  return _wrap_routine(_iron_python.cmfe_Basis_NumberOfXiGet, [basis])
130 
131  def NumberOfXiSet(self, numberOfXi):
132  """Sets/changes the number of Xi directions in a basis identified by an object.
133 
134  :param numberOfXi: The number of xi directions in the specified basis to set.
135  :type numberOfXi: int
136  :rtype: None
137  """
138 
139  basis = self
140  return _wrap_routine(_iron_python.cmfe_Basis_NumberOfXiSet, [basis, numberOfXi])
141 
142  def QuadratureLocalFaceGaussEvaluateSet(self, faceGaussEvaluate):
143  """Sets/changes the local face Gauss scheme calculation, on a basis identified by an object.
144 
145  :param faceGaussEvaluate: The type of quadrature in the specified basis to set.
146  :type faceGaussEvaluate: bool
147  :rtype: None
148  """
149 
150  basis = self
151  return _wrap_routine(_iron_python.cmfe_Basis_QuadratureLocalFaceGaussEvaluateSet, [basis, faceGaussEvaluate])
152 
153  def QuadratureMultipleGaussXiGet(self, quadratureScheme, GaussPoints, GaussXiSizes):
154  """Returns the xi positions of Gauss points on a basis quadrature identified by an object.
155 
156  :param quadratureScheme: The quadrature scheme to return the Gauss xi positions for.
157  :type quadratureScheme: int
158  :param GaussPoints: The Gauss points to return the element xi positions for.
159  :type GaussPoints: Array of ints
160  :param GaussXiSizes: Tuple of dimensions of GaussXi to allocate, with length 2.
161  :returns: GaussXi. GaussXi(Gauss_point,xi_direction) the Gauss xi positions for the specified quadrature scheme.
162  :rtype: 2d array of floats
163  """
164 
165  basis = self
166  return _wrap_routine(_iron_python.cmfe_Basis_QuadratureMultipleGaussXiGet, [basis, quadratureScheme, GaussPoints, GaussXiSizes])
167 
168  def QuadratureNumberOfGaussXiGet(self, numberOfGaussXiSize):
169  """Returns the number Gauss points in each Xi directions for a basis quadrature identified by an object.
170 
171  :param numberOfGaussXiSize: Size of numberOfGaussXi to allocate.
172  :returns: numberOfGaussXi. The number of Gauss points in each Xi directions in the specified basis.
173  :rtype: Array of ints
174  """
175 
176  basis = self
177  return _wrap_routine(_iron_python.cmfe_Basis_QuadratureNumberOfGaussXiGet, [basis, numberOfGaussXiSize])
178 
179  def QuadratureNumberOfGaussXiSet(self, numberOfGaussXi):
180  """Sets the number Gauss points in each Xi directions for a basis quadrature identified by an object.
181 
182  :param numberOfGaussXi: The number of Gauss points in each Xi directions in the specified basis to set.
183  :type numberOfGaussXi: Array of ints
184  :rtype: None
185  """
186 
187  basis = self
188  return _wrap_routine(_iron_python.cmfe_Basis_QuadratureNumberOfGaussXiSet, [basis, numberOfGaussXi])
189 
191  """Returns the the order of quadrature for a basis quadrature identified by an object.
192 
193  :returns: quadratureOrder. The order of quadrature in the specified basis.
194  :rtype: int
195  """
196 
197  basis = self
198  return _wrap_routine(_iron_python.cmfe_Basis_QuadratureOrderGet, [basis])
199 
200  def QuadratureOrderSet(self, quadratureOrder):
201  """Sets/changes the the order of quadrature for a basis quadrature identified by an object.
202 
203  :param quadratureOrder: The order of quadrature in the specified basis to set.
204  :type quadratureOrder: int
205  :rtype: None
206  """
207 
208  basis = self
209  return _wrap_routine(_iron_python.cmfe_Basis_QuadratureOrderSet, [basis, quadratureOrder])
210 
211  def QuadratureSingleGaussXiGet(self, quadratureScheme, GaussPoint, GaussXiSize):
212  """Returns the xi position of a Gauss point on a basis quadrature identified by an object.
213 
214  :param quadratureScheme: The quadrature scheme to return the Gauss xi positions for.
215  :type quadratureScheme: int
216  :param GaussPoint: The Gauss point to return the element xi positions for.
217  :type GaussPoint: int
218  :param GaussXiSize: Size of GaussXi to allocate.
219  :returns: GaussXi. GaussXi(xi_direction) the xi position of the specified Gauss point for the specified quadrature scheme.
220  :rtype: Array of floats
221  """
222 
223  basis = self
224  return _wrap_routine(_iron_python.cmfe_Basis_QuadratureSingleGaussXiGet, [basis, quadratureScheme, GaussPoint, GaussXiSize])
225 
226  def QuadratureTypeGet(self):
227  """Returns the the type of quadrature for a basis quadrature identified by an object.
228 
229  :returns: quadratureType. The type of quadrature in the specified basis. Will be a value from the QuadratureTypes enum.
230  :rtype: int
231  """
232 
233  basis = self
234  return _wrap_routine(_iron_python.cmfe_Basis_QuadratureTypeGet, [basis])
235 
236  def QuadratureTypeSet(self, quadratureType):
237  """Sets/changes the the type of quadrature for a basis quadrature identified by an object.
238 
239  :param quadratureType: The type of quadrature in the specified basis to set. Must be a value from the QuadratureTypes enum.
240  :type quadratureType: int
241  :rtype: None
242  """
243 
244  basis = self
245  return _wrap_routine(_iron_python.cmfe_Basis_QuadratureTypeSet, [basis, quadratureType])
246 
247  def TypeGet(self):
248  """Returns the type of a basis identified by an object.
249 
250  :returns: basisType. The type of the specified basis. Will be a value from the BasisTypes enum.
251  :rtype: int
252  """
253 
254  basis = self
255  return _wrap_routine(_iron_python.cmfe_Basis_TypeGet, [basis])
256 
257  def TypeSet(self, basisType):
258  """Sets/changes the type of a basis identified by an object.
259 
260  :param basisType: The type of the specified basis to set. Must be a value from the BasisTypes enum.
261  :type basisType: int
262  :rtype: None
263  """
264 
265  basis = self
266  return _wrap_routine(_iron_python.cmfe_Basis_TypeSet, [basis, basisType])
267 
268  interpolationXi = property(InterpolationXiGet, InterpolationXiSet, None, """The interpolation type in each xi directions for a basis indentified by an object.""")
269 
270  quadratureNumberOfGaussXi = property(QuadratureNumberOfGaussXiGet, QuadratureNumberOfGaussXiSet, None, """The number Gauss points in each Xi directions for a basis quadrature identified by an object.""")
271 
272  quadratureLocalFaceGaussEvaluate = property(None, QuadratureLocalFaceGaussEvaluateSet, None, """The local face Gauss scheme calculation, on a basis identified by an object.""")
273 
274  quadratureType = property(QuadratureTypeGet, QuadratureTypeSet, None, """The the type of quadrature for a basis quadrature identified by an object.""")
275 
276  collapsedXi = property(CollapsedXiGet, CollapsedXiSet, None, """The collapsed Xi flags of a basis identified by an object.""")
277 
278  numberOfXi = property(NumberOfXiGet, NumberOfXiSet, None, """The number of Xi directions in a basis identified by an object.""")
279 
280  type = property(TypeGet, TypeSet, None, """The type of a basis identified by an object.""")
281 
282  numberOfLocalNodes = property(NumberOfLocalNodesGet, None, None, """The number of local nodes in a basis identified by an object.""")
283 
284  quadratureOrder = property(QuadratureOrderGet, QuadratureOrderSet, None, """The the order of quadrature for a basis quadrature identified by an object.""")
285 
286 
287 class BoundaryConditions(CMFEType):
288  """Contains information on the boundary conditions for the equations set.
289  """
290 
291  def __init__(self):
292  """Initialise a null cmfe_BoundaryConditionsType"""
293 
294  self.cmiss_type = _wrap_routine(_iron_python.cmfe_BoundaryConditions_Initialise, None)
295 
296  def AddConstant(self, field, variableType, componentNumber, condition, value):
297  """Adds to the value of the specified constant and sets this as a boundary condition on the specified constant for boundary conditions identified by an object.
298 
299  :param field: The dependent field to set the boundary condition on.
300  :type field: Field
301  :param variableType: The variable type of the dependent field to set the boundary condition at. Must be a value from the FieldVariableTypes enum.
302  :type variableType: int
303  :param componentNumber: The component number of the dependent field to set the boundary condition at.
304  :type componentNumber: int
305  :param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
306  :type condition: int
307  :param value: The value of the boundary condition to add.
308  :type value: float
309  :rtype: None
310  """
311 
312  boundaryConditions = self
313  return _wrap_routine(_iron_python.cmfe_BoundaryConditions_AddConstant, [boundaryConditions, field, variableType, componentNumber, condition, value])
314 
315  def AddElement(self, field, variableType, elementUserNumber, componentNumber, condition, value):
316  """Adds to the value of the specified element and sets this as a boundary condition on the specified element for boundary conditions identified by an object.
317 
318  :param field: The dependent field to set the boundary condition on.
319  :type field: Field
320  :param variableType: The variable type of the dependent field to add the boundary condition at. Must be a value from the FieldVariableTypes enum.
321  :type variableType: int
322  :param elementUserNumber: The user number of the element to add the boundary conditions for.
323  :type elementUserNumber: int
324  :param componentNumber: The component number of the dependent field to set the boundary condition at.
325  :type componentNumber: int
326  :param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
327  :type condition: int
328  :param value: The value of the boundary condition to add.
329  :type value: float
330  :rtype: None
331  """
332 
333  boundaryConditions = self
334  return _wrap_routine(_iron_python.cmfe_BoundaryConditions_AddElement, [boundaryConditions, field, variableType, elementUserNumber, componentNumber, condition, value])
335 
336  def AddNode(self, field, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, condition, value):
337  """Adds to the value of the specified node and sets this as a boundary condition on the specified node for boundary conditions identified by an object.
338 
339  :param field: The dependent field to set the boundary condition on.
340  :type field: Field
341  :param variableType: The variable type of the dependent field to add the boundary condition at. Must be a value from the FieldVariableTypes enum.
342  :type variableType: int
343  :param versionNumber: The user number of the node derivative version to add the boundary conditions for.
344  :type versionNumber: int
345  :param derivativeNumber: The user number of the node derivative to add the boundary conditions for.
346  :type derivativeNumber: int
347  :param nodeUserNumber: The user number of the node to add the boundary conditions for.
348  :type nodeUserNumber: int
349  :param componentNumber: The component number of the dependent field to set the boundary condition at.
350  :type componentNumber: int
351  :param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
352  :type condition: int
353  :param value: The value of the boundary condition to add.
354  :type value: float
355  :rtype: None
356  """
357 
358  boundaryConditions = self
359  return _wrap_routine(_iron_python.cmfe_BoundaryConditions_AddNode, [boundaryConditions, field, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, condition, value])
360 
361  def ConstrainNodeDofsEqual(self, field, fieldVariableType, versionNumber, derivativeNumber, component, nodes, coefficient):
362  """Constrain multiple nodal equations dependent field DOFs to be a single solver DOF in the solver equations
363 
364  :param field: The equations dependent field containing the field DOFs to be constrained.
365  :type field: Field
366  :param fieldVariableType: The field variable type of the DOFs to be constrained. Must be a value from the FieldVariableTypes enum.
367  :type fieldVariableType: int
368  :param versionNumber: The derivative version number.
369  :type versionNumber: int
370  :param derivativeNumber: The derivative number.
371  :type derivativeNumber: int
372  :param component: The field component number of the DOFs to be constrained.
373  :type component: int
374  :param nodes: The user numbers of the nodes to be constrained to be equal.
375  :type nodes: Array of ints
376  :param coefficient: The coefficient of constraint, applied to all but the first node.
377  :type coefficient: float
378  :rtype: None
379  """
380 
381  boundaryConditions = self
382  return _wrap_routine(_iron_python.cmfe_BoundaryConditions_ConstrainNodeDofsEqual, [boundaryConditions, field, fieldVariableType, versionNumber, derivativeNumber, component, nodes, coefficient])
383 
384  def Destroy(self):
385  """Destroys boundary conditions identified by an object.
386 
387  :rtype: None
388  """
389 
390  boundaryConditions = self
391  return _wrap_routine(_iron_python.cmfe_BoundaryConditions_Destroy, [boundaryConditions])
392 
393  def Finalise(self):
394  """Finalises a cmfe_BoundaryConditionsType object.
395 
396  :rtype: None
397  """
398 
399  cmfe_BoundaryConditions = self
400  return _wrap_routine(_iron_python.cmfe_BoundaryConditions_Finalise, [cmfe_BoundaryConditions])
401 
402  def NeumannSparsityTypeSet(self, sparsityType):
403  """Sets the Neumann integration matrix sparsity type for the boundary conditions
404 
405  :param sparsityType: The sparsity type for the Neumann integration matrices. Must be a value from the BoundaryConditionSparsityTypes enum.
406  :type sparsityType: int
407  :rtype: None
408  """
409 
410  boundaryConditions = self
411  return _wrap_routine(_iron_python.cmfe_BoundaryConditions_NeumannSparsityTypeSet, [boundaryConditions, sparsityType])
412 
413  def SetConstant(self, field, variableType, componentNumber, condition, value):
414  """Sets the value of the specified constant and sets this as a boundary condition on the specified constant for boundary conditions identified by an object.
415 
416  :param field: The dependent field to set the boundary condition on.
417  :type field: Field
418  :param variableType: The variable type of the dependent field to set the boundary condition at. Must be a value from the FieldVariableTypes enum.
419  :type variableType: int
420  :param componentNumber: The component number of the dependent field to set the boundary condition at.
421  :type componentNumber: int
422  :param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
423  :type condition: int
424  :param value: The value of the boundary condition to set.
425  :type value: float
426  :rtype: None
427  """
428 
429  boundaryConditions = self
430  return _wrap_routine(_iron_python.cmfe_BoundaryConditions_SetConstant, [boundaryConditions, field, variableType, componentNumber, condition, value])
431 
432  def SetElement(self, field, variableType, elementUserNumber, componentNumber, condition, value):
433  """Sets the value of the specified element and sets this as a boundary condition on the specified elements for boundary conditions identified by an object.
434 
435  :param field: The dependent field to set the boundary condition on.
436  :type field: Field
437  :param variableType: The variable type of the dependent field to set the boundary condition at. Must be a value from the FieldVariableTypes enum.
438  :type variableType: int
439  :param elementUserNumber: The user number of the element to set the boundary conditions for.
440  :type elementUserNumber: int
441  :param componentNumber: The component number of the dependent field to set the boundary condition at.
442  :type componentNumber: int
443  :param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
444  :type condition: int
445  :param value: The value of the boundary condition to set.
446  :type value: float
447  :rtype: None
448  """
449 
450  boundaryConditions = self
451  return _wrap_routine(_iron_python.cmfe_BoundaryConditions_SetElement, [boundaryConditions, field, variableType, elementUserNumber, componentNumber, condition, value])
452 
453  def SetNode(self, field, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, condition, value):
454  """Sets the value of the specified node and sets this as a boundary condition on the specified node for boundary conditions identified by an object.
455 
456  :param field: The dependent field to set the boundary condition on.
457  :type field: Field
458  :param variableType: The variable type of the dependent field to set the boundary condition at. Must be a value from the FieldVariableTypes enum.
459  :type variableType: int
460  :param versionNumber: The user number of the node derivative version to set the boundary conditions for.
461  :type versionNumber: int
462  :param derivativeNumber: The user number of the node derivative to set the boundary conditions for.
463  :type derivativeNumber: int
464  :param nodeUserNumber: The user number of the node to set the boundary conditions for.
465  :type nodeUserNumber: int
466  :param componentNumber: The component number of the dependent field to set the boundary condition at.
467  :type componentNumber: int
468  :param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
469  :type condition: int
470  :param value: The value of the boundary condition to set.
471  :type value: float
472  :rtype: None
473  """
474 
475  boundaryConditions = self
476  return _wrap_routine(_iron_python.cmfe_BoundaryConditions_SetNode, [boundaryConditions, field, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, condition, value])
477 
478  neumannSparsityType = property(None, NeumannSparsityTypeSet, None, """The Neumann integration matrix sparsity type for the boundary conditions""")
479 
480 
481 class CellMLEquations(CMFEType):
482  """Contains information about the CellML equations for a solver.
483  """
484 
485  def __init__(self):
486  """Initialise a null cmfe_CellMLEquationsType"""
487 
488  self.cmiss_type = _wrap_routine(_iron_python.cmfe_CellMLEquations_Initialise, None)
489 
490  def CellMLAdd(self, CellML):
491  """Adds a CellML environment to CellML equations identified by an object.
492 
493  :param CellML: The CellML environment to add.
494  :type CellML: CellML
495  :returns: CellMLIndex. The index of the added CellML environment.
496  :rtype: int
497  """
498 
499  CellMLEquations = self
500  return _wrap_routine(_iron_python.cmfe_CellMLEquations_CellMLAdd, [CellMLEquations, CellML])
501 
502  def Finalise(self):
503  """Finalises a cmfe_CellMLEquationsType object.
504 
505  :rtype: None
506  """
507 
508  cmfe_CellMLEquations = self
509  return _wrap_routine(_iron_python.cmfe_CellMLEquations_Finalise, [cmfe_CellMLEquations])
510 
511 
512 class CellML(CMFEType):
513  """Contains information on a CellML environment.
514  """
515 
516  def __init__(self):
517  """Initialise a null cmfe_CellMLType"""
518 
519  self.cmiss_type = _wrap_routine(_iron_python.cmfe_CellML_Initialise, None)
520 
521  def CreateCellMLToFieldMap(self, CellMLModelUserNumber, variableID, CellMLParameterSet, field, variableType, componentNumber, fieldParameterSet):
522  """Defines a CellML model variable to field variable component map by object.
523 
524  :param CellMLModelUserNumber: The user number of the CellML model to map from.
525  :type CellMLModelUserNumber: int
526  :param variableID: The of the CellML variable in the given model to map from.
527  :type variableID: string
528  :param CellMLParameterSet: The CellML variable parameter set to map from.
529  :type CellMLParameterSet: int
530  :param field: The field to map to.
531  :type field: Field
532  :param variableType: The field variable type to map to.
533  :type variableType: int
534  :param componentNumber: The field variable component number to.
535  :type componentNumber: int
536  :param fieldParameterSet: The field variable parameter set to map to.
537  :type fieldParameterSet: int
538  :rtype: None
539  """
540 
541  CellML = self
542  return _wrap_routine(_iron_python.cmfe_CellML_CreateCellMLToFieldMap, [CellML, CellMLModelUserNumber, variableID, CellMLParameterSet, field, variableType, componentNumber, fieldParameterSet])
543 
544  def CreateFieldToCellMLMap(self, field, variableType, componentNumber, fieldParameterSet, CellMLModelUserNumber, variableID, CellMLParameterSet):
545  """Defines a field variable component to CellML model variable map by object.
546 
547  :param field: The field to map from.
548  :type field: Field
549  :param variableType: The field variable to map from.
550  :type variableType: int
551  :param componentNumber: The component number to map from the given field variable.
552  :type componentNumber: int
553  :param fieldParameterSet: The field variable parameter set to map from.
554  :type fieldParameterSet: int
555  :param CellMLModelUserNumber: The user number of the CellML model to map to.
556  :type CellMLModelUserNumber: int
557  :param variableID: The of the CellML variable in the given model to map to.
558  :type variableID: string
559  :param CellMLParameterSet: The CellML variable parameter set to map to.
560  :type CellMLParameterSet: int
561  :rtype: None
562  """
563 
564  CellML = self
565  return _wrap_routine(_iron_python.cmfe_CellML_CreateFieldToCellMLMap, [CellML, field, variableType, componentNumber, fieldParameterSet, CellMLModelUserNumber, variableID, CellMLParameterSet])
566 
567  def CreateFinish(self):
568  """Finish the creation of a CellML environment identified by an object.
569 
570  :rtype: None
571  """
572 
573  CellML = self
574  return _wrap_routine(_iron_python.cmfe_CellML_CreateFinish, [CellML])
575 
576  def CreateStart(self, CellMLUserNumber, region):
577  """Start the creation of a CellML environment identified by an object.
578 
579  :param CellMLUserNumber: The user number of the CellML enviroment to start creating.
580  :type CellMLUserNumber: int
581  :param region: The region containing the field to start the CellML enviroment creation on.
582  :type region: Region
583  :rtype: None
584  """
585 
586  CellML = self
587  return _wrap_routine(_iron_python.cmfe_CellML_CreateStart, [CellMLUserNumber, region, CellML])
588 
589  def Destroy(self):
590  """Destroy a CellML environment identified by an object.
591 
592  :rtype: None
593  """
594 
595  CellML = self
596  return _wrap_routine(_iron_python.cmfe_CellML_Destroy, [CellML])
597 
598  def FieldComponentGet(self, CellMLModelUserNumber, CellMLFieldType, variableID):
599  """Returns the field component number that corresponds to a character string variable ID for a CellML environment identified by an object.
600 
601  :param CellMLModelUserNumber: The user number of the CellML model to map from.
602  :type CellMLModelUserNumber: int
603  :param CellMLFieldType: The type of CellML field to get the component for. Must be a value from the CellMLFieldTypes enum.
604  :type CellMLFieldType: int
605  :param variableID: The ID to get the corresponding field component for.
606  :type variableID: string
607  :returns: fieldComponent. The field component corresponding to the ID.
608  :rtype: int
609  """
610 
611  CellML = self
612  return _wrap_routine(_iron_python.cmfe_CellML_FieldComponentGet, [CellML, CellMLModelUserNumber, CellMLFieldType, variableID])
613 
615  """Finish the creation of field maps for a CellML environment identified by an object.
616 
617  :rtype: None
618  """
619 
620  CellML = self
621  return _wrap_routine(_iron_python.cmfe_CellML_FieldMapsCreateFinish, [CellML])
622 
624  """Start the creation of field maps for a CellML environment identified by an object.
625 
626  :rtype: None
627  """
628 
629  CellML = self
630  return _wrap_routine(_iron_python.cmfe_CellML_FieldMapsCreateStart, [CellML])
631 
632  def Finalise(self):
633  """Finalises a cmfe_CellMLType object.
634 
635  :rtype: None
636  """
637 
638  cmfe_CellML = self
639  return _wrap_routine(_iron_python.cmfe_CellML_Finalise, [cmfe_CellML])
640 
641  def Generate(self):
642  """Validiate and instantiate a CellML environment identified by an object.
643 
644  :rtype: None
645  """
646 
647  CellML = self
648  return _wrap_routine(_iron_python.cmfe_CellML_Generate, [CellML])
649 
651  """Finish the creation of CellML intermediate field for a CellML environment identified by an object.
652 
653  :rtype: None
654  """
655 
656  CellML = self
657  return _wrap_routine(_iron_python.cmfe_CellML_IntermediateFieldCreateFinish, [CellML])
658 
659  def IntermediateFieldCreateStart(self, CellMLIntermediateFieldUserNumber, field):
660  """Start the creation of CellML intermediate field for a CellML environment identified by an object.
661 
662  :param CellMLIntermediateFieldUserNumber: The user number of the CellML intermediate field to start creating.
663  :type CellMLIntermediateFieldUserNumber: int
664  :param field: On return, the created CellML intermediate field.
665  :type field: Field
666  :rtype: None
667  """
668 
669  CellML = self
670  return _wrap_routine(_iron_python.cmfe_CellML_IntermediateFieldCreateStart, [CellML, CellMLIntermediateFieldUserNumber, field])
671 
672  def IntermediateFieldGet(self, field):
673  """Returns the CellML intermediate field for a CellML environment identified by an object.
674 
675  :param field: On return, the CellML intermediate field.
676  :type field: Field
677  :rtype: None
678  """
679 
680  CellML = self
681  return _wrap_routine(_iron_python.cmfe_CellML_IntermediateFieldGet, [CellML, field])
682 
683  def ModelImport(self, URI):
684  """Imports a specified CellML model as specified by a character URI into a CellML environment identified by an object.
685 
686  :param URI: The URI of the CellML model to import.
687  :type URI: string
688  :returns: modelIndex. The index of the imported model.
689  :rtype: int
690  """
691 
692  CellML = self
693  return _wrap_routine(_iron_python.cmfe_CellML_ModelImport, [CellML, URI])
694 
696  """Finish the creation of CellML models field for a CellML environment identified by an object.
697 
698  :rtype: None
699  """
700 
701  CellML = self
702  return _wrap_routine(_iron_python.cmfe_CellML_ModelsFieldCreateFinish, [CellML])
703 
704  def ModelsFieldCreateStart(self, CellMLModelsFieldUserNumber, field):
705  """Start the creation of CellML models field for a CellML environment identified by an object.
706 
707  :param CellMLModelsFieldUserNumber: The user number of the CellML models field to start creating.
708  :type CellMLModelsFieldUserNumber: int
709  :param field: On return, the created CellML models field.
710  :type field: Field
711  :rtype: None
712  """
713 
714  CellML = self
715  return _wrap_routine(_iron_python.cmfe_CellML_ModelsFieldCreateStart, [CellML, CellMLModelsFieldUserNumber, field])
716 
717  def ModelsFieldGet(self, field):
718  """Returns the CellML models field for a CellML environment identified by an object.
719 
720  :param field: On return, the CellML models field. Must not be associated on entry.
721  :type field: Field
722  :rtype: None
723  """
724 
725  CellML = self
726  return _wrap_routine(_iron_python.cmfe_CellML_ModelsFieldGet, [CellML, field])
727 
729  """Finish the creation of CellML parameters field for a CellML environment identified by an object.
730 
731  :rtype: None
732  """
733 
734  CellML = self
735  return _wrap_routine(_iron_python.cmfe_CellML_ParametersFieldCreateFinish, [CellML])
736 
737  def ParametersFieldCreateStart(self, CellMLParametersFieldUserNumber, field):
738  """Start the creation of CellML parameters field for a CellML environment identified by an object.
739 
740  :param CellMLParametersFieldUserNumber: The user number of the CellML parameters field to start creating.
741  :type CellMLParametersFieldUserNumber: int
742  :param field: On return, the created CellML parameters field.
743  :type field: Field
744  :rtype: None
745  """
746 
747  CellML = self
748  return _wrap_routine(_iron_python.cmfe_CellML_ParametersFieldCreateStart, [CellML, CellMLParametersFieldUserNumber, field])
749 
750  def ParametersFieldGet(self, field):
751  """Returns the CellML parameters field for a CellML environment identified by an object.
752 
753  :param field: On return, the CellML parameters field.
754  :type field: Field
755  :rtype: None
756  """
757 
758  CellML = self
759  return _wrap_routine(_iron_python.cmfe_CellML_ParametersFieldGet, [CellML, field])
760 
762  """Finish the creation of CellML state field for a CellML environment identified by an object.
763 
764  :rtype: None
765  """
766 
767  CellML = self
768  return _wrap_routine(_iron_python.cmfe_CellML_StateFieldCreateFinish, [CellML])
769 
770  def StateFieldCreateStart(self, CellMLStateFieldUserNumber, field):
771  """Start the creation of CellML state field for a CellML environment identified by an object.
772 
773  :param CellMLStateFieldUserNumber: The user number of the CellML state field to start creating.
774  :type CellMLStateFieldUserNumber: int
775  :param field: On return, the created CellML state field.
776  :type field: Field
777  :rtype: None
778  """
779 
780  CellML = self
781  return _wrap_routine(_iron_python.cmfe_CellML_StateFieldCreateStart, [CellML, CellMLStateFieldUserNumber, field])
782 
783  def StateFieldGet(self, field):
784  """Returns the CellML state field for a CellML environment identified by an object.
785 
786  :param field: On return, the CellML state field.
787  :type field: Field
788  :rtype: None
789  """
790 
791  CellML = self
792  return _wrap_routine(_iron_python.cmfe_CellML_StateFieldGet, [CellML, field])
793 
794  def VariableSetAsKnown(self, CellMLModelUserNumber, variableID):
795  """Sets a CellML model variable to be known by object.
796 
797  :param CellMLModelUserNumber: The user number of the CellML model in which to find the given variable.
798  :type CellMLModelUserNumber: int
799  :param variableID: The CellML variable to set as known (in the format 'component_name/variable_name').
800  :type variableID: string
801  :rtype: None
802  """
803 
804  CellML = self
805  return _wrap_routine(_iron_python.cmfe_CellML_VariableSetAsKnown, [CellML, CellMLModelUserNumber, variableID])
806 
807  def VariableSetAsWanted(self, CellMLModelUserNumber, variableID):
808  """Sets a CellML model variable to be wanted by object.
809 
810  :param CellMLModelUserNumber: The user number of the CellML model in which to find the given variable.
811  :type CellMLModelUserNumber: int
812  :param variableID: The CellML variable to set as wanted (in the format 'component_name/variable_name').
813  :type variableID: string
814  :rtype: None
815  """
816 
817  CellML = self
818  return _wrap_routine(_iron_python.cmfe_CellML_VariableSetAsWanted, [CellML, CellMLModelUserNumber, variableID])
819 
820  modelsField = property(ModelsFieldGet, None, None, """The CellML models field for a CellML environment identified by an object.""")
821 
822  parametersField = property(ParametersFieldGet, None, None, """The CellML parameters field for a CellML environment identified by an object.""")
823 
824  intermediateField = property(IntermediateFieldGet, None, None, """The CellML intermediate field for a CellML environment identified by an object.""")
825 
826  stateField = property(StateFieldGet, None, None, """The CellML state field for a CellML environment identified by an object.""")
827 
828 
829 class ComputationalWorkGroup(CMFEType):
830  """Contains information on a computational work group
831  """
832 
833  def __init__(self):
834  """Initialise a null cmfe_ComputationalWorkGroupType"""
835 
836  self.cmiss_type = _wrap_routine(_iron_python.cmfe_ComputationalWorkGroup_Initialise, None)
837 
838  def CreateFinish(self):
839  """GENERATE THE HIERARCHY COMPUTATIONAL ENVIRONMENT BASED ON WORK GROUP TREE
840 
841  :rtype: None
842  """
843 
844  worldWorkGroup = self
845  return _wrap_routine(_iron_python.cmfe_ComputationalWorkGroup_CreateFinish, [worldWorkGroup])
846 
847  def CreateStart(self, numberComputationalNodes):
848  """CREATE THE HIGHEST LEVEL WORK GROUP (DEFAULT: GROUP_WORLD)
849 
850  :param numberComputationalNodes:
851  :type numberComputationalNodes: int
852  :rtype: None
853  """
854 
855  worldWorkGroup = self
856  return _wrap_routine(_iron_python.cmfe_ComputationalWorkGroup_CreateStart, [worldWorkGroup, numberComputationalNodes])
857 
858  def SubgroupAdd(self, numberComputationalNodes, addedWorkGroup):
859  """ADD WORK SUB-GROUP TO THE PARENT GROUP BASED ON THE COMPUTATIONAL REQUIREMENTS (CALLED BY THE USER)
860 
861  :param numberComputationalNodes:
862  :type numberComputationalNodes: int
863  :param addedWorkGroup:
864  :type addedWorkGroup: ComputationalWorkGroup
865  :rtype: None
866  """
867 
868  parentWorkGroup = self
869  return _wrap_routine(_iron_python.cmfe_ComputationalWorkGroup_SubgroupAdd, [parentWorkGroup, numberComputationalNodes, addedWorkGroup])
870 
871 
872 class ControlLoop(CMFEType):
873  """Contains information on a control loop.
874  """
875 
876  def __init__(self):
877  """Initialise a null cmfe_ControlLoopType"""
878 
879  self.cmiss_type = _wrap_routine(_iron_python.cmfe_ControlLoop_Initialise, None)
880 
881  def AbsoluteToleranceSet(self, absoluteTolerance):
882  """Sets/changes the maximum iterations for a while control loop identified by an object.
883 
884  :param absoluteTolerance: The absolute tolerance value for a control loop.
885  :type absoluteTolerance: float
886  :rtype: None
887  """
888 
889  controlLoop = self
890  return _wrap_routine(_iron_python.cmfe_ControlLoop_AbsoluteToleranceSet, [controlLoop, absoluteTolerance])
891 
892  def ControlLoopGet(self, controlLoopIdentifiers):
893  """Returns the specified control loop as indexed by the control loop identifiers from the control loop root.
894 
895  :param controlLoopIdentifiers: The control loop identifiers.
896  :type controlLoopIdentifiers: Array of ints
897  :returns: controlLoop. The specified control loop.
898  :rtype: ControlLoop
899  """
900 
901  controlLoopRoot = self
902  return _wrap_routine(_iron_python.cmfe_ControlLoop_ControlLoopGet, [controlLoopRoot, controlLoopIdentifiers])
903 
904  def CurrentTimesGet(self):
905  """Gets the current time parameters for a time control loop identified by an object.
906 
907  :returns: (The current time of the time control loop, The current time increment of the time control loop)
908  :rtype: tuple. (float, float)
909  """
910 
911  controlLoop = self
912  return _wrap_routine(_iron_python.cmfe_ControlLoop_CurrentTimesGet, [controlLoop])
913 
914  def Destroy(self):
915  """Destroys a control loop identified by an object.
916 
917  :rtype: None
918  """
919 
920  controlLoop = self
921  return _wrap_routine(_iron_python.cmfe_ControlLoop_Destroy, [controlLoop])
922 
923  def Finalise(self):
924  """Finalises a cmfe_ControlLoopType object.
925 
926  :rtype: None
927  """
928 
929  cmfe_ControlLoop = self
930  return _wrap_routine(_iron_python.cmfe_ControlLoop_Finalise, [cmfe_ControlLoop])
931 
932  def IterationsSet(self, startIteration, stopIteration, iterationIncrement):
933  """Sets/changes the iteration parameters for a fixed control loop identified by an object.
934 
935  :param startIteration: The start iteration of the fixed control loop to set.
936  :type startIteration: int
937  :param stopIteration: The stop iteration of the fixed control loop to set.
938  :type stopIteration: int
939  :param iterationIncrement: The iteration increment of the fixed control loop to set.
940  :type iterationIncrement: int
941  :rtype: None
942  """
943 
944  controlLoop = self
945  return _wrap_routine(_iron_python.cmfe_ControlLoop_IterationsSet, [controlLoop, startIteration, stopIteration, iterationIncrement])
946 
947  def LabelGet(self):
948  """Returns the character string label for a control loop identified by an object.
949 
950  :returns: label. The region label.
951  :rtype: string
952  """
953 
954  controlLoop = self
955  return _wrap_routine(_iron_python.cmfe_ControlLoop_LabelGet, [controlLoop])
956 
957  def LabelSet(self, label):
958  """Sets/changes the character string label for a control loop identified by an object.
959 
960  :param label: The control loop label to set.
961  :type label: string
962  :rtype: None
963  """
964 
965  controlLoop = self
966  return _wrap_routine(_iron_python.cmfe_ControlLoop_LabelSet, [controlLoop, label])
967 
968  def LoadOutputSet(self, outputFrequency):
969  """Sets/changes the output parameters for a load control loop identified by an object.
970 
971  :param outputFrequency: The output frequency modulo to set.
972  :type outputFrequency: int
973  :rtype: None
974  """
975 
976  controlLoop = self
977  return _wrap_routine(_iron_python.cmfe_ControlLoop_LoadOutputSet, [controlLoop, outputFrequency])
978 
979  def MaximumIterationsSet(self, maximumIterations):
980  """Sets/changes the maximum iterations for a while control loop identified by an object.
981 
982  :param maximumIterations: The maximum iterations of the while control loop to set.
983  :type maximumIterations: int
984  :rtype: None
985  """
986 
987  controlLoop = self
988  return _wrap_routine(_iron_python.cmfe_ControlLoop_MaximumIterationsSet, [controlLoop, maximumIterations])
989 
991  """Gets the number of iterations for a time control loop identified by an object.
992 
993  :returns: numberOfIterations. The number of iterations
994  :rtype: int
995  """
996 
997  controlLoop = self
998  return _wrap_routine(_iron_python.cmfe_ControlLoop_NumberOfIterationsGet, [controlLoop])
999 
1000  def NumberOfIterationsSet(self, numberOfIterations):
1001  """Sets the number of iterations for a time control loop identified by an object.
1002 
1003  :param numberOfIterations: The number of iterations to set
1004  :type numberOfIterations: int
1005  :rtype: None
1006  """
1007 
1008  controlLoop = self
1009  return _wrap_routine(_iron_python.cmfe_ControlLoop_NumberOfIterationsSet, [controlLoop, numberOfIterations])
1010 
1012  """Returns the number of sub-control loops for a control loop identified by an object.
1013 
1014  :returns: numberOfSubLoops. The number of sub loops for the specified control loop.
1015  :rtype: int
1016  """
1017 
1018  controlLoop = self
1019  return _wrap_routine(_iron_python.cmfe_ControlLoop_NumberOfSubLoopsGet, [controlLoop])
1020 
1021  def NumberOfSubLoopsSet(self, numberOfSubLoops):
1022  """Sets/changes the number of sub-control loops for a control loop identified by an object. \todo is this really public???
1023 
1024  :param numberOfSubLoops: The number of sub loops for the specified control loop.
1025  :type numberOfSubLoops: int
1026  :rtype: None
1027  """
1028 
1029  controlLoop = self
1030  return _wrap_routine(_iron_python.cmfe_ControlLoop_NumberOfSubLoopsSet, [controlLoop, numberOfSubLoops])
1031 
1032  def OutputTypeGet(self):
1033  """Returns the output type for a control loop identified by an object.
1034 
1035  :returns: outputType. The output type of the control loop. Will be a value from the ControlLoopOutputTypes enum.
1036  :rtype: int
1037  """
1038 
1039  controlLoop = self
1040  return _wrap_routine(_iron_python.cmfe_ControlLoop_OutputTypeGet, [controlLoop])
1041 
1042  def OutputTypeSet(self, outputType):
1043  """Sets the output type for a control loop identified by an object.
1044 
1045  :param outputType: The output type to set. Must be a value from the ControlLoopOutputTypes enum.
1046  :type outputType: int
1047  :rtype: None
1048  """
1049 
1050  controlLoop = self
1051  return _wrap_routine(_iron_python.cmfe_ControlLoop_OutputTypeSet, [controlLoop, outputType])
1052 
1053  def TimeInputSet(self, inputOption):
1054  """Sets/changes the input parameters for a time control loop identified by an object.
1055 
1056  :param inputOption: The output frequency modulo to set.
1057  :type inputOption: int
1058  :rtype: None
1059  """
1060 
1061  controlLoop = self
1062  return _wrap_routine(_iron_python.cmfe_ControlLoop_TimeInputSet, [controlLoop, inputOption])
1063 
1064  def TimeOutputSet(self, outputFrequency):
1065  """Sets/changes the output parameters for a time control loop identified by an object.
1066 
1067  :param outputFrequency: The output frequency modulo to set.
1068  :type outputFrequency: int
1069  :rtype: None
1070  """
1071 
1072  controlLoop = self
1073  return _wrap_routine(_iron_python.cmfe_ControlLoop_TimeOutputSet, [controlLoop, outputFrequency])
1074 
1075  def TimesGet(self):
1076  """Returns the time parameters for a time control loop identified by an object.
1077 
1078  :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)
1079  :rtype: tuple. (float, float, float, float, int, int)
1080  """
1081 
1082  controlLoop = self
1083  return _wrap_routine(_iron_python.cmfe_ControlLoop_TimesGet, [controlLoop])
1084 
1085  def TimesSet(self, startTime, stopTime, timeIncrement):
1086  """Sets/changes the time parameters for a time control loop identified by an object.
1087 
1088  :param startTime: The start time for the time control loop to set.
1089  :type startTime: float
1090  :param stopTime: The stop time for the time control loop to set.
1091  :type stopTime: float
1092  :param timeIncrement: The time increment for the time control loop to set.
1093  :type timeIncrement: float
1094  :rtype: None
1095  """
1096 
1097  controlLoop = self
1098  return _wrap_routine(_iron_python.cmfe_ControlLoop_TimesSet, [controlLoop, startTime, stopTime, timeIncrement])
1099 
1100  def TypeSet(self, loopType):
1101  """Sets/changes the loop type for a control loop identified by an object. \todo is this really public???
1102 
1103  :param loopType: The type of control loop to set. Must be a value from the ProblemControlLoopTypes enum.
1104  :type loopType: int
1105  :rtype: None
1106  """
1107 
1108  controlLoop = self
1109  return _wrap_routine(_iron_python.cmfe_ControlLoop_TypeSet, [controlLoop, loopType])
1110 
1111  numberOfIterations = property(NumberOfIterationsGet, NumberOfIterationsSet, None, """The number of iterations for a time control loop identified by an object.""")
1112 
1113  absoluteTolerance = property(None, AbsoluteToleranceSet, None, """The maximum iterations for a while control loop identified by an object.""")
1114 
1115  timeOutput = property(None, TimeOutputSet, None, """The output parameters for a time control loop identified by an object.""")
1116 
1117  timeInput = property(None, TimeInputSet, None, """The input parameters for a time control loop identified by an object.""")
1118 
1119  outputType = property(OutputTypeGet, OutputTypeSet, None, """The output type for a control loop identified by an object.""")
1120 
1121  label = property(LabelGet, LabelSet, None, """The character string label for a control loop identified by an object.""")
1122 
1123  loadOutput = property(None, LoadOutputSet, None, """The output parameters for a load control loop identified by an object.""")
1124 
1125  numberOfSubLoops = property(NumberOfSubLoopsGet, NumberOfSubLoopsSet, None, """The number of sub-control loops for a control loop identified by an object.""")
1126 
1127  type = property(None, TypeSet, None, """The loop type for a control loop identified by an object. \todo is this really public???""")
1128 
1129  maximumIterations = property(None, MaximumIterationsSet, None, """The maximum iterations for a while control loop identified by an object.""")
1130 
1131 
1132 class CoordinateSystem(CMFEType):
1133  """Contains information on a coordinate system.
1134  """
1135 
1136  def __init__(self):
1137  """Initialise a null cmfe_CoordinateSystemType"""
1138 
1139  self.cmiss_type = _wrap_routine(_iron_python.cmfe_CoordinateSystem_Initialise, None)
1140 
1141  def CreateFinish(self):
1142  """Finishes the creation of a coordinate system identified by an object.
1143 
1144  :rtype: None
1145  """
1146 
1147  coordinateSystem = self
1148  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_CreateFinish, [coordinateSystem])
1149 
1150  def CreateStart(self, coordinateSystemUserNumber):
1151  """Starts the creation of a coordinate system identified by an object.
1152 
1153  :param coordinateSystemUserNumber: The user number of the coordinate system to start creating.
1154  :type coordinateSystemUserNumber: int
1155  :rtype: None
1156  """
1157 
1158  coordinateSystem = self
1159  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_CreateStart, [coordinateSystemUserNumber, coordinateSystem])
1160 
1161  def Destroy(self):
1162  """Destroys a coordinate system identified by an object.
1163 
1164  :rtype: None
1165  """
1166 
1167  coordinateSystem = self
1168  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_Destroy, [coordinateSystem])
1169 
1170  def DimensionGet(self):
1171  """Returns the dimension of a coordinate system identified by an object.
1172 
1173  :returns: coordinateSystemDimension. The dimension of the coordinate system.
1174  :rtype: int
1175  """
1176 
1177  coordinateSystem = self
1178  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_DimensionGet, [coordinateSystem])
1179 
1180  def DimensionSet(self, coordinateSystemDimension):
1181  """Sets/changes the dimension of a coordinate system identified by an object.
1182 
1183  :param coordinateSystemDimension: The dimension of the coordinate system to set.
1184  :type coordinateSystemDimension: int
1185  :rtype: None
1186  """
1187 
1188  coordinateSystem = self
1189  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_DimensionSet, [coordinateSystem, coordinateSystemDimension])
1190 
1191  def Finalise(self):
1192  """Finalises a cmfe_CoordinateSystemType object.
1193 
1194  :rtype: None
1195  """
1196 
1197  cmfe_CoordinateSystem = self
1198  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_Finalise, [cmfe_CoordinateSystem])
1199 
1200  def FocusGet(self):
1201  """Returns the focus of a coordinate system identified by an object.
1202 
1203  :returns: focus. The focus of the coordinate system.
1204  :rtype: float
1205  """
1206 
1207  coordinateSystem = self
1208  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_FocusGet, [coordinateSystem])
1209 
1210  def FocusSet(self, focus):
1211  """Sets/changes the focus of a coordinate system identified by an object.
1212 
1213  :param focus: The focus of the coordinate system to set.
1214  :type focus: float
1215  :rtype: None
1216  """
1217 
1218  coordinateSystem = self
1219  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_FocusSet, [coordinateSystem, focus])
1220 
1221  def OrientationGet(self, orientationSizes):
1222  """Returns the orientation of a coordinate system identified by an object.
1223 
1224  :param orientationSizes: Tuple of dimensions of orientation to allocate, with length 2.
1225  :returns: orientation. The orientation of the coordinate system.
1226  :rtype: 2d array of floats
1227  """
1228 
1229  coordinateSystem = self
1230  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_OrientationGet, [coordinateSystem, orientationSizes])
1231 
1232  def OrientationSet(self, orientation):
1233  """Sets/changes the orientation of a coordinate system identified by an object.
1234 
1235  :param orientation: The orientation of the coordinate system to set.
1236  :type orientation: 2d array of floats
1237  :rtype: None
1238  """
1239 
1240  coordinateSystem = self
1241  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_OrientationSet, [coordinateSystem, orientation])
1242 
1243  def OriginGet(self, originSize):
1244  """Returns the origin of a coordinate system identified by an object.
1245 
1246  :param originSize: Size of origin to allocate.
1247  :returns: origin. The origin of the coordinate system.
1248  :rtype: Array of floats
1249  """
1250 
1251  coordinateSystem = self
1252  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_OriginGet, [coordinateSystem, originSize])
1253 
1254  def OriginSet(self, origin):
1255  """Sets/changes the origin of a coordinate system identified by an object.
1256 
1257  :param origin: The origin of the coordinate system to set.
1258  :type origin: Array of floats
1259  :rtype: None
1260  """
1261 
1262  coordinateSystem = self
1263  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_OriginSet, [coordinateSystem, origin])
1264 
1266  """Returns the radial interpolation type of a coordinate system identified by an object.
1267 
1268  :returns: radialInterpolationType. The radial interpolation type of the coordinate system. Will be a value from the CoordinateRadialInterpolations enum.
1269  :rtype: int
1270  """
1271 
1272  coordinateSystem = self
1273  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_RadialInterpolationGet, [coordinateSystem])
1274 
1275  def RadialInterpolationSet(self, radialInterpolationType):
1276  """Sets/changes the radial interpolation type of a coordinate system identified by an object.
1277 
1278  :param radialInterpolationType: The radial interpolation type of the coordinate system to set. Must be a value from the CoordinateRadialInterpolations enum.
1279  :type radialInterpolationType: int
1280  :rtype: None
1281  """
1282 
1283  coordinateSystem = self
1284  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_RadialInterpolationSet, [coordinateSystem, radialInterpolationType])
1285 
1286  def TypeGet(self):
1287  """Returns the type of a coordinate system identified by an object.
1288 
1289  :returns: coordinateSystemType. The type of the coordinate system. Will be a value from the CoordinateSystemTypes enum.
1290  :rtype: int
1291  """
1292 
1293  coordinateSystem = self
1294  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_TypeGet, [coordinateSystem])
1295 
1296  def TypeSet(self, coordinateSystemType):
1297  """Sets/changes the type of a coordinate system identified by an object.
1298 
1299  :param coordinateSystemType: The type of the coordinate system to set. Must be a value from the CoordinateSystemTypes enum.
1300  :type coordinateSystemType: int
1301  :rtype: None
1302  """
1303 
1304  coordinateSystem = self
1305  return _wrap_routine(_iron_python.cmfe_CoordinateSystem_TypeSet, [coordinateSystem, coordinateSystemType])
1306 
1307  origin = property(OriginGet, OriginSet, None, """The origin of a coordinate system identified by an object.""")
1308 
1309  radialInterpolation = property(RadialInterpolationGet, RadialInterpolationSet, None, """The radial interpolation type of a coordinate system identified by an object.""")
1310 
1311  orientation = property(OrientationGet, OrientationSet, None, """The orientation of a coordinate system identified by an object.""")
1312 
1313  focus = property(FocusGet, FocusSet, None, """The focus of a coordinate system identified by an object.""")
1314 
1315  type = property(TypeGet, TypeSet, None, """The type of a coordinate system identified by an object.""")
1316 
1317  dimension = property(DimensionGet, DimensionSet, None, """The dimension of a coordinate system identified by an object.""")
1318 
1319 
1320 class DataPoints(CMFEType):
1321  """Contains information on the data points defined on a region.
1322  """
1323 
1324  def __init__(self):
1325  """Initialise a null cmfe_DataPointsType"""
1326 
1327  self.cmiss_type = _wrap_routine(_iron_python.cmfe_DataPoints_Initialise, None)
1328 
1329  def CreateFinish(self):
1330  """Finishes the creation of a data points in a region for data points identified by an object.
1331 
1332  :rtype: None
1333  """
1334 
1335  dataPoints = self
1336  return _wrap_routine(_iron_python.cmfe_DataPoints_CreateFinish, [dataPoints])
1337 
1338  def CreateStartInterface(self, interface, numberOfDataPoints):
1339  """Starts the creation of a data points in a region for data points identified by an object.
1340 
1341  :param interface: The interface to start the creation of data points on.
1342  :type interface: Interface
1343  :param numberOfDataPoints: The number of data points to create.
1344  :type numberOfDataPoints: int
1345  :rtype: None
1346  """
1347 
1348  dataPoints = self
1349  return _wrap_routine(_iron_python.cmfe_DataPoints_CreateStartInterface, [interface, numberOfDataPoints, dataPoints])
1350 
1351  def CreateStart(self, region, numberOfDataPoints):
1352  """Starts the creation of a data points in a region for data points identified by an object.
1353 
1354  :param region: The region to start the creation of data points on.
1355  :type region: Region
1356  :param numberOfDataPoints: The number of data points to create.
1357  :type numberOfDataPoints: int
1358  :rtype: None
1359  """
1360 
1361  dataPoints = self
1362  return _wrap_routine(_iron_python.cmfe_DataPoints_CreateStart, [region, numberOfDataPoints, dataPoints])
1363 
1364  def Destroy(self):
1365  """Destroys the data points in a region for data points identified by an object.
1366 
1367  :rtype: None
1368  """
1369 
1370  dataPoints = self
1371  return _wrap_routine(_iron_python.cmfe_DataPoints_Destroy, [dataPoints])
1372 
1373  def Finalise(self):
1374  """Finalises a cmfe_DataPointsType object.
1375 
1376  :rtype: None
1377  """
1378 
1379  cmfe_DataPoints = self
1380  return _wrap_routine(_iron_python.cmfe_DataPoints_Finalise, [cmfe_DataPoints])
1381 
1382  def LabelGet(self, dataPointGlobalNumber):
1383  """Returns the character label for a data point in a set of data points identified by an object.
1384 
1385  :param dataPointGlobalNumber: The global number of the data points to get the label for.
1386  :type dataPointGlobalNumber: int
1387  :returns: label. The label for the data point.
1388  :rtype: string
1389  """
1390 
1391  dataPoints = self
1392  return _wrap_routine(_iron_python.cmfe_DataPoints_LabelGet, [dataPoints, dataPointGlobalNumber])
1393 
1394  def LabelSet(self, dataPointGlobalNumber, label):
1395  """Sets/changes the character label for a data point in a set of data points identified by an object.
1396 
1397  :param dataPointGlobalNumber: The global number of the data points to set the label for.
1398  :type dataPointGlobalNumber: int
1399  :param label: The label for the data point to set.
1400  :type label: string
1401  :rtype: None
1402  """
1403 
1404  dataPoints = self
1405  return _wrap_routine(_iron_python.cmfe_DataPoints_LabelSet, [dataPoints, dataPointGlobalNumber, label])
1406 
1408  """Returns the number of data points
1409 
1410  :returns: numberOfDataPoints. The number of data points
1411  :rtype: int
1412  """
1413 
1414  dataPoints = self
1415  return _wrap_routine(_iron_python.cmfe_DataPoints_NumberOfDataPointsGet, [dataPoints])
1416 
1417  def UserNumberGet(self, dataPointGlobalNumber):
1418  """Returns the user number for a data point in a set of data points identified by an object.
1419 
1420  :param dataPointGlobalNumber: The global number of the data points to get the data point user number for.
1421  :type dataPointGlobalNumber: int
1422  :returns: dataPointUserNumber. The user number for the data point.
1423  :rtype: int
1424  """
1425 
1426  dataPoints = self
1427  return _wrap_routine(_iron_python.cmfe_DataPoints_UserNumberGet, [dataPoints, dataPointGlobalNumber])
1428 
1429  def UserNumberSet(self, dataPointGlobalNumber, dataPointUserNumber):
1430  """Sets/changes the user number for a data point in a set of data points identified by an object.
1431 
1432  :param dataPointGlobalNumber: The global number of the data points to set the data point user number for.
1433  :type dataPointGlobalNumber: int
1434  :param dataPointUserNumber: The user number for the data point to set.
1435  :type dataPointUserNumber: int
1436  :rtype: None
1437  """
1438 
1439  dataPoints = self
1440  return _wrap_routine(_iron_python.cmfe_DataPoints_UserNumberSet, [dataPoints, dataPointGlobalNumber, dataPointUserNumber])
1441 
1442  def ValuesGet(self, dataPointGlobalNumber, dataPointValuesSize):
1443  """Returns the values for a data point in a set of data points identified by an object.
1444 
1445  :param dataPointGlobalNumber: The global number of the data points to get the data point user number for.
1446  :type dataPointGlobalNumber: int
1447  :param dataPointValuesSize: Size of dataPointValues to allocate.
1448  :returns: dataPointValues. The values for the data point.
1449  :rtype: Array of floats
1450  """
1451 
1452  dataPoints = self
1453  return _wrap_routine(_iron_python.cmfe_DataPoints_ValuesGet, [dataPoints, dataPointGlobalNumber, dataPointValuesSize])
1454 
1455  def ValuesSet(self, dataPointGlobalNumber, dataPointValues):
1456  """Sets/changes the values for a data point in a set of data points identified by an object.
1457 
1458  :param dataPointGlobalNumber: The global number of the data points to set the data point user number for.
1459  :type dataPointGlobalNumber: int
1460  :param dataPointValues: The values for the data point to set.
1461  :type dataPointValues: Array of floats
1462  :rtype: None
1463  """
1464 
1465  dataPoints = self
1466  return _wrap_routine(_iron_python.cmfe_DataPoints_ValuesSet, [dataPoints, dataPointGlobalNumber, dataPointValues])
1467 
1468  def WeightsGet(self, dataPointGlobalNumber, dataPointWeightsSize):
1469  """Returns the weights for a data point in a set of data points identified by an object.
1470 
1471  :param dataPointGlobalNumber: The global number of the data points to get the data point user number for.
1472  :type dataPointGlobalNumber: int
1473  :param dataPointWeightsSize: Size of dataPointWeights to allocate.
1474  :returns: dataPointWeights. The weights for the data point.
1475  :rtype: Array of floats
1476  """
1477 
1478  dataPoints = self
1479  return _wrap_routine(_iron_python.cmfe_DataPoints_WeightsGet, [dataPoints, dataPointGlobalNumber, dataPointWeightsSize])
1480 
1481  def WeightsSet(self, dataPointGlobalNumber, dataPointWeights):
1482  """Sets/changes the weights for a data point in a set of data points identified by an object.
1483 
1484  :param dataPointGlobalNumber: The global number of the data points to set the data point user number for.
1485  :type dataPointGlobalNumber: int
1486  :param dataPointWeights: The weights for the data point to set.
1487  :type dataPointWeights: Array of floats
1488  :rtype: None
1489  """
1490 
1491  dataPoints = self
1492  return _wrap_routine(_iron_python.cmfe_DataPoints_WeightsSet, [dataPoints, dataPointGlobalNumber, dataPointWeights])
1493 
1494  numberOfDataPoints = property(NumberOfDataPointsGet, None, None, """The number of data points""")
1495 
1496 
1497 class DataProjection(CMFEType):
1498  """Contains information about a data projection.
1499  """
1500 
1501  def __init__(self):
1502  """Initialise a null cmfe_DataProjectionType"""
1503 
1504  self.cmiss_type = _wrap_routine(_iron_python.cmfe_DataProjection_Initialise, None)
1505 
1507  """Returns the absolute tolerance of data projection identified an object.
1508 
1509  :returns: absoluteTolerance. On exit, the absolute tolerance of the specified data projection
1510  :rtype: float
1511  """
1512 
1513  dataProjection = self
1514  return _wrap_routine(_iron_python.cmfe_DataProjection_AbsoluteToleranceGet, [dataProjection])
1515 
1516  def AbsoluteToleranceSet(self, absoluteTolerance):
1517  """Sets/changes the absolute tolerance of data projection identified an object.
1518 
1519  :param absoluteTolerance: the absolute tolerance to set
1520  :type absoluteTolerance: float
1521  :rtype: None
1522  """
1523 
1524  dataProjection = self
1525  return _wrap_routine(_iron_python.cmfe_DataProjection_AbsoluteToleranceSet, [dataProjection, absoluteTolerance])
1526 
1527  def CreateFinish(self):
1528  """Finishes the creation of a new data projection identified by an object.
1529 
1530  :rtype: None
1531  """
1532 
1533  dataProjection = self
1534  return _wrap_routine(_iron_python.cmfe_DataProjection_CreateFinish, [dataProjection])
1535 
1536  def CreateStart(self, dataProjectionUserNumber, dataPoints, mesh):
1537  """Starts the creation of a new data projection for a data projection identified by an object.
1538 
1539  :param dataProjectionUserNumber: The data projection user number.
1540  :type dataProjectionUserNumber: int
1541  :param dataPoints: The data points to be projected
1542  :type dataPoints: DataPoints
1543  :param mesh: The mesh where data points is projected on
1544  :type mesh: Mesh
1545  :rtype: None
1546  """
1547 
1548  dataProjection = self
1549  return _wrap_routine(_iron_python.cmfe_DataProjection_CreateStart, [dataProjectionUserNumber, dataPoints, mesh, dataProjection])
1550 
1551  def DataPointsPositionEvaluate(self, field, fieldVariableType):
1552  """Evaluate the data points position in a field based on data projection, identified by object
1553 
1554  :param field: The field to interpolate
1555  :type field: Field
1556  :param fieldVariableType: The field variable type to be interpolated
1557  :type fieldVariableType: int
1558  :rtype: None
1559  """
1560 
1561  dataProjection = self
1562  return _wrap_routine(_iron_python.cmfe_DataProjection_DataPointsPositionEvaluate, [dataProjection, field, fieldVariableType])
1563 
1564  def DataPointsProjectionEvaluate(self, projectionField):
1565  """Evaluate a data projection identified by an object.
1566 
1567  :param projectionField: The field data points is projected on
1568  :type projectionField: Field
1569  :rtype: None
1570  """
1571 
1572  dataProjection = self
1573  return _wrap_routine(_iron_python.cmfe_DataProjection_DataPointsProjectionEvaluate, [dataProjection, projectionField])
1574 
1575  def Destroy(self):
1576  """Destroys a data projection identified by an object.
1577 
1578  :rtype: None
1579  """
1580 
1581  dataProjection = self
1582  return _wrap_routine(_iron_python.cmfe_DataProjection_Destroy, [dataProjection])
1583 
1584  def ElementSet(self, dataPointNumber, elementNumber):
1585  """Sets/changes the starting xi of data projection identified an object.
1586 
1587  :param dataPointNumber: The data point number to set xi position for
1588  :type dataPointNumber: int
1589  :param elementNumber: the element number to set
1590  :type elementNumber: int
1591  :rtype: None
1592  """
1593 
1594  dataProjection = self
1595  return _wrap_routine(_iron_python.cmfe_DataProjection_ElementSet, [dataProjection, dataPointNumber, elementNumber])
1596 
1597  def Finalise(self):
1598  """Finalises a cmfe_DataProjectionType object.
1599 
1600  :rtype: None
1601  """
1602 
1603  cmfe_DataProjection = self
1604  return _wrap_routine(_iron_python.cmfe_DataProjection_Finalise, [cmfe_DataProjection])
1605 
1606  def LabelGet(self):
1607  """Gets the character string label of a data projection identified an object.
1608 
1609  :returns: label. the label to get
1610  :rtype: string
1611  """
1612 
1613  dataProjection = self
1614  return _wrap_routine(_iron_python.cmfe_DataProjection_LabelGet, [dataProjection])
1615 
1616  def LabelSet(self, label):
1617  """Sets/changes the character string label of a data projection identified an object.
1618 
1619  :param label: the label to set
1620  :type label: string
1621  :rtype: None
1622  """
1623 
1624  dataProjection = self
1625  return _wrap_routine(_iron_python.cmfe_DataProjection_LabelSet, [dataProjection, label])
1626 
1628  """Returns the relative tolerance of data projection identified an object.
1629 
1630  :returns: maximumIterationUpdate. On exit, the maximum iteration update of the specified data projection
1631  :rtype: float
1632  """
1633 
1634  dataProjection = self
1635  return _wrap_routine(_iron_python.cmfe_DataProjection_MaximumIterationUpdateGet, [dataProjection])
1636 
1637  def MaximumIterationUpdateSet(self, maximumIterationUpdate):
1638  """Sets/changes the relative tolerance of data projection identified an object.
1639 
1640  :param maximumIterationUpdate: the maximum iteration update to set
1641  :type maximumIterationUpdate: float
1642  :rtype: None
1643  """
1644 
1645  dataProjection = self
1646  return _wrap_routine(_iron_python.cmfe_DataProjection_MaximumIterationUpdateSet, [dataProjection, maximumIterationUpdate])
1647 
1649  """Returns the maximum number of iterations of data projection identified an object.
1650 
1651  :returns: maximumNumberOfIterations. On exit, the maximum number of iterations of the specified data projection
1652  :rtype: int
1653  """
1654 
1655  dataProjection = self
1656  return _wrap_routine(_iron_python.cmfe_DataProjection_MaximumNumberOfIterationsGet, [dataProjection])
1657 
1658  def MaximumNumberOfIterationsSet(self, maximumNumberOfIterations):
1659  """Sets/changes the maximum number of iterations of data projection identified an object.
1660 
1661  :param maximumNumberOfIterations: the maximum number of iterations to set
1662  :type maximumNumberOfIterations: int
1663  :rtype: None
1664  """
1665 
1666  dataProjection = self
1667  return _wrap_routine(_iron_python.cmfe_DataProjection_MaximumNumberOfIterationsSet, [dataProjection, maximumNumberOfIterations])
1668 
1670  """Returns the number of closest elements of data projection identified an object.
1671 
1672  :returns: numberOfClosestElements. On exit, the number of closest elements of the specified data projection
1673  :rtype: int
1674  """
1675 
1676  dataProjection = self
1677  return _wrap_routine(_iron_python.cmfe_DataProjection_NumberOfClosestElementsGet, [dataProjection])
1678 
1679  def NumberOfClosestElementsSet(self, numberOfClosestElements):
1680  """Sets/changes the number of closest elements of data projection identified an object.
1681 
1682  :param numberOfClosestElements: the number of closest elements to set
1683  :type numberOfClosestElements: int
1684  :rtype: None
1685  """
1686 
1687  dataProjection = self
1688  return _wrap_routine(_iron_python.cmfe_DataProjection_NumberOfClosestElementsSet, [dataProjection, numberOfClosestElements])
1689 
1690  def ProjectionCandidatesSet(self, candidateElements, localFaceLineNumbers):
1691  """Evaluate the data points position in a field based on data projection, identified by object
1692 
1693  :param candidateElements: The candidate element for the projection
1694  :type candidateElements: Array of ints
1695  :param localFaceLineNumbers: The local face/line number for the candidate elements
1696  :type localFaceLineNumbers: Array of ints
1697  :rtype: None
1698  """
1699 
1700  dataProjection = self
1701  return _wrap_routine(_iron_python.cmfe_DataProjection_ProjectionCandidatesSet, [dataProjection, candidateElements, localFaceLineNumbers])
1702 
1704  """Returns the projection type of data projection identified an object.
1705 
1706  :returns: projectionType. On exit, the projection type of the specified data projection
1707  :rtype: int
1708  """
1709 
1710  dataProjection = self
1711  return _wrap_routine(_iron_python.cmfe_DataProjection_ProjectionTypeGet, [dataProjection])
1712 
1713  def ProjectionTypeSet(self, projectionType):
1714  """Sets/changes the projection type of data projection identified an object.
1715 
1716  :param projectionType: the projection type to set
1717  :type projectionType: int
1718  :rtype: None
1719  """
1720 
1721  dataProjection = self
1722  return _wrap_routine(_iron_python.cmfe_DataProjection_ProjectionTypeSet, [dataProjection, projectionType])
1723 
1725  """Returns the relative tolerance of data projection identified an object.
1726 
1727  :returns: relativeTolerance. On exit, the absolute relative tolerance of the specified data projection
1728  :rtype: float
1729  """
1730 
1731  dataProjection = self
1732  return _wrap_routine(_iron_python.cmfe_DataProjection_RelativeToleranceGet, [dataProjection])
1733 
1734  def RelativeToleranceSet(self, relativeTolerance):
1735  """Sets/changes the relative tolerance of data projection identified an object.
1736 
1737  :param relativeTolerance: the absolute relative tolerance to set
1738  :type relativeTolerance: float
1739  :rtype: None
1740  """
1741 
1742  dataProjection = self
1743  return _wrap_routine(_iron_python.cmfe_DataProjection_RelativeToleranceSet, [dataProjection, relativeTolerance])
1744 
1745  def ResultDistanceGet(self, dataPointUserNumber):
1746  """Returns the projection distance for a data point in a set of data points identified by an object.
1747 
1748  :param dataPointUserNumber: The user number of the data points to get attributes for.
1749  :type dataPointUserNumber: int
1750  :returns: ProjectionDistance. The projection distance for the data point.
1751  :rtype: float
1752  """
1753 
1754  dataProjection = self
1755  return _wrap_routine(_iron_python.cmfe_DataProjection_ResultDistanceGet, [dataProjection, dataPointUserNumber])
1756 
1757  def ResultElementFaceNumberGet(self, dataPointUserNumber):
1758  """Returns the projection element face number for a data point in a set of data points identified by an object.
1759 
1760  :param dataPointUserNumber: The user number of the data points to get attributes for.
1761  :type dataPointUserNumber: int
1762  :returns: ProjectionElementFaceNumber. The projection element face number for the data point.
1763  :rtype: int
1764  """
1765 
1766  dataProjection = self
1767  return _wrap_routine(_iron_python.cmfe_DataProjection_ResultElementFaceNumberGet, [dataProjection, dataPointUserNumber])
1768 
1769  def ResultElementLineNumberGet(self, dataPointUserNumber):
1770  """Returns the projection element line number for a data point in a set of data points identified by an object.
1771 
1772  :param dataPointUserNumber: The user number of the data points to get attributes for.
1773  :type dataPointUserNumber: int
1774  :returns: ProjectionElementLineNumber. The projection element line number for the data point.
1775  :rtype: int
1776  """
1777 
1778  dataProjection = self
1779  return _wrap_routine(_iron_python.cmfe_DataProjection_ResultElementLineNumberGet, [dataProjection, dataPointUserNumber])
1780 
1781  def ResultElementNumberGet(self, dataPointUserNumber):
1782  """Returns the projection element number for a data point in a set of data points identified by an object.
1783 
1784  :param dataPointUserNumber: The user number of the data points to get attributes for.
1785  :type dataPointUserNumber: int
1786  :returns: ProjectionElementNumber. The projection element number for the data point.
1787  :rtype: int
1788  """
1789 
1790  dataProjection = self
1791  return _wrap_routine(_iron_python.cmfe_DataProjection_ResultElementNumberGet, [dataProjection, dataPointUserNumber])
1792 
1793  def ResultExitTagGet(self, dataPointUserNumber):
1794  """Returns the projection exit tag for a data point in a set of data points identified by an object.
1795 
1796  :param dataPointUserNumber: The user number of the data points to get attributes for.
1797  :type dataPointUserNumber: int
1798  :returns: ProjectionExitTag. The projection exit tag for the data point.
1799  :rtype: int
1800  """
1801 
1802  dataProjection = self
1803  return _wrap_routine(_iron_python.cmfe_DataProjection_ResultExitTagGet, [dataProjection, dataPointUserNumber])
1804 
1805  def ResultProjectionVectorGet(self, dataPointUserNumber, projectionVectorSize):
1806  """Returns the projection vector for a data point in a set of data points identified by an object.
1807 
1808  :param dataPointUserNumber: The user number of the data points to get attributes for.
1809  :type dataPointUserNumber: int
1810  :param projectionVectorSize: Size of projectionVector to allocate.
1811  :returns: projectionVector. The projection vector for the data point.
1812  :rtype: Array of floats
1813  """
1814 
1815  dataProjection = self
1816  return _wrap_routine(_iron_python.cmfe_DataProjection_ResultProjectionVectorGet, [dataProjection, dataPointUserNumber, projectionVectorSize])
1817 
1818  def ResultXiGet(self, dataPointUserNumber, ProjectionXiSize):
1819  """Returns the projection xi for a data point in a set of data points identified by an object.
1820 
1821  :param dataPointUserNumber: The user number of the data points to get attributes for.
1822  :type dataPointUserNumber: int
1823  :param ProjectionXiSize: Size of ProjectionXi to allocate.
1824  :returns: ProjectionXi. The projection xi for the data point.
1825  :rtype: Array of floats
1826  """
1827 
1828  dataProjection = self
1829  return _wrap_routine(_iron_python.cmfe_DataProjection_ResultXiGet, [dataProjection, dataPointUserNumber, ProjectionXiSize])
1830 
1831  def ResultXiSet(self, dataPointUserNumber, ProjectionXi):
1832  """Sets the projection xi for a data point in a set of data points identified by an object.
1833 
1834  :param dataPointUserNumber: The user number of the data points to set attributes for
1835  :type dataPointUserNumber: int
1836  :param ProjectionXi: On return, the projection xi for the data point.
1837  :type ProjectionXi: Array of floats
1838  :rtype: None
1839  """
1840 
1841  dataProjection = self
1842  return _wrap_routine(_iron_python.cmfe_DataProjection_ResultXiSet, [dataProjection, dataPointUserNumber, ProjectionXi])
1843 
1844  def StartingXiGet(self, startingXiSize):
1845  """Returns the starting xi of data projection identified an object.
1846 
1847  :param startingXiSize: Size of startingXi to allocate.
1848  :returns: startingXi. On exit, the absolute starting xi of the specified data projection
1849  :rtype: Array of floats
1850  """
1851 
1852  dataProjection = self
1853  return _wrap_routine(_iron_python.cmfe_DataProjection_StartingXiGet, [dataProjection, startingXiSize])
1854 
1855  def StartingXiSet(self, startingXi):
1856  """Sets/changes the starting xi of data projection identified an object.
1857 
1858  :param startingXi: the absolute starting xi to set
1859  :type startingXi: Array of floats
1860  :rtype: None
1861  """
1862 
1863  dataProjection = self
1864  return _wrap_routine(_iron_python.cmfe_DataProjection_StartingXiSet, [dataProjection, startingXi])
1865 
1866  maximumNumberOfIterations = property(MaximumNumberOfIterationsGet, MaximumNumberOfIterationsSet, None, """The maximum number of iterations of data projection identified an object.""")
1867 
1868  absoluteTolerance = property(AbsoluteToleranceGet, AbsoluteToleranceSet, None, """The absolute tolerance of data projection identified an object.""")
1869 
1870  label = property(LabelGet, LabelSet, None, """The character string label of a data projection identified an object.""")
1871 
1872  maximumIterationUpdate = property(MaximumIterationUpdateGet, MaximumIterationUpdateSet, None, """The relative tolerance of data projection identified an object.""")
1873 
1874  numberOfClosestElements = property(NumberOfClosestElementsGet, NumberOfClosestElementsSet, None, """The number of closest elements of data projection identified an object.""")
1875 
1876  projectionType = property(ProjectionTypeGet, ProjectionTypeSet, None, """The projection type of data projection identified an object.""")
1877 
1878  startingXi = property(StartingXiGet, StartingXiSet, None, """The starting xi of data projection identified an object.""")
1879 
1880  relativeTolerance = property(RelativeToleranceGet, RelativeToleranceSet, None, """The relative tolerance of data projection identified an object.""")
1881 
1882 
1883 class Decomposition(CMFEType):
1884  """Contains information on the mesh decomposition.
1885  """
1886 
1887  def __init__(self):
1888  """Initialise a null cmfe_DecompositionType"""
1889 
1890  self.cmiss_type = _wrap_routine(_iron_python.cmfe_Decomposition_Initialise, None)
1891 
1892  def CalculateFacesSet(self, calculateFacesFlag):
1893  """Sets whether faces should be calculated
1894 
1895  :param calculateFacesFlag: Boolean to determine whether to set faces to be calculated.
1896  :type calculateFacesFlag: bool
1897  :rtype: None
1898  """
1899 
1900  decomposition = self
1901  return _wrap_routine(_iron_python.cmfe_Decomposition_CalculateFacesSet, [decomposition, calculateFacesFlag])
1902 
1903  def CalculateLinesSet(self, calculateLinesFlag):
1904  """Sets whether lines should be calculated
1905 
1906  :param calculateLinesFlag: Boolean to determine whether to set lines to be calculated.
1907  :type calculateLinesFlag: bool
1908  :rtype: None
1909  """
1910 
1911  decomposition = self
1912  return _wrap_routine(_iron_python.cmfe_Decomposition_CalculateLinesSet, [decomposition, calculateLinesFlag])
1913 
1914  def CreateFinish(self):
1915  """Finishes the creation of a domain decomposition for a decomposition identified by an object.
1916 
1917  :rtype: None
1918  """
1919 
1920  decomposition = self
1921  return _wrap_routine(_iron_python.cmfe_Decomposition_CreateFinish, [decomposition])
1922 
1923  def CreateStart(self, decompositionUserNumber, mesh):
1924  """Starts the creation of a domain decomposition for a decomposition identified by an object.
1925 
1926  :param decompositionUserNumber: The user number of the decomposition to create.
1927  :type decompositionUserNumber: int
1928  :param mesh: The mesh to create the decomposition for.
1929  :type mesh: Mesh
1930  :rtype: None
1931  """
1932 
1933  decomposition = self
1934  return _wrap_routine(_iron_python.cmfe_Decomposition_CreateStart, [decompositionUserNumber, mesh, decomposition])
1935 
1936  def Destroy(self):
1937  """Destroys a decomposition identified by an object.
1938 
1939  :rtype: None
1940  """
1941 
1942  decomposition = self
1943  return _wrap_routine(_iron_python.cmfe_Decomposition_Destroy, [decomposition])
1944 
1946  """Calculates the element domains for a decomposition identified by an object.
1947 
1948  :rtype: None
1949  """
1950 
1951  decomposition = self
1952  return _wrap_routine(_iron_python.cmfe_Decomposition_ElementDomainCalculate, [decomposition])
1953 
1954  def ElementDomainGet(self, elementUserNumber):
1955  """Returns the domain for a given element in a decomposition identified by an object.
1956 
1957  :param elementUserNumber: The user number of the element to get the domain for.
1958  :type elementUserNumber: int
1959  :returns: domain. The computational domain of the element.
1960  :rtype: int
1961  """
1962 
1963  decomposition = self
1964  return _wrap_routine(_iron_python.cmfe_Decomposition_ElementDomainGet, [decomposition, elementUserNumber])
1965 
1966  def ElementDomainSet(self, elementUserNumber, domain):
1967  """Sets/changes the domain for a given element in a decomposition identified by an object.
1968 
1969  :param elementUserNumber: The user number of the element to set the domain for.
1970  :type elementUserNumber: int
1971  :param domain: The computational domain of the element to set.
1972  :type domain: int
1973  :rtype: None
1974  """
1975 
1976  decomposition = self
1977  return _wrap_routine(_iron_python.cmfe_Decomposition_ElementDomainSet, [decomposition, elementUserNumber, domain])
1978 
1979  def Finalise(self):
1980  """Finalises a cmfe_DecompositionType object.
1981 
1982  :rtype: None
1983  """
1984 
1985  cmfe_Decomposition = self
1986  return _wrap_routine(_iron_python.cmfe_Decomposition_Finalise, [cmfe_Decomposition])
1987 
1988  def MeshComponentGet(self):
1989  """Returns the mesh component number used for the decomposition of a mesh for a decomposition identified by an object.
1990 
1991  :returns: meshComponentNumber. The mesh component number for the decomposition.
1992  :rtype: int
1993  """
1994 
1995  decomposition = self
1996  return _wrap_routine(_iron_python.cmfe_Decomposition_MeshComponentGet, [decomposition])
1997 
1998  def MeshComponentSet(self, meshComponentNumber):
1999  """Sets/changes the mesh component number used for the decomposition of a mesh for a decomposition identified by an object.
2000 
2001  :param meshComponentNumber: The mesh component number for the decomposition to set.
2002  :type meshComponentNumber: int
2003  :rtype: None
2004  """
2005 
2006  decomposition = self
2007  return _wrap_routine(_iron_python.cmfe_Decomposition_MeshComponentSet, [decomposition, meshComponentNumber])
2008 
2009  def NodeDomainGet(self, nodeUserNumber, meshComponentNumber):
2010  """Returns the domain for a given node in a decomposition identified by an object. \todo Maybe swap Node and MeshComponent?
2011 
2012  :param nodeUserNumber: The user number of the node to get the domain for.
2013  :type nodeUserNumber: int
2014  :param meshComponentNumber: The user number of the mesh component to get the domain for.
2015  :type meshComponentNumber: int
2016  :returns: domain. The computational domain of the node.
2017  :rtype: int
2018  """
2019 
2020  decomposition = self
2021  return _wrap_routine(_iron_python.cmfe_Decomposition_NodeDomainGet, [decomposition, nodeUserNumber, meshComponentNumber])
2022 
2024  """Returns the number of domains for a decomposition identified by an object.
2025 
2026  :returns: numberOfDomains. The number of domains in the decomposition.
2027  :rtype: int
2028  """
2029 
2030  decomposition = self
2031  return _wrap_routine(_iron_python.cmfe_Decomposition_NumberOfDomainsGet, [decomposition])
2032 
2033  def NumberOfDomainsSet(self, numberOfDomains):
2034  """Sets/changes the number of domains for a decomposition identified by an object.
2035 
2036  :param numberOfDomains: The number of domains in the decomposition to set.
2037  :type numberOfDomains: int
2038  :rtype: None
2039  """
2040 
2041  decomposition = self
2042  return _wrap_routine(_iron_python.cmfe_Decomposition_NumberOfDomainsSet, [decomposition, numberOfDomains])
2043 
2045  """Calculates the decomposition topology for data points
2046 
2047  :rtype: None
2048  """
2049 
2050  decomposition = self
2051  return _wrap_routine(_iron_python.cmfe_Decomposition_TopologyDataProjectionCalculate, [decomposition])
2052 
2053  def TopologyElementDataPointLocalNumberGet(self, elementNumber, dataPointIndex):
2054  """Gets the local data point number for data points projected on an element
2055 
2056  :param elementNumber: The element number to get the data point for
2057  :type elementNumber: int
2058  :param dataPointIndex: The data point index to get the number for
2059  :type dataPointIndex: int
2060  :returns: dataPointLocalNumber. The data point local number to retu
2061  :rtype: int
2062  """
2063 
2064  decomposition = self
2065  return _wrap_routine(_iron_python.cmfe_Decomposition_TopologyElementDataPointLocalNumberGet, [decomposition, elementNumber, dataPointIndex])
2066 
2067  def TopologyElementDataPointUserNumberGet(self, elementNumber, dataPointIndex):
2068  """Gets the user data point number for data points projected on an element
2069 
2070  :param elementNumber: The element number to get the data point for
2071  :type elementNumber: int
2072  :param dataPointIndex: The data point index to get the number for
2073  :type dataPointIndex: int
2074  :returns: dataPointUserNumber. The data point user number to retu
2075  :rtype: int
2076  """
2077 
2078  decomposition = self
2079  return _wrap_routine(_iron_python.cmfe_Decomposition_TopologyElementDataPointUserNumberGet, [decomposition, elementNumber, dataPointIndex])
2080 
2081  def TopologyNumberOfElementDataPointsGet(self, elementNumber):
2082  """Gets the number of data points projected on an element
2083 
2084  :param elementNumber: The element number to get the data point for
2085  :type elementNumber: int
2086  :returns: numberOfDataPoints. The data point local number to return
2087  :rtype: int
2088  """
2089 
2090  decomposition = self
2091  return _wrap_routine(_iron_python.cmfe_Decomposition_TopologyNumberOfElementDataPointsGet, [decomposition, elementNumber])
2092 
2093  def TypeGet(self):
2094  """Returns the type of a decomposition identified by an object.
2095 
2096  :returns: decompositionType. The type of the decomposition.
2097  :rtype: int
2098  """
2099 
2100  decomposition = self
2101  return _wrap_routine(_iron_python.cmfe_Decomposition_TypeGet, [decomposition])
2102 
2103  def TypeSet(self, decompositionType):
2104  """Sets/changes the type of a decomposition identified by an object.
2105 
2106  :param decompositionType: The type of the decomposition to set.
2107  :type decompositionType: int
2108  :rtype: None
2109  """
2110 
2111  decomposition = self
2112  return _wrap_routine(_iron_python.cmfe_Decomposition_TypeSet, [decomposition, decompositionType])
2113 
2114  def WorldWorkGroupSet(self, worldWorkGroup):
2115  """Set the working group tree in order to performe mesh decomposition
2116 
2117  :param worldWorkGroup:
2118  :type worldWorkGroup: ComputationalWorkGroup
2119  :rtype: None
2120  """
2121 
2122  decomposition = self
2123  return _wrap_routine(_iron_python.cmfe_Decomposition_WorldWorkGroupSet, [decomposition, worldWorkGroup])
2124 
2125  worldWorkGroup = property(None, WorldWorkGroupSet, None, """The working group tree in order to performe mesh decomposition""")
2126 
2127  calculateFaces = property(None, CalculateFacesSet, None, """Whether faces should be calculated""")
2128 
2129  type = property(TypeGet, TypeSet, None, """The type of a decomposition identified by an object.""")
2130 
2131  calculateLines = property(None, CalculateLinesSet, None, """Whether lines should be calculated""")
2132 
2133  numberOfDomains = property(NumberOfDomainsGet, NumberOfDomainsSet, None, """The number of domains for a decomposition identified by an object.""")
2134 
2135  meshComponent = property(MeshComponentGet, MeshComponentSet, None, """The mesh component number used for the decomposition of a mesh for a decomposition identified by an object.""")
2136 
2137 
2138 class DistributedMatrix(CMFEType):
2139  """A matrix that may be distributed across multiple computational nodes
2140  and may use sparse or full storage.
2141  """
2142 
2143  def __init__(self):
2144  """Initialise a null cmfe_DistributedMatrixType"""
2145 
2146  self.cmiss_type = _wrap_routine(_iron_python.cmfe_DistributedMatrix_Initialise, None)
2147 
2148  def DataGetDP(self):
2149  """Get the data array for this matrix on this computational node
2150 
2151  :param dataSize: Size of data to allocate.
2152  :returns: data. The matrix data
2153  :rtype: Array of floats
2154  """
2155 
2156  matrix = self
2157  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_DataGetDP, [matrix])
2158 
2159  def DataGetIntg(self):
2160  """Get the data array for this matrix on this computational node
2161 
2162  :param dataSize: Size of data to allocate.
2163  :returns: data. The matrix data
2164  :rtype: Array of ints
2165  """
2166 
2167  matrix = self
2168  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_DataGetIntg, [matrix])
2169 
2170  def DataGetL(self):
2171  """Get the data array for this matrix on this computational node
2172 
2173  :param dataSize: Size of data to allocate.
2174  :returns: data. The matrix data
2175  :rtype: Array of bools
2176  """
2177 
2178  matrix = self
2179  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_DataGetL, [matrix])
2180 
2181  def DataGetSP(self):
2182  """Get the data array for this matrix on this computational node
2183 
2184  :param dataSize: Size of data to allocate.
2185  :returns: data. The matrix data
2186  :rtype: Array of floats
2187  """
2188 
2189  matrix = self
2190  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_DataGetSP, [matrix])
2191 
2192  def DataRestoreDP(self, data):
2193  """Restore the data array for this matrix once it has finished being used
2194 
2195  :param data: On entry, a pointer to the matrix data. On return, a nullified pointer.
2196  :type data: Array of floats
2197  :rtype: None
2198  """
2199 
2200  matrix = self
2201  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_DataRestoreDP, [matrix, data])
2202 
2203  def DataRestoreIntg(self, data):
2204  """Restore the data array for this matrix once it has finished being used
2205 
2206  :param data: On entry, a pointer to the matrix data. On return, a nullified pointer.
2207  :type data: Array of ints
2208  :rtype: None
2209  """
2210 
2211  matrix = self
2212  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_DataRestoreIntg, [matrix, data])
2213 
2214  def DataRestoreL(self, data):
2215  """Restore the data array for this matrix once it has finished being used
2216 
2217  :param data: On entry, a pointer to the matrix data. On return, a nullified pointer.
2218  :type data: Array of bools
2219  :rtype: None
2220  """
2221 
2222  matrix = self
2223  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_DataRestoreL, [matrix, data])
2224 
2225  def DataRestoreSP(self, data):
2226  """Restore the data array for this matrix once it has finished being used
2227 
2228  :param data: On entry, a pointer to the matrix data. On return, a nullified pointer.
2229  :type data: Array of floats
2230  :rtype: None
2231  """
2232 
2233  matrix = self
2234  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_DataRestoreSP, [matrix, data])
2235 
2236  def DataTypeGet(self):
2237  """Get the data type of a distributed matrix
2238 
2239  :returns: dataType. The matrix data type. Will be a value from the MatrixVectorDataTypes enum.
2240  :rtype: int
2241  """
2242 
2243  matrix = self
2244  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_DataTypeGet, [matrix])
2245 
2246  def DimensionsGet(self):
2247  """Get the dimensions of a distributed matrix on this computational node
2248 
2249  :returns: (The number of rows for this computational node, The number of columns)
2250  :rtype: tuple. (int, int)
2251  """
2252 
2253  matrix = self
2254  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_DimensionsGet, [matrix])
2255 
2257  """Get the row indices and column indices for a sparse matrix
2258 
2259  :param rowIndicesSize: Size of rowIndices to allocate.
2260  :param columnIndicesSize: Size of columnIndices to allocate.
2261  :returns: (The matrix storage row indices, The matrix storage column indices)
2262  :rtype: tuple. (Array of ints, Array of ints)
2263  """
2264 
2265  matrix = self
2266  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_StorageLocationsGet, [matrix])
2267 
2268  def StorageTypeGet(self):
2269  """Get the storage type for a distributed matrix
2270 
2271  :returns: storageType. The matrix storage type. Will be a value from the MatrixStorageTypes enum.
2272  :rtype: int
2273  """
2274 
2275  matrix = self
2276  return _wrap_routine(_iron_python.cmfe_DistributedMatrix_StorageTypeGet, [matrix])
2277 
2278  dataType = property(DataTypeGet, None, None, """The data type of a distributed matrix""")
2279 
2280  storageType = property(StorageTypeGet, None, None, """The storage type for a distributed matrix""")
2281 
2282 
2283 class DistributedVector(CMFEType):
2284  """A vector that may be distributed across multiple computational nodes
2285  """
2286 
2287  def __init__(self):
2288  """Initialise a null cmfe_DistributedVectorType"""
2289 
2290  self.cmiss_type = _wrap_routine(_iron_python.cmfe_DistributedVector_Initialise, None)
2291 
2292  def DataGetDP(self):
2293  """Get the data array for this vector on this computational node
2294 
2295  :param dataSize: Size of data to allocate.
2296  :returns: data. The vector data
2297  :rtype: Array of floats
2298  """
2299 
2300  vector = self
2301  return _wrap_routine(_iron_python.cmfe_DistributedVector_DataGetDP, [vector])
2302 
2303  def DataGetIntg(self):
2304  """Get the data array for this vector on this computational node
2305 
2306  :param dataSize: Size of data to allocate.
2307  :returns: data. The vector data
2308  :rtype: Array of ints
2309  """
2310 
2311  vector = self
2312  return _wrap_routine(_iron_python.cmfe_DistributedVector_DataGetIntg, [vector])
2313 
2314  def DataGetL(self):
2315  """Get the data array for this vector on this computational node
2316 
2317  :param dataSize: Size of data to allocate.
2318  :returns: data. The vector data
2319  :rtype: Array of bools
2320  """
2321 
2322  vector = self
2323  return _wrap_routine(_iron_python.cmfe_DistributedVector_DataGetL, [vector])
2324 
2325  def DataGetSP(self):
2326  """Get the data array for this vector on this computational node
2327 
2328  :param dataSize: Size of data to allocate.
2329  :returns: data. The vector data
2330  :rtype: Array of floats
2331  """
2332 
2333  vector = self
2334  return _wrap_routine(_iron_python.cmfe_DistributedVector_DataGetSP, [vector])
2335 
2336  def DataRestoreDP(self, data):
2337  """Restore the data array for this vector once it has finished being used
2338 
2339  :param data: On entry, a pointer to the vector data. On return, a nullified pointer.
2340  :type data: Array of floats
2341  :rtype: None
2342  """
2343 
2344  vector = self
2345  return _wrap_routine(_iron_python.cmfe_DistributedVector_DataRestoreDP, [vector, data])
2346 
2347  def DataRestoreIntg(self, data):
2348  """Restore the data array for this vector once it has finished being used
2349 
2350  :param data: On entry, a pointer to the vector data. On return, a nullified pointer.
2351  :type data: Array of ints
2352  :rtype: None
2353  """
2354 
2355  vector = self
2356  return _wrap_routine(_iron_python.cmfe_DistributedVector_DataRestoreIntg, [vector, data])
2357 
2358  def DataRestoreL(self, data):
2359  """Restore the data array for this vector once it has finished being used
2360 
2361  :param data: On entry, a pointer to the vector data. On return, a nullified pointer.
2362  :type data: Array of bools
2363  :rtype: None
2364  """
2365 
2366  vector = self
2367  return _wrap_routine(_iron_python.cmfe_DistributedVector_DataRestoreL, [vector, data])
2368 
2369  def DataRestoreSP(self, data):
2370  """Restore the data array for this vector once it has finished being used
2371 
2372  :param data: On entry, a pointer to the vector data. On return, a nullified pointer.
2373  :type data: Array of floats
2374  :rtype: None
2375  """
2376 
2377  vector = self
2378  return _wrap_routine(_iron_python.cmfe_DistributedVector_DataRestoreSP, [vector, data])
2379 
2380  def DataTypeGet(self):
2381  """Get the data type of a distributed vector
2382 
2383  :returns: dataType. The vector data type. Will be a value from the MatrixVectorDataTypes enum.
2384  :rtype: int
2385  """
2386 
2387  vector = self
2388  return _wrap_routine(_iron_python.cmfe_DistributedVector_DataTypeGet, [vector])
2389 
2390  dataType = property(DataTypeGet, None, None, """The data type of a distributed vector""")
2391 
2392 
2393 class EquationsSet(CMFEType):
2394  """Contains information on an equations set defined on a region.
2395  """
2396 
2397  def __init__(self):
2398  """Initialise a null cmfe_EquationsSetType"""
2399 
2400  self.cmiss_type = _wrap_routine(_iron_python.cmfe_EquationsSet_Initialise, None)
2401 
2403  """Finish the creation of a analytic solution for an equations set identified by an object.
2404 
2405  :rtype: None
2406  """
2407 
2408  equationsSet = self
2409  return _wrap_routine(_iron_python.cmfe_EquationsSet_AnalyticCreateFinish, [equationsSet])
2410 
2411  def AnalyticCreateStart(self, analyticFunctionType, analyticFieldUserNumber, analyticField):
2412  """Start the creation of an analytic solution for an equations set identified by an object.
2413 
2414  :param analyticFunctionType: The analytic function type to use. Must be a value from the EquationsSetAnalyticFunctionTypes enum.
2415  :type analyticFunctionType: int
2416  :param analyticFieldUserNumber: The user number of the field for the analytic function
2417  :type analyticFieldUserNumber: int
2418  :param analyticField: If associated on entry, the user created analytic field which has the same user number as the specified analytic field user number. If not associated on entry, on return, the created analytic field for the equations set.
2419  :type analyticField: Field
2420  :rtype: None
2421  """
2422 
2423  equationsSet = self
2424  return _wrap_routine(_iron_python.cmfe_EquationsSet_AnalyticCreateStart, [equationsSet, analyticFunctionType, analyticFieldUserNumber, analyticField])
2425 
2426  def AnalyticDestroy(self):
2427  """Destroy the analytic solution for an equations set identified by an object.
2428 
2429  :rtype: None
2430  """
2431 
2432  equationsSet = self
2433  return _wrap_routine(_iron_python.cmfe_EquationsSet_AnalyticDestroy, [equationsSet])
2434 
2435  def AnalyticEvaluate(self):
2436  """Evaluates the current analytic solution for an equations set identified by an object.
2437 
2438  :rtype: None
2439  """
2440 
2441  equationsSet = self
2442  return _wrap_routine(_iron_python.cmfe_EquationsSet_AnalyticEvaluate, [equationsSet])
2443 
2444  def AnalyticTimeGet(self):
2445  """Returns the analytic time for an equations set identified by an object.
2446 
2447  :returns: time. The analytic time for the equations set.
2448  :rtype: float
2449  """
2450 
2451  equationsSet = self
2452  return _wrap_routine(_iron_python.cmfe_EquationsSet_AnalyticTimeGet, [equationsSet])
2453 
2454  def AnalyticTimeSet(self, time):
2455  """Sets/changes the analytic time for an equations set identified by an object.
2456 
2457  :param time: The analytic time to set.
2458  :type time: float
2459  :rtype: None
2460  """
2461 
2462  equationsSet = self
2463  return _wrap_routine(_iron_python.cmfe_EquationsSet_AnalyticTimeSet, [equationsSet, time])
2464 
2465  def AnalyticUserParamGet(self, paramIdx):
2466  """Sets the analytic problem user parameter
2467 
2468  :param paramIdx: The index of the analytic user parameter to set
2469  :type paramIdx: int
2470  :returns: param. Value of the parameter to set
2471  :rtype: float
2472  """
2473 
2474  equationsSet = self
2475  return _wrap_routine(_iron_python.cmfe_EquationsSet_AnalyticUserParamGet, [equationsSet, paramIdx])
2476 
2477  def AnalyticUserParamSet(self, paramIdx, param):
2478  """Sets the analytic problem user parameter
2479 
2480  :param paramIdx: The index of the analytic user parameter to set
2481  :type paramIdx: int
2482  :param param: Value of the parameter to set
2483  :type param: float
2484  :rtype: None
2485  """
2486 
2487  equationsSet = self
2488  return _wrap_routine(_iron_python.cmfe_EquationsSet_AnalyticUserParamSet, [equationsSet, paramIdx, param])
2489 
2490  def CreateFinish(self):
2491  """Finish the creation of an equations set identified by an object.
2492 
2493  :rtype: None
2494  """
2495 
2496  equationsSet = self
2497  return _wrap_routine(_iron_python.cmfe_EquationsSet_CreateFinish, [equationsSet])
2498 
2499  def CreateStart(self, equationsSetUserNumber, region, geomFibreField, equationsSetSpecification, equationsSetFieldUserNumber, equationsSetFieldField):
2500  """Start the creation of an equations set identified by an object.
2501 
2502  :param equationsSetUserNumber: The user number of the equations set to be created.
2503  :type equationsSetUserNumber: int
2504  :param region: The region to create the equations set on.
2505  :type region: Region
2506  :param geomFibreField: The Geometric/Fibre field for the creation of the equations set.
2507  :type geomFibreField: Field
2508  :param equationsSetSpecification: The equations set specification array, containing the equations class, type etc
2509  :type equationsSetSpecification: Array of ints
2510  :param equationsSetFieldUserNumber: The user number of the equations set field
2511  :type equationsSetFieldUserNumber: int
2512  :param equationsSetFieldField: On return, a pointer to the equations set field
2513  :type equationsSetFieldField: Field
2514  :rtype: None
2515  """
2516 
2517  equationsSet = self
2518  return _wrap_routine(_iron_python.cmfe_EquationsSet_CreateStart, [equationsSetUserNumber, region, geomFibreField, equationsSetSpecification, equationsSetFieldUserNumber, equationsSetFieldField, equationsSet])
2519 
2521  """Finish the creation of dependent variables for an equations set identified by an object.
2522 
2523  :rtype: None
2524  """
2525 
2526  equationsSet = self
2527  return _wrap_routine(_iron_python.cmfe_EquationsSet_DependentCreateFinish, [equationsSet])
2528 
2529  def DependentCreateStart(self, dependentFieldUserNumber, dependentField):
2530  """Start the creation of dependent variables for an equations set identified by an object.
2531 
2532  :param dependentFieldUserNumber: The user number of the dependent field.
2533  :type dependentFieldUserNumber: int
2534  :param dependentField: If associated on entry, the user created dependent field which has the same user number as the specified dependent field user number. If not associated on entry, on return, the created dependent field for the equations set.
2535  :type dependentField: Field
2536  :rtype: None
2537  """
2538 
2539  equationsSet = self
2540  return _wrap_routine(_iron_python.cmfe_EquationsSet_DependentCreateStart, [equationsSet, dependentFieldUserNumber, dependentField])
2541 
2542  def DependentDestroy(self):
2543  """Destroy the dependent variables for an equations set identified by an object.
2544 
2545  :rtype: None
2546  """
2547 
2548  equationsSet = self
2549  return _wrap_routine(_iron_python.cmfe_EquationsSet_DependentDestroy, [equationsSet])
2550 
2552  """Finish the creation of derived variables for an equations set identified by an object.
2553 
2554  :rtype: None
2555  """
2556 
2557  equationsSet = self
2558  return _wrap_routine(_iron_python.cmfe_EquationsSet_DerivedCreateFinish, [equationsSet])
2559 
2560  def DerivedCreateStart(self, derivedFieldUserNumber, derivedField):
2561  """Start the creation of derived variables for an equations set identified by an object.
2562 
2563  :param derivedFieldUserNumber: The user number of the derived field.
2564  :type derivedFieldUserNumber: int
2565  :param derivedField: If associated on entry, the user created derived field which has the same user number as the specified derived field user number. If not associated on entry, on return, the created derived field for the equations set.
2566  :type derivedField: Field
2567  :rtype: None
2568  """
2569 
2570  equationsSet = self
2571  return _wrap_routine(_iron_python.cmfe_EquationsSet_DerivedCreateStart, [equationsSet, derivedFieldUserNumber, derivedField])
2572 
2573  def DerivedDestroy(self):
2574  """Destroy the derived variables for an equations set identified by an object.
2575 
2576  :rtype: None
2577  """
2578 
2579  equationsSet = self
2580  return _wrap_routine(_iron_python.cmfe_EquationsSet_DerivedDestroy, [equationsSet])
2581 
2582  def DerivedVariableCalculate(self, derivedType):
2583  """Calculates a derived field value for the equations set and stores the result in the derived field previously set up
2584 
2585  :param derivedType: The derived field type to calculate. Must be a value from the EquationsSetDerivedTypes enum.
2586  :type derivedType: int
2587  :rtype: None
2588  """
2589 
2590  equationsSet = self
2591  return _wrap_routine(_iron_python.cmfe_EquationsSet_DerivedVariableCalculate, [equationsSet, derivedType])
2592 
2593  def DerivedVariableSet(self, derivedType, fieldVariableType):
2594  """Sets the field variable type of the derived field to be used to store a derived variable
2595 
2596  :param derivedType: The derived field type to calculate. Must be a value from the EquationsSetDerivedTypes enum.
2597  :type derivedType: int
2598  :param fieldVariableType: The field variable type to store the calculated values in.
2599  :type fieldVariableType: int
2600  :rtype: None
2601  """
2602 
2603  equationsSet = self
2604  return _wrap_routine(_iron_python.cmfe_EquationsSet_DerivedVariableSet, [equationsSet, derivedType, fieldVariableType])
2605 
2606  def Destroy(self):
2607  """Destroy an equations set identified by an object.
2608 
2609  :rtype: None
2610  """
2611 
2612  equationsSet = self
2613  return _wrap_routine(_iron_python.cmfe_EquationsSet_Destroy, [equationsSet])
2614 
2616  """Finish the creation of equations for an equations set identified by an object.
2617 
2618  :rtype: None
2619  """
2620 
2621  equationsSet = self
2622  return _wrap_routine(_iron_python.cmfe_EquationsSet_EquationsCreateFinish, [equationsSet])
2623 
2624  def EquationsCreateStart(self, equations):
2625  """Start the creation of equations for an equations set identified by an object.
2626 
2627  :param equations: On return, the created equations.
2628  :type equations: Equations
2629  :rtype: None
2630  """
2631 
2632  equationsSet = self
2633  return _wrap_routine(_iron_python.cmfe_EquationsSet_EquationsCreateStart, [equationsSet, equations])
2634 
2635  def EquationsDestroy(self):
2636  """Destroy the equations for an equations set identified by an object.
2637 
2638  :rtype: None
2639  """
2640 
2641  equationsSet = self
2642  return _wrap_routine(_iron_python.cmfe_EquationsSet_EquationsDestroy, [equationsSet])
2643 
2644  def Finalise(self):
2645  """Finalises a cmfe_EquationsSetType object.
2646 
2647  :rtype: None
2648  """
2649 
2650  cmfe_EquationsSet = self
2651  return _wrap_routine(_iron_python.cmfe_EquationsSet_Finalise, [cmfe_EquationsSet])
2652 
2654  """Finish the creation of independent variables for an equations set identified by an object.
2655 
2656  :rtype: None
2657  """
2658 
2659  equationsSet = self
2660  return _wrap_routine(_iron_python.cmfe_EquationsSet_IndependentCreateFinish, [equationsSet])
2661 
2662  def IndependentCreateStart(self, independentFieldUserNumber, independentField):
2663  """Start the creation of independent variables for an equations set identified by an object.
2664 
2665  :param independentFieldUserNumber: The user number of the dependent field.
2666  :type independentFieldUserNumber: int
2667  :param independentField: If associated on entry, the user created independent field which has the same user number as the specified independent field user number. If not associated on entry, on return, the created independent field for the equations set.
2668  :type independentField: Field
2669  :rtype: None
2670  """
2671 
2672  equationsSet = self
2673  return _wrap_routine(_iron_python.cmfe_EquationsSet_IndependentCreateStart, [equationsSet, independentFieldUserNumber, independentField])
2674 
2676  """Destroy the independent variables for an equations set identified by an object.
2677 
2678  :rtype: None
2679  """
2680 
2681  equationsSet = self
2682  return _wrap_routine(_iron_python.cmfe_EquationsSet_IndependentDestroy, [equationsSet])
2683 
2685  """Finish the creation of materials for an equations set identified by an object.
2686 
2687  :rtype: None
2688  """
2689 
2690  equationsSet = self
2691  return _wrap_routine(_iron_python.cmfe_EquationsSet_MaterialsCreateFinish, [equationsSet])
2692 
2693  def MaterialsCreateStart(self, materialsFieldUserNumber, materialsField):
2694  """Start the creation of materials for an equations set identified by an object.
2695 
2696  :param materialsFieldUserNumber: The user number of the materials field.
2697  :type materialsFieldUserNumber: int
2698  :param materialsField: If associated on entry, the user created materials field which has the same user number as the specified materials field user number. If not associated on entry, on return, the created materials field for the equations set.
2699  :type materialsField: Field
2700  :rtype: None
2701  """
2702 
2703  equationsSet = self
2704  return _wrap_routine(_iron_python.cmfe_EquationsSet_MaterialsCreateStart, [equationsSet, materialsFieldUserNumber, materialsField])
2705 
2706  def MaterialsDestroy(self):
2707  """Destroy the materials for an equations set identified by an object.
2708 
2709  :rtype: None
2710  """
2711 
2712  equationsSet = self
2713  return _wrap_routine(_iron_python.cmfe_EquationsSet_MaterialsDestroy, [equationsSet])
2714 
2716  """Returns the solution method for an equations set identified by an object.
2717 
2718  :returns: solutionMethod. The solution method. Will be a value from the EquationsSetSolutionMethods enum.
2719  :rtype: int
2720  """
2721 
2722  equationsSet = self
2723  return _wrap_routine(_iron_python.cmfe_EquationsSet_SolutionMethodGet, [equationsSet])
2724 
2725  def SolutionMethodSet(self, solutionMethod):
2726  """Sets/changes the solution method for an equations set identified by an object.
2727 
2728  :param solutionMethod: The solution method to set. Must be a value from the EquationsSetSolutionMethods enum.
2729  :type solutionMethod: int
2730  :rtype: None
2731  """
2732 
2733  equationsSet = self
2734  return _wrap_routine(_iron_python.cmfe_EquationsSet_SolutionMethodSet, [equationsSet, solutionMethod])
2735 
2737  """Finish the creation of a source for an equations set identified by an object.
2738 
2739  :rtype: None
2740  """
2741 
2742  equationsSet = self
2743  return _wrap_routine(_iron_python.cmfe_EquationsSet_SourceCreateFinish, [equationsSet])
2744 
2745  def SourceCreateStart(self, sourceFieldUserNumber, sourceField):
2746  """Start the creation of a source for an equations set identified by an object.
2747 
2748  :param sourceFieldUserNumber: The user number of the source field.
2749  :type sourceFieldUserNumber: int
2750  :param sourceField: If associated on entry, the user created source field which has the same user number as the specified source field user number. If not associated on entry, on return, the created source field for the equations set.
2751  :type sourceField: Field
2752  :rtype: None
2753  """
2754 
2755  equationsSet = self
2756  return _wrap_routine(_iron_python.cmfe_EquationsSet_SourceCreateStart, [equationsSet, sourceFieldUserNumber, sourceField])
2757 
2758  def SourceDestroy(self):
2759  """Destroy the source for an equations set identified by an object.
2760 
2761  :rtype: None
2762  """
2763 
2764  equationsSet = self
2765  return _wrap_routine(_iron_python.cmfe_EquationsSet_SourceDestroy, [equationsSet])
2766 
2767  def SpecificationGet(self, equationsSetSpecification):
2768  """Returns the equations set specification array for an equations set identified by an object.
2769 
2770  :param equationsSetSpecification: On return, the equations set specification array. Must be allocated and large enough to contain the specification on entry.
2771  :type equationsSetSpecification: Array of ints
2772  :rtype: None
2773  """
2774 
2775  equationsSet = self
2776  return _wrap_routine(_iron_python.cmfe_EquationsSet_SpecificationGet, [equationsSet, equationsSetSpecification])
2777 
2779  """Returns the size of the equations set specification array for an equations set identified by an object.
2780 
2781  :returns: specificationSize. The size of the equations set specification array.
2782  :rtype: int
2783  """
2784 
2785  equationsSet = self
2786  return _wrap_routine(_iron_python.cmfe_EquationsSet_SpecificationSizeGet, [equationsSet])
2787 
2788  def TensorInterpolateXi(self, tensorEvaluateType, userElementNumber, xi, valuesSizes):
2789  """Evaluate a tensor at a given element xi location, for an equations set identified by an object.
2790 
2791  :param tensorEvaluateType: The type of tensor to evaluate.
2792  :type tensorEvaluateType: int
2793  :param userElementNumber: The user element number of the field to interpolate.
2794  :type userElementNumber: int
2795  :param xi: The element xi to interpolate the field at.
2796  :type xi: Array of floats
2797  :param valuesSizes: Tuple of dimensions of values to allocate, with length 2.
2798  :returns: values. The interpolated strain tensor values.
2799  :rtype: 2d array of floats
2800  """
2801 
2802  equationsSet = self
2803  return _wrap_routine(_iron_python.cmfe_EquationsSet_TensorInterpolateXi, [equationsSet, tensorEvaluateType, userElementNumber, xi, valuesSizes])
2804 
2805  specificationSize = property(SpecificationSizeGet, None, None, """The size of the equations set specification array for an equations set identified by an object.""")
2806 
2807  analyticTime = property(AnalyticTimeGet, AnalyticTimeSet, None, """The analytic time for an equations set identified by an object.""")
2808 
2809  solutionMethod = property(SolutionMethodGet, SolutionMethodSet, None, """The solution method for an equations set identified by an object.""")
2810 
2811  specification = property(SpecificationGet, None, None, """The equations set specification array for an equations set identified by an object.""")
2812 
2813 
2814 class Equations(CMFEType):
2815  """Contains information about the equations in an equations set.
2816  """
2817 
2818  def __init__(self):
2819  """Initialise a null cmfe_EquationsType"""
2820 
2821  self.cmiss_type = _wrap_routine(_iron_python.cmfe_Equations_Initialise, None)
2822 
2823  def Destroy(self):
2824  """Destroy equations for equations identified by an object.
2825 
2826  :rtype: None
2827  """
2828 
2829  equations = self
2830  return _wrap_routine(_iron_python.cmfe_Equations_Destroy, [equations])
2831 
2832  def DynamicMatrixGet(self, matrixIndex, matrix):
2833  """Get a dynamic equations matrix from equations using the dynamic matrix index
2834 
2835  :param matrixIndex: The number of the dynamic matrix to get
2836  :type matrixIndex: int
2837  :param matrix: On return, the requested dynamic matrix
2838  :type matrix: DistributedMatrix
2839  :rtype: None
2840  """
2841 
2842  equations = self
2843  return _wrap_routine(_iron_python.cmfe_Equations_DynamicMatrixGet, [equations, matrixIndex, matrix])
2844 
2845  def DynamicMatrixGetByType(self, matrixType, matrix):
2846  """Get a dynamic equations matrix from equations using the dynamic matrix type
2847 
2848  :param matrixType: The type of the dynamic matrix to get. Must be a value from the EquationsSetDynamicMatrixTypes enum.
2849  :type matrixType: int
2850  :param matrix: On return, the requested dynamic matrix
2851  :type matrix: DistributedMatrix
2852  :rtype: None
2853  """
2854 
2855  equations = self
2856  return _wrap_routine(_iron_python.cmfe_Equations_DynamicMatrixGetByType, [equations, matrixType, matrix])
2857 
2858  def DynamicMatrixTypeGet(self, matrixIndex):
2859  """Get the type of a dynamic matrix from equations set equations
2860 
2861  :param matrixIndex: The number of the dynamic matrix to get the type of
2862  :type matrixIndex: int
2863  :returns: matrixType. The dynamic matrix type. Will be a value from the EquationsSetDynamicMatrixTypes enum.
2864  :rtype: int
2865  """
2866 
2867  equations = self
2868  return _wrap_routine(_iron_python.cmfe_Equations_DynamicMatrixTypeGet, [equations, matrixIndex])
2869 
2870  def Finalise(self):
2871  """Finalises a cmfe_EquationsType object.
2872 
2873  :rtype: None
2874  """
2875 
2876  cmfe_Equations = self
2877  return _wrap_routine(_iron_python.cmfe_Equations_Finalise, [cmfe_Equations])
2878 
2879  def JacobianMatricesTypesSet(self, jacobianTypes):
2880  """Setting Jacobian matrix evaluation type
2881 
2882  :param jacobianTypes: The type of Jacobian evaluation. Must be a value from the EquationsJacobianCalculated enum.
2883  :type jacobianTypes: int
2884  :rtype: None
2885  """
2886 
2887  equations = self
2888  return _wrap_routine(_iron_python.cmfe_Equations_JacobianMatricesTypesSet, [equations, jacobianTypes])
2889 
2890  def JacobianMatrixGet(self, residualIndex, variableType, matrix):
2891  """Get a Jacobian matrix from the equations
2892 
2893  :param residualIndex: The index of the residual vector to get the Jacobian matrix for
2894  :type residualIndex: int
2895  :param variableType: The field variable type that the residual is differentiated with respect to for this Jacobian. Must be a value from the FieldVariableTypes enum.
2896  :type variableType: int
2897  :param matrix: On return, the requested Jacobian matrix
2898  :type matrix: DistributedMatrix
2899  :rtype: None
2900  """
2901 
2902  equations = self
2903  return _wrap_routine(_iron_python.cmfe_Equations_JacobianMatrixGet, [equations, residualIndex, variableType, matrix])
2904 
2905  def LinearMatrixGet(self, matrixIndex, matrix):
2906  """Get a linear equations matrix from the equations
2907 
2908  :param matrixIndex: The number of the linear matrix to get
2909  :type matrixIndex: int
2910  :param matrix: On return, the requested linear matrix
2911  :type matrix: DistributedMatrix
2912  :rtype: None
2913  """
2914 
2915  equations = self
2916  return _wrap_routine(_iron_python.cmfe_Equations_LinearMatrixGet, [equations, matrixIndex, matrix])
2917 
2918  def LinearityTypeGet(self):
2919  """Gets the linearity type for equations identified by an object.
2920 
2921  :returns: linearityType. The linearity type of the equations. Will be a value from the EquationsLinearityTypes enum.
2922  :rtype: int
2923  """
2924 
2925  equations = self
2926  return _wrap_routine(_iron_python.cmfe_Equations_LinearityTypeGet, [equations])
2927 
2928  def LumpingTypeGet(self):
2929  """Gets the lumping type for equations identified by an object.
2930 
2931  :returns: lumpingType. The lumping type of the equations. Will be a value from the EquationsLumpingTypes enum.
2932  :rtype: int
2933  """
2934 
2935  equations = self
2936  return _wrap_routine(_iron_python.cmfe_Equations_LumpingTypeGet, [equations])
2937 
2938  def LumpingTypeSet(self, lumpingType):
2939  """Sets/changes the lumping type for equations identified by an object.
2940 
2941  :param lumpingType: The lumping type of the equations to set. Must be a value from the EquationsLumpingTypes enum.
2942  :type lumpingType: int
2943  :rtype: None
2944  """
2945 
2946  equations = self
2947  return _wrap_routine(_iron_python.cmfe_Equations_LumpingTypeSet, [equations, lumpingType])
2948 
2950  """Get the number of dynamic matrices in the equations
2951 
2952  :returns: numberOfMatrices. The number of dynamic matrices
2953  :rtype: int
2954  """
2955 
2956  equations = self
2957  return _wrap_routine(_iron_python.cmfe_Equations_NumberOfDynamicMatricesGet, [equations])
2958 
2960  """Get the number of Jacobian matrices in the equations
2961 
2962  :returns: numberOfMatrices. The number of Jacobian matrices
2963  :rtype: int
2964  """
2965 
2966  equations = self
2967  return _wrap_routine(_iron_python.cmfe_Equations_NumberOfJacobianMatricesGet, [equations])
2968 
2970  """Get the number of linear matrices in the equations
2971 
2972  :returns: numberOfMatrices. The number of linear matrices
2973  :rtype: int
2974  """
2975 
2976  equations = self
2977  return _wrap_routine(_iron_python.cmfe_Equations_NumberOfLinearMatricesGet, [equations])
2978 
2979  def OutputTypeGet(self):
2980  """Gets the output type for equations identified by an object.
2981 
2982  :returns: outputType. The output type of the equations. Will be a value from the EquationsOutputTypes enum.
2983  :rtype: int
2984  """
2985 
2986  equations = self
2987  return _wrap_routine(_iron_python.cmfe_Equations_OutputTypeGet, [equations])
2988 
2989  def OutputTypeSet(self, outputType):
2990  """Sets/changes the output type for equations identified by an object.
2991 
2992  :param outputType: The output type of the equations to set. Must be a value from the EquationsOutputTypes enum.
2993  :type outputType: int
2994  :rtype: None
2995  """
2996 
2997  equations = self
2998  return _wrap_routine(_iron_python.cmfe_Equations_OutputTypeSet, [equations, outputType])
2999 
3000  def ResidualNumberOfVariablesGet(self, residualIndex):
3001  """Get the number of field variables that contribute to the residual vector
3002 
3003  :param residualIndex: The index of the residual vector to get the number of variables for
3004  :type residualIndex: int
3005  :returns: numberOfVariables. The number of variables that contribute to the residual vector
3006  :rtype: int
3007  """
3008 
3009  equations = self
3010  return _wrap_routine(_iron_python.cmfe_Equations_ResidualNumberOfVariablesGet, [equations, residualIndex])
3011 
3012  def ResidualVariablesGet(self, residualIndex, residualVariablesSize):
3013  """Get the field variables that contribute to the residual vector
3014 
3015  :param residualIndex: The index of the residual vector to get the variables for
3016  :type residualIndex: int
3017  :param residualVariablesSize: Size of residualVariables to allocate.
3018  :returns: residualVariables. residualVariables(varIdx). On return, the field variable type for the varIdx'th residual variable. Will be a value from the FieldVariableTypes enum.
3019  :rtype: Array of ints
3020  """
3021 
3022  equations = self
3023  return _wrap_routine(_iron_python.cmfe_Equations_ResidualVariablesGet, [equations, residualIndex, residualVariablesSize])
3024 
3025  def ResidualVectorGet(self, residualIndex, residualVector):
3026  """Get a residual vector for equations
3027 
3028  :param residualIndex: The index of the residual vector to get
3029  :type residualIndex: int
3030  :param residualVector: On return, the residual vector for the equations
3031  :type residualVector: DistributedVector
3032  :rtype: None
3033  """
3034 
3035  equations = self
3036  return _wrap_routine(_iron_python.cmfe_Equations_ResidualVectorGet, [equations, residualIndex, residualVector])
3037 
3038  def RhsVectorGet(self, rhsVector):
3039  """Get the right hand side vector for equations
3040 
3041  :param rhsVector: On return, the right hand side vector for the equations
3042  :type rhsVector: DistributedVector
3043  :rtype: None
3044  """
3045 
3046  equations = self
3047  return _wrap_routine(_iron_python.cmfe_Equations_RhsVectorGet, [equations, rhsVector])
3048 
3049  def SourceVectorGet(self, sourceVector):
3050  """Get the source vector for equations
3051 
3052  :param sourceVector: On return, the source vector for the equations
3053  :type sourceVector: DistributedVector
3054  :rtype: None
3055  """
3056 
3057  equations = self
3058  return _wrap_routine(_iron_python.cmfe_Equations_SourceVectorGet, [equations, sourceVector])
3059 
3060  def SparsityTypeGet(self):
3061  """Gets the sparsity type for equations identified by an object.
3062 
3063  :returns: sparsityType. The sparsity type of the equations. Will be a value from the EquationsSparsityTypes enum.
3064  :rtype: int
3065  """
3066 
3067  equations = self
3068  return _wrap_routine(_iron_python.cmfe_Equations_SparsityTypeGet, [equations])
3069 
3070  def SparsityTypeSet(self, sparsityType):
3071  """Sets/changes the sparsity type for equations identified by an object.
3072 
3073  :param sparsityType: The sparsity type of the equations to set. Must be a value from the EquationsSparsityTypes enum.
3074  :type sparsityType: int
3075  :rtype: None
3076  """
3077 
3078  equations = self
3079  return _wrap_routine(_iron_python.cmfe_Equations_SparsityTypeSet, [equations, sparsityType])
3080 
3082  """Gets the time dependence type for equations identified by an object.
3083 
3084  :returns: timeDependenceType. The time dependence type of the equations. Will be a value from the EquationsTimeDependenceTypes enum.
3085  :rtype: int
3086  """
3087 
3088  equations = self
3089  return _wrap_routine(_iron_python.cmfe_Equations_TimeDependenceTypeGet, [equations])
3090 
3091  rhsVector = property(RhsVectorGet, None, None, """The right hand side vector for equations""")
3092 
3093  timeDependenceType = property(TimeDependenceTypeGet, None, None, """The time dependence type for equations identified by an object.""")
3094 
3095  sourceVector = property(SourceVectorGet, None, None, """The source vector for equations""")
3096 
3097  outputType = property(OutputTypeGet, OutputTypeSet, None, """The output type for equations identified by an object.""")
3098 
3099  sparsityType = property(SparsityTypeGet, SparsityTypeSet, None, """The sparsity type for equations identified by an object.""")
3100 
3101  linearityType = property(LinearityTypeGet, None, None, """The linearity type for equations identified by an object.""")
3102 
3103  jacobianMatricesTypes = property(None, JacobianMatricesTypesSet, None, """Setting Jacobian matrix evaluation type""")
3104 
3105  numberOfJacobianMatrices = property(NumberOfJacobianMatricesGet, None, None, """The number of Jacobian matrices in the equations""")
3106 
3107  numberOfDynamicMatrices = property(NumberOfDynamicMatricesGet, None, None, """The number of dynamic matrices in the equations""")
3108 
3109  lumpingType = property(LumpingTypeGet, LumpingTypeSet, None, """The lumping type for equations identified by an object.""")
3110 
3111  numberOfLinearMatrices = property(NumberOfLinearMatricesGet, None, None, """The number of linear matrices in the equations""")
3112 
3113 
3114 class FieldMLIO(CMFEType):
3115  """Provides input and output of fields through the FieldML API
3116  """
3117 
3118  def __init__(self):
3119  """Initialise a null cmfe_FieldMLIOType"""
3120 
3121  self.cmiss_type = _wrap_routine(_iron_python.cmfe_FieldMLIO_Initialise, None)
3122 
3123  def Finalise(self):
3124  """Finalises a Fieldml context.
3125 
3126  :rtype: None
3127  """
3128 
3129  fieldml = self
3130  return _wrap_routine(_iron_python.cmfe_FieldMLIO_Finalise, [fieldml])
3131 
3132  def GetSession(self):
3133  """Get the session handle from a Fieldml context.
3134 
3135  :returns: sessionHandle. The session handle.
3136  :rtype: int
3137  """
3138 
3139  fieldml = self
3140  return _wrap_routine(_iron_python.cmfe_FieldMLIO_GetSession, [fieldml])
3141 
3142  def InputBasisCreateStartNum(self, evaluatorName, userNumber):
3143  """Create a basis using the given FieldML evaluator.
3144 
3145  :param evaluatorName: The name of the argument evaluator to create the basis from.
3146  :type evaluatorName: string
3147  :param userNumber: The user number to assign to the new basis.
3148  :type userNumber: int
3149  :rtype: None
3150  """
3151 
3152  fieldml = self
3153  return _wrap_routine(_iron_python.cmfe_FieldML_InputBasisCreateStartNum, [fieldml, evaluatorName, userNumber])
3154 
3155  def InputBasisCreateStart(self, evaluatorName, userNumber, basis):
3156  """Create a basis using the given FieldML evaluator.
3157 
3158  :param evaluatorName: The name of the argument evaluator to create the basis from.
3159  :type evaluatorName: string
3160  :param userNumber: The user number to assign to the new basis.
3161  :type userNumber: int
3162  :param basis: On return, the newly created basis.
3163  :type basis: Basis
3164  :rtype: None
3165  """
3166 
3167  fieldml = self
3168  return _wrap_routine(_iron_python.cmfe_FieldML_InputBasisCreateStart, [fieldml, evaluatorName, userNumber, basis])
3169 
3170  def InputCoordinateSystemCreateStartNum(self, evaluatorName, userNumber):
3171  """Create a coordinate system using the given FieldML evaluator.
3172 
3173  :param evaluatorName: The name of the argument evaluator to create the coordinate system from.
3174  :type evaluatorName: string
3175  :param userNumber: The user number to assign to the new coordinate system.
3176  :type userNumber: int
3177  :rtype: None
3178  """
3179 
3180  fieldml = self
3181  return _wrap_routine(_iron_python.cmfe_FieldML_InputCoordinateSystemCreateStartNum, [fieldml, evaluatorName, userNumber])
3182 
3183  def InputCoordinateSystemCreateStart(self, evaluatorName, coordinateSystem, userNumber):
3184  """Create a coordinate system using the given FieldML evaluator.
3185 
3186  :param evaluatorName: The name of the argument evaluator to create the coordinate system from.
3187  :type evaluatorName: string
3188  :param coordinateSystem: On return, the newly created coordinate system.
3189  :type coordinateSystem: CoordinateSystem
3190  :param userNumber: The user number to assign to the new coordinate system.
3191  :type userNumber: int
3192  :rtype: None
3193  """
3194 
3195  fieldml = self
3196  return _wrap_routine(_iron_python.cmfe_FieldML_InputCoordinateSystemCreateStart, [fieldml, evaluatorName, coordinateSystem, userNumber])
3197 
3198  def InputCreateFromFile(self, filename):
3199  """Initialise the given FieldML context using the given FieldML XML file.
3200 
3201  :param filename: The FieldML XML file to parse.
3202  :type filename: string
3203  :rtype: None
3204  """
3205 
3206  fieldml = self
3207  return _wrap_routine(_iron_python.cmfe_FieldML_InputCreateFromFile, [filename, fieldml])
3208 
3209  def InputCreateMeshComponentNum(self, regionNumber, meshNumber, componentNumber, evaluatorName):
3210  """Use the given FieldML evaluator as a template to create a component on the mesh identified by the given user number.
3211 
3212  :param regionNumber: The user number of the region in which the mesh component is to be created.
3213  :type regionNumber: int
3214  :param meshNumber: The user number of the mesh for which the mesh component is to be created.
3215  :type meshNumber: int
3216  :param componentNumber: The number of the mesh component to create.
3217  :type componentNumber: int
3218  :param evaluatorName: The name of the argument evaluator to create the basis from.
3219  :type evaluatorName: string
3220  :rtype: None
3221  """
3222 
3223  fieldml = self
3224  return _wrap_routine(_iron_python.cmfe_FieldML_InputCreateMeshComponentNum, [fieldml, regionNumber, meshNumber, componentNumber, evaluatorName])
3225 
3226  def InputCreateMeshComponent(self, mesh, componentNumber, evaluatorName):
3227  """Use the given FieldML evaluator as a template to create a component on the given mesh.
3228 
3229  :param mesh: The mesh for which to create the mesh component.
3230  :type mesh: Mesh
3231  :param componentNumber: The number of the mesh component to create.
3232  :type componentNumber: int
3233  :param evaluatorName: The name of the argument evaluator to create the mesh from.
3234  :type evaluatorName: string
3235  :rtype: None
3236  """
3237 
3238  fieldml = self
3239  return _wrap_routine(_iron_python.cmfe_FieldML_InputCreateMeshComponent, [fieldml, mesh, componentNumber, evaluatorName])
3240 
3241  def InputFieldCreateStartNum(self, regionNumber, meshNumber, decompositionNumber, fieldNumber, variableType, evaluatorName):
3242  """Create a field with the given user number using the given FieldML evaluator.
3243 
3244  :param regionNumber: The user number of the region in which to create the field.
3245  :type regionNumber: int
3246  :param meshNumber: The user number of the mesh to use when creating the field.
3247  :type meshNumber: int
3248  :param decompositionNumber: The user number of the decomposition to use when creating the field.
3249  :type decompositionNumber: int
3250  :param fieldNumber: The user number to assign to the new field.
3251  :type fieldNumber: int
3252  :param variableType: The OpenCMISS variable type.
3253  :type variableType: int
3254  :param evaluatorName: The name of the argument evaluator to create the field from.
3255  :type evaluatorName: string
3256  :rtype: None
3257  """
3258 
3259  fieldml = self
3260  return _wrap_routine(_iron_python.cmfe_FieldML_InputFieldCreateStartNum, [fieldml, regionNumber, meshNumber, decompositionNumber, fieldNumber, variableType, evaluatorName])
3261 
3262  def InputFieldCreateStart(self, region, decomposition, fieldNumber, field, variableType, evaluatorName):
3263  """Create a field using the given FieldML evaluator.
3264 
3265  :param region: The region in which the field is to be created.
3266  :type region: Region
3267  :param decomposition: The decomposition to use when creating the field.
3268  :type decomposition: Decomposition
3269  :param fieldNumber: The user number to assign to the new field.
3270  :type fieldNumber: int
3271  :param field: On return, the newly created field.
3272  :type field: Field
3273  :param variableType: The OpenCMISS variable type.
3274  :type variableType: int
3275  :param evaluatorName: The name of the argument evaluator to create the field from.
3276  :type evaluatorName: string
3277  :rtype: None
3278  """
3279 
3280  fieldml = self
3281  return _wrap_routine(_iron_python.cmfe_FieldML_InputFieldCreateStart, [fieldml, region, decomposition, fieldNumber, field, variableType, evaluatorName])
3282 
3283  def InputFieldParametersUpdateNum(self, regionNumber, fieldNumber, evaluatorName, variableType, setType):
3284  """Update the DOF parameters of field with the given user number, using the given FieldML evaluator.
3285 
3286  :param regionNumber: The user number of the region of the field for which parameters are to be updated.
3287  :type regionNumber: int
3288  :param fieldNumber: The user number of the field for which parameters are to be updated.
3289  :type fieldNumber: int
3290  :param evaluatorName: The name of the argument evaluator to get the parameters from.
3291  :type evaluatorName: string
3292  :param variableType: The OpenCMISS variable type.
3293  :type variableType: int
3294  :param setType: The parameter set type.
3295  :type setType: int
3296  :rtype: None
3297  """
3298 
3299  fieldml = self
3300  return _wrap_routine(_iron_python.cmfe_FieldML_InputFieldParametersUpdateNum, [fieldml, regionNumber, fieldNumber, evaluatorName, variableType, setType])
3301 
3302  def InputFieldParametersUpdate(self, field, evaluatorName, variableType, setType):
3303  """Update the DOF parameters of the given field, using the given FieldML evaluator.
3304 
3305  :param field: On return, the field object.
3306  :type field: Field
3307  :param evaluatorName: The name of the argument evaluator to get the parameters from.
3308  :type evaluatorName: string
3309  :param variableType: The OpenCMISS variable type.
3310  :type variableType: int
3311  :param setType: The parameter set type.
3312  :type setType: int
3313  :rtype: None
3314  """
3315 
3316  fieldml = self
3317  return _wrap_routine(_iron_python.cmfe_FieldML_InputFieldParametersUpdate, [fieldml, field, evaluatorName, variableType, setType])
3318 
3319  def InputMeshCreateStartNum(self, meshArgumentName, meshNumber, regionNumber):
3320  """Creates a mesh with the given user number using the given FieldML evaluator.
3321 
3322  :param meshArgumentName: The name of the mesh argument evaluator to create a mesh from.
3323  :type meshArgumentName: string
3324  :param meshNumber: The user number to assign to the new mesh.
3325  :type meshNumber: int
3326  :param regionNumber: The user number of the region in which to create the mesh.
3327  :type regionNumber: int
3328  :rtype: None
3329  """
3330 
3331  fieldml = self
3332  return _wrap_routine(_iron_python.cmfe_FieldML_InputMeshCreateStartNum, [fieldml, meshArgumentName, meshNumber, regionNumber])
3333 
3334  def InputMeshCreateStart(self, meshArgumentName, mesh, meshNumber, region):
3335  """Creates a mesh using the given FieldML evaluator.
3336 
3337  :param meshArgumentName: The name of the argument evaluator to create a mesh from.
3338  :type meshArgumentName: string
3339  :param mesh: On return, the newly created mesh.
3340  :type mesh: Mesh
3341  :param meshNumber: The user number to assign to the new mesh.
3342  :type meshNumber: int
3343  :param region: The region in which to create the mesh.
3344  :type region: Region
3345  :rtype: None
3346  """
3347 
3348  fieldml = self
3349  return _wrap_routine(_iron_python.cmfe_FieldML_InputMeshCreateStart, [fieldml, meshArgumentName, mesh, meshNumber, region])
3350 
3351  def InputNodesCreateStartNum(self, nodesArgumentName, regionNumber, nodes):
3352  """Creates a region's nodes using the given FieldML evaluator.
3353 
3354  :param nodesArgumentName: The name of the argument evaluator to create the nodes from.
3355  :type nodesArgumentName: string
3356  :param regionNumber: The user number of the region to create to the nodes in.
3357  :type regionNumber: int
3358  :param nodes: On return, the newly created nodes.
3359  :type nodes: Nodes
3360  :rtype: None
3361  """
3362 
3363  fieldml = self
3364  return _wrap_routine(_iron_python.cmfe_FieldML_InputNodesCreateStartNum, [fieldml, nodesArgumentName, regionNumber, nodes])
3365 
3366  def InputNodesCreateStart(self, nodesArgumentName, region, nodes):
3367  """Creates a region's nodes using the given FieldML evaluator.
3368 
3369  :param nodesArgumentName: The name of the argument evaluator to create the basis from.
3370  :type nodesArgumentName: string
3371  :param region: The user number of the region to create to the nodes in.
3372  :type region: Region
3373  :param nodes: On return, the newly created nodes.
3374  :type nodes: Nodes
3375  :rtype: None
3376  """
3377 
3378  fieldml = self
3379  return _wrap_routine(_iron_python.cmfe_FieldML_InputNodesCreateStart, [fieldml, nodesArgumentName, region, nodes])
3380 
3381  def OutputAddFieldComponentsNum(self, typeHandle, baseName, dofFormat, regionNumber, fieldNumber, fieldComponentNumbers, variableType, setType):
3382  """Add the field with the given user number to the current FieldML context, only including the given components.
3383 
3384  :param typeHandle: The FieldML type to assign to the new FieldML field.
3385  :type typeHandle: int
3386  :param baseName: The prefix to use when naming automatically created FieldML objects in the context.
3387  :type baseName: string
3388  :param dofFormat: The name of the format to use when writing dof data.
3389  :type dofFormat: string
3390  :param regionNumber: The user number of the region owning the field to add.
3391  :type regionNumber: int
3392  :param fieldNumber: The user number of the field whose components are to be added.
3393  :type fieldNumber: int
3394  :param fieldComponentNumbers: The component numbers to add.
3395  :type fieldComponentNumbers: Array of ints
3396  :param variableType: The variable type of the field to add to the FieldML context.
3397  :type variableType: int
3398  :param setType: The parameter set type.
3399  :type setType: int
3400  :rtype: None
3401  """
3402 
3403  fieldml = self
3404  return _wrap_routine(_iron_python.cmfe_FieldML_OutputAddFieldComponentsNum, [fieldml, typeHandle, baseName, dofFormat, regionNumber, fieldNumber, fieldComponentNumbers, variableType, setType])
3405 
3406  def OutputAddFieldComponents(self, typeHandle, baseName, dofFormat, field, fieldComponentNumbers, variableType, setType):
3407  """Add the given field to the current FieldML context, only including the given components.
3408 
3409  :param typeHandle: The FieldML type to assign to the new FieldML field.
3410  :type typeHandle: int
3411  :param baseName: The prefix to use when naming automatically created FieldML objects in the context.
3412  :type baseName: string
3413  :param dofFormat: The name of the format to use when writing dof data.
3414  :type dofFormat: string
3415  :param field: The field whose components are to be added.
3416  :type field: Field
3417  :param fieldComponentNumbers:
3418  :type fieldComponentNumbers: Array of ints
3419  :param variableType: The variable type of the field to add to the FieldML context.
3420  :type variableType: int
3421  :param setType: The parameter set type.
3422  :type setType: int
3423  :rtype: None
3424  """
3425 
3426  fieldml = self
3427  return _wrap_routine(_iron_python.cmfe_FieldML_OutputAddFieldComponents, [fieldml, typeHandle, baseName, dofFormat, field, fieldComponentNumbers, variableType, setType])
3428 
3429  def OutputAddFieldNoTypeNum(self, baseName, dofFormat, regionNumber, fieldNumber, variableType, setType):
3430  """Add the field with the given user number to the given FieldML context. The FieldML type will be inferred.
3431 
3432  :param baseName: The prefix to use when naming automatically created FieldML objects in the context.
3433  :type baseName: string
3434  :param dofFormat: The name of the format to use when writing dof data.
3435  :type dofFormat: string
3436  :param regionNumber: The user number of the region containing the field to add to the FieldML context.
3437  :type regionNumber: int
3438  :param fieldNumber: The user number of the field to add to the FieldML context.
3439  :type fieldNumber: int
3440  :param variableType: The variable type of the field to add to the FieldML context.
3441  :type variableType: int
3442  :param setType: The parameter set type.
3443  :type setType: int
3444  :rtype: None
3445  """
3446 
3447  fieldml = self
3448  return _wrap_routine(_iron_python.cmfe_FieldML_OutputAddFieldNoTypeNum, [fieldml, baseName, dofFormat, regionNumber, fieldNumber, variableType, setType])
3449 
3450  def OutputAddFieldNoType(self, baseName, dofFormat, field, variableType, setType):
3451  """Add the given field to the given FieldML context. The FieldML type will be inferred.
3452 
3453  :param baseName: The prefix to use when naming automatically created FieldML objects in the context.
3454  :type baseName: string
3455  :param dofFormat: The name of the format to use when writing dof data.
3456  :type dofFormat: string
3457  :param field: The field to add.
3458  :type field: Field
3459  :param variableType: The variable type of the field to add.
3460  :type variableType: int
3461  :param setType: The parameter set type.
3462  :type setType: int
3463  :rtype: None
3464  """
3465 
3466  fieldml = self
3467  return _wrap_routine(_iron_python.cmfe_FieldML_OutputAddFieldNoType, [fieldml, baseName, dofFormat, field, variableType, setType])
3468 
3469  def OutputAddFieldWithTypeNum(self, baseName, dofFormat, regionNumber, fieldNumber, variableType, setType, typeHandle):
3470  """Add the given field to the given FieldML context, using the given FieldML type.
3471 
3472  :param baseName: The prefix to use when naming automatically created FieldML objects in the context.
3473  :type baseName: string
3474  :param dofFormat: The name of the format to use when writing dof data.
3475  :type dofFormat: string
3476  :param regionNumber: The user number of the region owning the field to add.
3477  :type regionNumber: int
3478  :param fieldNumber: The user number of the field to add.
3479  :type fieldNumber: int
3480  :param variableType: The variable type of the field to add to the FieldML context.
3481  :type variableType: int
3482  :param setType: The parameter set type.
3483  :type setType: int
3484  :param typeHandle: The FieldML type to assign to the new FieldML field.
3485  :type typeHandle: int
3486  :rtype: None
3487  """
3488 
3489  fieldml = self
3490  return _wrap_routine(_iron_python.cmfe_FieldML_OutputAddFieldWithTypeNum, [fieldml, baseName, dofFormat, regionNumber, fieldNumber, variableType, setType, typeHandle])
3491 
3492  def OutputAddFieldWithType(self, baseName, dofFormat, field, variableType, setType, typeHandle):
3493  """Add the given field to the given FieldML context, using the given FieldML type.
3494 
3495  :param baseName: The prefix to use when naming automatically created FieldML objects in the context.
3496  :type baseName: string
3497  :param dofFormat: The name of the format to use when writing dof data.
3498  :type dofFormat: string
3499  :param field: The field to add to the FieldML context.
3500  :type field: Field
3501  :param variableType: The variable type of the field to add to the FieldML context.
3502  :type variableType: int
3503  :param setType: The parameter set type.
3504  :type setType: int
3505  :param typeHandle: The FieldML type to assign to the new FieldML field.
3506  :type typeHandle: int
3507  :rtype: None
3508  """
3509 
3510  fieldml = self
3511  return _wrap_routine(_iron_python.cmfe_FieldML_OutputAddFieldWithType, [fieldml, baseName, dofFormat, field, variableType, setType, typeHandle])
3512 
3513  def OutputAddImport(self, name):
3514  """Import a FieldML object from the library into the current session.
3515 
3516  :param name: The name of the object to import.
3517  :type name: string
3518  :returns: handle. A handle to the newly imported FieldML object.
3519  :rtype: int
3520  """
3521 
3522  fieldml = self
3523  return _wrap_routine(_iron_python.cmfe_FieldML_OutputAddImport, [fieldml, name])
3524 
3525  def OutputCreateNum(self, regionNumber, meshNumber, location, baseName, connectivityFormat):
3526  """Initialise the given FieldML context using the mesh with the given user number.
3527 
3528  :param regionNumber: The user number of the region owning the mesh to use when initialising the FieldML context.
3529  :type regionNumber: int
3530  :param meshNumber: The user number of the mesh to use when initialising the FieldML context.
3531  :type meshNumber: int
3532  :param location: The root directory in which associated data files should be created.
3533  :type location: string
3534  :param baseName: The prefix to use when naming automatically created FieldML objects in the context.
3535  :type baseName: string
3536  :param connectivityFormat: The name of the format to use when writing connectivity data.
3537  :type connectivityFormat: string
3538  :rtype: None
3539  """
3540 
3541  fieldml = self
3542  return _wrap_routine(_iron_python.cmfe_FieldML_OutputCreateNum, [regionNumber, meshNumber, location, baseName, connectivityFormat, fieldml])
3543 
3544  def OutputCreate(self, mesh, location, baseName, connectivityFormat):
3545  """Initialise the given FieldML context using the given mesh.
3546 
3547  :param mesh: The mesh to use when initialising the FieldML context.
3548  :type mesh: Mesh
3549  :param location: The root directory in which associated data files should be created.
3550  :type location: string
3551  :param baseName: The prefix to use when naming automatically created FieldML objects in the context.
3552  :type baseName: string
3553  :param connectivityFormat: The name of the format to use when writing connectivity data.
3554  :type connectivityFormat: string
3555  :rtype: None
3556  """
3557 
3558  fieldml = self
3559  return _wrap_routine(_iron_python.cmfe_FieldML_OutputCreate, [mesh, location, baseName, connectivityFormat, fieldml])
3560 
3561  def OutputWrite(self, filename):
3562  """Write the FieldML document managed by the given context to a file with the given name.
3563 
3564  :param filename: The name of the file to write the FieldML document to.
3565  :type filename: string
3566  :rtype: None
3567  """
3568 
3569  fieldml = self
3570  return _wrap_routine(_iron_python.cmfe_FieldML_OutputWrite, [fieldml, filename])
3571 
3572 
3573 class Field(CMFEType):
3574  """Contains information for a field defined on a region.
3575  """
3576 
3577  def __init__(self):
3578  """Initialise a null cmfe_FieldType"""
3579 
3580  self.cmiss_type = _wrap_routine(_iron_python.cmfe_Field_Initialise, None)
3581 
3582  def ComponentInterpolationGet(self, variableType, componentNumber):
3583  """Returns the interpolation type for a field variable component for a field identified by an object.
3584 
3585  :param variableType: The variable type of the field to get the interpolation type for. Must be a value from the FieldVariableTypes enum.
3586  :type variableType: int
3587  :param componentNumber: The component number of the field variable to get the interpolation type for.
3588  :type componentNumber: int
3589  :returns: interpolationType. The interpolation type. Will be a value from the FieldInterpolationTypes enum.
3590  :rtype: int
3591  """
3592 
3593  field = self
3594  return _wrap_routine(_iron_python.cmfe_Field_ComponentInterpolationGet, [field, variableType, componentNumber])
3595 
3596  def ComponentInterpolationSet(self, variableType, componentNumber, interpolationType):
3597  """Sets/changes the interpolation type for a field variable component for a field identified by an object.
3598 
3599  :param variableType: The variable type of the field to set the interpolation type for. Must be a value from the FieldVariableTypes enum.
3600  :type variableType: int
3601  :param componentNumber: The component number of the field variable to set the interpolation type for.
3602  :type componentNumber: int
3603  :param interpolationType: The interpolation type to set. Must be a value from the FieldInterpolationTypes enum.
3604  :type interpolationType: int
3605  :rtype: None
3606  """
3607 
3608  field = self
3609  return _wrap_routine(_iron_python.cmfe_Field_ComponentInterpolationSet, [field, variableType, componentNumber, interpolationType])
3610 
3611  def ComponentLabelGet(self, variableType, componentNumber):
3612  """Returns the character string label for a field variable component for a field identified by an object.
3613 
3614  :param variableType: The variable type of the field to get the label for. Must be a value from the FieldVariableTypes enum.
3615  :type variableType: int
3616  :param componentNumber: The component number of the field variable to get the label for.
3617  :type componentNumber: int
3618  :returns: label. The field variable component label.
3619  :rtype: string
3620  """
3621 
3622  field = self
3623  return _wrap_routine(_iron_python.cmfe_Field_ComponentLabelGet, [field, variableType, componentNumber])
3624 
3625  def ComponentLabelSet(self, variableType, componentNumber, label):
3626  """Sets/changes the character string label for a field variable component for a field identified by an object.
3627 
3628  :param variableType: The variable type of the field to set the label for. Must be a value from the FieldVariableTypes enum.
3629  :type variableType: int
3630  :param componentNumber: The component number of the field variable to set the label for.
3631  :type componentNumber: int
3632  :param label: The field variable component label to set.
3633  :type label: string
3634  :rtype: None
3635  """
3636 
3637  field = self
3638  return _wrap_routine(_iron_python.cmfe_Field_ComponentLabelSet, [field, variableType, componentNumber, label])
3639 
3640  def ComponentMeshComponentGet(self, variableType, componentNumber):
3641  """Returns the mesh component number for a field variable component for a field identified by an object.
3642 
3643  :param variableType: The variable type of the field to get the mesh component number for. Must be a value from the FieldVariableTypes enum.
3644  :type variableType: int
3645  :param componentNumber: The component number of the field variable to get the mesh component number for.
3646  :type componentNumber: int
3647  :returns: meshComponent. The mesh component number.
3648  :rtype: int
3649  """
3650 
3651  field = self
3652  return _wrap_routine(_iron_python.cmfe_Field_ComponentMeshComponentGet, [field, variableType, componentNumber])
3653 
3654  def ComponentMeshComponentSet(self, variableType, componentNumber, meshComponent):
3655  """Sets/changes the mesh component number for a field variable component for a field identified by an object.
3656 
3657  :param variableType: The variable type of the field to set the mesh component number for. Must be a value from the FieldVariableTypes enum.
3658  :type variableType: int
3659  :param componentNumber: The component number of the field variable to set the mesh component number for.
3660  :type componentNumber: int
3661  :param meshComponent: The mesh component number to set.
3662  :type meshComponent: int
3663  :rtype: None
3664  """
3665 
3666  field = self
3667  return _wrap_routine(_iron_python.cmfe_Field_ComponentMeshComponentSet, [field, variableType, componentNumber, meshComponent])
3668 
3669  def ComponentValuesInitialiseDP(self, variableType, fieldSetType, componentNumber, value):
3670  """Initialises the values of parameter set of a field variable component to a double precision constant value for a field identified by an object.
3671 
3672  :param variableType: The variable type of the field to initialise the field variable component for. Must be a value from the FieldVariableTypes enum.
3673  :type variableType: int
3674  :param fieldSetType: The parameter set type of the field to initialise the field variable component for. Must be a value from the FieldParameterSetTypes enum.
3675  :type fieldSetType: int
3676  :param componentNumber: The component number of the field variable to initialise the field variable component for.
3677  :type componentNumber: int
3678  :param value: The value to initialise the parameter set for.
3679  :type value: float
3680  :rtype: None
3681  """
3682 
3683  field = self
3684  return _wrap_routine(_iron_python.cmfe_Field_ComponentValuesInitialiseDP, [field, variableType, fieldSetType, componentNumber, value])
3685 
3686  def ComponentValuesInitialiseIntg(self, variableType, fieldSetType, componentNumber, value):
3687  """Initialises the values of parameter set of a field variable component to an integer constant value for a field identified by an object.
3688 
3689  :param variableType: The variable type of the field to initialise the field variable component for. Must be a value from the FieldVariableTypes enum.
3690  :type variableType: int
3691  :param fieldSetType: The parameter set type of the field to initialise the field variable component for. Must be a value from the FieldParameterSetTypes enum.
3692  :type fieldSetType: int
3693  :param componentNumber: The component number of the field variable to initialise the field variable component for.
3694  :type componentNumber: int
3695  :param value: The value to initialise the parameter set for.
3696  :type value: int
3697  :rtype: None
3698  """
3699 
3700  field = self
3701  return _wrap_routine(_iron_python.cmfe_Field_ComponentValuesInitialiseIntg, [field, variableType, fieldSetType, componentNumber, value])
3702 
3703  def ComponentValuesInitialiseL(self, variableType, fieldSetType, componentNumber, value):
3704  """Initialises the values of parameter set of a field variable component to a logical constant value for a field identified by an object.
3705 
3706  :param variableType: The variable type of the field to initialise the field variable component for. Must be a value from the FieldVariableTypes enum.
3707  :type variableType: int
3708  :param fieldSetType: The parameter set type of the field to initialise the field variable component for. Must be a value from the FieldParameterSetTypes enum.
3709  :type fieldSetType: int
3710  :param componentNumber: The component number of the field variable to initialise the field variable component for.
3711  :type componentNumber: int
3712  :param value: The value to initialise the parameter set for.
3713  :type value: bool
3714  :rtype: None
3715  """
3716 
3717  field = self
3718  return _wrap_routine(_iron_python.cmfe_Field_ComponentValuesInitialiseL, [field, variableType, fieldSetType, componentNumber, value])
3719 
3720  def ComponentValuesInitialiseSP(self, variableType, fieldSetType, componentNumber, value):
3721  """Initialises the values of parameter set of a field variable component to a single precision constant value for a field identified by an object.
3722 
3723  :param variableType: The variable type of the field to initialise the field variable component for. Must be a value from the FieldVariableTypes enum.
3724  :type variableType: int
3725  :param fieldSetType: The parameter set type of the field to initialise the field variable component for. Must be a value from the FieldParameterSetTypes enum.
3726  :type fieldSetType: int
3727  :param componentNumber: The component number of the field variable to initialise the field variable component for.
3728  :type componentNumber: int
3729  :param value: The value to initialise the parameter set for.
3730  :type value: float
3731  :rtype: None
3732  """
3733 
3734  field = self
3735  return _wrap_routine(_iron_python.cmfe_Field_ComponentValuesInitialiseSP, [field, variableType, fieldSetType, componentNumber, value])
3736 
3737  def CreateFinish(self):
3738  """Finishes the creation of a field identified by an object.
3739 
3740  :rtype: None
3741  """
3742 
3743  field = self
3744  return _wrap_routine(_iron_python.cmfe_Field_CreateFinish, [field])
3745 
3746  def CreateStartInterface(self, fieldUserNumber, interface):
3747  """Starts the creation of a field on an interface identified by an object.
3748 
3749  :param fieldUserNumber: The user number of the field to start the creation of.
3750  :type fieldUserNumber: int
3751  :param interface: The interface to create the field on.
3752  :type interface: Interface
3753  :rtype: None
3754  """
3755 
3756  field = self
3757  return _wrap_routine(_iron_python.cmfe_Field_CreateStartInterface, [fieldUserNumber, interface, field])
3758 
3759  def CreateStart(self, fieldUserNumber, region):
3760  """Starts the creation of a field on a region identified by an object.
3761 
3762  :param fieldUserNumber: The user number of the field to start the creation of.
3763  :type fieldUserNumber: int
3764  :param region: The region to create the field on.
3765  :type region: Region
3766  :rtype: None
3767  """
3768 
3769  field = self
3770  return _wrap_routine(_iron_python.cmfe_Field_CreateStart, [fieldUserNumber, region, field])
3771 
3772  def DOFOrderTypeGet(self, variableType):
3773  """Returns the DOF Order type for a field variable for a field identified by an object.
3774 
3775  :param variableType: The variable type of the field to get the DOF order type for. Must be a value from the FieldVariableTypes enum.
3776  :type variableType: int
3777  :returns: DOFOrderType. The field variable DOF order type. Will be a value from the FieldDOFOrderTypes enum.
3778  :rtype: int
3779  """
3780 
3781  field = self
3782  return _wrap_routine(_iron_python.cmfe_Field_DOFOrderTypeGet, [field, variableType])
3783 
3784  def DOFOrderTypeSet(self, variableType, DOFOrderType):
3785  """Sets/changes the DOF Order type for a field variable for a field identified by an object.
3786 
3787  :param variableType: The variable type of the field to set the DOF order type for. Must be a value from the FieldVariableTypes enum.
3788  :type variableType: int
3789  :param DOFOrderType: The field variable DOF order type to set. Must be a value from the FieldDOFOrderTypes enum.
3790  :type DOFOrderType: int
3791  :rtype: None
3792  """
3793 
3794  field = self
3795  return _wrap_routine(_iron_python.cmfe_Field_DOFOrderTypeSet, [field, variableType, DOFOrderType])
3796 
3797  def DataProjectionSet(self, dataProjection):
3798  """Sets/changes the data projection for a field identified by an object.
3799 
3800  :param dataProjection: The data projection for the field to set.
3801  :type dataProjection: DataProjection
3802  :rtype: None
3803  """
3804 
3805  field = self
3806  return _wrap_routine(_iron_python.cmfe_Field_DataProjectionSet, [field, dataProjection])
3807 
3808  def DataTypeGet(self, variableType):
3809  """Returns the data type for a field variable for a field identified by an object.
3810 
3811  :param variableType: The variable type of the field to get the data type for. Must be a value from the FieldVariableTypes enum.
3812  :type variableType: int
3813  :returns: dataType. The field variable data type. Will be a value from the FieldDataTypes enum.
3814  :rtype: int
3815  """
3816 
3817  field = self
3818  return _wrap_routine(_iron_python.cmfe_Field_DataTypeGet, [field, variableType])
3819 
3820  def DataTypeSet(self, variableType, dataType):
3821  """Sets/changes the data type for a field variable for a field identified by an object.
3822 
3823  :param variableType: The variable type of the field to set the data type for. Must be a value from the FieldVariableTypes enum.
3824  :type variableType: int
3825  :param dataType: The field variable data type to set. Must be a value from the FieldDataTypes enum.
3826  :type dataType: int
3827  :rtype: None
3828  """
3829 
3830  field = self
3831  return _wrap_routine(_iron_python.cmfe_Field_DataTypeSet, [field, variableType, dataType])
3832 
3833  def DependentTypeGet(self):
3834  """Returns the dependent type for a field identified by an object.
3835 
3836  :returns: dependentType. The field dependent type. Will be a value from the FieldDependentTypes enum.
3837  :rtype: int
3838  """
3839 
3840  field = self
3841  return _wrap_routine(_iron_python.cmfe_Field_DependentTypeGet, [field])
3842 
3843  def DependentTypeSet(self, dependentType):
3844  """Sets/changes the dependent type for a field identified by an object.
3845 
3846  :param dependentType: The field dependent type to set. Must be a value from the FieldDependentTypes enum.
3847  :type dependentType: int
3848  :rtype: None
3849  """
3850 
3851  field = self
3852  return _wrap_routine(_iron_python.cmfe_Field_DependentTypeSet, [field, dependentType])
3853 
3854  def Destroy(self):
3855  """Destroys a field identified by an object.
3856 
3857  :rtype: None
3858  """
3859 
3860  field = self
3861  return _wrap_routine(_iron_python.cmfe_Field_Destroy, [field])
3862 
3863  def DimensionGet(self, variableType):
3864  """Returns the dimension for a field identified by an object.
3865 
3866  :param variableType: The variable type of the field to get the dimension for. Must be a value from the FieldVariableTypes enum.
3867  :type variableType: int
3868  :returns: dimension. The field dimension. Will be a value from the FieldDimension enum.
3869  :rtype: int
3870  """
3871 
3872  field = self
3873  return _wrap_routine(_iron_python.cmfe_Field_DimensionGet, [field, variableType])
3874 
3875  def DimensionSet(self, variableType, dimension):
3876  """Sets/changes the dimension for a field identified by an object.
3877 
3878  :param variableType: The variable type of the field to get the dimension for. Must be a value from the FieldVariableTypes enum.
3879  :type variableType: int
3880  :param dimension: The field dimension to set. Must be a value from the FieldDimension enum.
3881  :type dimension: int
3882  :rtype: None
3883  """
3884 
3885  field = self
3886  return _wrap_routine(_iron_python.cmfe_Field_DimensionSet, [field, variableType, dimension])
3887 
3888  def Finalise(self):
3889  """Finalises a cmfe_FieldType object.
3890 
3891  :rtype: None
3892  """
3893 
3894  cmfe_Field = self
3895  return _wrap_routine(_iron_python.cmfe_Field_Finalise, [cmfe_Field])
3896 
3897  def GeometricFieldGet(self, geometricField):
3898  """Returns the geometric field for a field identified by an object.
3899 
3900  :param geometricField: On return, the geometric field for the field.
3901  :type geometricField: Field
3902  :rtype: None
3903  """
3904 
3905  field = self
3906  return _wrap_routine(_iron_python.cmfe_Field_GeometricFieldGet, [field, geometricField])
3907 
3908  def GeometricFieldSet(self, geometricField):
3909  """Sets/changes the geometric field for a field identified by an object.
3910 
3911  :param geometricField: The geometric field for the field to set.
3912  :type geometricField: Field
3913  :rtype: None
3914  """
3915 
3916  field = self
3917  return _wrap_routine(_iron_python.cmfe_Field_GeometricFieldSet, [field, geometricField])
3918 
3919  def GeometricParametersElementLineLengthGet(self, elementNumber, elementLineNumber):
3920  """Gets the line length between nodes of a geometric field for a given element number and element basis line number by an object.
3921 
3922  :param elementNumber: The element to get the line length for
3923  :type elementNumber: int
3924  :param elementLineNumber: The element basis line to get the length for
3925  :type elementLineNumber: int
3926  :returns: lineLength. The line length of the chosen element line number
3927  :rtype: float
3928  """
3929 
3930  geometricField = self
3931  return _wrap_routine(_iron_python.cmfe_Field_GeometricParametersElementLineLengthGet, [geometricField, elementNumber, elementLineNumber])
3932 
3933  def GeometricParametersElementVolumeGet(self, elementNumber):
3934  """Gets the volume for a given element number by an object.
3935 
3936  :param elementNumber: The element to get the volume for
3937  :type elementNumber: int
3938  :returns: elementVolume. The volume of the chosen element
3939  :rtype: float
3940  """
3941 
3942  geometricField = self
3943  return _wrap_routine(_iron_python.cmfe_Field_GeometricParametersElementVolumeGet, [geometricField, elementNumber])
3944 
3945  def LabelGet(self):
3946  """Returns the character string label for a field identified by an object.
3947 
3948  :returns: label. The field label.
3949  :rtype: string
3950  """
3951 
3952  field = self
3953  return _wrap_routine(_iron_python.cmfe_Field_LabelGet, [field])
3954 
3955  def LabelSet(self, label):
3956  """Sets/changes the character string label for a field identified by an object.
3957 
3958  :param label: The field label to set.
3959  :type label: string
3960  :rtype: None
3961  """
3962 
3963  field = self
3964  return _wrap_routine(_iron_python.cmfe_Field_LabelSet, [field, label])
3965 
3966  def MeshDecompositionGet(self, meshDecomposition):
3967  """Returns the mesh decomposition for a field identified by an object.
3968 
3969  :param meshDecomposition: On return, the mesh decomposition for the field.
3970  :type meshDecomposition: Decomposition
3971  :rtype: None
3972  """
3973 
3974  field = self
3975  return _wrap_routine(_iron_python.cmfe_Field_MeshDecompositionGet, [field, meshDecomposition])
3976 
3977  def MeshDecompositionSet(self, meshDecomposition):
3978  """Sets/changes the mesh decomposition for a field identified by an object.
3979 
3980  :param meshDecomposition: The mesh decomposition for the field to set.
3981  :type meshDecomposition: Decomposition
3982  :rtype: None
3983  """
3984 
3985  field = self
3986  return _wrap_routine(_iron_python.cmfe_Field_MeshDecompositionSet, [field, meshDecomposition])
3987 
3988  def NumberOfComponentsGet(self, variableType):
3989  """Returns the number of components for a field variable for a field identified by an object.
3990 
3991  :param variableType: The variable type of the dependent field to get the number of components for. Must be a value from the FieldVariableTypes enum.
3992  :type variableType: int
3993  :returns: numberOfComponents. The number of components in the field variable.
3994  :rtype: int
3995  """
3996 
3997  field = self
3998  return _wrap_routine(_iron_python.cmfe_Field_NumberOfComponentsGet, [field, variableType])
3999 
4000  def NumberOfComponentsSet(self, variableType, numberOfComponents):
4001  """Sets/changes the number of components for a field variable for a field identified by an object.
4002 
4003  :param variableType: The variable type of the dependent field to set the number of components for. Must be a value from the FieldVariableTypes enum.
4004  :type variableType: int
4005  :param numberOfComponents: The number of components in the field variable to set.
4006  :type numberOfComponents: int
4007  :rtype: None
4008  """
4009 
4010  field = self
4011  return _wrap_routine(_iron_python.cmfe_Field_NumberOfComponentsSet, [field, variableType, numberOfComponents])
4012 
4014  """Returns the number of variables for a field identified by an object.
4015 
4016  :returns: numberOfVariables. The number of variables in the field.
4017  :rtype: int
4018  """
4019 
4020  field = self
4021  return _wrap_routine(_iron_python.cmfe_Field_NumberOfVariablesGet, [field])
4022 
4023  def NumberOfVariablesSet(self, numberOfVariables):
4024  """Sets/changes the number of variables for a field identified by an object.
4025 
4026  :param numberOfVariables: The number of variables in the field to set.
4027  :type numberOfVariables: int
4028  :rtype: None
4029  """
4030 
4031  field = self
4032  return _wrap_routine(_iron_python.cmfe_Field_NumberOfVariablesSet, [field, numberOfVariables])
4033 
4034  def ParameterSetAddConstantDP(self, variableType, fieldSetType, componentNumber, value):
4035  """Adds the given double precision value to the given parameter set for the constant of the field variable component for a field identified by an object.
4036 
4037  :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.
4038  :type variableType: int
4039  :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.
4040  :type fieldSetType: int
4041  :param componentNumber: The component number of the field variable to add the constant to the field parameter set for.
4042  :type componentNumber: int
4043  :param value: The value to add to the field parameter set.
4044  :type value: float
4045  :rtype: None
4046  """
4047 
4048  field = self
4049  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddConstantDP, [field, variableType, fieldSetType, componentNumber, value])
4050 
4051  def ParameterSetAddConstantIntg(self, variableType, fieldSetType, componentNumber, value):
4052  """Adds the given integer value to the given parameter set for the constant of the field variable component for a field identified by an object.
4053 
4054  :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.
4055  :type variableType: int
4056  :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.
4057  :type fieldSetType: int
4058  :param componentNumber: The component number of the field variable to add the constant to the field parameter set for.
4059  :type componentNumber: int
4060  :param value: The value to add to the field parameter set.
4061  :type value: int
4062  :rtype: None
4063  """
4064 
4065  field = self
4066  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddConstantIntg, [field, variableType, fieldSetType, componentNumber, value])
4067 
4068  def ParameterSetAddConstantL(self, variableType, fieldSetType, componentNumber, value):
4069  """Adds the given logical value to the given parameter set for the constant of the field variable component for a field identified by an object.
4070 
4071  :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.
4072  :type variableType: int
4073  :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.
4074  :type fieldSetType: int
4075  :param componentNumber: The component number of the field variable to add the constant to the field parameter set for.
4076  :type componentNumber: int
4077  :param value: The value to add to the field parameter set.
4078  :type value: bool
4079  :rtype: None
4080  """
4081 
4082  field = self
4083  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddConstantL, [field, variableType, fieldSetType, componentNumber, value])
4084 
4085  def ParameterSetAddConstantSP(self, variableType, fieldSetType, componentNumber, value):
4086  """Adds the given single precision value to the given parameter set for the constant of the field variable component for a field identified by an object.
4087 
4088  :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.
4089  :type variableType: int
4090  :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.
4091  :type fieldSetType: int
4092  :param componentNumber: The component number of the field variable to add the constant to the field parameter set for.
4093  :type componentNumber: int
4094  :param value: The value to add to the field parameter set.
4095  :type value: float
4096  :rtype: None
4097  """
4098 
4099  field = self
4100  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddConstantSP, [field, variableType, fieldSetType, componentNumber, value])
4101 
4102  def ParameterSetAddElementDP(self, variableType, fieldSetType, userElementNumber, componentNumber, value):
4103  """Adds the given double precision value to an element in the given parameter set for field variable component for a field identified by an object.
4104 
4105  :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.
4106  :type variableType: int
4107  :param fieldSetType: The parameter set type of the field to add the value to the element. Must be a value from the FieldParameterSetTypes enum.
4108  :type fieldSetType: int
4109  :param userElementNumber: The user element number to add the value to.
4110  :type userElementNumber: int
4111  :param componentNumber: The component number of the field variable to add the value to the element to in the field parameter set.
4112  :type componentNumber: int
4113  :param value: The value to add to the element in the field parameter set.
4114  :type value: float
4115  :rtype: None
4116  """
4117 
4118  field = self
4119  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddElementDP, [field, variableType, fieldSetType, userElementNumber, componentNumber, value])
4120 
4121  def ParameterSetAddElementIntg(self, variableType, fieldSetType, userElementNumber, componentNumber, value):
4122  """Adds the given integer value to an element in the given parameter set for field variable component for a field identified by an object.
4123 
4124  :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.
4125  :type variableType: int
4126  :param fieldSetType: The parameter set type of the field to add the value to the element. Must be a value from the FieldParameterSetTypes enum.
4127  :type fieldSetType: int
4128  :param userElementNumber: The user element number to add the value to.
4129  :type userElementNumber: int
4130  :param componentNumber: The component number of the field variable to add the value to the element to in the field parameter set.
4131  :type componentNumber: int
4132  :param value: The value to add to the element in the field parameter set.
4133  :type value: int
4134  :rtype: None
4135  """
4136 
4137  field = self
4138  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddElementIntg, [field, variableType, fieldSetType, userElementNumber, componentNumber, value])
4139 
4140  def ParameterSetAddElementL(self, variableType, fieldSetType, userElementNumber, componentNumber, value):
4141  """Adds the given logical value to an element in the given parameter set for field variable component for a field identified by an object.
4142 
4143  :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.
4144  :type variableType: int
4145  :param fieldSetType: The parameter set type of the field to add the value to the element. Must be a value from the FieldParameterSetTypes enum.
4146  :type fieldSetType: int
4147  :param userElementNumber: The user element number to add the value to.
4148  :type userElementNumber: int
4149  :param componentNumber: The component number of the field variable to add the value to the element to in the field parameter set.
4150  :type componentNumber: int
4151  :param value: The value to add to the element in the field parameter set.
4152  :type value: bool
4153  :rtype: None
4154  """
4155 
4156  field = self
4157  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddElementL, [field, variableType, fieldSetType, userElementNumber, componentNumber, value])
4158 
4159  def ParameterSetAddElementSP(self, variableType, fieldSetType, userElementNumber, componentNumber, value):
4160  """Adds the given single precision value to an element in the given parameter set for field variable component for a field identified by an object.
4161 
4162  :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.
4163  :type variableType: int
4164  :param fieldSetType: The parameter set type of the field to add the value to the element. Must be a value from the FieldParameterSetTypes enum.
4165  :type fieldSetType: int
4166  :param userElementNumber: The user element number to add the value to.
4167  :type userElementNumber: int
4168  :param componentNumber: The component number of the field variable to add the value to the element to in the field parameter set.
4169  :type componentNumber: int
4170  :param value: The value to add to the element in the field parameter set.
4171  :type value: float
4172  :rtype: None
4173  """
4174 
4175  field = self
4176  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddElementSP, [field, variableType, fieldSetType, userElementNumber, componentNumber, value])
4177 
4178  def ParameterSetAddNodeDP(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value):
4179  """Adds the given double precision value to an node in the given parameter set for field variable component for a field identified by an object.
4180 
4181  :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.
4182  :type variableType: int
4183  :param fieldSetType: The parameter set type of the field to add the value to the node. Must be a value from the FieldParameterSetTypes enum.
4184  :type fieldSetType: int
4185  :param versionNumber: The node derivative version number of the node to add the value to.
4186  :type versionNumber: int
4187  :param derivativeNumber: The node derivative number of the node to add the value to.
4188  :type derivativeNumber: int
4189  :param userNodeNumber: The user node number to add the value to.
4190  :type userNodeNumber: int
4191  :param componentNumber: The component number of the field variable to add the value to the node to in the field parameter set.
4192  :type componentNumber: int
4193  :param value: The value to add to the node in the field parameter set.
4194  :type value: float
4195  :rtype: None
4196  """
4197 
4198  field = self
4199  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddNodeDP, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value])
4200 
4201  def ParameterSetAddNodeIntg(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value):
4202  """Adds the given integer value to an node in the given parameter set for field variable component for a field identified by an object.
4203 
4204  :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.
4205  :type variableType: int
4206  :param fieldSetType: The parameter set type of the field to add the value to the node. Must be a value from the FieldParameterSetTypes enum.
4207  :type fieldSetType: int
4208  :param versionNumber: The node derivative version number of the node to add the value to.
4209  :type versionNumber: int
4210  :param derivativeNumber: The node derivative number of the node to add the value to.
4211  :type derivativeNumber: int
4212  :param userNodeNumber: The user node number to add the value to.
4213  :type userNodeNumber: int
4214  :param componentNumber: The component number of the field variable to add the value to the node to in the field parameter set.
4215  :type componentNumber: int
4216  :param value: The value to add to the node in the field parameter set.
4217  :type value: int
4218  :rtype: None
4219  """
4220 
4221  field = self
4222  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddNodeIntg, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value])
4223 
4224  def ParameterSetAddNodeL(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value):
4225  """Adds the given logical value to an node in the given parameter set for field variable component for a field identified by an object.
4226 
4227  :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.
4228  :type variableType: int
4229  :param fieldSetType: The parameter set type of the field to add the value to the node. Must be a value from the FieldParameterSetTypes enum.
4230  :type fieldSetType: int
4231  :param versionNumber: The node derivative version number of the node to add the value to.
4232  :type versionNumber: int
4233  :param derivativeNumber: The node derivative number of the node to add the value to.
4234  :type derivativeNumber: int
4235  :param userNodeNumber: The user node number to add the value to.
4236  :type userNodeNumber: int
4237  :param componentNumber: The component number of the field variable to add the value to the node to in the field parameter set.
4238  :type componentNumber: int
4239  :param value: The value to add to the node in the field parameter set.
4240  :type value: bool
4241  :rtype: None
4242  """
4243 
4244  field = self
4245  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddNodeL, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value])
4246 
4247  def ParameterSetAddNodeSP(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value):
4248  """Adds the given single precision value to an node in the given parameter set for field variable component for a field identified by an object.
4249 
4250  :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.
4251  :type variableType: int
4252  :param fieldSetType: The parameter set type of the field to add the value to the node. Must be a value from the FieldParameterSetTypes enum.
4253  :type fieldSetType: int
4254  :param versionNumber: The node derivative version number of the node to add the value to.
4255  :type versionNumber: int
4256  :param derivativeNumber: The node derivative number of the node to add the value to.
4257  :type derivativeNumber: int
4258  :param userNodeNumber: The user node number to add the value to.
4259  :type userNodeNumber: int
4260  :param componentNumber: The component number of the field variable to add the value to the node to in the field parameter set.
4261  :type componentNumber: int
4262  :param value: The value to add to the node in the field parameter set.
4263  :type value: float
4264  :rtype: None
4265  """
4266 
4267  field = self
4268  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetAddNodeSP, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value])
4269 
4270  def ParameterSetCreate(self, variableType, fieldSetType):
4271  """Creates a new parameter set of type set type for a field variable for a field identified by an object.
4272 
4273  :param variableType: The variable type of the field to create the parameter set on. Must be a value from the FieldVariableTypes enum.
4274  :type variableType: int
4275  :param fieldSetType: The parameter set type of the field to create. Must be a value from the FieldParameterSetTypes enum.
4276  :type fieldSetType: int
4277  :rtype: None
4278  """
4279 
4280  field = self
4281  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetCreate, [field, variableType, fieldSetType])
4282 
4283  def ParameterSetDataGetDP(self, variableType, fieldSetType):
4284  """Returns a pointer to the specified field parameter set local double precision data array for a field identified by an object. 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.
4285 
4286  :param variableType: The variable type of the field to get the parameter set data for. Must be a value from the FieldVariableTypes enum.
4287  :type variableType: int
4288  :param fieldSetType: The parameter set type of the parameter set data to get. Must be a value from the FieldParameterSetTypes enum.
4289  :type fieldSetType: int
4290  :param parametersSize: Size of parameters to allocate.
4291  :returns: parameters. A pointer to the parameter set data.
4292  :rtype: Array of floats
4293  """
4294 
4295  field = self
4296  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetDataGetDP, [field, variableType, fieldSetType])
4297 
4298  def ParameterSetDataGetIntg(self, variableType, fieldSetType):
4299  """Returns a pointer to the specified field parameter set local integer data array for a field identified by an object. 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.
4300 
4301  :param variableType: The variable type of the field to get the parameter set data for. Must be a value from the FieldVariableTypes enum.
4302  :type variableType: int
4303  :param fieldSetType: The parameter set type of the parameter set data to get. Must be a value from the FieldParameterSetTypes enum.
4304  :type fieldSetType: int
4305  :param parametersSize: Size of parameters to allocate.
4306  :returns: parameters. A pointer to the parameter set data.
4307  :rtype: Array of ints
4308  """
4309 
4310  field = self
4311  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetDataGetIntg, [field, variableType, fieldSetType])
4312 
4313  def ParameterSetDataGetL(self, variableType, fieldSetType):
4314  """Returns a pointer to the specified field parameter set local logical data array for a field identified by an object. 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.
4315 
4316  :param variableType: The variable type of the field to get the parameter set data for. Must be a value from the FieldVariableTypes enum.
4317  :type variableType: int
4318  :param fieldSetType: The parameter set type of the parameter set data to get. Must be a value from the FieldParameterSetTypes enum.
4319  :type fieldSetType: int
4320  :param parametersSize: Size of parameters to allocate.
4321  :returns: parameters. A pointer to the parameter set data.
4322  :rtype: Array of bools
4323  """
4324 
4325  field = self
4326  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetDataGetL, [field, variableType, fieldSetType])
4327 
4328  def ParameterSetDataGetSP(self, variableType, fieldSetType):
4329  """Returns a pointer to the specified field parameter set local single precision data array for a field identified by an object. 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.
4330 
4331  :param variableType: The variable type of the field to get the parameter set data for. Must be a value from the FieldVariableTypes enum.
4332  :type variableType: int
4333  :param fieldSetType: The parameter set type of the parameter set data to get. Must be a value from the FieldParameterSetTypes enum.
4334  :type fieldSetType: int
4335  :param parametersSize: Size of parameters to allocate.
4336  :returns: parameters. A pointer to the parameter set data.
4337  :rtype: Array of floats
4338  """
4339 
4340  field = self
4341  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetDataGetSP, [field, variableType, fieldSetType])
4342 
4343  def ParameterSetDataRestoreDP(self, variableType, fieldSetType, parameters):
4344  """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 object.
4345 
4346  :param variableType: The variable type of the field to restore the parameter set data for. Must be a value from the FieldVariableTypes enum.
4347  :type variableType: int
4348  :param fieldSetType: The parameter set type of the parameter set data to restore. Must be a value from the FieldParameterSetTypes enum.
4349  :type fieldSetType: int
4350  :param parameters: A pointer to the parameter set data to restore. On return this pointer is null.
4351  :type parameters: Array of floats
4352  :rtype: None
4353  """
4354 
4355  field = self
4356  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetDataRestoreDP, [field, variableType, fieldSetType, parameters])
4357 
4358  def ParameterSetDataRestoreIntg(self, variableType, fieldSetType, parameters):
4359  """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 object.
4360 
4361  :param variableType: The variable type of the field to restore the parameter set data for. Must be a value from the FieldVariableTypes enum.
4362  :type variableType: int
4363  :param fieldSetType: The parameter set type of the parameter set data to restore. Must be a value from the FieldParameterSetTypes enum.
4364  :type fieldSetType: int
4365  :param parameters: A pointer to the parameter set data to restore. On return this pointer is null.
4366  :type parameters: Array of ints
4367  :rtype: None
4368  """
4369 
4370  field = self
4371  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetDataRestoreIntg, [field, variableType, fieldSetType, parameters])
4372 
4373  def ParameterSetDataRestoreL(self, variableType, fieldSetType, parameters):
4374  """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 object.
4375 
4376  :param variableType: The variable type of the field to restore the parameter set data for. Must be a value from the FieldVariableTypes enum.
4377  :type variableType: int
4378  :param fieldSetType: The parameter set type of the parameter set data to restore. Must be a value from the FieldParameterSetTypes enum.
4379  :type fieldSetType: int
4380  :param parameters: A pointer to the parameter set data to restore. On return this pointer is null.
4381  :type parameters: Array of bools
4382  :rtype: None
4383  """
4384 
4385  field = self
4386  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetDataRestoreL, [field, variableType, fieldSetType, parameters])
4387 
4388  def ParameterSetDataRestoreSP(self, variableType, fieldSetType, parameters):
4389  """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 object.
4390 
4391  :param variableType: The variable type of the field to restore the parameter set data for. Must be a value from the FieldVariableTypes enum.
4392  :type variableType: int
4393  :param fieldSetType: The parameter set type of the parameter set data to restore. Must be a value from the FieldParameterSetTypes enum.
4394  :type fieldSetType: int
4395  :param parameters: A pointer to the parameter set data to restore.
4396  :type parameters: Array of floats
4397  :rtype: None
4398  """
4399 
4400  field = self
4401  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetDataRestoreSP, [field, variableType, fieldSetType, parameters])
4402 
4403  def ParameterSetDestroy(self, variableType, fieldSetType):
4404  """Destroys the specified parameter set type for a field variable for a field identified by an object.
4405 
4406  :param variableType: The variable type of the field to destroy the parameter set for. Must be a value from the FieldVariableTypes enum.
4407  :type variableType: int
4408  :param fieldSetType: The parameter set type of the field to destroy. Must be a value from the FieldParameterSetTypes enum.
4409  :type fieldSetType: int
4410  :rtype: None
4411  """
4412 
4413  field = self
4414  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetDestroy, [field, variableType, fieldSetType])
4415 
4416  def ParameterSetGetConstantDP(self, variableType, fieldSetType, componentNumber):
4417  """Returns from the given parameter set a double precision value for the specified constant of a field variable component for a field identified by an object.
4418 
4419  :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.
4420  :type variableType: int
4421  :param fieldSetType: The parameter set type of the field to get the constant value from. Must be a value from the FieldParameterSetTypes enum.
4422  :type fieldSetType: int
4423  :param componentNumber: The component number of the field variable to get the constant value from the field parameter set.
4424  :type componentNumber: int
4425  :returns: value. The value from the field parameter set.
4426  :rtype: float
4427  """
4428 
4429  field = self
4430  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetConstantDP, [field, variableType, fieldSetType, componentNumber])
4431 
4432  def ParameterSetGetConstantIntg(self, variableType, fieldSetType, componentNumber):
4433  """Returns from the given parameter set an integer value for the specified constant of a field variable component for a field identified by an object.
4434 
4435  :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.
4436  :type variableType: int
4437  :param fieldSetType: The parameter set type of the field to get the constant value from. Must be a value from the FieldParameterSetTypes enum.
4438  :type fieldSetType: int
4439  :param componentNumber: The component number of the field variable to get the constant value from the field parameter set.
4440  :type componentNumber: int
4441  :returns: value. The value from the field parameter set.
4442  :rtype: int
4443  """
4444 
4445  field = self
4446  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetConstantIntg, [field, variableType, fieldSetType, componentNumber])
4447 
4448  def ParameterSetGetConstantL(self, variableType, fieldSetType, componentNumber):
4449  """Returns from the given parameter set a logical value for the specified constant of a field variable component for a field identified by an object.
4450 
4451  :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.
4452  :type variableType: int
4453  :param fieldSetType: The parameter set type of the field to get the constant value from. Must be a value from the FieldParameterSetTypes enum.
4454  :type fieldSetType: int
4455  :param componentNumber: The component number of the field variable to get the constant value from the field parameter set.
4456  :type componentNumber: int
4457  :returns: value. The value from the field parameter set.
4458  :rtype: bool
4459  """
4460 
4461  field = self
4462  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetConstantL, [field, variableType, fieldSetType, componentNumber])
4463 
4464  def ParameterSetGetConstantSP(self, variableType, fieldSetType, componentNumber):
4465  """Returns from the given parameter set a single precision value for the specified constant of a field variable component for a field identified by an object.
4466 
4467  :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.
4468  :type variableType: int
4469  :param fieldSetType: The parameter set type of the field to get the constant value from. Must be a value from the FieldParameterSetTypes enum.
4470  :type fieldSetType: int
4471  :param componentNumber: The component number of the field variable to get the constant value from the field parameter set.
4472  :type componentNumber: int
4473  :returns: value. The value from the field parameter set.
4474  :rtype: float
4475  """
4476 
4477  field = self
4478  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetConstantSP, [field, variableType, fieldSetType, componentNumber])
4479 
4480  def ParameterSetGetDataPointDP(self, variableType, fieldSetType, userDataPointNumber, componentNumber):
4481  """Returns from the given parameter set a double precision value for the specified constant of a field variable component for a field identified by an object.
4482 
4483  :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.
4484  :type variableType: int
4485  :param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
4486  :type fieldSetType: int
4487  :param userDataPointNumber: The user data point number to get the value for
4488  :type userDataPointNumber: int
4489  :param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
4490  :type componentNumber: int
4491  :returns: value. The value from the field parameter set.
4492  :rtype: float
4493  """
4494 
4495  field = self
4496  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetDataPointDP, [field, variableType, fieldSetType, userDataPointNumber, componentNumber])
4497 
4498  def ParameterSetGetDataPointIntg(self, variableType, fieldSetType, userDataPointNumber, componentNumber):
4499  """Returns from the given parameter set a integer value for the specified constant of a field variable component for a field identified by an object.
4500 
4501  :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.
4502  :type variableType: int
4503  :param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
4504  :type fieldSetType: int
4505  :param userDataPointNumber: The user data point number to get the value for
4506  :type userDataPointNumber: int
4507  :param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
4508  :type componentNumber: int
4509  :returns: value. The value from the field parameter set.
4510  :rtype: int
4511  """
4512 
4513  field = self
4514  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetDataPointIntg, [field, variableType, fieldSetType, userDataPointNumber, componentNumber])
4515 
4516  def ParameterSetGetDataPointL(self, variableType, fieldSetType, userDataPointNumber, componentNumber):
4517  """Returns from the given parameter set a logical value for the specified constant of a field variable component for a field identified by an object.
4518 
4519  :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.
4520  :type variableType: int
4521  :param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
4522  :type fieldSetType: int
4523  :param userDataPointNumber: The user data point number to get the value for
4524  :type userDataPointNumber: int
4525  :param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
4526  :type componentNumber: int
4527  :returns: value. The value from the field parameter set.
4528  :rtype: bool
4529  """
4530 
4531  field = self
4532  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetDataPointL, [field, variableType, fieldSetType, userDataPointNumber, componentNumber])
4533 
4534  def ParameterSetGetDataPointSP(self, variableType, fieldSetType, userDataPointNumber, componentNumber):
4535  """Returns from the given parameter set a single precision value for the specified constant of a field variable component for a field identified by an object.
4536 
4537  :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.
4538  :type variableType: int
4539  :param fieldSetType: The parameter set type of the field to get the data point value from. Must be a value from the FieldParameterSetTypes enum.
4540  :type fieldSetType: int
4541  :param userDataPointNumber: The user data point number to get the value for
4542  :type userDataPointNumber: int
4543  :param componentNumber: The component number of the field variable to get the data point value from the field parameter set.
4544  :type componentNumber: int
4545  :returns: value. The value from the field parameter set.
4546  :rtype: float
4547  """
4548 
4549  field = self
4550  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetDataPointSP, [field, variableType, fieldSetType, userDataPointNumber, componentNumber])
4551 
4552  def ParameterSetGetElementDP(self, variableType, fieldSetType, userElementNumber, componentNumber):
4553  """Returns from the given parameter set a double precision value for the specified element of a field variable component for a field identified by an object.
4554 
4555  :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.
4556  :type variableType: int
4557  :param fieldSetType: The parameter set type of the field to get the element value from. Must be a value from the FieldParameterSetTypes enum.
4558  :type fieldSetType: int
4559  :param userElementNumber: The user element number to get the value from the field parameter set.
4560  :type userElementNumber: int
4561  :param componentNumber: The component number of the field variable to get the element value from the field parameter set.
4562  :type componentNumber: int
4563  :returns: value. The value from the field parameter set.
4564  :rtype: float
4565  """
4566 
4567  field = self
4568  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetElementDP, [field, variableType, fieldSetType, userElementNumber, componentNumber])
4569 
4570  def ParameterSetGetElementIntg(self, variableType, fieldSetType, userElementNumber, componentNumber):
4571  """Returns from the given parameter set an integer value for the specified element of a field variable component for a field identified by an object.
4572 
4573  :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.
4574  :type variableType: int
4575  :param fieldSetType: The parameter set type of the field to get the element value from. Must be a value from the FieldParameterSetTypes enum.
4576  :type fieldSetType: int
4577  :param userElementNumber: The user element number to get the value from the field parameter set.
4578  :type userElementNumber: int
4579  :param componentNumber: The component number of the field variable to get the element value from the field parameter set.
4580  :type componentNumber: int
4581  :returns: value. The value from the field parameter set.
4582  :rtype: int
4583  """
4584 
4585  field = self
4586  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetElementIntg, [field, variableType, fieldSetType, userElementNumber, componentNumber])
4587 
4588  def ParameterSetGetElementL(self, variableType, fieldSetType, userElementNumber, componentNumber):
4589  """Returns from the given parameter set a logical value for the specified element of a field variable component for a field identified by an object.
4590 
4591  :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.
4592  :type variableType: int
4593  :param fieldSetType: The parameter set type of the field to get the element value from. Must be a value from the FieldParameterSetTypes enum.
4594  :type fieldSetType: int
4595  :param userElementNumber: The user element number to get the value from the field parameter set.
4596  :type userElementNumber: int
4597  :param componentNumber: The component number of the field variable to get the element value from the field parameter set.
4598  :type componentNumber: int
4599  :returns: value. The value from the field parameter set.
4600  :rtype: bool
4601  """
4602 
4603  field = self
4604  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetElementL, [field, variableType, fieldSetType, userElementNumber, componentNumber])
4605 
4606  def ParameterSetGetElementSP(self, variableType, fieldSetType, userElementNumber, componentNumber):
4607  """Returns from the given parameter set a single precision value for the specified element of a field variable component for a field identified by an object.
4608 
4609  :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.
4610  :type variableType: int
4611  :param fieldSetType: The parameter set type of the field to get the element value from. Must be a value from the FieldParameterSetTypes enum.
4612  :type fieldSetType: int
4613  :param userElementNumber: The user element number to get the value from the field parameter set.
4614  :type userElementNumber: int
4615  :param componentNumber: The component number of the field variable to get the element value from the field parameter set.
4616  :type componentNumber: int
4617  :returns: value. The value from the field parameter set.
4618  :rtype: float
4619  """
4620 
4621  field = self
4622  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetElementSP, [field, variableType, fieldSetType, userElementNumber, componentNumber])
4623 
4624  def ParameterSetGetGaussPointDP(self, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber):
4625  """Returns from the given parameter set a double precision value for the specified element of a field variable component for a field identified by an object.
4626 
4627  :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.
4628  :type variableType: int
4629  :param fieldSetType: The parameter set type of the field to get the element value from. Must be a value from the FieldParameterSetTypes enum.
4630  :type fieldSetType: int
4631  :param gaussPointNumber: The gauss point number number to get the value from the field parameter set.
4632  :type gaussPointNumber: int
4633  :param userElementNumber: The user element number to get the value from the field parameter set.
4634  :type userElementNumber: int
4635  :param componentNumber: The component number of the field variable to get the element value from the field parameter set.
4636  :type componentNumber: int
4637  :returns: VALUE. The value from the field parameter set.
4638  :rtype: float
4639  """
4640 
4641  field = self
4642  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetGaussPointDP, [field, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber])
4643 
4644  def ParameterSetGetNodeDP(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber):
4645  """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 an object.
4646 
4647  :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.
4648  :type variableType: int
4649  :param fieldSetType: The parameter set type of the field to get the nodal value from. Must be a value from the FieldParameterSetTypes enum.
4650  :type fieldSetType: int
4651  :param versionNumber: The derivative version number to get the value from the field parameter set.
4652  :type versionNumber: int
4653  :param derivativeNumber: The derivative number to get the value from the field parameter set.
4654  :type derivativeNumber: int
4655  :param userNodeNumber: The user node number to get the value from the field parameter set.
4656  :type userNodeNumber: int
4657  :param componentNumber: The component number of the field variable to get the nodal value from the field parameter set.
4658  :type componentNumber: int
4659  :returns: value. The value from the field parameter set.
4660  :rtype: float
4661  """
4662 
4663  field = self
4664  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetNodeDP, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber])
4665 
4666  def ParameterSetGetNodeIntg(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber):
4667  """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 an object.
4668 
4669  :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.
4670  :type variableType: int
4671  :param fieldSetType: The parameter set type of the field to get the nodal value from. Must be a value from the FieldParameterSetTypes enum.
4672  :type fieldSetType: int
4673  :param versionNumber: The derivative version number to get the value from the field parameter set.
4674  :type versionNumber: int
4675  :param derivativeNumber: The derivative number to get the value from the field parameter set.
4676  :type derivativeNumber: int
4677  :param userNodeNumber: The user node number to get the value from the field parameter set.
4678  :type userNodeNumber: int
4679  :param componentNumber: The component number of the field variable to get the nodal value from the field parameter set.
4680  :type componentNumber: int
4681  :returns: value. The value from the field parameter set.
4682  :rtype: int
4683  """
4684 
4685  field = self
4686  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetNodeIntg, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber])
4687 
4688  def ParameterSetGetNodeL(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber):
4689  """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 an object.
4690 
4691  :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.
4692  :type variableType: int
4693  :param fieldSetType: The parameter set type of the field to get the nodal value from. Must be a value from the FieldParameterSetTypes enum.
4694  :type fieldSetType: int
4695  :param versionNumber: The derivative version number to get the value from the field parameter set.
4696  :type versionNumber: int
4697  :param derivativeNumber: The derivative number to get the value from the field parameter set.
4698  :type derivativeNumber: int
4699  :param userNodeNumber: The user node number to get the value from the field parameter set.
4700  :type userNodeNumber: int
4701  :param componentNumber: The component number of the field variable to get the nodal value from the field parameter set.
4702  :type componentNumber: int
4703  :returns: value. The value from the field parameter set.
4704  :rtype: bool
4705  """
4706 
4707  field = self
4708  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetNodeL, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber])
4709 
4710  def ParameterSetGetNodeSP(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber):
4711  """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 an object.
4712 
4713  :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.
4714  :type variableType: int
4715  :param fieldSetType: The parameter set type of the field to get the nodal value from. Must be a value from the FieldParameterSetTypes enum.
4716  :type fieldSetType: int
4717  :param versionNumber: The derivative version number to get the value from the field parameter set.
4718  :type versionNumber: int
4719  :param derivativeNumber: The derivative number to get the value from the field parameter set.
4720  :type derivativeNumber: int
4721  :param userNodeNumber: The user node number to get the value from the field parameter set.
4722  :type userNodeNumber: int
4723  :param componentNumber: The component number of the field variable to get the nodal value from the field parameter set.
4724  :type componentNumber: int
4725  :returns: value. The value from the field parameter set.
4726  :rtype: float
4727  """
4728 
4729  field = self
4730  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetGetNodeSP, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber])
4731 
4732  def ParameterSetInterpolateMultipleGaussDP(self, variableType, fieldSetType, derivativeNumber, userElementNumber, quadratureScheme, GaussPoints, valuesSizes):
4733  """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 field identified by an object. If no Gauss points are specified then all Gauss points are interpolated.
4734 
4735  :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.
4736  :type variableType: int
4737  :param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
4738  :type fieldSetType: int
4739  :param derivativeNumber: The derivative number of the field to interpolate.
4740  :type derivativeNumber: int
4741  :param userElementNumber: The user element number of the field variable component to update for the field parameter set.
4742  :type userElementNumber: int
4743  :param quadratureScheme: The quadrature scheme to interpolate the field for.
4744  :type quadratureScheme: int
4745  :param GaussPoints: The Gauss points to interpolate the field at.
4746  :type GaussPoints: Array of ints
4747  :param valuesSizes: Tuple of dimensions of values to allocate, with length 2.
4748  :returns: values. The interpolated values.
4749  :rtype: 2d array of floats
4750  """
4751 
4752  field = self
4753  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetInterpolateMultipleGaussDP, [field, variableType, fieldSetType, derivativeNumber, userElementNumber, quadratureScheme, GaussPoints, valuesSizes])
4754 
4755  def ParameterSetInterpolateMultipleXiDP(self, variableType, fieldSetType, derivativeNumber, userElementNumber, xi, valuesSizes):
4756  """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 an object.
4757 
4758  :param variableType: The variable type of the field to interpolate. Must be a value from the FieldVariableTypes enum.
4759  :type variableType: int
4760  :param fieldSetType: The parameter set type of the field to interpolate. Must be a value from the FieldParameterSetTypes enum.
4761  :type fieldSetType: int
4762  :param derivativeNumber: The derivative number of the field to interpolate.
4763  :type derivativeNumber: int
4764  :param userElementNumber: The user element number of the field to interpolate.
4765  :type userElementNumber: int
4766  :param xi: The sets of element xi to interpolate the field at.
4767  :type xi: 2d array of floats
4768  :param valuesSizes: Tuple of dimensions of values to allocate, with length 2.
4769  :returns: values. The interpolated values.
4770  :rtype: 2d array of floats
4771  """
4772 
4773  field = self
4774  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetInterpolateMultipleXiDP, [field, variableType, fieldSetType, derivativeNumber, userElementNumber, xi, valuesSizes])
4775 
4776  def ParameterSetInterpolateSingleGaussDP(self, variableType, fieldSetType, derivativeNumber, userElementNumber, quadratureScheme, GaussPoint, valuesSize):
4777  """Interpolates the given parameter set at a specified Gauss point for the specified element and derviative and returns double precision values for a field identified by an object.
4778 
4779  :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.
4780  :type variableType: int
4781  :param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
4782  :type fieldSetType: int
4783  :param derivativeNumber: The derivative number of the field to interpolate.
4784  :type derivativeNumber: int
4785  :param userElementNumber: The user element number of the field variable component to update for the field parameter set.
4786  :type userElementNumber: int
4787  :param quadratureScheme: The quadrature scheme to interpolate the field for.
4788  :type quadratureScheme: int
4789  :param GaussPoint: The Gauss point to interpolate the field at.
4790  :type GaussPoint: int
4791  :param valuesSize: Size of values to allocate.
4792  :returns: values. The interpolated values.
4793  :rtype: Array of floats
4794  """
4795 
4796  field = self
4797  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetInterpolateSingleGaussDP, [field, variableType, fieldSetType, derivativeNumber, userElementNumber, quadratureScheme, GaussPoint, valuesSize])
4798 
4799  def ParameterSetInterpolateSingleXiDP(self, variableType, fieldSetType, derivativeNumber, userElementNumber, xi, valuesSize):
4800  """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 an object.
4801 
4802  :param variableType: The variable type of the field to interpolate. Must be a value from the FieldVariableTypes enum.
4803  :type variableType: int
4804  :param fieldSetType: The parameter set type of the field to interpolate. Must be a value from the FieldParameterSetTypes enum.
4805  :type fieldSetType: int
4806  :param derivativeNumber: The derivative number of the field to interpolate.
4807  :type derivativeNumber: int
4808  :param userElementNumber: The user element number of the field to interpolate.
4809  :type userElementNumber: int
4810  :param xi: The element xi to interpolate the field at.
4811  :type xi: Array of floats
4812  :param valuesSize: Size of values to allocate.
4813  :returns: values. The interpolated values.
4814  :rtype: Array of floats
4815  """
4816 
4817  field = self
4818  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetInterpolateSingleXiDP, [field, variableType, fieldSetType, derivativeNumber, userElementNumber, xi, valuesSize])
4819 
4820  def ParameterSetNodeNumberOfScaleFactorDofsGet(self, variableType, meshComponentNumber):
4821  """Gets the number of scale factor dofs, identified by an object.
4822 
4823  :param variableType: The field variable type to get the number of scale factor dofs for
4824  :type variableType: int
4825  :param meshComponentNumber: The mesh component number of the field to get the number of scale factor dofs for
4826  :type meshComponentNumber: int
4827  :returns: numberOfScaleFactorsDofs. The number of scale factor dofs
4828  :rtype: int
4829  """
4830 
4831  field = self
4832  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetNodeNumberOfScaleFactorDofsGet, [field, variableType, meshComponentNumber])
4833 
4834  def ParameterSetNodeScaleFactorGet(self, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber):
4835  """Gets the scale factor for a particular node identified by an object.
4836 
4837  :param variableType: The field variable type to get the scale factor for
4838  :type variableType: int
4839  :param versionNumber: The user number of the node derivative version to get the scale factor for
4840  :type versionNumber: int
4841  :param derivativeNumber: The user number of the node derivative to get the scale factor for
4842  :type derivativeNumber: int
4843  :param nodeUserNumber: The user number of the node to get the scale factor for
4844  :type nodeUserNumber: int
4845  :param componentNumber: The component number of the field to get the scale factor for
4846  :type componentNumber: int
4847  :returns: scaleFactor. The scale factor of the specified node
4848  :rtype: float
4849  """
4850 
4851  field = self
4852  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetNodeScaleFactorGet, [field, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber])
4853 
4854  def ParameterSetNodeScaleFactorSet(self, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, scaleFactor):
4855  """Sets the scale factor for a particular node identified by an object.
4856 
4857  :param variableType: The field variable type to set the scale factor for
4858  :type variableType: int
4859  :param versionNumber: The user number of the node derivative version to set the scale factor for
4860  :type versionNumber: int
4861  :param derivativeNumber: The user number of the node derivative to set the scale factor for
4862  :type derivativeNumber: int
4863  :param nodeUserNumber: The user number of the node to set the scale factor for
4864  :type nodeUserNumber: int
4865  :param componentNumber: The component number of the field to set the scale factor for
4866  :type componentNumber: int
4867  :param scaleFactor: The scale factor of the specified node
4868  :type scaleFactor: float
4869  :rtype: None
4870  """
4871 
4872  field = self
4873  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetNodeScaleFactorSet, [field, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, scaleFactor])
4874 
4875  def ParameterSetNodeScaleFactorsGet(self, variableType, meshComponentNumber, scaleFactorsSize):
4876  """Gets the scale factors for all nodes identified by an object.
4877 
4878  :param variableType: The field variable type to get the scale factor for
4879  :type variableType: int
4880  :param meshComponentNumber: The mesh omponent number of the field to set the scale factor for
4881  :type meshComponentNumber: int
4882  :param scaleFactorsSize: Size of scaleFactors to allocate.
4883  :returns: scaleFactors. The scale factors
4884  :rtype: Array of floats
4885  """
4886 
4887  field = self
4888  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetNodeScaleFactorsGet, [field, variableType, meshComponentNumber, scaleFactorsSize])
4889 
4890  def ParameterSetNodeScaleFactorsSet(self, variableType, meshComponentNumber, scaleFactors):
4891  """Sets the scale factors for all nodes identified by an object.
4892 
4893  :param variableType: The field variable type to set the scale factor for
4894  :type variableType: int
4895  :param meshComponentNumber: The component number of the field to set the scale factor for
4896  :type meshComponentNumber: int
4897  :param scaleFactors: The scale factors
4898  :type scaleFactors: Array of floats
4899  :rtype: None
4900  """
4901 
4902  field = self
4903  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetNodeScaleFactorsSet, [field, variableType, meshComponentNumber, scaleFactors])
4904 
4905  def ParameterSetUpdateConstantDP(self, variableType, fieldSetType, componentNumber, value):
4906  """Updates the given parameter set with the given double precision value for the constant of the field variable component for a field identified by an object.
4907 
4908  :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.
4909  :type variableType: int
4910  :param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
4911  :type fieldSetType: int
4912  :param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
4913  :type componentNumber: int
4914  :param value: The value for the field parameter set to update.
4915  :type value: float
4916  :rtype: None
4917  """
4918 
4919  field = self
4920  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateConstantDP, [field, variableType, fieldSetType, componentNumber, value])
4921 
4922  def ParameterSetUpdateConstantIntg(self, variableType, fieldSetType, componentNumber, value):
4923  """Updates the given parameter set with the given integer value for the constant of the field variable component for a field identified by an object.
4924 
4925  :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.
4926  :type variableType: int
4927  :param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
4928  :type fieldSetType: int
4929  :param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
4930  :type componentNumber: int
4931  :param value: The value for the field parameter set to update.
4932  :type value: int
4933  :rtype: None
4934  """
4935 
4936  field = self
4937  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateConstantIntg, [field, variableType, fieldSetType, componentNumber, value])
4938 
4939  def ParameterSetUpdateConstantL(self, variableType, fieldSetType, componentNumber, value):
4940  """Updates the given parameter set with the given logical value for the constant of the field variable component for a field identified by an object.
4941 
4942  :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.
4943  :type variableType: int
4944  :param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
4945  :type fieldSetType: int
4946  :param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
4947  :type componentNumber: int
4948  :param value: The value for the field parameter set to update.
4949  :type value: bool
4950  :rtype: None
4951  """
4952 
4953  field = self
4954  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateConstantL, [field, variableType, fieldSetType, componentNumber, value])
4955 
4956  def ParameterSetUpdateConstantSP(self, variableType, fieldSetType, componentNumber, value):
4957  """Updates the given parameter set with the given single precision value for the constant of the field variable component for a field identified by an object.
4958 
4959  :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.
4960  :type variableType: int
4961  :param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
4962  :type fieldSetType: int
4963  :param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
4964  :type componentNumber: int
4965  :param value: The value for the field parameter set to update.
4966  :type value: float
4967  :rtype: None
4968  """
4969 
4970  field = self
4971  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateConstantSP, [field, variableType, fieldSetType, componentNumber, value])
4972 
4973  def ParameterSetUpdateDataPointDP(self, variableType, fieldSetType, userDataPointNumber, componentNumber, value):
4974  """Update the given parameter set a double precision value for the specified constant of a field variable component for a field identified by an object.
4975 
4976  :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.
4977  :type variableType: int
4978  :param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
4979  :type fieldSetType: int
4980  :param userDataPointNumber: The user data point number to update the value for
4981  :type userDataPointNumber: int
4982  :param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
4983  :type componentNumber: int
4984  :param value: The value for the field parameter set to update
4985  :type value: float
4986  :rtype: None
4987  """
4988 
4989  field = self
4990  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateDataPointDP, [field, variableType, fieldSetType, userDataPointNumber, componentNumber, value])
4991 
4992  def ParameterSetUpdateDataPointIntg(self, variableType, fieldSetType, userDataPointNumber, componentNumber, value):
4993  """Update the given parameter set a integer value for the specified constant of a field variable component for a field identified by an object.
4994 
4995  :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.
4996  :type variableType: int
4997  :param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
4998  :type fieldSetType: int
4999  :param userDataPointNumber: The user data point number to update the value for
5000  :type userDataPointNumber: int
5001  :param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
5002  :type componentNumber: int
5003  :param value: The value for the field parameter set to update
5004  :type value: int
5005  :rtype: None
5006  """
5007 
5008  field = self
5009  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateDataPointIntg, [field, variableType, fieldSetType, userDataPointNumber, componentNumber, value])
5010 
5011  def ParameterSetUpdateDataPointL(self, variableType, fieldSetType, userDataPointNumber, componentNumber, value):
5012  """Update the given parameter set a logical value for the specified constant of a field variable component for a field identified by an object.
5013 
5014  :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.
5015  :type variableType: int
5016  :param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
5017  :type fieldSetType: int
5018  :param userDataPointNumber: The user data point number to update the value for
5019  :type userDataPointNumber: int
5020  :param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
5021  :type componentNumber: int
5022  :param value: The value for the field parameter set to update
5023  :type value: bool
5024  :rtype: None
5025  """
5026 
5027  field = self
5028  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateDataPointL, [field, variableType, fieldSetType, userDataPointNumber, componentNumber, value])
5029 
5030  def ParameterSetUpdateDataPointSP(self, variableType, fieldSetType, userDataPointNumber, componentNumber, value):
5031  """Update the given parameter set a single precision value for the specified constant of a field variable component for a field identified by an object.
5032 
5033  :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.
5034  :type variableType: int
5035  :param fieldSetType: The parameter set type of the field to update the data point value from. Must be a value from the FieldParameterSetTypes enum.
5036  :type fieldSetType: int
5037  :param userDataPointNumber: The user data point number to update the value for
5038  :type userDataPointNumber: int
5039  :param componentNumber: The component number of the field variable to update the data point value from the field parameter set.
5040  :type componentNumber: int
5041  :param value: The value for the field parameter set to update
5042  :type value: float
5043  :rtype: None
5044  """
5045 
5046  field = self
5047  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateDataPointSP, [field, variableType, fieldSetType, userDataPointNumber, componentNumber, value])
5048 
5049  def ParameterSetUpdateElementDP(self, variableType, fieldSetType, userElementNumber, componentNumber, value):
5050  """Updates the given parameter set with the given double precision value for the element of the field variable component for a field identified by an object.
5051 
5052  :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.
5053  :type variableType: int
5054  :param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
5055  :type fieldSetType: int
5056  :param userElementNumber: The user element number of the field variable component to update for the field parameter set.
5057  :type userElementNumber: int
5058  :param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
5059  :type componentNumber: int
5060  :param value: The value for the field parameter set to update.
5061  :type value: float
5062  :rtype: None
5063  """
5064 
5065  field = self
5066  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateElementDP, [field, variableType, fieldSetType, userElementNumber, componentNumber, value])
5067 
5068  def ParameterSetUpdateElementDataPointDP(self, variableType, fieldSetType, elementNumber, dataPointIndex, componentNumber, value):
5069  """Updates the given parameter set with the given double precision value for the element data point of the field variable component for a field identified by an object.
5070 
5071  :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.
5072  :type variableType: int
5073  :param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
5074  :type fieldSetType: int
5075  :param elementNumber: The user element number to update the data point for.
5076  :type elementNumber: int
5077  :param dataPointIndex: The index of the data point for the data points projected on this element.
5078  :type dataPointIndex: int
5079  :param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
5080  :type componentNumber: int
5081  :param value: The value for the field parameter set to update.
5082  :type value: float
5083  :rtype: None
5084  """
5085 
5086  field = self
5087  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateElementDataPointDP, [field, variableType, fieldSetType, elementNumber, dataPointIndex, componentNumber, value])
5088 
5089  def ParameterSetUpdateElementIntg(self, variableType, fieldSetType, userElementNumber, componentNumber, value):
5090  """Updates the given parameter set with the given integer value for the element of the field variable component for a field identified by an object.
5091 
5092  :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.
5093  :type variableType: int
5094  :param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
5095  :type fieldSetType: int
5096  :param userElementNumber: The user element number of the field variable component to update for the field parameter set.
5097  :type userElementNumber: int
5098  :param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
5099  :type componentNumber: int
5100  :param value: The value for the field parameter set to update.
5101  :type value: int
5102  :rtype: None
5103  """
5104 
5105  field = self
5106  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateElementIntg, [field, variableType, fieldSetType, userElementNumber, componentNumber, value])
5107 
5108  def ParameterSetUpdateElementL(self, variableType, fieldSetType, userElementNumber, componentNumber, value):
5109  """Updates the given parameter set with the given logical value for the element of the field variable component for a field identified by an object.
5110 
5111  :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.
5112  :type variableType: int
5113  :param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
5114  :type fieldSetType: int
5115  :param userElementNumber: The user element number of the field variable component to update for the field parameter set.
5116  :type userElementNumber: int
5117  :param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
5118  :type componentNumber: int
5119  :param value: The value for the field parameter set to update.
5120  :type value: bool
5121  :rtype: None
5122  """
5123 
5124  field = self
5125  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateElementL, [field, variableType, fieldSetType, userElementNumber, componentNumber, value])
5126 
5127  def ParameterSetUpdateElementSP(self, variableType, fieldSetType, userElementNumber, componentNumber, value):
5128  """Updates the given parameter set with the given single precision value for the element of the field variable component for a field identified by an object.
5129 
5130  :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.
5131  :type variableType: int
5132  :param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
5133  :type fieldSetType: int
5134  :param userElementNumber: The user element number of the field variable component to update for the field parameter set.
5135  :type userElementNumber: int
5136  :param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
5137  :type componentNumber: int
5138  :param value: The value for the field parameter set to update.
5139  :type value: float
5140  :rtype: None
5141  """
5142 
5143  field = self
5144  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateElementSP, [field, variableType, fieldSetType, userElementNumber, componentNumber, value])
5145 
5146  def ParameterSetUpdateFinish(self, variableType, fieldSetType):
5147  """Finishes the parameter set update for a field variable for a field identified by an object.
5148 
5149  :param variableType: The variable type of the field to finish the parameter set update for. Must be a value from the FieldVariableTypes enum.
5150  :type variableType: int
5151  :param fieldSetType: The parameter set type to finish the update for. Must be a value from the FieldParameterSetTypes enum.
5152  :type fieldSetType: int
5153  :rtype: None
5154  """
5155 
5156  field = self
5157  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateFinish, [field, variableType, fieldSetType])
5158 
5159  def ParameterSetUpdateGaussPointDP(self, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value):
5160  """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 an object.
5161 
5162  :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.
5163  :type variableType: int
5164  :param fieldSetType: The parameter set type of the field to update the Gauss point value for. Must be a value from the FieldParameterSetTypes enum.
5165  :type fieldSetType: int
5166  :param gaussPointNumber: The user element number of the field variable component to update for the field parameter set.
5167  :type gaussPointNumber: int
5168  :param userElementNumber: The user element number of the field variable component to update for the field parameter set.
5169  :type userElementNumber: int
5170  :param componentNumber: The component number of the field variable to update the Gauss point value for the field parameter set.
5171  :type componentNumber: int
5172  :param value: The value for the field parameter set to update.
5173  :type value: float
5174  :rtype: None
5175  """
5176 
5177  field = self
5178  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateGaussPointDP, [field, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value])
5179 
5180  def ParameterSetUpdateGaussPointIntg(self, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value):
5181  """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 an object.
5182 
5183  :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.
5184  :type variableType: int
5185  :param fieldSetType: The parameter set type of the field to update the Gauss point value for. Must be a value from the FieldParameterSetTypes enum.
5186  :type fieldSetType: int
5187  :param gaussPointNumber: The user element number of the field variable component to update for the field parameter set.
5188  :type gaussPointNumber: int
5189  :param userElementNumber: The user element number of the field variable component to update for the field parameter set.
5190  :type userElementNumber: int
5191  :param componentNumber: The component number of the field variable to update the Gauss point value for the field parameter set.
5192  :type componentNumber: int
5193  :param value: The value for the field parameter set to update.
5194  :type value: int
5195  :rtype: None
5196  """
5197 
5198  field = self
5199  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateGaussPointIntg, [field, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value])
5200 
5201  def ParameterSetUpdateGaussPointL(self, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value):
5202  """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 an object.
5203 
5204  :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.
5205  :type variableType: int
5206  :param fieldSetType: The parameter set type of the field to update the Gauss point value for. Must be a value from the FieldParameterSetTypes enum.
5207  :type fieldSetType: int
5208  :param gaussPointNumber: The user element number of the field variable component to update for the field parameter set.
5209  :type gaussPointNumber: int
5210  :param userElementNumber: The user element number of the field variable component to update for the field parameter set.
5211  :type userElementNumber: int
5212  :param componentNumber: The component number of the field variable to update the Gauss point value for the field parameter set.
5213  :type componentNumber: int
5214  :param value: The value for the field parameter set to update.
5215  :type value: bool
5216  :rtype: None
5217  """
5218 
5219  field = self
5220  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateGaussPointL, [field, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value])
5221 
5222  def ParameterSetUpdateGaussPointSP(self, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value):
5223  """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 an object.
5224 
5225  :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.
5226  :type variableType: int
5227  :param fieldSetType: The parameter set type of the field to update the Gauss point value for. Must be a value from the FieldParameterSetTypes enum.
5228  :type fieldSetType: int
5229  :param gaussPointNumber: The user element number of the field variable component to update for the field parameter set.
5230  :type gaussPointNumber: int
5231  :param userElementNumber: The user element number of the field variable component to update for the field parameter set.
5232  :type userElementNumber: int
5233  :param componentNumber: The component number of the field variable to update the Gauss point value for the field parameter set.
5234  :type componentNumber: int
5235  :param value: The value for the field parameter set to update.
5236  :type value: float
5237  :rtype: None
5238  """
5239 
5240  field = self
5241  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateGaussPointSP, [field, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value])
5242 
5243  def ParameterSetUpdateLocalDofsDP(self, variableType, fieldSetType, values):
5244  """Updates the given parameter set with the given values for all local dofs of the field variable identified by an object..
5245 
5246  :param variableType: The variable type of the field to update values for the field parameter set. Must be a value from the FieldVariableTypes enum.
5247  :type variableType: int
5248  :param fieldSetType: The parameter set type of the field to update values for. Must be a value from the FieldParameterSetTypes enum.
5249  :type fieldSetType: int
5250  :param values: The values to update the field parameter set to.
5251  :type values: Array of floats
5252  :rtype: None
5253  """
5254 
5255  field = self
5256  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateLocalDofsDP, [field, variableType, fieldSetType, values])
5257 
5258  def ParameterSetUpdateNodeDP(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value):
5259  """: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.
5260  :type variableType: int
5261  :param fieldSetType: The parameter set type of the field to update the nodal value for. Must be a value from the FieldParameterSetTypes enum.
5262  :type fieldSetType: int
5263  :param versionNumber: The derivative version number of the field variable component to update for the field parameter set.
5264  :type versionNumber: int
5265  :param derivativeNumber: The derivative number of the field variable component to update for the field parameter set.
5266  :type derivativeNumber: int
5267  :param userNodeNumber: The user node number of the field variable component to update for the field parameter set.
5268  :type userNodeNumber: int
5269  :param componentNumber: The component number of the field variable to update the nodal value for the field parameter set.
5270  :type componentNumber: int
5271  :param value: The value to update the field parameter set to.
5272  :type value: float
5273  :rtype: None
5274  """
5275 
5276  field = self
5277  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateNodeDP, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value])
5278 
5279  def ParameterSetUpdateNodeIntg(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value):
5280  """: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.
5281  :type variableType: int
5282  :param fieldSetType: The parameter set type of the field to update the nodal value for. Must be a value from the FieldParameterSetTypes enum.
5283  :type fieldSetType: int
5284  :param versionNumber: The derivative version number of the field variable component to update for the field parameter set.
5285  :type versionNumber: int
5286  :param derivativeNumber: The derivative number of the field variable component to update for the field parameter set.
5287  :type derivativeNumber: int
5288  :param userNodeNumber: The user node number of the field variable component to update for the field parameter set.
5289  :type userNodeNumber: int
5290  :param componentNumber: The component number of the field variable to update the nodal value for the field parameter set.
5291  :type componentNumber: int
5292  :param value: The value to update the field parameter set to.
5293  :type value: int
5294  :rtype: None
5295  """
5296 
5297  field = self
5298  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateNodeIntg, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value])
5299 
5300  def ParameterSetUpdateNodeL(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value):
5301  """: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.
5302  :type variableType: int
5303  :param fieldSetType: The parameter set type of the field to update the nodal value for. Must be a value from the FieldParameterSetTypes enum.
5304  :type fieldSetType: int
5305  :param versionNumber: The derivative version number of the field variable component to update for the field parameter set.
5306  :type versionNumber: int
5307  :param derivativeNumber: The derivative number of the field variable component to update for the field parameter set.
5308  :type derivativeNumber: int
5309  :param userNodeNumber: The user node number of the field variable component to update for the field parameter set.
5310  :type userNodeNumber: int
5311  :param componentNumber: The component number of the field variable to update the nodal value for the field parameter set.
5312  :type componentNumber: int
5313  :param value: The value to update the field parameter set to.
5314  :type value: bool
5315  :rtype: None
5316  """
5317 
5318  field = self
5319  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateNodeL, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value])
5320 
5321  def ParameterSetUpdateNodeSP(self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value):
5322  """: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.
5323  :type variableType: int
5324  :param fieldSetType: The parameter set type of the field to update the nodal value for. Must be a value from the FieldParameterSetTypes enum.
5325  :type fieldSetType: int
5326  :param versionNumber: The derivative version number of the field variable component to update for the field parameter set.
5327  :type versionNumber: int
5328  :param derivativeNumber: The derivative number of the field variable component to update for the field parameter set.
5329  :type derivativeNumber: int
5330  :param userNodeNumber: The user node number of the field variable component to update for the field parameter set.
5331  :type userNodeNumber: int
5332  :param componentNumber: The component number of the field variable to update the nodal value for the field parameter set.
5333  :type componentNumber: int
5334  :param value: The value to update the field parameter set to.
5335  :type value: float
5336  :rtype: None
5337  """
5338 
5339  field = self
5340  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateNodeSP, [field, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value])
5341 
5342  def ParameterSetUpdateStart(self, variableType, fieldSetType):
5343  """Starts the parameter set update for a field variable for a field identified by an object.
5344 
5345  :param variableType: The variable type of the field to start the parameter set update for. Must be a value from the FieldVariableTypes enum.
5346  :type variableType: int
5347  :param fieldSetType: The parameter set type to start the update for. Must be a value from the FieldParameterSetTypes enum.
5348  :type fieldSetType: int
5349  :rtype: None
5350  """
5351 
5352  field = self
5353  return _wrap_routine(_iron_python.cmfe_Field_ParameterSetUpdateStart, [field, variableType, fieldSetType])
5354 
5355  def ParametersToFieldParametersComponentCopy(self, fromVariableType, fromParameterSetType, fromComponentNumber, toField, toVariableType, toParameterSetType, toComponentNumber):
5356  """Copy the parameters from the parameter set of a component of a field variable to the paramters of a parameter set of
5357  a component of another field variable, where both fields are objects.
5358 
5359  :param fromVariableType: The field variable type to copy from
5360  :type fromVariableType: int
5361  :param fromParameterSetType: The field parameter set type to copy from
5362  :type fromParameterSetType: int
5363  :param fromComponentNumber: The field variable component number to copy from
5364  :type fromComponentNumber: int
5365  :param toField: The field to copy to
5366  :type toField: Field
5367  :param toVariableType: The field variable type to copy to
5368  :type toVariableType: int
5369  :param toParameterSetType: The parameter set type to copy to
5370  :type toParameterSetType: int
5371  :param toComponentNumber: The field variable component to copy to
5372  :type toComponentNumber: int
5373  :rtype: None
5374  """
5375 
5376  fromField = self
5377  return _wrap_routine(_iron_python.cmfe_Field_ParametersToFieldParametersComponentCopy, [fromField, fromVariableType, fromParameterSetType, fromComponentNumber, toField, toVariableType, toParameterSetType, toComponentNumber])
5378 
5379  def PositionNormalTangentCalculateNode(self, variableType, componentNumber, localNodeNumber, positionSize, normalSize, tangentsSizes):
5380  """Returns the position, normal and tangents for a field node for a field identified by an object.
5381 
5382  :param variableType: The variable type of the field to get the interpolation type for. Must be a value from the FieldVariableTypes enum.
5383  :type variableType: int
5384  :param componentNumber: The component number of the field variable to get the data type for.
5385  :type componentNumber: int
5386  :param localNodeNumber: The local node number of the field variable to get the data type for.
5387  :type localNodeNumber: int
5388  :param positionSize: Size of position to allocate.
5389  :param normalSize: Size of normal to allocate.
5390  :param tangentsSizes: Tuple of dimensions of tangents to allocate, with length 2.
5391  :returns: (Actual useful outputs, Actual useful outputs, Actual useful outputs)
5392  :rtype: tuple. (Array of floats, Array of floats, 2d array of floats)
5393  """
5394 
5395  field = self
5396  return _wrap_routine(_iron_python.cmfe_Field_PositionNormalTangentCalculateNode, [field, variableType, componentNumber, localNodeNumber, positionSize, normalSize, tangentsSizes])
5397 
5398  def ScalingTypeGet(self):
5399  """Returns the scaling type for a field identified by an object.
5400 
5401  :returns: scalingType. The field scaling type. Will be a value from the FieldScalingTypes enum.
5402  :rtype: int
5403  """
5404 
5405  field = self
5406  return _wrap_routine(_iron_python.cmfe_Field_ScalingTypeGet, [field])
5407 
5408  def ScalingTypeSet(self, scalingType):
5409  """Sets/changes the scaling type for a field identified by an object.
5410 
5411  :param scalingType: The field scaling type to set. Must be a value from the FieldScalingTypes enum.
5412  :type scalingType: int
5413  :rtype: None
5414  """
5415 
5416  field = self
5417  return _wrap_routine(_iron_python.cmfe_Field_ScalingTypeSet, [field, scalingType])
5418 
5419  def TypeGet(self):
5420  """Returns the type for a field identified by an object.
5421 
5422  :returns: fieldType. The field type. Will be a value from the FieldTypes enum.
5423  :rtype: int
5424  """
5425 
5426  field = self
5427  return _wrap_routine(_iron_python.cmfe_Field_TypeGet, [field])
5428 
5429  def TypeSet(self, fieldType):
5430  """Sets/changes the type for a field identified by an object.
5431 
5432  :param fieldType: The field type to set. Must be a value from the FieldTypes enum.
5433  :type fieldType: int
5434  :rtype: None
5435  """
5436 
5437  field = self
5438  return _wrap_routine(_iron_python.cmfe_Field_TypeSet, [field, fieldType])
5439 
5440  def VariableLabelGet(self, variableType):
5441  """Returns the character string label for a field variable for a field identified by an object.
5442 
5443  :param variableType: The variable type of the field to get the field variable label. Must be a value from the FieldVariableTypes enum.
5444  :type variableType: int
5445  :returns: label. The field variable label.
5446  :rtype: string
5447  """
5448 
5449  field = self
5450  return _wrap_routine(_iron_python.cmfe_Field_VariableLabelGet, [field, variableType])
5451 
5452  def VariableLabelSet(self, variableType, label):
5453  """Sets/changes the character string label for a field variable for a field identified by an object.
5454 
5455  :param variableType: The variable type of the field to set the field variable label. Must be a value from the FieldVariableTypes enum.
5456  :type variableType: int
5457  :param label: The field variable label to set.
5458  :type label: string
5459  :rtype: None
5460  """
5461 
5462  field = self
5463  return _wrap_routine(_iron_python.cmfe_Field_VariableLabelSet, [field, variableType, label])
5464 
5465  def VariableTypesGet(self, variableTypesSize):
5466  """Returns the variable types for a field identified by an object.
5467 
5468  :param variableTypesSize: Size of variableTypes to allocate.
5469  :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.
5470  :rtype: Array of ints
5471  """
5472 
5473  field = self
5474  return _wrap_routine(_iron_python.cmfe_Field_VariableTypesGet, [field, variableTypesSize])
5475 
5476  def VariableTypesSet(self, variableTypes):
5477  """Sets/changes the variable types for a field identified by an object.
5478 
5479  :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.
5480  :type variableTypes: Array of ints
5481  :rtype: None
5482  """
5483 
5484  field = self
5485  return _wrap_routine(_iron_python.cmfe_Field_VariableTypesSet, [field, variableTypes])
5486 
5487  dependentType = property(DependentTypeGet, DependentTypeSet, None, """The dependent type for a field identified by an object.""")
5488 
5489  variableTypes = property(VariableTypesGet, VariableTypesSet, None, """The variable types for a field identified by an object.""")
5490 
5491  dataProjection = property(None, DataProjectionSet, None, """The data projection for a field identified by an object.""")
5492 
5493  numberOfVariables = property(NumberOfVariablesGet, NumberOfVariablesSet, None, """The number of variables for a field identified by an object.""")
5494 
5495  label = property(LabelGet, LabelSet, None, """The character string label for a field identified by an object.""")
5496 
5497  meshDecomposition = property(MeshDecompositionGet, MeshDecompositionSet, None, """The mesh decomposition for a field identified by an object.""")
5498 
5499  scalingType = property(ScalingTypeGet, ScalingTypeSet, None, """The scaling type for a field identified by an object.""")
5500 
5501  type = property(TypeGet, TypeSet, None, """The type for a field identified by an object.""")
5502 
5503  geometricField = property(GeometricFieldGet, GeometricFieldSet, None, """The geometric field for a field identified by an object.""")
5504 
5505 
5506 class Fields(CMFEType):
5507  """Contains information for a fields defined on a region.
5508  """
5509 
5510  def __init__(self):
5511  """Initialise a null cmfe_FieldsType"""
5512 
5513  self.cmiss_type = _wrap_routine(_iron_python.cmfe_Fields_Initialise, None)
5514 
5515  def CreateInterface(self, interface):
5516  """Creates a cmfe_FieldsType object for an inteface by an object reference.
5517 
5518  :param interface: The interface to get the fields from
5519  :type interface: Interface
5520  :rtype: None
5521  """
5522 
5523  fields = self
5524  return _wrap_routine(_iron_python.cmfe_Fields_CreateInterface, [interface, fields])
5525 
5526  def CreateRegion(self, region):
5527  """Creates a cmfe_FieldsType object for a region by an object reference.
5528 
5529  :param region: The region to get the fields from
5530  :type region: Region
5531  :rtype: None
5532  """
5533 
5534  fields = self
5535  return _wrap_routine(_iron_python.cmfe_Fields_CreateRegion, [region, fields])
5536 
5537  def ElementsExport(self, fileName, method):
5538  """Export element information for fields set identified by an object. \todo number method
5539 
5540  :param fileName: The file name to export the elements to
5541  :type fileName: string
5542  :param method: The export method to use.
5543  :type method: string
5544  :rtype: None
5545  """
5546 
5547  fields = self
5548  return _wrap_routine(_iron_python.cmfe_Fields_ElementsExport, [fields, fileName, method])
5549 
5550  def Finalise(self):
5551  """Finalises a cmfe_FieldsType object.
5552 
5553  :rtype: None
5554  """
5555 
5556  cmfe_Fields = self
5557  return _wrap_routine(_iron_python.cmfe_Fields_Finalise, [cmfe_Fields])
5558 
5559  def NodesExport(self, fileName, method):
5560  """Export nodal information for fields set identified by an object. \todo number method
5561 
5562  :param fileName: The file name to export the nodes to
5563  :type fileName: string
5564  :param method: The export method to use.
5565  :type method: string
5566  :rtype: None
5567  """
5568 
5569  fields = self
5570  return _wrap_routine(_iron_python.cmfe_Fields_NodesExport, [fields, fileName, method])
5571 
5572 
5573 class GeneratedMesh(CMFEType):
5574  """Contains information on a generated mesh.
5575  """
5576 
5577  def __init__(self):
5578  """Initialise a null cmfe_GeneratedMeshType"""
5579 
5580  self.cmiss_type = _wrap_routine(_iron_python.cmfe_GeneratedMesh_Initialise, None)
5581 
5582  def BaseVectorsSet(self, baseVectors):
5583  """Sets/changes the base vectors for a generated mesh identified by an object.
5584 
5585  :param baseVectors: baseVectors(coordinate_idx,xi_idx). The base vectors to set.
5586  :type baseVectors: 2d array of floats
5587  :rtype: None
5588  """
5589 
5590  generatedMesh = self
5591  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_BaseVectorsSet, [generatedMesh, baseVectors])
5592 
5593  def BasisGet(self, bases):
5594  """Returns the basis for a generated mesh identified by an object.
5595 
5596  :param bases: On return, the array of bases.
5597  :type bases: Array of Basis objects
5598  :rtype: None
5599  """
5600 
5601  generatedMesh = self
5602  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_BasisGet, [generatedMesh, bases])
5603 
5604  def BasisSet(self, bases):
5605  """Sets/changes the basis for a generated mesh identified by an object.
5606 
5607  :param bases: The bases to set.
5608  :type bases: Array of Basis objects
5609  :rtype: None
5610  """
5611 
5612  generatedMesh = self
5613  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_BasisSet, [generatedMesh, bases])
5614 
5615  def CreateFinish(self, meshUserNumber, mesh):
5616  """Finishes the creation of a generated mesh identified by an object.
5617 
5618  :param meshUserNumber: The user number of the mesh to generate.
5619  :type meshUserNumber: int
5620  :param mesh: On return, the generated mesh.
5621  :type mesh: Mesh
5622  :rtype: None
5623  """
5624 
5625  generatedMesh = self
5626  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_CreateFinish, [generatedMesh, meshUserNumber, mesh])
5627 
5628  def CreateStartInterface(self, generatedMeshUserNumber, interface):
5629  """Starts the creation of a generated mesh on an interface identified by an object.
5630 
5631  :param generatedMeshUserNumber: The user number of the generated mesh to create.
5632  :type generatedMeshUserNumber: int
5633  :param interface: The interface to created generated mesh in.
5634  :type interface: Interface
5635  :rtype: None
5636  """
5637 
5638  generatedMesh = self
5639  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_CreateStartInterface, [generatedMeshUserNumber, interface, generatedMesh])
5640 
5641  def CreateStart(self, generatedMeshUserNumber, region):
5642  """Starts the creation of a generated mesh on a region identified by an object.
5643 
5644  :param generatedMeshUserNumber: The user number of the generated mesh to create.
5645  :type generatedMeshUserNumber: int
5646  :param region: The region to created generated mesh in.
5647  :type region: Region
5648  :rtype: None
5649  """
5650 
5651  generatedMesh = self
5652  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_CreateStart, [generatedMeshUserNumber, region, generatedMesh])
5653 
5654  def Destroy(self):
5655  """Destroys a generated mesh identified by an object.
5656 
5657  :rtype: None
5658  """
5659 
5660  generatedMesh = self
5661  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_Destroy, [generatedMesh])
5662 
5663  def ExtentGet(self, extentSize):
5664  """Returns the extent for a generated mesh identified by an object.
5665 
5666  :param extentSize: Size of extent to allocate.
5667  :returns: extent. extent(i). On return, the extent for the i'th dimension of the generated mesh.
5668  :rtype: Array of floats
5669  """
5670 
5671  generatedMesh = self
5672  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_ExtentGet, [generatedMesh, extentSize])
5673 
5674  def ExtentSet(self, extent):
5675  """Sets/changes the extent for a generated mesh identified by an object.
5676 
5677  :param extent: extent(i). the extent for the i'th dimension of the generated mesh to set.
5678  :type extent: Array of floats
5679  :rtype: None
5680  """
5681 
5682  generatedMesh = self
5683  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_ExtentSet, [generatedMesh, extent])
5684 
5685  def Finalise(self):
5686  """Finalises a cmfe_GeneratedMeshType object.
5687 
5688  :rtype: None
5689  """
5690 
5691  cmfe_GeneratedMesh = self
5692  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_Finalise, [cmfe_GeneratedMesh])
5693 
5695  """Calculates and sets the geometric field parameters for a generated mesh identified by an object.
5696 
5697  :param field: The field to calculate the geometric parameters for
5698  :type field: Field
5699  :rtype: None
5700  """
5701 
5702  generatedMesh = self
5703  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_GeometricParametersCalculate, [generatedMesh, field])
5704 
5705  def NumberOfElementsGet(self, numberOfElementsSize):
5706  """Returns the number of elements for a generated mesh identified by an object.
5707 
5708  :param numberOfElementsSize: Size of numberOfElements to allocate.
5709  :returns: numberOfElements. numberOfElements(i). On return, the number of elements in the i'th dimension of the generated mesh.
5710  :rtype: Array of ints
5711  """
5712 
5713  generatedMesh = self
5714  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_NumberOfElementsGet, [generatedMesh, numberOfElementsSize])
5715 
5716  def NumberOfElementsSet(self, numberOfElements):
5717  """Sets/changes the number of elements for a generated mesh identified by an object.
5718 
5719  :param numberOfElements: numberOfElements(i). The number of elements in the i'th dimension of the generated mesh to set.
5720  :type numberOfElements: Array of ints
5721  :rtype: None
5722  """
5723 
5724  generatedMesh = self
5725  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_NumberOfElementsSet, [generatedMesh, numberOfElements])
5726 
5727  def OriginGet(self, originSize):
5728  """Returns the origin of a generated mesh identified by an object.
5729 
5730  :param originSize: Size of origin to allocate.
5731  :returns: origin. origin(i). On return, the origin of the i'th dimension of the generated mesh.
5732  :rtype: Array of floats
5733  """
5734 
5735  generatedMesh = self
5736  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_OriginGet, [generatedMesh, originSize])
5737 
5738  def OriginSet(self, origin):
5739  """Sets/changes the origin of a generated mesh identified by an object.
5740 
5741  :param origin: origin(i). The origin of the i'th dimension of the generated mesh to set.
5742  :type origin: Array of floats
5743  :rtype: None
5744  """
5745 
5746  generatedMesh = self
5747  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_OriginSet, [generatedMesh, origin])
5748 
5749  def TypeGet(self):
5750  """Returns the type of a generated mesh identified by an object.
5751 
5752  :returns: generatedMeshType. The type of the generated mesh. Will be a value from the GeneratedMeshTypes enum.
5753  :rtype: int
5754  """
5755 
5756  generatedMesh = self
5757  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_TypeGet, [generatedMesh])
5758 
5759  def TypeSet(self, generatedMeshType):
5760  """Sets/changes the type of a generated mesh identified by an object.
5761 
5762  :param generatedMeshType: The type of the generated mesh to set. Must be a value from the GeneratedMeshTypes enum.
5763  :type generatedMeshType: int
5764  :rtype: None
5765  """
5766 
5767  generatedMesh = self
5768  return _wrap_routine(_iron_python.cmfe_GeneratedMesh_TypeSet, [generatedMesh, generatedMeshType])
5769 
5770  origin = property(OriginGet, OriginSet, None, """The origin of a generated mesh identified by an object.""")
5771 
5772  basis = property(BasisGet, BasisSet, None, """The basis for a generated mesh identified by an object.""")
5773 
5774  baseVectors = property(None, BaseVectorsSet, None, """The base vectors for a generated mesh identified by an object.""")
5775 
5776  extent = property(ExtentGet, ExtentSet, None, """The extent for a generated mesh identified by an object.""")
5777 
5778  type = property(TypeGet, TypeSet, None, """The type of a generated mesh identified by an object.""")
5779 
5780  numberOfElements = property(NumberOfElementsGet, NumberOfElementsSet, None, """The number of elements for a generated mesh identified by an object.""")
5781 
5782 
5783 class History(CMFEType):
5784  """Contains information about a history file for a control loop.
5785  """
5786 
5787  def __init__(self):
5788  """Initialise a null cmfe_HistoryType"""
5789 
5790  self.cmiss_type = _wrap_routine(_iron_python.cmfe_History_Initialise, None)
5791 
5792  def Finalise(self):
5793  """Finalises a cmfe_HistoryType object.
5794 
5795  :rtype: None
5796  """
5797 
5798  cmfe_History = self
5799  return _wrap_routine(_iron_python.cmfe_History_Finalise, [cmfe_History])
5800 
5801 
5802 class InterfaceCondition(CMFEType):
5803  """Contains information about an interface condition.
5804  """
5805 
5806  def __init__(self):
5807  """Initialise a null cmfe_InterfaceConditionType"""
5808 
5809  self.cmiss_type = _wrap_routine(_iron_python.cmfe_InterfaceCondition_Initialise, None)
5810 
5811  def CreateFinish(self):
5812  """Finishes the creation of an interface condition identified by an object.
5813 
5814  :rtype: None
5815  """
5816 
5817  interfaceCondition = self
5818  return _wrap_routine(_iron_python.cmfe_InterfaceCondition_CreateFinish, [interfaceCondition])
5819 
5820  def CreateStart(self, interfaceConditionUserNumber, interface, geometricField):
5821  """Starts the creation of an interface condition identified by an object.
5822 
5823  :param interfaceConditionUserNumber: The user number of the interface conditon to start the creation of.
5824  :type interfaceConditionUserNumber: int
5825  :param interface: The interface to create the interface on.
5826  :type interface: Interface
5827  :param geometricField: The geometric field for the interface condition.
5828  :type geometricField: Field
5829  :rtype: None
5830  """
5831 
5832  interfaceCondition = self
5833  return _wrap_routine(_iron_python.cmfe_InterfaceCondition_CreateStart, [interfaceConditionUserNumber, interface, geometricField, interfaceCondition])
5834 
5835  def DependentVariableAdd(self, meshIndex, equationsSet, variableType):
5836  """Adds a dependent field variable to an interface condition identified by an object.
5837 
5838  :param meshIndex: The mesh index of the interface condition interface for which the dependent variable is added.
5839  :type meshIndex: int
5840  :param equationsSet: The equations set containg the dependent variable to add.
5841  :type equationsSet: EquationsSet
5842  :param variableType: The variable type of the dependent variable to add.
5843  :type variableType: int
5844  :rtype: None
5845  """
5846 
5847  interfaceCondition = self
5848  return _wrap_routine(_iron_python.cmfe_InterfaceCondition_DependentVariableAdd, [interfaceCondition, meshIndex, equationsSet, variableType])
5849 
5850  def Destroy(self):
5851  """Destroys an interface condition identified by an object.
5852 
5853  :rtype: None
5854  """
5855 
5856  interfaceCondition = self
5857  return _wrap_routine(_iron_python.cmfe_InterfaceCondition_Destroy, [interfaceCondition])
5858 
5860  """Finishes the creation of interface equations for an interface condition identified by an object.
5861 
5862  :rtype: None
5863  """
5864 
5865  interfaceCondition = self
5866  return _wrap_routine(_iron_python.cmfe_InterfaceCondition_EquationsCreateFinish, [interfaceCondition])
5867 
5868  def EquationsCreateStart(self, interfaceEquations):
5869  """Starts the creation of interface equations for an interface condition identified by an object.
5870 
5871  :param interfaceEquations: On return, the created interface equations.
5872  :type interfaceEquations: InterfaceEquations
5873  :rtype: None
5874  """
5875 
5876  interfaceCondition = self
5877  return _wrap_routine(_iron_python.cmfe_InterfaceCondition_EquationsCreateStart, [interfaceCondition, interfaceEquations])
5878 
5879  def EquationsDestroy(self):
5880  """Destroys the interface equations for an interface condition identified by an object.
5881 
5882  :rtype: None
5883  """
5884 
5885  interfaceCondition = self
5886  return _wrap_routine(_iron_python.cmfe_InterfaceCondition_EquationsDestroy, [interfaceCondition])
5887 
5888  def Finalise(self):
5889  """Finalises a cmfe_InterfaceConditionType object.
5890 
5891  :rtype: None
5892  """
5893 
5894  cmfe_InterfaceCondition = self
5895  return _wrap_routine(_iron_python.cmfe_InterfaceCondition_Finalise, [cmfe_InterfaceCondition])
5896 
5898  """Gets the integration type for an interface condition identified by an object.
5899 
5900  :returns: interfaceConditionIntegrationType. The interface condition integration type. Will be a value from the InterfaceConditionIntegrationTypes enum.
5901  :rtype: int
5902  """
5903 
5904  interfaceCondition = self
5905  return _wrap_routine(_iron_python.cmfe_InterfaceCondition_IntegrationTypeGet, [interfaceCondition])
5906 
5907  def IntegrationTypeSet(self, interfaceConditionIntegrationType):
5908  """Sets/changes the integration type for an interface condition identified by an object.
5909 
5910  :param interfaceConditionIntegrationType: On return, the interface condition integration type. Must be a value from the InterfaceConditionIntegrationTypes enum.
5911  :type interfaceConditionIntegrationType: int
5912  :rtype: None
5913  """
5914 
5915  interfaceCondition = self
5916  return _wrap_routine(_iron_python.cmfe_InterfaceCondition_IntegrationTypeSet, [interfaceCondition, interfaceConditionIntegrationType])
5917