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

Public Member Functions

def __init__ (self)
 
def CellMLEquationsGet (self, CellMLEquations)
 
def DAEEulerSolverTypeGet (self)
 
def DAEEulerSolverTypeSet (self, DAEEulerSolverType)
 
def DAESolverTypeGet (self)
 
def DAESolverTypeSet (self, DAESolverType)
 
def DAETimeStepSet (self, timeStep)
 
def DAETimesSet (self, startTime, endTime)
 
def DynamicDegreeGet (self)
 
def DynamicDegreeSet (self, degree)
 
def DynamicLinearSolverGet (self, linearSolver)
 
def DynamicLinearityTypeGet (self)
 
def DynamicNonlinearSolverGet (self, nonlinearSolver)
 
def DynamicSchemeSet (self, scheme)
 
def DynamicThetaSet (self, thetas)
 
def DynamicTimesSet (self, currentTime, timeIncrement)
 
def Finalise (self)
 
def GeometricTransformationArbitraryPathSet (self, arbitraryPath)
 
def GeometricTransformationClear (self)
 
def GeometricTransformationFieldSet (self, field, variableType)
 
def GeometricTransformationMatrixSet (self, matrix, loadIncrementIdx)
 
def GeometricTransformationNoLoadIncrementsSet (self, numberOfIncrements)
 
def GeometricTransformationRotationSet (self, pivotPoint, axis, angle, loadIncrementIdx)
 
def GeometricTransformationScalingsSet (self, scalings)
 
def GeometricTransformationTranslationSet (self, translation, loadIncrementIdx)
 
def LabelGet (self)
 
def LabelSet (self, label)
 
def LibraryTypeGet (self)
 
def LibraryTypeSet (self, libraryType)
 
def LinearDirectTypeSet (self, directSolverType)
 
def LinearIterativeAbsoluteToleranceSet (self, absoluteTolerance)
 
def LinearIterativeDivergenceToleranceSet (self, divergenceTolerance)
 
def LinearIterativeGMRESRestartSet (self, GMRESRestart)
 
def LinearIterativeMaximumIterationsSet (self, maximumIterations)
 
def LinearIterativePreconditionerTypeSet (self, preconditionerType)
 
def LinearIterativeRelativeToleranceSet (self, relativeTolerance)
 
def LinearIterativeTypeSet (self, iterativeSolverType)
 
def LinearTypeSet (self, linearSolverType)
 
def MumpsSetCntl (self, icntl, val)
 
def MumpsSetIcntl (self, icntl, ivalue)
 
def NewtonAbsoluteToleranceSet (self, absoluteTolerance)
 
def NewtonCellMLSolverGet (self, CellMLSolver)
 
def NewtonConvergenceTestTypeSet (self, convergenceTestType)
 
def NewtonJacobianCalculationTypeSet (self, jacobianCalculationType)
 
def NewtonLineSearchAlphaSet (self, alpha)
 
def NewtonLineSearchMaxStepSet (self, maxStep)
 
def NewtonLineSearchMonitorOutputSet (self, monitorLinesearchFlag)
 
def NewtonLineSearchStepTolSet (self, stepTol)
 
def NewtonLineSearchTypeSet (self, lineSearchType)
 
def NewtonLinearSolverGet (self, linearSolver)
 
def NewtonMaximumFunctionEvaluationsSet (self, maximumFunctionEvaluations)
 
def NewtonMaximumIterationsSet (self, maximumIterations)
 
def NewtonRelativeToleranceSet (self, relativeTolerance)
 
def NewtonSolutionToleranceSet (self, solutionTolerance)
 
def NewtonTrustRegionDelta0Set (self, delta0)
 
def NewtonTrustRegionToleranceSet (self, tolerance)
 
def NewtonTypeSet (self, newtonSolveType)
 
def NonlinearTypeSet (self, nonlinearSolveType)
 
def OutputTypeSet (self, outputType)
 
def QuasiNewtonAbsoluteToleranceSet (self, absoluteTolerance)
 
def QuasiNewtonCellMLSolverGet (self, CellMLSolver)
 
def QuasiNewtonConvergenceTestTypeSet (self, convergenceTestType)
 
def QuasiNewtonJacobianCalculationTypeSet (self, jacobianCalculationType)
 
def QuasiNewtonLineSearchMaxStepSet (self, maxStep)
 
def QuasiNewtonLineSearchMonitorOutputSet (self, monitorLinesearchFlag)
 
def QuasiNewtonLineSearchStepTolSet (self, stepTol)
 
def QuasiNewtonLineSearchTypeSet (self, lineSearchType)
 
def QuasiNewtonLinearSolverGet (self, linearSolver)
 
def QuasiNewtonMaximumFunctionEvaluationsSet (self, maximumFunctionEvaluations)
 
def QuasiNewtonMaximumIterationsSet (self, maximumIterations)
 
def QuasiNewtonRelativeToleranceSet (self, relativeTolerance)
 
def QuasiNewtonRestartSet (self, quasiNewtonRestart)
 
def QuasiNewtonRestartTypeSet (self, quasiNewtonRestartType)
 
def QuasiNewtonScaleTypeSet (self, quasiNewtonScaleType)
 
def QuasiNewtonSolutionToleranceSet (self, solutionTolerance)
 
def QuasiNewtonSolveTypeSet (self, quasiNewtonSolveType)
 
def QuasiNewtonTrustRegionDelta0Set (self, delta0)
 
def QuasiNewtonTrustRegionToleranceSet (self, tolerance)
 
def QuasiNewtonTypeSet (self, quasiNewtonType)
 
def SolverEquationsGet (self, solverEquations)
 

Public Attributes

 cmiss_type
 

