IndexStack< Idx > Class Template Reference#

DiFfRG: DiFfRG::IndexStack< Idx > Class Template Reference
DiFfRG

#include <stack_coordinates.hh>

Public Types

using ctype = Idx
 

Public Member Functions

 IndexStack (Idx start, Idx stop)
 
template<typename Idx2 >
 IndexStack (const LinearCoordinates1D< Idx2 > &other)
 
Idx KOKKOS_FORCEINLINE_FUNCTION forward (const Idx x) const
 Transform from the grid to the physical space.
 
Idx KOKKOS_FORCEINLINE_FUNCTION backward (const Idx y) const
 Transform from the physical space to the grid.
 
size_t size () const
 
std::string to_string () const
 

Public Attributes

const Idx start
 
const Idx stop
 

Static Public Attributes

static constexpr size_t dim = 1
 

Private Attributes

const size_t m_size
 

Member Typedef Documentation

◆ ctype

template<typename Idx >
using DiFfRG::IndexStack< Idx >::ctype = Idx

Constructor & Destructor Documentation

◆ IndexStack() [1/2]

template<typename Idx >
DiFfRG::IndexStack< Idx >::IndexStack ( Idx start,
Idx stop )
inline

◆ IndexStack() [2/2]

template<typename Idx >
template<typename Idx2 >
DiFfRG::IndexStack< Idx >::IndexStack ( const LinearCoordinates1D< Idx2 > & other)
inline

Member Function Documentation

◆ backward()

template<typename Idx >
Idx KOKKOS_FORCEINLINE_FUNCTION DiFfRG::IndexStack< Idx >::backward ( const Idx y) const
inline

Transform from the physical space to the grid.

Parameters
yphysical coordinate
Returns
double grid coordinate

◆ forward()

template<typename Idx >
Idx KOKKOS_FORCEINLINE_FUNCTION DiFfRG::IndexStack< Idx >::forward ( const Idx x) const
inline

Transform from the grid to the physical space.

Parameters
xgrid coordinate
Returns
NumberType physical coordinate

◆ size()

template<typename Idx >
size_t DiFfRG::IndexStack< Idx >::size ( ) const
inline

◆ to_string()

template<typename Idx >
std::string DiFfRG::IndexStack< Idx >::to_string ( ) const
inline

Member Data Documentation

◆ dim

template<typename Idx >
size_t DiFfRG::IndexStack< Idx >::dim = 1
staticconstexpr

◆ m_size

template<typename Idx >
const size_t DiFfRG::IndexStack< Idx >::m_size
private

◆ start

template<typename Idx >
const Idx DiFfRG::IndexStack< Idx >::start

◆ stop

template<typename Idx >
const Idx DiFfRG::IndexStack< Idx >::stop

The documentation for this class was generated from the following file:
  • /home/runner/work/DiFfRG_current/DiFfRG_current/DiFfRG/include/DiFfRG/discretization/coordinates/stack_coordinates.hh