Skip to content

Commit e9df674

Browse files
committed
06_27_2025: updated docs
1 parent 82e5109 commit e9df674

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/source/index.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,26 @@ Single particle hamiltonian function:
66

77
.. math::
88
9-
H(q_x, q_y, q_s, p_x, p_y, p_s; s) = p_s/\beta - t(s)(q_x p_y - q_y p_x) - (1 + h(s) q_x) (\sqrt{(p_s + 1/beta - \varphi(qs, s))^2 - (p_x - a_x(qs, s))^2 - (p_y - a_y(qs, s))^2 - 1/(\beta \gamma)^2} - a_s)
9+
H = H(q_x, q_y, q_s, p_x, p_y, p_s; s) \\
10+
H = p_s/\beta - t(s)(q_x p_y - q_y p_x) - (1 + h(s) q_x) (\sqrt{P_s^2 - P_x^2 - P_y^2 - 1/(\beta \gamma)^2} - a_s) \\
11+
P_s = p_s + 1/beta - \varphi(q_x, q_y, q_s, s) \\
12+
P_x = p_x - a_x(q_x, q_y, q_s, s) \\
13+
P_y p_y - a_y(q_x, q_y, q_s, s)
1014
1115
where :math:`\beta` and :math:`\gamma` are the relativistic factors, :math:`h(s)` is the reference trajectory curvature and :math:`t(s)` is the reference trajectory torsion, :math:`a_x(qs, s)`, :math:`a_y(qs, s)` and :math:`a_s(qs, s)` are the scaled vector potential components, and :math:`\varphi(qs, s)` is the scaled scalar potential.
1216
Additionaly, longitudinal coordinate and momentum are given by:
1317

1418
.. math::
15-
q_s = \frac{s}{\beta} - c t
19+
20+
q_s = \frac{s}{\beta} - c t \\
1621
p_s = \frac{E}{c P} - 1/beta
1722
1823
Common predefined elements are available or you can create your own by specifying scaled potentials and reference trajectory parameters (curvature and torsion).
1924
All but vector potentials arguments are optional for hamiltonian and element construction.
2025
Vector and scalar potentials are assumed to have matching signatures.
2126

2227
.. code-block:: python
28+
2329
def vector(qs:Array, s:Array, *args:Array) -> tuple[Array, Array, Array]:
2430
q_x, q_y, q_s = qs
2531
...
@@ -32,6 +38,7 @@ This is also the case for curvature and torsion functions.
3238
Note, same extra arguments as in vector and scalar functions should be passed.
3339

3440
.. code-block:: python
41+
3542
def curvature(s:Array, *args:Array) -> Array:
3643
...
3744
@@ -41,6 +48,7 @@ Note, same extra arguments as in vector and scalar functions should be passed.
4148
The resulting hamiltonian and element signatures are:
4249

4350
.. code-block:: python
51+
4452
def hamiltonian(qs: Array, ps: Array, s: Array, *args: Array) -> Array:
4553
q_x, q_y, q_s = qs
4654
p_x, p_y, p_s = ps

0 commit comments

Comments
 (0)