FreeFOAM The Cross-Platform CFD Toolkit
BICCG Class Reference

Diagonal incomplete LU preconditioned BiCG solver derived from the general preconditioned BiCG solver PBiCG but with the choice of preconditioner pre-selected. More...

#include <OpenFOAM/BICCG.H>


Detailed Description

Diagonal incomplete LU preconditioned BiCG solver derived from the general preconditioned BiCG solver PBiCG but with the choice of preconditioner pre-selected.

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

Definition at line 55 of file BICCG.H.

+ Inheritance diagram for BICCG:
+ Collaboration diagram for BICCG:

List of all members.

Public Member Functions

 TypeName ("BICCG")
 Runtime type information.
 BICCG (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.
 BICCG (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 ~BICCG ()
- Public Member Functions inherited from PBiCG
 TypeName ("PBiCG")
 Runtime type information.
 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.
virtual ~PBiCG ()
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 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.

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

BICCG ( 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 70 of file BICCG.C.

BICCG ( 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 92 of file BICCG.C.

virtual ~BICCG ( )
inlinevirtual

Definition at line 114 of file BICCG.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 42 of file BICCG.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 56 of file BICCG.C.

References readScalar.

TypeName ( "BICCG"  )

Runtime type information.


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