DDC 0.1.0
Loading...
Searching...
No Matches
ddc::UniformPointSampling< CDim > Class Template Reference

UniformPointSampling models a uniform discretization of the provided continuous dimension. More...

#include <uniform_point_sampling.hpp>

Inheritance diagram for ddc::UniformPointSampling< CDim >:
Inheritance graph
Collaboration diagram for ddc::UniformPointSampling< CDim >:
Collaboration graph

Classes

class  Impl
 

Public Types

using continuous_dimension_type = CDim
 
using continuous_element_type = Coordinate< CDim >
 
using discrete_dimension_type = UniformPointSampling
 

Static Public Member Functions

template<class DDim >
static std::tuple< typename DDim::template Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim > > init (Coordinate< CDim > a, Coordinate< CDim > b, DiscreteVector< DDim > n)
 Construct a Impl<Kokkos::HostSpace> and associated discrete_domain_type from a segment \([a, b] \subset [a, +\infty[\) and a number of points n.
 
template<class DDim >
static std::tuple< typename DDim::template Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim > > init_ghosted (Coordinate< CDim > a, Coordinate< CDim > b, DiscreteVector< DDim > n, DiscreteVector< DDim > n_ghosts_before, DiscreteVector< DDim > n_ghosts_after)
 Construct a uniform DiscreteDomain from a segment \([a, b] \subset [a, +\infty[\) and a number of points n.
 
template<class DDim >
static std::tuple< typename DDim::template Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim > > init_ghosted (Coordinate< CDim > a, Coordinate< CDim > b, DiscreteVector< DDim > n, DiscreteVector< DDim > n_ghosts)
 Construct a uniform DiscreteDomain from a segment \([a, b] \subset [a, +\infty[\) and a number of points n.
 

Detailed Description

template<class CDim>
class ddc::UniformPointSampling< CDim >

UniformPointSampling models a uniform discretization of the provided continuous dimension.

Definition at line 35 of file uniform_point_sampling.hpp.

Member Typedef Documentation

◆ continuous_dimension_type

template<class CDim >
using ddc::UniformPointSampling< CDim >::continuous_dimension_type = CDim

Definition at line 38 of file uniform_point_sampling.hpp.

◆ continuous_element_type

template<class CDim >
using ddc::UniformPointSampling< CDim >::continuous_element_type = Coordinate<CDim>

Definition at line 40 of file uniform_point_sampling.hpp.

◆ discrete_dimension_type

template<class CDim >
using ddc::UniformPointSampling< CDim >::discrete_dimension_type = UniformPointSampling

Definition at line 43 of file uniform_point_sampling.hpp.

Member Function Documentation

◆ init()

template<class CDim >
template<class DDim >
static std::tuple< typename DDim::template Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim > > ddc::UniformPointSampling< CDim >::init ( Coordinate< CDim a,
Coordinate< CDim b,
DiscreteVector< DDim n 
)
inlinestatic

Construct a Impl<Kokkos::HostSpace> and associated discrete_domain_type from a segment \([a, b] \subset [a, +\infty[\) and a number of points n.

Note that there is no guarantee that either the boundaries a or b will be exactly represented in the sampling. One should expect usual floating point rounding errors.

Parameters
acoordinate of the first point of the domain
bcoordinate of the last point of the domain
nnumber of points to map on the segment \([a, b]\) including a & b

Definition at line 132 of file uniform_point_sampling.hpp.

◆ init_ghosted() [1/2]

template<class CDim >
template<class DDim >
static std::tuple< typename DDim::template Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim > > ddc::UniformPointSampling< CDim >::init_ghosted ( Coordinate< CDim a,
Coordinate< CDim b,
DiscreteVector< DDim n,
DiscreteVector< DDim n_ghosts_before,
DiscreteVector< DDim n_ghosts_after 
)
inlinestatic

Construct a uniform DiscreteDomain from a segment \([a, b] \subset [a, +\infty[\) and a number of points n.

Note that there is no guarantee that either the boundaries a or b will be exactly represented in the sampling. One should expect usual floating point rounding errors.

Parameters
acoordinate of the first point of the domain
bcoordinate of the last point of the domain
nthe number of points to map the segment \([a, b]\) including a & b
n_ghosts_beforenumber of additional "ghost" points before the segment
n_ghosts_afternumber of additional "ghost" points after the segment

Definition at line 160 of file uniform_point_sampling.hpp.

◆ init_ghosted() [2/2]

template<class CDim >
template<class DDim >
static std::tuple< typename DDim::template Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim > > ddc::UniformPointSampling< CDim >::init_ghosted ( Coordinate< CDim a,
Coordinate< CDim b,
DiscreteVector< DDim n,
DiscreteVector< DDim n_ghosts 
)
inlinestatic

Construct a uniform DiscreteDomain from a segment \([a, b] \subset [a, +\infty[\) and a number of points n.

Note that there is no guarantee that either the boundaries a or b will be exactly represented in the sampling. One should expect usual floating point rounding errors.

Parameters
acoordinate of the first point of the domain
bcoordinate of the last point of the domain
nthe number of points to map the segment \([a, b]\) including a & b
n_ghostsnumber of additional "ghost" points before and after the segment

Definition at line 206 of file uniform_point_sampling.hpp.


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