Incomplete Cholesky preconditioned CG solver derived from the general preconditioned CG solver PCG but with the choice of preconditioner pre-selected. More...

Inheritance diagram for ICCG:

[legend]

Collaboration diagram for ICCG:

[legend]

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

	ICCG (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 data stream. More...

	ICCG (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const scalar tolerance, const scalar relTol=0.0)
	Construct from matrix components and tolerances. More...

virtual	~ICCG ()
	Destructor. More...

Public Member Functions inherited from PCG
	TypeName ("PCG")
	Runtime type information. More...

	PCG (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	~PCG ()
	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 ()
	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...

scalar	normFactor (const scalarField &psi, const scalarField &source, const scalarField &Apsi, scalarField &tmpField) const
	Return the matrix norm used to normalise the residual for the. More...

Static Public Member Functions
static dictionary	solverDict (const scalar tol, const scalar relTol)
	Return the dictionary constructed from the components. More...

static dictionary	solverDict (Istream &)
	Return the dictionary constructed from the old-style data-stream. More...

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...

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

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

Additional Inherited Members
Protected Member Functions inherited from lduMatrix::solver
virtual void	readControls ()
	Read the control parameters from the controlDict_. 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...

Detailed Description

Incomplete Cholesky preconditioned CG solver derived from the general preconditioned CG solver PCG but with the choice of preconditioner pre-selected.

Deprecated:: This solver is present for backward-compatibility and the PCG solver should be used for preference. (deprecated Apr 2008)

Source files

Definition at line 54 of file ICCG.H.

Constructor & Destructor Documentation

◆ ICCG() [1/3]

ICCG ( const ICCG & )

private

Disallow default bitwise copy construct.

◆ ICCG() [2/3]

ICCG	(	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 data stream.

Definition at line 68 of file ICCG.C.

◆ ICCG() [3/3]

ICCG	(	const word &	fieldName,
		const lduMatrix &	matrix,
		const FieldField< Field, scalar > &	interfaceBouCoeffs,
		const FieldField< Field, scalar > &	interfaceIntCoeffs,
		const lduInterfaceFieldPtrsList &	interfaces,
		const scalar	tolerance,
		const scalar	relTol = `0.0`
	)

Construct from matrix components and tolerances.

Definition at line 90 of file ICCG.C.

◆ ~ICCG()

virtual ~ICCG ( )

inlinevirtual

Destructor.

Definition at line 111 of file ICCG.H.

Member Function Documentation

◆ operator=()

void operator= ( const ICCG & )

private

Disallow default bitwise assignment.

◆ solverDict() [1/2]

Foam::dictionary solverDict	(	const scalar	tol,
		const scalar	relTol
	)

static

Return the dictionary constructed from the components.

Needed for backward compatibility

Definition at line 41 of file ICCG.C.

References dict.

Referenced by solution::upgradeSolverDict().

Here is the caller graph for this function:

◆ solverDict() [2/2]

Foam::dictionary solverDict ( Istream & is )

static

Return the dictionary constructed from the old-style data-stream.

Needed for backward compatibility

Definition at line 55 of file ICCG.C.

References readScalar.

◆ TypeName()

TypeName ( "ICCG" )

Runtime type information.

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

src/OpenFOAM/matrices/lduMatrix/solvers/ICCG/ICCG.H
src/OpenFOAM/matrices/lduMatrix/solvers/ICCG/ICCG.C

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members