impactx::envelope::spacecharge Namespace Reference

Functions
amrex::ParticleReal	Elliptic_RD (amrex::ParticleReal x, amrex::ParticleReal y, amrex::ParticleReal z, amrex::ParticleReal errtol)
void	space_charge2D_push (RefPart const &AMREX_RESTRICT refpart, Map6x6 &AMREX_RESTRICT cm, amrex::ParticleReal current, amrex::ParticleReal ds)
void	space_charge3D_push (RefPart const &AMREX_RESTRICT refpart, Map6x6 &AMREX_RESTRICT cm, amrex::ParticleReal bunch_charge, amrex::ParticleReal ds)

Function Documentation

Elliptic_RD()

amrex::ParticleReal impactx::envelope::spacecharge::Elliptic_RD	(	amrex::ParticleReal	x,
		amrex::ParticleReal	y,
		amrex::ParticleReal	z,
		amrex::ParticleReal	errtol )

Function to return the Carlson elliptic integral denoted by RD(x,y,z). This is a reimplementation of the C++ function written by John Burkardt (GNU LGPL license):

https://people.math.sc.edu/Burkardt/cpp_src /elliptic_integral/elliptic_integral.html

which in turn is based on:

Bille Carlson, Computing Elliptic Integrals by Duplication, Numerische Mathematik, Volume 33, 1979, pages 1-16.

Bille Carlson, Elaine Notis, Algorithm 577, Algorithms for Incomplete Elliptic Integrals, ACM Transactions on Mathematical Software, Volume 7, Number 3, pages 398-403, September 1981.

Parameters

[in]	x	first argument
[in]	y	second argument
[in]	z	third argument
[in]	errtol	error tolerance

Returns

the elliptic integral RD(x,y,z)

space_charge2D_push()

void impactx::envelope::spacecharge::space_charge2D_push	(	RefPart const &AMREX_RESTRICT	refpart,
		Map6x6 &AMREX_RESTRICT	cm,
		amrex::ParticleReal	current,
		amrex::ParticleReal	ds )

This function pushes the 6x6 beam covariance matrix for a slice of length ds, using the linear space charge fields in an rms equivalent 2D ellipse, as determined from the beam covariance matrix. Note: This is a reduced model of 2D space charge.

Parameters

[in]	refpart	reference particle
[in,out]	cm	covariance matrix
[in]	current	beam current [A]
[in]	ds	step size [m]

space_charge3D_push()

void impactx::envelope::spacecharge::space_charge3D_push	(	RefPart const &AMREX_RESTRICT	refpart,
		Map6x6 &AMREX_RESTRICT	cm,
		amrex::ParticleReal	bunch_charge,
		amrex::ParticleReal	ds )

This function pushes the 6x6 beam covariance matrix for a slice of length ds, using the linear space charge fields in an rms equivalent 3D ellipsoid, as determined from the beam covariance matrix. Note: This is a reduced model of 3D space charge.

Parameters

[in]	refpart	reference particle
[in,out]	cm	covariance matrix
[in]	bunch_charge	bunch charge [C]
[in]	ds	step size [m]