diff options
| author |  Remi Lehe <remi.lehe@normalesup.org>
| 2019-05-01 08:20:32 -0700 |
|---|---|---|
| committer | Remi Lehe <remi.lehe@normalesup.org>
| 2019-05-01 08:20:32 -0700 |
| commit | e4985aa4188ce6f9605171db2a1c621ecc730e26 (patch) | |
| tree | df186acee203e94ee986418c6172bdf921ccf19b /Source/FieldSolver/SpectralSolver/SpectralAlgorithms | |
| parent | 91f27c7e814666aed85f505094635128a80dade6 (diff) | |
| download | WarpX-e4985aa4188ce6f9605171db2a1c621ecc730e26.tar.gz WarpX-e4985aa4188ce6f9605171db2a1c621ecc730e26.tar.zst WarpX-e4985aa4188ce6f9605171db2a1c621ecc730e26.zip | |
Add comments
Diffstat (limited to 'Source/FieldSolver/SpectralSolver/SpectralAlgorithms')
| -rw-r--r-- | Source/FieldSolver/SpectralSolver/SpectralAlgorithms/SpectralBaseAlgorithm.H | 5 |
1 files changed, 4 insertions, 1 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 { |