Public Member Functions | List of all members
PBiCG Class Reference

Preconditioned bi-conjugate gradient solver for asymmetric lduMatrices using a run-time selectable preconditiioner. More...

Inheritance diagram for PBiCG:
Inheritance graph
[legend]
Collaboration diagram for PBiCG:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("PBiCG")
 Runtime type information. More...
 
 PBiCG (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
 Construct from matrix components and solver data stream. More...
 
virtual ~PBiCG ()
 Destructor. More...
 
virtual solverPerformance solve (scalarField &psi, const scalarField &source, const direction cmpt=0) const
 Solve the matrix with this solver. More...
 
- Public Member Functions inherited from lduMatrix::solver
virtual const wordtype () const =0
 Runtime type information. More...
 
 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 ()
 Destructor. More...
 
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. More...
 
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. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from lduMatrix::solver
static autoPtr< solverNew (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
 Return a new solver. More...
 
- Protected Member Functions inherited from lduMatrix::solver
virtual void readControls ()
 Read the control parameters from the controlDict_. More...
 
- Protected Attributes inherited from lduMatrix::solver
word fieldName_
 
const lduMatrixmatrix_
 
const FieldField< Field, scalar > & interfaceBouCoeffs_
 
const FieldField< Field, scalar > & interfaceIntCoeffs_
 
lduInterfaceFieldPtrsList interfaces_
 
dictionary controlDict_
 Dictionary of controls. More...
 
label maxIter_
 Maximum number of iterations in the solver. More...
 
label minIter_
 Minimum number of iterations in the solver. More...
 
scalar tolerance_
 Final convergence tolerance. More...
 
scalar relTol_
 Convergence tolerance relative to the initial. More...
 

Detailed Description

Preconditioned bi-conjugate gradient solver for asymmetric lduMatrices using a run-time selectable preconditiioner.

Source files

Definition at line 49 of file PBiCG.H.

Constructor & Destructor Documentation

PBiCG ( const word fieldName,
const lduMatrix matrix,
const FieldField< Field, scalar > &  interfaceBouCoeffs,
const FieldField< Field, scalar > &  interfaceIntCoeffs,
const lduInterfaceFieldPtrsList interfaces,
const dictionary solverControls 
)

Construct from matrix components and solver data stream.

Definition at line 42 of file PBiCG.C.

References PBiCG::solve().

Here is the call graph for this function:

virtual ~PBiCG ( )
inlinevirtual

Destructor.

Definition at line 83 of file PBiCG.H.

References psi, and PBiCG::solve().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "PBiCG"  )

Runtime type information.

Foam::solverPerformance solve ( scalarField psi,
const scalarField source,
const direction  cmpt = 0 
) const
virtual

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