diff options
| author |  David Grote <grote1@llnl.gov>
| 2022-12-19 05:43:16 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-12-19 14:43:16 +0100 |
| commit | c3eb6ea1efeff3910e8520d94e260d94367d68f7 (patch) | |
| tree | af59d4a61a92fc602ca224e0fdd45685960de433 /Docs/source/usage | |
| parent | 4913d07348eeed38263745a47ffe3a9f9a680076 (diff) | |
| download | WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.tar.gz WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.tar.zst WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.zip | |
Clean up documentation (#3542)
* Fix comments for documentation
* More fixes to comments for documentation
* Fixes in the doc files
* Fix typo in parameters.rst
Diffstat (limited to 'Docs/source/usage')
| -rw-r--r-- | Docs/source/usage/parameters.rst | 2 | ||||
| -rw-r--r-- | Docs/source/usage/python.rst | 12 |
2 files changed, 1 insertions, 13 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index 36855a52d..22f01196a 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -766,7 +766,7 @@ Particle initialization * ``maxwell_boltzmann``: Maxwell-Boltzmann distribution that takes a dimensionless temperature parameter :math:`\theta` as an input, where :math:`\theta = \frac{k_\mathrm{B} \cdot T}{m \cdot c^2}`, - "math:`T` is the temperature in Kelvin, :math:`k_\mathrm{B}` is the Boltzmann constant, :math:`c` is the speed of light, and :math:`m` is the mass of the species. + :math:`T` is the temperature in Kelvin, :math:`k_\mathrm{B}` is the Boltzmann constant, :math:`c` is the speed of light, and :math:`m` is the mass of the species. Theta is specified by a combination of ``<species_name>.theta_distribution_type``, ``<species_name>.theta``, and ``<species_name>.theta_function(x,y,z)`` (see below). For values of :math:`\theta > 0.01`, errors due to ignored relativistic terms exceed 1%. Temperatures less than zero are not allowed. diff --git a/Docs/source/usage/python.rst b/Docs/source/usage/python.rst index f42a5cf57..d5af350b7 100644 --- a/Docs/source/usage/python.rst +++ b/Docs/source/usage/python.rst @@ -102,10 +102,6 @@ ElectrostaticFieldDiagnostic Lab-frame diagnostics diagnostics are used when running boosted-frame simulations. -LabFrameParticleDiagnostic -"""""""""""""""""""""""""" -.. autoclass:: pywarpx.picmi.LabFrameParticleDiagnostic - LabFrameFieldDiagnostic """"""""""""""""""""""" .. autoclass:: pywarpx.picmi.LabFrameFieldDiagnostic @@ -258,12 +254,6 @@ simulation objects (particles, fields and memory buffers) as well as general pro .. autofunction:: pywarpx.picmi.Simulation.extension.finalize -.. autofunction:: pywarpx.picmi.Simulation.extension.getistep - -.. autofunction:: pywarpx.picmi.Simulation.extension.gett_new - -.. autofunction:: pywarpx.picmi.Simulation.extension.evolve - .. autofunction:: pywarpx.picmi.Simulation.extension.getProbLo .. autofunction:: pywarpx.picmi.Simulation.extension.getProbHi @@ -309,8 +299,6 @@ with scraped particle data. .. autofunction:: pywarpx.picmi.Simulation.extension.get_particle_boundary_buffer_size -.. autofunction:: pywarpx.picmi.Simulation.extension.get_particle_boundary_buffer_size - .. autofunction:: pywarpx.picmi.Simulation.extension.get_particle_boundary_buffer_structs .. autofunction:: pywarpx.picmi.Simulation.extension.get_particle_boundary_buffer |