Diffpack Documentation

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

ConvMonitorList Class Reference

list of convergence monitors. More...

#include <ConvMonitorList.h>

Inheritance diagram for ConvMonitorList::

Public Methods
	ConvMonitorList ()
	ConvMonitorList (const ConvMonitorList_prm &pm)
virtual	~ConvMonitorList ()
void	init (Handle(LinEqCommBlk) &communication)
bool	ok () const
bool	satisfied ()
void	attach (ConvMonitor &monitor)
ConvMonitor&	operator() (int i)
bool	operator== (const ConvMonitor &) const
bool	operator!= (const ConvMonitor &m) const
int	getNoEntries () const
int	getWork () const
real	getStorage () const
void	performance (LinEqStatBlk &performance_status)
void	plotMonitorData (CurvePlotFile &file, const String &comment, bool logplot=true)
void	popUpMonitorData ()
void	generatePostScriptPlot (CurvePlotFile &file, const char *psFileDir=NULL)
void	debugPrint (Os os) const
void	attachCommAdm (const SubdCommAdm &adm_)
Protected Attributes
	DpList(ConvMonitor)
DpListItemHandle	the_list

Detailed Description

list of convergence monitors.

NAME: ConvMonitorList - list of convergence monitors

DESCRIPTION:

The class manages a list of convergence monitors and serves as an interface between objects of types "ConvMonitor" and "IterativeSolver".

Constructor & Destructor Documentation

ConvMonitorList::ConvMonitorList ( )

There is a default constructor without arguments and one taking a "ConvMonitorList_prm" argument. In the first case, explicit attachment of "ConvMonitor" objects is necessary.

ConvMonitorList::ConvMonitorList ( const ConvMonitorList_prm & pm )

See documentation of one of the overloaded constructor.

ConvMonitorList::~ConvMonitorList ( ) [virtual]

Member Function Documentation

void ConvMonitorList::attach ( ConvMonitor & monitor )

insert a new "ConvMonitor" object in the list

void ConvMonitorList::attachCommAdm ( const SubdCommAdm & adm_ )

void ConvMonitorList::debugPrint ( Os os ) const

dump the contents of all convergence monitors in the list.

void ConvMonitorList::generatePostScriptPlot ( CurvePlotFile & file,

const char * psFileDir = NULL )

generate convergence history plots for all active monitors as PostScript code.

int ConvMonitorList::getNoEntries ( ) const

real ConvMonitorList::getStorage ( ) const

return accumulated storage requirements for all "ConvMonitor" objects in the list.

int ConvMonitorList::getWork ( ) const

return accumulated work estimate for all "ConvMonitor" objects in the list.

void ConvMonitorList::init ( Handle(LinEqCommBlk) & communication )

initialize all "ConvMonitor" objects in the list.

bool ConvMonitorList::ok ( ) const

check the state of all "ConvMonitor" objects in the list.

bool ConvMonitorList::operator!= ( const ConvMonitor & m ) const [inline]

ConvMonitor & ConvMonitorList::operator() ( int i )

bool ConvMonitorList::operator== ( const ConvMonitor & ) const [inline]

void ConvMonitorList::performance ( LinEqStatBlk & performance_status )

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

void ConvMonitorList::plotMonitorData ( CurvePlotFile & file,

const String & comment,

bool logplot = true )

make a plot of this monitor''s history.

void ConvMonitorList::popUpMonitorData ( )

pop up a plot of this monitor''s history on the screen.

bool ConvMonitorList::satisfied ( )

evaluate the compound convergence history value given by the combination of all "ConvMonitor" objects in the list.

Member Data Documentation

ConvMonitorList::DpList_ConvMonitor [protected]

DpListItemHandle ConvMonitorList::the_list [protected]

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

ConvMonitorList.h