ImpactX
Public Member Functions | Public Attributes | List of all members
impactx::RefPart Struct Reference

#include <ReferenceParticle.H>

Public Member Functions

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 RefPartset_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 RefPartset_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 RefPartset_charge_qe (amrex::ParticleReal const charge_qe)
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal qm_qeeV () const
 

Public Attributes

amrex::ParticleReal s = 0.0
 integrated orbit path length, in meters More...
 
amrex::ParticleReal x = 0.0
 horizontal position x, in meters More...
 
amrex::ParticleReal y = 0.0
 vertical position y, in meters More...
 
amrex::ParticleReal z = 0.0
 longitudinal position z, in meters More...
 
amrex::ParticleReal t = 0.0
 clock time * c in meters More...
 
amrex::ParticleReal px = 0.0
 momentum in x, normalized by mass*c More...
 
amrex::ParticleReal py = 0.0
 momentum in y, normalized by mass*c More...
 
amrex::ParticleReal pz = 0.0
 momentum in z, normalized by mass*c More...
 
amrex::ParticleReal pt = 0.0
 energy, normalized by rest energy More...
 
amrex::ParticleReal mass = 0.0
 reference rest mass, in kg More...
 
amrex::ParticleReal charge = 0.0
 reference charge, in C More...
 
amrex::ParticleReal sedge = 0.0
 value of s at entrance of the current beamline element More...
 
amrex::Array2D< amrex::ParticleReal, 1, 6, 1, 6 > map
 linearized map More...
 

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

◆ 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

Returns
rest mass in MeV/c^2

◆ qm_qeeV()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal impactx::RefPart::qm_qeeV ( ) const
inline

Get reference particle charge to mass ratio

Returns
charge to mass ratio (elementary charge/eV)

◆ 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_qein multiples of the (positive) elementary charge

◆ 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_energyinitial 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
massEparticle rest mass (MeV/c^2)

Member Data Documentation

◆ charge

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

reference charge, in C

◆ map

amrex::Array2D<amrex::ParticleReal, 1, 6, 1, 6> impactx::RefPart::map

linearized map

◆ 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, normalized by mass*c

◆ py

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

momentum in y, normalized by mass*c

◆ pz

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

momentum in z, normalized by mass*c

◆ 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: