Preparing for multigrid parameter consolidation and clean up of code, rationalise the different variants.

tests/solver/Test_multigrid_common.h

@@ -37,9 +37,9 @@ Zero zero;
 // serialization strategy of Grid?
 
 // clang-format off
-struct MultiGridParams : Serializable {
+struct WilsonMGParams : Serializable {
 public:
-  GRID_SERIALIZABLE_CLASS_MEMBERS(MultiGridParams,
+  GRID_SERIALIZABLE_CLASS_MEMBERS(WilsonMGParams,
                                   int,                           nLevels,
                                   std::vector<std::vector<int>>, blockSizes,           // size == nLevels - 1
                                   std::vector<double>,           smootherTol,          // size == nLevels - 1
@@ -54,7 +54,7 @@ public:
                                   int,                           coarseSolverMaxInnerIter);
 
   // constructor with default values
-  MultiGridParams(int                           _nLevels                  = 2,
+  WilsonMGParams(int                           _nLevels                  = 2,
                   std::vector<std::vector<int>> _blockSizes               = {{4, 4, 4, 4}},
                   std::vector<double>           _smootherTol              = {1e-14},
                   std::vector<int>              _smootherMaxOuterIter     = {4},
@@ -82,7 +82,7 @@ public:
 };
 // clang-format on
 
-void checkParameterValidity(MultiGridParams const &params) {
+void checkParameterValidity(WilsonMGParams const &params) {
 
   auto correctSize = params.nLevels - 1;
 
@@ -101,7 +101,7 @@ public:
   std::vector<GridCartesian *>  Grids;
   std::vector<GridParallelRNG>  PRNGs;
 
-  LevelInfo(GridCartesian *FineGrid, MultiGridParams const &mgParams) {
+  LevelInfo(GridCartesian *FineGrid, WilsonMGParams const &mgParams) {
 
     auto nCoarseLevels = mgParams.blockSizes.size();
 
@@ -176,7 +176,7 @@ public:
   int _CurrentLevel;
   int _NextCoarserLevel;
 
-  MultiGridParams &_MultiGridParams;
+  WilsonMGParams &_WilsonMGParams;
   LevelInfo &      _LevelInfo;
 
   FineDiracMatrix & _FineMatrix;
@@ -201,10 +201,10 @@ public:
   // Member Functions
   /////////////////////////////////////////////
 
-  MultiGridPreconditioner(MultiGridParams &mgParams, LevelInfo &LvlInfo, FineDiracMatrix &FineMat, FineDiracMatrix &SmootherMat)
+  MultiGridPreconditioner(WilsonMGParams &mgParams, LevelInfo &LvlInfo, FineDiracMatrix &FineMat, FineDiracMatrix &SmootherMat)
     : _CurrentLevel(mgParams.nLevels - (nCoarserLevels + 1)) // _Level = 0 corresponds to finest
     , _NextCoarserLevel(_CurrentLevel + 1)                   // incremented for instances on coarser levels
-    , _MultiGridParams(mgParams)
+    , _WilsonMGParams(mgParams)
     , _LevelInfo(LvlInfo)
     , _FineMatrix(FineMat)
     , _SmootherMatrix(SmootherMat)
@@ -212,7 +212,7 @@ public:
     , _CoarseMatrix(*_LevelInfo.Grids[_NextCoarserLevel]) {
 
     _NextPreconditionerLevel
-      = std::unique_ptr<NextPreconditionerLevel>(new NextPreconditionerLevel(_MultiGridParams, _LevelInfo, _CoarseMatrix, _CoarseMatrix));
+      = std::unique_ptr<NextPreconditionerLevel>(new NextPreconditionerLevel(_WilsonMGParams, _LevelInfo, _CoarseMatrix, _CoarseMatrix));
 
     resetTimers();
   }
@@ -261,7 +261,7 @@ public:
     conformable(in, out);
 
     // TODO: implement a W-cycle
-    if(_MultiGridParams.kCycle)
+    if(_WilsonMGParams.kCycle)
       kCycle(in, out);
     else
       vCycle(in, out);
@@ -279,13 +279,13 @@ public:
 
     FineVector fineTmp(in.Grid());
 
-    auto maxSmootherIter = _MultiGridParams.smootherMaxOuterIter[_CurrentLevel] * _MultiGridParams.smootherMaxInnerIter[_CurrentLevel];
+    auto maxSmootherIter = _WilsonMGParams.smootherMaxOuterIter[_CurrentLevel] * _WilsonMGParams.smootherMaxInnerIter[_CurrentLevel];
 
     TrivialPrecon<FineVector>                      fineTrivialPreconditioner;
-    FlexibleGeneralisedMinimalResidual<FineVector> fineFGMRES(_MultiGridParams.smootherTol[_CurrentLevel],
+    FlexibleGeneralisedMinimalResidual<FineVector> fineFGMRES(_WilsonMGParams.smootherTol[_CurrentLevel],
                                                               maxSmootherIter,
                                                               fineTrivialPreconditioner,
-                                                              _MultiGridParams.smootherMaxInnerIter[_CurrentLevel],
+                                                              _WilsonMGParams.smootherMaxInnerIter[_CurrentLevel],
                                                               false);
 
     MdagMLinearOperator<FineDiracMatrix, FineVector> fineMdagMOp(_FineMatrix);
@@ -336,19 +336,19 @@ public:
 
     FineVector fineTmp(in.Grid());
 
-    auto smootherMaxIter = _MultiGridParams.smootherMaxOuterIter[_CurrentLevel] * _MultiGridParams.smootherMaxInnerIter[_CurrentLevel];
-    auto kCycleMaxIter   = _MultiGridParams.kCycleMaxOuterIter[_CurrentLevel] * _MultiGridParams.kCycleMaxInnerIter[_CurrentLevel];
+    auto smootherMaxIter = _WilsonMGParams.smootherMaxOuterIter[_CurrentLevel] * _WilsonMGParams.smootherMaxInnerIter[_CurrentLevel];
+    auto kCycleMaxIter   = _WilsonMGParams.kCycleMaxOuterIter[_CurrentLevel] * _WilsonMGParams.kCycleMaxInnerIter[_CurrentLevel];
 
     TrivialPrecon<FineVector>                        fineTrivialPreconditioner;
-    FlexibleGeneralisedMinimalResidual<FineVector>   fineFGMRES(_MultiGridParams.smootherTol[_CurrentLevel],
+    FlexibleGeneralisedMinimalResidual<FineVector>   fineFGMRES(_WilsonMGParams.smootherTol[_CurrentLevel],
                                                               smootherMaxIter,
                                                               fineTrivialPreconditioner,
-                                                              _MultiGridParams.smootherMaxInnerIter[_CurrentLevel],
+                                                              _WilsonMGParams.smootherMaxInnerIter[_CurrentLevel],
                                                               false);
-    FlexibleGeneralisedMinimalResidual<CoarseVector> coarseFGMRES(_MultiGridParams.kCycleTol[_CurrentLevel],
+    FlexibleGeneralisedMinimalResidual<CoarseVector> coarseFGMRES(_WilsonMGParams.kCycleTol[_CurrentLevel],
                                                                   kCycleMaxIter,
                                                                   *_NextPreconditionerLevel,
-                                                                  _MultiGridParams.kCycleMaxInnerIter[_CurrentLevel],
+                                                                  _WilsonMGParams.kCycleMaxInnerIter[_CurrentLevel],
                                                                   false);
 
     MdagMLinearOperator<FineDiracMatrix, FineVector>     fineMdagMOp(_FineMatrix);
@@ -581,7 +581,7 @@ public:
 
   int _CurrentLevel;
 
-  MultiGridParams &_MultiGridParams;
+  WilsonMGParams &_WilsonMGParams;
   LevelInfo &      _LevelInfo;
 
   FineDiracMatrix &_FineMatrix;
@@ -594,9 +594,9 @@ public:
   // Member Functions
   /////////////////////////////////////////////
 
-  MultiGridPreconditioner(MultiGridParams &mgParams, LevelInfo &LvlInfo, FineDiracMatrix &FineMat, FineDiracMatrix &SmootherMat)
+  MultiGridPreconditioner(WilsonMGParams &mgParams, LevelInfo &LvlInfo, FineDiracMatrix &FineMat, FineDiracMatrix &SmootherMat)
     : _CurrentLevel(mgParams.nLevels - (0 + 1))
-    , _MultiGridParams(mgParams)
+    , _WilsonMGParams(mgParams)
     , _LevelInfo(LvlInfo)
     , _FineMatrix(FineMat)
     , _SmootherMatrix(SmootherMat) {
@@ -613,12 +613,12 @@ public:
     conformable(_LevelInfo.Grids[_CurrentLevel], in.Grid());
     conformable(in, out);
 
-    auto coarseSolverMaxIter = _MultiGridParams.coarseSolverMaxOuterIter * _MultiGridParams.coarseSolverMaxInnerIter;
+    auto coarseSolverMaxIter = _WilsonMGParams.coarseSolverMaxOuterIter * _WilsonMGParams.coarseSolverMaxInnerIter;
 
     // On the coarsest level we only have what I above call the fine level, no coarse one
     TrivialPrecon<FineVector>                      fineTrivialPreconditioner;
     FlexibleGeneralisedMinimalResidual<FineVector> fineFGMRES(
-      _MultiGridParams.coarseSolverTol, coarseSolverMaxIter, fineTrivialPreconditioner, _MultiGridParams.coarseSolverMaxInnerIter, false);
+      _WilsonMGParams.coarseSolverTol, coarseSolverMaxIter, fineTrivialPreconditioner, _WilsonMGParams.coarseSolverMaxInnerIter, false);
 
     MdagMLinearOperator<FineDiracMatrix, FineVector> fineMdagMOp(_FineMatrix);
 
@@ -651,7 +651,7 @@ using NLevelMGPreconditioner = MultiGridPreconditioner<Fobj, CComplex, nBasis, n
 
 template<class Fobj, class CComplex, int nBasis, class Matrix>
 std::unique_ptr<MultiGridPreconditionerBase<Lattice<Fobj>>>
-createMGInstance(MultiGridParams &mgParams, LevelInfo &levelInfo, Matrix &FineMat, Matrix &SmootherMat) {
+createMGInstance(WilsonMGParams &mgParams, LevelInfo &levelInfo, Matrix &FineMat, Matrix &SmootherMat) {
 
 #define CASE_FOR_N_LEVELS(nLevels)                                                                                     \
   case nLevels:                                                                                                        \

tests/solver/Test_wilson_mg.cc

@@ -51,7 +51,7 @@ int main(int argc, char **argv) {
 
   RealD mass = -0.25;
 
-  MultiGridParams mgParams;
+  WilsonMGParams mgParams;
   std::string     inputXml{"./mg_params.xml"};
 
   if(GridCmdOptionExists(argv, argv + argc, "--inputxml")) {

tests/solver/Test_wilson_mg_mp.cc

@@ -58,7 +58,7 @@ int main(int argc, char **argv) {
 
   RealD mass = -0.25;
 
-  MultiGridParams mgParams;
+  WilsonMGParams mgParams;
   std::string     inputXml{"./mg_params.xml"};
 
   if(GridCmdOptionExists(argv, argv + argc, "--inputxml")) {

tests/solver/Test_wilsonclover_mg.cc

@@ -54,7 +54,7 @@ int main(int argc, char **argv) {
   RealD csw_r = 1.0;
   RealD csw_t = 1.0;
 
-  MultiGridParams mgParams;
+  WilsonMGParams mgParams;
   std::string     inputXml{"./mg_params.xml"};
 
   if(GridCmdOptionExists(argv, argv + argc, "--inputxml")) {

tests/solver/Test_wilsonclover_mg_lime.cc

@@ -84,7 +84,7 @@ int main(int argc, char **argv) {
   RealD csw_r = 1.0;
   RealD csw_t = 1.0;
 
-  MultiGridParams mgParams;
+  WilsonMGParams mgParams;
   std::string     inputXml{"./mg_params.xml"};
 
   if(GridCmdOptionExists(argv, argv + argc, "--inputxml")) {

tests/solver/Test_wilsonclover_mg_mp.cc

@@ -60,7 +60,7 @@ int main(int argc, char **argv) {
   RealD csw_r = 1.0;
   RealD csw_t = 1.0;
 
-  MultiGridParams mgParams;
+  WilsonMGParams mgParams;
   std::string     inputXml{"./mg_params.xml"};
 
   if(GridCmdOptionExists(argv, argv + argc, "--inputxml")) {