From 7fdde885fee52173ebaf7d5e5e66fb7fab42482c Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Fri, 12 Aug 2022 18:44:52 +0100
Subject: [PATCH] fvCellSet: The selectionMode entry is now optional

Description
    General cell set selection class for models that apply to sub-sets
    of the mesh.

    Currently supports cell selection from a set of points, a specified cellSet
    or cellZone or all of the cells.  The selection method can either be
    specified explicitly using the \c selectionMode entry or inferred from the
    presence of either a \c cellSet, \c cellZone or \c points entry.  The \c
    selectionMode entry is required to select \c all cells.

Usage
    Examples:
    \verbatim
        // Apply everywhere
        selectionMode   all;

        // Apply within a given cellSet
        selectionMode   cellSet; // Optional
        cellSet         rotor;

        // Apply within a given cellZone
        selectionMode   cellZone; // Optional
        cellSet         rotor;

        // Apply in cells containing a list of points
        selectionMode   points; // Optional
        points
        (
            (2.25 0.5 0)
            (2.75 0.5 0)
        );
    \endverbatim

All tutorials updated and simplified.
---
 .../functions/Function1/omega/omega.H         |   2 +-
 .../solidBodyMotionSolver.C                   |   6 +-
 .../cfdTools/general/MRF/MRFZone.C            |   2 +-
 src/finiteVolume/fvMesh/fvCellSet/fvCellSet.C | 133 ++++++++----------
 src/finiteVolume/fvMesh/fvCellSet/fvCellSet.H |  59 +++-----
 .../angledDuctImplicit/system/fvConstraints   |   1 -
 .../reverseBurner/system/gas/fvConstraints    |   1 -
 .../fluid/angledDuct/constant/fvModels        |   1 -
 .../constant/fvModels                         |   1 -
 .../system/fvConstraints                      |   2 -
 .../fluid/angledDuctLTS/constant/fvModels     |   1 -
 .../fluid/mixerVessel2DMRF/constant/fvModels  |   1 -
 .../porousBlockage/constant/fvModels          |   1 -
 .../rotorDisk/constant/fvModels               |   1 -
 .../turbineSiting/constant/fvModels           |   2 -
 .../filter/constant/fvModels                  |   2 -
 .../simplifiedSiwek/system/fvConstraints      |   1 -
 .../RAS/angledDuct/constant/fvModels          |   1 -
 .../RAS/bubblePipe/constant/fvModels          |   1 -
 .../laminar/bed/constant/fvModels             |   1 -
 .../laminar/injection/constant/fvModels       |   1 -
 .../laminar/steamInjection/constant/fvModels  |   1 -
 22 files changed, 83 insertions(+), 139 deletions(-)

diff --git a/src/OpenFOAM/primitives/functions/Function1/omega/omega.H b/src/OpenFOAM/primitives/functions/Function1/omega/omega.H
index 468a4f109d..ea67b36dc4 100644
--- a/src/OpenFOAM/primitives/functions/Function1/omega/omega.H
+++ b/src/OpenFOAM/primitives/functions/Function1/omega/omega.H
@@ -50,7 +50,7 @@ Usage
             origin     (0 0 0);
             axis       (0 0 1);
 
-            rpm        6.28319;
+            omega      6.28319;
         }
     \endverbatim
     or for a tabulated ramped rotational speed of a solid body:
diff --git a/src/dynamicMesh/motionSolvers/displacement/solidBody/solidBodyMotionSolver/solidBodyMotionSolver.C b/src/dynamicMesh/motionSolvers/displacement/solidBody/solidBodyMotionSolver/solidBodyMotionSolver.C
index 6ddf5e030b..d753558dfa 100644
--- a/src/dynamicMesh/motionSolvers/displacement/solidBody/solidBodyMotionSolver/solidBodyMotionSolver.C
+++ b/src/dynamicMesh/motionSolvers/displacement/solidBody/solidBodyMotionSolver/solidBodyMotionSolver.C
@@ -61,10 +61,10 @@ Foam::solidBodyMotionSolver::solidBodyMotionSolver
     moveAllCells_(false),
     transform_(SBMFPtr_().transformation())
 {
-    word cellZoneName =
+    const word cellZoneName =
         coeffDict().lookupOrDefault<word>("cellZone", "none");
 
-    word cellSetName =
+    const word cellSetName =
         coeffDict().lookupOrDefault<word>("cellSet", "none");
 
     if ((cellZoneName != "none") && (cellSetName != "none"))
@@ -105,7 +105,7 @@ Foam::solidBodyMotionSolver::solidBodyMotionSolver
         cellIDs = set.toc();
     }
 
