iron.SolverEquations Class Reference

Inheritance diagram for iron.SolverEquations:

Collaboration diagram for iron.SolverEquations:

Public Member Functions
def	__init__ (self)
def	BoundaryConditionsAnalytic (self)
def	BoundaryConditionsCreateFinish (self)
def	BoundaryConditionsCreateStart (self, boundaryConditions)
def	BoundaryConditionsGet (self, boundaryConditions)
def	EquationsSetAdd (self, equationsSet)
def	Finalise (self)
def	InterfaceConditionAdd (self, interfaceCondition)
def	JacobianMatrixGet (self, matrix)
def	MatrixGet (self, matrixIndex, matrix)
def	NumberOfMatricesGet (self)
def	ResidualVectorGet (self, residualVector)
def	RhsVectorGet (self, rhsVector)
def	SparsityTypeSet (self, sparsityType)
def	VectorGet (self, matrixIndex, vector)

Public Attributes
	cmiss_type

Properties
	rhsVector = property(RhsVectorGet, None, None, )
	boundaryConditions = property(BoundaryConditionsGet, None, None, )
	jacobianMatrix = property(JacobianMatrixGet, None, None, )
	numberOfMatrices = property(NumberOfMatricesGet, None, None, )
	residualVector = property(ResidualVectorGet, None, None, )
	sparsityType = property(None, SparsityTypeSet, None, )

Detailed Description

Contains information about the solver equations for a solver.

Definition at line 7490 of file iron.py.

Constructor & Destructor Documentation

def iron.SolverEquations.__init__

(

self

)

Initialise a null cmfe_SolverEquationsType

Definition at line 7494 of file iron.py.

Member Function Documentation

def iron.SolverEquations.BoundaryConditionsAnalytic

(

self

)

Set boundary conditions for solver equations according to the analytic equations.

:rtype: None

Definition at line 7499 of file iron.py.

def iron.SolverEquations.BoundaryConditionsCreateFinish

(

self

)

Finish the creation of the boundary conditions for the solver equations

:rtype: None

Definition at line 7508 of file iron.py.

def iron.SolverEquations.BoundaryConditionsCreateStart	(		self,
			boundaryConditions
	)

Start the creation of the boundary conditions for the solver equations

:param boundaryConditions: On return, the created boundary conditions.
:type boundaryConditions: BoundaryConditions
:rtype: None

Definition at line 7517 of file iron.py.

def iron.SolverEquations.BoundaryConditionsGet	(		self,
			boundaryConditions
	)

Get the boundary conditions for solver equations

:param boundaryConditions: On return, The boundary conditions for the specified solver equations.
:type boundaryConditions: BoundaryConditions
:rtype: None

Definition at line 7528 of file iron.py.

def iron.SolverEquations.EquationsSetAdd	(		self,
			equationsSet
	)

Adds equations sets to solver equations identified by an object.

:param equationsSet: The equations set to add.
:type equationsSet: EquationsSet
:returns: equationsSetIndex. The index of the added equations set in the solver equations.
:rtype: int

Definition at line 7539 of file iron.py.

def iron.SolverEquations.Finalise

(

self

)

Finalises a cmfe_SolverEquationsType object.

:rtype: None

Definition at line 7551 of file iron.py.

def iron.SolverEquations.InterfaceConditionAdd	(		self,
			interfaceCondition
	)

Adds an interface condition to solver equations identified by an object.

:param interfaceCondition: The interface condition to add.
:type interfaceCondition: InterfaceCondition
:returns: interfaceConditionIndex. The index of the added interface condition in the solver equations.
:rtype: int

Definition at line 7560 of file iron.py.

def iron.SolverEquations.JacobianMatrixGet	(		self,
			matrix
	)

Get the Jacobian matrix from the solver equations matrices for nonlinear solver equations

:param matrix: On return, the solver equations Jacobian matrix
:type matrix: DistributedMatrix
:rtype: None

Definition at line 7572 of file iron.py.

def iron.SolverEquations.MatrixGet	(		self,
			matrixIndex,
			matrix
	)

Get a solver matrix from the solver equations matrices

:param matrixIndex: The solver matrix index to get
:type matrixIndex: int
:param matrix: On return, the requested solver matrix
:type matrix: DistributedMatrix
:rtype: None

Definition at line 7583 of file iron.py.

def iron.SolverEquations.NumberOfMatricesGet

(

self

)

Get the number of solver matrices for the solver equations

:returns: numberOfMatrices. The number of matrices for the solver equations
:rtype: int

Definition at line 7596 of file iron.py.

def iron.SolverEquations.ResidualVectorGet	(		self,
			residualVector
	)

Get the residual vector from the solver equations for nonlinear problems

:param residualVector: On return, the solver residual vector
:type residualVector: DistributedVector
:rtype: None

Definition at line 7606 of file iron.py.

def iron.SolverEquations.RhsVectorGet	(		self,
			rhsVector
	)

Get the right hand side vector from the solver equations

:param rhsVector: On return, the solver right hand side vector
:type rhsVector: DistributedVector
:rtype: None

Definition at line 7617 of file iron.py.

def iron.SolverEquations.SparsityTypeSet	(		self,
			sparsityType
	)

Sets/changes the sparsity type for solver equations identified by an object.

:param sparsityType: The sparsity type to set. Must be a value from the SolverEquationsSparsityTypes enum.
:type sparsityType: int
:rtype: None

Definition at line 7628 of file iron.py.

def iron.SolverEquations.VectorGet	(		self,
			matrixIndex,
			vector
	)

Get the vector assiciated with a solver matrix from the solver equations matrices

:param matrixIndex: The solver matrix index to get the vector for
:type matrixIndex: int
:param vector: On return, the requested solver matrix vector
:type vector: DistributedVector
:rtype: None

Definition at line 7639 of file iron.py.

Member Data Documentation

iron.SolverEquations.cmiss_type

Definition at line 7497 of file iron.py.

Property Documentation

iron.SolverEquations.boundaryConditions = property(BoundaryConditionsGet, None, None, )

static

Definition at line 7654 of file iron.py.

iron.SolverEquations.jacobianMatrix = property(JacobianMatrixGet, None, None, )

static

Definition at line 7656 of file iron.py.

iron.SolverEquations.numberOfMatrices = property(NumberOfMatricesGet, None, None, )

static

Definition at line 7658 of file iron.py.

iron.SolverEquations.residualVector = property(ResidualVectorGet, None, None, )

static

Definition at line 7660 of file iron.py.

iron.SolverEquations.rhsVector = property(RhsVectorGet, None, None, )

static

Definition at line 7652 of file iron.py.

iron.SolverEquations.sparsityType = property(None, SparsityTypeSet, None, )

static

Definition at line 7662 of file iron.py.