ImpactX
Public Types | Public Member Functions | Static Public Attributes | Private Attributes | List of all members
impactx::Sol Struct Reference

#include <Sol.H>

Inheritance diagram for impactx::Sol:
impactx::elements::BeamOptic< Sol > impactx::elements::Thick

Public Types

using PType = ImpactXParticleContainer::ParticleType
 

Public Member Functions

 Sol (amrex::ParticleReal const ds, amrex::ParticleReal const ks, int const nslice)
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void operator() (PType &AMREX_RESTRICT p, amrex::ParticleReal &AMREX_RESTRICT px, amrex::ParticleReal &AMREX_RESTRICT py, amrex::ParticleReal &AMREX_RESTRICT pt, RefPart const &refpart) const
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void operator() (RefPart &AMREX_RESTRICT refpart) const
 
- Public Member Functions inherited from impactx::elements::BeamOptic< Sol >
void operator() (ImpactXParticleContainer::iterator &pti, RefPart &AMREX_RESTRICT ref_part)
 
- Public Member Functions inherited from impactx::elements::Thick
 Thick (amrex::ParticleReal const ds, int const nslice)
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int nslice () const
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal ds () const
 

Static Public Attributes

static constexpr auto name = "Sol"
 

Private Attributes

amrex::ParticleReal m_ks
 

Additional Inherited Members

- Protected Attributes inherited from impactx::elements::Thick
amrex::ParticleReal m_ds
 
int m_nslice
 segment length in m More...
 

Member Typedef Documentation

◆ PType

Constructor & Destructor Documentation

◆ Sol()

impactx::Sol::Sol ( amrex::ParticleReal const  ds,
amrex::ParticleReal const  ks,
int const  nslice 
)
inline

An ideal hard-edge Solenoid magnet

Parameters
dsSegment length in m.
ksSolenoid strength in m^(-1) (MADX convention) = (magnetic field Bz in T) / (rigidity in T-m)
nslicenumber of slices used for the application of space charge

Member Function Documentation

◆ operator()() [1/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::Sol::operator() ( PType &AMREX_RESTRICT  p,
amrex::ParticleReal &AMREX_RESTRICT  px,
amrex::ParticleReal &AMREX_RESTRICT  py,
amrex::ParticleReal &AMREX_RESTRICT  pt,
RefPart const &  refpart 
) const
inline

This is a sol functor, so that a variable of this type can be used like a sol function.

Parameters
pParticle AoS data for positions and cpu/id
pxparticle momentum in x
pyparticle momentum in y
ptparticle momentum in t
refpartreference particle

◆ operator()() [2/2]

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::Sol::operator() ( RefPart &AMREX_RESTRICT  refpart) const
inline

This pushes the reference particle.

Parameters
[in,out]refpartreference particle

Member Data Documentation

◆ m_ks

amrex::ParticleReal impactx::Sol::m_ks
private

◆ name

constexpr auto impactx::Sol::name = "Sol"
static

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