-    label nCells = returnReduce(cellIDs.size(), sumOp<label>());
+    const label nCells = returnReduce(cellIDs.size(), sumOp<label>());
     moveAllCells_ = nCells == 0;
 
     if (moveAllCells_)
diff --git a/src/finiteVolume/cfdTools/general/MRF/MRFZone.C b/src/finiteVolume/cfdTools/general/MRF/MRFZone.C
index 6b04123969..dea0dc6d18 100644
--- a/src/finiteVolume/cfdTools/general/MRF/MRFZone.C
+++ b/src/finiteVolume/cfdTools/general/MRF/MRFZone.C
@@ -222,7 +222,7 @@ Foam::MRFZone::MRFZone
     mesh_(mesh),
     name_(name),
     coeffs_(dict),
-    cellSet_(mesh, coeffs_, fvCellSet::selectionModeType::cellZone),
+    cellSet_(mesh, coeffs_),
     origin_(coeffs_.lookup("origin")),
     axis_(coeffs_.lookup("axis")),
     omega_(coeffs_)
diff --git a/src/finiteVolume/fvMesh/fvCellSet/fvCellSet.C b/src/finiteVolume/fvMesh/fvCellSet/fvCellSet.C
index 956825bb0d..548cdcb9b9 100644
--- a/src/finiteVolume/fvMesh/fvCellSet/fvCellSet.C
+++ b/src/finiteVolume/fvMesh/fvCellSet/fvCellSet.C
@@ -142,44 +142,6 @@ void Foam::fvCellSet::setV()
 }
 
 
-void Foam::fvCellSet::setSet(const dictionary& dict)
-{
-    switch (selectionMode_)
-    {
-        case selectionModeType::points:
-        {
-            dict.lookup("points") >> points_;
-            break;
-        }
-        case selectionModeType::cellSet:
-        {
-            dict.lookup("cellSet") >> cellSetName_;
-            break;
-        }
-        case selectionModeType::cellZone:
-        {
-            dict.lookup("cellZone") >> cellSetName_;
-            break;
-        }
-        case selectionModeType::all:
-        {
-            break;
-        }
-        default:
-        {
-            FatalErrorInFunction
-                << "Unknown selectionMode "
-                << selectionModeTypeNames_[selectionMode_]
-                << ". Valid selectionMode types are" << selectionModeTypeNames_
-                << exit(FatalError);
-        }
-    }
-
-    setCells();
-    setV();
-}
-
-
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
 Foam::fvCellSet::fvCellSet
@@ -197,22 +159,6 @@ Foam::fvCellSet::fvCellSet
 }
 
 
-Foam::fvCellSet::fvCellSet
-(
-    const fvMesh& mesh,
-    const dictionary& dict,
-    const selectionModeType defaultSelectionMode
-)
-:
-    mesh_(mesh),
-    selectionMode_(defaultSelectionMode),
-    cellSetName_(word::null),
-    V_(NaN)
-{
-    read(dict, defaultSelectionMode);
-}
-
-
 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
 Foam::fvCellSet::~fvCellSet()
