Skip to content

Commit

Permalink
Fix docstrings after the change in sign
Browse files Browse the repository at this point in the history
  • Loading branch information
agolovanov committed May 9, 2024
1 parent d03e493 commit 07346a4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions wake_t/beamline_elements/field_quadrupole.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ class FieldQuadrupole(FieldElement):
Length of the quadrupole lens in :math:`m`.
foc_strength : float
Focusing strength of the quadrupole in :math:`T/m`. Defined so
that a positive value is focusing for electrons in the :math:`y`
plane and defocusing in the :math:`x` plane.
that a positive value is focusing for electrons in the :math:`x`
plane and defocusing in the :math:`y` plane.
dt_bunch : float, str, or list of float and str
The time step for evolving the particle bunches. If ``'auto'``, it will
be automatically set to :math:`dt = T/(10*2*pi)`, where T is the
Expand Down
8 changes: 4 additions & 4 deletions wake_t/physics_models/em_fields/quadrupole.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ class QuadrupoleField(AnalyticalField):
In Cartesian coordinates, the field is given by:
```
b_x = k * y
b_y = k * x
b_x = - k * y
b_y = - k * x
```
When `k > 0`, it corresponds to focussing electrons in the `y` direction
and defocussing in `x`. When `k < 0`, the result is the opposite.
When `k > 0`, it corresponds to focussing electrons in the `x` direction
and defocussing in `y`. When `k < 0`, the result is the opposite.
Parameters
----------
Expand Down

0 comments on commit 07346a4

Please sign in to comment.