Documentation

docs/source/usage/parameters.rst

@@ -449,6 +449,11 @@ Lattice Elements
                 openPMD `iteration encoding <https://openpmd-api.readthedocs.io/en/0.14.0/usage/concepts.html#iteration-and-series>`__: (v)ariable based, (f)ile based, (g)roup based (default)
                 variable based is an `experimental feature with ADIOS2 <https://openpmd-api.readthedocs.io/en/0.14.0/backends/adios2.html#experimental-new-adios2-schema>`__.
 
+            * ``<element_name>.cycle_intervals`` (``int``, default value: ``1``)
+
+                For periodic lattice, only output every N cycles (turns).
+                By default, diagnostics is performed every cycle.
+
             * ``<element_name>.nonlinear_lens_invariants`` (``boolean``, default value: ``false``)
 
                 Compute and output the invariants H and I within the nonlinear magnetic insert element (see: ``nonlinear_lens``).

docs/source/usage/python.rst

@@ -623,7 +623,7 @@ This module provides elements for the accelerator lattice.
    :param dy: vertical translation error in m
    :param rotation: rotation error in the transverse plane [degrees]
 
-.. py:class:: impactx.elements.BeamMonitor(name, backend="default", encoding="g")
+.. py:class:: impactx.elements.BeamMonitor(name, backend="default", encoding="g", cycle_intervals=1)
 
    A beam monitor, writing all beam particles at fixed ``s`` to openPMD files.
 
@@ -640,6 +640,7 @@ This module provides elements for the accelerator lattice.
    :param name: name of the series
    :param backend: I/O backend, e.g., ``bp``, ``h5``, ``json``
    :param encoding: openPMD iteration encoding: (v)ariable based, (f)ile based, (g)roup based (default)
+   :param cycle_intervals: for periodic lattice, only output every N cycles (turns)
 
    .. py:property:: name