Chombo + EB + MF  3.2
Public Member Functions | Private Member Functions | List of all members
Scheduler::PeriodicFunction Class Referenceabstract

#include <Scheduler.H>

Inheritance diagram for Scheduler::PeriodicFunction:
Inheritance graph
[legend]

Public Member Functions

 PeriodicFunction ()
 Default construction. More...
 
virtual ~PeriodicFunction ()
 Destructor. More...
 
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 &)
 
PeriodicFunctionoperator= (const PeriodicFunction &)
 

Detailed Description

This function is called periodically by the Scheduler. Its call operator must be overridden to define its behavior.

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_AMRThe AMR object with which this function will interact during periodic function calls.
a_intervalThe interval (in steps) at which the periodic function is to be called.

Reimplemented in CheckpointPeriodicFunction, and PlotterPeriodicFunction.

virtual void Scheduler::PeriodicFunction::setUp ( AMR a_AMR,
Real  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 units. By default this does nothing.

Parameters
a_AMRThe AMR object with which this function will interact during periodic function calls.
a_intervalThe 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_stepThe step at which the function is called.
a_timeThe simulation time at which the function is called.

Implemented in CheckpointPeriodicFunction, and PlotterPeriodicFunction.

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_stepThe step at which the function is called.
a_timeThe 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: