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

Public Member Functions

def __init__ (self)
 
def CellMLEquationsCreateFinish (self)
 
def CellMLEquationsCreateStart (self)
 
def CellMLEquationsGet (self, controlLoopIdentifiers, solverIndex, CellMLEquations)
 
def ControlLoopCreateFinish (self)
 
def ControlLoopCreateStart (self)
 
def ControlLoopDestroy (self)
 
def ControlLoopGet (self, controlLoopIdentifiers, controlLoop)
 
def CreateFinish (self)
 
def CreateStart (self, problemUserNumber, problemSpecification)
 
def Destroy (self)
 
def Finalise (self)
 
def Solve (self)
 
def SolverEquationsCreateFinish (self)
 
def SolverEquationsCreateStart (self)
 
def SolverEquationsDestroy (self)
 
def SolverEquationsGet (self, controlLoopIdentifiers, solverIndex, solverEquations)
 
def SolverGet (self, controlLoopIdentifiers, solverIndex, solver)
 
def SolversCreateFinish (self)
 
def SolversCreateStart (self)
 
def SolversDestroy (self)
 
def SpecificationGet (self, problemSpecification)
 
def SpecificationSizeGet (self)
 

Public Attributes

 cmiss_type
 

Properties

 specification = property(SpecificationGet, None, None, )
 
 specificationSize = property(SpecificationSizeGet, None, None, )
 

Detailed Description

Contains information for a problem.

Definition at line 7107 of file iron.py.

Constructor & Destructor Documentation

def iron.Problem.__init__ (   self)
Initialise a null cmfe_ProblemType

Definition at line 7111 of file iron.py.

Member Function Documentation

def iron.Problem.CellMLEquationsCreateFinish (   self)
Finishes the creation of CellML equations for problem identified by an object.

:rtype: None

Definition at line 7116 of file iron.py.

def iron.Problem.CellMLEquationsCreateStart (   self)
Starts the creation of CellML equations for problem identified by an object.

:rtype: None

Definition at line 7125 of file iron.py.

def iron.Problem.CellMLEquationsGet (   self,
  controlLoopIdentifiers,
  solverIndex,
  CellMLEquations 
)
Returns the CellML equations from a problem identified by an object.

:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the CellML equations for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to get the CellML equations for.
:type solverIndex: int
:param CellMLEquations: On return, the specified CellML equations.
:type CellMLEquations: CellMLEquations
:rtype: None

Definition at line 7134 of file iron.py.

def iron.Problem.ControlLoopCreateFinish (   self)
Finishes the creation of a control loop on a problem identified by an object.

:rtype: None

Definition at line 7149 of file iron.py.

def iron.Problem.ControlLoopCreateStart (   self)
Starts the creation of a control loop on a problem identified by an object.

:rtype: None

Definition at line 7158 of file iron.py.

def iron.Problem.ControlLoopDestroy (   self)
Destroys the control loops on a problem identified by an object.

:rtype: None

Definition at line 7167 of file iron.py.

def iron.Problem.ControlLoopGet (   self,
  controlLoopIdentifiers,
  controlLoop 
)
Returns a control loop from a problem identified by an object.

:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the control loop for.
:type controlLoopIdentifiers: Array of ints
:param controlLoop: On return, the specified problem control loop.
:type controlLoop: ControlLoop
:rtype: None

Definition at line 7176 of file iron.py.

def iron.Problem.CreateFinish (   self)
Finishes the creation of a problem identified by an object.

:rtype: None

Definition at line 7189 of file iron.py.

def iron.Problem.CreateStart (   self,
  problemUserNumber,
  problemSpecification 
)
Starts the creation of a problem identified by an object.

:param problemUserNumber: The user number of the problem to start the creation of.
:type problemUserNumber: int
:param problemSpecification: The problem specification array, containt the problem class, type etc
:type problemSpecification: Array of ints
:rtype: None

Definition at line 7198 of file iron.py.

def iron.Problem.Destroy (   self)
Destroys a problem identified by an object.

:rtype: None

Definition at line 7211 of file iron.py.

def iron.Problem.Finalise (   self)
Finalises a cmfe_ProblemType object.

:rtype: None

Definition at line 7220 of file iron.py.

def iron.Problem.Solve (   self)
Solves a problem identified by an object.

:rtype: None

Definition at line 7229 of file iron.py.

def iron.Problem.SolverEquationsCreateFinish (   self)
Finishes the creation of solver equations for problem identified by an object.

:rtype: None

Definition at line 7238 of file iron.py.

def iron.Problem.SolverEquationsCreateStart (   self)
Starts the creation of solver equations for problem identified by an object.

:rtype: None

Definition at line 7247 of file iron.py.

def iron.Problem.SolverEquationsDestroy (   self)
Destroys the solver equations for problem identified by an object.

:rtype: None

Definition at line 7256 of file iron.py.

def iron.Problem.SolverEquationsGet (   self,
  controlLoopIdentifiers,
  solverIndex,
  solverEquations 
)
Returns the solver equations from a problem identified by an object.

:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the solver equations for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to get the solver equations for.
:type solverIndex: int
:param solverEquations: On return, the specified solver equations.
:type solverEquations: SolverEquations
:rtype: None

Definition at line 7265 of file iron.py.

def iron.Problem.SolverGet (   self,
  controlLoopIdentifiers,
  solverIndex,
  solver 
)
Returns a solver from a problem identified by an object.

:param controlLoopIdentifiers: controlLoopIdentifiers(i). The i'th control loop identifier to get the solver for.
:type controlLoopIdentifiers: Array of ints
:param solverIndex: The solver index to get the solver for.
:type solverIndex: int
:param solver: On return, the specified solver.
:type solver: Solver
:rtype: None

Definition at line 7280 of file iron.py.

def iron.Problem.SolversCreateFinish (   self)
Finishes the creation of solvers for problem identified by an object.

:rtype: None

Definition at line 7295 of file iron.py.

def iron.Problem.SolversCreateStart (   self)
Starts the creation of solvers for problem identified by an object.

:rtype: None

Definition at line 7304 of file iron.py.

def iron.Problem.SolversDestroy (   self)
Destroys the solvers for problem identified by an object.

:rtype: None

Definition at line 7313 of file iron.py.

def iron.Problem.SpecificationGet (   self,
  problemSpecification 
)
Returns the specification array for a problem identified by an object.

:param problemSpecification: On return, the problem specification array. Must be allocated and large enough to contain the specification on entry.
:type problemSpecification: Array of ints
:rtype: None

Definition at line 7322 of file iron.py.

def iron.Problem.SpecificationSizeGet (   self)
Returns the size of the specification array for a problem identified by an object.

:returns: specificationSize. The size of the problem specification array.
:rtype: int

Definition at line 7333 of file iron.py.

Member Data Documentation

iron.Problem.cmiss_type

Definition at line 7114 of file iron.py.

Property Documentation

iron.Problem.specification = property(SpecificationGet, None, None, )
static

Definition at line 7343 of file iron.py.

iron.Problem.specificationSize = property(SpecificationSizeGet, None, None, )
static

Definition at line 7345 of file iron.py.