Namespace fem was added to almost all classes and functions of the li…

…brary. This was done to avoid ambiguity when one uses this library with another one containing classes with the same names (for example, there is a class FiniteElement which is very popular everywhere).
martemyev · Mar 13, 2014 · ddc06ff · ddc06ff
1 parent 3cfd451
commit ddc06ff
Show file tree

Hide file tree

Showing 31 changed files with 194 additions and 7 deletions.
diff --git a/config.h.in b/config.h.in
@@ -3,9 +3,17 @@
 
 #include <string>
 
+// options defined in cmake
 #cmakedefine DEBUG
 #cmakedefine HAVE_64BIT_SIZE_T
 
+// the following two definitions are used
+// to wrap the code in namespace 'fem'.
+// thus all classes will be used like 'fem::NameOfClass'
+#define NAMESPACE_FEM_OPEN namespace fem {
+#define NAMESPACE_FEM_CLOSE }
+
+// constants from cmake
 const std::string HOME_DIRECTORY = "$ENV{HOME}";
 
 #endif // FEM_CONFIG_H
diff --git a/headers/config.h b/headers/config.h
@@ -3,9 +3,17 @@
 
 #include <string>
 
-/* #undef DEBUG */
-#define HAVE_64BIT_SIZE_T
+// options defined in cmake
+#define DEBUG
+/* #undef HAVE_64BIT_SIZE_T */
 
-const std::string HOME_DIRECTORY = "/u/artemyev";
+// the following two definitions are used
+// to wrap the code in namespace 'fem'.
+// thus all classes will be used like 'fem::NameOfClass'
+#define NAMESPACE_FEM_OPEN namespace fem {
+#define NAMESPACE_FEM_CLOSE }
+
+// constants from cmake
+const std::string HOME_DIRECTORY = "/home/artemiev";
 
 #endif // FEM_CONFIG_H
diff --git a/headers/csr_pattern.h b/headers/csr_pattern.h
@@ -1,12 +1,15 @@
 #ifndef FEM_SPARSE_FORMAT_H
 #define FEM_SPARSE_FORMAT_H
 
-#include <vector>
-#include <set>
+#include "config.h"
 #include "dof_handler.h"
 #include "rectangle.h"
+#include <vector>
+#include <set>
 
 
+NAMESPACE_FEM_OPEN
+
 
 enum CONNECTIVITY
 {
@@ -119,4 +122,7 @@ class CSRPattern
   CSRPattern& operator=(const CSRPattern&);
 };
 
+
+NAMESPACE_FEM_CLOSE
+
 #endif // FEM_SPARSE_FORMAT_H
diff --git a/headers/dof_handler.h b/headers/dof_handler.h
@@ -1,12 +1,16 @@
 #ifndef DOF_HANDLER_H
 #define DOF_HANDLER_H
 
+#include "config.h"
 #include "point.h"
 #include "edge.h"
 //#include "sym_csr_pattern.h"
 #include <vector>
 
 
+NAMESPACE_FEM_OPEN
+
+
 class FineMesh;
 class SymCSRPattern;
 class FiniteElement;
@@ -152,4 +156,7 @@ void associated_dg_edges(unsigned int ver_i,
                          std::vector<unsigned int> &assoc_dg_edges);
 
 
+
+NAMESPACE_FEM_CLOSE
+
 #endif // DOF_HANDLER_H
diff --git a/headers/edge.h b/headers/edge.h
@@ -1,9 +1,13 @@
 #ifndef EDGE_H
 #define EDGE_H
 
+#include "config.h"
 #include "line.h"
 #include <vector>
 
+NAMESPACE_FEM_OPEN
+
+
 class Point;
 class Triangle;
 
@@ -80,4 +84,6 @@ class Edge : public Line
 };
 
 
+NAMESPACE_FEM_CLOSE
+
 #endif // EDGE_H
diff --git a/headers/fine_mesh.h b/headers/fine_mesh.h
@@ -1,6 +1,7 @@
 #ifndef FINE_MESH_H
 #define FINE_MESH_H
 
