Diffpack Documentation

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

CMRelSeqSolution Class Reference

relative convergence monitor for sequence of iterates. More...

#include <ConvMonitor.h>

Inheritance diagram for CMRelSeqSolution::

Public Methods
	CMRelSeqSolution (const ConvMonitor_prm &p)
	CMRelSeqSolution (const real conv_tolerance_=1.0e-4, const Norm_type norm_tp_=l2, const int chunk_size_=100)
	~CMRelSeqSolution ()
virtual void	init (Handle(LinEqCommBlk) &communication)
virtual bool	satisfied ()
virtual String	description () const

Detailed Description

relative convergence monitor for sequence of iterates.

NAME: CMRelSeqSolution - relative convergence monitor for sequence of iterates

DESCRIPTION:

Monitors the behaviour of the iterates "x" managed by "IterativeSolver". The convergence test is relative and is based on the difference of two succeeding iterates i.e., `$

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

Constructor & Destructor Documentation

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

CMRelSeqSolution::CMRelSeqSolution ( const real conv_tolerance_ = 1.0e-4,

const Norm_type norm_tp_ = l2,

const int chunk_size_ = 100 ) [inline]

CMRelSeqSolution::~CMRelSeqSolution ( ) [inline]

Member Function Documentation

String CMRelSeqSolution::description ( ) const [virtual]

Reimplemented from CMAbsSeqSolution.

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

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

bool CMRelSeqSolution::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 CMAbsSeqSolution.

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