LinearCoordinates1D< NT > Class Template Reference#

DiFfRG: DiFfRG::LinearCoordinates1D< NT > Class Template Reference
DiFfRG

#include <coordinates.hh>

Public Types

using ctype = NT
 

Public Member Functions

 LinearCoordinates1D (size_t grid_extent, double start, double stop)
 
template<typename NT2 >
 LinearCoordinates1D (const LinearCoordinates1D< NT2 > &other)
 
device::array< size_t, 1 > KOKKOS_FORCEINLINE_FUNCTION from_linear_index (size_t i) const
 
template<typename IT >
NT KOKKOS_FORCEINLINE_FUNCTION forward (const IT &x) const
 Transform from the grid to the physical space.
 
template<typename IT >
device::array< NT, 1 > KOKKOS_FORCEINLINE_FUNCTION forward (const device::array< IT, 1 > &x) const
 
NT KOKKOS_FORCEINLINE_FUNCTION backward (const NT &y) const
 Transform from the physical space to the grid.
 
size_t KOKKOS_FORCEINLINE_FUNCTION size () const
 
device::array< size_t, 1 > KOKKOS_FORCEINLINE_FUNCTION sizes () const
 
std::string to_string () const
 

Public Attributes

const NT start
 
const NT stop
 

Static Public Attributes

static constexpr size_t dim = 1
 

Private Attributes

const size_t grid_extent
 
NT a
 

Friends

template<typename NT2 >
bool operator== (const LinearCoordinates1D< NT > &lhs, const LinearCoordinates1D< NT2 > &rhs)
 

Member Typedef Documentation

◆ ctype

template<typename NT = double>
using DiFfRG::LinearCoordinates1D< NT >::ctype = NT

Constructor & Destructor Documentation

◆ LinearCoordinates1D() [1/2]

template<typename NT = double>
DiFfRG::LinearCoordinates1D< NT >::LinearCoordinates1D ( size_t grid_extent,
double start,
double stop )
inline

◆ LinearCoordinates1D() [2/2]

template<typename NT = double>
template<typename NT2 >
DiFfRG::LinearCoordinates1D< NT >::LinearCoordinates1D ( const LinearCoordinates1D< NT2 > & other)
inline

Member Function Documentation

◆ backward()

template<typename NT = double>
NT KOKKOS_FORCEINLINE_FUNCTION DiFfRG::LinearCoordinates1D< NT >::backward ( const NT & y) const
inline

Transform from the physical space to the grid.

Parameters
yphysical coordinate
Returns
double grid coordinate

◆ forward() [1/2]

template<typename NT = double>
template<typename IT >
device::array< NT, 1 > KOKKOS_FORCEINLINE_FUNCTION DiFfRG::LinearCoordinates1D< NT >::forward ( const device::array< IT, 1 > & x) const
inline

◆ forward() [2/2]

template<typename NT = double>
template<typename IT >
NT KOKKOS_FORCEINLINE_FUNCTION DiFfRG::LinearCoordinates1D< NT >::forward ( const IT & x) const
inline

Transform from the grid to the physical space.

Parameters
xgrid coordinate
Returns
NumberType physical coordinate

◆ from_linear_index()

template<typename NT = double>
device::array< size_t, 1 > KOKKOS_FORCEINLINE_FUNCTION DiFfRG::LinearCoordinates1D< NT >::from_linear_index ( size_t i) const
inline

◆ size()

template<typename NT = double>
size_t KOKKOS_FORCEINLINE_FUNCTION DiFfRG::LinearCoordinates1D< NT >::size ( ) const
inline

◆ sizes()

template<typename NT = double>
device::array< size_t, 1 > KOKKOS_FORCEINLINE_FUNCTION DiFfRG::LinearCoordinates1D< NT >::sizes ( ) const
inline

◆ to_string()

template<typename NT = double>
std::string DiFfRG::LinearCoordinates1D< NT >::to_string ( ) const
inline

Friends And Related Symbol Documentation

◆ operator==

template<typename NT = double>
template<typename NT2 >
bool operator== ( const LinearCoordinates1D< NT > & lhs,
const LinearCoordinates1D< NT2 > & rhs )
friend

Member Data Documentation

◆ a

template<typename NT = double>
NT DiFfRG::LinearCoordinates1D< NT >::a
private

◆ dim

template<typename NT = double>
size_t DiFfRG::LinearCoordinates1D< NT >::dim = 1
staticconstexpr

◆ grid_extent

template<typename NT = double>
const size_t DiFfRG::LinearCoordinates1D< NT >::grid_extent
private

◆ start

template<typename NT = double>
const NT DiFfRG::LinearCoordinates1D< NT >::start

◆ stop

template<typename NT = double>
const NT DiFfRG::LinearCoordinates1D< NT >::stop

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