OpenFOAM logo
Open Source CFD Toolkit

lduMatrix::solverPerformance Class Reference

Collaboration diagram for lduMatrix::solverPerformance:

Collaboration graph
[legend]
List of all members.

Detailed Description

Class returned by the solver.

containing performance statistics

Definition at line 88 of file lduMatrix.H.

Public Member Functions

 solverPerformance ()
 solverPerformance (const word &solverName, const word &fieldName, const scalar iRes=0, const scalar fRes=0, const label nIter=0, const bool converged=false, const bool singular=false)
const wordsolverName () const
 Return solver name.
scalar initialResidual () const
 Return initial residual.
scalar & initialResidual ()
 Return initial residual.
scalar finalResidual () const
 Return final residual.
scalar & finalResidual ()
 Return final residual.
label nIterations () const
 Return number of iterations.
labelnIterations ()
 Return number of iterations.
bool converged () const
 Has the solver converged?
bool singular () const
 Is the matrix singular?
bool checkConvergence (const scalar tolerance, const scalar relTolerance)
 Convergence test.
bool checkSingularity (const scalar residual)
 Singularity test.
void print () const
 Print summary of solver performance.


Constructor & Destructor Documentation

solverPerformance  )  [inline]
 

Definition at line 103 of file lduMatrix.H.

References Foam::label.

solverPerformance const word solverName,
const word fieldName,
const scalar  iRes = 0,
const scalar  fRes = 0,
const label  nIter = 0,
const bool  converged = false,
const bool  singular = false
[inline]
 

Definition at line 114 of file lduMatrix.H.


Member Function Documentation

bool checkConvergence const scalar  tolerance,
const scalar  relTolerance
 

Convergence test.

bool checkSingularity const scalar  residual  ) 
 

Singularity test.

bool converged  )  const [inline]
 

Has the solver converged?

Definition at line 182 of file lduMatrix.H.

scalar& finalResidual  )  [inline]
 

Return final residual.

Definition at line 162 of file lduMatrix.H.

scalar finalResidual  )  const [inline]
 

Return final residual.

Definition at line 156 of file lduMatrix.H.

scalar& initialResidual  )  [inline]
 

Return initial residual.

Definition at line 149 of file lduMatrix.H.

scalar initialResidual  )  const [inline]
 

Return initial residual.

Definition at line 143 of file lduMatrix.H.

label& nIterations  )  [inline]
 

Return number of iterations.

Definition at line 175 of file lduMatrix.H.

label nIterations  )  const [inline]
 

Return number of iterations.

Definition at line 169 of file lduMatrix.H.

void print  )  const
 

Print summary of solver performance.

bool singular  )  const [inline]
 

Is the matrix singular?

Definition at line 188 of file lduMatrix.H.

const word& solverName  )  const [inline]
 

Return solver name.

Definition at line 137 of file lduMatrix.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org