Merge branch 'feature/meshgraph-io' into 'master'

Separate MeshGraph input/output functions into a new class

See merge request nektar/nektar!1778

CHANGELOG.md

 Changelog
 =========
+v5.7.0
+------
+**Library**
+- Separate MeshGraph input/output functions into a new class (!1778)
 
 v5.7.0
 ------

docs/developer-guide/library/SpatialDomains/spdomains-datastructures.tex

@@ -61,4 +61,9 @@ At its core, the items contained within SpatialDomains are meant to represent th
 
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsection{MeshGraph}
+\subsection{MeshGraph and MeshGraphIO}
\ No newline at end of file
+The MeshGraph class holds the geometric information about each element and the connectivity of these elements to form the domain, in arrays of Geometry objects.
+The MeshGraphIO classes handle MeshGraph's reading and writing operations in the different file formats.
+
+Since v5.7.0 (when MeshGraph's input/output operations were moved to the separate MeshGraphIO classes) a MeshGraph is instantiated by calling a MeshGraphIO subclass' Read method.
+Creating a MeshGraph object generates the hierarchical mesh entity data structures, constructing the domain $\Omega$ by instantiating a corresponding Geometry object for each element $\Omega_e$.
\ No newline at end of file

library/Demos/Collections/CollectionTiming.cpp

@@ -42,7 +42,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ExpList.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -99,7 +99,7 @@ int main(int argc, char *argv[])
 
     // Read in mesh
     SpatialDomains::MeshGraphSharedPtr graph =
-        SpatialDomains::MeshGraph::Read(session);
+        SpatialDomains::MeshGraphIO::Read(session);
 
     // BwdTrans operator
     for (int imp = 1; imp < 5; ++imp)

library/Demos/MatrixFreeOps/Helmholtz2D_MFO.cpp

@@ -41,7 +41,7 @@
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField.h>
 #include <MultiRegions/ExpList.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -83,7 +83,7 @@ int main(int argc, char *argv[])
         //----------------------------------------------
         // Read in mesh from input file
         SpatialDomains::MeshGraphSharedPtr graph2D =
-            SpatialDomains::MeshGraph::Read(vSession);
+            SpatialDomains::MeshGraphIO::Read(vSession);
         //----------------------------------------------
 
         //----------------------------------------------

library/Demos/MatrixFreeOps/Helmholtz3D_MFO.cpp

@@ -41,7 +41,7 @@
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField.h>
 #include <MultiRegions/ExpList.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -83,7 +83,7 @@ int main(int argc, char *argv[])
         //----------------------------------------------
         // Read in mesh from input file
         SpatialDomains::MeshGraphSharedPtr graph2D =
-            SpatialDomains::MeshGraph::Read(vSession);
+            SpatialDomains::MeshGraphIO::Read(vSession);
         //----------------------------------------------
 
         //----------------------------------------------

library/Demos/MatrixFreeOps/MFO_Timing.cpp

@@ -43,7 +43,7 @@
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField.h>
 #include <MultiRegions/ExpList.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -91,7 +91,7 @@ int main(int argc, char *argv[])
         //----------------------------------------------
         // Read in mesh from input file
         SpatialDomains::MeshGraphSharedPtr graph2D =
-            SpatialDomains::MeshGraph::Read(vSession);
+            SpatialDomains::MeshGraphIO::Read(vSession);
         //----------------------------------------------
 
         //----------------------------------------------

library/Demos/MatrixFreeOps/MFO_Timing_3D.cpp

@@ -43,7 +43,7 @@
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField.h>
 #include <MultiRegions/ExpList.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -91,7 +91,7 @@ int main(int argc, char *argv[])
         //----------------------------------------------
         // Read in mesh from input file
         SpatialDomains::MeshGraphSharedPtr graph2D =
-            SpatialDomains::MeshGraph::Read(vSession);
+            SpatialDomains::MeshGraphIO::Read(vSession);
         //----------------------------------------------
 
         //----------------------------------------------

library/Demos/MultiRegions/Deriv3DHomo1D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField3DHomogeneous1D.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -65,7 +65,7 @@ int main(int argc, char *argv[])
     //----------------------------------------------
     // Read in mesh from input file
     SpatialDomains::MeshGraphSharedPtr graph2D =
-        SpatialDomains::MeshGraph::Read(vSession);
+        SpatialDomains::MeshGraphIO::Read(vSession);
     //----------------------------------------------
 
     //----------------------------------------------

library/Demos/MultiRegions/Deriv3DHomo1D_SingleMode.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField3DHomogeneous1D.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -65,7 +65,7 @@ int main(int argc, char *argv[])
     //----------------------------------------------
     // Read in mesh from input file
     SpatialDomains::MeshGraphSharedPtr graph2D =
-        SpatialDomains::MeshGraph::Read(vSession);
+        SpatialDomains::MeshGraphIO::Read(vSession);
     //----------------------------------------------
 
     //----------------------------------------------

library/Demos/MultiRegions/Deriv3DHomo2D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField3DHomogeneous2D.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -65,7 +65,7 @@ int main(int argc, char *argv[])
     //----------------------------------------------
     // Read in mesh from input file
     SpatialDomains::MeshGraphSharedPtr graph1D =
-        SpatialDomains::MeshGraph::Read(vSession);
+        SpatialDomains::MeshGraphIO::Read(vSession);
     //----------------------------------------------
 
     //----------------------------------------------

library/Demos/MultiRegions/HDGHelmholtz1D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/DisContField.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -69,7 +69,7 @@ int main(int argc, char *argv[])
     //----------------------------------------------
     // Read in mesh from input file
     SpatialDomains::MeshGraphSharedPtr graph1D =
-        SpatialDomains::MeshGraph::Read(vSession);
+        SpatialDomains::MeshGraphIO::Read(vSession);
     //----------------------------------------------
 
     //----------------------------------------------

library/Demos/MultiRegions/HDGHelmholtz2D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/DisContField.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 // #define TIMING
 #ifdef TIMING
@@ -81,7 +81,7 @@ int main(int argc, char *argv[])
     //----------------------------------------------
     // Read in mesh from input file
     SpatialDomains::MeshGraphSharedPtr graph2D =
-        SpatialDomains::MeshGraph::Read(vSession);
+        SpatialDomains::MeshGraphIO::Read(vSession);
     //----------------------------------------------
 
     //----------------------------------------------

library/Demos/MultiRegions/HDGHelmholtz3D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/DisContField.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 // #define TIMING
 #ifdef TIMING
@@ -80,7 +80,7 @@ int main(int argc, char *argv[])
     //----------------------------------------------
     // Read in mesh from input file
     SpatialDomains::MeshGraphSharedPtr graph3D =
-        SpatialDomains::MeshGraph::Read(vSession);
+        SpatialDomains::MeshGraphIO::Read(vSession);
     //----------------------------------------------
 
     //----------------------------------------------

library/Demos/MultiRegions/HDGHelmholtz3DHomo1D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/DisContField3DHomogeneous1D.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 // #define TIMING
 #ifdef TIMING
@@ -83,7 +83,7 @@ int main(int argc, char *argv[])
     //----------------------------------------------
     // Read in mesh from input file
     SpatialDomains::MeshGraphSharedPtr graph2D =
-        SpatialDomains::MeshGraph::Read(vSession);
+        SpatialDomains::MeshGraphIO::Read(vSession);
     //----------------------------------------------
 
     //----------------------------------------------

library/Demos/MultiRegions/Helmholtz1D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -72,7 +72,7 @@ int main(int argc, char *argv[])
         //----------------------------------------------
         // Read in mesh from input file
         SpatialDomains::MeshGraphSharedPtr graph1D =
-            SpatialDomains::MeshGraph::Read(vSession);
+            SpatialDomains::MeshGraphIO::Read(vSession);
         //----------------------------------------------
 
         //----------------------------------------------

library/Demos/MultiRegions/Helmholtz2D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -83,7 +83,7 @@ int main(int argc, char *argv[])
         //----------------------------------------------
         // Read in mesh from input file
         SpatialDomains::MeshGraphSharedPtr graph2D =
-            SpatialDomains::MeshGraph::Read(vSession);
+            SpatialDomains::MeshGraphIO::Read(vSession);
         //----------------------------------------------
 
         //----------------------------------------------

library/Demos/MultiRegions/Helmholtz3D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -86,7 +86,7 @@ int main(int argc, char *argv[])
         //----------------------------------------------
         // Read in mesh from input file
         SpatialDomains::MeshGraphSharedPtr graph3D =
-            SpatialDomains::MeshGraph::Read(vSession);
+            SpatialDomains::MeshGraphIO::Read(vSession);
         //----------------------------------------------
 
         //----------------------------------------------

library/Demos/MultiRegions/Helmholtz3DHomo1D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField3DHomogeneous1D.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -73,7 +73,7 @@ int main(int argc, char *argv[])
     //----------------------------------------------
     // Read in mesh from input file
     SpatialDomains::MeshGraphSharedPtr graph2D =
-        SpatialDomains::MeshGraph::Read(vSession);
+        SpatialDomains::MeshGraphIO::Read(vSession);
     //----------------------------------------------
 
     //----------------------------------------------

library/Demos/MultiRegions/Helmholtz3DHomo2D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField3DHomogeneous2D.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -67,7 +67,7 @@ int main(int argc, char *argv[])
     //----------------------------------------------
     // Read in mesh from input file
     SpatialDomains::MeshGraphSharedPtr graph1D =
-        SpatialDomains::MeshGraph::Read(vSession);
+        SpatialDomains::MeshGraphIO::Read(vSession);
     //----------------------------------------------
 
     //----------------------------------------------

library/Demos/MultiRegions/Int3DHomo1D.cpp

@@ -39,7 +39,7 @@
 #include <LibUtilities/Communication/Comm.h>
 #include <LibUtilities/Memory/NekMemoryManager.hpp>
 #include <MultiRegions/ContField3DHomogeneous1D.h>
-#include <SpatialDomains/MeshGraph.h>
+#include <SpatialDomains/MeshGraphIO.h>
 
 using namespace std;
 using namespace Nektar;
@@ -65,7 +65,7 @@ int main(int argc, char *argv[])
     //----------------------------------------------
     // Read in mesh from input file
     SpatialDomains::MeshGraphSharedPtr graph2D =
-        SpatialDomains::MeshGraph::Read(vSession);
+        SpatialDomains::MeshGraphIO::Read(vSession);
     //----------------------------------------------
 
     //----------------------------------------------