DDC 0.0.0

a discrete domain computation library

ddc::PeriodicSampling< CDim > Class Template Reference

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

Classes

class  Impl
 

Public Types

using continuous_dimension_type = CDim
 
using continuous_element_type = Coordinate< CDim >
 
using discrete_dimension_type = PeriodicSampling
 
using discrete_element_type = DiscreteElement< PeriodicSampling >
 
using discrete_domain_type = DiscreteDomain< PeriodicSampling >
 
using discrete_vector_type = DiscreteVector< PeriodicSampling >
 

Static Public Member Functions

static std::tuple< Impl< Kokkos::HostSpace >, discrete_domain_typeinit (continuous_element_type a, continuous_element_type b, discrete_vector_type n, discrete_vector_type 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. More...
 
static std::tuple< Impl< Kokkos::HostSpace >, discrete_domain_type, discrete_domain_type, discrete_domain_type, discrete_domain_typeinit_ghosted (continuous_element_type a, continuous_element_type b, discrete_vector_type n, discrete_vector_type n_period, discrete_vector_type n_ghosts_before, discrete_vector_type n_ghosts_after)
 Construct a periodic DiscreteDomain from a segment $[a, b] \subset [a, +\infty[$ and a number of points n. More...
 
static std::tuple< Impl< Kokkos::HostSpace >, discrete_domain_type, discrete_domain_type, discrete_domain_type, discrete_domain_typeinit_ghosted (continuous_element_type a, continuous_element_type b, discrete_vector_type n, discrete_vector_type n_period, discrete_vector_type n_ghosts)
 Construct a periodic DiscreteDomain from a segment $[a, b] \subset [a, +\infty[$ and a number of points n. More...
 

Detailed Description

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

PeriodicSampling models a periodic discretization of the provided continuous dimension.

Member Typedef Documentation

◆ continuous_dimension_type

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

◆ continuous_element_type

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

◆ discrete_dimension_type

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

◆ discrete_element_type

template<class CDim >
using ddc::PeriodicSampling< CDim >::discrete_element_type = DiscreteElement<PeriodicSampling>

◆ discrete_domain_type

template<class CDim >
using ddc::PeriodicSampling< CDim >::discrete_domain_type = DiscreteDomain<PeriodicSampling>

◆ discrete_vector_type

template<class CDim >
using ddc::PeriodicSampling< CDim >::discrete_vector_type = DiscreteVector<PeriodicSampling>

Member Function Documentation

◆ init()

template<class CDim >
static std::tuple< Impl< Kokkos::HostSpace >, discrete_domain_type > ddc::PeriodicSampling< CDim >::init ( continuous_element_type  a,
continuous_element_type  b,
discrete_vector_type  n,
discrete_vector_type  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.

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
n_periodthe number of steps in a period

◆ init_ghosted() [1/2]

template<class CDim >
static std::tuple< Impl< Kokkos::HostSpace >, discrete_domain_type, discrete_domain_type, discrete_domain_type, discrete_domain_type > ddc::PeriodicSampling< CDim >::init_ghosted ( continuous_element_type  a,
continuous_element_type  b,
discrete_vector_type  n,
discrete_vector_type  n_period,
discrete_vector_type  n_ghosts_before,
discrete_vector_type  n_ghosts_after 
)
inlinestatic

Construct a periodic DiscreteDomain from a segment $[a, b] \subset [a, +\infty[$ and a number of points n.

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_periodthe number of steps in a period
n_ghosts_beforenumber of additional "ghost" points before the segment
n_ghosts_afternumber of additional "ghost" points after the segment

◆ init_ghosted() [2/2]

template<class CDim >
static std::tuple< Impl< Kokkos::HostSpace >, discrete_domain_type, discrete_domain_type, discrete_domain_type, discrete_domain_type > ddc::PeriodicSampling< CDim >::init_ghosted ( continuous_element_type  a,
continuous_element_type  b,
discrete_vector_type  n,
discrete_vector_type  n_period,
discrete_vector_type  n_ghosts 
)
inlinestatic

Construct a periodic DiscreteDomain from a segment $[a, b] \subset [a, +\infty[$ and a number of points n.

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_periodthe number of steps in a period
n_ghostsnumber of additional "ghost" points before and after the segment

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