Diffpack Documentation

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

CMRelResidualUB Class Reference

relative convergence monitor for residual vectors wwith user-defined base value. More...

#include <ConvMonitor.h>

Inheritance diagram for CMRelResidualUB::

Public Methods
	CMRelResidualUB (const ConvMonitor_prm &p)
	CMRelResidualUB (const real conv_tolerance=1.0e-4, const Residual_type residual_tp=ORIGINAL_RES, const Norm_type norm_tp=l2, const real user_base=1.0, const int chunk_size=100)
	~CMRelResidualUB ()
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

Detailed Description

relative convergence monitor for residual vectors wwith user-defined base value.

NAME: CMRelResidualUB - relative convergence monitor for residual vectors wwith user-defined base value

DESCRIPTION:

Monitors the behaviour of a residual vector imported from an "IterativeSolver" via a "LinEqCommBlk" object, i.e. no internal storage. The convergence test is relative, see "CMRelResidual". The only difference from this class, is that the base value has to be set manually by the user.

Constructor & Destructor Documentation

CMRelResidualUB::CMRelResidualUB ( const ConvMonitor_prm & p )

See class "CMRelResidual". The additional parameter "user_base" can be used to set the base value.

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

const Residual_type residual_tp = ORIGINAL_RES,

const Norm_type norm_tp = l2,

const real user_base = 1.0,

const int chunk_size = 100 )

See documentation of one of the overloaded constructor.

CMRelResidualUB::~CMRelResidualUB ( ) [inline]

Member Function Documentation

String CMRelResidualUB::description ( ) const [virtual]

Reimplemented from CMAbsResidual.

real CMRelResidualUB::getScaling ( ) const [virtual]

Reimplemented from ConvMonitor.

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

Reimplemented from ConvMonitor.

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

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

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

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

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

Reimplemented from CMAbsResidual.

Friends And Related Function Documentation

class ConvMonitorList [friend]

Reimplemented from CMAbsResidual.

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