wip

include/ddc/kernels/splines/bsplines_uniform.hpp

@@ -24,6 +24,12 @@ struct UniformBSplinesBase
 {
 };
 
+/**
+ * The type of a uniform BSplines 1D basis.
+ *
+ * @tparam Tag The tag identifying the continuous dimension which supports the building of the BSplines.
+ * @tparam D The degree of the BSplines.
+ */
 template <class Tag, std::size_t D>
 class UniformBSplines : UniformBSplinesBase
 {

include/ddc/kernels/splines/greville_interpolation_points.hpp

@@ -15,7 +15,7 @@
 namespace ddc {
 
 /**
- * A class which provides helper functions to initialise the Greville points from a B-Spline definition.
+ * A class which provides helper functions to initialize the Greville points from a B-Spline definition.
  *
  * @tparam BSplines The bspline class relative to which the Greville points will be calculated.
  * @tparam BcXmin The (left) boundary condition that will be used to build the splines.

include/ddc/kernels/splines/null_extrapolation_rule.hpp

@@ -6,6 +6,9 @@
 
 namespace ddc {
 
+/**
+ * @brief A functor for describing a spline boundary value by a null extrapolation for 1D evaluator.
+ */
 struct NullExtrapolationRule
 {
     template <class CoordType, class ChunkSpan>

include/ddc/kernels/splines/spline_builder.hpp

@@ -10,10 +10,26 @@
 #include "deriv.hpp"
 
 namespace ddc {
+
+/**
+ * @brief An enum determining the backend solver of a SplineBuilder or SplineBuilder2d.
+ *
+ * An enum determining the backend solver of a SplineBuilder or SplineBuilder2d. Only GINKGO available at the moment,
+ * other solvers will be implemented in the futur.
+ */
 enum class SplineSolver {
     GINKGO
-}; // Only GINKGO available atm, other solvers will be implemented in the futur
+};
 
+/**
+ * @brief An helper giving the uniform/non_uniform status of a spline interpolation mesh according to its attributes.
+ *
+ * An helper giving the uniform/non_uniform status of a spline interpolation mesh according to its attributes.
+ * @param is_uniform A boolean giving the presumed status before considering boundary conditions.
+ * @param BcXmin The Xmin boundary condition.
+ * @param BcXmax The Xmax boundary condition.
+ * @param int The degree of the spline.
+ */
 constexpr bool is_spline_interpolation_mesh_uniform(
         bool const is_uniform,
         ddc::BoundCond const BcXmin,
@@ -34,6 +50,14 @@ constexpr bool is_spline_interpolation_mesh_uniform(
  * of BSplines. The spline is constructed such that it respects the boundary conditions
  * BcXmin and BcXmax, and it interpolates the function at the points on the interpolation_mesh
  * associated with interpolation_mesh_type.
+ * @tparam ExecSpace The Kokkos execution space on which the spline transform is performed.
+ * @tparam MemorySpace The Kokkos memory space on which the data (interpolation function and splines coefficients) are stored.
+ * @tparam BSplines The BSplines dimension.
+ * @tparam InterpolationMesh The discrete dimension supporting the interpolation points.
+ * @tparam BcXmin The Xmin boundary condition.
+ * @tparam BcXmax The Xmax boundary condition.
+ * @tparam Solver The SplineSolver giving the backend used to perform the spline transform.
+ * @tparam IDimX A variadic template of all the discrete dimensions forming the full space (InterpolationMesh + batched dimensions).
  */
 template <
         class ExecSpace,
@@ -57,34 +81,52 @@ class SplineBuilder
     using tag_type = typename InterpolationMesh::continuous_dimension_type;
 
 public:
+    /**
+     * @brief The type of the Kokkos execution space used by this class.
+     */
     using exec_space = ExecSpace;
 
+    /**
+     * @brief The type of the Kokkos memory space used by this class.
+     */
     using memory_space = MemorySpace;
 
     /**
-     * @brief The type of the interpolation mesh used by this class.
+     * @brief The type of the interpolation mesh (discrete dimension of interest) used by this class.
      */
     using interpolation_mesh_type = InterpolationMesh;
 
     /**
-     * @brief The type of the BSplines which are compatible with this class.
+     * @brief The BSplines dimension.
      */
     using bsplines_type = BSplines;
 
+	/**
+     * @brief The deriv dimension at the boundaries.
+     */
     using deriv_type = ddc::Deriv<tag_type>;
 
     /**
      * @brief The type of the domain for the interpolation mesh used by this class.
      */
     using interpolation_domain_type = ddc::DiscreteDomain<interpolation_mesh_type>;
 
+    /**
+     * @brief The type of the whole domain representing interpolation points.
+     */
     using batched_interpolation_domain_type = ddc::DiscreteDomain<IDimX...>;
 
+    /**
+     * @brief The type of the batch domain (obtained by removing dimension of interest from whole space).
+     */
     using batch_domain_type =
             typename ddc::detail::convert_type_seq_to_discrete_domain<ddc::type_seq_remove_t<
                     ddc::detail::TypeSeq<IDimX...>,
                     ddc::detail::TypeSeq<interpolation_mesh_type>>>;
 
+	/**
+     * @brief The dimension WIP.
+     */
     template <typename Tag>
     using spline_dim_type
             = std::conditional_t<std::is_same_v<Tag, interpolation_mesh_type>, bsplines_type, Tag>;

include/ddc/kernels/splines/spline_builder_2d.hpp

@@ -87,7 +87,14 @@ class SplineBuilder2D
      */
     using bsplines_type2 = typename builder_type2::bsplines_type;
 
+	/**
+     * @brief The type of the derivatives on boundaries in the first dimension which are compatible with this class.
+     */
     using deriv_type1 = typename builder_type1::deriv_type;
+
+	/**
+     * @brief The type of the derivatives on boundaries in the second dimension which are compatible with this class.
+     */
     using deriv_type2 = typename builder_type2::deriv_type;
 
     /**