Adjust indent in parameters.rst (BLAST-WarpX#6632)

At most 4 spaces for indent of parameter descriptions

Author: eebasso

Docs/source/usage/parameters.rst

@@ -1445,18 +1445,19 @@ Particle initialization
     when the particles are generated.
     If the user-defined integer attribute is ``<int_attrib_name>`` then the
     following required parameter must be specified to initialize the attribute.
+
     * ``<species_name>.attribute.<int_attrib_name>(x,y,z,ux,uy,uz,t)`` (`string`)
-    ``t`` represents the physical time in seconds during the simulation.
-    ``x``, ``y``, ``z`` represent particle positions in the unit of meter.
-    ``ux``, ``uy``, ``uz`` represent the particle momenta in the unit of
-    :math:`\gamma v/c`, where
-    :math:`\gamma` is the Lorentz factor,
-    :math:`v/c` is the particle velocity normalized by the speed of light.
-    E.g. If ``electrons.addIntegerAttributes = upstream``
-    and ``electrons.upstream(x,y,z,ux,uy,uz,t) = (x>0.0)*1`` is provided
-    then, an integer attribute ``upstream`` is added to all electron particles
-    and when these particles are generated, the particles with position less than ``0``
-    are assigned a value of ``1``.
+        ``t`` represents the physical time in seconds during the simulation.
+        ``x``, ``y``, ``z`` represent particle positions in the unit of meter.
+        ``ux``, ``uy``, ``uz`` represent the particle momenta in the unit of
+        :math:`\gamma v/c`, where
+        :math:`\gamma` is the Lorentz factor,
+        :math:`v/c` is the particle velocity normalized by the speed of light.
+        E.g. If ``electrons.addIntegerAttributes = upstream``
+        and ``electrons.upstream(x,y,z,ux,uy,uz,t) = (x>0.0)*1`` is provided
+        then, an integer attribute ``upstream`` is added to all electron particles
+        and when these particles are generated, the particles with position less than ``0``
+        are assigned a value of ``1``.
 
 * ``<species_name>.addRealAttributes`` (list of `string`)
     User-defined real particle attribute for species, ``species_name``.
@@ -1465,13 +1466,13 @@ Particle initialization
     If the user-defined real attribute is ``<real_attrib_name>`` then the
     following required parameter must be specified to initialize the attribute.
 
-   * ``<species_name>.attribute.<real_attrib_name>(x,y,z,ux,uy,uz,t)`` (`string`)
-     ``t`` represents the physical time in seconds during the simulation.
-     ``x``, ``y``, ``z`` represent particle positions in the unit of meter.
-     ``ux``, ``uy``, ``uz`` represent the particle momenta in the unit of
-     :math:`\gamma v/c`, where
-     :math:`\gamma` is the Lorentz factor,
-     :math:`v/c` is the particle velocity normalized by the speed of light.
+    * ``<species_name>.attribute.<real_attrib_name>(x,y,z,ux,uy,uz,t)`` (`string`)
+        ``t`` represents the physical time in seconds during the simulation.
+        ``x``, ``y``, ``z`` represent particle positions in the unit of meter.
+        ``ux``, ``uy``, ``uz`` represent the particle momenta in the unit of
+        :math:`\gamma v/c`, where
+        :math:`\gamma` is the Lorentz factor,
+        :math:`v/c` is the particle velocity normalized by the speed of light.
 
 * ``<species_name>.save_particles_at_xlo/ylo/zlo``, ``<species_name>.save_particles_at_xhi/yhi/zhi`` and ``<species_name>.save_particles_at_eb`` (`0` or `1` optional, default `0`)
     If `1` particles of this species will be copied to the scraped particle
@@ -2546,7 +2547,7 @@ Particle push, charge and current deposition, field gathering
      - ``vay``: Vay pusher (see :cite:t:`param-Vaypop2008`)
      - ``higuera``: Higuera-Cary pusher (see :cite:t:`param-HigueraPOP2017`)
 
-     If ``algo.particle_pusher`` is not specified, ``boris`` is the default.
+    If ``algo.particle_pusher`` is not specified, ``boris`` is the default.
 
 * ``algo.particle_shape`` (`integer`; `1`, `2`, `3`, or `4`)
     The order of the shape factors (splines) for the macro-particles along all spatial directions: `1` for linear, `2` for quadratic, `3` for cubic, `4` for quartic.
@@ -2576,7 +2577,7 @@ Two families of Maxwell solvers are implemented in WarpX, based on the Finite-Di
      - ``hybrid``: The E-field will be solved using Ohm's law and a kinetic-fluid hybrid model (see :ref:`theory <theory-kinetic-fluid-hybrid-model>`).
      - ``none``: No field solve will be performed.
 
-     If ``algo.maxwell_solver`` is not specified, ``yee`` is the default.
+    If ``algo.maxwell_solver`` is not specified, ``yee`` is the default.
 
 * ``algo.em_solver_medium`` (`string`, optional)
     The medium for evaluating the Maxwell solver. Available options are :
@@ -2738,10 +2739,10 @@ Maxwell solver: macroscopic media
     Comparing the two methods, Lax-Wendroff is more prone to developing oscillations and requires a smaller timestep for stability. On the other hand, Backward Euler is more robust but it is first-order accurate in time compared to the second-order Lax-Wendroff method.
 
 * ``macroscopic.sigma_function(x,y,z)``, ``macroscopic.epsilon_function(x,y,z)``, ``macroscopic.mu_function(x,y,z)`` (`string`)
-     To initialize spatially varying conductivity, permittivity, and permeability, respectively,
-     using a mathematical function in the input. Constants required in the
-     mathematical expression can be set using ``my_constants``. These parameters are parsed
-     if ``algo.em_solver_medium=macroscopic``.
+    To initialize spatially varying conductivity, permittivity, and permeability, respectively,
+    using a mathematical function in the input. Constants required in the
+    mathematical expression can be set using ``my_constants``. These parameters are parsed
+    if ``algo.em_solver_medium=macroscopic``.
 
 * ``macroscopic.sigma``, ``macroscopic.epsilon``, ``macroscopic.mu`` (`double`)
     To initialize a constant conductivity, permittivity, and permeability of the
@@ -2916,16 +2917,16 @@ Additional parameters
     This allows the profiler to give meaningful timers, but (hardly) slows down the simulation.
 
 * ``warpx.sort_intervals`` (`string`) optional (defaults: ``-1`` on CPU; ``4`` on GPU)
-     Using the `Time intervals`_ syntax, this string defines the timesteps at which particles are
-     sorted.
-     If ``<=0``, do not sort particles.
-     It is turned on on GPUs for performance reasons (to improve memory locality).
+    Using the `Time intervals`_ syntax, this string defines the timesteps at which particles are
+    sorted.
+    If ``<=0``, do not sort particles.
+    It is turned on on GPUs for performance reasons (to improve memory locality).
 
 * ``warpx.sort_particles_for_deposition`` (`bool`) optional (default: ``true`` for the CUDA backend, otherwise ``false``)
-     This option controls the type of sorting used if particle sorting is turned on, i.e. if ``sort_intervals`` is not ``<=0``.
-     If ``true``, particles will be sorted by cell to optimize deposition with many particles per cell, in the order x -> y -> z -> ppc.
-     If ``false``, particles will be sorted by bin, using the ``sort_bin_size`` parameter below, in the order ppc -> x -> y -> z.
-     ``true`` is recommend for best performance on NVIDIA GPUs, especially if there are many particles per cell.
+    This option controls the type of sorting used if particle sorting is turned on, i.e. if ``sort_intervals`` is not ``<=0``.
+    If ``true``, particles will be sorted by cell to optimize deposition with many particles per cell, in the order x -> y -> z -> ppc.
+    If ``false``, particles will be sorted by bin, using the ``sort_bin_size`` parameter below, in the order ppc -> x -> y -> z.
+    ``true`` is recommend for best performance on NVIDIA GPUs, especially if there are many particles per cell.
 
 * ``warpx.sort_idx_type`` (list of `int`) optional (default: ``0 0 0``)
     This controls the type of grid used to sort the particles when ``sort_particles_for_deposition`` is ``true``. Possible values are:
@@ -2936,46 +2937,46 @@ Additional parameters
     In 1D, only the first element is read.
 
 * ``warpx.sort_bin_size`` (list of `int`) optional (default ``1 1 1``)
-     If ``sort_intervals`` is activated and ``sort_particles_for_deposition`` is ``false``, particles are sorted in bins of ``sort_bin_size`` cells.
-     In 2D, only the first two elements are read.
+    If ``sort_intervals`` is activated and ``sort_particles_for_deposition`` is ``false``, particles are sorted in bins of ``sort_bin_size`` cells.
+    In 2D, only the first two elements are read.
 
 * ``warpx.do_shared_mem_charge_deposition`` (`bool`) optional (default `false`)
-     If activated, charge deposition will allocate and use small
-     temporary buffers on which to accumulate deposited charge values
-     from particles. On GPUs these buffers will reside in ``__shared__``
-     memory, which is faster than the usual ``__global__``
-     memory. Performance impact will depend on the relative overhead
-     of assigning the particles to bins small enough to fit in the
-     space available for the temporary buffers.
+    If activated, charge deposition will allocate and use small
+    temporary buffers on which to accumulate deposited charge values
+    from particles. On GPUs these buffers will reside in ``__shared__``
+    memory, which is faster than the usual ``__global__``
+    memory. Performance impact will depend on the relative overhead
+    of assigning the particles to bins small enough to fit in the
+    space available for the temporary buffers.
 
 * ``warpx.do_shared_mem_current_deposition`` (`bool`) optional (default `false`)
-     If activated, current deposition will allocate and use small
-     temporary buffers on which to accumulate deposited current values
-     from particles. On GPUs these buffers will reside in ``__shared__``
-     memory, which is faster than the usual ``__global__``
-     memory. Performance impact will depend on the relative overhead
-     of assigning the particles to bins small enough to fit in the
-     space available for the temporary buffers. Performance is mostly improved
-     when there is lots of contention between particles writing to the same cell
-     (e.g. for high particles per cell). This feature is only available for CUDA
-     and HIP, and is only recommended for 3D or 2D.
+    If activated, current deposition will allocate and use small
+    temporary buffers on which to accumulate deposited current values
+    from particles. On GPUs these buffers will reside in ``__shared__``
+    memory, which is faster than the usual ``__global__``
+    memory. Performance impact will depend on the relative overhead
+    of assigning the particles to bins small enough to fit in the
+    space available for the temporary buffers. Performance is mostly improved
+    when there is lots of contention between particles writing to the same cell
+    (e.g. for high particles per cell). This feature is only available for CUDA
+    and HIP, and is only recommended for 3D or 2D.
 
 * ``warpx.shared_tilesize`` (list of `int`) optional (default `6 6 8` in 3D; `14 14` in 2D; `1s` otherwise)
-     Used to tune performance when ``do_shared_mem_current_deposition`` or
-     ``do_shared_mem_charge_deposition`` is enabled. ``shared_tilesize`` is the
-     size of the temporary buffer allocated in shared memory for a threadblock.
-     A larger tilesize requires more shared memory, but gives more work to each
-     threadblock, which can lead to higher occupancy, and allows for more
-     buffered writes to ``__shared__`` instead of ``__global__``. The defaults
-     in 2D and 3D
-     are chosen from experimentation, but can be improved upon for specific
-     problems. The other defaults are not optimized and should always be fine
-     tuned for the problem.
+    Used to tune performance when ``do_shared_mem_current_deposition`` or
+    ``do_shared_mem_charge_deposition`` is enabled. ``shared_tilesize`` is the
+    size of the temporary buffer allocated in shared memory for a threadblock.
+    A larger tilesize requires more shared memory, but gives more work to each
+    threadblock, which can lead to higher occupancy, and allows for more
+    buffered writes to ``__shared__`` instead of ``__global__``. The defaults
+    in 2D and 3D
+    are chosen from experimentation, but can be improved upon for specific
+    problems. The other defaults are not optimized and should always be fine
+    tuned for the problem.
 
 * ``warpx.shared_mem_current_tpb`` (`int`) optional (default `128`)
-     Used to tune performance when ``do_shared_mem_current_deposition`` is
-     enabled. ``shared_mem_current_tpb`` controls the number of threads per
-     block (tpb), i.e. the number of threads operating on a shared buffer.
+    Used to tune performance when ``do_shared_mem_current_deposition`` is
+    enabled. ``shared_mem_current_tpb`` controls the number of threads per
+    block (tpb), i.e. the number of threads operating on a shared buffer.
 
 
 .. _running-cpp-parameters-diagnostics:
@@ -3067,10 +3068,10 @@ In-situ capabilities can be used by turning on Sensei or Ascent (provided they a
     When WarpX is compiled with openPMD support, the first available backend in the order given above is taken.
 
 * ``<diag_name>.openpmd_encoding`` (optional, ``v`` (variable based), ``f`` (file based) or ``g`` (group based) ) only read if ``<diag_name>.format = openpmd``.
-     openPMD `file output encoding <https://openpmd-api.readthedocs.io/en/0.17.0/usage/concepts.html#iteration-and-series>`__.
-     File based: one file per timestep (slower), group/variable based: one file for all steps (faster)).
-     ``variable based`` is an `experimental feature with ADIOS2 BP5 <https://openpmd-api.readthedocs.io/en/0.17.0/backends/adios2.html#experimental-new-adios2-schema>`__ that will replace ``g``.
-     Default: ``f`` (full diagnostics)
+    openPMD `file output encoding <https://openpmd-api.readthedocs.io/en/0.17.0/usage/concepts.html#iteration-and-series>`__.
+    File based: one file per timestep (slower), group/variable based: one file for all steps (faster)).
+    ``variable based`` is an `experimental feature with ADIOS2 BP5 <https://openpmd-api.readthedocs.io/en/0.17.0/backends/adios2.html#experimental-new-adios2-schema>`__ that will replace ``g``.
+    Default: ``f`` (full diagnostics)
 
 * ``<diag_name>.buffer_flush_limit_btd`` (`integer`; defaults to 5) optional, only read if ``<diag_name>.diag_type = BackTransformed``
     This parameter is intended for ADIOS backend to group every N buffers (N is the value of this parameter) and then flush to disk.
