iron.Field Class Reference

Inheritance diagram for iron.Field:

Collaboration diagram for iron.Field:

Public Member Functions
def	__init__ (self)
def	ComponentInterpolationGet (self, variableType, componentNumber)
def	ComponentInterpolationSet (self, variableType, componentNumber, interpolationType)
def	ComponentLabelGet (self, variableType, componentNumber)
def	ComponentLabelSet (self, variableType, componentNumber, label)
def	ComponentMeshComponentGet (self, variableType, componentNumber)
def	ComponentMeshComponentSet (self, variableType, componentNumber, meshComponent)
def	ComponentValuesInitialiseDP (self, variableType, fieldSetType, componentNumber, value)
def	ComponentValuesInitialiseIntg (self, variableType, fieldSetType, componentNumber, value)
def	ComponentValuesInitialiseL (self, variableType, fieldSetType, componentNumber, value)
def	ComponentValuesInitialiseSP (self, variableType, fieldSetType, componentNumber, value)
def	CreateFinish (self)
def	CreateStartInterface (self, fieldUserNumber, interface)
def	CreateStart (self, fieldUserNumber, region)
def	DOFOrderTypeGet (self, variableType)
def	DOFOrderTypeSet (self, variableType, DOFOrderType)
def	DataProjectionSet (self, dataProjection)
def	DataTypeGet (self, variableType)
def	DataTypeSet (self, variableType, dataType)
def	DependentTypeGet (self)
def	DependentTypeSet (self, dependentType)
def	Destroy (self)
def	DimensionGet (self, variableType)
def	DimensionSet (self, variableType, dimension)
def	Finalise (self)
def	GeometricFieldGet (self, geometricField)
def	GeometricFieldSet (self, geometricField)
def	GeometricParametersElementLineLengthGet (self, elementNumber, elementLineNumber)
def	GeometricParametersElementVolumeGet (self, elementNumber)
def	LabelGet (self)
def	LabelSet (self, label)
def	MeshDecompositionGet (self, meshDecomposition)
def	MeshDecompositionSet (self, meshDecomposition)
def	NumberOfComponentsGet (self, variableType)
def	NumberOfComponentsSet (self, variableType, numberOfComponents)
def	NumberOfVariablesGet (self)
def	NumberOfVariablesSet (self, numberOfVariables)
def	ParameterSetAddConstantDP (self, variableType, fieldSetType, componentNumber, value)
def	ParameterSetAddConstantIntg (self, variableType, fieldSetType, componentNumber, value)
def	ParameterSetAddConstantL (self, variableType, fieldSetType, componentNumber, value)
def	ParameterSetAddConstantSP (self, variableType, fieldSetType, componentNumber, value)
def	ParameterSetAddElementDP (self, variableType, fieldSetType, userElementNumber, componentNumber, value)
def	ParameterSetAddElementIntg (self, variableType, fieldSetType, userElementNumber, componentNumber, value)
def	ParameterSetAddElementL (self, variableType, fieldSetType, userElementNumber, componentNumber, value)
def	ParameterSetAddElementSP (self, variableType, fieldSetType, userElementNumber, componentNumber, value)
def	ParameterSetAddNodeDP (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
def	ParameterSetAddNodeIntg (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
def	ParameterSetAddNodeL (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
def	ParameterSetAddNodeSP (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
def	ParameterSetCreate (self, variableType, fieldSetType)
def	ParameterSetDataGetDP (self, variableType, fieldSetType)
def	ParameterSetDataGetIntg (self, variableType, fieldSetType)
def	ParameterSetDataGetL (self, variableType, fieldSetType)
def	ParameterSetDataGetSP (self, variableType, fieldSetType)
def	ParameterSetDataRestoreDP (self, variableType, fieldSetType, parameters)
def	ParameterSetDataRestoreIntg (self, variableType, fieldSetType, parameters)
def	ParameterSetDataRestoreL (self, variableType, fieldSetType, parameters)
def	ParameterSetDataRestoreSP (self, variableType, fieldSetType, parameters)
def	ParameterSetDestroy (self, variableType, fieldSetType)
def	ParameterSetGetConstantDP (self, variableType, fieldSetType, componentNumber)
def	ParameterSetGetConstantIntg (self, variableType, fieldSetType, componentNumber)
def	ParameterSetGetConstantL (self, variableType, fieldSetType, componentNumber)
def	ParameterSetGetConstantSP (self, variableType, fieldSetType, componentNumber)
def	ParameterSetGetDataPointDP (self, variableType, fieldSetType, userDataPointNumber, componentNumber)
def	ParameterSetGetDataPointIntg (self, variableType, fieldSetType, userDataPointNumber, componentNumber)
def	ParameterSetGetDataPointL (self, variableType, fieldSetType, userDataPointNumber, componentNumber)
def	ParameterSetGetDataPointSP (self, variableType, fieldSetType, userDataPointNumber, componentNumber)
def	ParameterSetGetElementDP (self, variableType, fieldSetType, userElementNumber, componentNumber)
def	ParameterSetGetElementIntg (self, variableType, fieldSetType, userElementNumber, componentNumber)
def	ParameterSetGetElementL (self, variableType, fieldSetType, userElementNumber, componentNumber)
def	ParameterSetGetElementSP (self, variableType, fieldSetType, userElementNumber, componentNumber)
def	ParameterSetGetGaussPointDP (self, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber)
def	ParameterSetGetNodeDP (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber)
def	ParameterSetGetNodeIntg (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber)
def	ParameterSetGetNodeL (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber)
def	ParameterSetGetNodeSP (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber)
def	ParameterSetInterpolateMultipleGaussDP (self, variableType, fieldSetType, derivativeNumber, userElementNumber, quadratureScheme, GaussPoints, valuesSizes)
def	ParameterSetInterpolateMultipleXiDP (self, variableType, fieldSetType, derivativeNumber, userElementNumber, xi, valuesSizes)
def	ParameterSetInterpolateSingleGaussDP (self, variableType, fieldSetType, derivativeNumber, userElementNumber, quadratureScheme, GaussPoint, valuesSize)
def	ParameterSetInterpolateSingleXiDP (self, variableType, fieldSetType, derivativeNumber, userElementNumber, xi, valuesSize)
def	ParameterSetNodeNumberOfScaleFactorDofsGet (self, variableType, meshComponentNumber)
def	ParameterSetNodeScaleFactorGet (self, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber)
def	ParameterSetNodeScaleFactorSet (self, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, scaleFactor)
def	ParameterSetNodeScaleFactorsGet (self, variableType, meshComponentNumber, scaleFactorsSize)
def	ParameterSetNodeScaleFactorsSet (self, variableType, meshComponentNumber, scaleFactors)
def	ParameterSetUpdateConstantDP (self, variableType, fieldSetType, componentNumber, value)
def	ParameterSetUpdateConstantIntg (self, variableType, fieldSetType, componentNumber, value)
def	ParameterSetUpdateConstantL (self, variableType, fieldSetType, componentNumber, value)
def	ParameterSetUpdateConstantSP (self, variableType, fieldSetType, componentNumber, value)
def	ParameterSetUpdateDataPointDP (self, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
def	ParameterSetUpdateDataPointIntg (self, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
def	ParameterSetUpdateDataPointL (self, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
def	ParameterSetUpdateDataPointSP (self, variableType, fieldSetType, userDataPointNumber, componentNumber, value)
def	ParameterSetUpdateElementDP (self, variableType, fieldSetType, userElementNumber, componentNumber, value)
def	ParameterSetUpdateElementDataPointDP (self, variableType, fieldSetType, elementNumber, dataPointIndex, componentNumber, value)
def	ParameterSetUpdateElementIntg (self, variableType, fieldSetType, userElementNumber, componentNumber, value)
def	ParameterSetUpdateElementL (self, variableType, fieldSetType, userElementNumber, componentNumber, value)
def	ParameterSetUpdateElementSP (self, variableType, fieldSetType, userElementNumber, componentNumber, value)
def	ParameterSetUpdateFinish (self, variableType, fieldSetType)
def	ParameterSetUpdateGaussPointDP (self, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value)
def	ParameterSetUpdateGaussPointIntg (self, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value)
def	ParameterSetUpdateGaussPointL (self, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value)
def	ParameterSetUpdateGaussPointSP (self, variableType, fieldSetType, gaussPointNumber, userElementNumber, componentNumber, value)
def	ParameterSetUpdateLocalDofsDP (self, variableType, fieldSetType, values)
def	ParameterSetUpdateNodeDP (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
def	ParameterSetUpdateNodeIntg (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
def	ParameterSetUpdateNodeL (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
def	ParameterSetUpdateNodeSP (self, variableType, fieldSetType, versionNumber, derivativeNumber, userNodeNumber, componentNumber, value)
def	ParameterSetUpdateStart (self, variableType, fieldSetType)
def	ParametersToFieldParametersComponentCopy (self, fromVariableType, fromParameterSetType, fromComponentNumber, toField, toVariableType, toParameterSetType, toComponentNumber)
def	PositionNormalTangentCalculateNode (self, variableType, componentNumber, localNodeNumber, positionSize, normalSize, tangentsSizes)
def	ScalingTypeGet (self)
def	ScalingTypeSet (self, scalingType)
def	TypeGet (self)
def	TypeSet (self, fieldType)
def	VariableLabelGet (self, variableType)
def	VariableLabelSet (self, variableType, label)
def	VariableTypesGet (self, variableTypesSize)
def	VariableTypesSet (self, variableTypes)

Public Attributes
	cmiss_type

Properties
	dependentType = property(DependentTypeGet, DependentTypeSet, None, )
	variableTypes = property(VariableTypesGet, VariableTypesSet, None, )
	dataProjection = property(None, DataProjectionSet, None, )
	numberOfVariables = property(NumberOfVariablesGet, NumberOfVariablesSet, None, )
	label = property(LabelGet, LabelSet, None, )
	meshDecomposition = property(MeshDecompositionGet, MeshDecompositionSet, None, )
	scalingType = property(ScalingTypeGet, ScalingTypeSet, None, )
	type = property(TypeGet, TypeSet, None, )
	geometricField = property(GeometricFieldGet, GeometricFieldSet, None, )

Detailed Description

Contains information for a field defined on a region.

Definition at line 3573 of file iron.py.

Constructor & Destructor Documentation

def iron.Field.__init__

(

self

)

Initialise a null cmfe_FieldType

Definition at line 3577 of file iron.py.

Member Function Documentation

def iron.Field.ComponentInterpolationGet	(		self,
			variableType,
			componentNumber
	)

Returns the interpolation type for a field variable component for a field identified by an object.

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

Definition at line 3582 of file iron.py.

def iron.Field.ComponentInterpolationSet	(		self,
			variableType,
			componentNumber,
			interpolationType
	)

Sets/changes the interpolation type for a field variable component for a field identified by an object.

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

Definition at line 3596 of file iron.py.

def iron.Field.ComponentLabelGet	(		self,
			variableType,
			componentNumber
	)

Returns the character string label for a field variable component for a field identified by an object.

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

Definition at line 3611 of file iron.py.

def iron.Field.ComponentLabelSet	(		self,
			variableType,
			componentNumber,
			label
	)

Sets/changes the character string label for a field variable component for a field identified by an object.

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

Definition at line 3625 of file iron.py.

def iron.Field.ComponentMeshComponentGet	(		self,
			variableType,
			componentNumber
	)

Returns the mesh component number for a field variable component for a field identified by an object.

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

Definition at line 3640 of file iron.py.

def iron.Field.ComponentMeshComponentSet	(		self,
			variableType,
			componentNumber,
			meshComponent
	)

Sets/changes the mesh component number for a field variable component for a field identified by an object.

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

Definition at line 3654 of file iron.py.

def iron.Field.ComponentValuesInitialiseDP	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Initialises the values of parameter set of a field variable component to a double precision constant value for a field identified by an object.

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

Definition at line 3669 of file iron.py.

def iron.Field.ComponentValuesInitialiseIntg	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Initialises the values of parameter set of a field variable component to an integer constant value for a field identified by an object.

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

Definition at line 3686 of file iron.py.

def iron.Field.ComponentValuesInitialiseL	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Initialises the values of parameter set of a field variable component to a logical constant value for a field identified by an object.

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

Definition at line 3703 of file iron.py.

def iron.Field.ComponentValuesInitialiseSP	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Initialises the values of parameter set of a field variable component to a single precision constant value for a field identified by an object.

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

Definition at line 3720 of file iron.py.

def iron.Field.CreateFinish

(

self

)

Finishes the creation of a field identified by an object.

:rtype: None

Definition at line 3737 of file iron.py.

def iron.Field.CreateStart	(		self,
			fieldUserNumber,
			region
	)

Starts the creation of a field on a region identified by an object.

:param fieldUserNumber: The user number of the field to start the creation of.
:type fieldUserNumber: int
:param region: The region to create the field on.
:type region: Region
:rtype: None

Definition at line 3759 of file iron.py.

def iron.Field.CreateStartInterface	(		self,
			fieldUserNumber,
			interface
	)

Starts the creation of a field on an interface identified by an object.

:param fieldUserNumber: The user number of the field to start the creation of.
:type fieldUserNumber: int
:param interface: The interface to create the field on.
:type interface: Interface
:rtype: None

Definition at line 3746 of file iron.py.

def iron.Field.DataProjectionSet	(		self,
			dataProjection
	)

Sets/changes the data projection for a field identified by an object.

:param dataProjection: The data projection for the field to set.
:type dataProjection: DataProjection
:rtype: None

Definition at line 3797 of file iron.py.

def iron.Field.DataTypeGet	(		self,
			variableType
	)

Returns the data type for a field variable for a field identified by an object.

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

Definition at line 3808 of file iron.py.

def iron.Field.DataTypeSet	(		self,
			variableType,
			dataType
	)

Sets/changes the data type for a field variable for a field identified by an object.

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

Definition at line 3820 of file iron.py.

def iron.Field.DependentTypeGet

(

self

)

Returns the dependent type for a field identified by an object.

:returns: dependentType. The field dependent type. Will be a value from the FieldDependentTypes enum.
:rtype: int

Definition at line 3833 of file iron.py.

def iron.Field.DependentTypeSet	(		self,
			dependentType
	)

Sets/changes the dependent type for a field identified by an object.

:param dependentType: The field dependent type to set. Must be a value from the FieldDependentTypes enum.
:type dependentType: int
:rtype: None

Definition at line 3843 of file iron.py.

def iron.Field.Destroy

(

self

)

Destroys a field identified by an object.

:rtype: None

Definition at line 3854 of file iron.py.

def iron.Field.DimensionGet	(		self,
			variableType
	)

Returns the dimension for a field identified by an object.

:param variableType: The variable type of the field to get the dimension for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:returns: dimension. The field dimension. Will be a value from the FieldDimension enum.
:rtype: int

Definition at line 3863 of file iron.py.

def iron.Field.DimensionSet	(		self,
			variableType,
			dimension
	)

Sets/changes the dimension for a field identified by an object.

:param variableType: The variable type of the field to get the dimension for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param dimension: The field dimension to set. Must be a value from the FieldDimension enum.
:type dimension: int
:rtype: None

Definition at line 3875 of file iron.py.

def iron.Field.DOFOrderTypeGet	(		self,
			variableType
	)

Returns the DOF Order type for a field variable for a field identified by an object.

:param variableType: The variable type of the field to get the DOF order type for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:returns: DOFOrderType. The field variable DOF order type. Will be a value from the FieldDOFOrderTypes enum.
:rtype: int

Definition at line 3772 of file iron.py.

def iron.Field.DOFOrderTypeSet	(		self,
			variableType,
			DOFOrderType
	)

Sets/changes the DOF Order type for a field variable for a field identified by an object.

:param variableType: The variable type of the field to set the DOF order type for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param DOFOrderType: The field variable DOF order type to set. Must be a value from the FieldDOFOrderTypes enum.
:type DOFOrderType: int
:rtype: None

Definition at line 3784 of file iron.py.

def iron.Field.Finalise

(

self

)

Finalises a cmfe_FieldType object.

:rtype: None

Definition at line 3888 of file iron.py.

def iron.Field.GeometricFieldGet	(		self,
			geometricField
	)

Returns the geometric field for a field identified by an object.

:param geometricField: On return, the geometric field for the field.
:type geometricField: Field
:rtype: None

Definition at line 3897 of file iron.py.

def iron.Field.GeometricFieldSet	(		self,
			geometricField
	)

Sets/changes the geometric field for a field identified by an object.

:param geometricField: The geometric field for the field to set.
:type geometricField: Field
:rtype: None

Definition at line 3908 of file iron.py.

def iron.Field.GeometricParametersElementLineLengthGet	(		self,
			elementNumber,
			elementLineNumber
	)

Gets the line length between nodes of a geometric field for a given element number and element basis line number by an object.

:param elementNumber: The element to get the line length for
:type elementNumber: int
:param elementLineNumber: The element basis line to get the length for
:type elementLineNumber: int
:returns: lineLength. The line length of the chosen element line number
:rtype: float

Definition at line 3919 of file iron.py.

def iron.Field.GeometricParametersElementVolumeGet	(		self,
			elementNumber
	)

Gets the volume for a given element number by an object.

:param elementNumber: The element to get the volume for
:type elementNumber: int
:returns: elementVolume. The volume of the chosen element
:rtype: float

Definition at line 3933 of file iron.py.

def iron.Field.LabelGet

(

self

)

Returns the character string label for a field identified by an object.

:returns: label. The field label.
:rtype: string

Definition at line 3945 of file iron.py.

def iron.Field.LabelSet	(		self,
			label
	)

Sets/changes the character string label for a field identified by an object.

:param label: The field label to set.
:type label: string
:rtype: None

Definition at line 3955 of file iron.py.

def iron.Field.MeshDecompositionGet	(		self,
			meshDecomposition
	)

Returns the mesh decomposition for a field identified by an object.

:param meshDecomposition: On return, the mesh decomposition for the field.
:type meshDecomposition: Decomposition
:rtype: None

Definition at line 3966 of file iron.py.

def iron.Field.MeshDecompositionSet	(		self,
			meshDecomposition
	)

Sets/changes the mesh decomposition for a field identified by an object.

:param meshDecomposition: The mesh decomposition for the field to set.
:type meshDecomposition: Decomposition
:rtype: None

Definition at line 3977 of file iron.py.

def iron.Field.NumberOfComponentsGet	(		self,
			variableType
	)

Returns the number of components for a field variable for a field identified by an object.

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

Definition at line 3988 of file iron.py.

def iron.Field.NumberOfComponentsSet	(		self,
			variableType,
			numberOfComponents
	)

Sets/changes the number of components for a field variable for a field identified by an object.

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

Definition at line 4000 of file iron.py.

def iron.Field.NumberOfVariablesGet

(

self

)

Returns the number of variables for a field identified by an object.

:returns: numberOfVariables. The number of variables in the field.
:rtype: int

Definition at line 4013 of file iron.py.

def iron.Field.NumberOfVariablesSet	(		self,
			numberOfVariables
	)

Sets/changes the number of variables for a field identified by an object.

:param numberOfVariables: The number of variables in the field to set.
:type numberOfVariables: int
:rtype: None

Definition at line 4023 of file iron.py.

def iron.Field.ParameterSetAddConstantDP	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Adds the given double precision value to the given parameter set for the constant of the field variable component for a field identified by an object.

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

Definition at line 4034 of file iron.py.

def iron.Field.ParameterSetAddConstantIntg	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Adds the given integer value to the given parameter set for the constant of the field variable component for a field identified by an object.

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

Definition at line 4051 of file iron.py.

def iron.Field.ParameterSetAddConstantL	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Adds the given logical value to the given parameter set for the constant of the field variable component for a field identified by an object.

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

Definition at line 4068 of file iron.py.

def iron.Field.ParameterSetAddConstantSP	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Adds the given single precision value to the given parameter set for the constant of the field variable component for a field identified by an object.

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

Definition at line 4085 of file iron.py.

def iron.Field.ParameterSetAddElementDP	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber,
			value
	)

Adds the given double precision value to an element in the given parameter set for field variable component for a field identified by an object.

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

Definition at line 4102 of file iron.py.

def iron.Field.ParameterSetAddElementIntg	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber,
			value
	)

Adds the given integer value to an element in the given parameter set for field variable component for a field identified by an object.

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

Definition at line 4121 of file iron.py.

def iron.Field.ParameterSetAddElementL	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber,
			value
	)

Adds the given logical value to an element in the given parameter set for field variable component for a field identified by an object.

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

Definition at line 4140 of file iron.py.

def iron.Field.ParameterSetAddElementSP	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber,
			value
	)

Adds the given single precision value to an element in the given parameter set for field variable component for a field identified by an object.

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

Definition at line 4159 of file iron.py.

def iron.Field.ParameterSetAddNodeDP	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber,
			value
	)

Adds the given double precision value to an node in the given parameter set for field variable component for a field identified by an object.

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

Definition at line 4178 of file iron.py.

def iron.Field.ParameterSetAddNodeIntg	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber,
			value
	)

Adds the given integer value to an node in the given parameter set for field variable component for a field identified by an object.

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

Definition at line 4201 of file iron.py.

def iron.Field.ParameterSetAddNodeL	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber,
			value
	)

Adds the given logical value to an node in the given parameter set for field variable component for a field identified by an object.

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

Definition at line 4224 of file iron.py.

def iron.Field.ParameterSetAddNodeSP	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber,
			value
	)

Adds the given single precision value to an node in the given parameter set for field variable component for a field identified by an object.

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

Definition at line 4247 of file iron.py.

def iron.Field.ParameterSetCreate	(		self,
			variableType,
			fieldSetType
	)

Creates a new parameter set of type set type for a field variable for a field identified by an object.

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

Definition at line 4270 of file iron.py.

def iron.Field.ParameterSetDataGetDP	(		self,
			variableType,
			fieldSetType
	)

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.

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

Definition at line 4283 of file iron.py.

def iron.Field.ParameterSetDataGetIntg	(		self,
			variableType,
			fieldSetType
	)

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.

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

Definition at line 4298 of file iron.py.

def iron.Field.ParameterSetDataGetL	(		self,
			variableType,
			fieldSetType
	)

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.

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

Definition at line 4313 of file iron.py.

def iron.Field.ParameterSetDataGetSP	(		self,
			variableType,
			fieldSetType
	)

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.

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

Definition at line 4328 of file iron.py.

def iron.Field.ParameterSetDataRestoreDP	(		self,
			variableType,
			fieldSetType,
			parameters
	)

Restores the specified field variable parameter set local double precision array that was obtained with an OpenCMISS::Iron::cmfe_Field_ParameterSetDataGet call for a field that is specified with an object.

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

Definition at line 4343 of file iron.py.

def iron.Field.ParameterSetDataRestoreIntg	(		self,
			variableType,
			fieldSetType,
			parameters
	)

Restores the specified field variable parameter set local integer array that was obtained with an OpenCMISS::Iron::cmfe_Field_ParameterSetDataGet call for a field that is specified with an object.

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

Definition at line 4358 of file iron.py.

def iron.Field.ParameterSetDataRestoreL	(		self,
			variableType,
			fieldSetType,
			parameters
	)

Restores the specified field variable parameter set local logical array that was obtained with an OpenCMISS::Iron::cmfe_Field_ParameterSetDataGet call for a field that is specified with an object.

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

Definition at line 4373 of file iron.py.

def iron.Field.ParameterSetDataRestoreSP	(		self,
			variableType,
			fieldSetType,
			parameters
	)

Restores the specified field variable parameter set local single precision array that was obtained with an OpenCMISS::Iron::cmfe_Field_ParameterSetDataGet call for a field that is specified with an object.

:param variableType: The variable type of the field to restore the parameter set data for. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the parameter set data to restore. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param parameters: A pointer to the parameter set data to restore.
:type parameters: Array of floats
:rtype: None

Definition at line 4388 of file iron.py.

def iron.Field.ParameterSetDestroy	(		self,
			variableType,
			fieldSetType
	)

Destroys the specified parameter set type for a field variable for a field identified by an object.

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

Definition at line 4403 of file iron.py.

def iron.Field.ParameterSetGetConstantDP	(		self,
			variableType,
			fieldSetType,
			componentNumber
	)

Returns from the given parameter set a double precision value for the specified constant of a field variable component for a field identified by an object.

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

Definition at line 4416 of file iron.py.

def iron.Field.ParameterSetGetConstantIntg	(		self,
			variableType,
			fieldSetType,
			componentNumber
	)

Returns from the given parameter set an integer value for the specified constant of a field variable component for a field identified by an object.

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

Definition at line 4432 of file iron.py.

def iron.Field.ParameterSetGetConstantL	(		self,
			variableType,
			fieldSetType,
			componentNumber
	)

Returns from the given parameter set a logical value for the specified constant of a field variable component for a field identified by an object.

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

Definition at line 4448 of file iron.py.

def iron.Field.ParameterSetGetConstantSP	(		self,
			variableType,
			fieldSetType,
			componentNumber
	)

Returns from the given parameter set a single precision value for the specified constant of a field variable component for a field identified by an object.

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

Definition at line 4464 of file iron.py.

def iron.Field.ParameterSetGetDataPointDP	(		self,
			variableType,
			fieldSetType,
			userDataPointNumber,
			componentNumber
	)

Returns from the given parameter set a double precision value for the specified constant of a field variable component for a field identified by an object.

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

Definition at line 4480 of file iron.py.

def iron.Field.ParameterSetGetDataPointIntg	(		self,
			variableType,
			fieldSetType,
			userDataPointNumber,
			componentNumber
	)

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.

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

Definition at line 4498 of file iron.py.

def iron.Field.ParameterSetGetDataPointL	(		self,
			variableType,
			fieldSetType,
			userDataPointNumber,
			componentNumber
	)

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.

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

Definition at line 4516 of file iron.py.

def iron.Field.ParameterSetGetDataPointSP	(		self,
			variableType,
			fieldSetType,
			userDataPointNumber,
			componentNumber
	)

Returns from the given parameter set a single precision value for the specified constant of a field variable component for a field identified by an object.

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

Definition at line 4534 of file iron.py.

def iron.Field.ParameterSetGetElementDP	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber
	)

Returns from the given parameter set a double precision value for the specified element of a field variable component for a field identified by an object.

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

Definition at line 4552 of file iron.py.

def iron.Field.ParameterSetGetElementIntg	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber
	)

