Chombo + EB  3.2
Public Member Functions | Private Attributes | List of all members
OutputAMRMultiGridInspector< T > Class Template Reference

#include <OutputAMRMultiGridInspector.H>

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

Public Member Functions

 OutputAMRMultiGridInspector (const std::string &a_name, AMRMultiGrid< T > &a_solver)
 
 ~OutputAMRMultiGridInspector ()
 Destructor. More...
 
void recordResiduals (const Vector< T * > &a_residuals, int a_minLevel, int a_maxLevel, int a_iter)
 
void recordCorrections (const Vector< T * > &a_corrections, int a_minLevel, int a_maxLevel, int a_iter)
 
- Public Member Functions inherited from AMRMultiGridInspector< T >
 AMRMultiGridInspector ()
 Base class constructor. This must be called by all subclasses. More...
 
virtual ~AMRMultiGridInspector ()
 Destructor. More...
 

Private Attributes

std::string m_name
 
AMRMultiGrid< T > * m_solver
 

Detailed Description

template<class T>
class OutputAMRMultiGridInspector< T >

This subclass of AMRMultiGridInspector simply writes output files containing residuals and corrections at each multigrid iteration.

Constructor & Destructor Documentation

template<class T >
OutputAMRMultiGridInspector< T >::OutputAMRMultiGridInspector ( const std::string &  a_name,
AMRMultiGrid< T > &  a_solver 
)
inline

Create an AMRMultiGridInspector that inspects the given AMRMultiGrid solver and generates output files containing intermediate data. a_name The name of the inspector. This gets prepended to the output files. a_solver The AMRMultiGrid solver with which this inspector is associated.

template<class T >
OutputAMRMultiGridInspector< T >::~OutputAMRMultiGridInspector ( )
inline

Destructor.

Member Function Documentation

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

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.

Implements AMRMultiGridInspector< T >.

References OutputAMRMultiGridInspector< T >::m_name, OutputAMRMultiGridInspector< T >::m_solver, and name().

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

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.

Implements AMRMultiGridInspector< T >.

References OutputAMRMultiGridInspector< T >::m_name, OutputAMRMultiGridInspector< T >::m_solver, and name().

Member Data Documentation

template<class T >
std::string OutputAMRMultiGridInspector< T >::m_name
private
template<class T >
AMRMultiGrid<T>* OutputAMRMultiGridInspector< T >::m_solver
private

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