noPreconditioner Class Reference

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

#include <noPreconditioner.H>

Inheritance diagram for noPreconditioner:

Collaboration diagram for noPreconditioner:

Public Member Functions
	TypeName ("none")
	Runtime type information.
	noPreconditioner (const lduMatrix::solver &, const dictionary &solverControlsUnused)
	Construct from matrix components and preconditioner solver controls.
virtual	~noPreconditioner ()=default
	Destructor.
virtual void	precondition (solveScalarField &wA, const solveScalarField &rA, const direction cmpt=0) const
	Return wA the preconditioned form of residual rA.
virtual void	preconditionT (solveScalarField &wT, const solveScalarField &rT, const direction cmpt=0) const
	Return wT the transpose-matrix preconditioned form of residual rT.
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	setFinished (const solverPerformance &perf) const
	Signal end of solver.

Additional Inherited Members
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.
Protected Attributes inherited from lduMatrix::preconditioner
const solver &	solver_
	Reference to the base-solver this preconditioner is used with.

Detailed Description

Null preconditioner for both symmetric and asymmetric matrices.

Source files

• noPreconditioner.H
• noPreconditioner.C

Definition at line 50 of file noPreconditioner.H.

Constructor & Destructor Documentation

noPreconditioner()

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

Construct from matrix components and preconditioner solver controls.

Definition at line 42 of file noPreconditioner.C.

References lduMatrix::preconditioner::preconditioner().

Here is the call graph for this function:

~noPreconditioner()

virtual ~noPreconditioner ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"none"

)

Runtime type information.

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 54 of file noPreconditioner.C.

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

Referenced by preconditionT().

Here is the call graph for this function:

Here is the caller graph for this function:

preconditionT()

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

inlinevirtual

Return wT the transpose-matrix preconditioned form of residual rT.

Reimplemented from lduMatrix::preconditioner.

Definition at line 108 of file noPreconditioner.H.

References precondition().

Here is the call graph for this function:

---

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

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