Diffpack Documentation

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

CMAbsMixResidual Class Reference

convergence monitor based on absolute mixed residuals. More...

#include <ConvMonitor.h>

Inheritance diagram for CMAbsMixResidual::

Public Methods
	CMAbsMixResidual (const ConvMonitor_prm &p)
	CMAbsMixResidual (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)
	~CMAbsMixResidual ()
virtual void	getScaling (String &scale) const
virtual real	getScaling () 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
Handle(LinEqVector)	r

Detailed Description

convergence monitor based on absolute mixed residuals.

NAME: CMAbsMixResidual - convergence monitor based on absolute mixed residuals

DESCRIPTION:

This class implements the convergence test based on the absolute mixed residual `$S\cdot((r^{k},v^{k})`.

Constructor & Destructor Documentation

CMAbsMixResidual::CMAbsMixResidual ( const ConvMonitor_prm & p )

See class "CMAbsResidual".

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

CMAbsMixResidual::~CMAbsMixResidual ( ) [inline]

Member Function Documentation

String CMAbsMixResidual::description ( ) const [virtual]

Reimplemented from CMAbsResidual.

real CMAbsMixResidual::getScaling ( ) const [virtual]

Reimplemented from ConvMonitor.

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

Reimplemented from ConvMonitor.

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

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

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

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

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

Reimplemented from CMAbsResidual.

bool CMAbsMixResidual::satisfied ( ) [virtual]

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

Friends And Related Function Documentation

class ConvMonitorList [friend]

Reimplemented from CMAbsResidual.

Member Data Documentation

Handle(LinEqVector) CMAbsMixResidual::r [protected]

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

ConvMonitor.h