Diffpack Documentation

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

CMAbsSeqResidual Class Reference

absolute convergence monitor for sequence of residual vectors. More...

#include <ConvMonitor.h>

Inheritance diagram for CMAbsSeqResidual::

Public Methods
	CMAbsSeqResidual (const ConvMonitor_prm &p)
	CMAbsSeqResidual (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)
	~CMAbsSeqResidual ()
virtual bool	hasResidualType () const
virtual Residual_type	getResidualType () const
virtual void	init (Handle(LinEqCommBlk) &communication)
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 sequence of residual vectors.

NAME: CMAbsSeqResidual - absolute convergence monitor for sequence of residual vectors

DESCRIPTION:

Monitors the behaviour of a residual vector obtained from an "IterativeSolver" via a "LinEqCommBlk" object. The convergence test is absolute and is based on the difference of two succeeding residuals, i.e., `$

allel\! v^{k}-v^{k-1} \!\parallel \leq \varepsilon$`, where: `$v^{k}$` is one of the residuals `$r^{k}$`, `$s^{k}$` or `$z^{k}$`.

Constructor & Destructor Documentation

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

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

CMAbsSeqResidual::~CMAbsSeqResidual ( ) [inline]

Member Function Documentation

String CMAbsSeqResidual::description ( ) const [virtual]

Reimplemented from ConvMonitor.
Reimplemented in CMRelSeqResidual.

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

Reimplemented from ConvMonitor.

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

Reimplemented from ConvMonitor.

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

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

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

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

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

Reimplemented from ConvMonSeq.

Friends And Related Function Documentation

class ConvMonitorList [friend]

Reimplemented from ConvMonSeq.
Reimplemented in CMRelSeqResidual.

Member Data Documentation

Residual_type CMAbsSeqResidual::residual_tp [protected]

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

ConvMonitor.h