lduMatrix::preconditioner Class Reference

Inheritance diagram for lduMatrix::preconditioner:

Collaboration diagram for lduMatrix::preconditioner:

Public Member Functions
virtual const word &	type () const =0
	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)
virtual	~preconditioner ()=default
virtual void	read (const dictionary &)
virtual void	precondition (solveScalarField &wA, const solveScalarField &rA, const direction cmpt=0) const =0
virtual void	preconditionT (solveScalarField &wT, const solveScalarField &rT, const direction cmpt=0) const

Static Public Member Functions
static word	getName (const dictionary &)
static autoPtr< preconditioner >	New (const solver &sol, const dictionary &solverControls)

Protected Attributes
const solver &	solver_

Detailed Description

Definition at line 429 of file lduMatrix.H.

Constructor & Destructor Documentation

preconditioner()

preconditioner ( const solver &  sol )

inline

Definition at line 478 of file lduMatrix.H.

~preconditioner()

virtual ~preconditioner ( )

virtualdefault

Member Function Documentation

getName()

Foam::word getName ( const dictionary &  solverControls )

static

Definition at line 36 of file lduMatrixPreconditioner.C.

References Foam::constant::electromagnetic::e, dictionary::lookupEntry(), and Foam::name().

Referenced by PPCG::scalarSolveCG().

Here is the call graph for this function:

Here is the caller graph for this function:

type()

virtual const word& type ( ) const

pure virtual

declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		preconditioner	,
		symMatrix	,
		(const solver &sol, const dictionary &solverControls)	,
		(sol, solverControls)
	)

declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		preconditioner	,
		asymMatrix	,
		(const solver &sol, const dictionary &solverControls)	,
		(sol, solverControls)
	)

New()

Foam::autoPtr< Foam::lduMatrix::preconditioner > New ( const solver &  sol, const dictionary &  solverControls  )

static

Definition at line 61 of file lduMatrixPreconditioner.C.

References lduMatrix::asymmetric(), Foam::constant::electromagnetic::e, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FatalIOErrorInLookup, dictionary::lookupEntry(), lduMatrix::solver::matrix(), Foam::name(), and lduMatrix::symmetric().

Referenced by PPCG::scalarSolveCG().

Here is the call graph for this function:

Here is the caller graph for this function:

read()

virtual void read ( const dictionary &  )

inlinevirtual

Definition at line 504 of file lduMatrix.H.

precondition()

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

pure virtual

Implemented in FDICPreconditioner, diagonalPreconditioner, GAMGPreconditioner, DICPreconditioner, DILUPreconditioner, and noPreconditioner.

preconditionT()

virtual void preconditionT ( solveScalarField &  wT, const solveScalarField &  rT, const direction  cmpt = 0  ) const

inlinevirtual

Reimplemented in diagonalPreconditioner, DILUPreconditioner, and noPreconditioner.

Definition at line 519 of file lduMatrix.H.

References NotImplemented.

Member Data Documentation

solver_

const solver& solver_

protected

Definition at line 436 of file lduMatrix.H.

---

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

• src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrix.H
• src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrixPreconditioner.C