diff options
Diffstat (limited to 'Docs/source/running_cpp')
| -rw-r--r-- | Docs/source/running_cpp/parameters.rst | 29 | ||||
| -rw-r--r-- | Docs/source/running_cpp/platforms.rst | 4 |
2 files changed, 19 insertions, 14 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index d2f0c8546..e5c99a3d9 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -349,8 +349,8 @@ Particle initialization ``<species>.plot_vars = none`` to plot no particle data, except particle position. -* ``<species>.do_boosted_frame_diags`` (`0` or `1` optional, default `1`) - Only used when ``warpx.do_boosted_frame_diagnostic=1``. When running in a +* ``<species>.do_back_transformed_diagnostics`` (`0` or `1` optional, default `1`) + Only used when ``warpx.do_back_transformed_diagnostics=1``. When running in a boosted frame, whether or not to plot back-transformed diagnostics for this species. @@ -614,8 +614,6 @@ Numerics and algorithms - ``direct``: simpler current deposition algorithm, described in the section :doc:`../theory/picsar_theory`. Note that this algorithm is not strictly charge-conserving. - If ``algo.current_deposition`` is not specified, the default is ``esirkepov``. - * ``algo.charge_deposition`` (`string`, optional) The algorithm for the charge density deposition. Available options are: @@ -625,8 +623,15 @@ Numerics and algorithms * ``algo.field_gathering`` (`string`, optional) The algorithm for field gathering. Available options are: - - ``standard``: gathers directly from the grid points (either staggered + - ``energy-conserving``: gathers directly from the grid points (either staggered or nodal gridpoints depending on ``warpx.do_nodal``). + - ``momentum-conserving``: first average the fields from the grid points to + the nodes, and then gather from the nodes. + + If ``algo.field_gathering`` is not specified, the default is ``energy-conserving``. + If ``warpx.do_nodal`` is ``true``, then ``energy-conserving`` and ``momentum-conserving`` + are equivalent. + * ``algo.particle_pusher`` (`string`, optional) The algorithm for the particle pusher. Available options are: @@ -766,7 +771,7 @@ Diagnostics and output When WarpX is compiled with openPMD support, this is ``h5`` by default. ``json`` only works with serial/single-rank jobs. -* ``warpx.do_boosted_frame_diagnostic`` (`0` or `1`) +* ``warpx.do_back_transformed_diagnostics`` (`0` or `1`) Whether to use the **back-transformed diagnostics** (i.e. diagnostics that perform on-the-fly conversion to the laboratory frame, when running boosted-frame simulations) @@ -777,22 +782,22 @@ Diagnostics and output is `lab_frame_data`. * ``warpx.num_snapshots_lab`` (`integer`) - Only used when ``warpx.do_boosted_frame_diagnostic`` is ``1``. + Only used when ``warpx.do_back_transformed_diagnostics`` is ``1``. The number of lab-frame snapshots that will be written. * ``warpx.dt_snapshots_lab`` (`float`, in seconds) - Only used when ``warpx.do_boosted_frame_diagnostic`` is ``1``. + Only used when ``warpx.do_back_transformed_diagnostics`` is ``1``. The time interval inbetween the lab-frame snapshots (where this time interval is expressed in the laboratory frame). * ``warpx.dz_snapshots_lab`` (`float`, in meters) - Only used when ``warpx.do_boosted_frame_diagnostic`` is ``1``. + Only used when ``warpx.do_back_transformed_diagnostics`` is ``1``. Distance between the lab-frame snapshots (expressed in the laboratory frame). ``dt_snapshots_lab`` is then computed by ``dt_snapshots_lab = dz_snapshots_lab/c``. Either `dt_snapshots_lab` or `dz_snapshot_lab` is required. -* ``warpx.do_boosted_frame_fields`` (`0 or 1`) +* ``warpx.do_back_transformed_fields`` (`0 or 1`) Whether to use the **back-transformed diagnostics** for the fields. * ``warpx.boosted_frame_diag_fields`` (space-separated list of `string`) @@ -851,7 +856,7 @@ Diagnostics and output negative number to disable slice generation and slice data dumping. * ``slice.num_slice_snapshots_lab`` (`integer`) - Only used when ``warpx.do_boosted_frame_diagnostic`` is ``1``. + Only used when ``warpx.do_back_transformed_diagnostics`` is ``1``. The number of back-transformed field and particle data that will be written for the reduced domain defined by ``slice.dom_lo`` and ``slice.dom_hi``. Note that the 'slice' is a reduced @@ -861,7 +866,7 @@ Diagnostics and output for further details. * ``slice.dt_slice_snapshots_lab`` (`float`, in seconds) - Only used when ``warpx.do_boosted_frame_diagnostic`` is ``1``. + Only used when ``warpx.do_back_transformed_diagnostics`` is ``1``. The time interval between the back-transformed reduced diagnostics (where this time interval is expressed in the laboratory frame). diff --git a/Docs/source/running_cpp/platforms.rst b/Docs/source/running_cpp/platforms.rst index e74aa36db..9600c1c30 100644 --- a/Docs/source/running_cpp/platforms.rst +++ b/Docs/source/running_cpp/platforms.rst @@ -8,7 +8,7 @@ The batch script below can be used to run a WarpX simulation on 2 KNL nodes on the supercomputer Cori at NERSC. Replace descriptions between chevrons ``<>`` by relevant values, for instance ``<job name>`` could be ``laserWakefield``. -.. literalinclude:: ../../../Examples/batchScripts/batch_cori.sh +.. literalinclude:: ../../../Tools/batchScripts/batch_cori.sh :language: bash To run a simulation, copy the lines above to a file ``batch_cori.sh`` and @@ -42,7 +42,7 @@ by relevalt values, for instance ``<input file>`` could be ``plasma_mirror_inputs``. Note that the only option so far is to run with one MPI rank per GPU. -.. literalinclude:: ../../../Examples/batchScripts/batch_summit.sh +.. literalinclude:: ../../../Tools/batchScripts/batch_summit.sh :language: bash To run a simulation, copy the lines above to a file ``batch_summit.sh`` and |