Model Instancing to reduce memory footprint

examples/cpp-dummy/micro_cpp_dummy.cpp

@@ -59,6 +59,11 @@ py::list MicroSimulation::get_state() const
     return state_python;
 }
 
+int MicroSimulation::get_global_id() const
+{
+    return _sim_id;
+}
+
 PYBIND11_MODULE(micro_dummy, m) {
     // optional docstring
     m.doc() = "pybind11 micro dummy plugin";
@@ -68,6 +73,7 @@ PYBIND11_MODULE(micro_dummy, m) {
         .def("solve", &MicroSimulation::solve)
         .def("get_state", &MicroSimulation::get_state)
         .def("set_state", &MicroSimulation::set_state)
+        .def("get_global_id", &MicroSimulation::get_global_id)
         // Pickling support does not work currently, as there is no way to pass the simulation ID to the new instance ms.
         .def(py::pickle( // https://pybind11.readthedocs.io/en/latest/advanced/classes.html#pickling-support
             [](const MicroSimulation &ms) { // __getstate__

examples/cpp-dummy/micro_cpp_dummy.hpp

@@ -20,6 +20,7 @@ class MicroSimulation
 
     void set_state(py::list state);
     py::list get_state() const;
+    int get_global_id() const;
 
 private:
     int _sim_id;

examples/python-dummy/micro_dummy.py

@@ -32,3 +32,6 @@ def set_state(self, state):
 
     def get_state(self):
         return self._state
+
+    def get_global_id(self):
+        return self._sim_id

micro_manager/adaptivity/adaptivity.py

@@ -11,7 +11,7 @@
 
 class AdaptivityCalculator:
     def __init__(
-        self, configurator, nsims, micro_problem_cls, base_logger, rank
+        self, configurator, nsims, micro_problem_cls, model_manager, base_logger, rank
     ) -> None:
         """
         Class constructor.
@@ -24,6 +24,8 @@ def __init__(
             Number of micro simulations.
         micro_problem_cls : callable
             Class of micro problem.
+        model_manager : object
+            Handles instantiation of micro simulation.
         base_logger : object of class Logger
             Logger object to log messages.
         rank : int
@@ -37,6 +39,7 @@ def __init__(
         self._adaptivity_output_type = configurator.get_adaptivity_output_type()
 
         self._micro_problem_cls = micro_problem_cls
+        self._model_manager = model_manager
 
         self._coarse_tol = 0.0
         self._ref_tol = 0.0

micro_manager/adaptivity/adaptivity_selection.py

@@ -0,0 +1,50 @@
+from .global_adaptivity import GlobalAdaptivityCalculator
+from .global_adaptivity_lb import GlobalAdaptivityLBCalculator
+from .local_adaptivity import LocalAdaptivityCalculator
+from .adaptivity import AdaptivityCalculator
+
+
+def create_adaptivity_calculator(
+    config,
+    local_number_of_sims,
+    global_number_of_sims,
+    global_ids_of_local_sims,
+    participant,
+    logger,
+    rank,
+    comm,
+    micro_problem_cls,
+    model_manager,
+    use_lb,
+) -> AdaptivityCalculator:
+    adaptivity_type = config.get_adaptivity_type()
+
+    if adaptivity_type == "local":
+        return LocalAdaptivityCalculator(
+            config,
+            local_number_of_sims,
+            logger,
+            rank,
+            comm,
+            micro_problem_cls,
+            model_manager,
+        )
+
+    if adaptivity_type == "global":
+        cls = GlobalAdaptivityCalculator
+        if use_lb:
+            cls = GlobalAdaptivityLBCalculator
+
+        return cls(
+            config,
+            global_number_of_sims,
+            global_ids_of_local_sims,
+            participant,
+            logger,
+            rank,
+            comm,
+            micro_problem_cls,
+            model_manager,
+        )
+
+    raise ValueError("Unknown adaptivity type")

micro_manager/adaptivity/global_adaptivity.py

@@ -26,6 +26,7 @@ def __init__(
         rank: int,
         comm,
         micro_problem_cls,
+        model_manager,
     ) -> None:
         """
         Class constructor.
@@ -48,9 +49,16 @@ def __init__(
             Communicator for MPI.
         micro_problem_cls : callable
             Class of micro problem.
+        model_manager : object of class ModelManager
+            Handles instantiation of the micro simulation.
         """
         super().__init__(
-            configurator, global_number_of_sims, micro_problem_cls, base_logger, rank
+            configurator,
+            global_number_of_sims,
+            micro_problem_cls,
+            model_manager,
+            base_logger,
+            rank,
         )
         self._global_number_of_sims = global_number_of_sims
         self._global_ids = global_ids
@@ -459,7 +467,9 @@ def _update_inactive_sims(self, micro_sims: list) -> None:
         # Only handle activation of simulations on this rank
         for gid in to_be_activated_gids:
             to_be_activated_lid = self._global_ids.index(gid)
-            micro_sims[to_be_activated_lid] = self._micro_problem_cls(gid)
+            micro_sims[to_be_activated_lid] = self._model_manager.get_instance(
+                gid, self._micro_problem_cls
+            )
             assoc_active_gid = self._sim_is_associated_to[gid]
 
             if self._is_sim_on_this_rank[
@@ -496,7 +506,9 @@ def _update_inactive_sims(self, micro_sims: list) -> None:
             local_ids = to_be_activated_map[gid]
             for lid in local_ids:
                 # Create the micro simulation object and set its state
-                micro_sims[lid] = self._micro_problem_cls(self._global_ids[lid])
+                micro_sims[lid] = self._model_manager.get_instance(
+                    self._global_ids[lid], self._micro_problem_cls
+                )
                 micro_sims[lid].set_state(state)
 
         # Delete the micro simulation object if it is inactive

micro_manager/adaptivity/global_adaptivity_lb.py

@@ -23,6 +23,7 @@ def __init__(
         rank: int,
         comm,
         micro_problem_cls: callable,
+        model_manager,
     ) -> None:
         """
         Class constructor.
@@ -45,6 +46,8 @@ def __init__(
             Communicator for MPI.
         micro_problem_cls : callable
             Class of micro problem.
+        model_manager : object of class ModelManager
+            Handles instantiation of the micro simulation.
         """
         super().__init__(
             configurator,
@@ -55,6 +58,7 @@ def __init__(
             rank,
             comm,
             micro_problem_cls,
+            model_manager,
         )
 
         self._base_logger = base_logger
@@ -367,7 +371,9 @@ def _move_active_sims(
         # Create simulations and set them to the received states
         for req in recv_reqs:
             output, gid = req.wait()
-            micro_sims.append(self._micro_problem_cls(gid))
+            micro_sims.append(
+                self._model_manager.get_instance(gid, self._micro_problem_cls)
+            )
             micro_sims[-1].set_state(output)
             self._global_ids.append(gid)
             self._is_sim_on_this_rank[gid] = True

micro_manager/adaptivity/local_adaptivity.py

@@ -20,6 +20,7 @@ def __init__(
         rank,
         comm,
         micro_problem_cls,
+        model_manager,
     ) -> None:
         """
         Class constructor.
@@ -38,8 +39,12 @@ def __init__(
             Communicator for MPI.
         micro_problem_cls : callable
             Class of micro problem.
+        model_manager : object of class ModelManager
+            Handles instantiation of micro simulation.
         """
-        super().__init__(configurator, num_sims, micro_problem_cls, base_logger, rank)
+        super().__init__(
+            configurator, num_sims, micro_problem_cls, model_manager, base_logger, rank
+        )
         self._comm = comm
 
         # similarity_dists: 2D array having similarity distances between each micro simulation pair
@@ -292,7 +297,7 @@ def _update_inactive_sims(self, micro_sims: list) -> None:
         # Update the set of inactive micro sims
         for i in to_be_activated_ids:
             associated_active_id = self._sim_is_associated_to[i]
-            micro_sims[i] = self._micro_problem_cls(i)
+            micro_sims[i] = self._model_manager.get_instance(i, self._micro_problem_cls)
             micro_sims[i].set_state(micro_sims[associated_active_id].get_state())
             self._sim_is_associated_to[
                 i