ddc::PeriodicSampling< CDim > Class Template Reference

PeriodicSampling models a periodic discretization of the provided continuous dimension. More...

#include <periodic_sampling.hpp>

Inheritance diagram for ddc::PeriodicSampling< CDim >:

Collaboration diagram for ddc::PeriodicSampling< CDim >:

Classes
class	Impl

Public Types
using	continuous_dimension_type = CDim
using	discrete_dimension_type = PeriodicSampling

Public Member Functions
template<concepts::discrete_dimension DDim>
std::tuple< 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_period, DiscreteVector< DDim > n_ghosts_before, DiscreteVector< DDim > n_ghosts_after)
	Construct a periodic DiscreteDomain from a segment \([a, b] \subset [a, +\infty[\) and a number of points n.
template<concepts::discrete_dimension DDim>
std::tuple< 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_period, DiscreteVector< DDim > n_ghosts)
	Construct a periodic DiscreteDomain from a segment \([a, b] \subset [a, +\infty[\) and a number of points n.

Static Public Member Functions
template<concepts::discrete_dimension DDim>
static std::tuple< typename DDim::template Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim > >	init (Coordinate< CDim > a, Coordinate< CDim > b, DiscreteVector< DDim > n, DiscreteVector< DDim > n_period)
	Construct a Impl<Kokkos::HostSpace> and associated discrete_domain_type from a segment \([a, b] \subset [a, +\infty[\) and a number of points n.

Detailed Description

template<class CDim>
class ddc::PeriodicSampling< CDim >

PeriodicSampling models a periodic discretization of the provided continuous dimension.

Definition at line 39 of file periodic_sampling.hpp.

Member Typedef Documentation

continuous_dimension_type

template<class CDim >

using ddc::PeriodicSampling< CDim >::continuous_dimension_type = CDim

Definition at line 44 of file periodic_sampling.hpp.

discrete_dimension_type

template<class CDim >

using ddc::PeriodicSampling< CDim >::discrete_dimension_type = PeriodicSampling

Definition at line 46 of file periodic_sampling.hpp.

Member Function Documentation

init()

template<class CDim >

template<concepts::discrete_dimension DDim>

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

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

a	coordinate of the first point of the domain
b	coordinate of the last point of the domain
n	number of points to map on the segment \([a, b]\) including a & b
n_period	the number of steps in a period

Definition at line 164 of file periodic_sampling.hpp.

init_ghosted() [1/2]

template<class CDim >

template<concepts::discrete_dimension DDim>

std::tuple< Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim > > ddc::PeriodicSampling< CDim >::init_ghosted ( Coordinate< CDim >  a, Coordinate< CDim >  b, DiscreteVector< DDim >  n, DiscreteVector< DDim >  n_period, DiscreteVector< DDim >  n_ghosts_before, DiscreteVector< DDim >  n_ghosts_after  )

inline

Construct a periodic 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

a	coordinate of the first point of the domain
b	coordinate of the last point of the domain
n	the number of points to map the segment \([a, b]\) including a & b
n_period	the number of steps in a period
n_ghosts_before	number of additional "ghost" points before the segment
n_ghosts_after	number of additional "ghost" points after the segment

Definition at line 197 of file periodic_sampling.hpp.

init_ghosted() [2/2]

template<class CDim >

template<concepts::discrete_dimension DDim>

std::tuple< Impl< DDim, Kokkos::HostSpace >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim >, DiscreteDomain< DDim > > ddc::PeriodicSampling< CDim >::init_ghosted ( Coordinate< CDim >  a, Coordinate< CDim >  b, DiscreteVector< DDim >  n, DiscreteVector< DDim >  n_period, DiscreteVector< DDim >  n_ghosts  )

inline

Construct a periodic 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

a	coordinate of the first point of the domain
b	coordinate of the last point of the domain
n	the number of points to map the segment \([a, b]\) including a & b
n_period	the number of steps in a period
n_ghosts	number of additional "ghost" points before and after the segment

Definition at line 243 of file periodic_sampling.hpp.

---

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

• periodic_sampling.hpp