DICPreconditioner Class Reference

Simplified diagonal-based incomplete Cholesky preconditioner for symmetric matrices (symmetric equivalent of DILU). The reciprocal of the preconditioned diagonal is calculated and stored. More...

#include <DICPreconditioner.H>

Inheritance diagram for DICPreconditioner:

Collaboration diagram for DICPreconditioner:

Public Member Functions
	TypeName ("DIC")
	Runtime type information.
	DICPreconditioner (const lduMatrix::solver &, const dictionary &solverControlsUnused)
	Construct from matrix components and preconditioner solver controls.
virtual	~DICPreconditioner ()=default
	Destructor.
virtual void	precondition (solveScalarField &wA, const solveScalarField &rA, const direction cmpt=0) const
	Return wA the preconditioned form of residual rA.
Public Member Functions inherited from lduMatrix::preconditioner
virtual const word &	type () const =0
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, preconditioner, symMatrix,(const solver &sol, const dictionary &solverControls),(sol, solverControls))
	declareRunTimeSelectionTable (autoPtr, preconditioner, asymMatrix,(const solver &sol, const dictionary &solverControls),(sol, solverControls))
	preconditioner (const solver &sol)
	Construct for given solver.
virtual	~preconditioner ()=default
	Destructor.
virtual void	read (const dictionary &)
	Read and reset the preconditioner parameters from the given stream.
virtual void	preconditionT (solveScalarField &wT, const solveScalarField &rT, const direction cmpt=0) const
	Return wT the transpose-matrix preconditioned form of residual rT.
virtual void	setFinished (const solverPerformance &perf) const
	Signal end of solver.

Static Public Member Functions
static void	calcReciprocalD (solveScalarField &, const lduMatrix &)
	Calculate the reciprocal of the preconditioned diagonal.
Static Public Member Functions inherited from lduMatrix::preconditioner
static word	getName (const dictionary &)
	Find the preconditioner name (directly or from a sub-dictionary).
static autoPtr< preconditioner >	New (const solver &sol, const dictionary &solverControls)
	Return a new preconditioner.

Additional Inherited Members
Protected Attributes inherited from lduMatrix::preconditioner
const solver &	solver_
	Reference to the base-solver this preconditioner is used with.

Detailed Description

Simplified diagonal-based incomplete Cholesky preconditioner for symmetric matrices (symmetric equivalent of DILU). The reciprocal of the preconditioned diagonal is calculated and stored.

Source files

• DICPreconditioner.H
• DICPreconditioner.C

Definition at line 52 of file DICPreconditioner.H.

Constructor & Destructor Documentation

DICPreconditioner()

DICPreconditioner	(	const lduMatrix::solver &	sol,
		const dictionary &	solverControlsUnused )

Construct from matrix components and preconditioner solver controls.

Definition at line 39 of file DICPreconditioner.C.

References calcReciprocalD(), Foam::diag(), lduMatrix::solver::matrix(), and lduMatrix::preconditioner::preconditioner().

Here is the call graph for this function:

~DICPreconditioner()

virtual ~DICPreconditioner ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"DIC"

)

Runtime type information.

calcReciprocalD()

void calcReciprocalD ( solveScalarField & rD, const lduMatrix & matrix )

static

Calculate the reciprocal of the preconditioned diagonal.

Definition at line 57 of file DICPreconditioner.C.

References UList< T >::begin(), lduMatrix::lduAddr(), lduAddressing::lowerAddr(), UList< T >::size(), lduMatrix::upper(), and lduAddressing::upperAddr().

Referenced by DICPreconditioner(), DICSmoother::DICSmoother(), and FDICSmoother::FDICSmoother().

Here is the call graph for this function:

Here is the caller graph for this function:

precondition()

void precondition ( solveScalarField & wA, const solveScalarField & rA, const direction cmpt = 0 ) const

virtual

Return wA the preconditioned form of residual rA.

Implements lduMatrix::preconditioner.

Definition at line 87 of file DICPreconditioner.C.

References UList< T >::begin(), UList< T >::size(), and lduMatrix::preconditioner::solver_.

Here is the call graph for this function:

---

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

• src/OpenFOAM/matrices/lduMatrix/preconditioners/DICPreconditioner/DICPreconditioner.H
• src/OpenFOAM/matrices/lduMatrix/preconditioners/DICPreconditioner/DICPreconditioner.C