From 710ff4ff650f61372e8aed54f9453f2164cf744a Mon Sep 17 00:00:00 2001 From: Chad Mitchell Date: Tue, 1 Aug 2023 13:39:01 -0700 Subject: [PATCH] Add element docs. --- docs/source/usage/parameters.rst | 8 ++++++++ docs/source/usage/python.rst | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/docs/source/usage/parameters.rst b/docs/source/usage/parameters.rst index 123488f6d..7403a6bf2 100644 --- a/docs/source/usage/parameters.rst +++ b/docs/source/usage/parameters.rst @@ -466,6 +466,14 @@ Lattice Elements * ``.phi_out`` (``float``, in degrees) angle of the reference particle with respect to the longitudinal (z) axis in the rotated frame + * ``kicker`` for a thin transverse kicker. This requires these additional parameters: + + * ``.xkick`` (``float``, dimensionless OR in T-m) the horizontal kick strength + + * ``.ykick`` (``float``, dimensionless OR in T-m) the vertical kick strength + + * ``.units`` (``integer``, dimensionless) specification of units (default: ``0``) + * ``beam_monitor`` a beam monitor, writing all beam particles at fixed ``s`` to openPMD files. If the same element name is used multiple times, then an output series is created with multiple outputs. diff --git a/docs/source/usage/python.rst b/docs/source/usage/python.rst index e85fcbd72..c00216177 100644 --- a/docs/source/usage/python.rst +++ b/docs/source/usage/python.rst @@ -471,6 +471,14 @@ This module provides elements for the accelerator lattice. :param ds: Segment length in m :param nslice: number of slices used for the application of space charge +.. py:class:: impactx.elements.Kicker(xkick, ykick, units) + + A thin transverse kicker. + + :param xkick: horizontal kick strength (dimensionless OR T-m) + :param ykick: vertical kick strength (dimensionless OR T-m) + :param units: specification of units (0 - dimensionless, 1 - T-m) + .. py:class:: impactx.elements.Multipole(multipole, K_normal, K_skew) A general thin multipole element.