Diffpack Documentation

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Search

CMAbsTrueResidual Class Reference

absolute convergence monitor for true residual vectors. More...

#include <ConvMonitor.h>

Inheritance diagram for CMAbsTrueResidual::

Public Methods
	CMAbsTrueResidual (const ConvMonitor_prm &p)
	CMAbsTrueResidual (const real conv_tolerance=1.0e-4, const Residual_type residual_tp=ORIGINAL_RES, const Norm_type norm_tp=l2, const int chunk_size=100)
	~CMAbsTrueResidual ()
virtual bool	hasResidualType () const
virtual Residual_type	getResidualType () const
virtual void	init (Handle(LinEqCommBlk) &communication)
virtual bool	satisfied ()
virtual void	performance (ConvStatistics &convStat)
virtual String	description () const
virtual void	print (Os os) const
Protected Attributes
Residual_type	residual_tp

Detailed Description

absolute convergence monitor for true residual vectors.

NAME: CMAbsTrueResidual - absolute convergence monitor for true residual vectors

DESCRIPTION:

Monitors the behaviour of a true residual obtained from a "LinEqSystem" procedure "residual" and possibly one of the preconditioning operations "applyLeftPrec" or "applyPrec", i.e. internal storage is needed. The convergence test is absolute, `$S\cdot(

allel\! v^{k} \!\parallel) \leq \varepsilon$`, where: `$v^{k}$` equals one of the `$`k`$`th residuals `$r^{k}$`, `$s^{k}$` or `$z^{k}$` and `$`S`$` is a scaling obtained from spectral properties (if this information is available).

Constructor & Destructor Documentation

CMAbsTrueResidual::CMAbsTrueResidual ( const ConvMonitor_prm & p ) [inline]

CMAbsTrueResidual::CMAbsTrueResidual ( const real conv_tolerance = 1.0e-4,

const Residual_type residual_tp = ORIGINAL_RES,

const Norm_type norm_tp = l2,

const int chunk_size = 100 )

See documentation of one of the overloaded constructor.

CMAbsTrueResidual::~CMAbsTrueResidual ( ) [inline]

Member Function Documentation

String CMAbsTrueResidual::description ( ) const [virtual]

Reimplemented from ConvMonitor.
Reimplemented in CMRelTrueResidual.

Residual_type CMAbsTrueResidual::getResidualType ( ) const [inline, virtual]

Reimplemented from ConvMonitor.

bool CMAbsTrueResidual::hasResidualType ( ) const [inline, virtual]

Reimplemented from ConvMonitor.

void CMAbsTrueResidual::init ( Handle(LinEqCommBlk) & communication ) [virtual]

set up communication link via the "LinEqCommBlk" object referred to by "communication".
Reimplemented from ConvMonitor.
Reimplemented in CMRelTrueResidual.

void CMAbsTrueResidual::performance ( ConvStatistics & convStat ) [virtual]

fill out relevant parts of a "LinEqStatBlk" object for performance report.
Reimplemented from ConvMonitor.
Reimplemented in CMRelTrueResidual.

void CMAbsTrueResidual::print ( Os os ) const [virtual]

Reimplemented from ConvMonitor.
Reimplemented in CMRelTrueResidual.

bool CMAbsTrueResidual::satisfied ( ) [virtual]

monitor the test value and return true if the condition is met.
Reimplemented from ConvMonitor.

Friends And Related Function Documentation

class ConvMonitorList [friend]

Reimplemented from ConvMonitor.
Reimplemented in CMRelTrueResidual.

Member Data Documentation

Residual_type CMAbsTrueResidual::residual_tp [protected]

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

ConvMonitor.h