+#include "config.h"
 #include "point.h"
 #include "triangle.h"
 #include "rectangle.h"
@@ -9,6 +10,7 @@
 #include <string>
 #include <set>
 
+NAMESPACE_FEM_OPEN
 
 
 class FineMesh
@@ -200,4 +202,6 @@ class FineMesh
                                         const Point &declared_max_point);
 };
 
+NAMESPACE_FEM_CLOSE
+
 #endif // FINE_MESH_H
diff --git a/headers/finite_element.h b/headers/finite_element.h
@@ -1,6 +1,11 @@
 #ifndef FEM_FINITE_ELEMENT_H
 #define FEM_FINITE_ELEMENT_H
 
+#include "config.h"
+
+NAMESPACE_FEM_OPEN
+
+
 
 class FiniteElement
 {
@@ -20,4 +25,6 @@ class FiniteElement
 };
 
 
+NAMESPACE_FEM_CLOSE
+
 #endif // FEM_FINITE_ELEMENT_H
diff --git a/headers/function.h b/headers/function.h
@@ -1,6 +1,11 @@
 #ifndef FEM_FUNCTION_H
 #define FEM_FUNCTION_H
 
+#include "config.h"
+
+NAMESPACE_FEM_OPEN
+
+
 class Point;
 
 class Function
@@ -11,4 +16,6 @@ class Function
 };
 
 
+NAMESPACE_FEM_CLOSE
+
 #endif // FEM_FUNCTION_H
diff --git a/headers/line.h b/headers/line.h
@@ -1,9 +1,14 @@
 #ifndef LINE_H
 #define LINE_H
 
+#include "config.h"
 #include <vector>
 #include "mesh_element.h"
 
