SpeciesInformation::Impl< Grid1D, MemorySpace > Class Template Reference

Impl object storing attributes in MemorySpace. More...

Public Types
using	discrete_dimension_type = SpeciesInformation
	alias of the discrete dimension

Public Member Functions
template<class OMemorySpace >
	Impl (Impl< Grid1D, OMemorySpace > const &impl)
	Conversion constructor between different memory spaces. More...
	Impl (DFieldMem< index_range_type, MemorySpace > charge, DFieldMem< index_range_type, MemorySpace > mass)
	Main constructor taking all attributes. More...
KOKKOS_FUNCTION discrete_element_type	ielec () const
KOKKOS_FUNCTION double	charge (discrete_element_type const isp) const
KOKKOS_FUNCTION double	mass (discrete_element_type const isp) const
auto	charges () const
auto	masses () const

Detailed Description

template<class Grid1D, class MemorySpace>
class SpeciesInformation::Impl< Grid1D, MemorySpace >

Impl object storing attributes in MemorySpace.

Constructor & Destructor Documentation

Impl() [1/2]

template<class Grid1D , class MemorySpace >

template<class OMemorySpace >

SpeciesInformation::Impl< Grid1D, MemorySpace >::Impl ( Impl< Grid1D, OMemorySpace > const &  impl )

inlineexplicit

Conversion constructor between different memory spaces.

Parameters

[in]

impl

object from OMemorySpace that will be used to initialize this object on MemorySpace

Impl() [2/2]

template<class Grid1D , class MemorySpace >

SpeciesInformation::Impl< Grid1D, MemorySpace >::Impl ( DFieldMem< index_range_type, MemorySpace >  charge, DFieldMem< index_range_type, MemorySpace >  mass  )

inline

Main constructor taking all attributes.

Parameters

[in]	charge	array storing both kinetic and adiabatic charges
[in]	mass	array storing both kinetic and adiabatic masses

Member Function Documentation

ielec()

template<class Grid1D , class MemorySpace >

KOKKOS_FUNCTION discrete_element_type SpeciesInformation::Impl< Grid1D, MemorySpace >::ielec ( ) const

inline

Returns

the discrete element representing the electron species

charge()

template<class Grid1D , class MemorySpace >

KOKKOS_FUNCTION double SpeciesInformation::Impl< Grid1D, MemorySpace >::charge ( discrete_element_type const  isp ) const

inline

Parameters

[in]

isp

a discrete element of either a kinetic or adiabatic species

Returns

the charge associated to the discrete element

mass()

template<class Grid1D , class MemorySpace >

KOKKOS_FUNCTION double SpeciesInformation::Impl< Grid1D, MemorySpace >::mass ( discrete_element_type const  isp ) const

inline

Parameters

[in]

isp

a discrete element of either a kinetic or adiabatic species

Returns

the mass associated to the discrete element

charges()

template<class Grid1D , class MemorySpace >

auto SpeciesInformation::Impl< Grid1D, MemorySpace >::charges ( ) const

inline

Returns

kinetic and adiabatic charges array

masses()

template<class Grid1D , class MemorySpace >

auto SpeciesInformation::Impl< Grid1D, MemorySpace >::masses ( ) const

inline

Returns

kinetic and adiabatic masses array

---

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

• /home/runner/work/gyselalibxx/gyselalibxx/code_branch/src/speciesinfo/species_info.hpp