Properties

 newtonConvergenceTestType = property(None, NewtonConvergenceTestTypeSet, None, )
 
 geometricTransformationArbitraryPath = property(None, GeometricTransformationArbitraryPathSet, None, )
 
 newtonTrustRegionDelta0 = property(None, NewtonTrustRegionDelta0Set, None, )
 
 newtonRelativeTolerance = property(None, NewtonRelativeToleranceSet, None, )
 
 quasiNewtonType = property(None, QuasiNewtonTypeSet, None, )
 
 quasiNewtonSolutionTolerance = property(None, QuasiNewtonSolutionToleranceSet, None, )
 
 label = property(LabelGet, LabelSet, None, )
 
 quasiNewtonRestartType = property(None, QuasiNewtonRestartTypeSet, None, )
 
 quasiNewtonAbsoluteTolerance = property(None, QuasiNewtonAbsoluteToleranceSet, None, )
 
 quasiNewtonLinearSolver = property(QuasiNewtonLinearSolverGet, None, None, )
 
 geometricTransformationNoLoadIncrements = property(None, GeometricTransformationNoLoadIncrementsSet, None, )
 
 newtonLineSearchStepTol = property(None, NewtonLineSearchStepTolSet, None, )
 
 newtonJacobianCalculationType = property(None, NewtonJacobianCalculationTypeSet, None, )
 
 linearIterativeDivergenceTolerance = property(None, LinearIterativeDivergenceToleranceSet, None, )
 
 newtonLineSearchMaxStep = property(None, NewtonLineSearchMaxStepSet, None, )
 
 quasiNewtonRelativeTolerance = property(None, QuasiNewtonRelativeToleranceSet, None, )
 
 dynamicLinearityType = property(DynamicLinearityTypeGet, None, None, )
 
 newtonMaximumFunctionEvaluations = property(None, NewtonMaximumFunctionEvaluationsSet, None, )
 
 quasiNewtonConvergenceTestType = property(None, QuasiNewtonConvergenceTestTypeSet, None, )
 
 linearType = property(None, LinearTypeSet, None, )
 
 dAETimeStep = property(None, DAETimeStepSet, None, )
 
 geometricTransformationScalings = property(None, GeometricTransformationScalingsSet, None, )
 
 libraryType = property(LibraryTypeGet, LibraryTypeSet, None, )
 
 outputType = property(None, OutputTypeSet, None, )
 
 linearIterativePreconditionerType = property(None, LinearIterativePreconditionerTypeSet, None, )
 
 quasiNewtonCellMLSolver = property(QuasiNewtonCellMLSolverGet, None, None, )
 
 dynamicLinearSolver = property(DynamicLinearSolverGet, None, None, )
 
 newtonLinearSolver = property(NewtonLinearSolverGet, None, None, )
 
 linearIterativeRelativeTolerance = property(None, LinearIterativeRelativeToleranceSet, None, )
 
 quasiNewtonLineSearchMonitorOutput = property(None, QuasiNewtonLineSearchMonitorOutputSet, None, )
 
 quasiNewtonLineSearchMaxStep = property(None, QuasiNewtonLineSearchMaxStepSet, None, )
 
 newtonMaximumIterations = property(None, NewtonMaximumIterationsSet, None, )
 
 newtonCellMLSolver = property(NewtonCellMLSolverGet, None, None, )
 
 dynamicDegree = property(DynamicDegreeGet, DynamicDegreeSet, None, )
 
 quasiNewtonTrustRegionDelta0 = property(None, QuasiNewtonTrustRegionDelta0Set, None, )
 
 linearIterativeType = property(None, LinearIterativeTypeSet, None, )
 
 newtonLineSearchMonitorOutput = property(None, NewtonLineSearchMonitorOutputSet, None, )
 
 quasiNewtonJacobianCalculationType = property(None, QuasiNewtonJacobianCalculationTypeSet, None, )
 
 quasiNewtonSolveType = property(None, QuasiNewtonSolveTypeSet, None, )
 
 quasiNewtonTrustRegionTolerance = property(None, QuasiNewtonTrustRegionToleranceSet, None, )
 
 dynamicScheme = property(None, DynamicSchemeSet, None, )
 
 newtonLineSearchAlpha = property(None, NewtonLineSearchAlphaSet, None, )
 
 dynamicTheta = property(None, DynamicThetaSet, None, )
 
 newtonSolutionTolerance = property(None, NewtonSolutionToleranceSet, None, )
 
 linearIterativeAbsoluteTolerance = property(None, LinearIterativeAbsoluteToleranceSet, None, )
 
 cellMLEquations = property(CellMLEquationsGet, None, None, )
 
 dAEEulerSolverType = property(DAEEulerSolverTypeGet, DAEEulerSolverTypeSet, None, )
 
 dAESolverType = property(DAESolverTypeGet, DAESolverTypeSet, None, )
 
 newtonAbsoluteTolerance = property(None, NewtonAbsoluteToleranceSet, None, )
 
 dynamicNonlinearSolver = property(DynamicNonlinearSolverGet, None, None, )
 
 quasiNewtonMaximumIterations = property(None, QuasiNewtonMaximumIterationsSet, None, )
 
 nonlinearType = property(None, NonlinearTypeSet, None, )
 
 quasiNewtonScaleType = property(None, QuasiNewtonScaleTypeSet, None, )
 
 linearIterativeMaximumIterations = property(None, LinearIterativeMaximumIterationsSet, None, )
 
 quasiNewtonLineSearchStepTol = property(None, QuasiNewtonLineSearchStepTolSet, None, )
 
 quasiNewtonRestart = property(None, QuasiNewtonRestartSet, None, )
 
 solverEquations = property(SolverEquationsGet, None, None, )
 
 linearDirectType = property(None, LinearDirectTypeSet, None, )
 
 linearIterativeGMRESRestart = property(None, LinearIterativeGMRESRestartSet, None, )
 
 quasiNewtonMaximumFunctionEvaluations = property(None, QuasiNewtonMaximumFunctionEvaluationsSet, None, )
 
 newtonTrustRegionTolerance = property(None, NewtonTrustRegionToleranceSet, None, )
 
 newtonLineSearchType = property(None, NewtonLineSearchTypeSet, None, )
 
 quasiNewtonLineSearchType = property(None, QuasiNewtonLineSearchTypeSet, None, )
 
 newtonType = property(None, NewtonTypeSet, None, )
 

Detailed Description

Contains information about a solver.

Definition at line 7665 of file iron.py.

Constructor & Destructor Documentation

def iron.Solver.__init__ (   self)
Initialise a null cmfe_SolverType

Definition at line 7669 of file iron.py.

Member Function Documentation

def iron.Solver.CellMLEquationsGet (   self,
  CellMLEquations 
)
Returns the CellML equations for a solver identified by an object.