Returns from the given parameter set an integer value for the specified element of a field variable component for a field identified by an object.

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

Definition at line 4570 of file iron.py.

def iron.Field.ParameterSetGetElementL	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber
	)

Returns from the given parameter set a logical value for the specified element of a field variable component for a field identified by an object.

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

Definition at line 4588 of file iron.py.

def iron.Field.ParameterSetGetElementSP	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber
	)

Returns from the given parameter set a single precision value for the specified element of a field variable component for a field identified by an object.

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

Definition at line 4606 of file iron.py.

def iron.Field.ParameterSetGetGaussPointDP	(		self,
			variableType,
			fieldSetType,
			gaussPointNumber,
			userElementNumber,
			componentNumber
	)

Returns from the given parameter set a double precision value for the specified element of a field variable component for a field identified by an object.

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

Definition at line 4624 of file iron.py.

def iron.Field.ParameterSetGetNodeDP	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber
	)

Returns from the given parameter set a double precision value for the specified node and derivative of a field variable component for a field identified by an object.

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

Definition at line 4644 of file iron.py.

def iron.Field.ParameterSetGetNodeIntg	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber
	)

Returns from the given parameter set an integer value for the specified node and derivative of a field variable component for a field identified by an object.

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

Definition at line 4666 of file iron.py.

