impactx Namespace Reference

Namespaces
	detail
	diagnostics
	distribution
	elements
	initialization
	integrators
	madx_to_impactx
	MADXParser
	RFCavityData
	SoftQuadrupoleData
	SoftSolenoidData
	spacecharge
	transformation

Classes
class	ImpactX
struct	ChrDrift
struct	ChrQuad
struct	ChrAcc
struct	ConstF
struct	DipEdge
struct	Drift
struct	ExactDrift
struct	Multipole
struct	None
struct	NonlinearLens
struct	Programmable
struct	PRot
struct	Quad
struct	RF_field_data
struct	RFCavity
struct	Sbend
struct	ShortRF
struct	Quad_field_data
struct	SoftQuadrupole
struct	Sol_field_data
struct	SoftSolenoid
struct	Sol
struct	RealAoS
struct	RealSoA
struct	IntSoA
class	ParIter
class	ParConstIter
class	ImpactXParticleContainer
struct	RefPart
struct	Config

Typedefs
using	KnownElements = std::variant< None, ChrAcc, ChrDrift, ChrQuad, ConstF, diagnostics::BeamMonitor, DipEdge, Drift, ExactDrift, Multipole, NonlinearLens, Programmable, PRot, Quad, RFCavity, Sbend, ShortRF, SoftSolenoid, SoftQuadrupole, Sol >

Functions
void	read_element (std::string element_name, std::list< KnownElements > &m_lattice, int nslice_default, int mapsteps_default)
bool	do_omp_dynamic ()
void	Push (ImpactXParticleContainer &pc, KnownElements &element_variant, int step)
template<typename T_Element >
void	push_all (ImpactXParticleContainer &pc, T_Element &element, [[maybe_unused]] int step, [[maybe_unused]] bool omp_parallel=true)

Variables
	pwd = __file__.rsplit(os.sep, 1)[0] + os.sep
	paths = os.environ.get("PATH", "")
	__version__ = cxx.__version__
	__doc__ = cxx.__doc__
	__license__ = cxx.__license__
	__author__ = cxx.__author__
	load_file
	self
	madx_file
	nslice

Typedef Documentation

KnownElements

using impactx::KnownElements = typedef std::variant< None, ChrAcc, ChrDrift, ChrQuad, ConstF, diagnostics::BeamMonitor, DipEdge, Drift, ExactDrift, Multipole, NonlinearLens, Programmable, PRot, Quad, RFCavity, Sbend, ShortRF, SoftSolenoid, SoftQuadrupole, Sol >

Function Documentation

do_omp_dynamic()

bool impactx::do_omp_dynamic

(

)

Push()

void impactx::Push	(	ImpactXParticleContainer &	pc,
		KnownElements &	element_variant,
		int	step
	)

Push particles

Parameters

[in,out]	pc	container of the particles to push
[in,out]	element_variant	a single element to push the particles through
[in]	step	global step for diagnostics

push_all()

template<typename T_Element >

void impactx::push_all	(	ImpactXParticleContainer &	pc,
		T_Element &	element,
		[[maybe_unused] ] int	step,
		[[maybe_unused] ] bool	omp_parallel = true
	)

Push all particles in a particle container.

This element pushes first the reference particle, then all other particles. All particles are pushed independently with the same logic. Particles are relative to the reference particle.

Parameters

[in,out]	pc	particle container to push
[in,out]	element	the beamline element
[in]	step	global step for diagnostics
[in]	omp_parallel	allow threading via OpenMP for the particle iterator loop (note: if OMP backend is active)

read_element()

void impactx::read_element	(	std::string	element_name,
		std::list< KnownElements > &	m_lattice,
		int	nslice_default,
		int	mapsteps_default
	)

Read a lattice element

Read a lattice element from amrex::ParmParse, initialize it and append it to m_lattice.

Parameters

[in]	element_name	element name
[in,out]	m_lattice	the accelerator lattice
[in]	nslice_default
[in]	mapsteps_default

Variable Documentation

__author__

impactx.__author__ = cxx.__author__

private

__doc__

impactx.__doc__ = cxx.__doc__

private

__license__

impactx.__license__ = cxx.__license__

private

__version__

impactx.__version__ = cxx.__version__

private

load_file

impactx.load_file

madx_file

impactx.madx_file

nslice

impactx.nslice

paths

impactx.paths = os.environ.get("PATH", "")

pwd

impactx.pwd = __file__.rsplit(os.sep, 1)[0] + os.sep

self

impactx.self