aboutsummaryrefslogtreecommitdiff
path: root/Source/FieldSolver/SpectralSolver
diff options
context:
space:
mode:
authorGravatar Remi Lehe <remi.lehe@normalesup.org> 2019-05-01 08:20:32 -0700
committerGravatar Remi Lehe <remi.lehe@normalesup.org> 2019-05-01 08:20:32 -0700
commite4985aa4188ce6f9605171db2a1c621ecc730e26 (patch)
treedf186acee203e94ee986418c6172bdf921ccf19b /Source/FieldSolver/SpectralSolver
parent91f27c7e814666aed85f505094635128a80dade6 (diff)
downloadWarpX-e4985aa4188ce6f9605171db2a1c621ecc730e26.tar.gz
WarpX-e4985aa4188ce6f9605171db2a1c621ecc730e26.tar.zst
WarpX-e4985aa4188ce6f9605171db2a1c621ecc730e26.zip
Add comments
Diffstat (limited to 'Source/FieldSolver/SpectralSolver')
-rw-r--r--Source/FieldSolver/SpectralSolver/SpectralAlgorithms/SpectralBaseAlgorithm.H5
-rw-r--r--Source/FieldSolver/SpectralSolver/SpectralSolver.cpp6
2 files changed, 9 insertions, 2 deletions
diff --git a/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/SpectralBaseAlgorithm.H b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/SpectralBaseAlgorithm.H
index 18d26e0c8..5c662e533 100644
--- a/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/SpectralBaseAlgorithm.H
+++ b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/SpectralBaseAlgorithm.H
@@ -6,7 +6,10 @@
/* \brief Class that updates the field in spectral space
* and stores the coefficients of the corresponding update equation.
- * TODO: Mention base class
+ *
+ * `SpectralBaseAlgorithm` is only a base class and cannot be used directly.
+ * Instead use its subclasses, which implement the specific field update
+ * equations for a given spectral algorithm.
*/
class SpectralBaseAlgorithm
{
diff --git a/Source/FieldSolver/SpectralSolver/SpectralSolver.cpp b/Source/FieldSolver/SpectralSolver/SpectralSolver.cpp
index 5da39a7c7..c21c3cfb1 100644
--- a/Source/FieldSolver/SpectralSolver/SpectralSolver.cpp
+++ b/Source/FieldSolver/SpectralSolver/SpectralSolver.cpp
@@ -2,7 +2,11 @@
#include <SpectralSolver.H>
#include <PsatdAlgorithm.H>
-/* \brief TODO Description
+/* \brief Initialize the spectral Maxwell solver
+ *
+ * This function selects the spectral algorithm to be used, allocates the
+ * corresponding coefficients for the discretized field update equation,
+ * and prepares the structures that store the fields in spectral space.
*/
SpectralSolver::SpectralSolver(
const amrex::BoxArray& realspace_ba,