:param CellMLEquations: On return, the CellML equations for the solver.
:type CellMLEquations: CellMLEquations
:rtype: None

Definition at line 7674 of file iron.py.

def iron.Solver.DAEEulerSolverTypeGet (   self)
Returns the solve type for an Euler differential-algebraic equation solver identified by an object.

:returns: DAEEulerSolverType. The DAE Euler solver type. Will be a value from the EulerDAESolverTypes enum.
:rtype: int

Definition at line 7685 of file iron.py.

def iron.Solver.DAEEulerSolverTypeSet (   self,
  DAEEulerSolverType 
)
Sets/changes the solve type for an Euler differential-algebraic equation solver identified by an object.

:param DAEEulerSolverType: The DAE Euler solver type to set. Must be a value from the EulerDAESolverTypes enum.
:type DAEEulerSolverType: int
:rtype: None

Definition at line 7695 of file iron.py.

def iron.Solver.DAESolverTypeGet (   self)
Returns the solve type for an differential-algebraic equation solver identified by an object.

:returns: DAESolverType. The DAE solver type. Will be a value from the DAESolverTypes enum.
:rtype: int

Definition at line 7706 of file iron.py.

def iron.Solver.DAESolverTypeSet (   self,
  DAESolverType 
)
Sets/changes the solve type for an differential-algebraic equation solver identified by an object.

:param DAESolverType: The DAE solver type to set. Must be a value from the DAESolverTypes enum.
:type DAESolverType: int
:rtype: None

Definition at line 7716 of file iron.py.

def iron.Solver.DAETimesSet (   self,
  startTime,
  endTime 
)
Sets/changes the times for an differential-algebraic equation solver identified by an object.

:param startTime: The start time for the differential-algebraic solver.
:type startTime: float
:param endTime: The end time for the differential-algebraic solver.
:type endTime: float
:rtype: None

Definition at line 7738 of file iron.py.

def iron.Solver.DAETimeStepSet (   self,
  timeStep 
)
Sets/changes the (initial) time step for an differential-algebraic equation solver identified by an object.

:param timeStep: The (initial) time step for the differential-algebraic solver.
:type timeStep: float
:rtype: None

Definition at line 7727 of file iron.py.

def iron.Solver.DynamicDegreeGet (   self)
Returns the degree of the polynomial used to interpolate time for a dynamic solver identified by an object.

:returns: degree. The dynamic degree. Will be a value from the DynamicDegreeTypes enum.
:rtype: int

Definition at line 7751 of file iron.py.

def iron.Solver.DynamicDegreeSet (   self,
  degree 
)
Sets/changes the degree of the polynomial used to interpolate time for a dynamic solver identified by an object.

:param degree: The dynamic degree to set. Must be a value from the DynamicDegreeTypes enum.
:type degree: int
:rtype: None

Definition at line 7761 of file iron.py.

def iron.Solver.DynamicLinearityTypeGet (   self)
Returns the linearity type for a dynamic solver identified by an object.

:returns: linearityType. The dynamic linearity type. Will be a value from the DynamicLinearityTypes enum.
:rtype: int

Definition at line 7783 of file iron.py.

def iron.Solver.DynamicLinearSolverGet (   self,
  linearSolver 
)
Returns the linear solver associated with a linear dynamic solver identified by an object.

:param linearSolver: On return, the dynamic linear solver.
:type linearSolver: Solver
:rtype: None

Definition at line 7772 of file iron.py.

def iron.Solver.DynamicNonlinearSolverGet (   self,
  nonlinearSolver 
)
Returns the nonlinear solver associated with a nonlinear dynamic solver identified by an object.

:param nonlinearSolver: On return, the dynamic nonlinear solver.
:type nonlinearSolver: Solver
:rtype: None

Definition at line 7793 of file iron.py.

def iron.Solver.DynamicSchemeSet (   self,
  scheme 
)
Sets/changes the scheme for a dynamic solver identified by an object.

:param scheme: The dynamic scheme to set. Must be a value from the DynamicSchemeTypes enum.
:type scheme: int
:rtype: None

Definition at line 7804 of file iron.py.

def iron.Solver.DynamicThetaSet (   self,
  thetas 
)
Sets/changes the theta for a dynamic solver identified by an object.

:param thetas: thetas(i). The i'th dynamic theta to set.
:type thetas: Array of floats
:rtype: None

Definition at line 7815 of file iron.py.

def iron.Solver.DynamicTimesSet (   self,
  currentTime,
  timeIncrement 
)
Sets/changes the times for a dynamic solver identified by an object.

:param currentTime: The current time to set.
:type currentTime: float
:param timeIncrement: The time increment to set.
:type timeIncrement: float
:rtype: None

Definition at line 7826 of file iron.py.

def iron.Solver.Finalise (   self)
Finalises a cmfe_SolverType object.

:rtype: None

Definition at line 7839 of file iron.py.

def iron.Solver.GeometricTransformationArbitraryPathSet (   self,
  arbitraryPath 
)
Sets the arbitrary path logical for a geometric transformation solver identified by an object.

:param arbitraryPath: .TRUE. if the the transformation has an arbitrary path, .FALSE. if the path is uni-directional
:type arbitraryPath: bool
:rtype: None

Definition at line 7848 of file iron.py.

def iron.Solver.GeometricTransformationClear (   self)
Clear transformation for a geometric transformation solver identified by an object.

:rtype: None

Definition at line 7859 of file iron.py.

def iron.Solver.GeometricTransformationFieldSet (   self,
  field,
  variableType 
)
Sets the field for a geometric transformation solver identified by an object.

:param field: The field for the solver to set.
:type field: Field
:param variableType: The field variable type to set the transformation for
:type variableType: int
:rtype: None

Definition at line 7868 of file iron.py.

def iron.Solver.GeometricTransformationMatrixSet (   self,
  matrix,
  loadIncrementIdx 
)
Sets the full transformation matrix vector at a specific load increment for a geometric transformation solver identified by an object.

:param matrix: The full transformation matrix to set
:type matrix: 2d array of floats
:param loadIncrementIdx: The load increment index to set the matrix for.
:type loadIncrementIdx: int
:rtype: None

