Skip to content

Commit f5e02f6

Browse files
committed
Start documentation update.
1 parent 278114f commit f5e02f6

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

docs/source/usage/parameters.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -903,6 +903,7 @@ See there ``nslice`` option on lattice elements for slicing.
903903
When running in envelope mode (when ``algo.track = "envelope"``), this model currently assumes that ``<xy> = <yt> = <tx> = 0``.
904904

905905
* ``"Gauss3D"``: Calculate 3D space charge forces as if the beam was a Gaussian distribution.
906+
906907
* ``"Gauss2p5D"``: Calculate 2.5D space charge forces as if the beam was a transverse Gaussian distribution.
907908

908909
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.
923924

924925
Number of bins for longitudinal line density deposition.
925926

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"``).
931+
932+
This model supports the following sub-option:
933+
934+
* ``algo.space_charge.charge_z_bins`` (``int``, default: ``129``)
935+
936+
Number of bins for longitudinal line density deposition.
937+
926938
* ``amr.n_cell`` (3 integers) optional (default: 1 `blocking_factor <https://amrex-codes.github.io/amrex/docs_html/GridCreation.html>`__ per MPI process)
927939

928940
The number of grid points along each direction (on the **coarsest level**)

docs/source/usage/python.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ Collective Effects & Overall Simulation Parameters
7575
When running in envelope mode (when ``algo.track = "envelope"``), this model currently assumes that ``<xy> = <yt> = <tx> = 0``.
7676

7777
* ``"Gauss3D"``: Calculate 3D space charge forces as if the beam was a Gaussian distribution.
78+
7879
* ``"Gauss2p5D"``: Calculate 2.5D space charge forces as if the beam was a transverse Gaussian distribution.
7980

8081
These models are supported only in particle tracking mode (when ``algo.track = "particles"``).
@@ -93,6 +94,15 @@ Collective Effects & Overall Simulation Parameters
9394
9495
Number of bins for longitudinal charge density deposition (default: ``129``).
9596

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+
96106
.. py:property:: poisson_solver
97107
98108
The numerical solver to solve the Poisson equation when calculating space charge effects.

0 commit comments

Comments
 (0)