Public Member Functions | List of all members
PCICG< Type, DType, LUType > Class Template Reference

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

Inheritance diagram for PCICG< Type, DType, LUType >:
Inheritance graph
[legend]
Collaboration diagram for PCICG< Type, DType, LUType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("PCICG")
 Runtime type information. More...
 
 PCICG (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)
 Construct from matrix components and solver data dictionary. More...
 
virtual ~PCICG ()
 
virtual SolverPerformance< Type > solve (Field< Type > &psi) const
 Solve the matrix with this solver. More...
 
- Public Member Functions inherited from LduMatrix< Type, DType, LUType >::solver
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, solver, symMatrix,( const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict ),( fieldName, matrix, solverDict ))
 
 declareRunTimeSelectionTable (autoPtr, solver, asymMatrix,( const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict ),( fieldName, matrix, solverDict ))
 
 solver (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)
 
virtual ~solver ()
 
const wordfieldName () const
 
const LduMatrix< Type, DType, LUType > & matrix () const
 
virtual void read (const dictionary &solverDict)
 Read and reset the solver parameters from the given dictionary. More...
 
Type normFactor (const Field< Type > &psi, const Field< Type > &Apsi, Field< Type > &tmpField) const
 Return the matrix norm used to normalise the residual for the. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from LduMatrix< Type, DType, LUType >::solver
static autoPtr< solverNew (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)
 Return a new solver. More...
 
- Protected Member Functions inherited from LduMatrix< Type, DType, LUType >::solver
template<class T >
void readControl (const dictionary &controlDict, T &control, const word &controlName)
 Read a control parameter from controlDict. More...
 
virtual void readControls ()
 Read the control parameters from the controlDict_. More...
 
- Protected Attributes inherited from LduMatrix< Type, DType, LUType >::solver
word fieldName_
 
const LduMatrix< Type, DType, LUType > & matrix_
 
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...
 
Type tolerance_
 Final convergence tolerance. More...
 
Type relTol_
 Convergence tolerance relative to the initial. More...
 

Detailed Description

template<class Type, class DType, class LUType>
class Foam::PCICG< Type, DType, LUType >

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

Source files

Definition at line 50 of file PCICG.H.

Constructor & Destructor Documentation

PCICG ( const word fieldName,
const LduMatrix< Type, DType, LUType > &  matrix,
const dictionary solverDict 
)

Construct from matrix components and solver data dictionary.

Definition at line 32 of file PCICG.C.

virtual ~PCICG ( )
inlinevirtual

Definition at line 82 of file PCICG.H.

References psi, and PCICG< Type, DType, LUType >::solve().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "PCICG< Type, DType, LUType >"  )

Runtime type information.

Foam::SolverPerformance< Type > solve ( Field< Type > &  psi) const
virtual

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