+NAMESPACE_FEM_OPEN
+
+
+
 /**
  * Line keeps 3 numbers - the number of beginning vertex,
  * the number of the ending one, and a number of physical domain
@@ -76,4 +81,6 @@ class Line : public MeshElement
 };
 
 
+NAMESPACE_FEM_CLOSE
+
 #endif // LINE_H
diff --git a/headers/math_functions.h b/headers/math_functions.h
@@ -1,9 +1,14 @@
 #ifndef MATH_FUNCTIONS_H
 #define MATH_FUNCTIONS_H
 
+#include "config.h"
 #include "petscvec.h"
 #include "point.h"
 
+NAMESPACE_FEM_OPEN
+
+
+
 const double FLOAT_NUMBERS_EQUALITY_TOLERANCE = 1e-14;
 const double FLOAT_NUMBERS_EQUALITY_REDUCED_TOLERANCE = 1e-6;
 const double PI = 3.141592654;
@@ -40,4 +45,6 @@ double norm(const Point &vec);
 
 
 
+NAMESPACE_FEM_CLOSE
+
 #endif // MATH_FUNCTIONS_H
diff --git a/headers/mesh_element.h b/headers/mesh_element.h
@@ -1,8 +1,12 @@
 #ifndef MESH_ELEMENT_H
 #define MESH_ELEMENT_H
 
+#include "config.h"
 #include <vector>
 
+NAMESPACE_FEM_OPEN
+
+
 
 /**
  * This class implements the most part of functionality of
@@ -190,4 +194,6 @@ class MeshElement
 };
 
 
+NAMESPACE_FEM_CLOSE
+
 #endif // MESH_ELEMENT_H
diff --git a/headers/point.h b/headers/point.h
@@ -1,6 +1,11 @@
 #ifndef POINT_H
 #define POINT_H
 
+#include "config.h"
+
+NAMESPACE_FEM_OPEN
+
+
 
 /**
  * Point in 3-dimensional space.
@@ -75,5 +80,6 @@ class Point
 };
 
 
+NAMESPACE_FEM_CLOSE
 
 #endif // POINT_H
diff --git a/headers/quadrangle.h b/headers/quadrangle.h
@@ -1,9 +1,13 @@
 #ifndef FEM_QUADRANGLE_H
 #define FEM_QUADRANGLE_H
 
+#include "config.h"
 #include "mesh_element.h"
 #include "point.h"
 
+NAMESPACE_FEM_OPEN
+
+
 
 /**
  * Quadrangle is a 2-dimensional shape with 4 straight edges.
@@ -125,5 +129,6 @@ class Quadrangle : public MeshElement
 };
 
 
+NAMESPACE_FEM_CLOSE
 
 #endif // FEM_QUADRANGLE_H
diff --git a/headers/rectangle.h b/headers/rectangle.h
@@ -1,8 +1,12 @@
 #ifndef FEM_RECTANGLE_H
 #define FEM_RECTANGLE_H
 
+#include "config.h"
 #include "quadrangle.h"
 
+NAMESPACE_FEM_OPEN
+
+
 
 class Function;
 
@@ -125,4 +129,6 @@ class Rectangle : public Quadrangle
 };
 
 
+NAMESPACE_FEM_CLOSE
+
 #endif // FEM_RECTANGLE_H
diff --git a/headers/result.h b/headers/result.h
@@ -1,10 +1,15 @@
 #ifndef RESULT_H
 #define RESULT_H
 
+#include "config.h"
 #include "petscvec.h"
 #include <string>
 #include <vector>
 
+NAMESPACE_FEM_OPEN
+
+
+
 class DoFHandler;
 
 
@@ -64,4 +69,6 @@ class Result
 };
 
 
+NAMESPACE_FEM_CLOSE
+
 #endif // RESULT_H
diff --git a/headers/sym_csr_pattern.h b/headers/sym_csr_pattern.h
@@ -1,9 +1,12 @@
 #ifndef SYM_CSR_PATTERN_H
 #define SYM_CSR_PATTERN_H
 
+#include "config.h"
 #include "csr_pattern.h"
-//#include "dof_handler.h"
-//#include "fine_mesh.h"
+
+NAMESPACE_FEM_OPEN
+
+
 
 class DoFHandler;
 class FineMesh;
@@ -48,5 +51,6 @@ class SymCSRPattern : public CSRPattern
 };
 
 
+NAMESPACE_FEM_CLOSE
 
 #endif // SYM_CSR_PATTERN_H
diff --git a/headers/triangle.h b/headers/triangle.h
@@ -1,9 +1,13 @@
 #ifndef FEM_TRIANGLE_H
 #define FEM_TRIANGLE_H
 
+#include "config.h"
 #include "mesh_element.h"
 #include "point.h"
 
+NAMESPACE_FEM_OPEN
+
+
 
 class Edge;
 class DoFHandler;
@@ -287,5 +291,6 @@ class Triangle : public MeshElement
 
 
 
+NAMESPACE_FEM_CLOSE
 
 #endif // FEM_TRIANGLE_H
diff --git a/sources/csr_pattern.cpp b/sources/csr_pattern.cpp
@@ -3,6 +3,9 @@
 #include "fine_mesh.h"
 #include "auxiliary_functions.h"
 
+NAMESPACE_FEM_OPEN
+
+
 
 CSRPattern::CSRPattern()
 { }
@@ -289,3 +292,6 @@ const int* CSRPattern::nnz() const
     nnz[i] = _row[i + 1] - _row[i];
   return nnz;
 }
+
+
+NAMESPACE_FEM_CLOSE
diff --git a/sources/dof_handler.cpp b/sources/dof_handler.cpp
@@ -5,6 +5,9 @@
 #include "finite_element.h"
 #include <algorithm>
 
+NAMESPACE_FEM_OPEN
+
+
 
 DoFHandler::DoFHandler(FineMesh *fmesh)
   : _fmesh(fmesh),
@@ -336,3 +339,6 @@ void associated_dg_edges(unsigned int ver_i,
   // the number of found edges has to be 1 (for boundary edges) or 2 (for internal edges)
   expect(n_found_edges == 1 || n_found_edges == 2, "n_found_edges is not right");
 }
+
+
+NAMESPACE_FEM_CLOSE