Merge pull request #63 from VTT-ProperTune/ahojukka5/free_function_step

Add free function void(Simulator &s, Model &m)

Author: ahojukka5

apps/tungsten.cpp

@@ -285,6 +285,22 @@ void from_json(const json &j, Tungsten &m) {
   p.q4_bar = p.q40_bar;
 }
 
+/*
+Sometimes, one need to get access to the simulator during stepping. This can be
+done by overriding the following function. The default implementation just runs
+m.step(t) so if there's no need to access the simulator, it's not necessary to
+override this function.
+*/
+void step(Simulator &s, Tungsten &m) {
+#ifdef TUNGSTEN_DEBUG
+  if (m.rank0) cout << "Performing Tungsten step" << endl;
+#endif
+  double t = s.get_time().get_current();
+  m.step(t);
+  // perform some extra logic after the step, which can access both simulator
+  // and model
+}
+
 int main(int argc, char *argv[]) {
   cout << std::fixed;
   cout.precision(3);

include/openpfc/simulator.hpp

@@ -32,6 +32,8 @@ along with this program.  If not, see https://www.gnu.org/licenses/.
 
 namespace pfc {
 
+void step(class Simulator &s, Model &m);
+
 /**
  * @brief The Simulator class is responsible for running the simulation of the
  * model.
@@ -270,6 +272,10 @@ class Simulator {
   }
 };
 
+void step(Simulator &s, Model &m) {
+  m.step(s.get_time().get_current());
+}
+
 } // namespace pfc
 
 #endif // PFC_SIMULATOR_HPP

include/openpfc/ui.hpp

@@ -681,7 +681,7 @@ template <class ConcreteModel> class App {
       double l_fft_time = 0.0;
       MPI_Barrier(m_comm);
       l_steptime = -MPI_Wtime();
-      model.step(time.get_current());
+      step(simulator, model);
       MPI_Barrier(m_comm);
       l_steptime += MPI_Wtime();
       l_fft_time = fft.get_fft_time();