Definition at line 7881 of file iron.py.

def iron.Solver.GeometricTransformationNoLoadIncrementsSet (   self,
  numberOfIncrements 
)
Sets the arbitrary path logical for a geometric transformation solver identified by an object.

:param numberOfIncrements: The number of load increments to apply the transformation
:type numberOfIncrements: int
:rtype: None

Definition at line 7894 of file iron.py.

def iron.Solver.GeometricTransformationRotationSet (   self,
  pivotPoint,
  axis,
  angle,
  loadIncrementIdx 
)
Sets the rotation at a specific load increment for a geometric transformation solver identified by an object.

:param pivotPoint: The pivot point to rotate about
:type pivotPoint: Array of floats
:param axis: The axis to  to rotate around
:type axis: Array of floats
:param angle: The angle to rotate
:type angle: float
:param loadIncrementIdx: The load increment index to set the rotation for.
:type loadIncrementIdx: int
:rtype: None

Definition at line 7905 of file iron.py.

def iron.Solver.GeometricTransformationScalingsSet (   self,
  scalings 
)
Sets the scalings for a geometric transformation solver identified by an object.

:param scalings: The scalings to set
:type scalings: Array of floats
:rtype: None

Definition at line 7922 of file iron.py.

def iron.Solver.GeometricTransformationTranslationSet (   self,
  translation,
  loadIncrementIdx 
)
Sets the translation vector at a specific load increment for a geometric transformation solver identified by an object.

:param translation: The translation components to set
:type translation: Array of floats
:param loadIncrementIdx: The load increment index to set the translation for.
:type loadIncrementIdx: int
:rtype: None

Definition at line 7933 of file iron.py.

def iron.Solver.LabelGet (   self)
Returns the character string label for a solver identified by an object.

:returns: label. The solver label.
:rtype: string

Definition at line 7946 of file iron.py.

def iron.Solver.LabelSet (   self,
  label 
)
Sets/changes the character string label for a solver identified by an object.

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

Definition at line 7956 of file iron.py.

def iron.Solver.LibraryTypeGet (   self)
Returns the library type for a solver identified by an object.

:returns: libraryType. The library type for the solver. Will be a value from the SolverLibraries enum.
:rtype: int

Definition at line 7967 of file iron.py.

def iron.Solver.LibraryTypeSet (   self,
  libraryType 
)
Sets/changes the library type for a solver identified by an object.

:param libraryType: The library type for the solver to set. Must be a value from the SolverLibraries enum.
:type libraryType: int
:rtype: None

Definition at line 7977 of file iron.py.

def iron.Solver.LinearDirectTypeSet (   self,
  directSolverType 
)
Sets/changes the type of direct linear solver for a solver identified by an object.

:param directSolverType: The type of the direct linear solver to set. Must be a value from the DirectLinearSolverTypes enum.
:type directSolverType: int
:rtype: None

Definition at line 7988 of file iron.py.

def iron.Solver.LinearIterativeAbsoluteToleranceSet (   self,
  absoluteTolerance 
)
Sets/changes the maximum absolute tolerance for an iterative linear solver identified by an object.

:param absoluteTolerance: The absolute tolerance for the iterative linear solver to set.
:type absoluteTolerance: float
:rtype: None

Definition at line 7999 of file iron.py.

def iron.Solver.LinearIterativeDivergenceToleranceSet (   self,
  divergenceTolerance 
)
Sets/changes the maximum divergence tolerance for an iterative linear solver identified by an object.

:param divergenceTolerance: The divergence tolerance for the iterative linear solver to set.
:type divergenceTolerance: float
:rtype: None

Definition at line 8010 of file iron.py.

def iron.Solver.LinearIterativeGMRESRestartSet (   self,
  GMRESRestart 
)
Sets/changes the GMRES restart value for a GMRES iterative linear solver identified by an object.

:param GMRESRestart: The GMRES restart value to set.
:type GMRESRestart: int
:rtype: None

Definition at line 8021 of file iron.py.

def iron.Solver.LinearIterativeMaximumIterationsSet (   self,
  maximumIterations 
)
Sets/changes the maximum number of iterations for an iterative linear solver identified by an object.

:param maximumIterations: The maximum iterations to set.
:type maximumIterations: int
:rtype: None

Definition at line 8032 of file iron.py.

def iron.Solver.LinearIterativePreconditionerTypeSet (   self,
  preconditionerType 
)
Sets/changes the preconditioner type for an iterative linear solver identified by an object.

:param preconditionerType: The preconditioner type to set. Must be a value from the IterativePreconditionerTypes enum.
:type preconditionerType: int
:rtype: None

Definition at line 8043 of file iron.py.

def iron.Solver.LinearIterativeRelativeToleranceSet (   self,
  relativeTolerance 
)
Sets/changes the maximum relative tolerance for an iterative linear solver identified by an object.

:param relativeTolerance: The relative tolerance for the iterative linear solver to set.
:type relativeTolerance: float
:rtype: None

Definition at line 8054 of file iron.py.

def iron.Solver.LinearIterativeTypeSet (   self,
  iterativeSolverType 
)
Sets/changes the type for an iterative linear solver identified by an object.

:param iterativeSolverType: The iterative solver type to set. Must be a value from the IterativeLinearSolverTypes enum.
:type iterativeSolverType: int
:rtype: None

Definition at line 8065 of file iron.py.

def iron.Solver.LinearTypeSet (   self,
  linearSolverType 
)
Sets/changes the type for a linear solver identified by an object.

:param linearSolverType: The linear solver type to set. Must be a value from the LinearSolverTypes enum.
:type linearSolverType: int
:rtype: None

Definition at line 8076 of file iron.py.

def iron.Solver.MumpsSetCntl (   self,
  icntl,
  val 
)
Sets/changes the MUMPS CNTL(icntl)=val real/complex control parameters through the PETSc-MUMPS interface. Must be called after the boundary conditions have been set up.

:param icntl: The MUMPS CNTL integer control parameter
:type icntl: int
:param val: The MUMPS CNTL real value to set: CNTL(icntl)=val
:type val: float
:rtype: None

Definition at line 8087 of file iron.py.

