IPPL API Reference
Independent Parallel Particle Layer C++ API
Loading...
Searching...
No Matches
ippl::detail::ParticleLayout< T, Dim, PositionProperties > Class Template Reference

Public Types

typedef T value_type
 
typedef std::int64_t index_type
 
typedef Vector< T, Dim > vector_type
 
using particle_position_type = ParticleAttrib< vector_type, PositionProperties... >
 
using position_memory_space = typename particle_position_type::memory_space
 
using position_execution_space = typename particle_position_type::execution_space
 
typedef std::array< BC, 2 *Dim > bc_container_type
 

Public Member Functions

template<class PBase >
void update (PBase &)
 
void setParticleBC (bc_container_type bcs)
 
const bc_container_type & getParticleBC () const
 
void setParticleBC (BC bc)
 
void applyBC (const particle_position_type &R, const NDRegion< T, Dim > &nr)
 

Static Public Attributes

static constexpr unsigned dim = Dim
 

Member Function Documentation

◆ applyBC()

template<typename T , unsigned Dim, typename... Properties>
void ippl::detail::ParticleLayout< T, Dim, Properties >::applyBC ( const particle_position_type R,
const NDRegion< T, Dim > &  nr 
)

Apply the given boundary conditions to the current particle positions.

Parameters
Ris the particle position attribute
nris the particle domain

◆ getParticleBC()

template<typename T , unsigned Dim, typename... PositionProperties>
const bc_container_type & ippl::detail::ParticleLayout< T, Dim, PositionProperties >::getParticleBC ( ) const
inline

Return the current boundary conditions.

◆ setParticleBC() [1/2]

template<typename T , unsigned Dim, typename... PositionProperties>
void ippl::detail::ParticleLayout< T, Dim, PositionProperties >::setParticleBC ( BC  bc)
inline

Use the same boundary condition on each face

Parameters
bcis the boundary condition to apply on all faces

◆ setParticleBC() [2/2]

template<typename T , unsigned Dim, typename... PositionProperties>
void ippl::detail::ParticleLayout< T, Dim, PositionProperties >::setParticleBC ( bc_container_type  bcs)
inline

Copy over the given boundary conditions.

Parameters
bcsare the boundary conditions

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