aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp/parameters.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Docs/source/running_cpp/parameters.rst')
-rw-r--r--Docs/source/running_cpp/parameters.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index e0a0ac2b2..96ec75c05 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -208,6 +208,15 @@ Particle initialization
Inject a backward-propagating beam to reduce the effect of charge-separation
fields when running in the boosted frame. See examples.
+* ``<species_name>.do_splitting`` (`bool`) optional (default `0`)
+ Split particles of the species when crossing the boundary from a lower
+ resolution domain to a higher resolution domain.
+
+* ``<species_name>.split_type`` (`int`) optional (default `0`)
+ Splitting technique. When `0`, particles are split along the simulation
+ axes (4 particles in 2D, 6 particles in 3D). When `1`, particles are split
+ along the diagonals (4 particles in 2D, 8 particles in 3D).
+
* ``warpx.serialize_ics`` (`0 or 1`)
Whether or not to use OpenMP threading for particle initialization.
@@ -392,6 +401,7 @@ Numerics and algorithms
- ``0``: Vectorized version
- ``1``: Non-optimized version
+
.. warning::
The vectorized version does not run on GPU. Use