IterativeSolverSettings

Settings for the iterative solver.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Change the advanced solver type to iterative

project.SolutionSettings.SolverSettings.PreconditionerSettings.AdvancedSolverType = 
    cf.Enums.AdvancedSolverTypeEnum.Iterative

    -- Change the preconditioner type to BlockJacobiLU

project.SolutionSettings.SolverSettings.PreconditionerSettings.IterativeSolverSettings.
    PreconditionerType = cf.Enums.PreconditionerTypeEnum.BlockJacobiLU_64

Usage locations (object properties)

The following objects have properties using the IterativeSolverSettings object:

Property List

AcceleratedSPAIEnabled
Specifies whether SPAI is accelerated (faster, possibly more iterations). Only valid if PreconditionerType is SparseApproxInverse. (Read/Write boolean)
BlockSize
The Block-Jacobi block size. Only valid if PreconditionerType is BlockJacobiLU. (Read/Write Expression)
FillInPerRow
The Multilevel ILU controlled fill-in parameter. Only valid if PreconditionerType is MultiLevelILU. (Read/Write Expression)
LevelOfFill
The incomplete LU decomposition level-of-fill. Only valid if PreconditionerType is IncompleteLU. (Read/Write Expression)
MaxIterations
The maximum number of iterations. (Read/Write Expression)
MaxResiduum
The V increment in metres (parallel ray front). (Read/Write Expression)
PreconditionerType
The preconditioner type, specified by PreconditionerTypeEnum, eg. Default, BlockJacobiLU, etc. (Read/Write PreconditionerTypeEnum)
StabilisationFactor
The stabilisation factor. Only valid if PreconditionerType is MultiLevelILU. (Read/Write Expression)
StoppingCriterion
The V increment in metres (parallel ray front). (Read/Write Expression)

Property Details

AcceleratedSPAIEnabled
Specifies whether SPAI is accelerated (faster, possibly more iterations). Only valid if PreconditionerType is SparseApproxInverse.
Type
boolean
Access
Read/Write
BlockSize
The Block-Jacobi block size. Only valid if PreconditionerType is BlockJacobiLU.
Type
Expression
Access
Read/Write
FillInPerRow
The Multilevel ILU controlled fill-in parameter. Only valid if PreconditionerType is MultiLevelILU.
Type
Expression
Access
Read/Write
LevelOfFill
The incomplete LU decomposition level-of-fill. Only valid if PreconditionerType is IncompleteLU.
Type
Expression
Access
Read/Write
MaxIterations
The maximum number of iterations.
Type
Expression
Access
Read/Write
MaxResiduum
The V increment in metres (parallel ray front).
Type
Expression
Access
Read/Write
PreconditionerType
The preconditioner type, specified by PreconditionerTypeEnum, eg. Default, BlockJacobiLU, etc.
Type
PreconditionerTypeEnum
Access
Read/Write
StabilisationFactor
The stabilisation factor. Only valid if PreconditionerType is MultiLevelILU.
Type
Expression
Access
Read/Write
StoppingCriterion
The V increment in metres (parallel ray front).
Type
Expression
Access
Read/Write