DDC 0.0.0

a discrete domain computation library

ddc::PeriodicSampling< CDim >::Impl< MemorySpace > Class Template Reference

Public Types

using discrete_dimension_type = PeriodicSampling
 

Public Member Functions

 Impl ()=default
 
 Impl (Impl const &)=delete
 
template<class OriginMemorySpace >
 Impl (Impl< OriginMemorySpace > const &impl)
 
 Impl (Impl &&)=default
 
constexpr Impl (continuous_element_type origin, Real step, std::size_t n_period)
 Construct a Impl from a point and a spacing step. More...
 
 ~Impl ()=default
 
constexpr continuous_element_type origin () const noexcept
 Lower bound index of the mesh. More...
 
constexpr discrete_element_type front () const noexcept
 Lower bound index of the mesh. More...
 
constexpr Real step () const
 Spacing step of the mesh. More...
 
constexpr std::size_t n_period () const
 Number of steps in a period. More...
 
constexpr continuous_element_type coordinate (discrete_element_type const &icoord) const noexcept
 Convert a mesh index into a position in CDim More...
 

Friends

template<class OMemorySpace >
class Impl
 

Member Typedef Documentation

◆ discrete_dimension_type

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

Constructor & Destructor Documentation

◆ Impl() [1/5]

template<class CDim >
template<class MemorySpace >
ddc::PeriodicSampling< CDim >::Impl< MemorySpace >::Impl ( )
default

◆ Impl() [2/5]

template<class CDim >
template<class MemorySpace >
ddc::PeriodicSampling< CDim >::Impl< MemorySpace >::Impl ( Impl< MemorySpace > const &  )
delete

◆ Impl() [3/5]

template<class CDim >
template<class MemorySpace >
template<class OriginMemorySpace >
ddc::PeriodicSampling< CDim >::Impl< MemorySpace >::Impl ( Impl< OriginMemorySpace > const &  impl)
inlineexplicit

◆ Impl() [4/5]

template<class CDim >
template<class MemorySpace >
ddc::PeriodicSampling< CDim >::Impl< MemorySpace >::Impl ( Impl< MemorySpace > &&  )
default

◆ Impl() [5/5]

template<class CDim >
template<class MemorySpace >
constexpr ddc::PeriodicSampling< CDim >::Impl< MemorySpace >::Impl ( continuous_element_type  origin,
Real  step,
std::size_t  n_period 
)
inlineconstexpr

Construct a Impl from a point and a spacing step.

Parameters
originthe real coordinate of mesh coordinate 0
stepthe real distance between two points of mesh distance 1
n_periodthe number of steps in a period

◆ ~Impl()

template<class CDim >
template<class MemorySpace >
ddc::PeriodicSampling< CDim >::Impl< MemorySpace >::~Impl ( )
default

Member Function Documentation

◆ origin()

template<class CDim >
template<class MemorySpace >
constexpr continuous_element_type ddc::PeriodicSampling< CDim >::Impl< MemorySpace >::origin ( ) const
inlineconstexprnoexcept

Lower bound index of the mesh.

◆ front()

template<class CDim >
template<class MemorySpace >
constexpr discrete_element_type ddc::PeriodicSampling< CDim >::Impl< MemorySpace >::front ( ) const
inlineconstexprnoexcept

Lower bound index of the mesh.

◆ step()

template<class CDim >
template<class MemorySpace >
constexpr Real ddc::PeriodicSampling< CDim >::Impl< MemorySpace >::step ( ) const
inlineconstexpr

Spacing step of the mesh.

◆ n_period()

template<class CDim >
template<class MemorySpace >
constexpr std::size_t ddc::PeriodicSampling< CDim >::Impl< MemorySpace >::n_period ( ) const
inlineconstexpr

Number of steps in a period.

◆ coordinate()

template<class CDim >
template<class MemorySpace >
constexpr continuous_element_type ddc::PeriodicSampling< CDim >::Impl< MemorySpace >::coordinate ( discrete_element_type const &  icoord) const
inlineconstexprnoexcept

Convert a mesh index into a position in CDim

Friends And Related Function Documentation

◆ Impl

template<class CDim >
template<class MemorySpace >
template<class OMemorySpace >
friend class Impl
friend

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