ippl::BaseManager Class Reference

A base class for managing simulations using IPPL. More...

#include <BaseManager.h>

Inheritance diagram for ippl::BaseManager:

Public Member Functions
virtual void	pre_run ()
	A method that should be used for setting up the simulation.
virtual void	pre_step ()
	A method that should be used for preparation before perfoming a step of simulation.
virtual void	post_step ()
	A method that should be used after perfoming a step of simulation.
virtual void	advance ()=0
	A method that should be used to execute/advance a step of simulation.
void	run (int nt)
	The main for loop fro running a simulation.

Detailed Description

A base class for managing simulations using IPPL.

The BaseManager class provides a basic structure for running simulations with common steps.

Member Function Documentation

advance()

virtual void ippl::BaseManager::advance ( )

pure virtual

A method that should be used to execute/advance a step of simulation.

In a derived class, the user must override this method to implement their time integration method for solving the considered governing equation.

post_step()

virtual void ippl::BaseManager::post_step ( )

inlinevirtual

A method that should be used after perfoming a step of simulation.

Derived classes can override this method to dump data, increment time, etc. The default implementation does nothing.

pre_run()

virtual void ippl::BaseManager::pre_run ( )

inlinevirtual

A method that should be used for setting up the simulation.

Derived classes can override this method to allocate memory, initialize variables, etc. The default implementation does nothing.

pre_step()

virtual void ippl::BaseManager::pre_step ( )

inlinevirtual

A method that should be used for preparation before perfoming a step of simulation.

The default implementation does nothing.

run()

void ippl::BaseManager::run ( int  nt )

inline

The main for loop fro running a simulation.

This method performs a simulation run by calling pre_step, advance, and post_step in a loop for a specified number of time steps.

Parameters

nt	The number of time steps to run the simulation.

---

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

• ippl-src/src/Manager/BaseManager.h