Update docstring / cleanup

lutraconsulting · Mar 19, 2024 · 04a97c6 · 04a97c6
1 parent c0ff5c3
commit 04a97c6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/mdal/frmts/mdal_3di.hpp b/mdal/frmts/mdal_3di.hpp
@@ -60,6 +60,12 @@ namespace MDAL
    * line center. Data is specified on calculation nodes (i.e. dataset defined on faces)
    * and on lines (i.e. dataset defined on edges - not implemented yet)
    *
+   * The 2D mesh consists of two mostly overlapping meshes, one for groundwater data and one
+   * for surface water. Each face belongs to either one of them depending on its Node_type values.
+   * While the whole mesh data can be accessed using the "Mesh2D" mesh name, the two sub-meshes
+   * are individually accessible using "Mesh2D_groundwater" and "Mesh2D_surface_water"
+   * mesh names respectively.
+   *
    * The 1D Mesh is present too, but not parsed yet.
    */
   class Driver3Di: public DriverCF

diff --git a/tests/test_3di.cpp b/tests/test_3di.cpp
@@ -18,7 +18,6 @@ TEST( Mesh3DiTest, Mesh2Dgroundwater )
   std::string path = test_file( "/3di/2d_groundwater/results_3di.nc" );
   EXPECT_EQ( MDAL_MeshNames( path.c_str() ), "3Di:\"" + path + "\":Mesh2D;;3Di:\"" + path + "\":Mesh2D_groundwater;;3Di:\"" + path + "\":Mesh2D_surface_water" );
   std::string uri = "3Di:\"" + path + "\":Mesh2D_groundwater";
-//  std::string uri = "3Di:\"" + path + "\":Mesh2D";
   MDAL_MeshH m = MDAL_LoadMesh( uri.c_str() );
   ASSERT_NE( m, nullptr );
   MDAL_Status s = MDAL_LastStatus();
@@ -237,7 +236,6 @@ TEST( Mesh3DiTest, Mesh2Dsurface_water )
   std::string path = test_file( "/3di/2d_groundwater/results_3di.nc" );
   EXPECT_EQ( MDAL_MeshNames( path.c_str() ), "3Di:\"" + path + "\":Mesh2D;;3Di:\"" + path + "\":Mesh2D_groundwater;;3Di:\"" + path + "\":Mesh2D_surface_water" );
   std::string uri = "3Di:\"" + path + "\":Mesh2D_surface_water";
-  //  std::string uri = "3Di:\"" + path + "\":Mesh2D";
   MDAL_MeshH m = MDAL_LoadMesh( uri.c_str() );
   ASSERT_NE( m, nullptr );
   MDAL_Status s = MDAL_LastStatus();