SolverPerformance is the class returned by the LduMatrix solver containing performance statistics. More...

Public Member Functions
	ClassName ("SolverPerformance")

	SolverPerformance ()

	SolverPerformance (const word &solverName, const word &fieldName, const Type &iRes=pTraits< Type >::zero, const Type &fRes=pTraits< Type >::zero, const labelType &nIter=pTraits< labelType >::zero, const bool converged=false, const bool singular=false)

const word &	solverName () const noexcept
	Return solver name. More...

word &	solverName () noexcept
	Return solver name. More...

const word &	fieldName () const noexcept
	Return field name. More...

const Type &	initialResidual () const noexcept
	Return initial residual. More...

Type &	initialResidual () noexcept
	Return initial residual. More...

const Type &	finalResidual () const noexcept
	Return final residual. More...

Type &	finalResidual () noexcept
	Return final residual. More...

const labelType &	nIterations () const noexcept
	Return number of iterations. More...

labelType &	nIterations () noexcept
	Return number of iterations. More...

bool	converged () const noexcept
	Has the solver converged? More...

bool	singular () const
	Is the matrix singular? More...

bool	checkConvergence (const Type &tolerance, const Type &relTolerance, const int logLevel=0)
	Check, store and return convergence. More...

bool	checkSingularity (const Type &residual)
	Singularity test. More...

void	print (Ostream &os) const
	Print summary of solver performance to the given stream. More...

void	replace (const label cmpt, const SolverPerformance< typename pTraits< Type >::cmptType > &sp)
	Replace component based on the minimal SolverPerformance. More...

SolverPerformance< typename pTraits< Type >::cmptType >	max ()
	Return the summary maximum of SolverPerformance<Type> More...

bool	operator!= (const SolverPerformance< Type > &) const

template<>
Foam::SolverPerformance< Foam::scalar >	max ()

template<>
SolverPerformance< scalar >	max ()

Static Public Attributes
static const scalar	great_
	Large Type for the use in solvers. More...

static const scalar	small_
	Small Type for the use in solvers. More...

static const scalar	vsmall_
	Very small Type for the use in solvers. More...

Friends
SolverPerformance< Type >	Foam::max (const SolverPerformance< Type > &, const SolverPerformance< Type > &)
	Return the element-wise maximum of two SolverPerformance<Type>s. More...

Istream &	operator>> (Istream &, SolverPerformance< Type > &)

Ostream &	operator (Ostream &, const SolverPerformance< Type > &)

Detailed Description

template<class Type>
class Foam::SolverPerformance< Type >

SolverPerformance is the class returned by the LduMatrix solver containing performance statistics.

Source files

Definition at line 48 of file SolverPerformance.H.

Constructor & Destructor Documentation

◆ SolverPerformance() [1/2]

SolverPerformance ( )

inline

Definition at line 118 of file SolverPerformance.H.

◆ SolverPerformance() [2/2]

SolverPerformance	(	const word &	solverName,
		const word &	fieldName,
		const Type &	iRes = `pTraits<Type>::zero`,
		const Type &	fRes = `pTraits<Type>::zero`,
		const labelType &	nIter = `pTraits<labelType>::zero`,
		const bool	converged = `false`,
		const bool	singular = `false`
	)

inline

Definition at line 129 of file SolverPerformance.H.

Member Function Documentation

◆ ClassName()

ClassName ( "SolverPerformance< Type >" )

◆ solverName() [1/2]

const word& solverName ( ) const

inlinenoexcept

Return solver name.

Definition at line 154 of file SolverPerformance.H.

Referenced by faMatrix< Type >::solve(), and fvMatrix< Type >::solveSegregated().

Here is the caller graph for this function:

◆ solverName() [2/2]

word& solverName ( )

inlinenoexcept

Return solver name.

Definition at line 162 of file SolverPerformance.H.

◆ fieldName()

const word& fieldName ( ) const

inlinenoexcept

Return field name.

Definition at line 171 of file SolverPerformance.H.

Referenced by data::setSolverPerformance().

Here is the caller graph for this function:

◆ initialResidual() [1/2]

const Type& initialResidual ( ) const

inlinenoexcept

Return initial residual.

Definition at line 180 of file SolverPerformance.H.

Referenced by radiativeIntensityRay::correct(), PCG::scalarSolve(), PBiCGStab::scalarSolve(), PPCG::scalarSolveCG(), SmoothSolver< Type, DType, LUType >::solve(), PBiCG::solve(), smoothSolver::solve(), and GAMGSolver::solve().

Here is the caller graph for this function:

◆ initialResidual() [2/2]

Type& initialResidual ( )

inlinenoexcept

Return initial residual.

Definition at line 188 of file SolverPerformance.H.

◆ finalResidual() [1/2]

const Type& finalResidual ( ) const

inlinenoexcept

Return final residual.

Definition at line 197 of file SolverPerformance.H.

Referenced by PCG::scalarSolve(), PBiCGStab::scalarSolve(), PPCG::scalarSolveCG(), SmoothSolver< Type, DType, LUType >::solve(), PBiCG::solve(), smoothSolver::solve(), and GAMGSolver::solve().

Here is the caller graph for this function:

◆ finalResidual() [2/2]

