Class returned by the solver, containing performance statistics. More...

#include <src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrix.H>

Detailed Description

Class returned by the solver, containing performance statistics.

Definition at line 90 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 word &	solverName () 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.
label &	nIterations ()
	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 105 of file lduMatrix.H.

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 116 of file lduMatrix.H.

Member Function Documentation

const word& solverName ( ) const

inline

Return solver name.

Definition at line 139 of file lduMatrix.H.

scalar initialResidual ( ) const

inline

Return initial residual.

Definition at line 145 of file lduMatrix.H.

Referenced by if(), PBiCG::solve(), PCG::solve(), smoothSolver::solve(), GAMGSolver::solve(), and fvMatrix< Type >::solve().

scalar& initialResidual ( )

inline

Return initial residual.

Definition at line 151 of file lduMatrix.H.

scalar finalResidual ( ) const

inline

Return final residual.

Definition at line 158 of file lduMatrix.H.

Referenced by PBiCG::solve(), PCG::solve(), smoothSolver::solve(), and GAMGSolver::solve().

scalar& finalResidual ( )

inline

Return final residual.

Definition at line 164 of file lduMatrix.H.

label nIterations ( ) const

inline

Return number of iterations.

Definition at line 171 of file lduMatrix.H.

Referenced by PBiCG::solve(), PCG::solve(), smoothSolver::solve(), and GAMGSolver::solve().

label& nIterations ( )

inline

Return number of iterations.

Definition at line 177 of file lduMatrix.H.

bool converged ( ) const

inline

Has the solver converged?

Definition at line 184 of file lduMatrix.H.

bool singular ( ) const

inline

Is the matrix singular?

Definition at line 190 of file lduMatrix.H.

Referenced by lduMatrix::solverPerformance::print(), and fvMatrix< Type >::solve().

bool checkConvergence	(	const scalar	tolerance,
		const scalar	relTolerance
	)

Convergence test.

Definition at line 34 of file lduMatrixTests.C.

References Foam::endl(), and Foam::Info.

Referenced by PBiCG::solve(), PCG::solve(), smoothSolver::solve(), and GAMGSolver::solve().

bool checkSingularity ( const scalar residual )

Singularity test.

Definition at line 69 of file lduMatrixTests.C.

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

void print ( ) const

Print summary of solver performance.

Definition at line 86 of file lduMatrixTests.C.

References Foam::endl(), Foam::Info, and lduMatrix::solverPerformance::singular().

Referenced by fvMatrix< Type >::fvSolver::solve(), GAMGSolver::solve(), and fvMatrix< Type >::solve().

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

src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrix.H
src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrixTests.C

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation