Skip to content

Commit 2ae1c45

Browse files
committed
Update dipedge documentation.
1 parent 2a3097a commit 2ae1c45

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

docs/source/usage/parameters.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,8 @@ If ``model = "linear"``, then the linearized map is used. This model is identic
338338

339339
when expanded to first order in ``g/rc`` (gap / radius of curvature).
340340

341+
By comparison, note that the MAD-X DIPEDGE element uses as input the half-gap ``HGAP = g/2``, and sets the default value ``FINT = 0`` (while the corresponding default value of ``K2`` is set to 1).
342+
341343
This requires these additional parameters:
342344

343345
* ``<element_name>.psi`` (``float``, in radians) the pole face rotation angle
@@ -346,7 +348,7 @@ This requires these additional parameters:
346348
* ``<element_name>.R`` (``float``, in meters) scale length for the field integrals (default: ``1 m``)
347349
* ``<element_name>.K0`` (``float``, dimensionless) normalized field integral for fringe field
348350
* ``<element_name>.K1`` (``float``, dimensionless) normalized field integral for fringe field
349-
* ``<element_name>.K2`` (``float``, dimensionless) normalized field integral for fringe field (FINT)
351+
* ``<element_name>.K2`` (``float``, dimensionless) normalized field integral for fringe field (FINT, default: ``1``)
350352
* ``<element_name>.K3`` (``float``, dimensionless) normalized field integral for fringe field
351353
* ``<element_name>.K4`` (``float``, dimensionless) normalized field integral for fringe field
352354
* ``<element_name>.K5`` (``float``, dimensionless) normalized field integral for fringe field

docs/source/usage/python.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -809,7 +809,7 @@ This module provides elements and methods for the accelerator lattice.
809809
810810
focusing t strength in 1/m
811811

812-
.. py:class:: impactx.elements.DipEdge(psi, rc, g, K2, dx=0, dy=0, rotation=0, name=None)
812+
.. py:class:: impactx.elements.DipEdge(psi, rc, g, R=1, K0=pi/6, K1=0, K2=1, K3=1/6, K4=0, K5=0, K6=0, model="linear", location="entry", dx=0, dy=0, rotation=0, name=None)
813813
814814
Edge focusing associated with bend entry or exit
815815

@@ -832,6 +832,9 @@ This module provides elements and methods for the accelerator lattice.
832832

833833
when expanded to first order in ``g/rc`` (gap / radius of curvature).
834834

835+
By comparison, note that the MAD-X DIPEDGE element uses as input the half-gap ``HGAP = g/2``, and sets the default value ``FINT = 0`` (while
836+
the corresponding default value of ``K2`` is set to 1).
837+
835838
:param psi: Pole face angle [radians]
836839
:param rc: Radius of curvature [m]
837840
:param g: Gap parameter [m]

0 commit comments

Comments
 (0)