PlotterPeriodicFunction Class Reference

#include <Scheduler.H>

Inheritance diagram for PlotterPeriodicFunction:

Inheritance graph
[legend]

List of all members.


Detailed Description

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

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)

Private Attributes

std::string m_prefix

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_step The step at which the function is called.
a_time The 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_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 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_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 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_step The step at which the function is called.
a_time The 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:

Generated on Wed Aug 16 04:03:53 2017 for Chombo + EB by  doxygen 1.5.5