SimulationLoop

About the SimulationLoop class

The WaveBlocks Project

@author: R. Bourquin @copyright: Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015, 2016 R. Bourquin @license: Modified BSD License

Inheritance diagram

Class documentation

class WaveBlocksND.SimulationLoop(parameters)

This class acts as the main simulation loop. It owns a propagator that propagates a set of initial values during a time evolution. It is responsible for preparing the simulation, setting up initial values and store the simulation data with the help of an IOManager instance.

end_simulation()

Do the necessary cleanup after a simulation. For example request the IOManager to write the data and close the output files. Shut down the simulation process. :raise: NotImplementedError This is an abstract base class.

prepare_simulation()

Set up a propagator for the simulation loop. Set the potential and initial values according to the configuration. :raise: NotImplementedError This is an abstract base class.

run_simulation()

Run the simulation. This method will implement the central loop running over all timesteps. Inside of this loop it will call the propagate method of its propagator and save the simulation results. :raise: NotImplementedError This is an abstract base class.