aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar Olga Shapoval <30510597+oshapoval@users.noreply.github.com> 2020-03-11 19:29:26 -0700
committerGravatar GitHub <noreply@github.com> 2020-03-11 19:29:26 -0700
commit09686d364f981e0d6cc4402f9922474bc7bccaec (patch)
treec22a4e28329a588a7c3dff99dbb782907c38aaeb /Docs/source/running_cpp
parentbc7c47fc1a50c961892f13110f701aa89c0a53d2 (diff)
downloadWarpX-09686d364f981e0d6cc4402f9922474bc7bccaec.tar.gz
WarpX-09686d364f981e0d6cc4402f9922474bc7bccaec.tar.zst
WarpX-09686d364f981e0d6cc4402f9922474bc7bccaec.zip
Added optional user defined number of guard cells to use with PSATD solver (#787)
* Added optional user defined number of quard cells to use with PSATD solver. * Removed temporary comments. * Changed names nx_guard_psatd to psatd.nx_guard for consistency.
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 5966d2da1..dc8527d72 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -940,6 +940,11 @@ Numerics and algorithms
* ``psatd.nox``, ``psatd.noy``, ``pstad.noz`` (`integer`) optional (default `16` for all)
The order of accuracy of the spatial derivatives, when using the code compiled with a PSATD solver.
+* ``psatd.nx_guard`, ``psatd.ny_guard``, ``psatd.nz_guard`` (`integer`) optional
+ The number of guard cells to use with PSATD solver.
+ If not set by users, these values are calculated automatically and determined *empirically* and
+ would be equal the order of the solver for nodal grid, and half the order of the solver for staggered.
+
* ``psatd.hybrid_mpi_decomposition`` (`0` or `1`; default: 0)
Whether to use a different MPI decomposition for the particle-grid operations
(deposition and gather) and for the PSATD solver. If `1`, the FFT will