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

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

[legend]

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

[legend]

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

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

virtual	~PBiCICG ()=default

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 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)
	Construct for given field name, matrix and controls. More...

virtual	~solver ()=default
	Destructor. More...

const word &	fieldName () const noexcept

const LduMatrix< Type, DType, LUType > &	matrix () const noexcept

virtual void	read (const dictionary &)
	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 lduMatrix::normTypes normType) const
	Return the matrix norm using the specified norm method. 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 stopping criterion. More...

Additional Inherited Members
Static Public Member Functions inherited from LduMatrix< Type, DType, LUType >::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< Type, DType, LUType >::solver
virtual void	readControls ()
	Read the control parameters from controlDict_. More...

template<class T >
void	readControl (const dictionary &dict, T &val, const word &key)
	Deprecated(2021-09) Read control parameter from dictionary. More...

Protected Attributes inherited from LduMatrix< Type, DType, LUType >::solver
word	fieldName_

const LduMatrix< Type, DType, LUType > &	matrix_

dictionary	controlDict_
	Dictionary of solution controls. More...

int	log_
	Verbosity level for solver output statements. More...

label	minIter_
	Minimum number of iterations in the solver. More...

label	maxIter_
	Maximum number of iterations in the solver. More...

lduMatrix::normTypes	normType_
	The matrix normalisation type. 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::PBiCICG< Type, DType, LUType >

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

Source files

Definition at line 49 of file PBiCICG.H.

Constructor & Destructor Documentation

◆ PBiCICG()

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

Construct from matrix components and solver data dictionary.

Definition at line 28 of file PBiCICG.C.

◆ ~PBiCICG()

virtual ~PBiCICG ( )

virtualdefault

Member Function Documentation

◆ TypeName()

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

Runtime type information.

◆ solve()

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

virtual

Solve the matrix with this solver.

Implements LduMatrix< Type, DType, LUType >::solver.

Definition at line 47 of file PBiCICG.C.

References Foam::constant::atomic::alpha, UList< T >::begin(), UList< Type >::begin(), beta(), Foam::cmptDivide(), Foam::cmptMag(), Foam::cmptMultiply(), Foam::endl(), Foam::gSumCmptMag(), Foam::gSumCmptProd(), Foam::Info, Foam::New(), psi, Foam::stabilise(), and Foam::Zero.

Here is the call graph for this function:

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

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

Public Member Functions

Additional Inherited Members