diff options
| author |  Andrew Myers <atmyers@lbl.gov>
| 2020-07-22 17:28:00 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2020-07-22 17:28:00 -0700 |
| commit | fd8a4bc0af84f9b5b074b18554becd92d22cb9e4 (patch) | |
| tree | 31ae42fe56a083bf4779d6e71fb899e41586f736 /Docs/source/running_cpp | |
| parent | db1b1547d732fa762281a09b26394f782176a98c (diff) | |
| download | WarpX-fd8a4bc0af84f9b5b074b18554becd92d22cb9e4.tar.gz WarpX-fd8a4bc0af84f9b5b074b18554becd92d22cb9e4.tar.zst WarpX-fd8a4bc0af84f9b5b074b18554becd92d22cb9e4.zip | |
make the docs and assertions around the particle shape factors reflect the current behavior of the code. (#1199)
Diffstat (limited to 'Docs/source/running_cpp')
| -rw-r--r-- | Docs/source/running_cpp/parameters.rst | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index 526c0749c..f28b88a1c 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -1036,12 +1036,11 @@ Numerics and algorithms The conductivity, permittivity, and permeability of the computational medium, respectively. If ``algo.em_solver_medium`` is set to macroscopic, then these properties must be provided. -* ``interpolation.nox``, ``interpolation.noy``, ``interpolation.noz`` (`integer`) +* ``interpolation.nox``, ``interpolation.noy``, ``interpolation.noz`` (`1`, `2`, or `3` ; default: 1) The order of the shape factors for the macroparticles, for the 3 dimensions of space. Lower-order shape factors result in faster simulations, but more noisy results, - Note that the implementation in WarpX is more efficient when these 3 numbers are equal, - and when they are between 1 and 3. + Note that in the current implementation in WarpX these 3 numbers must be equal. * ``warpx.do_dive_cleaning`` (`0` or `1` ; default: 0) Whether to use modified Maxwell equations that progressively eliminate |