diff options
| author |  Ilian Kara-Mostefa <95044023+IlianCS@users.noreply.github.com>
| 2023-08-14 13:57:59 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-08-14 13:57:59 -0700 |
| commit | 1b58d52a8ab84ccfce1a992c5d5d65f2aea97a0e (patch) | |
| tree | 0c17310c7ac45cf26b80eac983824c7c19081e02 /Docs/source/usage/parameters.rst | |
| parent | 721181539fb4f074d11b878e448202178bee87b2 (diff) | |
| download | WarpX-1b58d52a8ab84ccfce1a992c5d5d65f2aea97a0e.tar.gz WarpX-1b58d52a8ab84ccfce1a992c5d5d65f2aea97a0e.tar.zst WarpX-1b58d52a8ab84ccfce1a992c5d5d65f2aea97a0e.zip | |
t_lab optionally imposed for externally loaded species in the boosted frame (#4153)
* added guidelines
* added impose t_lab from file as an option
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* removed unused comment
* fixed unconsistent variable type
* removed space
* rearranged code changes
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Diffstat (limited to 'Docs/source/usage/parameters.rst')
| -rw-r--r-- | Docs/source/usage/parameters.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index 87c2ca16f..6522d1b72 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -717,6 +717,7 @@ Particle initialization ``<species_name>.charge`` (`double`) optional (default is read from openPMD file) when set this will be the charge of the physical particle represented by the injected macroparticles. ``<species_name>.mass`` (`double`) optional (default is read from openPMD file) when set this will be the charge of the physical particle represented by the injected macroparticles. ``<species_name>.z_shift`` (`double`) optional (default is no shift) when set this value will be added to the longitudinal, ``z``, position of the particles. + ``<species_name>.impose_t_lab_from_file`` (`bool`) optional (default is false) only read if warpx.gamma_boost > 1., it allows to set t_lab for the Lorentz Transform as being the time stored in the openPMD file. Warning: ``q_tot!=0`` is not supported with the ``external_file`` injection style. If a value is provided, it is ignored and no re-scaling is done. The external file must include the species ``openPMD::Record`` labeled ``position`` and ``momentum`` (`double` arrays), with dimensionality and units set via ``openPMD::setUnitDimension`` and ``setUnitSI``. If the external file also contains ``openPMD::Records`` for ``mass`` and ``charge`` (constant `double` scalars) then the species will use these, unless overwritten in the input file (see ``<species_name>.mass``, ``<species_name>.charge`` or ``<species_name>.species_type``). |