ippl::detail::ParticleBC< T, Dim, ViewType > Struct Template Reference

#include <ParticleBC.h>

Inheritance diagram for ippl::detail::ParticleBC< T, Dim, ViewType >:

Collaboration diagram for ippl::detail::ParticleBC< T, Dim, ViewType >:

Public Types
using	value_type = typename ViewType::value_type::value_type

Public Member Functions
KOKKOS_DEFAULTED_FUNCTION	ParticleBC ()=default
KOKKOS_INLINE_FUNCTION	ParticleBC (const ViewType &view, const NDRegion< T, Dim > &nr, const unsigned &dim, const bool &isUpper)
KOKKOS_DEFAULTED_FUNCTION	~ParticleBC ()=default

Public Attributes
ViewType	view_m
	Kokkos view containing the field data. More...
size_t	dim_m
	The dimension along which this boundary condition. More...
double	minval_m
	Minimum and maximum coordinates of the domain along the given dimension. More...
double	maxval_m
bool	isUpper_m
	Whether the boundary conditions are being applied for an upper. More...
double	extent_m
	The length of the domain along the given dimension. More...
double	middle_m
	The coordinate of the midpoint of the domain along the given dimension. More...

Detailed Description

template<typename T, unsigned Dim, class ViewType>
struct ippl::detail::ParticleBC< T, Dim, ViewType >

Definition at line 21 of file ParticleBC.h.

Member Typedef Documentation

value_type

template<typename T , unsigned Dim, class ViewType >

using ippl::detail::ParticleBC< T, Dim, ViewType >::value_type = typename ViewType::value_type::value_type

Definition at line 22 of file ParticleBC.h.

Constructor & Destructor Documentation

ParticleBC() [1/2]

template<typename T , unsigned Dim, class ViewType >

KOKKOS_DEFAULTED_FUNCTION ippl::detail::ParticleBC< T, Dim, ViewType >::ParticleBC ( )

default

ParticleBC() [2/2]

template<typename T , unsigned Dim, class ViewType >

KOKKOS_INLINE_FUNCTION ippl::detail::ParticleBC< T, Dim, ViewType >::ParticleBC ( const ViewType &  view, const NDRegion< T, Dim > &  nr, const unsigned &  dim, const bool &  isUpper  )

inline

Definition at line 44 of file ParticleBC.h.

References ippl::detail::ParticleBC< T, Dim, ViewType >::extent_m, ippl::detail::ParticleBC< T, Dim, ViewType >::maxval_m, ippl::detail::ParticleBC< T, Dim, ViewType >::middle_m, ippl::detail::ParticleBC< T, Dim, ViewType >::minval_m, and nr.

~ParticleBC()

template<typename T , unsigned Dim, class ViewType >

KOKKOS_DEFAULTED_FUNCTION ippl::detail::ParticleBC< T, Dim, ViewType >::~ParticleBC ( )

default

Member Data Documentation

dim_m

template<typename T , unsigned Dim, class ViewType >

size_t ippl::detail::ParticleBC< T, Dim, ViewType >::dim_m

The dimension along which this boundary condition.

Definition at line 28 of file ParticleBC.h.

Referenced by ippl::detail::PeriodicBC< T, Dim, ViewType >::operator()(), ippl::detail::ReflectiveBC< T, Dim, ViewType >::operator()(), and ippl::detail::SinkBC< T, Dim, ViewType >::operator()().

extent_m

template<typename T , unsigned Dim, class ViewType >

double ippl::detail::ParticleBC< T, Dim, ViewType >::extent_m

The length of the domain along the given dimension.

Definition at line 37 of file ParticleBC.h.

Referenced by ippl::detail::PeriodicBC< T, Dim, ViewType >::operator()(), and ippl::detail::ParticleBC< T, Dim, ViewType >::ParticleBC().

isUpper_m

template<typename T , unsigned Dim, class ViewType >

bool ippl::detail::ParticleBC< T, Dim, ViewType >::isUpper_m

Whether the boundary conditions are being applied for an upper.

Definition at line 34 of file ParticleBC.h.

Referenced by ippl::detail::ReflectiveBC< T, Dim, ViewType >::operator()(), and ippl::detail::SinkBC< T, Dim, ViewType >::operator()().

maxval_m

template<typename T , unsigned Dim, class ViewType >

double ippl::detail::ParticleBC< T, Dim, ViewType >::maxval_m

Definition at line 31 of file ParticleBC.h.

Referenced by ippl::detail::ReflectiveBC< T, Dim, ViewType >::operator()(), ippl::detail::SinkBC< T, Dim, ViewType >::operator()(), and ippl::detail::ParticleBC< T, Dim, ViewType >::ParticleBC().

middle_m

template<typename T , unsigned Dim, class ViewType >

double ippl::detail::ParticleBC< T, Dim, ViewType >::middle_m

The coordinate of the midpoint of the domain along the given dimension.

Definition at line 39 of file ParticleBC.h.

Referenced by ippl::detail::PeriodicBC< T, Dim, ViewType >::operator()(), and ippl::detail::ParticleBC< T, Dim, ViewType >::ParticleBC().

minval_m

template<typename T , unsigned Dim, class ViewType >

double ippl::detail::ParticleBC< T, Dim, ViewType >::minval_m

Minimum and maximum coordinates of the domain along the given dimension.

Definition at line 30 of file ParticleBC.h.

Referenced by ippl::detail::ReflectiveBC< T, Dim, ViewType >::operator()(), ippl::detail::SinkBC< T, Dim, ViewType >::operator()(), and ippl::detail::ParticleBC< T, Dim, ViewType >::ParticleBC().

view_m

template<typename T , unsigned Dim, class ViewType >

ViewType ippl::detail::ParticleBC< T, Dim, ViewType >::view_m

Kokkos view containing the field data.

Definition at line 25 of file ParticleBC.h.

Referenced by ippl::detail::PeriodicBC< T, Dim, ViewType >::operator()(), ippl::detail::ReflectiveBC< T, Dim, ViewType >::operator()(), and ippl::detail::SinkBC< T, Dim, ViewType >::operator()().

---

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

• ParticleBC.h