Diffpack Documentation

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

CMRelTrueResidual Class Reference

relative monitor for true residual vectors. More...

#include <ConvMonitor.h>

Inheritance diagram for CMRelTrueResidual::

Public Methods
	CMRelTrueResidual (const ConvMonitor_prm &p)
	CMRelTrueResidual (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)
	~CMRelTrueResidual ()
virtual void	getScaling (String &scale) const
virtual real	getScaling () const
virtual void	init (Handle(LinEqCommBlk) &communication)
virtual void	performance (ConvStatistics &convStat)
virtual String	description () const
virtual void	print (Os os) const
Protected Attributes
bool	rel_to_rhs

Detailed Description

relative monitor for true residual vectors.

NAME: CMRelTrueResidual - relative monitor for true residual vectors

DESCRIPTION:

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

allel\! v^{k} \!\parallel/\parallel\! v^{0} \!\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

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

CMRelTrueResidual::CMRelTrueResidual ( 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.

CMRelTrueResidual::~CMRelTrueResidual ( ) [inline]

Member Function Documentation

String CMRelTrueResidual::description ( ) const [virtual]

Reimplemented from CMAbsTrueResidual.

real CMRelTrueResidual::getScaling ( ) const [virtual]

Reimplemented from ConvMonitor.

void CMRelTrueResidual::getScaling ( String & scale ) const [virtual]

Reimplemented from ConvMonitor.

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

set up communication link via the "LinEqCommBlk" object referred to by "communication".
Reimplemented from CMAbsTrueResidual.

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

fill out relevant parts of a "LinEqStatBlk" object for performance report.
Reimplemented from CMAbsTrueResidual.

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

Reimplemented from CMAbsTrueResidual.

Friends And Related Function Documentation

class ConvMonitorList [friend]

Reimplemented from CMAbsTrueResidual.

Member Data Documentation

bool CMRelTrueResidual::rel_to_rhs [protected]

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

ConvMonitor.h