Skip to content

Commit

Permalink
Splines minor classes doc (#452)
Browse files Browse the repository at this point in the history
  • Loading branch information
blegouix authored Jun 25, 2024
1 parent 15a155e commit 5fd96f8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
6 changes: 6 additions & 0 deletions include/ddc/kernels/splines/greville_interpolation_points.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@ class GrevilleInterpolationPoints
* when uniform splines are used with an odd degree and with boundary conditions which
* do not introduce additional interpolation points.
*
* @tparam Sampling The discrete dimension supporting the Greville points.
*
* @returns The mesh of uniform Greville points.
*/
template <
Expand All @@ -143,6 +145,8 @@ class GrevilleInterpolationPoints
/**
* Get the NonUniformPointSampling defining the Greville points.
*
* @tparam Sampling The discrete dimension supporting the Greville points.
*
* @returns The mesh of non-uniform Greville points.
*/
template <
Expand Down Expand Up @@ -262,6 +266,8 @@ class GrevilleInterpolationPoints
/**
* Get the domain which gives us access to all of the Greville points.
*
* @tparam Sampling The discrete dimension supporting the Greville points.
*
* @returns The domain of the Greville points.
*/
template <class Sampling>
Expand Down
4 changes: 4 additions & 0 deletions include/ddc/kernels/splines/knots_as_interpolation_points.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ namespace ddc {
* In the case of strongly non-uniform splines this choice may result in a less
* well conditioned problem, however most mathematical stability results are proven
* with this choice of interpolation points.
*
* @tparam BSplines The type of the uniform or non-uniform spline basis whose knots are used as interpolation points.
* @tparam BcXmin The lower boundary condition.
* @tparam BcXmin The upper boundary condition.
*/
template <class BSplines, ddc::BoundCond BcXmin, ddc::BoundCond BcXmax>
class KnotsAsInterpolationPoints
Expand Down

0 comments on commit 5fd96f8

Please sign in to comment.