OpenCMISS-Iron Python Bindings API Documentation
iron.InterfaceCondition Class Reference
Inheritance diagram for iron.InterfaceCondition:
Collaboration diagram for iron.InterfaceCondition:

Public Member Functions

def __init__ (self)
 
def CreateFinish (self)
 
def CreateStart (self, interfaceConditionUserNumber, interface, geometricField)
 
def DependentVariableAdd (self, meshIndex, equationsSet, variableType)
 
def Destroy (self)
 
def EquationsCreateFinish (self)
 
def EquationsCreateStart (self, interfaceEquations)
 
def EquationsDestroy (self)
 
def Finalise (self)
 
def IntegrationTypeGet (self)
 
def IntegrationTypeSet (self, interfaceConditionIntegrationType)
 
def LagrangeFieldCreateFinish (self)
 
def LagrangeFieldCreateStart (self, lagrangeFieldUserNumber, lagrangeField)
 
def MethodGet (self)
 
def MethodSet (self, interfaceConditionMethod)
 
def OperatorGet (self)
 
def OperatorSet (self, interfaceConditionOperator)
 
def PenaltyFieldCreateFinish (self)
 
def PenaltyFieldCreateStart (self, PenaltyFieldUserNumber, PenaltyField)
 

Public Attributes

 cmiss_type
 

Properties

 operator = property(OperatorGet, OperatorSet, None, )
 
 integrationType = property(IntegrationTypeGet, IntegrationTypeSet, None, )
 
 method = property(MethodGet, MethodSet, None, )
 

Detailed Description

Contains information about an interface condition.

Definition at line 5802 of file iron.py.

Constructor & Destructor Documentation

def iron.InterfaceCondition.__init__ (   self)
Initialise a null cmfe_InterfaceConditionType

Definition at line 5806 of file iron.py.

Member Function Documentation

def iron.InterfaceCondition.CreateFinish (   self)
Finishes the creation of an interface condition identified by an object.

:rtype: None

Definition at line 5811 of file iron.py.

def iron.InterfaceCondition.CreateStart (   self,
  interfaceConditionUserNumber,
  interface,
  geometricField 
)
Starts the creation of an interface condition identified by an object.

:param interfaceConditionUserNumber: The user number of the interface conditon to start the creation of.
:type interfaceConditionUserNumber: int
:param interface: The interface to create the interface on.
:type interface: Interface
:param geometricField: The geometric field for the interface condition.
:type geometricField: Field
:rtype: None

Definition at line 5820 of file iron.py.

def iron.InterfaceCondition.DependentVariableAdd (   self,
  meshIndex,
  equationsSet,
  variableType 
)
Adds a dependent field variable to an interface condition identified by an object.

:param meshIndex: The mesh index of the interface condition interface for which the dependent variable is added.
:type meshIndex: int
:param equationsSet: The equations set containg the dependent variable to add.
:type equationsSet: EquationsSet
:param variableType: The variable type of the dependent variable to add.
:type variableType: int
:rtype: None

Definition at line 5835 of file iron.py.

def iron.InterfaceCondition.Destroy (   self)
Destroys an interface condition identified by an object.

:rtype: None

Definition at line 5850 of file iron.py.

def iron.InterfaceCondition.EquationsCreateFinish (   self)
Finishes the creation of interface equations for an interface condition identified by an object.

:rtype: None

Definition at line 5859 of file iron.py.

def iron.InterfaceCondition.EquationsCreateStart (   self,
  interfaceEquations 
)
Starts the creation of interface equations for an interface condition identified by an object.

:param interfaceEquations: On return, the created interface equations.
:type interfaceEquations: InterfaceEquations
:rtype: None

Definition at line 5868 of file iron.py.

def iron.InterfaceCondition.EquationsDestroy (   self)
Destroys the interface equations for an interface condition identified by an object.

:rtype: None

Definition at line 5879 of file iron.py.

def iron.InterfaceCondition.Finalise (   self)
Finalises a cmfe_InterfaceConditionType object.

:rtype: None

Definition at line 5888 of file iron.py.

def iron.InterfaceCondition.IntegrationTypeGet (   self)
Gets the integration type for an interface condition identified by an object.

