#include <SoftSol.H>

Inheritance diagram for impactx::elements::SoftSolenoid:

Public Types
using	PType = ImpactXParticleContainer::ParticleType
using	DynamicData = mixin::GPUDataRegistry<SolenoidFourierCoefficients>

Public Member Functions
	SoftSolenoid (amrex::ParticleReal ds, amrex::ParticleReal bscale, std::vector< amrex::ParticleReal > cos_coef, std::vector< amrex::ParticleReal > sin_coef, int unit=DEFAULT_unit, amrex::ParticleReal dx=DEFAULT_dx, amrex::ParticleReal dy=DEFAULT_dy, amrex::ParticleReal rotation_degree=DEFAULT_rotation_degree, amrex::ParticleReal aperture_x=DEFAULT_aperture_x, amrex::ParticleReal aperture_y=DEFAULT_aperture_y, int mapsteps=DEFAULT_mapsteps, int nslice=DEFAULT_nslice, std::optional< std::string > name=DEFAULT_name)
void	reverse ()
void	compute_constants (RefPart const &refpart)
template<typename T_Real = amrex::ParticleReal, typename T_IdCpu = uint64_t>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	operator() (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_Real &AMREX_RESTRICT t, T_Real &AMREX_RESTRICT px, T_Real &AMREX_RESTRICT py, T_Real &AMREX_RESTRICT pt, T_IdCpu const &AMREX_RESTRICT idcpu, RefPart const &AMREX_RESTRICT refpart) const
AMREX_GPU_HOST AMREX_FORCE_INLINE void	operator() (RefPart &AMREX_RESTRICT refpart) const
template<typename T_Real = amrex::ParticleReal, typename T_IdCpu = uint64_t>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	spin_and_phasespace_push (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_Real &AMREX_RESTRICT t, T_Real &AMREX_RESTRICT px, T_Real &AMREX_RESTRICT py, T_Real &AMREX_RESTRICT pt, T_Real &AMREX_RESTRICT sx, T_Real &AMREX_RESTRICT sy, T_Real &AMREX_RESTRICT sz, 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
std::tuple< amrex::ParticleReal, amrex::ParticleReal, amrex::ParticleReal > AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE	Sol_Bfield (amrex::ParticleReal const zeval) const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	map1 (amrex::ParticleReal const tau, RefPart &refpart, amrex::ParticleReal &zeval) const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	map2 (amrex::ParticleReal const tau, RefPart &refpart, amrex::ParticleReal &zeval) const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	map3 (amrex::ParticleReal const tau, RefPart &refpart, amrex::ParticleReal &zeval) 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::BeamOptic< SoftSolenoid >
void	operator() (ImpactXParticleContainer &pc, int step, int period)
Public Member Functions inherited from impactx::elements::mixin::LinearTransport< SoftSolenoid >
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::Thick
	Thick (amrex::ParticleReal ds, int nslice)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int	nslice () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	ds () const
void	reverse ()
Public Member Functions inherited from impactx::elements::mixin::Alignment
	Alignment (amrex::ParticleReal dx, amrex::ParticleReal dy, amrex::ParticleReal rotation_degree)
	Alignment ()=default
	Alignment (Alignment const &)=default
Alignment &	operator= (Alignment const &)=default
	Alignment (Alignment &&)=default
Alignment &	operator= (Alignment &&rhs)=default
	~Alignment ()=default
void	compute_constants (RefPart const &refpart)
template<typename T_Real>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	shift_in (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_Real &AMREX_RESTRICT px, T_Real &AMREX_RESTRICT py) const
template<typename T_Real>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	rotate_in (T_Real &AMREX_RESTRICT sx, T_Real &AMREX_RESTRICT sy) const
template<typename T_Real>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	shift_out (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_Real &AMREX_RESTRICT px, T_Real &AMREX_RESTRICT py) const
template<typename T_Real>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	rotate_out (T_Real &AMREX_RESTRICT sx, T_Real &AMREX_RESTRICT sy) const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	dx () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	dy () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	rotation () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool	misaligned () const
AMREX_GPU_HOST AMREX_FORCE_INLINE Map6x6	rotation_map () const
AMREX_GPU_HOST AMREX_FORCE_INLINE Map6x6	rotate_aligned_map (Map6x6 const &R) const
Public Member Functions inherited from impactx::elements::mixin::NoFinalize
void	finalize ()
Public Member Functions inherited from impactx::elements::mixin::PipeAperture
	PipeAperture (amrex::ParticleReal aperture_x, amrex::ParticleReal aperture_y)
	PipeAperture ()=default
	PipeAperture (PipeAperture const &)=default
PipeAperture &	operator= (PipeAperture const &)=default
	PipeAperture (PipeAperture &&)=default
PipeAperture &	operator= (PipeAperture &&rhs)=default
	~PipeAperture ()=default
template<typename T_Real = amrex::ParticleReal, typename T_IdCpu = uint64_t>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	apply_aperture (T_Real &AMREX_RESTRICT x, T_Real &AMREX_RESTRICT y, T_IdCpu &AMREX_RESTRICT idcpu) const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	aperture_x () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::ParticleReal	aperture_y () const
Public Member Functions inherited from impactx::elements::mixin::SpinTransport
template<typename T_Real = amrex::ParticleReal>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	rotate_spin (T_Real const &AMREX_RESTRICT lambdax, T_Real const &AMREX_RESTRICT lambday, T_Real const &AMREX_RESTRICT lambdaz, T_Real &AMREX_RESTRICT sx, T_Real &AMREX_RESTRICT sy, T_Real &AMREX_RESTRICT sz) const
template<typename T_Real = amrex::ParticleReal>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void	tbmt_precession_vector (T_Real const &AMREX_RESTRICT x, T_Real const &AMREX_RESTRICT ux, T_Real const &AMREX_RESTRICT uy, T_Real const &AMREX_RESTRICT uz, T_Real const &AMREX_RESTRICT gamma, amrex::ParticleReal const &AMREX_RESTRICT h, amrex::ParticleReal const &AMREX_RESTRICT gyro_anomaly, T_Real const &AMREX_RESTRICT Bx, T_Real const &AMREX_RESTRICT By, T_Real const &AMREX_RESTRICT Bz, T_Real const &AMREX_RESTRICT Ex, T_Real const &AMREX_RESTRICT Ey, T_Real const &AMREX_RESTRICT Ez, T_Real &AMREX_RESTRICT Omegax, T_Real &AMREX_RESTRICT Omegay, T_Real &AMREX_RESTRICT Omegaz) const

Public Attributes
amrex::ParticleReal	m_bscale
int	m_unit
	scaling factor for solenoid Bz field
int	m_mapsteps
	unit specification for quad strength
int	m_id
	number of map integration steps per slice
int	m_ncoef = 0
	unique soft solenoid id used for data lookup map
amrex::ParticleReal const *	m_cos_h_data = nullptr
	number of Fourier coefficients
amrex::ParticleReal const *	m_sin_h_data = nullptr
	non-owning pointer to host cosine coefficients
amrex::ParticleReal const *	m_cos_d_data = nullptr
	non-owning pointer to host sine coefficients
amrex::ParticleReal const *	m_sin_d_data = nullptr
	non-owning pointer to device cosine coefficients
amrex::SmallMatrix< amrex::ParticleReal, 6, 6, amrex::Order::F, 1 >	m_map {}
	non-owning pointer to device sine coefficients
amrex::SmallMatrix< amrex::ParticleReal, 3, 6, amrex::Order::F, 1 >	m_spin_coupling {}
	linearized map
amrex::SmallMatrix< amrex::ParticleReal, 3, 1, amrex::Order::F, 1 >	m_spin_rotation_vector {}
	linearized spin-orbit coupling matrix
Public Attributes inherited from impactx::elements::mixin::Thick
amrex::ParticleReal	m_ds
int	m_nslice
	segment length in m
Public Attributes inherited from impactx::elements::mixin::Alignment
amrex::ParticleReal	m_dx = 0
amrex::ParticleReal	m_dy = 0
	horizontal translation error [m]
amrex::ParticleReal	m_rotation = 0
	vertical translation error [m]
Public Attributes inherited from impactx::elements::mixin::PipeAperture
amrex::ParticleReal	m_inv_aperture_x = 0
amrex::ParticleReal	m_inv_aperture_y = 0
	inverse of the horizontal aperture size [1/m]

Static Public Attributes
static constexpr auto	type = "SoftSolenoid"
static constexpr int	DEFAULT_unit = 0
static constexpr int	DEFAULT_mapsteps = 10
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< SoftSolenoid >
static constexpr bool	has_linear_transport
Static Public Attributes inherited from impactx::elements::mixin::Thick
static constexpr int	DEFAULT_nslice = 1
Static Public Attributes inherited from impactx::elements::mixin::Alignment
static constexpr amrex::ParticleReal	degree2rad
static constexpr amrex::ParticleReal	DEFAULT_dx = 0
static constexpr amrex::ParticleReal	DEFAULT_dy = 0
static constexpr amrex::ParticleReal	DEFAULT_rotation_degree = 0
Static Public Attributes inherited from impactx::elements::mixin::PipeAperture
static constexpr amrex::ParticleReal	DEFAULT_aperture_x = 0
static constexpr amrex::ParticleReal	DEFAULT_aperture_y = 0
Static Public Attributes inherited from amrex::simd::Vectorized< amrex::simd::native_simd_size_particlereal >
static constexpr int	simd_width

Member Typedef Documentation

◆ DynamicData

using impactx::elements::SoftSolenoid::DynamicData = mixin::GPUDataRegistry<SolenoidFourierCoefficients>

◆ PType

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

Constructor & Destructor Documentation

◆ SoftSolenoid()

impactx::elements::SoftSolenoid::SoftSolenoid	(	amrex::ParticleReal	ds,
		amrex::ParticleReal	bscale,
		std::vector< amrex::ParticleReal >	cos_coef,
		std::vector< amrex::ParticleReal >	sin_coef,
		int	unit = DEFAULT_unit,
		amrex::ParticleReal	dx = DEFAULT_dx,
		amrex::ParticleReal	dy = DEFAULT_dy,
		amrex::ParticleReal	rotation_degree = DEFAULT_rotation_degree,
		amrex::ParticleReal	aperture_x = DEFAULT_aperture_x,
		amrex::ParticleReal	aperture_y = DEFAULT_aperture_y,
		int	mapsteps = DEFAULT_mapsteps,
		int	nslice = DEFAULT_nslice,
		std::optional< std::string >	name = DEFAULT_name )

inline

A soft-edge solenoid

Parameters

ds	Segment length in m
bscale	Scaling factor for on-axis longitudinal magnetic field in 1/m (MAD-X convention) = (Bz in T) / (rigidity in T-m) OR Magnetic field Bz in T (SI units)
cos_coef	cosine coefficients in Fourier expansion of on-axis magnetic field Bz
sin_coef	sine coefficients in Fourier expansion of on-axis magnetic field Bz
unit	Unit specification unit = 0 MADX convention (default) unit = 1 SI units
dx	horizontal translation error in m
dy	vertical translation error in m
rotation_degree	rotation error in the transverse plane [degrees]
aperture_x	horizontal half-aperture in m
aperture_y	vertical half-aperture in m
mapsteps	number of integration steps per slice used for map and reference particle push in applied fields
nslice	number of slices used for the application of space charge
name	a user defined and not necessarily unique name of the element

Member Function Documentation

◆ compute_constants()

void impactx::elements::SoftSolenoid::compute_constants ( RefPart const & refpart )

inline

Compute and cache the constants for the push.

In particular, used to pre-compute and cache variables that are independent of the individually tracked particle.

Parameters

refpart reference particle

◆ map1()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::SoftSolenoid::map1	(	amrex::ParticleReal const	tau,
		RefPart &	refpart,
		amrex::ParticleReal &	zeval ) const

inline

This pushes the reference particle and the linear map matrix elements for a solenoid through the symplectic map associated with H_3 in the Hamiltonian splitting H = H_1 + H_2 + H_3.

Parameters

	tau	Map step size in m
[in,out]	refpart	reference particle
[in,out]	zeval	Longitudinal on-axis location in m

◆ map2()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::SoftSolenoid::map2	(	amrex::ParticleReal const	tau,
		RefPart &	refpart,
		amrex::ParticleReal &	zeval ) const

inline

This pushes the reference particle and the linear map matrix elements for a solenoid through the symplectic map associated with H_2 in the Hamiltonian splitting H = H_1 + H_2 + H_3.

Parameters

	tau	Map step size in m
[in,out]	refpart	reference particle
[in,out]	zeval	Longitudinal on-axis location in m

◆ map3()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::SoftSolenoid::map3	(	amrex::ParticleReal const	tau,
		RefPart &	refpart,
		amrex::ParticleReal &	zeval ) const

inline

This pushes the reference particle and the linear map matrix elements for a solenoid through the symplectic map associated with H_1 in the Hamiltonian splitting H = H_1 + H_2 + H_3.

Parameters

	tau	Map step size in m
[in,out]	refpart	reference particle
[in,out]	zeval	Longitudinal on-axis location in m

◆ operator()() [1/2]

AMREX_GPU_HOST AMREX_FORCE_INLINE void impactx::elements::SoftSolenoid::operator() ( RefPart &AMREX_RESTRICT refpart ) const

inline

This pushes the reference particle.

Parameters

[in,out] refpart reference particle

◆ operator()() [2/2]

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

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

inline

This is a soft-edge solenoid functor, so that a variable of this type can be used like a soft-edge solenoid function.

The

See also: compute_constants method must be called before pushing particles through this operator.

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
refpart	reference particle

◆ reverse()

void impactx::elements::SoftSolenoid::reverse ( )

inline

Reverse the element (negate ds)

◆ Sol_Bfield()

std::tuple< amrex::ParticleReal, amrex::ParticleReal, amrex::ParticleReal > AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE impactx::elements::SoftSolenoid::Sol_Bfield ( amrex::ParticleReal const zeval ) const

inline

This evaluates the on-axis magnetic field Bz at a fixed location z, together with certain required integrals and derivatives. The field returned is normalized to a peak value of 1.

Parameters

zeval Longitudinal on-axis location in m

◆ spin_and_phasespace_push()

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

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::elements::SoftSolenoid::spin_and_phasespace_push	(	T_Real &AMREX_RESTRICT	x,
		T_Real &AMREX_RESTRICT	y,
		T_Real &AMREX_RESTRICT	t,
		T_Real &AMREX_RESTRICT	px,
		T_Real &AMREX_RESTRICT	py,
		T_Real &AMREX_RESTRICT	pt,
		T_Real &AMREX_RESTRICT	sx,
		T_Real &AMREX_RESTRICT	sy,
		T_Real &AMREX_RESTRICT	sz,
		T_IdCpu const &AMREX_RESTRICT	idcpu,
		RefPart const &AMREX_RESTRICT	refpart ) const

inline

This operator pushes the particle spin.

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
sx	particle spin x-component
sy	particle spin y-component
sz	particle spin z-component
idcpu	particle global index
refpart	reference particle

◆ transport_map()

AMREX_GPU_HOST AMREX_FORCE_INLINE Map6x6 impactx::elements::SoftSolenoid::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

◆ DEFAULT_mapsteps

int impactx::elements::SoftSolenoid::DEFAULT_mapsteps = 10

staticconstexpr

◆ DEFAULT_unit

int impactx::elements::SoftSolenoid::DEFAULT_unit = 0

staticconstexpr

◆ m_bscale

amrex::ParticleReal impactx::elements::SoftSolenoid::m_bscale

◆ m_cos_d_data

amrex::ParticleReal const* impactx::elements::SoftSolenoid::m_cos_d_data = nullptr

non-owning pointer to host sine coefficients

◆ m_cos_h_data

amrex::ParticleReal const* impactx::elements::SoftSolenoid::m_cos_h_data = nullptr

number of Fourier coefficients

◆ m_id

int impactx::elements::SoftSolenoid::m_id

number of map integration steps per slice

◆ m_map

amrex::SmallMatrix<amrex::ParticleReal, 6, 6, amrex::Order::F, 1> impactx::elements::SoftSolenoid::m_map {}

mutable

non-owning pointer to device sine coefficients

◆ m_mapsteps

int impactx::elements::SoftSolenoid::m_mapsteps

unit specification for quad strength

◆ m_ncoef

int impactx::elements::SoftSolenoid::m_ncoef = 0

unique soft solenoid id used for data lookup map

◆ m_sin_d_data

amrex::ParticleReal const* impactx::elements::SoftSolenoid::m_sin_d_data = nullptr

non-owning pointer to device cosine coefficients

◆ m_sin_h_data

amrex::ParticleReal const* impactx::elements::SoftSolenoid::m_sin_h_data = nullptr

non-owning pointer to host cosine coefficients

◆ m_spin_coupling

amrex::SmallMatrix<amrex::ParticleReal, 3, 6, amrex::Order::F, 1> impactx::elements::SoftSolenoid::m_spin_coupling {}

mutable

linearized map

◆ m_spin_rotation_vector

amrex::SmallMatrix<amrex::ParticleReal, 3, 1, amrex::Order::F, 1> impactx::elements::SoftSolenoid::m_spin_rotation_vector {}

mutable

linearized spin-orbit coupling matrix

◆ m_unit

int impactx::elements::SoftSolenoid::m_unit

scaling factor for solenoid Bz field

◆ type

auto impactx::elements::SoftSolenoid::type = "SoftSolenoid"

staticconstexpr

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

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Member Typedef Documentation

◆ DynamicData

◆ PType

Constructor & Destructor Documentation

◆ SoftSolenoid()

Member Function Documentation

◆ compute_constants()

◆ map1()

◆ map2()

◆ map3()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ reverse()

◆ Sol_Bfield()

◆ spin_and_phasespace_push()

◆ transport_map()

Member Data Documentation

◆ DEFAULT_mapsteps

◆ DEFAULT_unit

◆ m_bscale

◆ m_cos_d_data

◆ m_cos_h_data

◆ m_id

◆ m_map

◆ m_mapsteps

◆ m_ncoef

◆ m_sin_d_data

◆ m_sin_h_data

◆ m_spin_coupling

◆ m_spin_rotation_vector

◆ m_unit

◆ type