Skip to content

Commit

Permalink
Merge pull request fbpic#698 from SchroederSa/patch-2
Browse files Browse the repository at this point in the history
clarifying ion initialisation via initialize_ions flag in the simulat…
  • Loading branch information
RemiLehe authored Sep 10, 2024
2 parents de984b3 + 543247a commit 19bda43
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/source/advanced/boosted_frame.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,9 @@ or read a `more detailed description of the speedup
in this case the ions move with relativistic speed and do produce a
non-negligible current :math:`\boldsymbol{j}`. Therefore, **in boosted-frame
simulations, the ions are required**. Make sure to include them, either
by setting the flag ``initialize_ions=True`` in the :any:`Simulation`
object, or by adding them separately with :any:`add_new_species`.
by setting the flag ``initialize_ions=True`` and specifying the ion plasma density in the :any:`Simulation`
object, or by adding them separately with :any:`add_new_species`. We recommend the latter approach, using
:any:`add_new_species` function.


Converting input parameters from the lab frame to the boosted frame
Expand Down

0 comments on commit 19bda43

Please sign in to comment.