Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Splines minor classes doc #452

Merged
merged 2 commits into from
Jun 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
blegouix marked this conversation as resolved.
Show resolved Hide resolved
*/
template <class BSplines, ddc::BoundCond BcXmin, ddc::BoundCond BcXmax>
class KnotsAsInterpolationPoints
Expand Down