chombo-discharge
CD_GeometryStepper.H
Go to the documentation of this file.
1 /* chombo-discharge
2  * Copyright © 2021 SINTEF Energy Research.
3  * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.
4  */
5 
12 #ifndef _GEOMETRY_STEPPER_
13 #define _GEOMETRY_STEPPER_
14 
15 // Our includes
16 #include <CD_TimeStepper.H>
17 #include <CD_NamespaceHeader.H>
18 
19 namespace Physics {
20 
24  namespace Geometry {
25 
32  {
33  public:
38 
42  virtual ~GeometryStepper();
43 
47  virtual void
48  setupSolvers() override;
49 
53  virtual void
54  allocate() override;
55 
59  virtual void
60  initialData() override;
61 
65  virtual void
66  postInitialize() override;
67 
71  virtual void
72  postCheckpointSetup() override;
73 
77  virtual void
78  registerRealms() override;
79 
83  virtual void
84  registerOperators() override;
85 
86 #ifdef CH_USE_HDF5
92  virtual void
93  writeCheckpointData(HDF5Handle& a_handle, const int a_lvl) const override;
94 #endif
95 #ifdef CH_USE_HDF5
101  virtual void
102  readCheckpointData(HDF5Handle& a_handle, const int a_lvl) override;
103 #endif
104 
109  virtual int
110  getNumberOfPlotVariables() const override;
111 
115  virtual Vector<std::string>
116  getPlotVariableNames() const override;
117 
125  virtual void
126  writePlotData(LevelData<EBCellFAB>& a_output,
127  int& a_icomp,
128  const std::string a_realm,
129  const int a_level) const override;
130 
135  virtual Real
136  computeDt() override;
137 
144  virtual Real
145  advance(const Real a_dt) override;
146 
153  virtual void
154  synchronizeSolverTimes(const int a_step, const Real a_time, const Real a_dt) override;
155 
160  virtual void
161  printStepReport() override;
162 
168  virtual void
169  preRegrid(const int a_lmin, const int a_oldFinestLevel) override;
170 
177  virtual void
178  regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) override;
179 
186  virtual void
187  postRegrid() override;
188  };
189  } // namespace Geometry
190 } // namespace Physics
191 
192 #include <CD_NamespaceFooter.H>
193 
194 #endif
Declaration of main (abstract) time stepper class.
This implementation does absolutely nothing – it instantiates a TimeStepper with empty functionality.
Definition: CD_GeometryStepper.H:32
virtual void registerOperators() override
operator registration (does nothing)
Definition: CD_GeometryStepper.cpp:48
virtual void postRegrid() override
Perform post-regrid operations (does nothing)
Definition: CD_GeometryStepper.cpp:111
virtual void initialData() override
Fill solver initial data (does nothing)
Definition: CD_GeometryStepper.cpp:32
virtual void writePlotData(LevelData< EBCellFAB > &a_output, int &a_icomp, const std::string a_realm, const int a_level) const override
Write plot data to output holder (does nothing since there's no IO form this class)
Definition: CD_GeometryStepper.cpp:64
virtual void regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) override
Time stepper regrid method (does nothing)
Definition: CD_GeometryStepper.cpp:107
virtual void synchronizeSolverTimes(const int a_step, const Real a_time, const Real a_dt) override
Synchronzie solver times and time steps (does nothing)
Definition: CD_GeometryStepper.cpp:95
virtual void allocate() override
Allocate solver internals (does nothing)
Definition: CD_GeometryStepper.cpp:28
virtual void preRegrid(const int a_lmin, const int a_oldFinestLevel) override
Perform pre-regrid operations (does nothing)
Definition: CD_GeometryStepper.cpp:103
virtual void setupSolvers() override
Set up solvers (does nothing)
Definition: CD_GeometryStepper.cpp:24
virtual Vector< std::string > getPlotVariableNames() const override
Get plot variable names (returns empty vector)
Definition: CD_GeometryStepper.cpp:77
virtual int getNumberOfPlotVariables() const override
Get the number of plot variables for this time stepper.
Definition: CD_GeometryStepper.cpp:71
virtual Real advance(const Real a_dt) override
Advancement routine. Does nothing.
Definition: CD_GeometryStepper.cpp:89
virtual void postInitialize() override
Post initialization function (does nothing)
Definition: CD_GeometryStepper.cpp:36
virtual ~GeometryStepper()
Destructor (does nothing)
Definition: CD_GeometryStepper.cpp:20
virtual void registerRealms() override
Realm register – does nothing.
Definition: CD_GeometryStepper.cpp:44
GeometryStepper()
Destructor (does nothing)
Definition: CD_GeometryStepper.cpp:18
virtual void postCheckpointSetup() override
Post-restart function (does nothing)
Definition: CD_GeometryStepper.cpp:40
virtual void printStepReport() override
Print a step report (does nothing)
Definition: CD_GeometryStepper.cpp:99
virtual Real computeDt() override
Compute a time step to be used by Driver.
Definition: CD_GeometryStepper.cpp:83
Base class for advancing equations.
Definition: CD_TimeStepper.H:30
Name containing various physics models for running chombo-discharge code.
Definition: CD_AdvectionDiffusion.H:15