impactx::elements::Marker Struct Reference

#include <Marker.H>

Inheritance diagram for impactx::elements::Marker:

Public Types
using	PType = ImpactXParticleContainer::ParticleType

Public Member Functions
	Marker (std::string name)
void	reverse ()
void	operator() (ImpactXParticleContainer &, int, int)
void	compute_constants (RefPart const &)
void	operator() (ImpactXParticleContainer::iterator &, RefPart &AMREX_RESTRICT)
template<typename T_Real = amrex::ParticleReal, typename T_IdCpu = uint64_t>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	operator() (T_Real const &AMREX_RESTRICT x, T_Real const &AMREX_RESTRICT y, T_Real const &AMREX_RESTRICT t, T_Real const &AMREX_RESTRICT px, T_Real const &AMREX_RESTRICT py, T_Real const &AMREX_RESTRICT pt, T_IdCpu const &AMREX_RESTRICT idcpu, RefPart const &AMREX_RESTRICT refpart) const
AMREX_GPU_HOST AMREX_FORCE_INLINE Map6x6	transport_map (RefPart const &AMREX_RESTRICT refpart) const
Public Member Functions inherited from impactx::elements::mixin::Named
AMREX_GPU_HOST void	set_name (std::string const &new_name)
AMREX_GPU_HOST	Named (std::optional< std::string > name)
AMREX_GPU_HOST_DEVICE	~Named ()
AMREX_GPU_HOST	Named (Named const &other)
AMREX_GPU_HOST Named &	operator= (Named const &other)
AMREX_GPU_HOST_DEVICE	Named (Named &&other) noexcept
AMREX_GPU_HOST_DEVICE Named &	operator= (Named &&other) noexcept
AMREX_FORCE_INLINE std::string	name () const
AMREX_FORCE_INLINE bool	has_name () const
Public Member Functions inherited from impactx::elements::mixin::LinearTransport< Marker >
AMREX_GPU_HOST AMREX_FORCE_INLINE void	operator() (Map6x6 &AMREX_RESTRICT cm, RefPart const &AMREX_RESTRICT ref) const
Public Member Functions inherited from impactx::elements::mixin::Thin
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	operator() (RefPart &AMREX_RESTRICT refpart) const
void	reverse ()
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int	nslice () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	ds () const
Public Member Functions inherited from impactx::elements::mixin::NoFinalize
void	finalize ()

Static Public Attributes
static constexpr auto	type = "Marker"
Static Public Attributes inherited from impactx::elements::mixin::Named
static constexpr std::nullopt_t	DEFAULT_name = std::nullopt
Static Public Attributes inherited from impactx::elements::mixin::LinearTransport< Marker >
static constexpr bool	has_linear_transport
Static Public Attributes inherited from amrex::simd::Vectorized< amrex::simd::native_simd_size_particlereal >
static constexpr int	simd_width

Member Typedef Documentation

PType

using impactx::elements::Marker::PType = ImpactXParticleContainer::ParticleType

Constructor & Destructor Documentation

Marker()

impactx::elements::Marker::Marker ( std::string name )

inline

This named element does nothing.

Parameters

name	a user defined and not necessarily unique name of the element

Member Function Documentation

compute_constants()

void impactx::elements::Marker::compute_constants ( RefPart const & )

inline

Compute and cache the constants for the push - nothing to do here

operator()() [1/3]

void impactx::elements::Marker::operator() ( ImpactXParticleContainer & , int , int  )

inline

Push all particles - nothing to do here

operator()() [2/3]

void impactx::elements::Marker::operator() ( ImpactXParticleContainer::iterator & , RefPart & AMREX_RESTRICT )

inline

Push all particles - nothing to do here

operator()() [3/3]

template<typename T_Real = amrex::ParticleReal, typename T_IdCpu = uint64_t>

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::Marker::operator() ( T_Real const &AMREX_RESTRICT x, T_Real const &AMREX_RESTRICT y, T_Real const &AMREX_RESTRICT t, T_Real const &AMREX_RESTRICT px, T_Real const &AMREX_RESTRICT py, T_Real const &AMREX_RESTRICT pt, T_IdCpu const &AMREX_RESTRICT idcpu, RefPart const &AMREX_RESTRICT refpart ) const

inline

Does nothing to a particle.

Parameters

x	particle position in x
y	particle position in y
t	particle position in t
px	particle momentum in x
py	particle momentum in y
pt	particle momentum in t
idcpu	particle global index (unused)
refpart	reference particle

reverse()

void impactx::elements::Marker::reverse ( )

inline

Reverse the element (no-op)

transport_map()

AMREX_GPU_HOST AMREX_FORCE_INLINE Map6x6 impactx::elements::Marker::transport_map ( RefPart const &AMREX_RESTRICT refpart ) const

inline

This function returns the linear transport map.

Parameters

[in]

refpart

reference particle

Returns

6x6 transport matrix

Member Data Documentation

type

auto impactx::elements::Marker::type = "Marker"

staticconstexpr

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/latest/src/elements/Marker.H