IPPL (Independent Parallel Particle Layer): ippl::detail::PeriodicBC< T, Dim, ViewType > Struct Template Reference

IPPL (Independent Parallel Particle Layer)

IPPL

Loading...

Searching...

No Matches

#include <ParticleBC.h>

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

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

Public Types
using	value_type = typename ParticleBC<T, Dim, ViewType>::value_type

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

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

Detailed Description

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

Definition at line 60 of file ParticleBC.h.

Member Typedef Documentation

◆ value_type

template<typename T, unsigned Dim, class ViewType>

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

Definition at line 61 of file ParticleBC.h.

Constructor & Destructor Documentation

◆ PeriodicBC() [1/2]

template<typename T, unsigned Dim, class ViewType>

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

default

◆ PeriodicBC() [2/2]

template<typename T, unsigned Dim, class ViewType>

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

inline

Definition at line 69 of file ParticleBC.h.

References Dim, ippl::detail::isUpper(), and ippl::detail::ParticleBC< T, Dim, ViewType >::ParticleBC().

Here is the call graph for this function:

◆ ~PeriodicBC()

template<typename T, unsigned Dim, class ViewType>

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

default

Member Function Documentation

◆ operator()()

template<typename T, unsigned Dim, class ViewType>

KOKKOS_INLINE_FUNCTION void ippl::detail::PeriodicBC< T, Dim, ViewType >::operator() ( const size_t & i ) const

inline

Definition at line 73 of file ParticleBC.h.

References ippl::detail::ParticleBC< T, Dim, ViewType >::dim_m, ippl::detail::ParticleBC< T, Dim, ViewType >::extent_m, ippl::detail::ParticleBC< T, Dim, ViewType >::middle_m, and ippl::detail::ParticleBC< T, Dim, ViewType >::view_m.

Member Data Documentation

◆ dim_m

template<typename T, unsigned Dim, class ViewType>

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

inherited

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()(), ippl::detail::SinkBC< T, Dim, ViewType >::operator()(), and ParticleBC().

◆ extent_m

template<typename T, unsigned Dim, class ViewType>

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

inherited

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 ParticleBC().

◆ isUpper_m

template<typename T, unsigned Dim, class ViewType>

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

inherited

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()(), ippl::detail::SinkBC< T, Dim, ViewType >::operator()(), and ParticleBC().

◆ maxval_m

template<typename T, unsigned Dim, class ViewType>

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

inherited

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 ParticleBC().

◆ middle_m

template<typename T, unsigned Dim, class ViewType>

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

inherited

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 ParticleBC().

◆ minval_m

template<typename T, unsigned Dim, class ViewType>

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

inherited

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 ParticleBC().

◆ view_m

template<typename T, unsigned Dim, class ViewType>

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

inherited

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()(), ippl::detail::SinkBC< T, Dim, ViewType >::operator()(), and ParticleBC().

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

ParticleBC.h