diff options
| author |  Davide Terzani <titoiride@gmail.com>
| 2023-02-21 09:05:16 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-02-21 09:05:16 -0800 |
| commit | 8f31cea2a47749ca697b64a93837842f990312ed (patch) | |
| tree | 155ec4b9d31063b407797203c2fa7202117ecd4c /Docs/source/usage/parameters.rst | |
| parent | 7eae30870646a2efbdf9164d46c75e540251e5f0 (diff) | |
| download | WarpX-8f31cea2a47749ca697b64a93837842f990312ed.tar.gz WarpX-8f31cea2a47749ca697b64a93837842f990312ed.tar.zst WarpX-8f31cea2a47749ca697b64a93837842f990312ed.zip | |
Renamed "particle_vel" to "particle_mom" (#3672)
* Renamed particle_vel to particle_mom
* Changed vel to u
* Updated gitignore with vscode-specific folder
* Updated docs for single particle
* Revert "Updated gitignore with vscode-specific folder"
This reverts commit cb44ef8d66c123daa93d6a13d5a1d88416e866bb.
* Fixed typo
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Fixed other typo
* Add species indication in warning
---------
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 | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index dc58bc071..84990e698 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -654,7 +654,7 @@ Particle initialization * ``SingleParticle``: Inject a single macroparticle. This requires the additional parameters: ``<species_name>.single_particle_pos`` (`3 doubles`, particle 3D position [meter]) - ``<species_name>.single_particle_vel`` (`3 doubles`, particle 3D normalized momentum, i.e. :math:`\gamma \beta`) + ``<species_name>.single_particle_u`` (`3 doubles`, particle 3D normalized momentum, i.e. :math:`\gamma \beta`) ``<species_name>.single_particle_weight`` ( `double`, macroparticle weight, i.e. number of physical particles it represents) * ``MultipleParticles``: Inject multiple macroparticles. @@ -662,9 +662,9 @@ Particle initialization ``<species_name>.multiple_particles_pos_x`` (list of `doubles`, X positions of the particles [meter]) ``<species_name>.multiple_particles_pos_y`` (list of `doubles`, Y positions of the particles [meter]) ``<species_name>.multiple_particles_pos_z`` (list of `doubles`, Z positions of the particles [meter]) - ``<species_name>.multiple_particles_vel_x`` (list of `doubles`, X normalized momenta of the particles, i.e. :math:`\gamma \beta_x`) - ``<species_name>.multiple_particles_vel_y`` (list of `doubles`, Y normalized momenta of the particles, i.e. :math:`\gamma \beta_y`) - ``<species_name>.multiple_particles_vel_z`` (list of `doubles`, Z normalized momenta of the particles, i.e. :math:`\gamma \beta_z`) + ``<species_name>.multiple_particles_ux`` (list of `doubles`, X normalized momenta of the particles, i.e. :math:`\gamma \beta_x`) + ``<species_name>.multiple_particles_uy`` (list of `doubles`, Y normalized momenta of the particles, i.e. :math:`\gamma \beta_y`) + ``<species_name>.multiple_particles_uz`` (list of `doubles`, Z normalized momenta of the particles, i.e. :math:`\gamma \beta_z`) ``<species_name>.multiple_particles_weight`` (list of `doubles`, macroparticle weights, i.e. number of physical particles each represents) * ``gaussian_beam``: Inject particle beam with gaussian distribution in |