def iron.Field.ParameterSetGetNodeL	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber
	)

Returns from the given parameter set a logical value for the specified node and derivative of a field variable component for a field identified by an object.

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

Definition at line 4688 of file iron.py.

def iron.Field.ParameterSetGetNodeSP	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber
	)

Returns from the given parameter set a single precision value for the specified node and derivative of a field variable component for a field identified by an object.

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

Definition at line 4710 of file iron.py.

def iron.Field.ParameterSetInterpolateMultipleGaussDP	(		self,
			variableType,
			fieldSetType,
			derivativeNumber,
			userElementNumber,
			quadratureScheme,
			GaussPoints,
			valuesSizes
	)

Interpolates the given parameter set at a specified set of Gauss points for the specified element and derviative and returns double precision values for a field identified by an object. If no Gauss points are specified then all Gauss points are interpolated.

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

Definition at line 4732 of file iron.py.

def iron.Field.ParameterSetInterpolateMultipleXiDP	(		self,
			variableType,
			fieldSetType,
			derivativeNumber,
			userElementNumber,
			xi,
			valuesSizes
	)

Interpolates the given parameter set at a specified set of xi locations for the specified element and derviative and returns double precision values for a field identified by an object.

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

Definition at line 4755 of file iron.py.

def iron.Field.ParameterSetInterpolateSingleGaussDP	(		self,
			variableType,
			fieldSetType,
			derivativeNumber,
			userElementNumber,
			quadratureScheme,
			GaussPoint,
			valuesSize
	)

