Spectral Index: Replace `struct`s of `enum` with Class (#2062)

* Add New Spectral Index Class

* Cleaning

* Use New Spectral Index Class in PML

* Cleaning

* Reuse Available Data for divE

* Allocate Rho Data Only when Necessary

* Cleaning

* Fix Bug in RZ Geometry

* Revert Commits for Allocation of Rho Data

* Cleaning

* Update Forward Declaration Header

* Do Not Include Unnecessary Header Files

* Doxygen

* Do Not Use Separate div() Cleaning Flags

* SpectralFieldIndex: Add Missing param to Doxygen

* Remove Unused getRequiredNumberOfFields

1 files changed, 14 insertions, 12 deletions

diff --git a/Source/FieldSolver/SpectralSolver/SpectralSolver.H b/Source/FieldSolver/SpectralSolver/SpectralSolver.H
index 45ba1a193..50b9978f4 100644
--- a/Source/FieldSolver/SpectralSolver/SpectralSolver.H
+++ b/Source/FieldSolver/SpectralSolver/SpectralSolver.H
@@ -60,11 +60,11 @@ class SpectralSolver
          * \param[in] fft_do_time_averaging whether the time averaging algorithm is used
          * \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
-         *                             compute 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 field update equations)
-         * \param[in] divb_cleaning whether to use div(B) cleaning to account for errors in magnetic Gauss law
-         *                          (new field G in the field update equations)
+         *                             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
+         *                          div(B) = 0 law (new field G in the update equations)
          */
         SpectralSolver (const int lev,
                         const amrex::BoxArray& realspace_ba,
@@ -76,13 +76,13 @@ class SpectralSolver
                         const amrex::Array<amrex::Real,3>& v_comoving,
                         const amrex::RealVect dx,
                         const amrex::Real dt,
-                        const bool pml = false,
-                        const bool periodic_single_box = false,
-                        const bool update_with_rho = false,
-                        const bool fft_do_time_averaging = false,
-                        const bool J_linear_in_time = false,
-                        const bool dive_cleaning = false,
-                        const bool divb_cleaning = false);
+                        const bool pml,
+                        const bool periodic_single_box,
+                        const bool update_with_rho,
+                        const bool fft_do_time_averaging,
+                        const bool J_linear_in_time,
+                        const bool dive_cleaning,
+                        const bool divb_cleaning);
 
         /**
          * \brief Transform the component `i_comp` of MultiFab `mf`
@@ -185,6 +185,8 @@ class SpectralSolver
             field_data.fields.mult(scale_factor, icomp, 1);
         }
 
+        SpectralFieldIndex m_spectral_index;
+
     protected:
 
         amrex::IntVect m_fill_guards;