Chombo + EB + MF  3.2
Public Member Functions | Private Member Functions | List of all members
AMRMultiGridInspector< T > Class Template Referenceabstract

#include <AMRMultiGrid.H>

Inheritance diagram for AMRMultiGridInspector< T >:
Inheritance graph
[legend]

Public Member Functions

 AMRMultiGridInspector ()
 Base class constructor. This must be called by all subclasses. More...
 
virtual ~AMRMultiGridInspector ()
 Destructor. More...
 
virtual void recordResiduals (const Vector< T * > &a_residuals, int a_minLevel, int a_maxLevel, int a_iter)=0
 
virtual void recordCorrections (const Vector< T * > &a_corrections, int a_minLevel, int a_maxLevel, int a_iter)=0
 

Private Member Functions

 AMRMultiGridInspector (const AMRMultiGridInspector &)
 
AMRMultiGridInspectoroperator= (const AMRMultiGridInspector &)
 

Detailed Description

template<class T>
class AMRMultiGridInspector< T >

This base class allows one to construct methods for inspecting the multigrid algorithm at each of its steps.

Constructor & Destructor Documentation

template<class T >
AMRMultiGridInspector< T >::AMRMultiGridInspector ( )
inline

Base class constructor. This must be called by all subclasses.

template<class T >
virtual AMRMultiGridInspector< T >::~AMRMultiGridInspector ( )
inlinevirtual

Destructor.

template<class T >
AMRMultiGridInspector< T >::AMRMultiGridInspector ( const AMRMultiGridInspector< T > &  )
private

Member Function Documentation

template<class T >
virtual void AMRMultiGridInspector< T >::recordResiduals ( const Vector< T * > &  a_residuals,
int  a_minLevel,
int  a_maxLevel,
int  a_iter 
)
pure virtual

Override this method to keep track of a multigrid residual computed during a multigrid iteration at the given levels.

Parameters
a_residualsAn array containing the residuals computed by the multigrid algorithm at each level in the range [a_minLevel, a_maxLevel].
a_minLevelThe lowest AMR level at which residuals were computed.
a_maxLevelThe highest AMR level at which residuals were computed.
a_iterThe multigrid iteration number.

Implemented in OutputAMRMultiGridInspector< T >.

template<class T >
virtual void AMRMultiGridInspector< T >::recordCorrections ( const Vector< T * > &  a_corrections,
int  a_minLevel,
int  a_maxLevel,
int  a_iter 
)
pure virtual

Override this method to keep track of a multigrid correction computed during a V cycle at the given level.

Parameters
a_correctionsAn array containing the corrections computed during a V cycle at each level in the range [a_minLevel, a_maxLevel].
a_minLevelThe lowest AMR level at which corrections were computed.
a_maxLevelThe highest AMR level at which corrections were computed.
a_iterThe multigrid iteration number.

Implemented in OutputAMRMultiGridInspector< T >.

template<class T >
AMRMultiGridInspector& AMRMultiGridInspector< T >::operator= ( const AMRMultiGridInspector< T > &  )
private

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