Interpolates the given parameter set at a specified Gauss point for the specified element and derviative and returns double precision values for a field identified by an object.

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

Definition at line 4776 of file iron.py.

def iron.Field.ParameterSetInterpolateSingleXiDP	(		self,
			variableType,
			fieldSetType,
			derivativeNumber,
			userElementNumber,
			xi,
			valuesSize
	)

Interpolates the given parameter set at a specified xi location for the specified element and derviative and returns double precision values for a field identified by an object.

:param variableType: The variable type of the field to interpolate. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to interpolate. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param derivativeNumber: The derivative number of the field to interpolate.
:type derivativeNumber: int
:param userElementNumber: The user element number of the field to interpolate.
:type userElementNumber: int
:param xi: The element xi to interpolate the field at.
:type xi: Array of floats
:param valuesSize: Size of values to allocate.
:returns: values. The interpolated values.
:rtype: Array of floats

Definition at line 4799 of file iron.py.

def iron.Field.ParameterSetNodeNumberOfScaleFactorDofsGet	(		self,
			variableType,
			meshComponentNumber
	)

Gets the number of scale factor dofs, identified by an object.

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

Definition at line 4820 of file iron.py.

def iron.Field.ParameterSetNodeScaleFactorGet	(		self,
			variableType,
			versionNumber,
			derivativeNumber,
			nodeUserNumber,
			componentNumber
	)

