DiscreteToCartesianBuilder< X, Y, SplineBuilder, SplineEvaluator > Class Template Reference

A class to create a DiscreteToCartesian instance from an analytical mapping. More...

Public Types
using	MappingType = DiscreteToCartesian< X, Y, SplineEvaluator >
	The type of the mapping that will be created.

Public Member Functions
template<class Mapping >
	DiscreteToCartesianBuilder (ExecSpace exec_space, Mapping const &analytical_mapping, SplineBuilder const &builder, SplineEvaluator const &evaluator)
	Create an instance of the class capable of providing a DiscreteToCartesian class instance.
DiscreteToCartesian< X, Y, SplineEvaluator >	operator() () const
	Get a DiscreteToCartesian class instance.
template<class Mapping >
void	set_curvilinear_to_cartesian_values (InterpolationField const &curvilinear_to_x_vals, InterpolationField const &curvilinear_to_y_vals, Mapping const &analytical_mapping, IdxRangeInterpolationPoints const &interpolation_idx_range)
	Fill in the curvilinear fields with interpolation points mapped with the given analytical mapping.

Detailed Description

template<class X, class Y, class SplineBuilder, class SplineEvaluator>
class DiscreteToCartesianBuilder< X, Y, SplineBuilder, SplineEvaluator >

A class to create a DiscreteToCartesian instance from an analytical mapping.

This class creates and stores splines memory spaces describing the analytical mapping. The discrete mapping is then created using the splines without copying data.

Template Parameters

X	The first cartesian dimension.
Y	The second cartesian dimension.
SplineBuilder	An operator for building spline coefficients.
SplineEvaluator	An operator for evaluating a spline.

Constructor & Destructor Documentation

DiscreteToCartesianBuilder()

template<class X , class Y , class SplineBuilder , class SplineEvaluator >

template<class Mapping >

DiscreteToCartesianBuilder< X, Y, SplineBuilder, SplineEvaluator >::DiscreteToCartesianBuilder ( ExecSpace  exec_space, Mapping const &  analytical_mapping, SplineBuilder const &  builder, SplineEvaluator const &  evaluator  )

inline

Create an instance of the class capable of providing a DiscreteToCartesian class instance.

Parameters

[in]	exec_space	The execution space where this class runs any for loops.
[in]	analytical_mapping	The analytical mapping to be described by this discrete mapping.
[in]	builder	A spline builder to be used to create a spline approximating the analytical mapping.
[in]	evaluator	A spline evaluator to be used to evaluate a spline approximating the analytical mapping.

Member Function Documentation

operator()()

template<class X , class Y , class SplineBuilder , class SplineEvaluator >

DiscreteToCartesian< X, Y, SplineEvaluator > DiscreteToCartesianBuilder< X, Y, SplineBuilder, SplineEvaluator >::operator() ( ) const

inline

Get a DiscreteToCartesian class instance.

Returns

An instance of the mapping.

set_curvilinear_to_cartesian_values()

template<class X , class Y , class SplineBuilder , class SplineEvaluator >

template<class Mapping >

void DiscreteToCartesianBuilder< X, Y, SplineBuilder, SplineEvaluator >::set_curvilinear_to_cartesian_values ( InterpolationField const &  curvilinear_to_x_vals, InterpolationField const &  curvilinear_to_y_vals, Mapping const &  analytical_mapping, IdxRangeInterpolationPoints const &  interpolation_idx_range  )

inline

Fill in the curvilinear fields with interpolation points mapped with the given analytical mapping.

This function should be private. It is not due to the inclusion of a KOKKOS_LAMBDA

Template Parameters

Mapping

Type of the analytical mapping.

Parameters

[out]	curvilinear_to_x_vals	Field of coordinate on X.
[out]	curvilinear_to_y_vals	Field of coordinate on Y.
[in]	analytical_mapping	Analytical mapping.
[in]	interpolation_idx_range	Index range of an interpolation grid.

---

The documentation for this class was generated from the following file:

• /home/runner/work/gyselalibxx/gyselalibxx/code_branch/vendor/sll/include/sll/mapping/discrete_mapping_builder.hpp