Diffpack Documentation

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

ConvMonSeq Class Reference

base class for convergence monitors (vector sequences). More...

#include <ConvMonitor.h>

Inheritance diagram for ConvMonSeq::

Public Methods
	~ConvMonSeq ()
virtual bool	ok () const
virtual bool	satisfied ()
virtual real	getStorage () const
virtual void	print (Os os) const
Protected Methods
	ConvMonSeq (const ConvMonitor_prm &p)
	ConvMonSeq (const real conv_tolerance=1.0e-4, const Norm_type norm_tp=l2, const int chunk_size=100)
Protected Attributes
bool	prev_is_internal
Handle(LinEqVector)	prev_vec
bool	firstcall
LinEqVector	scratch

Detailed Description

base class for convergence monitors (vector sequences).

NAME: ConvMonSeq - base class for convergence monitors (vector sequences)

DESCRIPTION:

The base class describes an extension to "ConvMonitor" that permits the monitoring of a vector sequence, e.g. cheking the difference of two succeeding iterates `$x^{k}-x^{k-1}$`. The vectors to be monitored may be allocated internally if these entities are not already allocated by the iterative solver.

Constructor & Destructor Documentation

ConvMonSeq::ConvMonSeq ( const ConvMonitor_prm & p ) [inline, protected]

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

const Norm_type norm_tp = l2,

const int chunk_size = 100 ) [protected]

See documentation of one of the overloaded constructor.

ConvMonSeq::~ConvMonSeq ( ) [inline]

Member Function Documentation

real ConvMonSeq::getStorage ( ) const [virtual]

estimate storage expenses for this monitor.
Reimplemented from ConvMonitor.

bool ConvMonSeq::ok ( ) const [virtual]

check current state.
Reimplemented from ConvMonitor.

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

Reimplemented from ConvMonitor.
Reimplemented in CMAbsSeqResidual.

bool ConvMonSeq::satisfied ( ) [virtual]

monitor the test value and return true if the condition is met.
Reimplemented from ConvMonitor.
Reimplemented in CMRelSeqResidual, and CMRelSeqSolution.

Friends And Related Function Documentation

class ConvMonitorList [friend]

Reimplemented from ConvMonitor.
Reimplemented in CMAbsSeqResidual, CMAbsSeqSolution, CMRelSeqResidual, and CMRelSeqSolution.

Member Data Documentation

bool ConvMonSeq::firstcall [protected]

bool ConvMonSeq::prev_is_internal [protected]

Handle(LinEqVector) ConvMonSeq::prev_vec [protected]

LinEqVector ConvMonSeq::scratch [protected]

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

ConvMonitor.h