Gets the scale factor for a particular node identified by an object.

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

Definition at line 4834 of file iron.py.

def iron.Field.ParameterSetNodeScaleFactorSet	(		self,
			variableType,
			versionNumber,
			derivativeNumber,
			nodeUserNumber,
			componentNumber,
			scaleFactor
	)

Sets the scale factor for a particular node identified by an object.

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

Definition at line 4854 of file iron.py.

def iron.Field.ParameterSetNodeScaleFactorsGet	(		self,
			variableType,
			meshComponentNumber,
			scaleFactorsSize
	)

Gets the scale factors for all nodes identified by an object.

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

Definition at line 4875 of file iron.py.

def iron.Field.ParameterSetNodeScaleFactorsSet	(		self,
			variableType,
			meshComponentNumber,
			scaleFactors
	)

Sets the scale factors for all nodes identified by an object.

:param variableType: The field variable type to set the scale factor for
:type variableType: int
:param meshComponentNumber: The component number of the field to set the scale factor for
:type meshComponentNumber: int
:param scaleFactors: The scale factors
:type scaleFactors: Array of floats
:rtype: None

Definition at line 4890 of file iron.py.

def iron.Field.ParameterSetUpdateConstantDP	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Updates the given parameter set with the given double precision value for the constant of the field variable component for a field identified by an object.

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

