Diffpack Documentation

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

CMRelSeqResidual Class Reference

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

#include <ConvMonitor.h>

Inheritance diagram for CMRelSeqResidual::

Public Methods
	CMRelSeqResidual (const ConvMonitor_prm &p)
	CMRelSeqResidual (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)
	~CMRelSeqResidual ()
virtual void	init (Handle(LinEqCommBlk) &communication)
virtual bool	satisfied ()
virtual String	description () const

Detailed Description

relative convergence monitor for sequence of residual vectors.

NAME: CMRelSeqResidual - relative 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 relative and is based on the difference of two succeeding residuals, i.e., `$

allel\! v^{k}-v^{k-1} \!\parallel/ \parallel\! v^{k-1} \!\parallel`: `\leq \varepsilon$`.

Constructor & Destructor Documentation

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

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

CMRelSeqResidual::~CMRelSeqResidual ( ) [inline]

Member Function Documentation

String CMRelSeqResidual::description ( ) const [virtual]

Reimplemented from CMAbsSeqResidual.

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

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

bool CMRelSeqResidual::satisfied ( ) [virtual]

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

Friends And Related Function Documentation

class ConvMonitorList [friend]

Reimplemented from CMAbsSeqResidual.

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