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

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

#include <LduMatrix.H>

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.
	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)
	Construct for given solver.
virtual	~preconditioner ()=default
	Destructor.
virtual void	read (const dictionary &)
	Read and reset the preconditioner parameters from the given dictionary.
virtual void	precondition (Field< Type > &wA, const Field< Type > &rA) const =0
	Return wA the preconditioned form of residual rA.
virtual void	preconditionT (Field< Type > &wT, const Field< Type > &rT) const
	Return wT the transpose-matrix preconditioned form of residual rT.

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

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

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 444 of file LduMatrix.H.

Constructor & Destructor Documentation

preconditioner()

template<class Type, class DType, class LUType>

preconditioner ( const solver & sol )

inline

Construct for given solver.

Definition at line 496 of file LduMatrix.H.

References solver_.

Referenced by declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), DiagonalPreconditioner< Type, DType, LUType >::DiagonalPreconditioner(), NoPreconditioner< Type, DType, LUType >::NoPreconditioner(), and TDILUPreconditioner< Type, DType, LUType >::TDILUPreconditioner().

Here is the caller graph for this function:

~preconditioner()

template<class Type, class DType, class LUType>

virtual ~preconditioner ( )

virtualdefault

Destructor.

Member Function Documentation

type()

template<class Type, class DType, class LUType>

virtual const word & type ( ) const

pure virtual

Runtime type information.

declareRunTimeSelectionTable() [1/2]

template<class Type, class DType, class LUType>

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

References preconditioner().

Here is the call graph for this function:

declareRunTimeSelectionTable() [2/2]

template<class Type, class DType, class LUType>

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

References preconditioner().

Here is the call graph for this function:

New()

template<class Type, class DType, class LUType>

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

static

Return a new preconditioner.

Definition at line 28 of file LduMatrixPreconditioner.C.

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

Referenced by PBiCCCG< Type, DType, LUType >::solve(), PBiCICG< Type, DType, LUType >::solve(), and PCICG< Type, DType, LUType >::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

read()

template<class Type, class DType, class LUType>

virtual void read ( const dictionary & )

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 526 of file LduMatrix.H.

precondition()

template<class Type, class DType, class LUType>

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 >, NoPreconditioner< Type, DType, LUType >, and TDILUPreconditioner< Type, DType, LUType >.

preconditionT()

template<class Type, class DType, class LUType>

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 >, NoPreconditioner< Type, DType, LUType >, and TDILUPreconditioner< Type, DType, LUType >.

Definition at line 544 of file LduMatrix.H.

References NotImplemented.

Member Data Documentation

solver_

template<class Type, class DType, class LUType>

const solver& solver_

protected

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

Definition at line 453 of file LduMatrix.H.

Referenced by DiagonalPreconditioner< Type, DType, LUType >::DiagonalPreconditioner(), TDILUPreconditioner< Type, DType, LUType >::precondition(), preconditioner(), and TDILUPreconditioner< Type, DType, LUType >::preconditionT().

---

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