Chombo + EB  3.0
Public Member Functions | Private Attributes | List of all members
PlotterPeriodicFunction Class Reference

#include <Scheduler.H>

Inheritance diagram for PlotterPeriodicFunction:
Inheritance graph
[legend]

Public Member Functions

 PlotterPeriodicFunction (const std::string &a_prefix)
 
void operator() (int a_step, Real a_time)
 
void setUp (AMR &a_AMR, int a_interval)
 
void setUp (AMR &a_AMR, Real a_interval)
 
void conclude (int a_step, Real a_time)
 
- Public Member Functions inherited from Scheduler::PeriodicFunction
 PeriodicFunction ()
 Default construction. More...
 
virtual ~PeriodicFunction ()
 Destructor. More...
 

Private Attributes

std::string m_prefix
 

Detailed Description

This placebo allows one to enable periodic plots using the Scheduler mechanism.

Constructor & Destructor Documentation

PlotterPeriodicFunction::PlotterPeriodicFunction ( const std::string &  a_prefix)
explicit

Member Function Documentation

void PlotterPeriodicFunction::operator() ( int  a_step,
Real  a_time 
)
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.

Implements Scheduler::PeriodicFunction.

void PlotterPeriodicFunction::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 from Scheduler::PeriodicFunction.

void PlotterPeriodicFunction::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 from Scheduler::PeriodicFunction.

void PlotterPeriodicFunction::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 from Scheduler::PeriodicFunction.

Member Data Documentation

std::string PlotterPeriodicFunction::m_prefix
private

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