FreeFOAM The Cross-Platform CFD Toolkit
lduMatrix::preconditioner Class Reference

Abstract base-class for lduMatrix preconditioners. More...

#include <src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrix.H>


Detailed Description

Abstract base-class for lduMatrix preconditioners.

Definition at line 524 of file lduMatrix.H.

+ Inheritance diagram for lduMatrix::preconditioner:
+ Collaboration diagram for lduMatrix::preconditioner:

List of all members.

Public Member Functions

virtual const wordtype () const =0
 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))
 preconditioner (const solver &sol)
virtual ~preconditioner ()
virtual void read (const dictionary &)
 Read and reset the preconditioner parameters.
virtual void precondition (scalarField &wA, const scalarField &rA, const direction cmpt=0) const =0
 Return wA the preconditioned form of residual rA.
virtual void preconditionT (scalarField &wT, const scalarField &rT, const direction cmpt=0) const
 Return wT the transpose-matrix preconditioned form of.

Static Public Member Functions

static word getName (const dictionary &)
 Find the preconditioner name (directly or from a sub-dictionary)
static autoPtr< preconditionerNew (const solver &sol, const dictionary &solverControls)
 Return a new preconditioner.

Protected Attributes

const solversolver_
 Reference to the base-solver this preconditioner is used with.

Constructor & Destructor Documentation

preconditioner ( const solver sol)
inline

Definition at line 573 of file lduMatrix.H.

virtual ~preconditioner ( )
inlinevirtual

Definition at line 593 of file lduMatrix.H.


Member Function Documentation

Foam::word getName ( const dictionary solverControls)
static

Find the preconditioner name (directly or from a sub-dictionary)

Definition at line 41 of file lduMatrixPreconditioner.C.

References entry::dict(), e, entry::isDict(), dictionary::lookup(), dictionary::lookupEntry(), name(), and entry::stream().

virtual const word& type ( ) const
pure virtual

Runtime type information.

Referenced by lduMatrix::preconditioner::preconditionT().

declareRunTimeSelectionTable ( autoPtr  ,
preconditioner  ,
symMatrix  ,
(const solver &sol, const dictionary &solverControls)  ,
(sol, solverControls)   
)
declareRunTimeSelectionTable ( autoPtr  ,
preconditioner  ,
asymMatrix  ,
(const solver &sol, const dictionary &solverControls)  ,
(sol, solverControls)   
)
virtual void read ( const dictionary )
inlinevirtual

Read and reset the preconditioner parameters.

from the given stream

Definition at line 601 of file lduMatrix.H.

virtual void precondition ( scalarField wA,
const scalarField rA,
const direction  cmpt = 0 
) const
pure virtual

Return wA the preconditioned form of residual rA.

Implemented in FDICPreconditioner, diagonalPreconditioner, GAMGPreconditioner, DICPreconditioner, DILUPreconditioner, and noPreconditioner.

virtual void preconditionT ( scalarField wT,
const scalarField rT,
const direction  cmpt = 0 
) const
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 616 of file lduMatrix.H.

References notImplemented, and lduMatrix::preconditioner::type().


Member Data Documentation

const solver& solver_
protected

Reference to the base-solver this preconditioner is used with.

Definition at line 531 of file lduMatrix.H.


The documentation for this class was generated from the following files: