Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
LduMatrix< Type, DType, LUType >::solver Class Referenceabstract

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

Inheritance diagram for LduMatrix< Type, DType, LUType >::solver:
Inheritance graph
[legend]
Collaboration diagram for LduMatrix< Type, DType, LUType >::solver:
Collaboration graph
[legend]

Public Member Functions

virtual const word & type () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, solver, symMatrix,(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict),(fieldName, matrix, solverDict))
 
 declareRunTimeSelectionTable (autoPtr, solver, asymMatrix,(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict),(fieldName, matrix, solverDict))
 
 solver (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)
 Construct for given field name, matrix and controls. More...
 
virtual ~solver ()=default
 Destructor. More...
 
const word & fieldName () const noexcept
 
const LduMatrix< Type, DType, LUType > & matrix () const noexcept
 
virtual void read (const dictionary &)
 Read and reset the solver parameters from the given dictionary. More...
 
virtual SolverPerformance< Type > solve (Field< Type > &psi) const =0
 
Type normFactor (const Field< Type > &psi, const Field< Type > &Apsi, Field< Type > &tmpField, const lduMatrix::normTypes normType) const
 Return the matrix norm using the specified norm method. More...
 
Type normFactor (const Field< Type > &psi, const Field< Type > &Apsi, Field< Type > &tmpField) const
 Return the matrix norm used to normalise the residual for the stopping criterion. More...
 

Static Public Member Functions

static autoPtr< solver > New (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)
 Return a new solver. More...
 

Protected Member Functions

virtual void readControls ()
 Read the control parameters from controlDict_. More...
 
template<class T >
void readControl (const dictionary &dict, T &val, const word &key)
 Deprecated(2021-09) Read control parameter from dictionary. More...
 

Protected Attributes

word fieldName_
 
const LduMatrix< Type, DType, LUType > & matrix_
 
dictionary controlDict_
 Dictionary of solution controls. More...
 
int log_
 Verbosity level for solver output statements. More...
 
label minIter_
 Minimum number of iterations in the solver. More...
 
label maxIter_
 Maximum number of iterations in the solver. More...
 
lduMatrix::normTypes normType_
 The matrix normalisation type. More...
 
Type tolerance_
 Final convergence tolerance. More...
 
Type relTol_
 Convergence tolerance relative to the initial. More...
 

Detailed Description

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

Abstract base-class for LduMatrix solvers.

Definition at line 136 of file LduMatrix.H.

Constructor & Destructor Documentation

◆ solver()

solver ( const word &  fieldName,
const LduMatrix< Type, DType, LUType > &  matrix,
const dictionary &  solverDict 
)

Construct for given field name, matrix and controls.

Definition at line 114 of file LduMatrixSolver.C.

◆ ~solver()

virtual ~solver ( )
virtualdefault

Destructor.

Member Function Documentation

◆ readControls()

void readControls ( )
protectedvirtual

Read the control parameters from controlDict_.

Reimplemented in SmoothSolver< Type, DType, LUType >.

Definition at line 139 of file LduMatrixSolver.C.

References LduMatrix< Type, DType, LUType >::solver::controlDict_, lduMatrix::DEFAULT_NORM, LduMatrix< Type, DType, LUType >::solver::log_, LduMatrix< Type, DType, LUType >::solver::maxIter_, LduMatrix< Type, DType, LUType >::solver::minIter_, LduMatrix< Type, DType, LUType >::solver::normType_, lduMatrix::normTypesNames_, Enum< EnumType >::readIfPresent(), dictionary::readIfPresent(), LduMatrix< Type, DType, LUType >::solver::relTol_, and LduMatrix< Type, DType, LUType >::solver::tolerance_.

Here is the call graph for this function:

◆ readControl()

void readControl ( const dictionary &  dict,
T &  val,
const word &  key 
)
inlineprotected

Deprecated(2021-09) Read control parameter from dictionary.

Deprecated:
(2021-09) - use dictionary methods directly

Definition at line 197 of file LduMatrix.H.

References dict, and Foam::glTF::key().

Here is the call graph for this function:

◆ type()

