aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar Dave Grote <grote1@llnl.gov> 2019-08-09 14:12:46 -0700
committerGravatar Dave Grote <grote1@llnl.gov> 2019-08-09 14:12:46 -0700
commitc3ce219b9d25e8d28e5a6cc5b878b3c5793cf90a (patch)
treed296f21c2e9051c21707f3fa419c8cfe892ea952 /Docs/source/running_cpp
parentf86512d788477a8eab5ed3c3c92ce9a7453ae4c7 (diff)
parent941a74cdee2d89c832d3fc682ef9a0973deddcce (diff)
downloadWarpX-c3ce219b9d25e8d28e5a6cc5b878b3c5793cf90a.tar.gz
WarpX-c3ce219b9d25e8d28e5a6cc5b878b3c5793cf90a.tar.zst
WarpX-c3ce219b9d25e8d28e5a6cc5b878b3c5793cf90a.zip
Merge branch 'dev' into RZgeometry
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst24
1 files changed, 14 insertions, 10 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index ec3baee86..518aae76a 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -226,6 +226,14 @@ Particle initialization
``electrons.density_function(x,y,z) = "n0+n0*x**2*1.e12"`` where ``n0`` is a
user-defined constant, see above.
+* ``<species_name>.density_min`` (`float`) optional (default `0.`)
+ Minimum plasma density. No particle is injected where the density is below
+ this value.
+
+* ``<species_name>.density_max`` (`float`) optional (default `infinity`)
+ Maximum plasma density. The density at each point is the minimum between
+ the value given in the profile, and `density_max`.
+
* ``<species_name>.radially_weighted`` (`bool`) optional (default `true`)
Whether particle's weight is varied with their radius. This only applies to cylindrical geometry.
The only valid value is true.
@@ -730,14 +738,12 @@ Diagnostics and output
* ``amr.plot_file`` (`string`)
Root for output file names. Supports sub-directories. Default `diags/plotfiles/plt`
-* ``warpx.plot_J_field`` (`0` or `1` optional; default `1`)
- Whether to plot the current density.
-
-* ``warpx.plot_E_field`` (`0` or `1` optional; default `1`)
- Whether to plot the electric field.
-
-* ``warpx.plot_B_field`` (`0` or `1` optional; default `1`)
- Whether to plot the magnetic field.
+* ``warpx.fields_to_plot`` (`list of strings`)
+ Fields written to plotfiles. Possible values: ``Ex`` ``Ey`` ``Ez``
+ ``Bx`` ``By`` ``Bz`` ``jx`` ``jy`` ``jz`` ``part_per_cell`` ``rho``
+ ``F`` ``part_per_grid`` ``part_per_proc`` ``divE`` ``divB``.
+ Default is
+ ``warpx_fields_to_plot = Ex Ey Ez Bx By Bz jx jy jz part_per_cell``.
* ``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 corner (``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 example: 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
@@ -750,8 +756,6 @@ Diagnostics and output
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.