def iron.Solver.MumpsSetIcntl (   self,
  icntl,
  ivalue 
)
Sets/changes the MUMPS ICNTL(icntl)=ivalue integer control parameters through the PETSc-MUMPS interface. Must be called after the boundary conditions have been set up.

:param icntl: The MUMPS ICNTL integer control parameter
:type icntl: int
:param ivalue: The MUMPS ICNTL integer value to set: ICNTL(icntl)=ivalue
:type ivalue: int
:rtype: None

Definition at line 8100 of file iron.py.

def iron.Solver.NewtonAbsoluteToleranceSet (   self,
  absoluteTolerance 
)
Sets/changes the absolute tolerance for a Newton solver identified by an object.

:param absoluteTolerance: The absolute tolerance for the Newton solver to set.
:type absoluteTolerance: float
:rtype: None

Definition at line 8113 of file iron.py.

def iron.Solver.NewtonCellMLSolverGet (   self,
  CellMLSolver 
)
Returns the CellML solver associated with a Newton solver identified by an object.

:param CellMLSolver: On return, the Newton CellML solver.
:type CellMLSolver: Solver
:rtype: None

Definition at line 8124 of file iron.py.

def iron.Solver.NewtonConvergenceTestTypeSet (   self,
  convergenceTestType 
)
Sets/changes the convergence test type for a Newton solver identified by an object.

:param convergenceTestType: The convergence test type for the Newton solver to set.
:type convergenceTestType: int
:rtype: None

Definition at line 8135 of file iron.py.

def iron.Solver.NewtonJacobianCalculationTypeSet (   self,
  jacobianCalculationType 
)
Sets/changes the Jacobian calculation type for a Newton solver identified by an object.

:param jacobianCalculationType: The Jacobian calculation type for the Newton solver to set. Must be a value from the JacobianCalculationTypes enum.
:type jacobianCalculationType: int
:rtype: None

Definition at line 8146 of file iron.py.

def iron.Solver.NewtonLinearSolverGet (   self,
  linearSolver 
)
Returns the linear solver associated with a Newton solver identified by an object.

:param linearSolver: On return, the Newton linear solver.
:type linearSolver: Solver
:rtype: None

Definition at line 8212 of file iron.py.

def iron.Solver.NewtonLineSearchAlphaSet (   self,
  alpha 
)
Sets/changes the line search alpha for a Newton line search solver identified by an object.

:param alpha: The alpha for the Newton line search solver to set.
:type alpha: float
:rtype: None

Definition at line 8157 of file iron.py.

def iron.Solver.NewtonLineSearchMaxStepSet (   self,
  maxStep 
)
Sets/changes the line search maximum step for a Newton line search solver identified by an object.

:param maxStep: The maximum step for the Newton line search solver to set.
:type maxStep: float
:rtype: None

Definition at line 8168 of file iron.py.

def iron.Solver.NewtonLineSearchMonitorOutputSet (   self,
  monitorLinesearchFlag 
)
Enables/disables output monitoring for a nonlinear Newton line search solver identified by an object.

:param monitorLinesearchFlag: Flag to determine whether to enable/disable linsearch monitor output.
:type monitorLinesearchFlag: bool
:rtype: None

Definition at line 8179 of file iron.py.

def iron.Solver.NewtonLineSearchStepTolSet (   self,
  stepTol 
)
Sets/changes the line search step tolerance for a Newton line search solver identified by an object.

:param stepTol: The step tolerance for the Newton line search solver to set.
:type stepTol: float
:rtype: None

Definition at line 8190 of file iron.py.

def iron.Solver.NewtonLineSearchTypeSet (   self,
  lineSearchType 
)
Sets/changes the type of line search for a Newton line search solver identified by an object.

:param lineSearchType: The type of line search for the Newton line search solver to set. Must be a value from the NewtonLineSearchTypes enum.
:type lineSearchType: int
:rtype: None

Definition at line 8201 of file iron.py.

def iron.Solver.NewtonMaximumFunctionEvaluationsSet (   self,
  maximumFunctionEvaluations 
)
Sets/changes the maximum number of function evaluations for a Newton solver identified by an object.

:param maximumFunctionEvaluations: The maximum number of function evaluations for the Newton solver to set.
:type maximumFunctionEvaluations: int
:rtype: None

Definition at line 8223 of file iron.py.

def iron.Solver.NewtonMaximumIterationsSet (   self,
  maximumIterations 
)
Sets/changes the maximum number of iterations for a Newton solver identified by an object.

:param maximumIterations: The maximum number of iterations for the Newton solver to set.
:type maximumIterations: int
:rtype: None

Definition at line 8234 of file iron.py.

def iron.Solver.NewtonRelativeToleranceSet (   self,
  relativeTolerance 
)
Sets/changes the relative tolerance for a Newton solver identified by an object.

:param relativeTolerance: The relative tolerance for the Newton solver to set.
:type relativeTolerance: float
:rtype: None

Definition at line 8245 of file iron.py.

def iron.Solver.NewtonSolutionToleranceSet (   self,
  solutionTolerance 
)
Sets/changes the solution tolerance for a Newton solver identified by an object.

:param solutionTolerance: The solution tolerance for the Newton solver to set.
:type solutionTolerance: float
:rtype: None

Definition at line 8256 of file iron.py.

def iron.Solver.NewtonTrustRegionDelta0Set (   self,
  delta0 
)
Sets/changes the delta0 for a Newton trust region solver identified by an object.

:param delta0: The delta0 for the Newton trust region solver to set.
:type delta0: float
:rtype: None

Definition at line 8267 of file iron.py.

def iron.Solver.NewtonTrustRegionToleranceSet (   self,
  tolerance 
)
Sets/changes the tolerance for a Newton trust region solver identified by an object.

:param tolerance: The tolerance for the Newton trust region solver to set.
:type tolerance: float
:rtype: None

Definition at line 8278 of file iron.py.

def iron.Solver.NewtonTypeSet (   self,
  newtonSolveType 
)
Sets/changes the type of a Newton solver identified by an object.

:param newtonSolveType: The type of the Newton solver to set. Must be a value from the NewtonSolverTypes enum.
:type newtonSolveType: int
:rtype: None

Definition at line 8289 of file iron.py.

def iron.Solver.NonlinearTypeSet (   self,
  nonlinearSolveType 
)
Sets/changes the type of a nonlinear solver identified by an object.

