iron.BoundaryConditions Class Reference

Inheritance diagram for iron.BoundaryConditions:

Collaboration diagram for iron.BoundaryConditions:

Public Member Functions
def	__init__ (self)
def	AddConstant (self, field, variableType, componentNumber, condition, value)
def	AddElement (self, field, variableType, elementUserNumber, componentNumber, condition, value)
def	AddNode (self, field, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, condition, value)
def	ConstrainNodeDofsEqual (self, field, fieldVariableType, versionNumber, derivativeNumber, component, nodes, coefficient)
def	Destroy (self)
def	Finalise (self)
def	NeumannSparsityTypeSet (self, sparsityType)
def	SetConstant (self, field, variableType, componentNumber, condition, value)
def	SetElement (self, field, variableType, elementUserNumber, componentNumber, condition, value)
def	SetNode (self, field, variableType, versionNumber, derivativeNumber, nodeUserNumber, componentNumber, condition, value)

Public Attributes
	cmiss_type

Properties
	neumannSparsityType = property(None, NeumannSparsityTypeSet, None, )

Detailed Description

Contains information on the boundary conditions for the equations set.

Definition at line 287 of file iron.py.

Constructor & Destructor Documentation

def iron.BoundaryConditions.__init__

(

self

)

Initialise a null cmfe_BoundaryConditionsType

Definition at line 291 of file iron.py.

Member Function Documentation

def iron.BoundaryConditions.AddConstant	(		self,
			field,
			variableType,
			componentNumber,
			condition,
			value
	)

Adds to the value of the specified constant and sets this as a boundary condition on the specified constant for boundary conditions identified by an object.

:param field: The dependent field to set the boundary condition on.
:type field: Field
:param variableType: The variable type of the dependent field to set the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param componentNumber: The component number of the dependent field to set the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to add.
:type value: float
:rtype: None

Definition at line 296 of file iron.py.

def iron.BoundaryConditions.AddElement	(		self,
			field,
			variableType,
			elementUserNumber,
			componentNumber,
			condition,
			value
	)

Adds to the value of the specified element and sets this as a boundary condition on the specified element for boundary conditions identified by an object.

:param field: The dependent field to set the boundary condition on.
:type field: Field
:param variableType: The variable type of the dependent field to add the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param elementUserNumber: The user number of the element to add the boundary conditions for.
:type elementUserNumber: int
:param componentNumber: The component number of the dependent field to set the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to add.
:type value: float
:rtype: None

Definition at line 315 of file iron.py.

def iron.BoundaryConditions.AddNode	(		self,
			field,
			variableType,
			versionNumber,
			derivativeNumber,
			nodeUserNumber,
			componentNumber,
			condition,
			value
	)

Adds to the value of the specified node and sets this as a boundary condition on the specified node for boundary conditions identified by an object.

:param field: The dependent field to set the boundary condition on.
:type field: Field
:param variableType: The variable type of the dependent field to add the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param versionNumber: The user number of the node derivative version to add the boundary conditions for.
:type versionNumber: int
:param derivativeNumber: The user number of the node derivative to add the boundary conditions for.
:type derivativeNumber: int
:param nodeUserNumber: The user number of the node to add the boundary conditions for.
:type nodeUserNumber: int
:param componentNumber: The component number of the dependent field to set the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to add.
:type value: float
:rtype: None

Definition at line 336 of file iron.py.

def iron.BoundaryConditions.ConstrainNodeDofsEqual	(		self,
			field,
			fieldVariableType,
			versionNumber,
			derivativeNumber,
			component,
			nodes,
			coefficient
	)

Constrain multiple nodal equations dependent field DOFs to be a single solver DOF in the solver equations

:param field: The equations dependent field containing the field DOFs to be constrained.
:type field: Field
:param fieldVariableType: The field variable type of the DOFs to be constrained. Must be a value from the FieldVariableTypes enum.
:type fieldVariableType: int
:param versionNumber: The derivative version number.
:type versionNumber: int
:param derivativeNumber: The derivative number.
:type derivativeNumber: int
:param component: The field component number of the DOFs to be constrained.
:type component: int
:param nodes: The user numbers of the nodes to be constrained to be equal.
:type nodes: Array of ints
:param coefficient: The coefficient of constraint, applied to all but the first node.
:type coefficient: float
:rtype: None

Definition at line 361 of file iron.py.

def iron.BoundaryConditions.Destroy

(

self

)

Destroys boundary conditions identified by an object.

:rtype: None

Definition at line 384 of file iron.py.

def iron.BoundaryConditions.Finalise

(

self

)

Finalises a cmfe_BoundaryConditionsType object.

:rtype: None

Definition at line 393 of file iron.py.

def iron.BoundaryConditions.NeumannSparsityTypeSet	(		self,
			sparsityType
	)

Sets the Neumann integration matrix sparsity type for the boundary conditions

:param sparsityType: The sparsity type for the Neumann integration matrices. Must be a value from the BoundaryConditionSparsityTypes enum.
:type sparsityType: int
:rtype: None

Definition at line 402 of file iron.py.

def iron.BoundaryConditions.SetConstant	(		self,
			field,
			variableType,
			componentNumber,
			condition,
			value
	)

Sets the value of the specified constant and sets this as a boundary condition on the specified constant for boundary conditions identified by an object.

:param field: The dependent field to set the boundary condition on.
:type field: Field
:param variableType: The variable type of the dependent field to set the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param componentNumber: The component number of the dependent field to set the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to set.
:type value: float
:rtype: None

Definition at line 413 of file iron.py.

def iron.BoundaryConditions.SetElement	(		self,
			field,
			variableType,
			elementUserNumber,
			componentNumber,
			condition,
			value
	)

Sets the value of the specified element and sets this as a boundary condition on the specified elements for boundary conditions identified by an object.

:param field: The dependent field to set the boundary condition on.
:type field: Field
:param variableType: The variable type of the dependent field to set the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param elementUserNumber: The user number of the element to set the boundary conditions for.
:type elementUserNumber: int
:param componentNumber: The component number of the dependent field to set the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to set.
:type value: float
:rtype: None

Definition at line 432 of file iron.py.

def iron.BoundaryConditions.SetNode	(		self,
			field,
			variableType,
			versionNumber,
			derivativeNumber,
			nodeUserNumber,
			componentNumber,
			condition,
			value
	)

Sets the value of the specified node and sets this as a boundary condition on the specified node for boundary conditions identified by an object.

:param field: The dependent field to set the boundary condition on.
:type field: Field
:param variableType: The variable type of the dependent field to set the boundary condition at. Must be a value from the FieldVariableTypes enum.
:type variableType: int
:param versionNumber: The user number of the node derivative version to set the boundary conditions for.
:type versionNumber: int
:param derivativeNumber: The user number of the node derivative to set the boundary conditions for.
:type derivativeNumber: int
:param nodeUserNumber: The user number of the node to set the boundary conditions for.
:type nodeUserNumber: int
:param componentNumber: The component number of the dependent field to set the boundary condition at.
:type componentNumber: int
:param condition: The boundary condition type to set. Must be a value from the BoundaryConditionsTypes enum.
:type condition: int
:param value: The value of the boundary condition to set.
:type value: float
:rtype: None

Definition at line 453 of file iron.py.

Member Data Documentation

iron.BoundaryConditions.cmiss_type

Definition at line 294 of file iron.py.

Property Documentation

iron.BoundaryConditions.neumannSparsityType = property(None, NeumannSparsityTypeSet, None, )

static

Definition at line 478 of file iron.py.