Scheduler::PeriodicFunction Class Reference
#include <Scheduler.H>
Detailed Description
This function is called periodically by the Scheduler. Its call operator must be overridden to define its behavior.Public Member Functions | |
| PeriodicFunction () | |
| Default construction. | |
| virtual | ~PeriodicFunction () |
| Destructor. | |
| virtual void | setUp (AMR &a_AMR, int a_interval) |
| virtual void | setUp (AMR &a_AMR, Real a_interval) |
| virtual void | operator() (int a_step, Real a_time)=0 |
| virtual void | conclude (int a_step, Real a_time) |
Private Member Functions | |
| PeriodicFunction (const PeriodicFunction &) | |
| PeriodicFunction & | operator= (const PeriodicFunction &) |
Constructor & Destructor Documentation
| Scheduler::PeriodicFunction::PeriodicFunction | ( | ) |
Default construction.
| virtual Scheduler::PeriodicFunction::~PeriodicFunction | ( | ) | [virtual] |
Destructor.
| Scheduler::PeriodicFunction::PeriodicFunction | ( | const PeriodicFunction & | ) | [private] |
Member Function Documentation
| virtual void Scheduler::PeriodicFunction::setUp | ( | AMR & | a_AMR, | |
| int | a_interval | |||
| ) | [virtual] |
Override this method to prepare the periodic function to interact with the given AMR object when set to an interval in time steps. By default this does nothing.
- Parameters:
-
a_AMR The AMR object with which this function will interact during periodic function calls. a_interval The interval (in steps) at which the periodic function is to be called.
Reimplemented in PlotterPeriodicFunction, and CheckpointPeriodicFunction.
Override this method to prepare the periodic function to interact with the given AMR object when set to an interval in time units. By default this does nothing.
- Parameters:
-
a_AMR The AMR object with which this function will interact during periodic function calls. a_interval The interval (in simulation time units) at which the periodic function is to be called.
Reimplemented in PlotterPeriodicFunction.
| virtual void Scheduler::PeriodicFunction::operator() | ( | int | a_step, | |
| Real | a_time | |||
| ) | [pure virtual] |
Override this operator to define the behavior of the periodic function.
- Parameters:
-
a_step The step at which the function is called. a_time The simulation time at which the function is called.
Implemented in PlotterPeriodicFunction, and CheckpointPeriodicFunction.
| virtual void Scheduler::PeriodicFunction::conclude | ( | int | a_step, | |
| Real | a_time | |||
| ) | [virtual] |
Override this operator to perform a task at the conclusion of a simulation. This is called by the conclude() method of AMR and is fed the final step and simulation time. By default, this does nothing.
- Parameters:
-
a_step The step at which the function is called. a_time The simulation time at which the function is called.
Reimplemented in PlotterPeriodicFunction.
| PeriodicFunction& Scheduler::PeriodicFunction::operator= | ( | const PeriodicFunction & | ) | [private] |
The documentation for this class was generated from the following file:
