Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SI units support to soft-edge solenoid #597

Merged
merged 1 commit into from
May 23, 2024
Merged

Add SI units support to soft-edge solenoid #597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/source/usage/parameters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,11 +369,16 @@ Lattice Elements
* ``solenoid_softedge`` for a soft-edge solenoid. This requires these additional parameters:

* ``<element_name>.ds`` (``float``, in meters) the segment length
* ``<element_name>.bscale`` (``float``, in inverse meters) Scaling factor for on-axis magnetic field Bz
* ``<element_name>.bscale`` (``float``, in inverse meters) Scaling factor for on-axis longitudinal magnetic field
= (magnetic field Bz in T) / (magnetic rigidity in T-m) - if units = 0

OR = magnetic field Bz in T - if units = 1

* ``<element_name>.cos_coefficients`` (array of ``float``) cos coefficients in Fourier expansion of the on-axis magnetic field Bz
(optional); default is a thin-shell model from `DOI:10.1016/J.NIMA.2022.166706 <https://doi.org/10.1016/j.nima.2022.166706>`__
* ``<element_name>.sin_coefficients`` (array of ``float``) sin coefficients in Fourier expansion of the on-axis magnetic field Bz
(optional); default is a thin-shell model from `DOI:10.1016/J.NIMA.2022.166706 <https://doi.org/10.1016/j.nima.2022.166706>`__
* ``<element_name>.units`` (``integer``) specification of units (default: ``0``)
* ``<element_name>.dx`` (``float``, in meters) horizontal translation error
* ``<element_name>.dy`` (``float``, in meters) vertical translation error
* ``<element_name>.rotation`` (``float``, in degrees) rotation error in the transverse plane
Expand Down
5 changes: 4 additions & 1 deletion docs/source/usage/python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -831,11 +831,14 @@ This module provides elements for the accelerator lattice.
A soft-edge solenoid.

:param ds: Segment length in m.
:param bscale: Scaling factor for on-axis magnetic field Bz in inverse meters
:param bscale: Scaling factor for on-axis magnetic field Bz in inverse meters (if units = 0)
= (magnetic field Bz in T) / (rigidity in T-m)
OR Magnetic field Bz in T (SI units, if units = 1)
:param cos_coefficients: array of ``float`` cosine coefficients in Fourier expansion of on-axis magnetic field Bz
(optional); default is a thin-shell model from `DOI:10.1016/J.NIMA.2022.166706 <https://doi.org/10.1016/j.nima.2022.166706>`__
:param sin_coefficients: array of ``float`` sine coefficients in Fourier expansion of on-axis magnetic field Bz
(optional); default is a thin-shell model from `DOI:10.1016/J.NIMA.2022.166706 <https://doi.org/10.1016/j.nima.2022.166706>`__
:param units: specification of units for scaling of the on-axis longitudinal magnetic field
:param dx: horizontal translation error in m
:param dy: vertical translation error in m
:param rotation: rotation error in the transverse plane [degrees]
Expand Down
4 changes: 3 additions & 1 deletion src/initialization/InitElement.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,15 +252,17 @@ namespace detail

amrex::ParticleReal bscale;
int mapsteps = mapsteps_default;
int units = 0;
Sol_field_data const bz;
std::vector<amrex::ParticleReal> cos_coef = bz.default_cos_coef;
std::vector<amrex::ParticleReal> sin_coef = bz.default_sin_coef;
pp_element.get("bscale", bscale);
pp_element.queryAdd("units", units);
pp_element.queryAdd("mapsteps", mapsteps);
detail::queryAddResize(pp_element, "cos_coefficients", cos_coef);
detail::queryAddResize(pp_element, "sin_coefficients", sin_coef);

