diff options
Diffstat (limited to 'Docs')
| -rw-r--r-- | Docs/source/developers/fields.rst | 4 | ||||
| -rw-r--r-- | Docs/source/index.rst | 1 | ||||
| -rw-r--r-- | Docs/source/usage/parameters.rst | 2 | ||||
| -rw-r--r-- | Docs/source/usage/python.rst | 12 |
4 files changed, 4 insertions, 15 deletions
diff --git a/Docs/source/developers/fields.rst b/Docs/source/developers/fields.rst index b40bb750e..af834354d 100644 --- a/Docs/source/developers/fields.rst +++ b/Docs/source/developers/fields.rst @@ -112,7 +112,9 @@ Bilinear filter The multi-pass bilinear filter (applied on the current density) is implemented in ``Source/Filter/``, and class ``WarpX`` holds an instance of this class in member variable ``WarpX::bilinear_filter``. For performance reasons (to avoid creating too many guard cells), this filter is directly applied in communication routines, see ``WarpX::AddCurrentFromFineLevelandSumBoundary`` above and -.. doxygenfunction:: WarpX::ApplyFilterandSumBoundaryJ +.. doxygenfunction:: WarpX::ApplyFilterJ(const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>, 3>> ¤t, const int lev, const int idim) + +.. doxygenfunction:: WarpX::SumBoundaryJ(const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>, 3>> ¤t, const int lev, const int idim, const amrex::Periodicity &period) Godfrey's anti-NCI filter for FDTD simulations ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/Docs/source/index.rst b/Docs/source/index.rst index c1755f44f..ad9719d90 100644 --- a/Docs/source/index.rst +++ b/Docs/source/index.rst @@ -98,7 +98,6 @@ Data Analysis dataanalysis/visit dataanalysis/visualpic dataanalysis/picviewer - dataanalysis/backtransformed_diags dataanalysis/reduced_diags Theory 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 |