Add element docs.

ECP-WarpX · Aug 1, 2023 · 710ff4f · 710ff4f
1 parent fe8e3ba
commit 710ff4f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/source/usage/parameters.rst b/docs/source/usage/parameters.rst
@@ -466,6 +466,14 @@ Lattice Elements
 
             * ``<element_name>.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:
+
+            * ``<element_name>.xkick`` (``float``, dimensionless OR in T-m) the horizontal kick strength
+
+            * ``<element_name>.ykick`` (``float``, dimensionless OR in T-m) the vertical kick strength
+
+            * ``<element_name>.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
@@ -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.