m_lattice.emplace_back( SoftSolenoid(ds, bscale, cos_coef, sin_coef, a["dx"], a["dy"], a["rotation_degree"], mapsteps, nslice) );
m_lattice.emplace_back( SoftSolenoid(ds, bscale, cos_coef, sin_coef, units, a["dx"], a["dy"], a["rotation_degree"], mapsteps, nslice) );
} else if (element_type == "quadrupole_softedge")
{
auto const [ds, nslice] = detail::query_ds(pp_element, nslice_default);
Expand Down
21 changes: 17 additions & 4 deletions src/particles/elements/SoftSol.H
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,14 @@ namespace SoftSolenoidData
/** A soft-edge solenoid
*
* @param ds Segment length in m
* @param bscale Scaling factor for on-axis magnetic field Bz in 1/m
* @param 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)
* @param cos_coef cosine coefficients in Fourier expansion of on-axis magnetic field Bz
* @param sin_coef sine coefficients in Fourier expansion of on-axis magnetic field Bz
* @param unit Unit specification
* unit = 0 MADX convention (default)
* unit = 1 SI units
* @param dx horizontal translation error in m
* @param dy vertical translation error in m
* @param rotation_degree rotation error in the transverse plane [degrees]
Expand All @@ -141,6 +146,7 @@ namespace SoftSolenoidData
amrex::ParticleReal bscale,
std::vector<amrex::ParticleReal> cos_coef,
std::vector<amrex::ParticleReal> sin_coef,
int unit,
amrex::ParticleReal dx = 0,
amrex::ParticleReal dy = 0,
amrex::ParticleReal rotation_degree = 0,
Expand All @@ -149,7 +155,7 @@ namespace SoftSolenoidData
)
: Thick(ds, nslice),
Alignment(dx, dy, rotation_degree),
m_bscale(bscale), m_mapsteps(mapsteps), m_id(SoftSolenoidData::next_id)
m_bscale(bscale), m_unit(unit), m_mapsteps(mapsteps), m_id(SoftSolenoidData::next_id)
{
// next created soft solenoid has another id for its data
SoftSolenoidData::next_id++;
Expand Down Expand Up @@ -445,7 +451,10 @@ namespace SoftSolenoidData
amrex::ParticleReal const pt = refpart.pt;

// Define parameters and intermediate constants
amrex::ParticleReal const B0 = m_bscale;
amrex::ParticleReal const B0 =
m_unit == 1 ?
m_bscale / refpart.rigidity_Tm() :
m_bscale;

// push the reference particle
auto [bz, bzp, bzint] = Sol_Bfield(zeval);
Expand Down Expand Up @@ -491,7 +500,10 @@ namespace SoftSolenoidData
amrex::ParticleReal const z = zeval;

// Define parameters and intermediate constants
amrex::ParticleReal const B0 = m_bscale;
amrex::ParticleReal const B0 =
m_unit == 1 ?
m_bscale / refpart.rigidity_Tm() :
m_bscale;

// push the reference particle
auto [bz, bzp, bzint] = Sol_Bfield(z);
Expand Down Expand Up @@ -546,6 +558,7 @@ namespace SoftSolenoidData
}

amrex::ParticleReal m_bscale; //! scaling factor for solenoid Bz field
int m_unit; //! unit specification for quad strength
int m_mapsteps; //! number of map integration steps per slice
int m_id; //! unique soft solenoid id used for data lookup map

Expand Down
4 changes: 3 additions & 1 deletion src/python/elements.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -992,13 +992,15 @@ void init_elements(py::module& m)
amrex::ParticleReal,
amrex::ParticleReal,
amrex::ParticleReal,
amrex::ParticleReal,
int,
int
>(),
py::arg("ds"),
py::arg("bscale"),
py::arg("cos_coefficients"),
py::arg("sin_coefficients"),
py::arg("unit") = 0,
py::arg("dx") = 0,
py::arg("dy") = 0,
py::arg("rotation") = 0,
Expand Down Expand Up @@ -1156,7 +1158,7 @@ void init_elements(py::module& m)
py::arg("dx") = 0,
py::arg("dy") = 0,
py::arg("rotation") = 0,
R"doc(A thin nonlinear plasma lens with A thin nonlinear plasma lens with transverse (horizontal) taper
R"doc(A thin nonlinear plasma lens with transverse (horizontal) taper

.. math::

Expand Down
Loading