Add test for partial derivatives

simulations/geometryRTheta/diocotron/diocotron.cpp

@@ -26,7 +26,7 @@
 #include "euler.hpp"
 #include "geometry.hpp"
 #include "input.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "output.hpp"
 #include "paraconfpp.hpp"
 #include "params.yaml.hpp"

simulations/geometryRTheta/vortex_merger/vortex_merger.cpp

@@ -26,7 +26,7 @@
 #include "euler.hpp"
 #include "geometry.hpp"
 #include "input.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "paraconfpp.hpp"
 #include "params.yaml.hpp"
 #include "pdi_out.yml.hpp"

simulations/geometryXY/guiding_center/guiding_center.cpp

@@ -19,7 +19,7 @@
 #include "geometry.hpp"
 #include "initialization_Kelvin_Helmholtz.hpp"
 #include "input.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "output.hpp"
 #include "paraconfpp.hpp"
 #include "params.yaml.hpp"

src/CMakeLists.txt

@@ -1,21 +1,22 @@
 # SPDX-License-Identifier: MIT
 
+add_subdirectory(advection)
+add_subdirectory(collisions)
 add_subdirectory(data_types)
-add_subdirectory(utils)
-add_subdirectory(speciesinfo)
 add_subdirectory(io)
-add_subdirectory(paraconfpp)
-add_subdirectory(quadrature)
 add_subdirectory(geometryXVx)
 add_subdirectory(geometryXY)
 add_subdirectory(geometryRTheta)
 add_subdirectory(geometryXYVxVy)
 add_subdirectory(geometryVparMu)
 add_subdirectory(interpolation)
 add_subdirectory(mapping)
-add_subdirectory(multipatch)
-add_subdirectory(advection)
-add_subdirectory(timestepper)
-add_subdirectory(collisions)
+add_subdirectory(math_tools)
 add_subdirectory(mpi_parallelisation)
+add_subdirectory(multipatch)
+add_subdirectory(paraconfpp)
 add_subdirectory(pde_solvers)
+add_subdirectory(quadrature)
+add_subdirectory(speciesinfo)
+add_subdirectory(timestepper)
+add_subdirectory(utils)

src/README.md

@@ -13,6 +13,7 @@ The `src/` folder contains all the code necessary to build a gyrokinetic semi-La
 - [interpolation](./interpolation/README.md) - Code describing interpolation methods.
 - [io](./io/README.md) - Code describing tools for inputting and outputting data in a simulation.
 - [mapping](./mapping/README.md) - Code describing tools for handling different coordinate systems.
+- [math\_tools](./math_tools/README.md) - Code describing math tools functions.
 - [multipatch](./multipatch/README.md) - Code describing multipatch geometry.
 <!-- - [paraconfpp](./paraconfpp/README.md) - Paraconf utility functions. -->
 - [mpi\_parallelisation](./mpi_parallelisation/README.md) - Code describing the MPI parallelisation.

src/geometryRTheta/advection/CMakeLists.txt

@@ -14,6 +14,7 @@ target_link_libraries(advection_rp
         gslx::geometry_RTheta
         gslx::interpolation_2D_rp
         gslx::mapping
+        gslx::math_tools
         gslx::utils
 )
 add_library(gslx::advection_rp ALIAS advection_rp)

src/geometryRTheta/advection/advection_domain.hpp

@@ -13,7 +13,7 @@
 #include "directional_tag.hpp"
 #include "geometry.hpp"
 #include "geometry_pseudo_cartesian.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "vector_field.hpp"
 #include "vector_field_mem.hpp"
 

src/geometryRTheta/initialization/vortex_merger_equilibrium.hpp

@@ -7,7 +7,7 @@
 #include "ddc_alias_inline_functions.hpp"
 #include "ddc_aliases.hpp"
 #include "geometry.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "poisson_like_rhs_function.hpp"
 #include "polarpoissonlikesolver.hpp"
 

src/geometryRTheta/time_solver/bsl_predcorr.hpp

@@ -17,7 +17,7 @@
 #include "geometry.hpp"
 #include "ifoot_finder.hpp"
 #include "itimesolver.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "poisson_like_rhs_function.hpp"
 #include "polarpoissonlikesolver.hpp"
 #include "rk2.hpp"

src/geometryXY/time_integration/predcorr_RK2.hpp

@@ -13,7 +13,7 @@
 #include "ddc_aliases.hpp"
 #include "directional_tag.hpp"
 #include "geometry.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "paraconfpp.hpp"
 #include "rk2.hpp"
 #include "vector_field.hpp"

src/math_tools/CMakeLists.txt

