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

Inheritance diagram for PBiCCCG< Type, DType, LUType >:

[legend]

Collaboration diagram for PBiCCCG< Type, DType, LUType >:

[legend]

Public Member Functions
	TypeName ("PBiCCCG")
	Runtime type information. More...

	PBiCCCG (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)
	Construct from matrix components and solver data dictionary. More...

virtual	~PBiCCCG ()

virtual SolverPerformance< Type >	solve (Field< Type > &psi) const
	Solve the matrix with this solver. More...

Public Member Functions inherited from LduMatrix::solver
virtual const word &	type () 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 word &	fieldName () 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...

Private Member Functions
	PBiCCCG (const PBiCCCG &)
	Disallow default bitwise copy construct. More...

void	operator= (const PBiCCCG &)
	Disallow default bitwise assignment. More...

Additional Inherited Members
Static Public Member Functions inherited from LduMatrix::solver
static autoPtr< solver >	New (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)
	Return a new solver. More...

Protected Member Functions inherited from LduMatrix::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::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::PBiCCCG< Type, DType, LUType >

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

Source files

Definition at line 50 of file PBiCCCG.H.

Constructor & Destructor Documentation

◆ PBiCCCG() [1/2]

PBiCCCG ( const PBiCCCG< Type, DType, LUType > & )

private

Disallow default bitwise copy construct.

◆ PBiCCCG() [2/2]

PBiCCCG	(	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 PBiCCCG.C.

◆ ~PBiCCCG()

virtual ~PBiCCCG ( )

inlinevirtual

Definition at line 82 of file PBiCCCG.H.

Member Function Documentation

◆ operator=()

void operator= ( const PBiCCCG< Type, DType, LUType > & )

private

Disallow default bitwise assignment.

◆ TypeName()

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

Runtime type information.

◆ solve()

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

virtual

Solve the matrix with this solver.

Implements LduMatrix::solver.

Definition at line 52 of file PBiCCCG.C.

References Foam::constant::atomic::alpha, beta(), SolverPerformance::checkConvergence(), SolverPerformance::checkSingularity(), Foam::cmptDivide(), Foam::endl(), SolverPerformance::finalResidual(), Foam::gSumCmptMag(), Foam::gSumProd(), Foam::Info, SolverPerformance::initialResidual(), Foam::mag(), Foam::compressible::New(), SolverPerformance::nIterations(), and psi.

Here is the call graph for this function:

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

src/OpenFOAM/matrices/LduMatrix/Solvers/PBiCCCG/PBiCCCG.H
src/OpenFOAM/matrices/LduMatrix/Solvers/PBiCCCG/PBiCCCG.C

Public Member Functions

Private Member Functions

Additional Inherited Members