PBiCGStab Class Reference

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

Inheritance diagram for PBiCGStab:

Collaboration diagram for PBiCGStab:

Public Member Functions
	TypeName ("PBiCGStab")
	PBiCGStab (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
virtual	~PBiCGStab ()=default
virtual solverPerformance	scalarSolve (solveScalarField &psi, const solveScalarField &source, const direction cmpt=0) const
virtual solverPerformance	solve (scalarField &psi, const scalarField &source, const direction cmpt=0) const
Public Member Functions inherited from lduMatrix::solver
virtual const word &	type () const =0
	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 ()=default
const word &	fieldName () const noexcept
const lduMatrix &	matrix () const noexcept
const FieldField< Field, scalar > &	interfaceBouCoeffs () const noexcept
const FieldField< Field, scalar > &	interfaceIntCoeffs () const noexcept
const lduInterfaceFieldPtrsList &	interfaces () const noexcept
virtual void	read (const dictionary &)
solveScalarField::cmptType	normFactor (const solveScalarField &psi, const solveScalarField &source, const solveScalarField &Apsi, solveScalarField &tmpField) const

Additional Inherited Members
Static Public Member Functions inherited from lduMatrix::solver
static autoPtr< solver >	New (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
Protected Member Functions inherited from lduMatrix::solver
virtual void	readControls ()
Protected Attributes inherited from lduMatrix::solver
word	fieldName_
const lduMatrix &	matrix_
const FieldField< Field, scalar > &	interfaceBouCoeffs_
const FieldField< Field, scalar > &	interfaceIntCoeffs_
lduInterfaceFieldPtrsList	interfaces_
dictionary	controlDict_
int	log_
label	minIter_
label	maxIter_
scalar	tolerance_
scalar	relTol_
profilingTrigger	profiling_
Static Protected Attributes inherited from lduMatrix::solver
static const label	defaultMaxIter_ = 1000

Detailed Description

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

References:

    Van der Vorst, H. A. (1992).
    Bi-CGSTAB: A fast and smoothly converging variant of Bi-CG
    for the solution of nonsymmetric linear systems.
    SIAM Journal on scientific and Statistical Computing, 13(2), 631-644.

    Barrett, R., Berry, M. W., Chan, T. F., Demmel, J., Donato, J.,
    Dongarra, J., Eijkhout, V., Pozo, R., Romine, C. & Van der Vorst, H.
    (1994).
    Templates for the solution of linear systems:
    building blocks for iterative methods
    (Vol. 43). Siam.

Source files

• PBiCGStab.H
• PBiCGStab.C

Definition at line 63 of file PBiCGStab.H.

Constructor & Destructor Documentation

PBiCGStab()

PBiCGStab	(	const word &	fieldName,
		const lduMatrix &	matrix,
		const FieldField< Field, scalar > &	interfaceBouCoeffs,
		const FieldField< Field, scalar > &	interfaceIntCoeffs,
		const lduInterfaceFieldPtrsList &	interfaces,
		const dictionary &	solverControls
	)

Definition at line 42 of file PBiCGStab.C.

~PBiCGStab()

virtual ~PBiCGStab ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"PBiCGStab"

)

scalarSolve()

Foam::solverPerformance scalarSolve ( solveScalarField &  psi, const solveScalarField &  source, const direction  cmpt = 0  ) const

virtual

Reimplemented from lduMatrix::solver.

Definition at line 66 of file PBiCGStab.C.

References Foam::constant::atomic::alpha, beta(), SolverPerformance::checkConvergence(), SolverPerformance::checkSingularity(), Foam::expressions::patchExpr::debug, Foam::endl(), SolverPerformance::finalResidual(), Foam::gSumMag(), Foam::gSumProd(), Foam::gSumSqr(), Foam::Info, SolverPerformance::initialResidual(), Foam::mag(), mesh, Foam::New(), SolverPerformance::nIterations(), psi, and lduMatrix::setResidualField().

Here is the call graph for this function:

solve()

Foam::solverPerformance solve ( scalarField &  psi, const scalarField &  source, const direction  cmpt = 0  ) const

virtual

Implements lduMatrix::solver.

Definition at line 272 of file PBiCGStab.C.

References refPtr< Field< Type > >::ref().

Here is the call graph for this function:

---

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

• src/OpenFOAM/matrices/lduMatrix/solvers/PBiCGStab/PBiCGStab.H
• src/OpenFOAM/matrices/lduMatrix/solvers/PBiCGStab/PBiCGStab.C