@@ -0,0 +1,16 @@
+# SPDX-License-Identifier: MIT
+
+add_library("math_tools" INTERFACE)
+
+target_include_directories("math_tools"
+    INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}"
+)
+
+target_link_libraries("math_tools"
+    INTERFACE
+        DDC::DDC
+        gslx::data_types
+)
+
+add_library("gslx::math_tools" ALIAS "math_tools")
+

src/math_tools/README.md

@@ -0,0 +1,9 @@
+# Utility Functions
+
+This folder contains mathematical classes and functions.
+
+## Utility tools
+
+The l\_norm\_tools.hpp file contains functions computing the infinity norm. For now, it computes the infinity norm of 
+- a double: $`\Vert x \Vert_{\infty} = x`$; 
+- a coordinate: $`\Vert x \Vert_{\infty} = \max_{i} (|x_i|)`$.

src/utils/math_tools.hpp → src/math_tools/l_norm_tools.hpp

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 /**
- * @file math_tools.hpp
- * File Describing useful mathematical functions.
+ * @file l_norm_tools.hpp
+ * File Describing useful mathematical functions to compute Lnorms
  */
 
 #pragma once

src/math_tools/partial_derivatives.hpp

@@ -0,0 +1,73 @@
+
+// SPDX-License-Identifier: MIT
+/**
+ * @file partial_derivatives.hpp
+ * File containing functions to compute the partial derivatives
+ */
+
+#pragma once
+
+#include <ddc/ddc.hpp>
+
+#include "ddc_alias_inline_functions.hpp"
+#include "ddc_aliases.hpp"
+
+
+/**
+ * @brief Compute the partial derivative of a 
+ *
+ * For a given field @f$F(X1,X2)@f$ , compute
+ * @f$\partial_{Xi} F(X1,X2)@f$ with i=1 or 2.
+ *
+ * @param[in] Xi
+ *      The given coordinate for the partial derivative.
+ *
+ * @return @f$\partial_{Xi} F(X1,X2)@f$ 
+ */
+
+template <
+        class GridXi,
+        class GridX1,
+        class GridX2,
+        class FieldX1Builder,
+        class FieldX1Evaluator>
+class PartialDerivative
+{
+private:
+    using IdxRangeX1X2 = IdxRange<GridX1, GridX2>;
+    using IdxX1X2 = typename IdxRangeX1X2::discrete_element_type;
+    using DFieldX1X2 = DField<IdxRangeX1X2>;
+    using DConstFieldX1X2 = DConstField<IdxRangeX1X2>;
+
+    // Type for spline representation of the field
+    using IdxRangeBSFieldX1 = typename FieldX1Builder::batched_spline_domain_type;
+    using FieldX1SplineMem = DFieldMem<IdxRangeBSFieldX1>;
+    using FieldX1SplineCoeffs = DField<IdxRangeBSFieldX1>;
+
+    FieldX1Builder const& m_fieldx1_builder;
+    FieldX1Evaluator const& m_fieldx1_evaluator;
+
+public:
+    explicit PartialDerivative(
+        FieldX1Builder const& fieldx1_builder,
+        FieldX1Evaluator const& fieldx1_evaluator)
+        : m_fieldx1_builder(fieldx1_builder)
+        , m_fieldx1_evaluator(fieldx1_evaluator)             
+    {    
+    }
+
+    ~PartialDerivative() = default;
+
+    DFieldX1X2 operator()(DFieldX1X2 dfield_dx1_x1x2, DConstFieldX1X2 field_x1x2)
+    {
+        // Build spline representation of the field ....................................
+        FieldX1SplineMem fieldx1_coefs_alloc(
+            m_fieldx1_builder.batched_spline_domain());
+        FieldX1SplineCoeffs fieldx1_coefs = get_field(fieldx1_coefs_alloc);
+
+        m_fieldx1_builder(fieldx1_coefs, get_const_field(field_x1x2));
+        m_fieldx1_evaluator.deriv(dfield_dx1_x1x2, get_const_field(fieldx1_coefs));
+
+        return dfield_dx1_x1x2;
+    }
+};

src/multipatch/README.md

@@ -6,8 +6,6 @@ The `multipatch` folder contains all the code describing methods and classes whi
 
 - [data\_types](./data_types/README.md) - Defines classes to handle objects on a multipatch domain more conveniently.
 
-- [interface\_derivatives](./interface_derivatives/README.md) - Ongoing work only available on GitLab.
-
 - [spline](./spline/README.md) - Defines structures and methods to deal with different splines on every patches.
 
 - [utils](./utils/README.md) - Defines utility functions to operate over multiple patches.

