diff options
| author |  Luca Fedeli <luca.fedeli@cea.fr>
| 2021-03-24 17:14:23 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-03-24 09:14:23 -0700 |
| commit | f298889d808f3afde18c3183211cebb978ee60d5 (patch) | |
| tree | ae001238d52ed0a3a20f3121cbfe632a2be731f7 | |
| parent | 9a46d75cb2664efc136e6be081992524de3f861b (diff) | |
| download | WarpX-f298889d808f3afde18c3183211cebb978ee60d5.tar.gz WarpX-f298889d808f3afde18c3183211cebb978ee60d5.tar.zst WarpX-f298889d808f3afde18c3183211cebb978ee60d5.zip | |
add warning for Galerkin scheme (#1832)
| -rw-r--r-- | Docs/source/usage/parameters.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index e1cc5304e..f90ec5485 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -1223,6 +1223,11 @@ Numerics and algorithms See equations 21-23 of (`Godfrey and Vay, 2013 <https://doi.org/10.1016/j.jcp.2013.04.006>`_) and associated references for details. Defaults to `1` unless ``warpx.do_nodal = 1`` and/or ``algo.field_gathering = momentum-conserving``. + .. warning:: + + The default behavior should not normally be changed. + At present, this parameter is intended mainly for testing and development purposes. + * ``interpolation.field_gathering_nox``, ``interpolation.field_gathering_noy``, ``interpolation.field_gathering_noz`` (default: ``2`` in all directions) The order of the interpolation used with staggered grids (``warpx.do_nodal = 0``) and momentum-conserving field gathering (``algo.field_gathering = momentum-conserving``) to interpolate the electric and magnetic fields from the cell centers to the cell nodes, before gathering the fields from the cell nodes to the particle positions. High-order interpolation (order 8 in each direction, at least) is necessary to ensure stability in typical LWFA boosted-frame simulations using the Galilean PSATD or comoving PSATD schemes. This arbitrary-order interpolation is used only when the PSATD solver is used for Maxwell's equations. With the FDTD solver, basic linear interpolation is used instead. |