:mod:`ocelot.utils.wake_pws`
============================

.. py:module:: ocelot.utils.wake_pws

.. autoapi-nested-parse::

   Planar wakefield structure
   S.Tomin, 11.2018

   added function which generates wake tables
   S.Tomin and I.Zagorodnov, 11.2019



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   ocelot.utils.wake_pws.wake_tables
   ocelot.utils.wake_pws.wake_kick


.. function:: wake_tables(b=500 * 1e-06, a=0.01, width=0.02, t=0.25 * 0.001, p=0.5 * 0.001, length=1, sigma=3e-05, filename=None)

   Function creates two wake tables for horizontal and vertical corrugated plates

   :param b: distance from the plate in [m]
   :param a: half gap between plates in [m]
   :param width: width of the corrugated structure in [m]
   :param t: longitudinal gap in [m]
   :param p: period of corrugation in [m]
   :param length: length of the corrugated structure in [m]
   :param sigma: characteristic longitudinal beam size in [m]]
   :param filename: save to files if filename is not None
   :return: hor_wake_table, vert_wake_table


.. function:: wake_kick(p_array, b=500 * 1e-06, t=0.25 * 0.001, p=0.5 * 0.001)

   Function to calculate transverse kick by corrugated structure [SLAC-PUB-16881]

   :param p_array: ParticleArray
   :param b: distance to the dechirper wall
   :param t: longitudinal gap
   :param p: period
   :return: (wake, current) - wake[:, 0] - s in [m],  wake[:, 1] - kick in [V]
                           - current[:, 0] - s in [m], current[:, 1] - current in [A]


.. data:: data_dir
   :annotation: = /Users/tomins/ownCloud/DESY/repository/ocelot/projects/dechirper/dataxxl/ocelot