FixedRefinement Class Reference
#include <FixedRefinement.H>
Inheritance diagram for FixedRefinement:
Collaboration diagram for FixedRefinement:
Detailed Description
This refinement criterion refines a fixed number of levels.Public Member Functions | |
| FixedRefinement () | |
| Null constructor. | |
| FixedRefinement (const int &a_counter) | |
| Constructor which sets counter. | |
| virtual | ~FixedRefinement () |
| Destructor. | |
| virtual bool | doRefine (Vector< int > &a_refineInDir, const int &a_dim, const Vector< Real > &a_dxRatio, const Vector< Vector< Real > > &a_residual) |
| Refine a fixed number of times. | |
| virtual void | setCounter (const int &a_counter) |
| Set the counter. | |
| virtual int | getCounter () |
| Get the counter. | |
Protected Attributes | |
| int | m_counter |
Constructor & Destructor Documentation
| FixedRefinement::FixedRefinement | ( | ) |
Null constructor.
| FixedRefinement::FixedRefinement | ( | const int & | a_counter | ) |
Constructor which sets counter.
| virtual FixedRefinement::~FixedRefinement | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual bool FixedRefinement::doRefine | ( | Vector< int > & | a_refineInDir, | |
| const int & | a_dim, | |||
| const Vector< Real > & | a_dxRatio, | |||
| const Vector< Vector< Real > > & | a_residual | |||
| ) | [virtual] |
Refine a fixed number of times.
Refine until the counter gets to zero. If the counter is non-zero, return true, "a_refineInDir" one in all components, and decrement counter. If the counter is zero, return false and "a_refineInDir" zero in all components.
Implements RefinementCriterion.
| virtual void FixedRefinement::setCounter | ( | const int & | a_counter | ) | [virtual] |
Set the counter.
| virtual int FixedRefinement::getCounter | ( | ) | [virtual] |
Get the counter.
Member Data Documentation
int FixedRefinement::m_counter [protected] |
The documentation for this class was generated from the following file:
