Diagonal preconditioner for both symmetric and asymmetric matrices. More...

Inheritance diagram for DiagonalPreconditioner< Type, DType, LUType >:

Collaboration diagram for DiagonalPreconditioner< Type, DType, LUType >:

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

	DiagonalPreconditioner (const typename LduMatrix< Type, DType, LUType >::solver &sol, const dictionary &preconditionerDict)
	Construct from matrix components and preconditioner data dictionary. More...

	DiagonalPreconditioner (const DiagonalPreconditioner &)=delete
	Disallow default bitwise copy construction. More...

virtual	~DiagonalPreconditioner ()

virtual void	read (const dictionary &preconditionerDict)
	Read and reset the preconditioner parameters from the given. More...

virtual void	precondition (Field< Type > &wA, const Field< Type > &rA) const
	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...

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

Public Member Functions inherited from LduMatrix< Type, DType, LUType >::preconditioner
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 ()

Additional Inherited Members
Static Public Member Functions inherited from LduMatrix< Type, DType, LUType >::preconditioner
static autoPtr< preconditioner >	New (const solver &sol, const dictionary &preconditionerDict)
	Return a new preconditioner. More...

Protected Attributes inherited from LduMatrix< Type, DType, LUType >::preconditioner
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::DiagonalPreconditioner< Type, DType, LUType >

Diagonal preconditioner for both symmetric and asymmetric matrices.

The inverse (reciprocal for scalar) of the diagonal is calculated and stored.

Source files

Definition at line 52 of file DiagonalPreconditioner.H.

Constructor & Destructor Documentation

◆ DiagonalPreconditioner() [1/2]

DiagonalPreconditioner	(	const typename LduMatrix< Type, DType, LUType >::solver &	sol,
		const dictionary &	preconditionerDict
	)

Construct from matrix components and preconditioner data dictionary.

Definition at line 31 of file DiagonalPreconditioner.C.

References UList< T >::begin(), Foam::inv(), LduMatrix< Type, DType, LUType >::solver::matrix(), List< T >::size(), and LduMatrix< Type, DType, LUType >::preconditioner::solver_.

Here is the call graph for this function:

◆ DiagonalPreconditioner() [2/2]

DiagonalPreconditioner ( const DiagonalPreconditioner< Type, DType, LUType > & )

delete

Disallow default bitwise copy construction.

◆ ~DiagonalPreconditioner()

virtual ~DiagonalPreconditioner ( )

inlinevirtual

Definition at line 83 of file DiagonalPreconditioner.H.

Member Function Documentation

◆ TypeName()

TypeName ( "diagonal" )

Runtime type information.

◆ read()

void read ( const dictionary & preconditionerDict )

virtual

Read and reset the preconditioner parameters from the given.

dictionary

Reimplemented from LduMatrix< Type, DType, LUType >::preconditioner.

Definition at line 56 of file DiagonalPreconditioner.C.

◆ precondition()

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

virtual

Return wA the preconditioned form of residual rA.

Implements LduMatrix< Type, DType, LUType >::preconditioner.

Definition at line 61 of file DiagonalPreconditioner.C.

References UList< T >::begin(), Foam::dot(), and List< T >::size().

Here is the call graph for this function:

◆ preconditionT()

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

inlinevirtual

Return wT the transpose-matrix preconditioned form of.

residual rT.

Reimplemented from LduMatrix< Type, DType, LUType >::preconditioner.

Definition at line 102 of file DiagonalPreconditioner.H.

◆ operator=()

void operator= ( const DiagonalPreconditioner< Type, DType, LUType > & )