Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members

NoOpSmoother Class Reference

#include <NoOpSmoother.H>

Inheritance diagram for NoOpSmoother:

Inheritance graph
[legend]
Collaboration diagram for NoOpSmoother:

Collaboration graph
[legend]
List of all members.

Detailed Description

Does nothing as a bottom smoother.

The NoOpSmoother class is a bottom smoother for LevelOp-derived classes which does nothing (mostly as a debugging test option)


Public Member Functions

 NoOpSmoother ()
 Null constructor.

virtual ~NoOpSmoother ()
 Destructor.

virtual BaseBottomSmoothernew_bottomSmoother () const
 This gets around the "no virtual constructor" rule.

virtual void doBottomSmooth (LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > &a_rhs, LevelOp *a_levelopPtr)
 Do (no) smoothing.

virtual void setConvergenceMetric (Real a_metric, int a_comp=0)
 sets metric to judge convergence (normally norm(rhs) of outer problem

virtual void setSolverTol (Real a_tol)
 this doesn't really do anything, but is required by BaseBottomSmoother


Constructor & Destructor Documentation

NoOpSmoother::NoOpSmoother  ) 
 

Null constructor.

virtual NoOpSmoother::~NoOpSmoother  )  [virtual]
 

Destructor.


Member Function Documentation

virtual BaseBottomSmoother* NoOpSmoother::new_bottomSmoother  )  const [virtual]
 

This gets around the "no virtual constructor" rule.

Implements BaseBottomSmoother.

virtual void NoOpSmoother::doBottomSmooth LevelData< FArrayBox > &  a_phi,
const LevelData< FArrayBox > &  a_rhs,
LevelOp a_levelopPtr
[virtual]
 

Do (no) smoothing.

True to its name, this class does nothing in this functino

Implements BaseBottomSmoother.

virtual void NoOpSmoother::setConvergenceMetric Real  a_metric,
int  a_comp = 0
[inline, virtual]
 

sets metric to judge convergence (normally norm(rhs) of outer problem

To make the iterative solver convergence more consistent, the solver will consider itself "solved" if the residual is reduced to epsilon*metric, where epsilon is the solver tolerance (set by setSolverTol). A good starting point for the metric is the norm of the RHS of the original problem (i.e. the rhs sent in to LevelSolver or AMRSolver). Default value is 1.0.

Implements BaseBottomSmoother.

virtual void NoOpSmoother::setSolverTol Real  a_tol  )  [inline, virtual]
 

this doesn't really do anything, but is required by BaseBottomSmoother

Implements BaseBottomSmoother.


The documentation for this class was generated from the following file:
Generated on Fri Jul 2 17:55:58 2004 for Chombo by doxygen 1.3.2