Block-Structured AMR Software Framework
amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt > Struct Template Reference

#include <AMReX_ParticleTile.H>

Inheritance diagram for amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >:
amrex::SoAParticleBase

Public Types

using StorageParticleType = SoAParticleBase
 
using ConstPTD = ConstParticleTileData< SoAParticleBase, NArrayReal, NArrayInt >
 
using RealType = ParticleReal
 

Public Member Functions

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE ConstSoAParticle (ConstPTD const &ptd, long i)
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE ConstParticleCPUWrapper cpu () const
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE ConstParticleIDWrapper id () const
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE RealVect pos () const &
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const RealTypepos (int position_index) const &
 

Static Public Member Functions

static Long NextID ()
 
static Long UnprotectedNextID ()
 This version can only be used inside omp critical. More...
 
static void NextID (Long nextid)
 Reset on restart. More...
 

Static Public Attributes

static constexpr int NArrayReal = T_NArrayReal
 
static constexpr int NArrayInt = T_NArrayInt
 
static constexpr bool is_soa_particle = true
 
static constexpr bool is_constsoa_particle = true
 
- Static Public Attributes inherited from amrex::SoAParticleBase
static constexpr int NReal =0
 
static constexpr int NInt =0
 
static constexpr bool is_soa_particle = true
 

Private Attributes

ConstPTD m_constparticle_tile_data
 
int m_index
 

Member Typedef Documentation

◆ ConstPTD

template<int T_NArrayReal, int T_NArrayInt>
using amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::ConstPTD = ConstParticleTileData<SoAParticleBase, NArrayReal, NArrayInt>

◆ RealType

template<int T_NArrayReal, int T_NArrayInt>
using amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::RealType = ParticleReal

◆ StorageParticleType

template<int T_NArrayReal, int T_NArrayInt>
using amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::StorageParticleType = SoAParticleBase

Constructor & Destructor Documentation

◆ ConstSoAParticle()

template<int T_NArrayReal, int T_NArrayInt>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::ConstSoAParticle ( ConstPTD const &  ptd,
long  i 
)
inline

Member Function Documentation

◆ cpu()

template<int T_NArrayReal, int T_NArrayInt>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE ConstParticleCPUWrapper amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::cpu ( ) const
inline

◆ id()

template<int T_NArrayReal, int T_NArrayInt>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE ConstParticleIDWrapper amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::id ( ) const
inline

◆ NextID() [1/2]

template<int T_NArrayReal, int T_NArrayInt>
static Long amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::NextID ( )
static

◆ NextID() [2/2]

template<int T_NArrayReal, int T_NArrayInt>
static void amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::NextID ( Long  nextid)
static

Reset on restart.

Parameters
nextid

◆ pos() [1/2]

template<int T_NArrayReal, int T_NArrayInt>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE RealVect amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::pos ( ) const &
inline

◆ pos() [2/2]

template<int T_NArrayReal, int T_NArrayInt>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const RealType& amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::pos ( int  position_index) const &
inline

◆ UnprotectedNextID()

template<int T_NArrayReal, int T_NArrayInt>
static Long amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::UnprotectedNextID ( )
static

This version can only be used inside omp critical.

Member Data Documentation

◆ is_constsoa_particle

template<int T_NArrayReal, int T_NArrayInt>
constexpr bool amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::is_constsoa_particle = true
staticconstexpr

◆ is_soa_particle

template<int T_NArrayReal, int T_NArrayInt>
constexpr bool amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::is_soa_particle = true
staticconstexpr

◆ m_constparticle_tile_data

template<int T_NArrayReal, int T_NArrayInt>
ConstPTD amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::m_constparticle_tile_data
private

◆ m_index

template<int T_NArrayReal, int T_NArrayInt>
int amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::m_index
private

◆ NArrayInt

template<int T_NArrayReal, int T_NArrayInt>
constexpr int amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::NArrayInt = T_NArrayInt
staticconstexpr

◆ NArrayReal

template<int T_NArrayReal, int T_NArrayInt>
constexpr int amrex::ConstSoAParticle< T_NArrayReal, T_NArrayInt >::NArrayReal = T_NArrayReal
staticconstexpr

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