aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar RevathiJambunathan <revanathan@gmail.com> 2019-05-17 14:09:14 -0700
committerGravatar RevathiJambunathan <revanathan@gmail.com> 2019-05-17 14:09:14 -0700
commit89913f85a71dadaf7033a79642476a92cc642473 (patch)
treee7a5698ed1a1c34f3dd8769e4e176d93aaae3643 /Docs/source/running_cpp
parent6e932214f793648af9a89c3c6762d30689f83384 (diff)
downloadWarpX-89913f85a71dadaf7033a79642476a92cc642473.tar.gz
WarpX-89913f85a71dadaf7033a79642476a92cc642473.tar.zst
WarpX-89913f85a71dadaf7033a79642476a92cc642473.zip
Included brief comments and some documentation for the input parameters
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 97fd1df30..7d4c12ca1 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -701,6 +701,19 @@ Diagnostics and output
* ``warpx.plot_B_field`` (`0` or `1` optional; default `1`)
Whether to plot the magnetic field.
+* ``slice.dom_lo`` and ``slice.dom_hi`` (`2 floats in 2D`, `3 floats in 3D`; in meters similar to the units of the simulation box.)
+ The extent of the slice are defined by the co-ordinates of the lower conrer (``slice.dom_lo``) and upper corner (``slice.dom_hi``). The slice could be 1D, 2D, or 3D, aligned with the co-ordinate axes and the first axis of the coordinates is x. For eg: if for a 3D simulation, an x-z slice is to be extracted at y = 0.0, then the y-value of slice.dom_lo and slice.dom_hi must be equal to 0.0
+
+* ``slice.coarsening_ratio`` (`2 integers in 2D`, `3 integers in 3D`; default `1`)
+ The coarsening ratio input must be greater than 0. Default is 1 in all directions.
+ In the directions that is reduced, i.e., for an x-z slice in 3D, the reduced y-dimension has a default coarsening ratio equal to 1.
+
+* ``slice.plot_int`` (`integer`)
+ The number of PIC cycles inbetween two consecutive data dumps for the slice. Use a
+ negative number to disable slice generation and slice data dumping.
+
+
+
Checkpoints and restart
-----------------------
WarpX supports checkpoints/restart via AMReX.