@@ -254,31 +200,64 @@ void Foam::fvCellSet::distribute(const polyDistributionMap&)
 
 bool Foam::fvCellSet::read(const dictionary& dict)
 {
-    selectionMode_ =
-        selectionModeTypeNames_.read(dict.lookup("selectionMode"));
+    if (dict.found("selectionMode"))
+    {
+        selectionMode_ =
+            selectionModeTypeNames_.read(dict.lookup("selectionMode"));
+    }
+    else if (dict.found("points"))
+    {
+        selectionMode_ = selectionModeType::points;
+    }
+    else if (dict.found("cellSet"))
+    {
+        selectionMode_ = selectionModeType::cellSet;
+    }
+    else if (dict.lookup("cellZone"))
+    {
+        selectionMode_ = selectionModeType::cellZone;
+    }
+    else
+    {
+        FatalIOErrorInFunction(dict)
+            << "selectionMode,  points, cellSet or cellZone not specified. "
+            << "Valid selectionMode types are" << selectionModeTypeNames_
+            << exit(FatalIOError);
+    }
 
-    setSet(dict);
+    switch (selectionMode_)
+    {
+        case selectionModeType::points:
+        {
+            dict.lookup("points") >> points_;
+            break;
+        }
+        case selectionModeType::cellSet:
+        {
+            dict.lookup("cellSet") >> cellSetName_;
+            break;
+        }
+        case selectionModeType::cellZone:
+        {
+            dict.lookup("cellZone") >> cellSetName_;
+            break;
+        }
+        case selectionModeType::all:
+        {
+            break;
+        }
+        default:
+        {
+            FatalErrorInFunction
+                << "Unknown selectionMode "
+                << selectionModeTypeNames_[selectionMode_]
+                << ". Valid selectionMode types are" << selectionModeTypeNames_
+                << exit(FatalError);
+        }
+    }
 
-    return true;
-}
-
-
-bool Foam::fvCellSet::read
-(
-    const dictionary& dict,
-    const selectionModeType defaultSelectionMode
-)
-{
-    selectionMode_ = selectionModeTypeNames_
-    [
-        dict.lookupOrDefault<word>
-        (
-            "selectionMode",
-            selectionModeTypeNames_[defaultSelectionMode]
-        )
-    ];
-
-    setSet(dict);
+    setCells();
+    setV();
 
     return true;
 }
diff --git a/src/finiteVolume/fvMesh/fvCellSet/fvCellSet.H b/src/finiteVolume/fvMesh/fvCellSet/fvCellSet.H
index 44be13e9e1..687689d98e 100644
--- a/src/finiteVolume/fvMesh/fvCellSet/fvCellSet.H
+++ b/src/finiteVolume/fvMesh/fvCellSet/fvCellSet.H
@@ -25,33 +25,36 @@ Class
     Foam::fv::fvCellSet
 
 Description
-    Cell-set fvConstraint abstract base class. Provides a base set of controls
-    regarding the location where the fvConstraint is applied.
+    General cell set selection class for models that apply to sub-sets
+    of the mesh.
+
+    Currently supports cell selection from a set of points, a specified cellSet
+    or cellZone or all of the cells.  The selection method can either be
+    specified explicitly using the \c selectionMode entry or inferred from the
+    presence of either a \c cellSet, \c cellZone or \c points entry.  The \c
+    selectionMode entry is required to select \c all cells.
 
 Usage
-    Example usage:
+    Examples:
     \verbatim
-    constraint1
-    {
-        type            <constraintType>
-
         // Apply everywhere
         selectionMode   all;
 
-        // // Apply within a given cell set
-        // selectionMode   cellSet;
-        // cellSet         c0;
+        // Apply within a given cellSet
+        selectionMode   cellSet; // Optional
+        cellSet         rotor;
 
-        // // Apply in cells containing a list of points
-        // selectionMode   points;
-        // points
-        // (
-        //     (2.25 0.5 0)
-        //     (2.75 0.5 0)
-        // );
+        // Apply within a given cellZone
+        selectionMode   cellZone; // Optional
+        cellSet         rotor;
 
-        ...
-    }
+        // Apply in cells containing a list of points
+        selectionMode   points; // Optional
+        points
+        (
+            (2.25 0.5 0)
+            (2.75 0.5 0)
+        );
     \endverbatim
 
 SourceFiles
@@ -130,9 +133,6 @@ private:
         //- Set the sum of scalar volumes
         void setV();
 
