aboutsummaryrefslogtreecommitdiff
path: root/Source/FieldSolver/SpectralSolver/PsatdAlgorithm.H
diff options
context:
space:
mode:
Diffstat (limited to 'Source/FieldSolver/SpectralSolver/PsatdAlgorithm.H')
-rw-r--r--Source/FieldSolver/SpectralSolver/PsatdAlgorithm.H7
1 files changed, 4 insertions, 3 deletions
diff --git a/Source/FieldSolver/SpectralSolver/PsatdAlgorithm.H b/Source/FieldSolver/SpectralSolver/PsatdAlgorithm.H
index 16d27cab2..acefcc466 100644
--- a/Source/FieldSolver/SpectralSolver/PsatdAlgorithm.H
+++ b/Source/FieldSolver/SpectralSolver/PsatdAlgorithm.H
@@ -4,8 +4,9 @@
#include <SpectralKSpace.H>
#include <SpectralFieldData.H>
-/* TODO: Write documentation
-*/
+/* \brief Class that updates the field in spectral space
+ * and stores the coefficients of the corresponding update equation.
+ */
class PsatdAlgorithm
{
using SpectralCoefficients = amrex::FabArray< amrex::BaseFab <amrex::Real> >;
@@ -16,7 +17,7 @@ class PsatdAlgorithm
const int norder_x, const int norder_y,
const int norder_z, const bool nodal, const amrex::Real dt);
PsatdAlgorithm() = default; // Default constructor
- PsatdAlgorithm& operator=(PsatdAlgorithm&& algorithm) = default; // Default move assignment
+ PsatdAlgorithm& operator=(PsatdAlgorithm&& algorithm) = default;
void pushSpectralFields(SpectralFieldData& f) const;
private: