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

Inheritance diagram for PPCG:

[legend]

Collaboration diagram for PPCG:

[legend]

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

	PPCG (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 controls. More...

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

virtual solverPerformance	solve (scalarField &psi, const scalarField &source, const direction cmpt=0) 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 &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
	Destructor. More...

const word &	fieldName () const

const lduMatrix &	matrix () const

const FieldField< Field, scalar > &	interfaceBouCoeffs () const

const FieldField< Field, scalar > &	interfaceIntCoeffs () const

const lduInterfaceFieldPtrsList &	interfaces () const

virtual void	read (const dictionary &)
	Read and reset the solver parameters from the given stream. More...

virtual solverPerformance	scalarSolve (solveScalarField &psi, const solveScalarField &source, const direction cmpt=0) const
	Solve with given field and rhs (in solveScalar precision). More...

solveScalarField::cmptType	normFactor (const solveScalarField &psi, const solveScalarField &source, const solveScalarField &Apsi, solveScalarField &tmpField) const

Protected Member Functions
solverPerformance	scalarSolveCG (solveScalarField &psi, const solveScalarField &source, const direction cmpt, const bool cgMode) const

Protected Member Functions inherited from lduMatrix::solver
virtual void	readControls ()
	Read the control parameters from the controlDict_. More...

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)
	Return a new solver. More...

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_
	Dictionary of controls. More...

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

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

scalar	tolerance_
	Final convergence tolerance. More...

scalar	relTol_
	Convergence tolerance relative to the initial. More...

profilingTrigger	profiling_

Static Protected Attributes inherited from lduMatrix::solver
static const label	defaultMaxIter_ = 1000
	Default maximum number of iterations in the solver. More...

Detailed Description

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

Reference:

    P. Ghysels, W. Vanroose.
    "Hiding global synchronization latency in the
     preconditioned Conjugate Gradient algorithm"

and implementation details from

    Paul Eller, William Gropp
    "Scalable Non-blocking Preconditioned Conjugate Gradient Methods"

Source files

Definition at line 64 of file PPCG.H.

Constructor & Destructor Documentation

◆ PPCG()

PPCG	(	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 controls.

Definition at line 259 of file PPCG.C.

◆ ~PPCG()

virtual ~PPCG ( )

virtualdefault

Destructor.

Member Function Documentation

◆ scalarSolveCG()

Foam::solverPerformance scalarSolveCG	(	solveScalarField &	psi,
		const solveScalarField &	source,
		const direction	cmpt,
		const bool	cgMode
	)		const

protected

CG solver. Operates either in conjugate-gradient mode or conjugate residual

Definition at line 82 of file PPCG.C.

References Foam::constant::atomic::alpha, beta(), SolverPerformance< Type >::checkConvergence(), Foam::expressions::patchExpr::debug, delta, Foam::endl(), SolverPerformance< Type >::finalResidual(), gamma, lduMatrix::preconditioner::getName(), Foam::Info, SolverPerformance< Type >::initialResidual(), n, lduMatrix::preconditioner::New(), SolverPerformance< Type >::nIterations(), p, UPstream::parRun(), lduMatrix::preconditioner::precondition(), psi, s, Foam::type(), and UPstream::waitRequest().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "PPCG" )

Runtime type information.

◆ solve()

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

virtual

Solve the matrix with this solver.

Implements lduMatrix::solver.

Reimplemented in PPCR.

Definition at line 283 of file PPCG.C.

References PrecisionAdaptor< Type, InputType, Container >::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/PPCG/PPCG.H
src/OpenFOAM/matrices/lduMatrix/solvers/PPCG/PPCG.C

Public Member Functions

Protected Member Functions

Additional Inherited Members