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 /Source/FieldSolver/SpectralSolver/SpectralFieldData.H | |
| 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 'Source/FieldSolver/SpectralSolver/SpectralFieldData.H')
| -rw-r--r-- | Source/FieldSolver/SpectralSolver/SpectralFieldData.H | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Source/FieldSolver/SpectralSolver/SpectralFieldData.H b/Source/FieldSolver/SpectralSolver/SpectralFieldData.H index c7848d731..e86348484 100644 --- a/Source/FieldSolver/SpectralSolver/SpectralFieldData.H +++ b/Source/FieldSolver/SpectralSolver/SpectralFieldData.H @@ -41,9 +41,12 @@ class SpectralFieldIndex * * \param[in] update_with_rho whether rho is used in the field update equations * \param[in] time_averaging whether the time averaging algorithm is used - * \param[in] do_multi_J whether the multi-J algorithm is used (hence two currents + * \param[in] J_in_time the multi-J algorithm used (hence two currents * computed at the beginning and the end of the time interval * instead of one current computed at half time) + * \param[in] rho_in_time the multi-rho algorithm used (hence two densities + * computed at the beginning and the end of the time interval + * instead of one density computed at half time) * \param[in] dive_cleaning whether to use div(E) cleaning to account for errors in * Gauss law (new field F in the update equations) * \param[in] divb_cleaning whether to use div(B) cleaning to account for errors in |