aboutsummaryrefslogtreecommitdiff
path: root/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H
diff options
context:
space:
mode:
Diffstat (limited to 'Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H')
-rw-r--r--Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H5
1 files changed, 5 insertions, 0 deletions
diff --git a/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H
index 954c313ee..41053fc9e 100644
--- a/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H
+++ b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H
@@ -38,12 +38,15 @@ class PsatdAlgorithm : public SpectralBaseAlgorithm
* \param[in] norder_y order of the spectral solver along y
* \param[in] norder_z order of the spectral solver along z
* \param[in] nodal whether the E and B fields are defined on a fully nodal grid or a Yee grid
+ * \param[in] fill_guards Update the guard cells (in addition to the valid cells) when pushing the fields in time
* \param[in] v_galilean Galilean velocity (three-dimensional array)
* \param[in] dt time step of the simulation
* \param[in] update_with_rho whether the update equation for E uses rho or not
* \param[in] time_averaging whether to use time averaging for large time steps
* \param[in] J_linear_in_time whether to use two currents computed at the beginning and the end
* of the time interval (instead of using one current computed at half time)
+ * \param[in] dive_cleaning Update F as part of the field update, so that errors in divE=rho propagate away at the speed of light
+ * \param[in] divb_cleaning Update G as part of the field update, so that errors in divB=0 propagate away at the speed of light
*/
PsatdAlgorithm (
const SpectralKSpace& spectral_kspace,
@@ -114,6 +117,7 @@ class PsatdAlgorithm : public SpectralBaseAlgorithm
* base class \c SpectralBaseAlgorithm and cannot be overridden by further
* derived classes.
*
+ * \param[in] lev The mesh-refinement level
* \param[in,out] field_data All fields in Fourier space
* \param[in,out] current Array of unique pointers to \c MultiFab storing
* the three components of the current density
@@ -132,6 +136,7 @@ class PsatdAlgorithm : public SpectralBaseAlgorithm
* base class \c SpectralBaseAlgorithm and cannot be overridden by further
* derived classes.
*
+ * \param[in] lev The mesh-refinement level
* \param[in,out] field_data All fields in Fourier space
* \param[in,out] current Array of unique pointers to \c MultiFab storing
* the three components of the current density