From 0ff5eb56870d39ad423774443a94c28666d36b6c Mon Sep 17 00:00:00 2001
From: Kutalmis Bercin <kutalmis.bercin@esi-group.com>
Date: Thu, 25 Jul 2024 11:45:17 +0100
Subject: [PATCH] STYLE: scalarTransport/energyTransport: modernise the code

- Remove redundant copy ctor and assignment operator (already deleted in base class)
- Remove unused header files
- Use default destructor
- Reorder member variables
---
 .../solvers/energyTransport/energyTransport.C | 60 ++++++++----------
 .../solvers/energyTransport/energyTransport.H | 62 +++++++++----------
 .../solvers/scalarTransport/scalarTransport.C | 42 ++++++-------
 .../solvers/scalarTransport/scalarTransport.H | 51 +++++++--------
 4 files changed, 94 insertions(+), 121 deletions(-)

diff --git a/src/functionObjects/solvers/energyTransport/energyTransport.C b/src/functionObjects/solvers/energyTransport/energyTransport.C
index d2a77b3407..730a320f8e 100644
--- a/src/functionObjects/solvers/energyTransport/energyTransport.C
+++ b/src/functionObjects/solvers/energyTransport/energyTransport.C
@@ -26,11 +26,6 @@ License
 \*---------------------------------------------------------------------------*/
 
 #include "energyTransport.H"
-#include "surfaceFields.H"
-#include "fvmDdt.H"
-#include "fvmDiv.H"
-#include "fvmLaplacian.H"
-#include "fvmSup.H"
 #include "turbulentTransportModel.H"
 #include "turbulentFluidThermoModel.H"
 #include "addToRunTimeSelectionTable.H"
@@ -188,24 +183,6 @@ Foam::functionObjects::energyTransport::energyTransport
 )
 :
     fvMeshFunctionObject(name, runTime, dict),
-    fieldName_(dict.getOrDefault<word>("field", "T")),
-    phiName_(dict.getOrDefault<word>("phi", "phi")),
-    rhoName_(dict.getOrDefault<word>("rho", "rho")),
-    nCorr_(0),
-    tol_(1),
-    schemesField_("unknown-schemesField"),
-    fvOptions_(mesh_),
-    multiphaseThermo_(dict.subOrEmptyDict("phaseThermos")),
-    Cp_("Cp", dimEnergy/dimMass/dimTemperature, 0, dict),
-    kappa_
-    (
-        "kappa",
-        dimEnergy/dimTime/dimLength/dimTemperature,
-        0,
-        dict
-    ),
-    rho_("rhoInf", dimDensity, 0, dict),
-    Prt_("Prt", dimless, 1, dict),
     rhoCp_
     (
         IOobject
@@ -219,7 +196,25 @@ Foam::functionObjects::energyTransport::energyTransport
         ),
         mesh_,
         dimensionedScalar(dimEnergy/dimTemperature/dimVolume, Zero)
