Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Feb 18, 2025
1 parent 9fc5601 commit cfc02c9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/source/usage/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Initial Beam Distributions

* ``beam.current`` (``float``, in A)
beam current, used only if space_charge_model = "2D"

* ``beam.particle`` (``string``)
particle type: currently either ``electron``, ``positron`` or ``proton``

Expand Down Expand Up @@ -834,13 +834,13 @@ Multigrid-specific numerical options:
Options:

* ``2D``: Space charge forces are computed in the plane ``(x,y)`` transverse to the reference particle velocity, assuming the beam is long and unbunched.

Currently, this model is supported only in evelope mode (when algo.track = "envelope").

* ``3D``: Space charge forces are computed in three dimensions, assuming the beam is bunched.

Currently, this model is supported only in particle mode (when algo.track = "particles").


.. _running-cpp-parameters-collective-csr:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/usage/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Collective Effects & Overall Simulation Parameters

:param ref: the reference particle (object from :py:class:`impactx.RefPart`)
:param distr: distribution function (object from :py:mod:`impactx.distribution`)
:param float intensity: the beam intensity, given as bunch charge (C) or beam current (A)
:param float intensity: the beam intensity, given as bunch charge (C) or beam current (A)

.. py:method:: particle_container()
Expand Down

0 comments on commit cfc02c9

Please sign in to comment.