Public Member Functions | Static Public Attributes | Friends | List of all members
SolverPerformance Class Reference

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
 
word & solverName () noexcept
 
const word & fieldName () const noexcept
 
const Type & initialResidual () const noexcept
 
Type & initialResidual () noexcept
 
const Type & finalResidual () const noexcept
 
Type & finalResidual () noexcept
 
const labelType & nIterations () const noexcept
 
labelType & nIterations () noexcept
 
bool converged () const noexcept
 
bool singular () const
 
bool checkConvergence (const Type &tolerance, const Type &relTolerance, const int logLevel=0)
 
bool checkSingularity (const Type &residual)
 
void print (Ostream &os) const
 
void replace (const label cmpt, const SolverPerformance< typename pTraits< Type >::cmptType > &sp)
 
SolverPerformance< typename pTraits< Type >::cmptType > max ()
 
bool operator!= (const SolverPerformance< Type > &) const
 
Foam::SolverPerformance< Foam::scalar > max ()
 
SolverPerformance< scalar > max ()
 

Static Public Attributes

static const scalar great_
 
static const scalar small_
 
static const scalar vsmall_
 

Friends

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

Detailed Description

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 112 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 123 of file SolverPerformance.H.

Member Function Documentation

◆ ClassName()

ClassName ( "SolverPerformance"  )

◆ solverName() [1/2]

const word& solverName ( ) const
inlinenoexcept

Definition at line 146 of file SolverPerformance.H.

Referenced by fvMatrix< Type >::solveSegregated(), and solverInfo::updateSolverInfo().

Here is the caller graph for this function:

◆ solverName() [2/2]

word& solverName ( )
inlinenoexcept

Definition at line 152 of file SolverPerformance.H.

◆ fieldName()

const word& fieldName ( ) const
inlinenoexcept

Definition at line 159 of file SolverPerformance.H.

Referenced by data::setSolverPerformance().

Here is the caller graph for this function:

◆ initialResidual() [1/2]

const Type& initialResidual ( ) const
inlinenoexcept

Definition at line 166 of file SolverPerformance.H.

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

Here is the caller graph for this function:

◆ initialResidual() [2/2]

Type& initialResidual ( )
inlinenoexcept

Definition at line 172 of file SolverPerformance.H.

◆ finalResidual() [1/2]

const Type& finalResidual ( ) const
inlinenoexcept

Definition at line 179 of file SolverPerformance.H.

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

Here is the caller graph for this function:

◆ finalResidual() [2/2]

Type& finalResidual ( )
inlinenoexcept

Definition at line 185 of file SolverPerformance.H.

◆ nIterations() [1/2]

const labelType& nIterations ( ) const
inlinenoexcept

Definition at line 192 of file SolverPerformance.H.

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

Here is the caller graph for this function:

◆ nIterations() [2/2]

labelType& nIterations ( )
inlinenoexcept

Definition at line 198 of file SolverPerformance.H.

◆ converged()

bool converged ( ) const
inlinenoexcept

Definition at line 205 of file SolverPerformance.H.

Referenced by solverInfo::updateSolverInfo().

Here is the caller graph for this function:

◆ singular()

bool singular ( ) const

Definition at line 44 of file SolverPerformance.C.

◆ checkConvergence()

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

Definition at line 57 of file SolverPerformance.C.

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

Referenced by PCG::scalarSolve(), PBiCGStab::scalarSolve(), PPCG::scalarSolveCG(), SmoothSolver< Type, DType, LUType >::solve(), PCICG< Type, DType, LUType >::solve(), PBiCCCG< Type, DType, LUType >::solve(), PBiCICG< 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)

Definition at line 29 of file SolverPerformance.C.

References Foam::component().

Referenced by PCG::scalarSolve(), PBiCGStab::scalarSolve(), PBiCICG< Type, DType, LUType >::solve(), PCICG< Type, DType, LUType >::solve(), PBiCCCG< Type, DType, LUType >::solve(), 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

Definition at line 86 of file SolverPerformance.C.

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

Referenced by faMatrix< Type >::solve(), fvMatrix::fvSolver::solve(), GAMGSolver::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 
)

Definition at line 119 of file SolverPerformance.C.

◆ max() [1/3]

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

◆ operator!=()

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

Definition at line 150 of file SolverPerformance.C.

◆ max() [2/3]

Foam::SolverPerformance< typename Foam::pTraits< Type >::cmptType > 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

◆ operator>>

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

◆ operator

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

Member Data Documentation

◆ great_

const scalar great_
static

Definition at line 101 of file SolverPerformance.H.

Referenced by PCG::scalarSolve(), PCICG< Type, DType, LUType >::solve(), and PBiCICG< Type, DType, LUType >::solve().

◆ small_

const scalar small_
static

Definition at line 104 of file SolverPerformance.H.

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

◆ vsmall_

const scalar vsmall_
static

Definition at line 107 of file SolverPerformance.H.

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

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17