Definition at line 4905 of file iron.py.

def iron.Field.ParameterSetUpdateConstantIntg	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Updates the given parameter set with the given integer value for the constant of the field variable component for a field identified by an object.

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

Definition at line 4922 of file iron.py.

def iron.Field.ParameterSetUpdateConstantL	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Updates the given parameter set with the given logical value for the constant of the field variable component for a field identified by an object.

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

Definition at line 4939 of file iron.py.

def iron.Field.ParameterSetUpdateConstantSP	(		self,
			variableType,
			fieldSetType,
			componentNumber,
			value
	)

Updates the given parameter set with the given single precision value for the constant of the field variable component for a field identified by an object.

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

Definition at line 4956 of file iron.py.

def iron.Field.ParameterSetUpdateDataPointDP	(		self,
			variableType,
			fieldSetType,
			userDataPointNumber,
			componentNumber,
			value
	)

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.

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

Definition at line 4973 of file iron.py.

def iron.Field.ParameterSetUpdateDataPointIntg	(		self,
			variableType,
			fieldSetType,
			userDataPointNumber,
			componentNumber,
			value
	)

Update the given parameter set a integer value for the specified constant of a field variable component for a field identified by an object.

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

Definition at line 4992 of file iron.py.

def iron.Field.ParameterSetUpdateDataPointL	(		self,
			variableType,
			fieldSetType,
			userDataPointNumber,
			componentNumber,
			value
	)

