DDC 0.10.0
Loading...
Searching...
No Matches
null_extrapolation_rule.hpp
1// Copyright (C) The DDC development team, see COPYRIGHT.md file
2//
3// SPDX-License-Identifier: MIT
4
5#pragma once
6
7#include <Kokkos_Macros.hpp>
8
9namespace ddc {
10
11/**
12 * @brief A functor describing a null extrapolation boundary value for 1D spline evaluator.
13 */
14struct NullExtrapolationRule
15{
16 /**
17 * @brief Evaluates the spline at a coordinate outside of the domain.
18 *
19 * @return A double with the value of the function outside the domain (here, 0.).
20 */
21 template <class CoordType, class ChunkSpan>
22 KOKKOS_FUNCTION double operator()(CoordType, ChunkSpan) const
23 {
24 return 0.0;
25 }
26};
27
28} // namespace ddc
ddc::ChunkCommon::ChunkSpan
friend class ChunkSpan
Definition chunk_common.hpp:76
ddc::DiscreteDomain::DiscreteDomain
friend class DiscreteDomain
Definition discrete_domain.hpp:66
ddc::DiscreteVector::operator!=
KOKKOS_FUNCTION constexpr bool operator!=(DiscreteVector< OTags... > const &rhs) const noexcept
Definition discrete_vector.hpp:346
ddc::GrevilleInterpolationPoints
A class which provides helper functions to initialise the Greville points from a B-Spline definition.
Definition greville_interpolation_points.hpp:30
ddc::GrevilleInterpolationPoints::get_domain
static ddc::DiscreteDomain< Sampling > get_domain()
Get the domain which gives us access to all of the Greville points.
Definition greville_interpolation_points.hpp:281
ddc::GrevilleInterpolationPoints::get_sampling
static auto get_sampling()
Get the UniformPointSampling defining the Greville points.
Definition greville_interpolation_points.hpp:146
ddc::KnotsAsInterpolationPoints
Helper class for the initialisation of the mesh of interpolation points.
Definition knots_as_interpolation_points.hpp:38
ddc::KnotsAsInterpolationPoints::get_sampling
static auto get_sampling()
Get the sampling of interpolation points.
Definition knots_as_interpolation_points.hpp:51
ddc::KnotsAsInterpolationPoints::get_domain
static ddc::DiscreteDomain< Sampling > get_domain()
Get the domain which can be used to access the interpolation points in the sampling.
Definition knots_as_interpolation_points.hpp:85
ddc::NonUniformBSplines::Impl
Storage class of the static attributes of the discrete dimension.
Definition bsplines_non_uniform.hpp:90
ddc::NonUniformBSplines::Impl::operator=
Impl & operator=(Impl &&x)=default
Move-assigns.
ddc::NonUniformBSplines::Impl::Impl
Impl(RandomIt breaks_begin, RandomIt breaks_end)
Constructs an Impl by iterating over a range of break points from begin to end.
Definition bsplines_non_uniform.hpp:410
ddc::NonUniformBSplines::Impl::rmin
KOKKOS_INLINE_FUNCTION ddc::Coordinate< CDim > rmin() const noexcept
Returns the coordinate of the first break point of the domain on which the B-splines are defined.
Definition bsplines_non_uniform.hpp:288
ddc::NonUniformBSplines::Impl::Impl
Impl(std::vector< ddc::Coordinate< CDim > > const &breaks)
Constructs an Impl using a std::vector.
Definition bsplines_non_uniform.hpp:138
ddc::NonUniformBSplines::Impl::eval_basis
KOKKOS_INLINE_FUNCTION discrete_element_type eval_basis(DSpan1D values, ddc::Coordinate< CDim > const &x) const
Evaluates non-zero B-splines at a given coordinate.
Definition bsplines_non_uniform.hpp:455
ddc::NonUniformBSplines::Impl::size
KOKKOS_INLINE_FUNCTION std::size_t size() const noexcept
Returns the number of elements necessary to construct a spline representation of a function.
Definition bsplines_non_uniform.hpp:319
ddc::NonUniformBSplines::Impl::Impl
Impl(Impl< DDim, OriginMemorySpace > const &impl)
Copy-constructs from another Impl with a different Kokkos memory space.
Definition bsplines_non_uniform.hpp:169
ddc::NonUniformBSplines::Impl::~Impl
~Impl()=default
Destructs.
ddc::NonUniformBSplines::Impl::break_point_domain
KOKKOS_INLINE_FUNCTION ddc::DiscreteDomain< knot_discrete_dimension_type > break_point_domain() const
Returns the discrete domain which describes the break points.
Definition bsplines_non_uniform.hpp:338
ddc::NonUniformBSplines::Impl::get_last_support_knot
KOKKOS_INLINE_FUNCTION ddc::DiscreteElement< knot_discrete_dimension_type > get_last_support_knot(discrete_element_type const &ix) const
Returns the coordinate of the last support knot associated to a DiscreteElement identifying a B-splin...
Definition bsplines_non_uniform.hpp:278
ddc::NonUniformBSplines::Impl::Impl
Impl(Impl &&x)=default
Move-constructs.
ddc::NonUniformBSplines::Impl::Impl
Impl(std::initializer_list< ddc::Coordinate< CDim > > breaks)
Constructs an Impl using a brace-list, i.e.
Definition bsplines_non_uniform.hpp:126
ddc::NonUniformBSplines::Impl::eval_basis_and_n_derivs
KOKKOS_INLINE_FUNCTION discrete_element_type eval_basis_and_n_derivs(ddc::DSpan2D derivs, ddc::Coordinate< CDim > const &x, std::size_t n) const
Evaluates non-zero B-spline values and derivatives at a given coordinate.
Definition bsplines_non_uniform.hpp:555
ddc::NonUniformBSplines::Impl::ncells
KOKKOS_INLINE_FUNCTION std::size_t ncells() const noexcept
Returns the number of cells over which the B-splines are defined.
Definition bsplines_non_uniform.hpp:372
ddc::NonUniformBSplines::Impl::full_domain
KOKKOS_INLINE_FUNCTION discrete_domain_type full_domain() const
Returns the discrete domain including eventual additional B-splines in the periodic case.
Definition bsplines_non_uniform.hpp:328
ddc::NonUniformBSplines::Impl::get_first_support_knot
KOKKOS_INLINE_FUNCTION ddc::DiscreteElement< knot_discrete_dimension_type > get_first_support_knot(discrete_element_type const &ix) const
Returns the coordinate of the first support knot associated to a DiscreteElement identifying a B-spli...
Definition bsplines_non_uniform.hpp:263
ddc::NonUniformBSplines::Impl::npoints
KOKKOS_INLINE_FUNCTION std::size_t npoints() const noexcept
The number of break points.
Definition bsplines_non_uniform.hpp:349
ddc::NonUniformBSplines::Impl::nbasis
KOKKOS_INLINE_FUNCTION std::size_t nbasis() const noexcept
Returns the number of basis functions.
Definition bsplines_non_uniform.hpp:360
ddc::NonUniformBSplines::Impl::Impl
Impl(Impl const &x)=default
Copy-constructs.
ddc::NonUniformBSplines::Impl::eval_deriv
KOKKOS_INLINE_FUNCTION discrete_element_type eval_deriv(DSpan1D derivs, ddc::Coordinate< CDim > const &x) const
Evaluates non-zero B-spline derivatives at a given coordinate.
Definition bsplines_non_uniform.hpp:495
ddc::NonUniformBSplines::Impl::length
KOKKOS_INLINE_FUNCTION double length() const noexcept
Returns the length of the domain.
Definition bsplines_non_uniform.hpp:306
ddc::NonUniformBSplines::Impl::operator=
Impl & operator=(Impl const &x)=default
Copy-assigns.
ddc::NonUniformBSplines::Impl::rmax
KOKKOS_INLINE_FUNCTION ddc::Coordinate< CDim > rmax() const noexcept
Returns the coordinate of the last break point of the domain on which the B-splines are defined.
Definition bsplines_non_uniform.hpp:297
ddc::NonUniformBSplines
The type of a non-uniform 1D spline basis (B-spline).
Definition bsplines_non_uniform.hpp:46
ddc::NonUniformBSplines::degree
static constexpr std::size_t degree() noexcept
The degree of B-splines.
Definition bsplines_non_uniform.hpp:60
ddc::NonUniformBSplines::is_periodic
static constexpr bool is_periodic() noexcept
Indicates if the B-splines are periodic or not.
Definition bsplines_non_uniform.hpp:69
ddc::NonUniformBSplines::is_uniform
static constexpr bool is_uniform() noexcept
Indicates if the B-splines are uniform or not (this is not the case here).
Definition bsplines_non_uniform.hpp:78
ddc::NonUniformPointSampling
NonUniformPointSampling models a non-uniform discretization of the CDim segment .
Definition non_uniform_point_sampling.hpp:40
ddc::UniformBSplines::Impl
Storage class of the static attributes of the discrete dimension.
Definition bsplines_uniform.hpp:94
ddc::UniformBSplines::Impl::get_last_support_knot
KOKKOS_INLINE_FUNCTION ddc::DiscreteElement< knot_discrete_dimension_type > get_last_support_knot(discrete_element_type const &ix) const
Returns the coordinate of the last support knot associated to a DiscreteElement identifying a B-splin...
Definition bsplines_uniform.hpp:268
ddc::UniformBSplines::Impl::Impl
Impl(ddc::Coordinate< CDim > rmin, ddc::Coordinate< CDim > rmax, std::size_t ncells)
Constructs a spline basis (B-splines) with n equidistant knots over .
Definition bsplines_uniform.hpp:135
ddc::UniformBSplines::Impl::rmax
KOKKOS_INLINE_FUNCTION ddc::Coordinate< CDim > rmax() const noexcept
Returns the coordinate of the upper bound of the domain on which the B-splines are defined.
Definition bsplines_uniform.hpp:287
ddc::UniformBSplines::Impl::eval_basis
KOKKOS_INLINE_FUNCTION discrete_element_type eval_basis(DSpan1D values, ddc::Coordinate< CDim > const &x) const
Evaluates non-zero B-splines at a given coordinate.
Definition bsplines_uniform.hpp:204
ddc::UniformBSplines::Impl::break_point_domain
KOKKOS_INLINE_FUNCTION ddc::DiscreteDomain< knot_discrete_dimension_type > break_point_domain() const
Returns the discrete domain which describes the break points.
Definition bsplines_uniform.hpp:328
ddc::UniformBSplines::Impl::rmin
KOKKOS_INLINE_FUNCTION ddc::Coordinate< CDim > rmin() const noexcept
Returns the coordinate of the lower bound of the domain on which the B-splines are defined.
Definition bsplines_uniform.hpp:278
ddc::UniformBSplines::Impl::~Impl
~Impl()=default
Destructs.
ddc::UniformBSplines::Impl::nbasis
KOKKOS_INLINE_FUNCTION std::size_t nbasis() const noexcept
Returns the number of basis functions.
Definition bsplines_uniform.hpp:339
ddc::UniformBSplines::Impl::Impl
Impl(Impl const &x)=default
Copy-constructs.
ddc::UniformBSplines::Impl::size
KOKKOS_INLINE_FUNCTION std::size_t size() const noexcept
Returns the number of elements necessary to construct a spline representation of a function.
Definition bsplines_uniform.hpp:309
ddc::UniformBSplines::Impl::Impl
Impl(Impl &&x)=default
Move-constructs.
ddc::UniformBSplines::Impl::eval_basis_and_n_derivs
KOKKOS_INLINE_FUNCTION discrete_element_type eval_basis_and_n_derivs(ddc::DSpan2D derivs, ddc::Coordinate< CDim > const &x, std::size_t n) const
Evaluates non-zero B-spline values and derivatives at a given coordinate.
Definition bsplines_uniform.hpp:469
ddc::UniformBSplines::Impl::get_first_support_knot
KOKKOS_INLINE_FUNCTION ddc::DiscreteElement< knot_discrete_dimension_type > get_first_support_knot(discrete_element_type const &ix) const
Returns the coordinate of the first support knot associated to a DiscreteElement identifying a B-spli...
Definition bsplines_uniform.hpp:253
ddc::UniformBSplines::Impl::length
KOKKOS_INLINE_FUNCTION double length() const noexcept
Returns the length of the domain.
Definition bsplines_uniform.hpp:296
ddc::UniformBSplines::Impl::Impl
Impl(Impl< DDim, OriginMemorySpace > const &impl)
Copy-constructs from another Impl with a different Kokkos memory space.
Definition bsplines_uniform.hpp:155
ddc::UniformBSplines::Impl::ncells
KOKKOS_INLINE_FUNCTION std::size_t ncells() const noexcept
Returns the number of cells over which the B-splines are defined.
Definition bsplines_uniform.hpp:351
ddc::UniformBSplines::Impl::eval_deriv
KOKKOS_INLINE_FUNCTION discrete_element_type eval_deriv(DSpan1D derivs, ddc::Coordinate< CDim > const &x) const
Evaluates non-zero B-spline derivatives at a given coordinate.
Definition bsplines_uniform.hpp:424
ddc::UniformBSplines::Impl::operator=
Impl & operator=(Impl &&x)=default
Move-assigns.
ddc::UniformBSplines::Impl::full_domain
KOKKOS_INLINE_FUNCTION discrete_domain_type full_domain() const
Returns the discrete domain including eventual additional B-splines in the periodic case.
Definition bsplines_uniform.hpp:318
ddc::UniformBSplines::Impl::operator=
Impl & operator=(Impl const &x)=default
Copy-assigns.
ddc::UniformBSplines
The type of a uniform 1D spline basis (B-spline).
Definition bsplines_uniform.hpp:50
ddc::UniformBSplines::is_uniform
static constexpr bool is_uniform() noexcept
Indicates if the B-splines are uniform or not (this is the case here).
Definition bsplines_uniform.hpp:82
ddc::UniformBSplines::is_periodic
static constexpr bool is_periodic() noexcept
Indicates if the B-splines are periodic or not.
Definition bsplines_uniform.hpp:73
ddc::UniformBSplines::degree
static constexpr std::size_t degree() noexcept
The degree of B-splines.
Definition bsplines_uniform.hpp:64
ddc::UniformPointSampling
UniformPointSampling models a uniform discretization of the provided continuous dimension.
Definition uniform_point_sampling.hpp:36
ddc
The top-level namespace of DDC.
Definition aligned_allocator.hpp:11
ddc::n_boundary_equations
constexpr int n_boundary_equations(ddc::BoundCond const bc, std::size_t const degree)
Return the number of equations needed to describe a given boundary condition.
Definition spline_boundary_conditions.hpp:55
ddc::is_uniform_bsplines_v
constexpr bool is_uniform_bsplines_v
Indicates if a tag corresponds to uniform B-splines or not.
Definition bsplines_uniform.hpp:383
ddc::BoundCond
BoundCond
An enum representing a spline boundary condition.
Definition spline_boundary_conditions.hpp:16
ddc::BoundCond::GREVILLE
@ GREVILLE
Use Greville points instead of conditions on derivative for B-Spline interpolation.
ddc::BoundCond::HERMITE
@ HERMITE
Hermite boundary condition.
ddc::BoundCond::PERIODIC
@ PERIODIC
Periodic boundary condition u(1)=u(n)
ddc::integrals
ddc::ChunkSpan< double, ddc::DiscreteDomain< DDim >, Layout, MemorySpace > integrals(ExecSpace const &execution_space, ddc::ChunkSpan< double, ddc::DiscreteDomain< DDim >, Layout, MemorySpace > int_vals)
Compute the integrals of the B-splines.
Definition integrals.hpp:166
ddc::is_non_uniform_bsplines_v
constexpr bool is_non_uniform_bsplines_v
Indicates if a tag corresponds to non-uniform B-splines or not.
Definition bsplines_non_uniform.hpp:405
ddc::Deriv
A templated struct representing a discrete dimension storing the derivatives of a function along a co...
Definition deriv.hpp:15
ddc::KnotDiscreteDimension
If the type DDim is a B-spline, defines type to the discrete dimension of the associated knots.
Definition knot_discrete_dimension_type.hpp:17
ddc::ConstantExtrapolationRule< DimI, DimNI >::ConstantExtrapolationRule
ConstantExtrapolationRule(ddc::Coordinate< DimI > eval_pos, ddc::Coordinate< DimNI > eval_pos_not_interest_min, ddc::Coordinate< DimNI > eval_pos_not_interest_max)
Instantiate a ConstantExtrapolationRule.
Definition constant_extrapolation_rule.hpp:104
ddc::ConstantExtrapolationRule< DimI, DimNI >::operator()
KOKKOS_FUNCTION double operator()(CoordType coord_extrap, ddc::ChunkSpan< double const, ddc::DiscreteDomain< BSplines1, BSplines2 >, Layout, MemorySpace > const spline_coef) const
Get the value of the function on B-splines at a coordinate outside the domain.
Definition constant_extrapolation_rule.hpp:148
ddc::ConstantExtrapolationRule< DimI, DimNI >::ConstantExtrapolationRule
ConstantExtrapolationRule(ddc::Coordinate< DimI > eval_pos)
Instantiate a ConstantExtrapolationRule.
Definition constant_extrapolation_rule.hpp:125
ddc::ConstantExtrapolationRule< DimI >::operator()
KOKKOS_FUNCTION double operator()(CoordType pos, ddc::ChunkSpan< double const, ddc::DiscreteDomain< BSplines >, Layout, MemorySpace > const spline_coef) const
Get the value of the function on B-splines at a coordinate outside the domain.
Definition constant_extrapolation_rule.hpp:53
ddc::ConstantExtrapolationRule< DimI >::ConstantExtrapolationRule
ConstantExtrapolationRule(ddc::Coordinate< DimI > eval_pos)
Instantiate a ConstantExtrapolationRule.
Definition constant_extrapolation_rule.hpp:42
ddc::NullExtrapolationRule
A functor describing a null extrapolation boundary value for 1D spline evaluator.
Definition null_extrapolation_rule.hpp:15
ddc::NullExtrapolationRule::operator()
KOKKOS_FUNCTION double operator()(CoordType, ChunkSpan) const
Evaluates the spline at a coordinate outside of the domain.
Definition null_extrapolation_rule.hpp:22
ddc::is_non_uniform_bsplines
Definition bsplines_non_uniform.hpp:396
ddc::is_uniform_bsplines
Definition bsplines_uniform.hpp:374