-    )
+    ),
+    fvOptions_(mesh_),
+    multiphaseThermo_(dict.subOrEmptyDict("phaseThermos")),
+    Cp_("Cp", dimEnergy/dimMass/dimTemperature, 0, dict),
+    kappa_
+    (
+        "kappa",
+        dimEnergy/dimTime/dimLength/dimTemperature,
+        0,
+        dict
+    ),
+    rho_("rhoInf", dimDensity, 0, dict),
+    Prt_("Prt", dimless, 1, dict),
+    fieldName_(dict.getOrDefault<word>("field", "T")),
+    schemesField_("unknown-schemesField"),
+    phiName_(dict.getOrDefault<word>("phi", "phi")),
+    rhoName_(dict.getOrDefault<word>("rho", "rho")),
+    tol_(1),
+    nCorr_(0)
 {
     read(dict);
 
@@ -306,17 +301,14 @@ Foam::functionObjects::energyTransport::energyTransport
 }
 
 
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
-
-Foam::functionObjects::energyTransport::~energyTransport()
-{}
-
-
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
 bool Foam::functionObjects::energyTransport::read(const dictionary& dict)
 {
-    fvMeshFunctionObject::read(dict);
+    if (!fvMeshFunctionObject::read(dict))
+    {
+        return false;
+    }
 
     dict.readIfPresent("phi", phiName_);
     dict.readIfPresent("rho", rhoName_);
@@ -359,14 +351,14 @@ bool Foam::functionObjects::energyTransport::execute()
 
     // Convergence monitor parameters
     bool converged = false;
-    label iter = 0;
+    int iter = 0;
 
     if (phi.dimensions() == dimMass/dimTime)
     {
         rhoCp_ = rho()*Cp();
         const surfaceScalarField rhoCpPhi(fvc::interpolate(Cp())*phi);
 
-        for (label i = 0; i <= nCorr_; i++)
+        for (int i = 0; i <= nCorr_; ++i)
         {
             fvScalarMatrix sEqn
             (
@@ -401,7 +393,7 @@ bool Foam::functionObjects::energyTransport::execute()
             rhoCp
         );
 
-        for (label i = 0; i <= nCorr_; i++)
+        for (int i = 0; i <= nCorr_; ++i)
         {
             fvScalarMatrix sEqn
             (
diff --git a/src/functionObjects/solvers/energyTransport/energyTransport.H b/src/functionObjects/solvers/energyTransport/energyTransport.H
index eea60e707d..04512f81f3 100644
--- a/src/functionObjects/solvers/energyTransport/energyTransport.H
+++ b/src/functionObjects/solvers/energyTransport/energyTransport.H
@@ -70,7 +70,7 @@ Usage
         Prt             <scalar>;
         schemesField    <word>;
         tolerance       <scalar>;
-        nCorr           <label>;
+        nCorr           <int>;
         fvOptions       <dict>;
         phaseThermos    <dict>;
 
@@ -93,7 +93,7 @@ Usage
       Prt       | Turbulent Prandtl number            | scalar | no | 1
       schemesField | Name of field to specify schemes | word   | no | field
       tolerance | Outer-loop initial-residual tolerance | scalar | no | 1
-      nCorr     | Number of outer-loop correctors     | label  | no | 0
+      nCorr     | Number of outer-loop correctors     | int    | no | 0
       fvOptions | List of finite-volume options       | dict   | no | -
       phaseThermos | Dictionary for multi-phase thermo | dict  | no | null
     \endtable
@@ -232,25 +232,10 @@ class energyTransport
 :
     public fvMeshFunctionObject
 {
-    // Private data
+    // Private Data
 
-        //- Name of the transport field.
-        word fieldName_;
-
-        //- Name of flux field
-        word phiName_;
-
-        //- Name of density field
-        word rhoName_;
-
-        //- Number of corrector iterations (optional)
-        label nCorr_;
-
-        //- Outer-loop initial-residual tolerance
-        scalar tol_;
-
-        //- Name of field whose schemes are used (optional)
-        word schemesField_;
+        //- Volumetric heat capacity field [J/m^3/K]
+        volScalarField rhoCp_;
 
         //- Run-time selectable finite volume options, e.g. sources, constraints
         fv::optionList fvOptions_;
@@ -261,7 +246,7 @@ class energyTransport
         //- List of phase names
         wordList phaseNames_;
 
-        //- List of phase heat capacities
+        //- List of phase specific heat capacities at constant pressure
         PtrList<dimensionedScalar> Cps_;
 
         //- List of phase thermal diffusivity for temperature [J/m/s/K]
@@ -270,7 +255,7 @@ class energyTransport
         //- Unallocated phase list
         UPtrList<volScalarField> phases_;
 
-        //- Heat capacity for single phase flows
+        //- Specific heat capacity at constant pressure for single phase flows
         dimensionedScalar Cp_;
 
         //- Thermal diffusivity for temperature for single phase flows
@@ -282,8 +267,23 @@ class energyTransport
         //- Turbulent Prandt number
         dimensionedScalar Prt_;
 
-        //- rhoCp
-        volScalarField rhoCp_;
+        //- Name of the transport field
+        word fieldName_;
+
+        //- Name of field whose schemes are used
+        word schemesField_;
+
+        //- Name of flux field
+        word phiName_;
+
+        //- Name of density field
+        word rhoName_;
+
+        //- Outer-loop initial-residual tolerance
+        scalar tol_;
+
+        //- Number of corrector iterations
+        int nCorr_;
 
 
     // Private Member Functions
@@ -294,21 +294,15 @@ class energyTransport
         //- Return the diffusivity field
         tmp<volScalarField> kappaEff() const;
 
-        //- Return rho field
+        //- Return the density field, rho
         tmp<volScalarField> rho() const;
 
-        //- Return Cp
+        //- Return the specific heat capacity at constant pressure field, Cp
         tmp<volScalarField> Cp() const;
 
-        //- Return kappa
+        //- Return the thermal diffusivity field
         tmp<volScalarField> kappa() const;
 
-        //- No copy construct
-        energyTransport(const energyTransport&) = delete;
-
-        //- No copy assignment
-        void operator=(const energyTransport&) = delete;
-
 
 public:
 
@@ -328,7 +322,7 @@ public:
 
 
     //- Destructor
-    virtual ~energyTransport();
+    virtual ~energyTransport() = default;
 
 
     // Member Functions
diff --git a/src/functionObjects/solvers/scalarTransport/scalarTransport.C b/src/functionObjects/solvers/scalarTransport/scalarTransport.C
index 05180db03f..99af527a7b 100644
--- a/src/functionObjects/solvers/scalarTransport/scalarTransport.C
+++ b/src/functionObjects/solvers/scalarTransport/scalarTransport.C
@@ -27,11 +27,6 @@ License
 \*---------------------------------------------------------------------------*/
 
 #include "scalarTransport.H"
-#include "surfaceFields.H"
-#include "fvmDdt.H"
-#include "fvmDiv.H"
-#include "fvmLaplacian.H"
-#include "fvmSup.H"
 #include "CMULES.H"
 #include "turbulentTransportModel.H"
 #include "turbulentFluidThermoModel.H"
@@ -172,7 +167,9 @@ Foam::functionObjects::scalarTransport::scalarTransport
 )
 :
     fvMeshFunctionObject(name, runTime, dict),
+    fvOptions_(mesh_),
     fieldName_(dict.getOrDefault<word>("field", "s")),
+    schemesField_("unknown-schemesField"),
     phiName_(dict.getOrDefault<word>("phi", "phi")),
     rhoName_(dict.getOrDefault<word>("rho", "rho")),
     nutName_(dict.getOrDefault<word>("nut", "none")),
@@ -182,12 +179,12 @@ Foam::functionObjects::scalarTransport::scalarTransport
         dict.getOrDefault<word>("phasePhiCompressed", "alphaPhiUn")
     ),
     D_(0),
-    constantD_(false),
+    alphaD_(1),
+    alphaDt_(1),
     tol_(1),
     nCorr_(0),
     resetOnStartUp_(false),
-    schemesField_("unknown-schemesField"),
-    fvOptions_(mesh_),
+    constantD_(false),
     bounded01_(dict.getOrDefault("bounded01", true))
 {
     read(dict);
@@ -203,32 +200,30 @@ Foam::functionObjects::scalarTransport::scalarTransport
 }
 
 
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
-
-Foam::functionObjects::scalarTransport::~scalarTransport()
-{}
-
-
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
 bool Foam::functionObjects::scalarTransport::read(const dictionary& dict)
 {
-    fvMeshFunctionObject::read(dict);
+    if (!fvMeshFunctionObject::read(dict))
+    {
+        return false;
+    }
 
     dict.readIfPresent("phi", phiName_);
     dict.readIfPresent("rho", rhoName_);
     dict.readIfPresent("nut", nutName_);
     dict.readIfPresent("phase", phaseName_);
-    dict.readIfPresent("bounded01", bounded01_);
+    dict.readIfPresent("phasePhiCompressed", phasePhiCompressedName_);
 
     schemesField_ = dict.getOrDefault("schemesField", fieldName_);
-    constantD_ = dict.readIfPresent("D", D_);
-    alphaD_ = dict.getOrDefault<scalar>("alphaD", 1);
-    alphaDt_ = dict.getOrDefault<scalar>("alphaDt", 1);
 
+    dict.readIfPresent("alphaD", alphaD_);
+    dict.readIfPresent("alphaDt", alphaDt_);
     dict.readIfPresent("tolerance", tol_);
     dict.readIfPresent("nCorr", nCorr_);
     dict.readIfPresent("resetOnStartUp", resetOnStartUp_);
+    constantD_ = dict.readIfPresent("D", D_);
+    dict.readIfPresent("bounded01", bounded01_);
 
     if (dict.found("fvOptions"))
     {
@@ -260,7 +255,7 @@ bool Foam::functionObjects::scalarTransport::execute()
 
     // Convergence monitor parameters
     bool converged = false;
-    label iter = 0;
+    int iter = 0;
 
     // Two phase scalar transport
     if (phaseName_ != "none")
@@ -278,7 +273,7 @@ bool Foam::functionObjects::scalarTransport::execute()
 
         // Solve
         tmp<surfaceScalarField> tTPhiUD;
-        for (label i = 0; i <= nCorr_; i++)
+        for (int i = 0; i <= nCorr_; ++i)
         {
             fvScalarMatrix sEqn
             (
@@ -317,9 +312,8 @@ bool Foam::functionObjects::scalarTransport::execute()
     {
         const volScalarField& rho = lookupObject<volScalarField>(rhoName_);
 
-        for (label i = 0; i <= nCorr_; i++)
+        for (int i = 0; i <= nCorr_; ++i)
         {
-
             fvScalarMatrix sEqn
             (
                 fvm::ddt(rho, s)
@@ -340,7 +334,7 @@ bool Foam::functionObjects::scalarTransport::execute()
     }
     else if (phi.dimensions() == dimVolume/dimTime)
     {
-        for (label i = 0; i <= nCorr_; i++)
+        for (int i = 0; i <= nCorr_; ++i)
         {
             fvScalarMatrix sEqn
             (
diff --git a/src/functionObjects/solvers/scalarTransport/scalarTransport.H b/src/functionObjects/solvers/scalarTransport/scalarTransport.H
index 61cea62fa5..6a97eafb22 100644
--- a/src/functionObjects/solvers/scalarTransport/scalarTransport.H
+++ b/src/functionObjects/solvers/scalarTransport/scalarTransport.H
@@ -73,7 +73,7 @@ Usage
         alphaD          <scalar>;
         alphaDt         <scalar>;
         tolerance       <scalar>;
-        nCorr           <label>;
+        nCorr           <int>;
         resetOnStartUp  <bool>;
         fvOptions       <dict>;
 
@@ -98,7 +98,7 @@ Usage
       alphaD    | Laminar diffusivity coefficient     | scalar | no | 1
       alphaDt   | Turbulent diffusivity coefficient   | scalar | no | 1
       tolerance | Outer-loop initial-residual tolerance | scalar | no | 1
-      nCorr     | Number of outer-loop correctors     | label  | no | 0
+      nCorr     | Number of outer-loop correctors     | int    | no | 0
       resetOnStartUp | Flag to reset field to zero on start-up | bool | no | no
       fvOptions | List of finite-volume options       | dict   | no | -
     \endtable
@@ -187,52 +187,52 @@ class scalarTransport
 :
     public fvMeshFunctionObject
 {
-    // Private data
+    // Private Data
+
+        //- Run-time selectable finite volume options, e.g. sources, constraints
+        fv::optionList fvOptions_;
 
         //- Name of the transport field.
         word fieldName_;
 
-        //- Name of flux field (optional)
+        //- Name of field whose schemes are used
+        word schemesField_;
+
+        //- Name of flux field
         word phiName_;
 
-        //- Name of density field (optional)
+        //- Name of density field
         word rhoName_;
 
-        //- Name of turbulent viscosity field (optional)
+        //- Name of turbulent viscosity field
         word nutName_;
 
-        //- Name of phase field (optional)
+        //- Name of phase field
         word phaseName_;
 
-        //- Name of phase field compressed flux (optional)
+        //- Name of phase field compressed flux
         word phasePhiCompressedName_;
 
-        //- Diffusion coefficient (optional)
+        //- Diffusion coefficient
         scalar D_;
 
-        //- Flag to indicate whether a constant, uniform D_ is specified
-        bool constantD_;
-
-        //- Laminar diffusion coefficient (optional)
+        //- Laminar diffusion coefficient
         scalar alphaD_;
 
-        //- Turbulent diffusion coefficient (optional)
+        //- Turbulent diffusion coefficient
         scalar alphaDt_;
 
         //- Outer-loop initial-residual tolerance
         scalar tol_;
 
-        //- Number of corrector iterations (optional)
-        label nCorr_;
+        //- Number of corrector iterations
+        int nCorr_;
 
         //- Flag to reset the scalar to zero on start-up
         bool resetOnStartUp_;
 
-        //- Name of field whose schemes are used (optional)
-        word schemesField_;
-
-        //- Run-time selectable finite volume options, e.g. sources, constraints
-        fv::optionList fvOptions_;
+        //- Flag to indicate whether a constant, uniform D_ is specified
+        bool constantD_;
 
         //- Bound scalar between 0-1 using MULES for multiphase case
         bool bounded01_;
@@ -251,13 +251,6 @@ class scalarTransport
         ) const;
 
 
-        //- No copy construct
-        scalarTransport(const scalarTransport&) = delete;
-
-        //- No copy assignment
-        void operator=(const scalarTransport&) = delete;
-
-
 public:
 
     //- Runtime type information
@@ -276,7 +269,7 @@ public:
 
 
     //- Destructor
-    virtual ~scalarTransport();
+    virtual ~scalarTransport() = default;
 
 
     // Member Functions