-        //- Set the set for the selectionMode
-        void setSet(const dictionary& dict);
-
 
 public:
 
@@ -145,14 +145,6 @@ public:
             const dictionary& dict
         );
 
-        //- Construct from mesh, dictionary and default selectionMode
-        fvCellSet
-        (
-            const fvMesh& mesh,
-            const dictionary& dict,
-            const selectionModeType defaultSelectionMode
-        );
-
 
     //- Destructor
     ~fvCellSet();
@@ -195,13 +187,6 @@ public:
 
             //- Read coefficients dictionary
             bool read(const dictionary& dict);
-
-            //- Read coefficients dictionary and default selectionMode
-            bool read
-            (
-                const dictionary& dict,
-                const selectionModeType defaultSelectionMode
-            );
 };
 
 
diff --git a/tutorials/compressible/rhoPorousSimpleFoam/angledDuctImplicit/system/fvConstraints b/tutorials/compressible/rhoPorousSimpleFoam/angledDuctImplicit/system/fvConstraints
index 39b5c12ede..0f5add094e 100644
--- a/tutorials/compressible/rhoPorousSimpleFoam/angledDuctImplicit/system/fvConstraints
+++ b/tutorials/compressible/rhoPorousSimpleFoam/angledDuctImplicit/system/fvConstraints
@@ -26,7 +26,6 @@ source1
 {
     type            fixedTemperatureConstraint;
 
-    selectionMode   cellZone;
     cellZone        porosity;
 
     mode            uniform;
diff --git a/tutorials/modules/CHT/reverseBurner/system/gas/fvConstraints b/tutorials/modules/CHT/reverseBurner/system/gas/fvConstraints
index f4231c1dfc..e5ec76194e 100644
--- a/tutorials/modules/CHT/reverseBurner/system/gas/fvConstraints
+++ b/tutorials/modules/CHT/reverseBurner/system/gas/fvConstraints
@@ -18,7 +18,6 @@ ignition
 {
     type            fixedTemperatureConstraint;
 
-    selectionMode   cellSet;
     cellSet         ignition;
 
     mode            uniform;
diff --git a/tutorials/modules/fluid/angledDuct/constant/fvModels b/tutorials/modules/fluid/angledDuct/constant/fvModels
index d4bd2ae8ca..d26e2c038b 100644
--- a/tutorials/modules/fluid/angledDuct/constant/fvModels
+++ b/tutorials/modules/fluid/angledDuct/constant/fvModels
@@ -20,7 +20,6 @@ porosity1
 
     explicitPorositySourceCoeffs
     {
-        selectionMode   cellZone;
         cellZone        porosity;
 
         type            DarcyForchheimer;
diff --git a/tutorials/modules/fluid/angledDuctExplicitFixedCoeff/constant/fvModels b/tutorials/modules/fluid/angledDuctExplicitFixedCoeff/constant/fvModels
index a4c2c15c73..53ce182026 100644
--- a/tutorials/modules/fluid/angledDuctExplicitFixedCoeff/constant/fvModels
+++ b/tutorials/modules/fluid/angledDuctExplicitFixedCoeff/constant/fvModels
@@ -20,7 +20,6 @@ porosity
 
     explicitPorositySourceCoeffs
     {
-        selectionMode   cellZone;
         cellZone        porosity;
 
         type            fixedCoeff;
diff --git a/tutorials/modules/fluid/angledDuctExplicitFixedCoeff/system/fvConstraints b/tutorials/modules/fluid/angledDuctExplicitFixedCoeff/system/fvConstraints
index 9517b48500..b95c0ac330 100644
--- a/tutorials/modules/fluid/angledDuctExplicitFixedCoeff/system/fvConstraints
+++ b/tutorials/modules/fluid/angledDuctExplicitFixedCoeff/system/fvConstraints
@@ -26,7 +26,6 @@ fixedTemperature
 {
     type            fixedTemperatureConstraint;
 
-    selectionMode   cellZone;
     cellZone        porosity;
 
     mode            uniform;
@@ -38,7 +37,6 @@ porosityTurbulence
 {
     type            fixedValueConstraint;
 
-    selectionMode   cellZone;
     cellZone        porosity;
 
     fieldValues
diff --git a/tutorials/modules/fluid/angledDuctLTS/constant/fvModels b/tutorials/modules/fluid/angledDuctLTS/constant/fvModels
index b6c74207bd..c4cb726509 100644
--- a/tutorials/modules/fluid/angledDuctLTS/constant/fvModels
+++ b/tutorials/modules/fluid/angledDuctLTS/constant/fvModels
@@ -20,7 +20,6 @@ porosity1
 
     explicitPorositySourceCoeffs
     {
-        selectionMode   cellZone;
         cellZone        porosity;
 
         type            DarcyForchheimer;
diff --git a/tutorials/modules/fluid/mixerVessel2DMRF/constant/fvModels b/tutorials/modules/fluid/mixerVessel2DMRF/constant/fvModels
index c4eb466c87..641e57c560 100644
--- a/tutorials/modules/fluid/mixerVessel2DMRF/constant/fvModels
+++ b/tutorials/modules/fluid/mixerVessel2DMRF/constant/fvModels
@@ -20,7 +20,6 @@ porosity1
 
     explicitPorositySourceCoeffs
     {
-        selectionMode   cellZone;
         cellZone        stator;
 
         type            DarcyForchheimer;
diff --git a/tutorials/modules/incompressibleFluid/porousBlockage/constant/fvModels b/tutorials/modules/incompressibleFluid/porousBlockage/constant/fvModels
index 47134767c4..75c737299c 100644
--- a/tutorials/modules/incompressibleFluid/porousBlockage/constant/fvModels
+++ b/tutorials/modules/incompressibleFluid/porousBlockage/constant/fvModels
@@ -20,7 +20,6 @@ porosity
 
     explicitPorositySourceCoeffs
     {
-        selectionMode   cellZone;
         cellZone        porousBlockage;
 
         type            DarcyForchheimer;
diff --git a/tutorials/modules/incompressibleFluid/rotorDisk/constant/fvModels b/tutorials/modules/incompressibleFluid/rotorDisk/constant/fvModels
index 0c58013af4..b30e35cbbc 100644
--- a/tutorials/modules/incompressibleFluid/rotorDisk/constant/fvModels
+++ b/tutorials/modules/incompressibleFluid/rotorDisk/constant/fvModels
@@ -17,7 +17,6 @@ disk
 {
     type            rotorDisk;
 
-    selectionMode   cellZone;
     cellZone        rotatingZone;
 
     nBlades         3;      // Number of blades
diff --git a/tutorials/modules/incompressibleFluid/turbineSiting/constant/fvModels b/tutorials/modules/incompressibleFluid/turbineSiting/constant/fvModels
index 3372e2dd95..4b8e882b3f 100644
--- a/tutorials/modules/incompressibleFluid/turbineSiting/constant/fvModels
+++ b/tutorials/modules/incompressibleFluid/turbineSiting/constant/fvModels
@@ -18,7 +18,6 @@ disk1
 {
     type            actuationDiskSource;
 
-    selectionMode   cellSet;
     cellSet         actuationDisk1;
 
     diskDir         (1 0 0);    // Orientation of the disk
@@ -32,7 +31,6 @@ disk2
 {
     type            actuationDiskSource;
 
-    selectionMode   cellSet;
     cellSet         actuationDisk2;
 
     diskDir         (1 0 0);    // Orientation of the disk
diff --git a/tutorials/modules/multicomponentFluid/filter/constant/fvModels b/tutorials/modules/multicomponentFluid/filter/constant/fvModels
index 7577fc6a4c..ae3ad7831f 100644
--- a/tutorials/modules/multicomponentFluid/filter/constant/fvModels
+++ b/tutorials/modules/multicomponentFluid/filter/constant/fvModels
@@ -31,7 +31,6 @@ filter1
 
     explicitPorositySourceCoeffs
     {
-        selectionMode   cellZone;
         cellZone        filter;
 
         type            DarcyForchheimer;
@@ -57,7 +56,6 @@ massSource
 {
     type            massSource;
 
-    selectionMode   points;
     points
     (
         (2.75 0.5 0)
diff --git a/tutorials/modules/multicomponentFluid/simplifiedSiwek/system/fvConstraints b/tutorials/modules/multicomponentFluid/simplifiedSiwek/system/fvConstraints
index bd28fa166e..c509a9f234 100644
--- a/tutorials/modules/multicomponentFluid/simplifiedSiwek/system/fvConstraints
+++ b/tutorials/modules/multicomponentFluid/simplifiedSiwek/system/fvConstraints
@@ -21,7 +21,6 @@ source1
     timeStart       0.1;
     duration        0.4;
 
-    selectionMode   cellSet;
     cellSet         ignitionCells;
 
     mode            uniform;
diff --git a/tutorials/multiphase/interFoam/RAS/angledDuct/constant/fvModels b/tutorials/multiphase/interFoam/RAS/angledDuct/constant/fvModels
index 726a9b9958..abcf650670 100644
--- a/tutorials/multiphase/interFoam/RAS/angledDuct/constant/fvModels
+++ b/tutorials/multiphase/interFoam/RAS/angledDuct/constant/fvModels
@@ -20,7 +20,6 @@ porosity1
 
     explicitPorositySourceCoeffs
     {
-        selectionMode   cellZone;
         cellZone        porosity;
 
         type            DarcyForchheimer;
diff --git a/tutorials/multiphase/multiphaseEulerFoam/RAS/bubblePipe/constant/fvModels b/tutorials/multiphase/multiphaseEulerFoam/RAS/bubblePipe/constant/fvModels
index e394ce2617..6decf79290 100644
--- a/tutorials/multiphase/multiphaseEulerFoam/RAS/bubblePipe/constant/fvModels
+++ b/tutorials/multiphase/multiphaseEulerFoam/RAS/bubblePipe/constant/fvModels
@@ -18,7 +18,6 @@ massSource
 {
     type            massSource;
 
-    selectionMode   cellZone;
     cellZone        injection;
 
     massFlowRate    6e-7;
diff --git a/tutorials/multiphase/multiphaseEulerFoam/laminar/bed/constant/fvModels b/tutorials/multiphase/multiphaseEulerFoam/laminar/bed/constant/fvModels
index 52fe2d4040..36f4ca8c0e 100644
--- a/tutorials/multiphase/multiphaseEulerFoam/laminar/bed/constant/fvModels
+++ b/tutorials/multiphase/multiphaseEulerFoam/laminar/bed/constant/fvModels
@@ -18,7 +18,6 @@ massSource
 {
     type            massSource;
 
-    selectionMode   points;
     points          ((0.075 0.925 0.05));
 
     massFlowRate
diff --git a/tutorials/multiphase/multiphaseEulerFoam/laminar/injection/constant/fvModels b/tutorials/multiphase/multiphaseEulerFoam/laminar/injection/constant/fvModels
index bdbe595f84..dcba54c7a1 100644
--- a/tutorials/multiphase/multiphaseEulerFoam/laminar/injection/constant/fvModels
+++ b/tutorials/multiphase/multiphaseEulerFoam/laminar/injection/constant/fvModels
@@ -18,7 +18,6 @@ massSource
 {
     type            massSource;
 
-    selectionMode   points;
     points
     (
         (0.075 0.2 0.05)
diff --git a/tutorials/multiphase/multiphaseEulerFoam/laminar/steamInjection/constant/fvModels b/tutorials/multiphase/multiphaseEulerFoam/laminar/steamInjection/constant/fvModels
index 4895f0c287..50c93b13fb 100644
--- a/tutorials/multiphase/multiphaseEulerFoam/laminar/steamInjection/constant/fvModels
+++ b/tutorials/multiphase/multiphaseEulerFoam/laminar/steamInjection/constant/fvModels
@@ -18,7 +18,6 @@ massSource
 {
     type            massSource;
 
-    selectionMode   points;
     points
     (
         (0.075 0.2 0.05)