dune-istl: Dune::InverseOperatorResult Struct Reference

dune-istl 2.2.0

Statistics about the application of an inverse operator. More...

#include <dune/istl/solvers.hh>

List of all members.

Public Member Functions
	InverseOperatorResult ()
	Default constructor.
void	clear ()
	Resets all data.
Public Attributes
int	iterations
	Number of iterations.
double	reduction
	Reduction achieved: $\\|b-A(x^n)\\|/\\|b-A(x^0)\\|$ .
bool	converged
	True if convergence criterion has been met.
double	conv_rate
	Convergence rate (average reduction per step)
double	elapsed
	Elapsed time in seconds.

Detailed Description

Statistics about the application of an inverse operator.

The return value of an application of the inverse operator delivers some important information about the iteration.

Constructor & Destructor Documentation

Dune::InverseOperatorResult::InverseOperatorResult ( ) [inline]

Default constructor.

References clear().

Member Function Documentation

void Dune::InverseOperatorResult::clear ( ) [inline]

Resets all data.

References conv_rate, converged, elapsed, iterations, and reduction.

Referenced by Dune::LoopSolver< X >::apply(), Dune::GradientSolver< X >::apply(), Dune::CGSolver< X >::apply(), Dune::BiCGSTABSolver< X >::apply(), Dune::MINRESSolver< X >::apply(), Dune::RestartedGMResSolver< X, Y, F >::apply(), and InverseOperatorResult().

Member Data Documentation

double Dune::InverseOperatorResult::conv_rate

Convergence rate (average reduction per step)

Referenced by Dune::LoopSolver< X >::apply(), Dune::GradientSolver< X >::apply(), Dune::CGSolver< X >::apply(), Dune::BiCGSTABSolver< X >::apply(), Dune::MINRESSolver< X >::apply(), Dune::RestartedGMResSolver< X, Y, F >::apply(), and clear().

bool Dune::InverseOperatorResult::converged

True if convergence criterion has been met.

Referenced by Dune::LoopSolver< X >::apply(), Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >::apply(), Dune::GradientSolver< X >::apply(), Dune::CGSolver< X >::apply(), Dune::BiCGSTABSolver< X >::apply(), Dune::MINRESSolver< X >::apply(), Dune::RestartedGMResSolver< X, Y, F >::apply(), and clear().

double Dune::InverseOperatorResult::elapsed

Elapsed time in seconds.

Referenced by Dune::LoopSolver< X >::apply(), Dune::GradientSolver< X >::apply(), Dune::CGSolver< X >::apply(), Dune::BiCGSTABSolver< X >::apply(), Dune::MINRESSolver< X >::apply(), Dune::RestartedGMResSolver< X, Y, F >::apply(), and clear().

int Dune::InverseOperatorResult::iterations

Number of iterations.

Referenced by Dune::LoopSolver< X >::apply(), Dune::SuperLU< BCRSMatrix< FieldMatrix< T, n, m >, A > >::apply(), Dune::GradientSolver< X >::apply(), Dune::CGSolver< X >::apply(), Dune::BiCGSTABSolver< X >::apply(), Dune::MINRESSolver< X >::apply(), Dune::RestartedGMResSolver< X, Y, F >::apply(), and clear().

double Dune::InverseOperatorResult::reduction

Reduction achieved: $\|b-A(x^n)\|/\|b-A(x^0)\|$ .

Referenced by Dune::LoopSolver< X >::apply(), Dune::GradientSolver< X >::apply(), Dune::CGSolver< X >::apply(), Dune::BiCGSTABSolver< X >::apply(), Dune::MINRESSolver< X >::apply(), Dune::RestartedGMResSolver< X, Y, F >::apply(), and clear().

The documentation for this struct was generated from the following file:

solvers.hh