Public Member Functions | List of all members
noPreconditioner Class Reference

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

Inheritance diagram for noPreconditioner:
Inheritance graph
[legend]
Collaboration diagram for noPreconditioner:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("none")
 Runtime type information. More...
 
 noPreconditioner (const lduMatrix::solver &, const dictionary &solverControlsUnused)
 Construct from matrix components and preconditioner solver controls. More...
 
 noPreconditioner (const noPreconditioner &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~noPreconditioner ()
 Destructor. More...
 
virtual void precondition (scalarField &wA, const scalarField &rA, const direction cmpt=0) const
 Return wA the preconditioned form of residual rA. More...
 
virtual void preconditionT (scalarField &wT, const scalarField &rT, const direction cmpt=0) const
 Return wT the transpose-matrix preconditioned form of residual rT. More...
 
void operator= (const noPreconditioner &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from lduMatrix::preconditioner
virtual const word & type () const =0
 Runtime type information. More...
 
 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 ()
 Destructor. More...
 
virtual void read (const dictionary &)
 Read and reset the preconditioner parameters. More...
 

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) More...
 
static autoPtr< preconditioner > New (const solver &sol, const dictionary &solverControls)
 Return a new preconditioner. More...
 
- Protected Attributes inherited from lduMatrix::preconditioner
const solver & solver_
 Reference to the base-solver this preconditioner is used with. More...
 

Detailed Description

Null preconditioner for both symmetric and asymmetric matrices.

Source files

Definition at line 48 of file noPreconditioner.H.

Constructor & Destructor Documentation

◆ noPreconditioner() [1/2]

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

Construct from matrix components and preconditioner solver controls.

Definition at line 47 of file noPreconditioner.C.

References noPreconditioner::precondition().

Here is the call graph for this function:

◆ noPreconditioner() [2/2]

noPreconditioner ( const noPreconditioner &  )
delete

Disallow default bitwise copy construction.

◆ ~noPreconditioner()

virtual ~noPreconditioner ( )
inlinevirtual

Destructor.

Definition at line 73 of file noPreconditioner.H.

References noPreconditioner::precondition(), and noPreconditioner::preconditionT().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

Runtime type information.

◆ precondition()

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

Return wA the preconditioned form of residual rA.

Implements lduMatrix::preconditioner.

Definition at line 59 of file noPreconditioner.C.

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

Referenced by noPreconditioner::noPreconditioner(), noPreconditioner::preconditionT(), and noPreconditioner::~noPreconditioner().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ preconditionT()

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

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

Reimplemented from lduMatrix::preconditioner.

Definition at line 89 of file noPreconditioner.H.

References noPreconditioner::operator=(), and noPreconditioner::precondition().

Referenced by noPreconditioner::~noPreconditioner().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const noPreconditioner &  )
delete

Disallow default bitwise assignment.

Referenced by noPreconditioner::preconditionT().

Here is the caller graph for this function:
The documentation for this class was generated from the following files: