LduMatrix< Type, DType, LUType >::preconditioner Class Reference

Abstract base-class for LduMatrix preconditioners. More...

Inheritance diagram for LduMatrix< Type, DType, LUType >::preconditioner:

Collaboration diagram for LduMatrix< Type, DType, LUType >::preconditioner:

Public Member Functions
virtual const word &	type () const =0
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, preconditioner, symMatrix,(const solver &sol, const dictionary &preconditionerDict),(sol, preconditionerDict))
	declareRunTimeSelectionTable (autoPtr, preconditioner, asymMatrix,(const solver &sol, const dictionary &preconditionerDict),(sol, preconditionerDict))
	preconditioner (const solver &sol)
virtual	~preconditioner ()
virtual void	read (const dictionary &preconditionerDict)
	Read and reset the preconditioner parameters. More...
virtual void	precondition (Field< Type > &wA, const Field< Type > &rA) const =0
	Return wA the preconditioned form of residual rA. More...
virtual void	preconditionT (Field< Type > &wT, const Field< Type > &rT) const
	Return wT the transpose-matrix preconditioned form of. More...

Static Public Member Functions
static autoPtr< preconditioner >	New (const solver &sol, const dictionary &preconditionerDict)
	Return a new preconditioner. More...

Protected Attributes
const solver &	solver_
	Reference to the base-solver this preconditioner is used with. More...

Detailed Description

template<class Type, class DType, class LUType>
class Foam::LduMatrix< Type, DType, LUType >::preconditioner

Abstract base-class for LduMatrix preconditioners.

Definition at line 361 of file LduMatrix.H.

Constructor & Destructor Documentation

preconditioner()

preconditioner ( const solver &  sol )

inline

Definition at line 407 of file LduMatrix.H.

References LduMatrix< Type, DType, LUType >::solver::New().

Here is the call graph for this function:

~preconditioner()

virtual ~preconditioner ( )

inlinevirtual

Definition at line 427 of file LduMatrix.H.

References LduMatrix< Type, DType, LUType >::solver::read().

Here is the call graph for this function:

Member Function Documentation

type()

virtual const word& type ( ) const

pure virtual

Runtime type information.

declareRunTimeSelectionTable() [1/2]

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

declareRunTimeSelectionTable() [2/2]

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

New()

Foam::autoPtr< typename Foam::LduMatrix< Type, DType, LUType >::preconditioner > New ( const solver &  sol, const dictionary &  preconditionerDict  )

static

Return a new preconditioner.

Definition at line 33 of file LduMatrixPreconditioner.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::lookup(), and LduMatrix< Type, DType, LUType >::solver::matrix().

Here is the call graph for this function:

read()

virtual void read ( const dictionary &  preconditionerDict )

inlinevirtual

Read and reset the preconditioner parameters.

from the given dictionary

Reimplemented in DiagonalPreconditioner< Type, DType, LUType >, and NoPreconditioner< Type, DType, LUType >.

Definition at line 435 of file LduMatrix.H.

precondition()

virtual void precondition ( Field< Type > &  wA, const Field< Type > &  rA  ) const

pure virtual

Return wA the preconditioned form of residual rA.

Implemented in DiagonalPreconditioner< Type, DType, LUType >, TDILUPreconditioner< Type, DType, LUType >, and NoPreconditioner< Type, DType, LUType >.

preconditionT()

virtual void preconditionT ( Field< Type > &  wT, const Field< Type > &  rT  ) const

inlinevirtual

Return wT the transpose-matrix preconditioned form of.

residual rT. This is only required for preconditioning asymmetric matrices.

Reimplemented in DiagonalPreconditioner< Type, DType, LUType >, TDILUPreconditioner< Type, DType, LUType >, and NoPreconditioner< Type, DType, LUType >.

Definition at line 449 of file LduMatrix.H.

References LduMatrix< Type, DType, LUType >::ClassName(), LduMatrix< Type, DType, LUType >::LduMatrix(), NotImplemented, and LduMatrix< Type, DType, LUType >::~LduMatrix().

Here is the call graph for this function:

Member Data Documentation

solver_

const solver& solver_

protected

Reference to the base-solver this preconditioner is used with.

Definition at line 368 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