Update the given parameter set a logical value for the specified constant of a field variable component for a field identified by an object.

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

Definition at line 5011 of file iron.py.

def iron.Field.ParameterSetUpdateDataPointSP	(		self,
			variableType,
			fieldSetType,
			userDataPointNumber,
			componentNumber,
			value
	)

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.

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

Definition at line 5030 of file iron.py.

def iron.Field.ParameterSetUpdateElementDataPointDP	(		self,
			variableType,
			fieldSetType,
			elementNumber,
			dataPointIndex,
			componentNumber,
			value
	)

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.

:param variableType: The variable type of the field to update the constant value for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update the constant value for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param elementNumber: The user element number to update the data point for.
:type elementNumber: int
:param dataPointIndex: The index of the data point for the data points projected on this element.
:type dataPointIndex: int
:param componentNumber: The component number of the field variable to update the constant value for the field parameter set.
:type componentNumber: int
:param value: The value for the field parameter set to update.
:type value: float
:rtype: None

Definition at line 5068 of file iron.py.

def iron.Field.ParameterSetUpdateElementDP	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber,
			value
	)

Updates the given parameter set with the given double precision value for the element of the field variable component for a field identified by an object.

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

Definition at line 5049 of file iron.py.

def iron.Field.ParameterSetUpdateElementIntg	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber,
			value
	)

Updates the given parameter set with the given integer value for the element of the field variable component for a field identified by an object.

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

Definition at line 5089 of file iron.py.

def iron.Field.ParameterSetUpdateElementL	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber,
			value
	)

Updates the given parameter set with the given logical value for the element of the field variable component for a field identified by an object.

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

Definition at line 5108 of file iron.py.

def iron.Field.ParameterSetUpdateElementSP	(		self,
			variableType,
			fieldSetType,
			userElementNumber,
			componentNumber,
			value
	)

Updates the given parameter set with the given single precision value for the element of the field variable component for a field identified by an object.

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

Definition at line 5127 of file iron.py.

def iron.Field.ParameterSetUpdateFinish	(		self,
			variableType,
			fieldSetType
	)

Finishes the parameter set update for a field variable for a field identified by an object.

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

Definition at line 5146 of file iron.py.

def iron.Field.ParameterSetUpdateGaussPointDP	(		self,
			variableType,
			fieldSetType,
			gaussPointNumber,
			userElementNumber,
			componentNumber,
			value
	)

Updates the given parameter set with the given double precision value for the element Gauss point of the field variable component for a field identified by an object.

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

Definition at line 5159 of file iron.py.

def iron.Field.ParameterSetUpdateGaussPointIntg	(		self,
			variableType,
			fieldSetType,
			gaussPointNumber,
			userElementNumber,
			componentNumber,
			value
	)

Updates the given parameter set with the given integer value for the element Gauss point of the field variable component for a field identified by an object.

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

Definition at line 5180 of file iron.py.

def iron.Field.ParameterSetUpdateGaussPointL	(		self,
			variableType,
			fieldSetType,
			gaussPointNumber,
			userElementNumber,
			componentNumber,
			value
	)

Updates the given parameter set with the given logical value for the element Gauss point of the field variable component for a field identified by an object.

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

Definition at line 5201 of file iron.py.

def iron.Field.ParameterSetUpdateGaussPointSP	(		self,
			variableType,
			fieldSetType,
			gaussPointNumber,
			userElementNumber,
			componentNumber,
			value
	)

Updates the given parameter set with the given single precision value for the element Gauss point of the field variable component for a field identified by an object.

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

Definition at line 5222 of file iron.py.

def iron.Field.ParameterSetUpdateLocalDofsDP	(		self,
			variableType,
			fieldSetType,
			values
	)

Updates the given parameter set with the given values for all local dofs of the field variable identified by an object..

:param variableType: The variable type of the field to update values for the field parameter set. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param fieldSetType: The parameter set type of the field to update values for. Must be a value from the FieldParameterSetTypes enum.
:type fieldSetType: int
:param values: The values to update the field parameter set to.
:type values: Array of floats
:rtype: None

Definition at line 5243 of file iron.py.

def iron.Field.ParameterSetUpdateNodeDP	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber,
			value
	)

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

Definition at line 5258 of file iron.py.

def iron.Field.ParameterSetUpdateNodeIntg	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber,
			value
	)

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