:param nonlinearSolveType: The type of the nonlinear solver to set. Must be a value from the NonlinearSolverTypes enum.
:type nonlinearSolveType: int
:rtype: None

Definition at line 8300 of file iron.py.

def iron.Solver.OutputTypeSet (   self,
  outputType 
)
Sets/changes the output type for a solver identified by an object.

:param outputType: The type of solver output to set. Must be a value from the SolverOutputTypes enum.
:type outputType: int
:rtype: None

Definition at line 8311 of file iron.py.

def iron.Solver.QuasiNewtonAbsoluteToleranceSet (   self,
  absoluteTolerance 
)
Sets/changes the absolute tolerance for a Quasi-Newton solver identified by an object.

:param absoluteTolerance: The absolute tolerance for the Quasi-Newton solver to set.
:type absoluteTolerance: float
:rtype: None

Definition at line 8322 of file iron.py.

def iron.Solver.QuasiNewtonCellMLSolverGet (   self,
  CellMLSolver 
)
Returns the CellML solver associated with a Quasi-Newton solver identified by an object.

:param CellMLSolver: On return, the Quasi-Newton CellML solver.
:type CellMLSolver: Solver
:rtype: None

Definition at line 8333 of file iron.py.

def iron.Solver.QuasiNewtonConvergenceTestTypeSet (   self,
  convergenceTestType 
)
Sets/changes the convergence test type for a Quasi-Newton solver identified by an object.

:param convergenceTestType: The convergence test type for the Quasi-Newton solver to set.
:type convergenceTestType: int
:rtype: None

Definition at line 8344 of file iron.py.

def iron.Solver.QuasiNewtonJacobianCalculationTypeSet (   self,
  jacobianCalculationType 
)
Sets/changes the Jacobian calculation type for a Quasi-Newton solver identified by an object.

:param jacobianCalculationType: The Jacobian calculation type for the Quasi-Newton solver to set. Must be a value from the JacobianCalculationTypes enum.
:type jacobianCalculationType: int
:rtype: None

Definition at line 8355 of file iron.py.

def iron.Solver.QuasiNewtonLinearSolverGet (   self,
  linearSolver 
)
Returns the linear solver associated with a Quasi-Newton solver identified by an object.

:param linearSolver: On return, the Quasi-Newton linear solver.
:type linearSolver: Solver
:rtype: None

Definition at line 8410 of file iron.py.

def iron.Solver.QuasiNewtonLineSearchMaxStepSet (   self,
  maxStep 
)
Sets/changes the line search maximum step for a Quasi-Newton line search solver identified by an object.

:param maxStep: The maximum step for the Quasi-Newton line search solver to set.
:type maxStep: float
:rtype: None

Definition at line 8366 of file iron.py.

def iron.Solver.QuasiNewtonLineSearchMonitorOutputSet (   self,
  monitorLinesearchFlag 
)
Enables/disables output monitoring for a nonlinear Quasi-Newton line search solver identified by an object.

:param monitorLinesearchFlag: Flag to determine whether to enable/disable linsearch monitor output.
:type monitorLinesearchFlag: bool
:rtype: None

Definition at line 8377 of file iron.py.

def iron.Solver.QuasiNewtonLineSearchStepTolSet (   self,
  stepTol 
)
Sets/changes the line search step tolerance for a Quasi-Newton line search solver identified by an object.

:param stepTol: The step tolerance for the Quasi-Newton line search solver to set.
:type stepTol: float
:rtype: None

Definition at line 8388 of file iron.py.

def iron.Solver.QuasiNewtonLineSearchTypeSet (   self,
  lineSearchType 
)
Sets/changes the type of line search for a Quasi-Newton line search solver identified by an object.

:param lineSearchType: The type of line search for the Quasi-Newton line search solver to set. Must be a value from the QuasiNewtonLineSearchTypes enum.
:type lineSearchType: int
:rtype: None

Definition at line 8399 of file iron.py.

def iron.Solver.QuasiNewtonMaximumFunctionEvaluationsSet (   self,
  maximumFunctionEvaluations 
)
Sets/changes the maximum number of function evaluations for a Quasi-Newton solver identified by an object.

:param maximumFunctionEvaluations: The maximum number of function evaluations for the Quasi-Newton solver to set.
:type maximumFunctionEvaluations: int
:rtype: None

Definition at line 8421 of file iron.py.

def iron.Solver.QuasiNewtonMaximumIterationsSet (   self,
  maximumIterations 
)
Sets/changes the maximum number of iterations for a Quasi-Newton solver identified by an object.

:param maximumIterations: The maximum number of iterations for the Quasi-Newton solver to set.
:type maximumIterations: int
:rtype: None

Definition at line 8432 of file iron.py.

def iron.Solver.QuasiNewtonRelativeToleranceSet (   self,
  relativeTolerance 
)
Sets/changes the relative tolerance for a Quasi-Newton solver identified by an object.

:param relativeTolerance: The relative tolerance for the Quasi-Newton solver to set.
:type relativeTolerance: float
:rtype: None

Definition at line 8443 of file iron.py.

def iron.Solver.QuasiNewtonRestartSet (   self,
  quasiNewtonRestart 
)
Sets/changes the restart of a Quasi-Newton solver identified by an object.

:param quasiNewtonRestart: The restart of the Quasi-Newton solver to set.
:type quasiNewtonRestart: int
:rtype: None

Definition at line 8454 of file iron.py.

def iron.Solver.QuasiNewtonRestartTypeSet (   self,
  quasiNewtonRestartType 
)
Sets/changes the restart type of a Quasi-Newton solver identified by an object.

:param quasiNewtonRestartType: The restart type of the Quasi-Newton solver to set. Must be a value from the QuasiNewtonRestartTypes enum.
:type quasiNewtonRestartType: int
:rtype: None

Definition at line 8465 of file iron.py.

def iron.Solver.QuasiNewtonScaleTypeSet (   self,
  quasiNewtonScaleType 
)
Sets/changes the scale type of a Quasi-Newton solver identified by an object.

:param quasiNewtonScaleType: The scale type of the Quasi-Newton solver to set. Must be a value from the QuasiNewtonScaleTypes enum.
:type quasiNewtonScaleType: int
:rtype: None