Type& finalResidual ( )

inlinenoexcept

Return final residual.

Definition at line 205 of file SolverPerformance.H.

◆ nIterations() [1/2]

const labelType& nIterations ( ) const

inlinenoexcept

Return number of iterations.

Definition at line 214 of file SolverPerformance.H.

Referenced by PCG::scalarSolve(), PBiCGStab::scalarSolve(), PPCG::scalarSolveCG(), SmoothSolver< Type, DType, LUType >::solve(), PBiCG::solve(), smoothSolver::solve(), and GAMGSolver::solve().

Here is the caller graph for this function:

◆ nIterations() [2/2]

labelType& nIterations ( )

inlinenoexcept

Return number of iterations.

Definition at line 222 of file SolverPerformance.H.

◆ converged()

bool converged ( ) const

inlinenoexcept

Has the solver converged?

Definition at line 231 of file SolverPerformance.H.

◆ singular()

bool singular ( ) const

Is the matrix singular?

Definition at line 44 of file SolverPerformance.C.

◆ checkConvergence()

bool checkConvergence	(	const Type &	tolerance,
		const Type &	relTolerance,
		const int	logLevel = `0`
	)

Check, store and return convergence.

Definition at line 57 of file SolverPerformance.C.

References Foam::cmptMultiply(), Foam::ensightOutput::debug, Foam::endl(), and Foam::Info.

Referenced by PCG::scalarSolve(), PBiCGStab::scalarSolve(), PPCG::scalarSolveCG(), SmoothSolver< Type, DType, LUType >::solve(), PBiCG::solve(), smoothSolver::solve(), and GAMGSolver::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkSingularity()

bool checkSingularity ( const Type & residual )

Singularity test.

Definition at line 29 of file SolverPerformance.C.

References Foam::component().

Referenced by PCG::scalarSolve(), PBiCGStab::scalarSolve(), and PBiCG::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print()

void print ( Ostream & os ) const

Print summary of solver performance to the given stream.

Definition at line 86 of file SolverPerformance.C.

References Foam::component(), Foam::endl(), and os().

Referenced by viewFactor::calculate(), fvMatrix< Type >::fvSolver::solve(), GAMGSolver::solve(), faMatrix< Type >::solve(), fvMatrix< Type >::solveCoupled(), and fvMatrix< Type >::solveSegregated().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ replace()

void replace	(	const label	cmpt,
		const SolverPerformance< typename pTraits< Type >::cmptType > &	sp
	)

Replace component based on the minimal SolverPerformance.

Definition at line 119 of file SolverPerformance.C.

◆ max() [1/3]

Foam::SolverPerformance< typename Foam::pTraits< Type >::cmptType > max ( )

Return the summary maximum of SolverPerformance<Type>

Effectively it will mostly return solverPerformanceScalar

Definition at line 133 of file SolverPerformance.C.

References Foam::cmptMax().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const SolverPerformance< Type > & sp ) const

Definition at line 150 of file SolverPerformance.C.

◆ max() [2/3]

Foam::SolverPerformance< Foam::scalar > max ( )

Definition at line 36 of file solverPerformance.C.

◆ max() [3/3]

SolverPerformance< scalar > max ( )

Friends And Related Function Documentation

◆ Foam::max

SolverPerformance<Type> Foam::max	(	const SolverPerformance< Type > &	,
		const SolverPerformance< Type > &
	)

friend

Return the element-wise maximum of two SolverPerformance<Type>s.

◆ operator>>

Istream& operator>>	(	Istream &	,
		SolverPerformance< Type > &
	)

friend

◆ operator

Ostream& operator	(	Ostream &	,
		const SolverPerformance< Type > &
	)

friend

Member Data Documentation

◆ great_

const scalar great_

static

Large Type for the use in solvers.

Definition at line 103 of file SolverPerformance.H.

Referenced by PCG::scalarSolve().

◆ small_

const scalar small_

static

Small Type for the use in solvers.

Definition at line 108 of file SolverPerformance.H.

Referenced by lduMatrix::solver::normFactor().

◆ vsmall_

const scalar vsmall_

static

Very small Type for the use in solvers.

Definition at line 113 of file SolverPerformance.H.

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

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

Public Member Functions

Static Public Attributes

Friends

Detailed Description

template<class Type> class Foam::SolverPerformance< Type >

Constructor & Destructor Documentation

◆ SolverPerformance() [1/2]

◆ SolverPerformance() [2/2]

Member Function Documentation

◆ ClassName()

◆ solverName() [1/2]

◆ solverName() [2/2]

◆ fieldName()

◆ initialResidual() [1/2]

◆ initialResidual() [2/2]

◆ finalResidual() [1/2]

◆ finalResidual() [2/2]

◆ nIterations() [1/2]

◆ nIterations() [2/2]

◆ converged()

◆ singular()

◆ checkConvergence()

◆ checkSingularity()

◆ print()

◆ replace()

◆ max() [1/3]

◆ operator!=()

◆ max() [2/3]

◆ max() [3/3]

Friends And Related Function Documentation

◆ Foam::max

◆ operator>>

◆ operator

Member Data Documentation

◆ great_

◆ small_

◆ vsmall_

template<class Type>
class Foam::SolverPerformance< Type >