:returns: interfaceConditionIntegrationType. The interface condition integration type. Will be a value from the InterfaceConditionIntegrationTypes enum.
:rtype: int

Definition at line 5897 of file iron.py.

def iron.InterfaceCondition.IntegrationTypeSet (   self,
  interfaceConditionIntegrationType 
)
Sets/changes the integration type for an interface condition identified by an object.

:param interfaceConditionIntegrationType: On return, the interface condition integration type. Must be a value from the InterfaceConditionIntegrationTypes enum.
:type interfaceConditionIntegrationType: int
:rtype: None

Definition at line 5907 of file iron.py.

def iron.InterfaceCondition.LagrangeFieldCreateFinish (   self)
Finishes the creation of a Lagrange multiplier field for an interface condition identified by an object.

:rtype: None

Definition at line 5918 of file iron.py.

def iron.InterfaceCondition.LagrangeFieldCreateStart (   self,
  lagrangeFieldUserNumber,
  lagrangeField 
)
Starts the creation of a Lagrange multiplier field for an interface condition identified by an object.

:param lagrangeFieldUserNumber: The user number of the Lagrange field.
:type lagrangeFieldUserNumber: int
:param lagrangeField: If associated on entry, the user created Lagrange field which has the same user number as the specified Lagrange field user number. If not associated on entry, on return, the created Lagrange field for the interface condition.
:type lagrangeField: Field
:rtype: None

Definition at line 5927 of file iron.py.

def iron.InterfaceCondition.MethodGet (   self)
Gets the method for an interface condition identified by an object.

:returns: interfaceConditionMethod. The interface condition method. Will be a value from the InterfaceConditionMethods enum.
:rtype: int

Definition at line 5940 of file iron.py.

def iron.InterfaceCondition.MethodSet (   self,
  interfaceConditionMethod 
)
Sets/changes the method for an interface condition identified by an object.

:param interfaceConditionMethod: The interface condition method to set. Must be a value from the InterfaceConditionMethods enum.
:type interfaceConditionMethod: int
:rtype: None

Definition at line 5950 of file iron.py.

def iron.InterfaceCondition.OperatorGet (   self)
Gets the operator for an interface condition identified by an object.

:returns: interfaceConditionOperator. The interface condition operator. Will be a value from the InterfaceConditionOperator enum.
:rtype: int

Definition at line 5961 of file iron.py.

def iron.InterfaceCondition.OperatorSet (   self,
  interfaceConditionOperator 
)
Sets/changes the operator for an interface condition identified by an object.

:param interfaceConditionOperator: The interface condition operator to set. Must be a value from the InterfaceConditionOperator enum.
:type interfaceConditionOperator: int
:rtype: None

Definition at line 5971 of file iron.py.

def iron.InterfaceCondition.PenaltyFieldCreateFinish (   self)
Finishes the creation of a penalty field for an interface condition identified by an object.

:rtype: None

Definition at line 5982 of file iron.py.

def iron.InterfaceCondition.PenaltyFieldCreateStart (   self,
  PenaltyFieldUserNumber,
  PenaltyField 
)
Starts the creation of a penalty field for an interface condition identified by an object.

:param PenaltyFieldUserNumber: The user number of the penalty field.
:type PenaltyFieldUserNumber: int
:param PenaltyField: If associated on entry, the user created penalty field which has the same user number as the specified penalty field user number. If not associated on entry, on return, the created penalty field for the interface condition.
:type PenaltyField: Field
:rtype: None

Definition at line 5991 of file iron.py.

Member Data Documentation

iron.InterfaceCondition.cmiss_type

Definition at line 5809 of file iron.py.

Property Documentation

iron.InterfaceCondition.integrationType = property(IntegrationTypeGet, IntegrationTypeSet, None, )
static

Definition at line 6006 of file iron.py.

iron.InterfaceCondition.method = property(MethodGet, MethodSet, None, )
static

Definition at line 6008 of file iron.py.

iron.InterfaceCondition.operator = property(OperatorGet, OperatorSet, None, )
static

Definition at line 6004 of file iron.py.