METHOD
simulation.h
Go to the documentation of this file.
1 #ifndef SIMULATION_H
2 #define SIMULATION_H
3 
4 #include "initFunc.h"
5 #include "simData.h"
6 #include "model.h"
7 #include "timeInt.h"
8 #include "boundaryConds.h"
9 #include "flux.h"
10 #include "saveData.h"
11 #include "platformEnv.h"
12 
13 
15 
24 {
25  public:
26 
27  Data * data;
28 
29  private:
30 
32 
34 
36 
37  Bcs * bcs;
38 
40 
42 
44 
45  public:
46 
48 
58  Simulation(Data * data, PlatformEnv *env);
59 
61  virtual ~Simulation();
62 
63 
64 
66 
84  void set(InitialFunc * init, Model * model,
87  SaveData * save = NULL);
88 
89 
90 
92 
100  void updateTime();
101 
102 
103 
105 
115  void evolve(bool output=false, int safety=-1);
116 
117 
118 };
119 
120 #endif
void updateTime()
Incrememt the system forward by a single timestep.
The Simulation interface for the programme
Definition: simulation.h:23
TimeIntegrator * timeInt
Pointer to TimeIntegrator object.
Definition: simulation.h:35
Boundary Conditions
Definition: boundaryConds.h:13
Model * model
Pointer to Model object, contains governing equations and spectral decomposition. ...
Definition: simulation.h:33
PlatformEnv
Definition: platformEnv.h:16
Data * data
Pointer to Data class containing global simulation data.
Definition: simulation.h:27
void evolve(bool output=false, int safety=-1)
Run the current set up until the end time.
virtual ~Simulation()
Destructor frees alloc'd memory.
PlatformEnv * env
Pointer to PlatformEnv object.
Definition: simulation.h:43
Physics model that we want to use
Definition: model.h:15
InitialFunc * init
Pointer to InitialFunc object to set up starting data.
Definition: simulation.h:31
FluxMethod * fluxMethod
Pointer to FluxMethod object.
Definition: simulation.h:39
Class used to save simulation data
Definition: saveData.h:23
General form of the time integrator
Definition: timeInt.h:85
Abstract base class for any future initial data classes
Definition: initFunc.h:12
Abstract base class for flux reconstruction methods
Definition: flux.h:17
Bcs * bcs
Pointer to boundary conditions, Bcs, object.
Definition: simulation.h:37
Data object
Definition: simData.h:49
Simulation(Data *data, PlatformEnv *env)
Constructor.
SaveData * save
Pointer to SaveData object.
Definition: simulation.h:41