#include <ReferenceParticle.H>

Public Member Functions
RefPart	copy () const
void	reset (bool keep_mass=false, bool keep_charge=false)
RefPart &	set_species (std::string const &species_name)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	gamma () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	beta () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	beta_gamma () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	mass_MeV () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE RefPart &	set_mass_MeV (amrex::ParticleReal const massE)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	kin_energy_MeV () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE RefPart &	set_kin_energy_MeV (amrex::ParticleReal const kin_energy)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	rigidity_Tm () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	charge_qe () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE RefPart &	set_charge_qe (amrex::ParticleReal const charge_qe)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	qm_ratio_SI () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE RefPart &	set_gyromagnetic_anomaly (amrex::ParticleReal const gyromagnetic_anomaly_ref)

Public Attributes
amrex::ParticleReal	s = 0.0
	integrated orbit path length, in meters
amrex::ParticleReal	x = 0.0
	horizontal position x, in meters
amrex::ParticleReal	y = 0.0
	vertical position y, in meters
amrex::ParticleReal	z = 0.0
	longitudinal position z, in meters
amrex::ParticleReal	t = 0.0
	clock time * c in meters
amrex::ParticleReal	px = 0.0
	momentum in x divided by mc = beta_xgamma [unitless]
amrex::ParticleReal	py = 0.0
	momentum in y divided by mc = beta_ygamma [unitless]
amrex::ParticleReal	pz = 0.0
	momentum in z divided by mc = beta_zgamma [unitless]
amrex::ParticleReal	pt = 0.0
	energy, normalized by rest energy
amrex::ParticleReal	mass = 0.0
	reference rest mass, in kg
amrex::ParticleReal	charge = 0.0
	reference charge, in C
amrex::ParticleReal	gyromagnetic_anomaly = 0.0
	anomalous magnetic moment [unitless]
amrex::ParticleReal	sedge = 0.0
	value of s at entrance of the current beamline element

Detailed Description

This struct stores the reference particle attributes stored in ImpactXParticleContainer

Member Function Documentation

◆ beta()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal impactx::RefPart::beta ( ) const

inline

Get reference particle relativistic beta

Returns: relativistic beta

◆ beta_gamma()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal impactx::RefPart::beta_gamma ( ) const

inline

Get reference particle beta*gamma

Returns: relativistic beta*gamma

◆ charge_qe()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal impactx::RefPart::charge_qe ( ) const

inline

Get reference particle charge

Returns: charge in multiples of the (positive) elementary charge

◆ copy()

RefPart impactx::RefPart::copy ( ) const

inline

Copy the reference particle

Use this if you want to do an operation that modifies the reference particle, but you want to avoid modifying the particle container that it is assigned to.

◆ gamma()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal impactx::RefPart::gamma ( ) const

inline

Get reference particle relativistic gamma

Returns: relativistic gamma

◆ kin_energy_MeV()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal impactx::RefPart::kin_energy_MeV ( ) const

inline

Get reference particle kinetic energy

Returns: kinetic energy in MeV

◆ mass_MeV()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal impactx::RefPart::mass_MeV ( ) const

inline

Get reference particle rest mass expressed in MeV

Returns: reference particle rest mass * c^2, expressed as an energy (MeV)

◆ qm_ratio_SI()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal impactx::RefPart::qm_ratio_SI ( ) const

inline

Get reference particle charge to mass ratio

Returns: charge to mass ratio (in SI units of C/kg)

◆ reset()

void impactx::RefPart::reset	(	bool	keep_mass = false,
		bool	keep_charge = false )

inline

Reset the reference particle

Parameters

keep_mass	do not reset the reference particle mass
keep_charge	do not reset the reference particle charge

◆ rigidity_Tm()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal impactx::RefPart::rigidity_Tm ( ) const

inline

Get reference particle magnetic rigidity

Returns: magnetic rigidity Brho in T*m

◆ set_charge_qe()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE RefPart & impactx::RefPart::set_charge_qe ( amrex::ParticleReal const charge_qe )

inline

Set reference particle charge

Parameters

charge_qe in multiples of the (positive) elementary charge

◆ set_gyromagnetic_anomaly()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE RefPart & impactx::RefPart::set_gyromagnetic_anomaly ( amrex::ParticleReal const gyromagnetic_anomaly_ref )

inline

Set reference particle anomalous magnetic dipole moment (aka gyromagnetic anomaly).

Parameters

gyromagnetic_anomaly_ref unitless

◆ set_kin_energy_MeV()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE RefPart & impactx::RefPart::set_kin_energy_MeV ( amrex::ParticleReal const kin_energy )

inline

Set reference particle kinetic energy

Parameters

kin_energy initial kinetic energy (MeV)

◆ set_mass_MeV()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE RefPart & impactx::RefPart::set_mass_MeV ( amrex::ParticleReal const massE )

inline

Set reference particle rest mass

Parameters

massE reference particle rest mass * c^2, expressed as an energy (MeV)

◆ set_species()

RefPart & impactx::RefPart::set_species ( std::string const & species_name )

inline

Set reference particle species by name

Sets charge, mass, and gyromagnetic anomaly for a known particle species.

Parameters

species_name particle species name

Returns: reference to this RefPart for chaining

Member Data Documentation

◆ charge

amrex::ParticleReal impactx::RefPart::charge = 0.0

reference charge, in C

◆ gyromagnetic_anomaly

amrex::ParticleReal impactx::RefPart::gyromagnetic_anomaly = 0.0

anomalous magnetic moment [unitless]

◆ mass

amrex::ParticleReal impactx::RefPart::mass = 0.0

reference rest mass, in kg

◆ pt

amrex::ParticleReal impactx::RefPart::pt = 0.0

energy, normalized by rest energy

◆ px

amrex::ParticleReal impactx::RefPart::px = 0.0

momentum in x divided by m*c = beta_x*gamma [unitless]

◆ py

amrex::ParticleReal impactx::RefPart::py = 0.0

momentum in y divided by m*c = beta_y*gamma [unitless]

◆ pz

amrex::ParticleReal impactx::RefPart::pz = 0.0

momentum in z divided by m*c = beta_z*gamma [unitless]

◆ s

amrex::ParticleReal impactx::RefPart::s = 0.0

integrated orbit path length, in meters

◆ sedge

amrex::ParticleReal impactx::RefPart::sedge = 0.0

value of s at entrance of the current beamline element

◆ t

amrex::ParticleReal impactx::RefPart::t = 0.0

clock time * c in meters

◆ x

amrex::ParticleReal impactx::RefPart::x = 0.0

horizontal position x, in meters

◆ y

amrex::ParticleReal impactx::RefPart::y = 0.0

vertical position y, in meters

◆ z

amrex::ParticleReal impactx::RefPart::z = 0.0

longitudinal position z, in meters

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

/home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/latest/src/particles/ReferenceParticle.H

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ beta()

◆ beta_gamma()

◆ charge_qe()

◆ copy()

◆ gamma()

◆ kin_energy_MeV()

◆ mass_MeV()

◆ qm_ratio_SI()

◆ reset()

◆ rigidity_Tm()

◆ set_charge_qe()

◆ set_gyromagnetic_anomaly()

◆ set_kin_energy_MeV()

◆ set_mass_MeV()

◆ set_species()

Member Data Documentation

◆ charge

◆ gyromagnetic_anomaly

◆ mass

◆ pt

◆ px

◆ py

◆ pz

◆ s

◆ sedge

◆ t

◆ x

◆ y

◆ z