Definition at line 8476 of file iron.py.

def iron.Solver.QuasiNewtonSolutionToleranceSet (   self,
  solutionTolerance 
)
Sets/changes the solution tolerance for a Quasi-Newton solver identified by an object.

:param solutionTolerance: The solution tolerance for the Quasi-Newton solver to set.
:type solutionTolerance: float
:rtype: None

Definition at line 8487 of file iron.py.

def iron.Solver.QuasiNewtonSolveTypeSet (   self,
  quasiNewtonSolveType 
)
Sets/changes the type of a Quasi-Newton solver identified by an object.

:param quasiNewtonSolveType: The type of the Quasi-Newton solver to set. Must be a value from the QuasiNewtonSolverTypes enum.
:type quasiNewtonSolveType: int
:rtype: None

Definition at line 8498 of file iron.py.

def iron.Solver.QuasiNewtonTrustRegionDelta0Set (   self,
  delta0 
)
Sets/changes the delta0 for a Quasi-Newton trust region solver identified by an object.

:param delta0: The delta0 for the Quasi-Newton trust region solver to set.
:type delta0: float
:rtype: None

Definition at line 8509 of file iron.py.

def iron.Solver.QuasiNewtonTrustRegionToleranceSet (   self,
  tolerance 
)
Sets/changes the tolerance for a Quasi-Newton trust region solver identified by an object.

:param tolerance: The tolerance for the Quasi-Newton trust region solver to set.
:type tolerance: float
:rtype: None

Definition at line 8520 of file iron.py.

def iron.Solver.QuasiNewtonTypeSet (   self,
  quasiNewtonType 
)
Sets/changes the type of a Quasi-Newton solver identified by an object.

:param quasiNewtonType: The Quasi-Newton type to set. Must be a value from the QuasiNewtonTypes enum.
:type quasiNewtonType: int
:rtype: None

Definition at line 8531 of file iron.py.

def iron.Solver.SolverEquationsGet (   self,
  solverEquations 
)
Returns the solver equations for a solver identified by an object.

:param solverEquations: On return, the solver equations for the solver.
:type solverEquations: SolverEquations
:rtype: None

Definition at line 8542 of file iron.py.

Member Data Documentation

iron.Solver.cmiss_type

Definition at line 7672 of file iron.py.

Property Documentation

iron.Solver.cellMLEquations = property(CellMLEquationsGet, None, None, )
static

Definition at line 8643 of file iron.py.

iron.Solver.dAEEulerSolverType = property(DAEEulerSolverTypeGet, DAEEulerSolverTypeSet, None, )
static

Definition at line 8645 of file iron.py.

iron.Solver.dAESolverType = property(DAESolverTypeGet, DAESolverTypeSet, None, )
static

Definition at line 8647 of file iron.py.

iron.Solver.dAETimeStep = property(None, DAETimeStepSet, None, )
static

Definition at line 8593 of file iron.py.

iron.Solver.dynamicDegree = property(DynamicDegreeGet, DynamicDegreeSet, None, )
static

Definition at line 8619 of file iron.py.

iron.Solver.dynamicLinearityType = property(DynamicLinearityTypeGet, None, None, )
static

Definition at line 8585 of file iron.py.

iron.Solver.dynamicLinearSolver = property(DynamicLinearSolverGet, None, None, )
static

Definition at line 8605 of file iron.py.

iron.Solver.dynamicNonlinearSolver = property(DynamicNonlinearSolverGet, None, None, )
static

Definition at line 8651 of file iron.py.

iron.Solver.dynamicScheme = property(None, DynamicSchemeSet, None, )
static

Definition at line 8633 of file iron.py.

iron.Solver.dynamicTheta = property(None, DynamicThetaSet, None, )
static

Definition at line 8637 of file iron.py.

iron.Solver.geometricTransformationArbitraryPath = property(None, GeometricTransformationArbitraryPathSet, None, )
static

Definition at line 8555 of file iron.py.

iron.Solver.geometricTransformationNoLoadIncrements = property(None, GeometricTransformationNoLoadIncrementsSet, None, )
static

Definition at line 8573 of file iron.py.

iron.Solver.geometricTransformationScalings = property(None, GeometricTransformationScalingsSet, None, )
static

Definition at line 8595 of file iron.py.

iron.Solver.label = property(LabelGet, LabelSet, None, )
static

Definition at line 8565 of file iron.py.

iron.Solver.libraryType = property(LibraryTypeGet, LibraryTypeSet, None, )
static

Definition at line 8597 of file iron.py.

iron.Solver.linearDirectType = property(None, LinearDirectTypeSet, None, )
static

Definition at line 8667 of file iron.py.

iron.Solver.linearIterativeAbsoluteTolerance = property(None, LinearIterativeAbsoluteToleranceSet, None, )
static

Definition at line 8641 of file iron.py.

iron.Solver.linearIterativeDivergenceTolerance = property(None, LinearIterativeDivergenceToleranceSet, None, )
static

Definition at line 8579 of file iron.py.

iron.Solver.linearIterativeGMRESRestart = property(None, LinearIterativeGMRESRestartSet, None, )
static

Definition at line 8669 of file iron.py.

iron.Solver.linearIterativeMaximumIterations = property(None, LinearIterativeMaximumIterationsSet, None, )
static

Definition at line 8659 of file iron.py.

iron.Solver.linearIterativePreconditionerType = property(None, LinearIterativePreconditionerTypeSet, None, )
static

Definition at line 8601 of file iron.py.

iron.Solver.linearIterativeRelativeTolerance = property(None, LinearIterativeRelativeToleranceSet, None, )
static

Definition at line 8609 of file iron.py.

iron.Solver.linearIterativeType = property(None, LinearIterativeTypeSet, None, )
static

Definition at line 8623 of file iron.py.

iron.Solver.linearType = property(None, LinearTypeSet, None, )
static

Definition at line 8591 of file iron.py.

iron.Solver.newtonAbsoluteTolerance = property(None, NewtonAbsoluteToleranceSet, None, )
static

Definition at line 8649 of file iron.py.

iron.Solver.newtonCellMLSolver = property(NewtonCellMLSolverGet, None, None, )
static

