Skip to content

Commit

Permalink
Add symplectic warning in Python element documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
cemitch99 authored Jan 13, 2025
1 parent c8ac06c commit 46a0f5d
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/source/usage/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,9 @@ This module provides elements for the accelerator lattice.
The matrix :math:`R` multiplies the phase space vector :math:`(x,px,y,py,t,pt)`, where coordinates :math:`(x,y,t)` have units of m
and momenta :math:`(px,py,pt)` are dimensionless. So, for example, :math:`R(1,1)` is dimensionless, and :math:`R(1,2)` has units of m.

The internal tracking methods used by ImpactX are symplectic. However, if a user-defined linear map :math:`R` is provided, it is
up to the user to ensure that the matrix :math:`R` is symplectic. Otherwise, this condition may be violated.

:param R: a linear transport map to multiply with the the phase space vector :math:`(x,px,y,py,t,pt)`.
:param dx: horizontal translation error in m
:param dy: vertical translation error in m
Expand Down

0 comments on commit 46a0f5d

Please sign in to comment.