src/multipatch/utils/multipatch_math_tools.hpp

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: MIT
 #pragma once
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "multipatch_field.hpp"
 
 /**

src/timestepper/CMakeLists.txt

@@ -1,6 +1,4 @@
 
-
-
 add_library(timestepper INTERFACE)
 target_include_directories(timestepper
     INTERFACE
@@ -9,6 +7,7 @@ target_include_directories(timestepper
 target_link_libraries(timestepper INTERFACE
     DDC::core
     gslx::data_types
+    gslx::math_tools
     gslx::multipatch_data_types
     gslx::multipatch_utils
     gslx::utils

src/timestepper/crank_nicolson.hpp

@@ -5,7 +5,7 @@
 #include "ddc_aliases.hpp"
 #include "ddc_helper.hpp"
 #include "itimestepper.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "multipatch_math_tools.hpp"
 #include "vector_field_common.hpp"
 

src/utils/README.md

@@ -5,9 +5,3 @@ This folder contains classes and functions which facilitate the writing of the r
 The class ddcHelper exists to provide functionalities which are currently missing from DDC.
 
 The class NDTag exists to provide a way to group directional tags together. This is notably useful in order to create a vector field.
-
-## Utility tools
-
-The utils\_tools.hpp file contains functions computing the infinity norm. For now, it computes the infinity norm of 
-- a double: $`\Vert x \Vert_{\infty} = x`$; 
-- a coordinate: $`\Vert x \Vert_{\infty} = \max_{i} (|x_i|)`$.

tests/CMakeLists.txt

@@ -22,6 +22,7 @@ add_subdirectory(geometryRTheta)
 add_subdirectory(geometryVparMu)
 add_subdirectory(multipatch)
 add_subdirectory(mpi_parallelisation)
+add_subdirectory(math_tools)
 add_subdirectory(pde_solvers)
 add_subdirectory(quadrature)
 add_subdirectory(timestepper)

tests/README.md

@@ -10,6 +10,7 @@ It is broken up into the following sub-folders:
  - geometryVparMu - Tests in the vpar-mu geometry.
  - geometryXVx - Tests in the x-vx geometry.
  - geometryXYVxVy - Tests in the x,y-vx,vy geometry.
+ - math\_tools - Test for mathematical functions.
  - MPI parallelism - Tests for the templated MPI operators.
  - [multipatch](./multipatch/README.md) - Tests for the classes that work over multipatch geometries.
  - PDE solvers - Tests for the templated Partial Differential Equation solvers.

tests/geometryRTheta/advection_2d_rp/advection_simulation_utils.hpp

@@ -16,7 +16,7 @@
 #include "bsl_advection_rp.hpp"
 #include "directional_tag.hpp"
 #include "geometry.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "paraconfpp.hpp"
 #include "params.yaml.hpp"
 #include "quadrature.hpp"

tests/geometryRTheta/advection_field_rp/advection_field_gtest.cpp

@@ -28,7 +28,7 @@
 #include "crank_nicolson.hpp"
 #include "euler.hpp"
 #include "geometry.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "mesh_builder.hpp"
 #include "quadrature.hpp"
 #include "rk3.hpp"

tests/geometryRTheta/quadrature/CMakeLists.txt

@@ -12,6 +12,7 @@ target_link_libraries(Li_norms_spline_quadrature_tests
         sll::SLL
         gslx::geometry_RTheta
         gslx::quadrature
+        gslx::math_tools
         gslx::utils
 
 )

tests/geometryRTheta/quadrature/tests_L1_and_L2_norms.cpp

@@ -9,7 +9,7 @@
 #include <gtest/gtest.h>
 
 #include "geometry.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 #include "mesh_builder.hpp"
 #include "quadrature.hpp"
 #include "spline_quadrature.hpp"

tests/math_tools/CMakeLists.txt

@@ -0,0 +1,21 @@
+# SPDX-License-Identifier: MIT
+
+
+include(GoogleTest)
+
+add_executable(unit_tests_math_tools
+    test_lnorm_tools.cpp
+    test_partial_derivatives.cpp
+    ../main.cpp
+)
+target_link_libraries(unit_tests_math_tools
+    PUBLIC
+        DDC::pdi
+        GTest::gtest
+        GTest::gmock
+        paraconf::paraconf
+	gslx::math_tools
+        gslx::utils
+)
+
+gtest_discover_tests(unit_tests_math_tools DISCOVERY_MODE PRE_TEST)

tests/utils/test_math_tools.cpp → tests/math_tools/test_lnorm_tools.cpp

@@ -6,7 +6,7 @@
 #include "ddc_alias_inline_functions.hpp"
 #include "ddc_aliases.hpp"
 #include "ddc_helper.hpp"
-#include "math_tools.hpp"
+#include "l_norm_tools.hpp"
 
 namespace {