Definition at line 8617 of file iron.py.

iron.Solver.newtonConvergenceTestType = property(None, NewtonConvergenceTestTypeSet, None, )
static

Definition at line 8553 of file iron.py.

iron.Solver.newtonJacobianCalculationType = property(None, NewtonJacobianCalculationTypeSet, None, )
static

Definition at line 8577 of file iron.py.

iron.Solver.newtonLinearSolver = property(NewtonLinearSolverGet, None, None, )
static

Definition at line 8607 of file iron.py.

iron.Solver.newtonLineSearchAlpha = property(None, NewtonLineSearchAlphaSet, None, )
static

Definition at line 8635 of file iron.py.

iron.Solver.newtonLineSearchMaxStep = property(None, NewtonLineSearchMaxStepSet, None, )
static

Definition at line 8581 of file iron.py.

iron.Solver.newtonLineSearchMonitorOutput = property(None, NewtonLineSearchMonitorOutputSet, None, )
static

Definition at line 8625 of file iron.py.

iron.Solver.newtonLineSearchStepTol = property(None, NewtonLineSearchStepTolSet, None, )
static

Definition at line 8575 of file iron.py.

iron.Solver.newtonLineSearchType = property(None, NewtonLineSearchTypeSet, None, )
static

Definition at line 8675 of file iron.py.

iron.Solver.newtonMaximumFunctionEvaluations = property(None, NewtonMaximumFunctionEvaluationsSet, None, )
static

Definition at line 8587 of file iron.py.

iron.Solver.newtonMaximumIterations = property(None, NewtonMaximumIterationsSet, None, )
static

Definition at line 8615 of file iron.py.

iron.Solver.newtonRelativeTolerance = property(None, NewtonRelativeToleranceSet, None, )
static

Definition at line 8559 of file iron.py.

iron.Solver.newtonSolutionTolerance = property(None, NewtonSolutionToleranceSet, None, )
static

Definition at line 8639 of file iron.py.

iron.Solver.newtonTrustRegionDelta0 = property(None, NewtonTrustRegionDelta0Set, None, )
static

Definition at line 8557 of file iron.py.

iron.Solver.newtonTrustRegionTolerance = property(None, NewtonTrustRegionToleranceSet, None, )
static

Definition at line 8673 of file iron.py.

iron.Solver.newtonType = property(None, NewtonTypeSet, None, )
static

Definition at line 8679 of file iron.py.

iron.Solver.nonlinearType = property(None, NonlinearTypeSet, None, )
static

Definition at line 8655 of file iron.py.

iron.Solver.outputType = property(None, OutputTypeSet, None, )
static

Definition at line 8599 of file iron.py.

iron.Solver.quasiNewtonAbsoluteTolerance = property(None, QuasiNewtonAbsoluteToleranceSet, None, )
static

Definition at line 8569 of file iron.py.

iron.Solver.quasiNewtonCellMLSolver = property(QuasiNewtonCellMLSolverGet, None, None, )
static

Definition at line 8603 of file iron.py.

iron.Solver.quasiNewtonConvergenceTestType = property(None, QuasiNewtonConvergenceTestTypeSet, None, )
static

Definition at line 8589 of file iron.py.

iron.Solver.quasiNewtonJacobianCalculationType = property(None, QuasiNewtonJacobianCalculationTypeSet, None, )
static

Definition at line 8627 of file iron.py.

iron.Solver.quasiNewtonLinearSolver = property(QuasiNewtonLinearSolverGet, None, None, )
static

Definition at line 8571 of file iron.py.

iron.Solver.quasiNewtonLineSearchMaxStep = property(None, QuasiNewtonLineSearchMaxStepSet, None, )
static

Definition at line 8613 of file iron.py.

iron.Solver.quasiNewtonLineSearchMonitorOutput = property(None, QuasiNewtonLineSearchMonitorOutputSet, None, )
static

Definition at line 8611 of file iron.py.

iron.Solver.quasiNewtonLineSearchStepTol = property(None, QuasiNewtonLineSearchStepTolSet, None, )
static

Definition at line 8661 of file iron.py.

iron.Solver.quasiNewtonLineSearchType = property(None, QuasiNewtonLineSearchTypeSet, None, )
static

Definition at line 8677 of file iron.py.

iron.Solver.quasiNewtonMaximumFunctionEvaluations = property(None, QuasiNewtonMaximumFunctionEvaluationsSet, None, )
static

Definition at line 8671 of file iron.py.

iron.Solver.quasiNewtonMaximumIterations = property(None, QuasiNewtonMaximumIterationsSet, None, )
static

Definition at line 8653 of file iron.py.

iron.Solver.quasiNewtonRelativeTolerance = property(None, QuasiNewtonRelativeToleranceSet, None, )
static

Definition at line 8583 of file iron.py.

iron.Solver.quasiNewtonRestart = property(None, QuasiNewtonRestartSet, None, )
static

Definition at line 8663 of file iron.py.

iron.Solver.quasiNewtonRestartType = property(None, QuasiNewtonRestartTypeSet, None, )
static

Definition at line 8567 of file iron.py.

iron.Solver.quasiNewtonScaleType = property(None, QuasiNewtonScaleTypeSet, None, )
static

Definition at line 8657 of file iron.py.

iron.Solver.quasiNewtonSolutionTolerance = property(None, QuasiNewtonSolutionToleranceSet, None, )
static

Definition at line 8563 of file iron.py.

iron.Solver.quasiNewtonSolveType = property(None, QuasiNewtonSolveTypeSet, None, )
static

Definition at line 8629 of file iron.py.

iron.Solver.quasiNewtonTrustRegionDelta0 = property(None, QuasiNewtonTrustRegionDelta0Set, None, )
static

Definition at line 8621 of file iron.py.

iron.Solver.quasiNewtonTrustRegionTolerance = property(None, QuasiNewtonTrustRegionToleranceSet, None, )
static

Definition at line 8631 of file iron.py.

iron.Solver.quasiNewtonType = property(None, QuasiNewtonTypeSet, None, )
static

Definition at line 8561 of file iron.py.

iron.Solver.solverEquations = property(SolverEquationsGet, None, None, )
static

Definition at line 8665 of file iron.py.