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/developers/fields.rst | |
| 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/developers/fields.rst')
| -rw-r--r-- | Docs/source/developers/fields.rst | 4 |
1 files changed, 3 insertions, 1 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |