FreeFOAM The Cross-Platform CFD Toolkit
GAMGPreconditioner Class Reference

Geometric agglomerated algebraic multigrid preconditioner. More...

#include <OpenFOAM/GAMGPreconditioner.H>


Detailed Description

+ Inheritance diagram for GAMGPreconditioner:
+ Collaboration diagram for GAMGPreconditioner:

List of all members.

Public Member Functions

 TypeName ("GAMG")
 Runtime type information.
 GAMGPreconditioner (const lduMatrix::solver &, const dictionary &solverControls)
 Construct from matrix components and preconditioner solver controls.
virtual ~GAMGPreconditioner ()
virtual void precondition (scalarField &wA, const scalarField &rA, const direction cmpt=0) const
 Return wA the preconditioned form of residual rA.
- Public Member Functions inherited from GAMGSolver
 GAMGSolver (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
 Construct from lduMatrix and solver controls.
virtual ~GAMGSolver ()
virtual
lduMatrix::solverPerformance 
solve (scalarField &psi, const scalarField &source, const direction cmpt=0) const
 Solve.
- Public Member Functions inherited from lduMatrix::solver
virtual const wordtype () const =0
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, solver, symMatrix,(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls),(fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces, solverControls))
 declareRunTimeSelectionTable (autoPtr, solver, asymMatrix,(const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls),(fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces, solverControls))
 solver (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
virtual ~solver ()
const wordfieldName () const
const lduMatrixmatrix () const
const FieldField< Field, scalar > & interfaceBouCoeffs () const
const FieldField< Field, scalar > & interfaceIntCoeffs () const
const lduInterfaceFieldPtrsListinterfaces () const
virtual void read (const dictionary &)
 Read and reset the solver parameters from the given stream.
scalar normFactor (const scalarField &psi, const scalarField &source, const scalarField &Apsi, scalarField &tmpField) const
 Return the matrix norm used to normalise the residual for the.
- Public Member Functions inherited from lduMatrix::preconditioner
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 preconditionT (scalarField &wT, const scalarField &rT, const direction cmpt=0) const
 Return wT the transpose-matrix preconditioned form of.

Protected Member Functions

virtual void readControls ()
 Read the control parameters from the controlDict_.

Protected Attributes

label nVcycles_
 Number of V-cycles to perform.
- Protected Attributes inherited from lduMatrix::preconditioner
const solversolver_
 Reference to the base-solver this preconditioner is used with.

Additional Inherited Members

- Static Public Member Functions inherited from lduMatrix::preconditioner
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.

Constructor & Destructor Documentation

GAMGPreconditioner ( const lduMatrix::solver sol,
const dictionary solverControls 
)

Construct from matrix components and preconditioner solver controls.

Definition at line 45 of file GAMGPreconditioner.C.

~GAMGPreconditioner ( )
virtual

Definition at line 68 of file GAMGPreconditioner.C.


Member Function Documentation

void readControls ( )
protectedvirtual

Read the control parameters from the controlDict_.

Reimplemented from GAMGSolver.

Definition at line 74 of file GAMGPreconditioner.C.

TypeName ( "GAMG"  )

Runtime type information.

Reimplemented from GAMGSolver.

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

Return wA the preconditioned form of residual rA.

Implements lduMatrix::preconditioner.

Definition at line 82 of file GAMGPreconditioner.C.

References List< T >::size().


Member Data Documentation

label nVcycles_
protected

Number of V-cycles to perform.

Definition at line 61 of file GAMGPreconditioner.H.


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