From 46a0f5d48b261aa8ae4fda5dd01ddc0a4f65915f Mon Sep 17 00:00:00 2001 From: Chad Mitchell <46825199+cemitch99@users.noreply.github.com> Date: Mon, 13 Jan 2025 09:47:33 -0800 Subject: [PATCH] Add symplectic warning in Python element documentation. --- docs/source/usage/python.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/usage/python.rst b/docs/source/usage/python.rst index 18ba2d169..0a7842fe2 100644 --- a/docs/source/usage/python.rst +++ b/docs/source/usage/python.rst @@ -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