@@ -3140,20 +3141,20 @@ In-situ capabilities can be used by turning on Sensei or Ascent (provided they a
     Whether to save all modes when in RZ.  When ``openpmd_backend = openpmd``, this parameter is ignored and all modes are saved.
 
 * ``<diag_name>.particle_fields_to_plot`` (list of `strings`, optional)
-   Names of per-cell diagnostics of particle properties to calculate and output as additional fields.
-   Note that the deposition onto the grid does not respect the particle shape factor, but instead uses nearest-grid point interpolation.
-   Default is none.
-   Parser functions for these field names are specified by ``<diag_name>.particle_fields.<field_name>(x,y,z,ux,uy,uz)``.
-   Also, note that this option is only available for ``<diag_name>.diag_type = Full``
+    Names of per-cell diagnostics of particle properties to calculate and output as additional fields.
+    Note that the deposition onto the grid does not respect the particle shape factor, but instead uses nearest-grid point interpolation.
+    Default is none.
+    Parser functions for these field names are specified by ``<diag_name>.particle_fields.<field_name>(x,y,z,ux,uy,uz)``.
+    Also, note that this option is only available for ``<diag_name>.diag_type = Full``
 
 * ``<diag_name>.particle_fields_species`` (list of `strings`, optional)
-         Species for which to calculate ``particle_fields_to_plot``.
-         Fields will be calculated separately for each specified species.
-         The default is a list of all of the available particle species.
+    Species for which to calculate ``particle_fields_to_plot``.
+    Fields will be calculated separately for each specified species.
+    The default is a list of all of the available particle species.
 
 * ``<diag_name>.particle_fields.<field_name>.do_average`` (`0` or `1`) optional (default `1`)
-   Whether the diagnostic is an average or a sum. With an average, the sum over the specified function is divided
-   by the sum of the particle weights in each cell.
+    Whether the diagnostic is an average or a sum. With an average, the sum over the specified function is divided
+    by the sum of the particle weights in each cell.
 
 * ``<diag_name>.particle_fields.<field_name>(x,y,z,ux,uy,uz)`` (parser `string`)
    Parser function to be calculated for each particle per cell. The averaged field written is
@@ -4182,10 +4183,10 @@ Schwinger process
     This feature does not require to compile with ``-DWarpX_QED=ON``.
 
 * ``warpx.quantum_xi`` (`float`; default: 1.3050122.e-52)
-     Overwrites the actual quantum parameter used in Maxwell's QED equations. Assigning a
-     value here will make the simulation unphysical, but will allow QED effects to become more apparent.
-     Note that this option will only have an effect if the ``warpx.use_Hybrid_QED`` flag is also triggered.
-     This feature does not require to compile with ``-DWarpX_QED=ON``.
+    Overwrites the actual quantum parameter used in Maxwell's QED equations. Assigning a
+    value here will make the simulation unphysical, but will allow QED effects to become more apparent.
+    Note that this option will only have an effect if the ``warpx.use_Hybrid_QED`` flag is also triggered.
+    This feature does not require to compile with ``-DWarpX_QED=ON``.
 
 
 Checkpoints and restart