A class to evaluate, differentiate or integrate a 2D spline function. More...
#include <spline_evaluator_2d.hpp>

Public Types | |
| using | continuous_dimension_type1 = typename BSplines1::continuous_dimension_type |
| The type of the first evaluation continuous dimension used by this class. | |
| using | continuous_dimension_type2 = typename BSplines2::continuous_dimension_type |
| The type of the second evaluation continuous dimension used by this class. | |
| using | exec_space = ExecSpace |
| The type of the Kokkos execution space used by this class. | |
| using | memory_space = MemorySpace |
| The type of the Kokkos memory space used by this class. | |
| using | evaluation_discrete_dimension_type1 = EvaluationDDim1 |
| The type of the first discrete dimension of interest used by this class. | |
| using | evaluation_discrete_dimension_type2 = EvaluationDDim2 |
| The type of the second discrete dimension of interest used by this class. | |
| using | bsplines_type1 = BSplines1 |
| The discrete dimension representing the B-splines along first dimension. | |
| using | bsplines_type2 = BSplines2 |
| The discrete dimension representing the B-splines along second dimension. | |
| using | evaluation_domain_type1 = ddc::DiscreteDomain< evaluation_discrete_dimension_type1 > |
| The type of the domain for the 1D evaluation mesh along first dimension used by this class. | |
| using | evaluation_domain_type2 = ddc::DiscreteDomain< evaluation_discrete_dimension_type2 > |
| The type of the domain for the 1D evaluation mesh along second dimension used by this class. | |
| using | evaluation_domain_type = ddc::DiscreteDomain< evaluation_discrete_dimension_type1, evaluation_discrete_dimension_type2 > |
| The type of the domain for the 2D evaluation mesh used by this class. | |
| template<class BatchedInterpolationDDom , class = std::enable_if_t<ddc::is_discrete_domain_v<BatchedInterpolationDDom>>> | |
| using | batched_evaluation_domain_type = BatchedInterpolationDDom |
| The type of the whole domain representing evaluation points. | |
| using | spline_domain_type1 = ddc::DiscreteDomain< bsplines_type1 > |
| The type of the 1D spline domain corresponding to the first dimension of interest. | |
| using | spline_domain_type2 = ddc::DiscreteDomain< bsplines_type2 > |
| The type of the 1D spline domain corresponding to the second dimension of interest. | |
| using | spline_domain_type = ddc::DiscreteDomain< bsplines_type1, bsplines_type2 > |
| The type of the 2D spline domain corresponding to the dimensions of interest. | |
| template<class BatchedInterpolationDDom , class = std::enable_if_t<ddc::is_discrete_domain_v<BatchedInterpolationDDom>>> | |
| using | batch_domain_type = typename ddc::remove_dims_of_t< BatchedInterpolationDDom, evaluation_discrete_dimension_type1, evaluation_discrete_dimension_type2 > |
| The type of the batch domain (obtained by removing the dimensions of interest from the whole domain). | |
| template<class BatchedInterpolationDDom , class = std::enable_if_t<ddc::is_discrete_domain_v<BatchedInterpolationDDom>>> | |
| using | batched_spline_domain_type = typename ddc::detail::convert_type_seq_to_discrete_domain_t< ddc::type_seq_replace_t< ddc::to_type_seq_t< BatchedInterpolationDDom >, ddc::detail::TypeSeq< evaluation_discrete_dimension_type1, evaluation_discrete_dimension_type2 >, ddc::detail::TypeSeq< bsplines_type1, bsplines_type2 > > > |
| The type of the whole spline domain (cartesian product of 2D spline domain and batch domain) preserving the underlying memory layout (order of dimensions). | |
| using | lower_extrapolation_rule_1_type = LowerExtrapolationRule1 |
| The type of the extrapolation rule at the lower boundary along the first dimension. | |
| using | upper_extrapolation_rule_1_type = UpperExtrapolationRule1 |
| The type of the extrapolation rule at the upper boundary along the first dimension. | |
| using | lower_extrapolation_rule_2_type = LowerExtrapolationRule2 |
| The type of the extrapolation rule at the lower boundary along the second dimension. | |
| using | upper_extrapolation_rule_2_type = UpperExtrapolationRule2 |
| The type of the extrapolation rule at the upper boundary along the second dimension. | |
A class to evaluate, differentiate or integrate a 2D spline function.
A class which contains an operator () which can be used to evaluate, differentiate or integrate a 2D spline function.
| ExecSpace | The Kokkos execution space on which the spline evaluation is performed. |
| MemorySpace | The Kokkos memory space on which the data (spline coefficients and evaluation) is stored. |
| BSplines1 | The discrete dimension representing the B-splines along the first dimension of interest. |
| BSplines2 | The discrete dimension representing the B-splines along the second dimension of interest. |
| EvaluationDDim1 | The first discrete dimension on which evaluation points are defined. |
| EvaluationDDim2 | The second discrete dimension on which evaluation points are defined. |
| LowerExtrapolationRule1 | The lower extrapolation rule type along first dimension of interest. |
| UpperExtrapolationRule1 | The upper extrapolation rule type along first dimension of interest. |
| LowerExtrapolationRule2 | The lower extrapolation rule type along second dimension of interest. |
| UpperExtrapolationRule2 | The upper extrapolation rule type along second dimension of interest. |
Definition at line 48 of file spline_evaluator_2d.hpp.
| using ddc::SplineEvaluator2D< ExecSpace, MemorySpace, BSplines1, BSplines2, EvaluationDDim1, EvaluationDDim2, LowerExtrapolationRule1, UpperExtrapolationRule1, LowerExtrapolationRule2, UpperExtrapolationRule2 >::continuous_dimension_type1 = typename BSplines1::continuous_dimension_type |
The type of the first evaluation continuous dimension used by this class.
Definition at line 52 of file spline_evaluator_2d.hpp.
| using ddc::SplineEvaluator2D< ExecSpace, MemorySpace, BSplines1, BSplines2, EvaluationDDim1, EvaluationDDim2, LowerExtrapolationRule1, UpperExtrapolationRule1, LowerExtrapolationRule2, UpperExtrapolationRule2 >::continuous_dimension_type2 = typename BSplines2::continuous_dimension_type |
The type of the second evaluation continuous dimension used by this class.
Definition at line 55 of file spline_evaluator_2d.hpp.
The type of the Kokkos execution space used by this class.
Definition at line 58 of file spline_evaluator_2d.hpp.
The type of the Kokkos memory space used by this class.
Definition at line 61 of file spline_evaluator_2d.hpp.
| using ddc::SplineEvaluator2D< ExecSpace, MemorySpace, BSplines1, BSplines2, EvaluationDDim1, EvaluationDDim2, LowerExtrapolationRule1, UpperExtrapolationRule1, LowerExtrapolationRule2, UpperExtrapolationRule2 >::evaluation_discrete_dimension_type1 = EvaluationDDim1 |
The type of the first discrete dimension of interest used by this class.
Definition at line 64 of file spline_evaluator_2d.hpp.
| using ddc::SplineEvaluator2D< ExecSpace, MemorySpace, BSplines1, BSplines2, EvaluationDDim1, EvaluationDDim2, LowerExtrapolationRule1, UpperExtrapolationRule1, LowerExtrapolationRule2, UpperExtrapolationRule2 >::evaluation_discrete_dimension_type2 = EvaluationDDim2 |
The type of the second discrete dimension of interest used by this class.
Definition at line 67 of file spline_evaluator_2d.hpp.
The discrete dimension representing the B-splines along first dimension.
Definition at line 70 of file spline_evaluator_2d.hpp.
The discrete dimension representing the B-splines along second dimension.
Definition at line 73 of file spline_evaluator_2d.hpp.
The type of the domain for the 1D evaluation mesh along first dimension used by this class.
Definition at line 76 of file spline_evaluator_2d.hpp.
The type of the domain for the 1D evaluation mesh along second dimension used by this class.
Definition at line 79 of file spline_evaluator_2d.hpp.
The type of the domain for the 2D evaluation mesh used by this class.
Definition at line 82 of file spline_evaluator_2d.hpp.
| using ddc::SplineEvaluator2D< ExecSpace, MemorySpace, BSplines1, BSplines2, EvaluationDDim1, EvaluationDDim2, LowerExtrapolationRule1, UpperExtrapolationRule1, LowerExtrapolationRule2, UpperExtrapolationRule2 >::batched_evaluation_domain_type = BatchedInterpolationDDom |
The type of the whole domain representing evaluation points.
| The | batched discrete domain on which the interpolation points are defined. |
Definition at line 94 of file spline_evaluator_2d.hpp.
The type of the 1D spline domain corresponding to the first dimension of interest.
Definition at line 97 of file spline_evaluator_2d.hpp.
The type of the 1D spline domain corresponding to the second dimension of interest.
Definition at line 100 of file spline_evaluator_2d.hpp.
The type of the 2D spline domain corresponding to the dimensions of interest.
Definition at line 103 of file spline_evaluator_2d.hpp.
The type of the batch domain (obtained by removing the dimensions of interest from the whole domain).
| The | batched discrete domain on which the interpolation points are defined. |
Definition at line 114 of file spline_evaluator_2d.hpp.
| using ddc::SplineEvaluator2D< ExecSpace, MemorySpace, BSplines1, BSplines2, EvaluationDDim1, EvaluationDDim2, LowerExtrapolationRule1, UpperExtrapolationRule1, LowerExtrapolationRule2, UpperExtrapolationRule2 >::batched_spline_domain_type = typename ddc::detail::convert_type_seq_to_discrete_domain_t<ddc::type_seq_replace_t< ddc::to_type_seq_t<BatchedInterpolationDDom>, ddc::detail::TypeSeq< evaluation_discrete_dimension_type1, evaluation_discrete_dimension_type2>, ddc::detail::TypeSeq<bsplines_type1, bsplines_type2> >> |
The type of the whole spline domain (cartesian product of 2D spline domain and batch domain) preserving the underlying memory layout (order of dimensions).
| The | batched discrete domain on which the interpolation points are defined. |
Definition at line 128 of file spline_evaluator_2d.hpp.
| using ddc::SplineEvaluator2D< ExecSpace, MemorySpace, BSplines1, BSplines2, EvaluationDDim1, EvaluationDDim2, LowerExtrapolationRule1, UpperExtrapolationRule1, LowerExtrapolationRule2, UpperExtrapolationRule2 >::lower_extrapolation_rule_1_type = LowerExtrapolationRule1 |
The type of the extrapolation rule at the lower boundary along the first dimension.
Definition at line 137 of file spline_evaluator_2d.hpp.
| using ddc::SplineEvaluator2D< ExecSpace, MemorySpace, BSplines1, BSplines2, EvaluationDDim1, EvaluationDDim2, LowerExtrapolationRule1, UpperExtrapolationRule1, LowerExtrapolationRule2, UpperExtrapolationRule2 >::upper_extrapolation_rule_1_type = UpperExtrapolationRule1 |
The type of the extrapolation rule at the upper boundary along the first dimension.
Definition at line 140 of file spline_evaluator_2d.hpp.
| using ddc::SplineEvaluator2D< ExecSpace, MemorySpace, BSplines1, BSplines2, EvaluationDDim1, EvaluationDDim2, LowerExtrapolationRule1, UpperExtrapolationRule1, LowerExtrapolationRule2, UpperExtrapolationRule2 >::lower_extrapolation_rule_2_type = LowerExtrapolationRule2 |
The type of the extrapolation rule at the lower boundary along the second dimension.
Definition at line 143 of file spline_evaluator_2d.hpp.
| using ddc::SplineEvaluator2D< ExecSpace, MemorySpace, BSplines1, BSplines2, EvaluationDDim1, EvaluationDDim2, LowerExtrapolationRule1, UpperExtrapolationRule1, LowerExtrapolationRule2, UpperExtrapolationRule2 >::upper_extrapolation_rule_2_type = UpperExtrapolationRule2 |
The type of the extrapolation rule at the upper boundary along the second dimension.
Definition at line 146 of file spline_evaluator_2d.hpp.
|
inlineexplicit |
Build a SplineEvaluator2D acting on batched_spline_domain.
| lower_extrap_rule1 | The extrapolation rule at the lower boundary along the first dimension. |
| upper_extrap_rule1 | The extrapolation rule at the upper boundary along the first dimension. |
| lower_extrap_rule2 | The extrapolation rule at the lower boundary along the second dimension. |
| upper_extrap_rule2 | The extrapolation rule at the upper boundary along the second dimension. |
Definition at line 234 of file spline_evaluator_2d.hpp.
Copy-constructs.
| x | A reference to another SplineEvaluator. |
|
default |
Move-constructs.
| x | An rvalue to another SplineEvaluator. |
|
default |
Destructs.
|
default |
Copy-assigns.
| x | A reference to another SplineEvaluator. |
|
default |
|
inline |
Get the lower extrapolation rule along the first dimension.
Extrapolation rules are functors used to define the behavior of the SplineEvaluator out of the domain where the break points of the B-splines are defined.
Definition at line 288 of file spline_evaluator_2d.hpp.
|
inline |
Get the upper extrapolation rule along the first dimension.
Extrapolation rules are functors used to define the behavior of the SplineEvaluator out of the domain where the break points of the B-splines are defined.
Definition at line 302 of file spline_evaluator_2d.hpp.
|
inline |
Get the lower extrapolation rule along the second dimension.
Extrapolation rules are functors used to define the behavior of the SplineEvaluator out of the domain where the break points of the B-splines are defined.
Definition at line 316 of file spline_evaluator_2d.hpp.
|
inline |
Get the upper extrapolation rule along the second dimension.
Extrapolation rules are functors used to define the behavior of the SplineEvaluator out of the domain where the break points of the B-splines are defined.
Definition at line 330 of file spline_evaluator_2d.hpp.
|
inline |
Evaluate 2D spline function (described by its spline coefficients) at a given coordinate.
The spline coefficients represent a 2D spline function defined on a B-splines (basis splines). They can be obtained via various methods, such as using a SplineBuilder2D.
Remark: calling SplineBuilder2D then SplineEvaluator2D corresponds to a 2D spline interpolation.
| coord_eval | The coordinate where the spline is evaluated. Note that only the components along the dimensions of interest are used. |
| spline_coef | A ChunkSpan storing the 2D spline coefficients. |
Definition at line 348 of file spline_evaluator_2d.hpp.
|
inline |
Evaluate 2D spline function (described by its spline coefficients) on a mesh.
The spline coefficients represent a 2D spline function defined on a cartesian product of batch_domain and B-splines (basis splines). They can be obtained via various methods, such as using a SplineBuilder2D.
This is not a nD evaluation. This is a batched 2D evaluation. This means that for each slice of coordinates identified by a batch_domain_type::discrete_element_type, the evaluation is performed with the 2D set of spline coefficients identified by the same batch_domain_type::discrete_element_type.
Remark: calling SplineBuilder2D then SplineEvaluator2D corresponds to a 2D spline interpolation.
| [out] | spline_eval | The values of the 2D spline function at the desired coordinates. For practical reasons those are stored in a ChunkSpan defined on a batched_evaluation_domain_type. |
| [in] | coords_eval | The coordinates where the spline is evaluated. Those are stored in a ChunkSpan defined on a batched_evaluation_domain_type. Note that the coordinates of the points represented by this domain are unused and irrelevant (but the points themselves (DiscreteElement) are used to select the set of 2D spline coefficients retained to perform the evaluation). |
| [in] | spline_coef | A ChunkSpan storing the 2D spline coefficients. |
Definition at line 382 of file spline_evaluator_2d.hpp.
|
inline |
Evaluate 2D spline function (described by its spline coefficients) on a mesh.
The spline coefficients represent a 2D spline function defined on a cartesian product of batch_domain and B-splines (basis splines). They can be obtained via various methods, such as using a SplineBuilder2D.
This is not a multidimensional evaluation. This is a batched 2D evaluation. This means that for each slice of spline_eval the evaluation is performed with the 2D set of spline coefficients identified by the same batch_domain_type::discrete_element_type.
Remark: calling SplineBuilder2D then SplineEvaluator2D corresponds to a 2D spline interpolation.
| [out] | spline_eval | The values of the 2D spline function at their coordinates. |
| [in] | spline_coef | A ChunkSpan storing the 2D spline coefficients. |
Definition at line 433 of file spline_evaluator_2d.hpp.
|
inline |
Differentiate 2D spline function (described by its spline coefficients) at a given coordinate along the dimensions of interest.
The spline coefficients represent a 2D spline function defined on a B-splines (basis splines). They can be obtained via various methods, such as using a SplineBuilder2D.
| deriv_order | A DiscreteElement containing the orders of derivation for each of the dimensions of interest. If one of the dimensions is not present, its corresponding order of derivation is considered to be 0. |
| coord_eval | The coordinate where the spline is differentiated. Note that only the components along the dimensions of interest are used. |
| spline_coef | A ChunkSpan storing the 2D spline coefficients. |
Definition at line 1079 of file spline_evaluator_2d.hpp.
|
inline |
Differentiate 2D spline function (described by its spline coefficients) on a mesh along the dimensions of interest.
The spline coefficients represent a 2D spline function defined on a cartesian product of batch_domain and B-splines (basis splines). They can be obtained via various methods, such as using a SplineBuilder2D.
This is not a nD differentiation. This is a batched 2D differentiation. This means that for each slice of coordinates identified by a batch_domain_type::discrete_element_type, the differentiation is performed with the 2D set of spline coefficients identified by the same batch_domain_type::discrete_element_type.
| [in] | deriv_order | A DiscreteElement containing the orders of derivation for each of the dimensions of interest. If one of the dimensions is not present, its corresponding order of derivation is considered to be 0. |
| [out] | spline_eval | The derivatives of the 2D spline function at the desired coordinates. For practical reasons those are stored in a ChunkSpan defined on a batched_evaluation_domain_type. Note that the coordinates of the points represented by this domain are unused and irrelevant (but the points themselves (DiscreteElement) are used to select the set of 2D spline coefficients retained to perform the evaluation). |
| [in] | coords_eval | The coordinates where the spline is differentiated. Those are stored in a ChunkSpan defined on a batched_evaluation_domain_type. Note that the coordinates of the points represented by this domain are unused and irrelevant (but the points themselves (DiscreteElement) are used to select the set of 2D spline coefficients retained to perform the evaluation). |
| [in] | spline_coef | A ChunkSpan storing the 2D spline coefficients. |
Definition at line 1117 of file spline_evaluator_2d.hpp.
|
inline |
Differentiate 2D spline function (described by its spline coefficients) on a mesh along the dimensions of interest.
The spline coefficients represent a 2D spline function defined on a cartesian product of batch_domain and B-splines (basis splines). They can be obtained via various methods, such as using a SplineBuilder2D.
This is not a multidimensional differentiation. This is a batched 2D differentiation. This means that for each slice of spline_eval the differentiation is performed with the 2D set of spline coefficients identified by the same batch_domain_type::discrete_element_type.
| [in] | deriv_order | A DiscreteElement containing the orders of derivation for each of the dimensions of interest. If one of the dimensions is not present, its corresponding order of derivation is considered to be 0. |
| [out] | spline_eval | The derivatives of the 2D spline function at the desired coordinates. |
| [in] | spline_coef | A ChunkSpan storing the 2D spline coefficients. |
Definition at line 1174 of file spline_evaluator_2d.hpp.
|
inline |
Perform batched 2D integrations of a spline function (described by its spline coefficients) along the dimensions of interest and store results on a subdomain of batch_domain.
The spline coefficients represent a 2D spline function defined on a B-splines (basis splines). They can be obtained via various methods, such as using a SplineBuilder2D.
This is not a nD integration. This is a batched 2D integration. This means that for each element of integrals, the integration is performed with the 2D set of spline coefficients identified by the same DiscreteElement.
| [out] | integrals | The integrals of the 2D spline function on the subdomain of batch_domain. For practical reasons those are stored in a ChunkSpan defined on a batch_domain_type. Note that the coordinates of the points represented by this domain are unused and irrelevant. |
| [in] | spline_coef | A ChunkSpan storing the 2D spline coefficients. |
Definition at line 1223 of file spline_evaluator_2d.hpp.