ansys.mapdl.core.Mapdl.itengine#

Mapdl.itengine(type_='', enginename='', precondname='', matrix='', rhsvector='', solvector='', maxiter='', toler='', **kwargs)#

Performs a solution using an iterative solver.

Mechanical APDL Command: *ITENGINE

Parameters:
type_str

Specifies the algorithm to be used:

  • PCG - Preconditioned conjugate gradient (default).

enginenamestr

Name used to identify this iterative solver engine. Must be specified.

precondnamestr

Linear solver engine name ( lsengine ) identifying the factored matrix to be used as the preconditioner.

matrixstr

Name of the matrix to solve.

rhsvectorstr

Matrix (load vector) name.

solvectorstr

Solution vector name. If non-zero, it will be taken as the initial vector for the iterative process.

maxiterstr

Maximum number of iterations allowed. Default is 2 times the number of rows in the matrix.

tolerstr

Convergence tolerance. Default is 1.0E-8.

Notes

Warning

This function contains specificities regarding the argument definitions. Please refer to the command documentation for further explanations.

Argument Descriptions

  • type_ : str - Specifies the algorithm to be used:

    • PCG - Preconditioned conjugate gradient (default).

  • enginename : str - Name used to identify this iterative solver engine. Must be specified.

  • precondname : str - Linear solver engine name ( lsengine ) identifying the factored matrix to be used as the preconditioner.

  • matrix : str - Name of the matrix to solve.

  • rhsvector : str - Matrix (load vector) name.

  • solvector : str - Solution vector name. If non-zero, it will be taken as the initial vector for the iterative process.

  • maxiter : str - Maximum number of iterations allowed. Default is 2 times the number of rows in the matrix.

  • toler : str - Convergence tolerance. Default is 1.0E-8.

This command solves Ax = b using a preconditioned conjugate gradient algorithm. It uses an existing factored system as the preconditioner. This solution method is useful if an existing matrix has been solved and minor changes have been made to the matrix.