FreeFOAM The Cross-Platform CFD Toolkit
Public Member Functions | Static Public Member Functions
ICCG Class Reference

Incomplete Cholesky preconditioned CG solver derived from the general preconditioned CG solver PCG but with the choice of preconditioner pre-selected. More...

#include <OpenFOAM/ICCG.H>

Detailed Description

Incomplete Cholesky preconditioned CG solver derived from the general preconditioned CG solver PCG but with the choice of preconditioner pre-selected.

Deprecated:
This solver is present for backward-compatibility and the PCG solver should be used for preference.
Source files

Definition at line 55 of file ICCG.H.

+ Inheritance diagram for ICCG:
+ Collaboration diagram for ICCG:

List of all members.

Public Member Functions

 TypeName ("ICCG")
 Runtime type information.
 ICCG (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.
 ICCG (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const scalar tolerance, const scalar relTol=0.0)
 Construct from matrix components and tolerances.
virtual ~ICCG ()
- Public Member Functions inherited from PCG
 TypeName ("PCG")
 Runtime type information.
 PCG (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 controls.
virtual ~PCG ()
virtual
lduMatrix::solverPerformance 		solve (scalarField &psi, const scalarField &source, const direction cmpt=0) const
 Solve the matrix with this solver.
- Public Member Functions inherited from lduMatrix::solver
virtual const word & type () 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 word & fieldName () const
const lduMatrix & matrix () const
const FieldField< Field, scalar > & interfaceBouCoeffs () const
const FieldField< Field, scalar > & interfaceIntCoeffs () const
const lduInterfaceFieldPtrsList & interfaces () 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.

Static Public Member Functions

static dictionary solverDict (const scalar tol, const scalar relTol)
 Return the dictionary constructed from the components.
static dictionary solverDict (Istream &)
 Return the dictionary constructed from the old-style data-stream.

Constructor & Destructor Documentation

ICCG ( 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 68 of file ICCG.C.

ICCG ( const word &  fieldName,
const lduMatrix &  matrix,
const FieldField< Field, scalar > &  interfaceBouCoeffs,
const FieldField< Field, scalar > &  interfaceIntCoeffs,
const lduInterfaceFieldPtrsList &  interfaces,
const scalar  tolerance,
const scalar  relTol = 0.0 
)

Construct from matrix components and tolerances.

Definition at line 90 of file ICCG.C.

virtual ~ICCG ( )
inlinevirtual

Definition at line 113 of file ICCG.H.

Member Function Documentation

Foam::dictionary solverDict ( const scalar  tol,
const scalar  relTol 
)
static

Return the dictionary constructed from the components.

Needed for backward compatibility

Definition at line 41 of file ICCG.C.

References dictionary::add().

Referenced by solution::upgradeSolverDict().

Foam::dictionary solverDict ( Istream &  is)
static

Return the dictionary constructed from the old-style data-stream.

Needed for backward compatibility

Definition at line 55 of file ICCG.C.

References readScalar.

TypeName ( "ICCG"  )

Runtime type information.

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