Definition at line 5279 of file iron.py.

def iron.Field.ParameterSetUpdateNodeL	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber,
			value
	)

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

Definition at line 5300 of file iron.py.

def iron.Field.ParameterSetUpdateNodeSP	(		self,
			variableType,
			fieldSetType,
			versionNumber,
			derivativeNumber,
			userNodeNumber,
			componentNumber,
			value
	)

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

Definition at line 5321 of file iron.py.

def iron.Field.ParameterSetUpdateStart	(		self,
			variableType,
			fieldSetType
	)

Starts the parameter set update for a field variable for a field identified by an object.

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

Definition at line 5342 of file iron.py.

def iron.Field.ParametersToFieldParametersComponentCopy	(		self,
			fromVariableType,
			fromParameterSetType,
			fromComponentNumber,
			toField,
			toVariableType,
			toParameterSetType,
			toComponentNumber
	)

Copy the parameters from the parameter set of a component of a field variable to the paramters of a parameter set of
a component of another field variable, where both fields are objects.

:param fromVariableType: The field variable type to copy from
:type fromVariableType: int
:param fromParameterSetType: The field parameter set type to copy from
:type fromParameterSetType: int
:param fromComponentNumber: The field variable component number to copy from
:type fromComponentNumber: int
:param toField: The field to copy to
:type toField: Field
:param toVariableType: The field variable type to copy to
:type toVariableType: int
:param toParameterSetType: The parameter set type to copy to
:type toParameterSetType: int
:param toComponentNumber: The field variable component to copy to
:type toComponentNumber: int
:rtype: None

Definition at line 5355 of file iron.py.

def iron.Field.PositionNormalTangentCalculateNode	(		self,
			variableType,
			componentNumber,
			localNodeNumber,
			positionSize,
			normalSize,
			tangentsSizes
	)

Returns the position, normal and tangents for a field node for a field identified by an object.

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

Definition at line 5379 of file iron.py.

def iron.Field.ScalingTypeGet

(

self

)

Returns the scaling type for a field identified by an object.

:returns: scalingType. The field scaling type. Will be a value from the FieldScalingTypes enum.
:rtype: int

Definition at line 5398 of file iron.py.

def iron.Field.ScalingTypeSet	(		self,
			scalingType
	)

Sets/changes the scaling type for a field identified by an object.

:param scalingType: The field scaling type to set. Must be a value from the FieldScalingTypes enum.
:type scalingType: int
:rtype: None

Definition at line 5408 of file iron.py.

def iron.Field.TypeGet

(

self

)

Returns the type for a field identified by an object.

:returns: fieldType. The field type. Will be a value from the FieldTypes enum.
:rtype: int

Definition at line 5419 of file iron.py.

def iron.Field.TypeSet	(		self,
			fieldType
	)

Sets/changes the type for a field identified by an object.

:param fieldType: The field type to set. Must be a value from the FieldTypes enum.
:type fieldType: int
:rtype: None

Definition at line 5429 of file iron.py.

def iron.Field.VariableLabelGet	(		self,
			variableType
	)

Returns the character string label for a field variable for a field identified by an object.

:param variableType: The variable type of the field to get the field variable label. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:returns: label. The field variable label.
:rtype: string

Definition at line 5440 of file iron.py.

def iron.Field.VariableLabelSet	(		self,
			variableType,
			label
	)

Sets/changes the character string label for a field variable for a field identified by an object.

:param variableType: The variable type of the field to set the field variable label. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param label: The field variable label to set.
:type label: string
:rtype: None

Definition at line 5452 of file iron.py.

def iron.Field.VariableTypesGet	(		self,
			variableTypesSize
	)

Returns the variable types for a field identified by an object.

:param variableTypesSize: Size of variableTypes to allocate.
:returns: variableTypes. variableTypes(variable_idx). On return, the field variable types for the variable_idx'th field variable. Will be a value from the FieldVariableTypes enum.
:rtype: Array of ints

Definition at line 5465 of file iron.py.

def iron.Field.VariableTypesSet	(		self,
			variableTypes
	)

Sets/changes the variable types for a field identified by an object.

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

Definition at line 5476 of file iron.py.

Member Data Documentation

iron.Field.cmiss_type

Definition at line 3580 of file iron.py.

Property Documentation

iron.Field.dataProjection = property(None, DataProjectionSet, None, )

static

Definition at line 5491 of file iron.py.

iron.Field.dependentType = property(DependentTypeGet, DependentTypeSet, None, )

static

Definition at line 5487 of file iron.py.

iron.Field.geometricField = property(GeometricFieldGet, GeometricFieldSet, None, )

static

Definition at line 5503 of file iron.py.

iron.Field.label = property(LabelGet, LabelSet, None, )

static

Definition at line 5495 of file iron.py.

iron.Field.meshDecomposition = property(MeshDecompositionGet, MeshDecompositionSet, None, )

static

Definition at line 5497 of file iron.py.

iron.Field.numberOfVariables = property(NumberOfVariablesGet, NumberOfVariablesSet, None, )

static

Definition at line 5493 of file iron.py.

iron.Field.scalingType = property(ScalingTypeGet, ScalingTypeSet, None, )

static

Definition at line 5499 of file iron.py.

iron.Field.type = property(TypeGet, TypeSet, None, )

static

Definition at line 5501 of file iron.py.

iron.Field.variableTypes = property(VariableTypesGet, VariableTypesSet, None, )

static

Definition at line 5489 of file iron.py.