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

#include <LduMatrix.H>

Inheritance diagram for LduMatrix< Type, DType, LUType >::solver:

[legend]

Collaboration diagram for LduMatrix< Type, DType, LUType >::solver:

[legend]

Public Member Functions
virtual const word &	type () const =0
	Runtime type information.
	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.
virtual	~solver ()=default
	Destructor.
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.
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.
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.

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

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

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

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()

template<class Type, class DType, class LUType>

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

Construct for given field name, matrix and controls.

Definition at line 113 of file LduMatrixSolver.C.

References controlDict_, fieldName(), fieldName_, LduMatrix< Type, DType, LUType >::LduMatrix(), log_, matrix(), matrix_, maxIter_, minIter_, normType_, readControls(), relTol_, tolerance_, and Foam::Zero.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~solver()

template<class Type, class DType, class LUType>

virtual ~solver ( )

virtualdefault

Destructor.

Member Function Documentation

◆ readControls()

template<class Type, class DType, class LUType>

void readControls ( )

protectedvirtual

Read the control parameters from controlDict_.

Reimplemented in SmoothSolver< Type, DType, LUType >.

Definition at line 139 of file LduMatrixSolver.C.

References controlDict_, lduMatrix::DEFAULT_NORM, log_, maxIter_, minIter_, normType_, lduMatrix::normTypesNames_, relTol_, and tolerance_.

Referenced by read(), SmoothSolver< Type, DType, LUType >::readControls(), and solver().

Here is the caller graph for this function:

◆ readControl()

template<class Type, class DType, class LUType>

template<class T>

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::T().

Here is the call graph for this function:

◆ 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	,
		solver	,
		symMatrix	,
		(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)	,
		(fieldName, matrix, solverDict)	)

References fieldName(), LduMatrix< Type, DType, LUType >::LduMatrix(), matrix(), and solver().

Here is the call graph for this function:

◆ declareRunTimeSelectionTable() [2/2]

template<class Type, class DType, class LUType>

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

References fieldName(), LduMatrix< Type, DType, LUType >::LduMatrix(), matrix(), and solver().

Here is the call graph for this function:

◆ New()

template<class Type, class DType, class LUType>

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 29 of file LduMatrixSolver.C.

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

Referenced by fvMatrix< Type >::solveCoupled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fieldName()

template<class Type, class DType, class LUType>

const word & fieldName ( ) const

inlinenoexcept

Definition at line 282 of file LduMatrix.H.

References fieldName_, and Foam::noexcept.

Here is the caller graph for this function:

◆ matrix()

template<class Type, class DType, class LUType>

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

inlinenoexcept

Definition at line 287 of file LduMatrix.H.

References LduMatrix< Type, DType, LUType >::LduMatrix(), matrix_, and Foam::noexcept.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

template<class Type, class DType, class LUType>

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 152 of file LduMatrixSolver.C.

References controlDict_, and readControls().

Here is the call graph for this function:

◆ solve()

template<class Type, class DType, class LUType>

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

pure virtual

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

References psi.

◆ normFactor() [1/2]

template<class Type, class DType, class LUType>

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 163 of file LduMatrixSolver.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normFactor() [2/2]

template<class Type, class DType, class LUType>

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

References normFactor(), normType_, and psi.

Here is the call graph for this function:

Member Data Documentation

◆ fieldName_

template<class Type, class DType, class LUType>

word fieldName_

protected

Definition at line 142 of file LduMatrix.H.

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

◆ matrix_

template<class Type, class DType, class LUType>

const LduMatrix<Type, DType, LUType>& matrix_

protected

Definition at line 143 of file LduMatrix.H.

Referenced by matrix(), normFactor(), DiagonalSolver< Type, DType, LUType >::solve(), PBiCCCG< Type, DType, LUType >::solve(), PBiCICG< Type, DType, LUType >::solve(), PCICG< Type, DType, LUType >::solve(), SmoothSolver< Type, DType, LUType >::solve(), and solver().

◆ controlDict_

template<class Type, class DType, class LUType>

dictionary controlDict_

protected

Dictionary of solution controls.

Definition at line 148 of file LduMatrix.H.

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

◆ log_

template<class Type, class DType, class LUType>

int log_

protected

Verbosity level for solver output statements.

Definition at line 153 of file LduMatrix.H.

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

◆ minIter_

template<class Type, class DType, class LUType>

label minIter_

protected

Minimum number of iterations in the solver.

Definition at line 158 of file LduMatrix.H.

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

◆ maxIter_

template<class Type, class DType, class LUType>

label maxIter_

protected

Maximum number of iterations in the solver.

Definition at line 163 of file LduMatrix.H.

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

◆ normType_

template<class Type, class DType, class LUType>

lduMatrix::normTypes normType_

protected

The matrix normalisation type.

Definition at line 168 of file LduMatrix.H.

Referenced by normFactor(), readControls(), and solver().

◆ tolerance_

template<class Type, class DType, class LUType>

Type tolerance_

protected

Final convergence tolerance.

Definition at line 173 of file LduMatrix.H.

Referenced by readControls(), and solver().

◆ relTol_

template<class Type, class DType, class LUType>

Type relTol_

protected

Convergence tolerance relative to the initial.

Definition at line 178 of file LduMatrix.H.

Referenced by readControls(), and solver().

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

src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.H
src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrixSolver.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ solver()

◆ ~solver()

Member Function Documentation

◆ readControls()

◆ readControl()

◆ type()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New()

◆ fieldName()

◆ matrix()

◆ read()

◆ solve()

◆ normFactor() [1/2]

◆ normFactor() [2/2]

Member Data Documentation

◆ fieldName_

◆ matrix_

◆ controlDict_

◆ log_

◆ minIter_

◆ maxIter_

◆ normType_

◆ tolerance_

◆ relTol_