You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/usage/parameters.rst
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -903,6 +903,7 @@ See there ``nslice`` option on lattice elements for slicing.
903
903
When running in envelope mode (when ``algo.track = "envelope"``), this model currently assumes that ``<xy> = <yt> = <tx> = 0``.
904
904
905
905
* ``"Gauss3D"``: Calculate 3D space charge forces as if the beam was a Gaussian distribution.
906
+
906
907
* ``"Gauss2p5D"``: Calculate 2.5D space charge forces as if the beam was a transverse Gaussian distribution.
907
908
908
909
These models are supported only in particle tracking mode (when ``algo.track = "particles"``).
@@ -923,6 +924,17 @@ See there ``nslice`` option on lattice elements for slicing.
923
924
924
925
Number of bins for longitudinal line density deposition.
925
926
927
+
* ``"2p5D"``: Space charge forces are computed in the plane ``(x,y)`` transverse to the reference particle velocity, while the transverse space charge kicks are weighted by the
928
+
longitudinal line density determined by charge deposition (2.5D model). Longitudinal space charge kicks are determined by the derivative of the line charge density.
929
+
930
+
This model is supported only in particle tracking mode (when ``algo.track = "particles"``).
Number of bins for longitudinal charge density deposition (default: ``129``).
95
96
97
+
* ``"2p5D"``: Space charge forces are computed in the plane ``(x,y)`` transverse to the reference particle velocity, while the transverse space charge kicks are weighted by the
98
+
longitudinal line density determined by charge deposition (2.5D model). Longitudinal space charge kicks are determined by the derivative of the line charge density.
99
+
100
+
These models are supported only in particle tracking mode (when ``algo.track = "particles"``).
101
+
102
+
.. py:property:: space_charge_z_bins
103
+
104
+
Number of bins for longitudinal charge density deposition (default: ``129``).
105
+
96
106
.. py:property:: poisson_solver
97
107
98
108
The numerical solver to solve the Poisson equation when calculating space charge effects.
0 commit comments