Migrate include after ifdefs in core and solver h (#1170)

Description Everywhere throughout the include files of the core and the solver library, there were multiple includes that were defined before the #ifndef -> #define -> #endif statements. This is mostly aesthetics, but this can also have a small impact on compilation time, especially on systems with a slow filesystem (e.g. the clusters). See for example: https://stackoverflow.com/questions/20988705/is-an-include-before-ifdef-define-include-guard-okay Additionally, some of the include guards were in capital letters, some were not. Heck, some were even missing. So I took the opportunity to uniformize thing. I limited myself to core/solver as a first step, but in a follow-up PR I could do it for the other parts of the library. Testing There are not tests required here. If the code compiles, everything will be fine. Documentation No documentation was modified in the making of this PR. Co-authored-by: Audrey Collard-Daigneault <71884806+acdaigneault@users.noreply.github.com> Co-authored-by: Amishga Alphonius <107414376+AmishgaAlphonius@users.noreply.github.com> Former-commit-id: eea049f
chaos-polymtl · Jun 13, 2024 · 470290a · 470290a
1 parent 6567cbe
commit 470290a
Show file tree

Hide file tree

Showing 48 changed files with 135 additions and 164 deletions.
diff --git a/include/core/auxiliary_math_functions.h b/include/core/auxiliary_math_functions.h
@@ -13,12 +13,12 @@
  *
  * ---------------------------------------------------------------------
  */
-#include "core/parameters.h"
 
-#include <cfloat>
 
-#ifndef LETHE_AUXILIARY_MATH_FUNCTIONS_H
-#  define LETHE_AUXILIARY_MATH_FUNCTIONS_H
+#ifndef lethe_auxiliary_math_functions_h
+#define lethe_auxiliary_math_functions_h
+
+#include <limits>
 
 /**
  * Carries out the calculation of the harmonic mean of two values.
@@ -31,7 +31,8 @@
 inline double
 harmonic_mean(const double &value_one, const double &value_two)
 {
-  return (2 * value_one * value_two / (value_one + value_two + DBL_MIN));
+  return (2 * value_one * value_two /
+          (value_one + value_two + std::numeric_limits<double>::min()));
 }
 
-#endif // LETHE_AUXILIARY_MATH_FUNCTIONS_H
+#endif
diff --git a/include/core/boundary_conditions.h b/include/core/boundary_conditions.h
@@ -12,9 +12,6 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Author: Bruno Blais, Polytechnique Montreal, 2019 -
  */
 
 #ifndef lethe_boundary_conditions_h

diff --git a/include/core/dem_properties.h b/include/core/dem_properties.h
@@ -12,22 +12,19 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Author: Bruno Blais, Polytechnique Montreal, 2020-
  */
 
-#include <iostream>
+
+
+#ifndef lethe_dem_properties_h
+#define lethe_dem_properties_h
+
 #include <string>
-#include <tuple>
 #include <vector>
 
-#ifndef Lethe_DEM_properties_h
-#  define Lethe_DEM_properties_h
-
 namespace DEM
 {
-  /* This enum class is reponsible for the handling the specific indexes of the
+  /* This enum class is responsible for the handling the specific indexes of the
    * particles properties within the property pool and also to generate
    * the associative names for the properties
    * This is the only part where we should use a classical enum because it is

diff --git a/include/core/evaporation_model.h b/include/core/evaporation_model.h
@@ -13,6 +13,7 @@
  *
  * ---------------------------------------------------------------------
  */
+
 #ifndef lethe_evaporation_model_h
 #define lethe_evaporation_model_h
 

diff --git a/include/core/grids.h b/include/core/grids.h
@@ -12,9 +12,6 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Author: Bruno Blais, Polytechnique Montreal, 2020 -
  */
 
 #ifndef lethe_grids_h

diff --git a/include/core/ib_particle.h b/include/core/ib_particle.h
@@ -15,10 +15,14 @@
  *
  */
 
+
+
+#ifndef lethe_ib_particle_h
+#define lethe_ib_particle_h
+
 #include <core/dem_properties.h>
 #include <core/shape.h>
 
-#include <deal.II/base/auto_derivative_function.h>
 #include <deal.II/base/function_signed_distance.h>
 #include <deal.II/base/parsed_function.h>
 #include <deal.II/base/point.h>
@@ -27,9 +31,6 @@
 
 #include <vector>
 
-#ifndef lethe_ib_particle_h
-#  define lethe_ib_particle_h
-
 using namespace dealii;
 
 /**

diff --git a/include/core/ib_stencil.h b/include/core/ib_stencil.h
@@ -12,8 +12,6 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
- *
- * Author: Lucka Barbeau, Bruno Blais, Polytechnique Montreal, 2019 -
  */
 
 #ifndef lethe_ib_stencil_h

diff --git a/include/core/inexact_newton_non_linear_solver.h b/include/core/inexact_newton_non_linear_solver.h
@@ -14,8 +14,8 @@
  * ---------------------------------------------------------------------
  */
 
-#ifndef lethe_inexact_newton_iteration_non_linear_solver_h
-#define lethe_inexact_newton_iteration_non_linear_solver_h
+#ifndef lethe_inexact_newton_non_linear_solver_h
+#define lethe_inexact_newton_non_linear_solver_h
 
 #include <core/non_linear_solver.h>
 

diff --git a/include/core/kinsol_newton_non_linear_solver.h b/include/core/kinsol_newton_non_linear_solver.h
@@ -14,8 +14,8 @@
  * ---------------------------------------------------------------------
  */
 
-#ifndef kinsol_non_linear_solver_h
-#define kinsol_non_linear_solver_h
+#ifndef lethe_kinsol_non_linear_solver_h
+#define lethe_kinsol_non_linear_solver_h
 
 #include <core/non_linear_solver.h>
 #include <core/parameters.h>

diff --git a/include/core/lethe_grid_tools.h b/include/core/lethe_grid_tools.h
@@ -13,12 +13,11 @@
  *
  * -------------------------------------------------------------------*/
 
-#ifndef lethe_lethegridtools_h
-#define lethe_lethegridtools_h
+#ifndef lethe_lethe_grid_tools_h
+#define lethe_lethe_grid_tools_h
 
 #include <core/serial_solid.h>
 
-#include <deal.II/base/table_handler.h>
 #include <deal.II/base/tensor.h>
 
 #include <deal.II/dofs/dof_handler.h>

diff --git a/include/core/manifolds.h b/include/core/manifolds.h
@@ -12,9 +12,6 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Author: Bruno Blais, Polytechnique Montreal, 2019 -
  */
 
 #ifndef lethe_manifolds_h

diff --git a/include/core/mesh_controller.h b/include/core/mesh_controller.h
@@ -14,11 +14,8 @@
  * ---------------------------------------------------------------------*/
 
 
-#ifndef lethe_mesh_controler_h
-#define lethe_mesh_controler_h
-
-#include <iostream>
-
+#ifndef lethe_mesh_controller_h
+#define lethe_mesh_controller_h
 
 /**
  * @Class Controller that target a given number of elements in the mesh. This

diff --git a/include/core/parameters_multiphysics.h b/include/core/parameters_multiphysics.h
@@ -12,9 +12,6 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Author: Bruno Blais, Polytechnique Montreal, 2019-
  */
 
 /*

diff --git a/include/core/periodic_hills_grid.h b/include/core/periodic_hills_grid.h
@@ -12,9 +12,6 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Author: Audrey Collard-Daigneault, Polytechnique Montreal, 2020 -
  */
 
 #ifndef lethe_per_hills_grid_h
@@ -23,7 +20,6 @@
 #include <deal.II/base/utilities.h>
 
 #include <deal.II/grid/grid_generator.h>
-#include <deal.II/grid/grid_out.h>
 #include <deal.II/grid/grid_tools.h>
 #include <deal.II/grid/manifold_lib.h>
 #include <deal.II/grid/tria.h>

diff --git a/include/core/phase_change.h b/include/core/phase_change.h
@@ -14,8 +14,8 @@
  * ---------------------------------------------------------------------
  */
 
-#ifndef phase_change_h
-#define phase_change_h
+#ifndef lethe_phase_change_h
+#define lethe_phase_change_h
 
 #include <core/physical_property_model.h>
 

diff --git a/include/core/physics_solver.h b/include/core/physics_solver.h
@@ -13,8 +13,8 @@
  *
  * ---------------------------------------------------------------------*/
 
-#ifndef LETHE_PHYSICSSOLVER
-#define LETHE_PHYSICSSOLVER
+#ifndef lethe_physics_solver_h
+#define lethe_physics_solver_h
 
 #include <core/inexact_newton_non_linear_solver.h>
 #include <core/kinsol_newton_non_linear_solver.h>

diff --git a/include/core/simulation_control.h b/include/core/simulation_control.h
@@ -12,9 +12,6 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Author: Bruno Blais, Polytechnique Montreal, 2020 -
  */
 
 #ifndef lethe_simulation_control_h

diff --git a/include/core/solid_base.h b/include/core/solid_base.h
@@ -12,10 +12,6 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Authors: Carole-Anne Daunais, Valérie Bibeau, Polytechnique Montreal, 2020
- * Jeanne Joachim, Polytechnique Montreal, 2020-
  */
 
 #ifndef lethe_solid_base_h

diff --git a/include/core/solid_objects_parameters.h b/include/core/solid_objects_parameters.h
@@ -12,14 +12,11 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Author: Carole-Anne Daunais, Polytechnique Montreal, 2020 -
  */
 
 
-#ifndef nitsche_h
-#define nitsche_h
+#ifndef lethe_solid_objects_parameters_h
+#define lethe_solid_objects_parameters_h
 
 #include <core/parameters.h>
 

diff --git a/include/core/solutions_output.h b/include/core/solutions_output.h
@@ -12,9 +12,6 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Author: Bruno Blais, Polytechnique Montreal, 2020 -
  */
 
 #ifndef lethe_solutions_output_h

diff --git a/include/core/tensors_and_points_dimension_manipulation.h b/include/core/tensors_and_points_dimension_manipulation.h
@@ -12,19 +12,16 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Author: Shahab Golshan, Polytechnique Montreal, 2019
  */
 
+#ifndef lethe_tensors_and_points_dimension_manipulation_h
+#define lethe_tensors_and_points_dimension_manipulation_h
+
 #include <deal.II/base/point.h>
 #include <deal.II/base/tensor.h>
 
 using namespace dealii;
 
-#ifndef tensors_and_points_dimension_manipulation_h
-#  define tensors_and_points_dimension_manipulation_h
-
 /**
  * Copies a two-dimensional tensor in a three-dimensional tensor. The third
  * element of the three-dimensional tensor (in z direction) is set to zero.

diff --git a/include/core/utilities.h b/include/core/utilities.h
@@ -12,9 +12,6 @@
  * the top level of the Lethe distribution.
  *
  * ---------------------------------------------------------------------
-
- *
- * Author: Bruno Blais, Polytechnique Montreal, 2020 -
  */
 
 #ifndef lethe_utilities_h

diff --git a/include/solvers/cahn_hilliard.h b/include/solvers/cahn_hilliard.h
@@ -26,8 +26,8 @@
  * phase field parameter and the chemical potential.
  */
 
-#ifndef cahn_hilliard_h
-#define cahn_hilliard_h
+#ifndef lethe_cahn_hilliard_h
+#define lethe_cahn_hilliard_h
 
 #include <core/bdf.h>
 #include <core/simulation_control.h>

diff --git a/include/solvers/cahn_hilliard_assemblers.h b/include/solvers/cahn_hilliard_assemblers.h
@@ -13,17 +13,15 @@
  *
  * ---------------------------------------------------------------------*/
 
+#ifndef lethe_cahn_hilliard_assemblers_h
+#define lethe_cahn_hilliard_assemblers_h
 
 #include <core/simulation_control.h>
 
 #include <solvers/cahn_hilliard_scratch_data.h>
 #include <solvers/copy_data.h>
 #include <solvers/multiphysics_interface.h>
 
-
-#ifndef lethe_cahn_hilliard_assemblers_h
-#  define lethe_cahn_hilliard_assemblers_h
-
 /**
  * @brief A pure virtual class that serves as an interface for all
  * of the assemblers for the Cahn-Hilliard equation

diff --git a/include/solvers/cahn_hilliard_filter.h b/include/solvers/cahn_hilliard_filter.h
@@ -17,7 +17,6 @@
 #ifndef lethe_cahn_hilliard_filter_h
 #define lethe_cahn_hilliard_filter_h
 
-
 #include <core/parameters_multiphysics.h>
 
 /**

diff --git a/include/solvers/cahn_hilliard_scratch_data.h b/include/solvers/cahn_hilliard_scratch_data.h
@@ -16,6 +16,10 @@
  * Scratch data for the CahnHilliard auxiliary physics
  */
 
+
+#ifndef lethe_cahn_hilliard_scratch_data_h
+#define lethe_cahn_hilliard_scratch_data_h
+
 #include <core/multiphysics.h>
 
 #include <solvers/multiphysics_interface.h>
@@ -33,9 +37,6 @@
 #include <deal.II/numerics/vector_tools.h>
 
 
-#ifndef lethe_cahn_hilliard_scratch_data_h
-#  define lethe_cahn_hilliard_scratch_data_h
-
 using namespace dealii;
 
 

diff --git a/include/solvers/copy_data.h b/include/solvers/copy_data.h
@@ -15,16 +15,16 @@
  */
 
 
+#ifndef lethe_copy_data_h
+#define lethe_copy_data_h
+
 #include <deal.II/dofs/dof_handler.h>
 
 #include <deal.II/lac/full_matrix.h>
 #include <deal.II/lac/vector.h>
 
 #include <vector>
 
-#ifndef copy_data_navier_stokes_h
-#  define copy_data_navier_stokes_h
-
 using namespace dealii;
 
 /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,7 @@ @@
      *
      * ---------------------------------------------------------------------
      */
     #ifndef lethe_evaporation_model_h
     #define lethe_evaporation_model_h
@@ Expand Down @@