Add note in the cpp-dummy that pickling support does not work due to …

…no good way to pass the sim id to the new micro simulation instance
precice · Mar 20, 2024 · 0a82966 · 0a82966
1 parent edb60de
commit 0a82966
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/examples/cpp-dummy/micro_cpp_dummy.cpp b/examples/cpp-dummy/micro_cpp_dummy.cpp
@@ -68,7 +68,8 @@ PYBIND11_MODULE(micro_dummy, m) {
         .def("solve", &MicroSimulation::solve)
         .def("get_state", &MicroSimulation::get_state)
         .def("set_state", &MicroSimulation::set_state)
-        .def(py::pickle(
+        // 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__
                 return ms.get_state();
             },