Diffpack Documentation

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

CMRelRefSolution Class Reference

relative convergence monitor for reference solution. More...

#include <ConvMonitor.h>

Inheritance diagram for CMRelRefSolution::

Public Methods
	CMRelRefSolution (const ConvMonitor_prm &p)
	CMRelRefSolution (const real conv_tolerance=1.0e-4, const Norm_type norm_tp=l2, const int chunk_size=100)
	~CMRelRefSolution ()
virtual void	init (Handle(LinEqCommBlk) &communication)
virtual String	description () const

Detailed Description

relative convergence monitor for reference solution.

NAME: CMRelRefSolution - relative convergence monitor for reference solution

DESCRIPTION:

Monitors the behaviour of the iterates "x" managed by "IterativeSolver". The convergence test is relative and is based on the difference of the current iterate and a reference solution set by "attach", i.e., `$

allel\! x^{k}-x_{ref} \!\parallel /`: `

allel\! x_{ref} \!\parallel \leq \varepsilon$`.

Constructor & Destructor Documentation

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

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

const Norm_type norm_tp = l2,

const int chunk_size = 100 )

See documentation of one of the overloaded constructor.

CMRelRefSolution::~CMRelRefSolution ( ) [inline]

Member Function Documentation

String CMRelRefSolution::description ( ) const [virtual]

Reimplemented from CMAbsRefSolution.

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

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

Friends And Related Function Documentation

class ConvMonitorList [friend]

Reimplemented from CMAbsRefSolution.

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