From c3eb6ea1efeff3910e8520d94e260d94367d68f7 Mon Sep 17 00:00:00 2001 From: David Grote Date: Mon, 19 Dec 2022 05:43:16 -0800 Subject: Clean up documentation (#3542) * Fix comments for documentation * More fixes to comments for documentation * Fixes in the doc files * Fix typo in parameters.rst --- Source/FieldSolver/SpectralSolver/SpectralFieldData.H | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'Source/FieldSolver/SpectralSolver/SpectralFieldData.H') 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 -- cgit v1.2.3