IterativeSolverSettings

Settings for the iterative solver.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

    -- Change the advanced solver type to iterative

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

    -- Change the preconditioner type to BlockJacobiLU

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

Inheritance

The IterativeSolverSettings object is derived from the CompositeValue object.

Usage locations

The IterativeSolverSettings object can be accessed from the following locations:

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 ParametricExpression)
FillInPerRow
The Multilevel ILU controlled fill-in parameter. Only valid if PreconditionerType is MultiLevelILU. (Read/Write ParametricExpression)
LevelOfFill
The incomplete LU decomposition level-of-fill. Only valid if PreconditionerType is IncompleteLU. (Read/Write ParametricExpression)
MaxIterations
The maximum number of iterations. (Read/Write ParametricExpression)
MaxResiduum
The V increment in metres (parallel ray front). (Read/Write ParametricExpression)
PreconditionerType
The preconditioner type, specified by PreconditionerTypeEnum, e.g. Default, BlockJacobiLU, etc. (Read/Write PreconditionerTypeEnum)
StabilisationFactor
The stabilisation factor. Only valid if PreconditionerType is MultiLevelILU. (Read/Write ParametricExpression)
StoppingCriterion
The V increment in metres (parallel ray front). (Read/Write ParametricExpression)

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
ParametricExpression
Access
Read/Write
FillInPerRow
The Multilevel ILU controlled fill-in parameter. Only valid if PreconditionerType is MultiLevelILU.
Type
ParametricExpression
Access
Read/Write
LevelOfFill
The incomplete LU decomposition level-of-fill. Only valid if PreconditionerType is IncompleteLU.
Type
ParametricExpression
Access
Read/Write
MaxIterations
The maximum number of iterations.
Type
ParametricExpression
Access
Read/Write
MaxResiduum
The V increment in metres (parallel ray front).
Type
ParametricExpression
Access
Read/Write
PreconditionerType
The preconditioner type, specified by PreconditionerTypeEnum, e.g. Default, BlockJacobiLU, etc.
Type
PreconditionerTypeEnum
Access
Read/Write
StabilisationFactor
The stabilisation factor. Only valid if PreconditionerType is MultiLevelILU.
Type
ParametricExpression
Access
Read/Write
StoppingCriterion
The V increment in metres (parallel ray front).
Type
ParametricExpression
Access
Read/Write