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

#include <periodic_sampling.hpp>

Collaboration diagram for ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >:

Public Types
using	discrete_dimension_type = PeriodicSampling
using	discrete_domain_type = DiscreteDomain< DDim >
using	discrete_element_type = DiscreteElement< DDim >
using	discrete_vector_type = DiscreteVector< DDim >

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

Friends
template<class ODDim , class OMemorySpace >
class	Impl

Detailed Description

template<class CDim>
template<class DDim, class MemorySpace>
class ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >

Definition at line 51 of file periodic_sampling.hpp.

Member Typedef Documentation

discrete_dimension_type

template<class CDim >

template<class DDim , class MemorySpace >

using ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::discrete_dimension_type = PeriodicSampling

Definition at line 64 of file periodic_sampling.hpp.

discrete_domain_type

template<class CDim >

template<class DDim , class MemorySpace >

using ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::discrete_domain_type = DiscreteDomain<DDim>

Definition at line 66 of file periodic_sampling.hpp.

discrete_element_type

template<class CDim >

template<class DDim , class MemorySpace >

using ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::discrete_element_type = DiscreteElement<DDim>

Definition at line 68 of file periodic_sampling.hpp.

discrete_vector_type

template<class CDim >

template<class DDim , class MemorySpace >

using ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::discrete_vector_type = DiscreteVector<DDim>

Definition at line 70 of file periodic_sampling.hpp.

Constructor & Destructor Documentation

Impl() [1/5]

template<class CDim >

template<class DDim , class MemorySpace >

ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::Impl ( )

inlinenoexcept

Definition at line 72 of file periodic_sampling.hpp.

Impl() [2/5]

template<class CDim >

template<class DDim , class MemorySpace >

ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::Impl ( Impl< DDim, MemorySpace > const &  )

delete

Impl() [3/5]

template<class CDim >

template<class DDim , class MemorySpace >

template<class OriginMemorySpace >

ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::Impl ( Impl< DDim, OriginMemorySpace > const &  impl )

inlineexplicit

Definition at line 77 of file periodic_sampling.hpp.

Impl() [4/5]

template<class CDim >

template<class DDim , class MemorySpace >

ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::Impl ( Impl< DDim, MemorySpace > &&  )

default

Impl() [5/5]

template<class CDim >

template<class DDim , class MemorySpace >

ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::Impl ( Coordinate< CDim >  origin, Real  step, std::size_t  n_period  )

inline

Construct a Impl from a point and a spacing step.

Parameters

origin	the real coordinate of mesh coordinate 0
step	the real distance between two points of mesh distance 1
n_period	the number of steps in a period

Definition at line 92 of file periodic_sampling.hpp.

~Impl()

template<class CDim >

template<class DDim , class MemorySpace >

ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::~Impl ( )

default

Member Function Documentation

operator=() [1/2]

template<class CDim >

template<class DDim , class MemorySpace >

Impl & ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::operator= ( Impl< DDim, MemorySpace > const &  x )

delete

operator=() [2/2]

template<class CDim >

template<class DDim , class MemorySpace >

Impl & ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::operator= ( Impl< DDim, MemorySpace > &&  x )

default

origin()

template<class CDim >

template<class DDim , class MemorySpace >

KOKKOS_FUNCTION Coordinate< CDim > ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::origin ( ) const

inlinenoexcept

Lower bound index of the mesh.

Definition at line 108 of file periodic_sampling.hpp.

front()

template<class CDim >

template<class DDim , class MemorySpace >

KOKKOS_FUNCTION discrete_element_type ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::front ( ) const

inlinenoexcept

Lower bound index of the mesh.

Definition at line 114 of file periodic_sampling.hpp.

step()

template<class CDim >

template<class DDim , class MemorySpace >

KOKKOS_FUNCTION Real ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::step ( ) const

inline

Spacing step of the mesh.

Definition at line 120 of file periodic_sampling.hpp.

n_period()

template<class CDim >

template<class DDim , class MemorySpace >

KOKKOS_FUNCTION std::size_t ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::n_period ( ) const

inline

Number of steps in a period.

Definition at line 126 of file periodic_sampling.hpp.

coordinate()

template<class CDim >

template<class DDim , class MemorySpace >

KOKKOS_FUNCTION Coordinate< CDim > ddc::PeriodicSampling< CDim >::Impl< DDim, MemorySpace >::coordinate ( discrete_element_type const &  icoord ) const

inlinenoexcept

Convert a mesh index into a position in CDim

Definition at line 132 of file periodic_sampling.hpp.

Friends And Related Symbol Documentation

Impl

template<class CDim >

template<class DDim , class MemorySpace >

template<class ODDim , class OMemorySpace >

friend class Impl

friend

Definition at line 54 of file periodic_sampling.hpp.

---

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

• periodic_sampling.hpp