Diffpack Documentation

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

EigenEstimator Class Reference

add-on module for eigenvalue estimation based on parameters extracted from iterative solvers. More...

#include <EigenEstimator.h>

Inheritance diagram for EigenEstimator::

Public Methods
	EigenEstimator (const String &solverId)
virtual	~EigenEstimator ()
virtual void	init (Handle(LinEqCommBlk) &communication)
virtual void	receive ()
virtual bool	ok ()
virtual void	debugPrint (Os os) const
Public Attributes
Handle(LinEqCommBlk)	communication

Detailed Description

add-on module for eigenvalue estimation based on parameters extracted from iterative solvers.

NAME: EigenEstimator - add-on module for eigenvalue estimation based on parameters extracted from iterative solvers

DESCRIPTION:

Base class for modules that can be coupled to iterative solvers for computation of eigenvalue estimates based on the iteration parameters. The communication between an "EigenEstimator", the solver and additional modules like preconditioners and convergence monitors is handled by the connected "LinEqCommBlk" object.

NB! There is no eigenvalue estimator fully implemented yet!

Constructor & Destructor Documentation

EigenEstimator::EigenEstimator ( const String & solverId )

The only constructor takes a string argument identifying the connected iterative solver. This is done to guarantee that the chosen eigenvalue estimator can handle the iteration parameters supplied by the solver.

EigenEstimator::~EigenEstimator ( ) [virtual]

Member Function Documentation

void EigenEstimator::debugPrint ( Os os ) const [virtual]

dump the contents of the eigenvalue estimator for debugging purposes.

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

initializes the eigenvalue estimator.

bool EigenEstimator::ok ( ) [virtual]

checks the state of the current eigenvalue estimator.

void EigenEstimator::receive ( ) [virtual]

tells the eigenvalue estimator to grab new iteration parameters from the connected "LinEqCommBlk" object.

Member Data Documentation

Handle(LinEqCommBlk) EigenEstimator::communication

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

EigenEstimator.h