Abstract base-class for lduMatrix preconditioners. More...
Public Member Functions | |
virtual const word & | type () const =0 |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, preconditioner, symMatrix,(const solver &sol, const dictionary &solverControls),(sol, solverControls)) | |
declareRunTimeSelectionTable (autoPtr, preconditioner, asymMatrix,(const solver &sol, const dictionary &solverControls),(sol, solverControls)) | |
preconditioner (const solver &sol) | |
Construct for given solver. More... | |
virtual | ~preconditioner ()=default |
Destructor. More... | |
virtual void | read (const dictionary &) |
Read and reset the preconditioner parameters from the given stream. More... | |
virtual void | precondition (solveScalarField &wA, const solveScalarField &rA, const direction cmpt=0) const =0 |
Return wA the preconditioned form of residual rA. More... | |
virtual void | preconditionT (solveScalarField &wT, const solveScalarField &rT, const direction cmpt=0) const |
Return wT the transpose-matrix preconditioned form of residual rT. More... | |
virtual void | setFinished (const solverPerformance &perf) const |
Signal end of solver. More... | |
Static Public Member Functions | |
static word | getName (const dictionary &) |
Find the preconditioner name (directly or from a sub-dictionary) More... | |
static autoPtr< preconditioner > | New (const solver &sol, const dictionary &solverControls) |
Return a new preconditioner. More... | |
Protected Attributes | |
const solver & | solver_ |
Reference to the base-solver this preconditioner is used with. More... | |
Abstract base-class for lduMatrix preconditioners.
Definition at line 563 of file lduMatrix.H.
|
inlineexplicit |
Construct for given solver.
Definition at line 620 of file lduMatrix.H.
|
virtualdefault |
Destructor.
|
static |
Find the preconditioner name (directly or from a sub-dictionary)
Definition at line 36 of file lduMatrixPreconditioner.C.
References Foam::constant::electromagnetic::e, dictionary::lookupEntry(), and Foam::name().
Referenced by FPCG::scalarSolve(), and PPCG::scalarSolveCG().
|
pure virtual |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
preconditioner | , | ||
symMatrix | , | ||
(const solver &sol, const dictionary &solverControls) | , | ||
(sol, solverControls) | |||
) |
declareRunTimeSelectionTable | ( | autoPtr | , |
preconditioner | , | ||
asymMatrix | , | ||
(const solver &sol, const dictionary &solverControls) | , | ||
(sol, solverControls) | |||
) |
|
static |
Return a new preconditioner.
Definition at line 61 of file lduMatrixPreconditioner.C.
References lduMatrix::asymmetric(), Foam::constant::electromagnetic::e, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FatalIOErrorInLookup, dictionary::lookupEntry(), lduMatrix::solver::matrix(), Foam::name(), and lduMatrix::symmetric().
Referenced by FPCG::scalarSolve(), and PPCG::scalarSolveCG().
|
inlinevirtual |
Read and reset the preconditioner parameters from the given stream.
Definition at line 650 of file lduMatrix.H.
|
pure virtual |
Return wA the preconditioned form of residual rA.
Implemented in distributedDILUPreconditioner, FDICPreconditioner, diagonalPreconditioner, GAMGPreconditioner, DICPreconditioner, DILUPreconditioner, and noPreconditioner.
|
inlinevirtual |
Return wT the transpose-matrix preconditioned form of residual rT.
This is only required for preconditioning asymmetric matrices.
Reimplemented in diagonalPreconditioner, DILUPreconditioner, and noPreconditioner.
Definition at line 670 of file lduMatrix.H.
References NotImplemented.
|
inlinevirtual |
Signal end of solver.
Reimplemented in distributedDILUPreconditioner.
Definition at line 682 of file lduMatrix.H.
|
protected |
Reference to the base-solver this preconditioner is used with.
Definition at line 572 of file lduMatrix.H.