virtual const word& type ( ) const
pure virtual

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( autoPtr  ,
solver  ,
symMatrix  ,
(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)  ,
(fieldName, matrix, solverDict)   
)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( autoPtr  ,
solver  ,
asymMatrix  ,
(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)  ,
(fieldName, matrix, solverDict)   
)

◆ New()

Foam::autoPtr< typename Foam::LduMatrix< Type, DType, LUType >::solver > New ( const word &  fieldName,
const LduMatrix< Type, DType, LUType > &  matrix,
const dictionary &  solverDict 
)
static

Return a new solver.

Definition at line 30 of file LduMatrixSolver.C.

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

Here is the call graph for this function:

◆ fieldName()

const word& fieldName ( ) const
inlinenoexcept

Definition at line 282 of file LduMatrix.H.

References LduMatrix< Type, DType, LUType >::solver::fieldName_.

◆ matrix()

const LduMatrix<Type, DType, LUType>& matrix ( ) const
inlinenoexcept

Definition at line 287 of file LduMatrix.H.

References LduMatrix< Type, DType, LUType >::solver::matrix_.

Referenced by LduMatrix< Type, DType, LUType >::preconditioner::New(), and TDILUPreconditioner< Type, DType, LUType >::TDILUPreconditioner().

Here is the caller graph for this function:

◆ read()

void read ( const dictionary &  solverDict)
virtual

Read and reset the solver parameters from the given dictionary.

Reimplemented in DiagonalSolver< Type, DType, LUType >.

Definition at line 153 of file LduMatrixSolver.C.

◆ solve()

virtual SolverPerformance<Type> solve ( Field< Type > &  psi) const
pure virtual

Implemented in PBiCCCG< Type, DType, LUType >, PBiCICG< Type, DType, LUType >, PCICG< Type, DType, LUType >, DiagonalSolver< Type, DType, LUType >, and SmoothSolver< Type, DType, LUType >.

◆ normFactor() [1/2]

Type normFactor ( const Field< Type > &  psi,
const Field< Type > &  Apsi,
Field< Type > &  tmpField,
const lduMatrix::normTypes  normType 
) const

Return the matrix norm using the specified norm method.

Definition at line 164 of file LduMatrixSolver.C.

References Foam::cmptMag(), Foam::cmptMultiply(), lduMatrix::DEFAULT_NORM, Foam::gAverage(), Foam::gSum(), lduMatrix::L1_SCALED_NORM, lduMatrix::NO_NORM, psi, and Foam::stabilise().

Referenced by LduMatrix< Type, DType, LUType >::solver::normFactor().

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

◆ normFactor() [2/2]

Type normFactor ( const Field< Type > &  psi,
const Field< Type > &  Apsi,
Field< Type > &  tmpField 
) const
inline

Return the matrix norm used to normalise the residual for the stopping criterion.

Definition at line 319 of file LduMatrix.H.

References LduMatrix< Type, DType, LUType >::solver::normFactor(), and LduMatrix< Type, DType, LUType >::solver::normType_.

Here is the call graph for this function:

Member Data Documentation

◆ fieldName_

word fieldName_
protected

Definition at line 142 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::fieldName().

◆ matrix_

const LduMatrix<Type, DType, LUType>& matrix_
protected

Definition at line 143 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::matrix().

◆ controlDict_

dictionary controlDict_
protected

Dictionary of solution controls.

Definition at line 148 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::readControls().

◆ log_

int log_
protected

Verbosity level for solver output statements.

Definition at line 153 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::readControls().

◆ minIter_

label minIter_
protected

Minimum number of iterations in the solver.

Definition at line 158 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::readControls().

◆ maxIter_

label maxIter_
protected

Maximum number of iterations in the solver.

Definition at line 163 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::readControls().

◆ normType_

lduMatrix::normTypes normType_
protected

The matrix normalisation type.

Definition at line 168 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::normFactor(), and LduMatrix< Type, DType, LUType >::solver::readControls().

◆ tolerance_

Type tolerance_
protected

Final convergence tolerance.

Definition at line 173 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::readControls().

◆ relTol_

Type relTol_
protected

Convergence tolerance relative to the initial.

Definition at line 178 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::readControls().

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