Add API for runtime remeshing (#224)

changelog-entries/224.md

@@ -0,0 +1 @@
+- Added API function `reset_mesh()`

cyprecice/Participant.pxd

@@ -65,6 +65,10 @@ cdef extern from "precice/Participant.hpp" namespace "precice":
 
         void setMeshTetrahedra (const string& meshName, vector[int] vertices)
 
+        # remeshing
+
+        void resetMesh (const string& meshName)
+
         # data access
 
         void writeData (const string& meshName, const string& dataName, vector[int] vertices, vector[double] values)

cyprecice/cyprecice.pyx

@@ -710,6 +710,42 @@ cdef class Participant:
 
         self.thisptr.setMeshTetrahedra (convert(mesh_name), cpp_vertices)
 
+    # remeshing
+
+
+    def reset_mesh (self, mesh_name):
+        """
+        Resets a mesh and allows setting it using set_mesh functions again.
+
+        Parameters
+        ----------
+        mesh_name : str
+            Name of the mesh to reset.
+
+        Notes
+        -----
+        This function is still experimental.
+        Please refer to the documentation on how to enable and use it.
+
+        Previous calls:
+            advance() has been called
+
+        Examples
+        --------
+        Reset a mesh with 5 vertices to have 3 vertices.
+
+        >>> positions = np.array([[1, 1], [2, 2], [3, 3], [4, 4], [5, 5]])
+        >>> mesh_name = "MeshOne"
+        >>> vertex_ids = participant.set_mesh_vertices(mesh_name, positions)
+        >>> # later in the coupling loop
+        >>> if remeshing_required():
+        >>>     participant.reset_mesh(mesh_name)
+        >>>     positions = np.array([[1, 1], [3, 3], [5, 5]])
+        >>>     vertex_ids = participant.set_mesh_vertices(mesh_name, positions)
+        """
+
+        self.thisptr.resetMesh (convert(mesh_name))
+
     # data access
 
     def write_data (self, mesh_name, data_name, vertex_ids, values):

test/Participant.cpp

@@ -237,6 +237,11 @@ void Participant::setMeshTetrahedra
     precice::span<const precice::VertexID> vertices)
 {}
 
+void Participant::resetMesh
+(
+    precice::string_view meshName)
+{}
+
 void Participant:: writeData
 (
   precice::string_view meshName,
@@ -320,4 +325,4 @@ std::string getVersionInformation()
   return fake_version;
 }
 
-} // namespace precice
+} // namespace precice

test/test_bindings_module.py

@@ -43,6 +43,11 @@ def test_requires_mesh_connectivity_for(self):
         fake_mesh_name = "FakeMesh"
         self.assertEqual(fake_bool, participant.requires_mesh_connectivity_for(fake_mesh_name))
 
+    def test_reset_mesh(self):
+        participant = precice.Participant("test", "dummy.xml", 0, 1)
+        fake_mesh_name = "FakeMesh"
+        participant.reset_mesh(fake_mesh_name)
+
     def test_set_mesh_vertices(self):
         participant = precice.Participant("test", "dummy.xml", 0, 1)
         fake_mesh_name = "FakeMesh"  # compare to test/SolverInterface.cpp, fake_mesh_name