From b4d7a319132bdaced4cd6d61e96f1905a9043624 Mon Sep 17 00:00:00 2001
From: Kutalmis Bercin <kutalmis.bercin@esi-group.com>
Date: Wed, 24 Jan 2024 15:30:38 +0000
Subject: [PATCH] STYLE: regionFaModels: add/remove various comments

---
 .../KirchhoffShell/KirchhoffShell.C           | 11 +++--------
 .../velocityFilmShellFvPatchVectorField.C     |  2 +-
 .../velocityFilmShellFvPatchVectorField.H     |  4 ++--
 .../vibrationShellFvPatchScalarField.H        |  2 +-
 .../setTimeStepFaRegionsFunctionObject.C      |  1 -
 .../kinematicThinFilm/kinematicThinFilm.C     | 13 +++++--------
 .../liquidFilm/liquidFilmBase.C               | 19 -------------------
 .../liquidFilm/liquidFilmBase.H               | 11 +++++------
 .../liquidFilmModel/liquidFilmModel.C         |  8 --------
 .../liquidFilmModel/liquidFilmModel.H         | 15 ++++++---------
 .../filmTurbulenceModel/filmTurbulenceModel.H |  6 +++---
 .../filmTurbulenceModel/laminar/laminar.C     |  1 -
 .../curvatureSeparation/curvatureSeparation.H |  3 +--
 .../thermalShell/thermalShell.C               |  5 +----
 .../thermalShell/thermalShell.H               |  8 ++++----
 .../vibrationShellModel/vibrationShellModel.C |  1 -
 16 files changed, 32 insertions(+), 78 deletions(-)

diff --git a/src/regionFaModels/KirchhoffShell/KirchhoffShell.C b/src/regionFaModels/KirchhoffShell/KirchhoffShell.C
index b3daab327e..7d0102f910 100644
--- a/src/regionFaModels/KirchhoffShell/KirchhoffShell.C
+++ b/src/regionFaModels/KirchhoffShell/KirchhoffShell.C
@@ -41,7 +41,6 @@ namespace regionModels
 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
 defineTypeNameAndDebug(KirchhoffShell, 0);
-
 addToRunTimeSelectionTable(vibrationShellModel, KirchhoffShell, dictionary);
 
 // * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
@@ -56,10 +55,7 @@ bool KirchhoffShell::init(const dictionary& dict)
 
 void KirchhoffShell::solveDisplacement()
 {
-    if (debug)
-    {
-        InfoInFunction << endl;
-    }
+    DebugInFunction << endl;
 
     const Time& time = primaryMesh().time();
 
@@ -77,7 +73,7 @@ void KirchhoffShell::solveDisplacement()
         w_.oldTime().oldTime() = w00_;
         laplaceW_.oldTime() = laplaceW0_;
         laplace2W_.oldTime() = laplace2W0_;
-     }
+    }
 
     for
     (
@@ -89,7 +85,6 @@ void KirchhoffShell::solveDisplacement()
        !(++wSubCycle).end();
     )
     {
-
         laplaceW_ = fac::laplacian(w_);
         laplace2W_ = fac::laplacian(laplaceW_);
 
@@ -264,7 +259,7 @@ void KirchhoffShell::evolveRegion()
     nNonOrthCorr_ = solution().get<label>("nNonOrthCorr");
     nSubCycles_ = solution().get<label>("nSubCycles");
 
-    for (int nonOrth=0; nonOrth<=nNonOrthCorr_; nonOrth++)
+    for (int nonOrth=0; nonOrth<=nNonOrthCorr_; ++nonOrth)
     {
         solveDisplacement();
     }
diff --git a/src/regionFaModels/derivedFvPatchFields/filmShell/velocityFilmShellFvPatchVectorField.C b/src/regionFaModels/derivedFvPatchFields/filmShell/velocityFilmShellFvPatchVectorField.C
index 478e03cb6c..d764b4a36f 100644
--- a/src/regionFaModels/derivedFvPatchFields/filmShell/velocityFilmShellFvPatchVectorField.C
+++ b/src/regionFaModels/derivedFvPatchFields/filmShell/velocityFilmShellFvPatchVectorField.C
@@ -146,7 +146,7 @@ void velocityFilmShellFvPatchVectorField::updateCoeffs()
         return;
     }
 
-    // Execute the change to the openFraction only once per time-step
+    // Execute the change only once per time-step
     if (curTimeIndex_ != this->db().time().timeIndex())
     {
         baffle_->evolve();
diff --git a/src/regionFaModels/derivedFvPatchFields/filmShell/velocityFilmShellFvPatchVectorField.H b/src/regionFaModels/derivedFvPatchFields/filmShell/velocityFilmShellFvPatchVectorField.H
index 9c09fe1e33..f0c22c58b8 100644
--- a/src/regionFaModels/derivedFvPatchFields/filmShell/velocityFilmShellFvPatchVectorField.H
+++ b/src/regionFaModels/derivedFvPatchFields/filmShell/velocityFilmShellFvPatchVectorField.H
@@ -141,7 +141,7 @@ class velocityFilmShellFvPatchVectorField
 
     // Private Data
 
-        //- The liquid film
+        //- The liquid film model
         autoPtr<baffleType> baffle_;
 
         //- Dictionary
@@ -150,7 +150,7 @@ class velocityFilmShellFvPatchVectorField
         //- Time index to evolve the film
         label curTimeIndex_;
 
-        //- Zero wall velocity. Fix U to zero or to film U
+        //- Flag to set velocity to zero or film velocity
         bool zeroWallVelocity_;
 
 
diff --git a/src/regionFaModels/derivedFvPatchFields/vibrationShell/vibrationShellFvPatchScalarField.H b/src/regionFaModels/derivedFvPatchFields/vibrationShell/vibrationShellFvPatchScalarField.H
index 17341165f5..64158eb555 100644
--- a/src/regionFaModels/derivedFvPatchFields/vibrationShell/vibrationShellFvPatchScalarField.H
+++ b/src/regionFaModels/derivedFvPatchFields/vibrationShell/vibrationShellFvPatchScalarField.H
@@ -89,7 +89,7 @@ class vibrationShellFvPatchScalarField
 
     // Private Data
 
-        //- The vibration shell
+        //- The vibration shell model
         autoPtr<baffleType> baffle_;
 
         //- Dictionary
diff --git a/src/regionFaModels/functionObjects/setTimeStep/setTimeStepFaRegionsFunctionObject.C b/src/regionFaModels/functionObjects/setTimeStep/setTimeStepFaRegionsFunctionObject.C
index 5b9cfa6df7..021f13530b 100644
--- a/src/regionFaModels/functionObjects/setTimeStep/setTimeStepFaRegionsFunctionObject.C
+++ b/src/regionFaModels/functionObjects/setTimeStep/setTimeStepFaRegionsFunctionObject.C
@@ -28,7 +28,6 @@ License
 #include "setTimeStepFaRegionsFunctionObject.H"
 #include "addToRunTimeSelectionTable.H"
 
-
 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
 namespace Foam
diff --git a/src/regionFaModels/liquidFilm/kinematicThinFilm/kinematicThinFilm.C b/src/regionFaModels/liquidFilm/kinematicThinFilm/kinematicThinFilm.C
index a688527b42..f12e655ddd 100644
--- a/src/regionFaModels/liquidFilm/kinematicThinFilm/kinematicThinFilm.C
+++ b/src/regionFaModels/liquidFilm/kinematicThinFilm/kinematicThinFilm.C
@@ -75,10 +75,7 @@ void kinematicThinFilm::preEvolveRegion()
 
 void kinematicThinFilm::evolveRegion()
 {
-    if (debug)
-    {
-        InfoInFunction << endl;
-    }
+    DebugInFunction << endl;
 
     const areaVectorField& ns = regionMesh().faceAreaNormals();
 
@@ -86,7 +83,7 @@ void kinematicThinFilm::evolveRegion()
 
     phi2s_ = fac::interpolate(h_)*phif_;
 
-    for (int oCorr=1; oCorr<=nOuterCorr_; oCorr++)
+    for (int oCorr=1; oCorr<=nOuterCorr_; ++oCorr)
     {
         pf_.storePrevIter();
 
@@ -108,10 +105,10 @@ void kinematicThinFilm::evolveRegion()
 
         if (momentumPredictor_)
         {
-            solve(UsEqn == - fac::grad(pf_*h_)/rho_ + pf_*fac::grad(h_)/rho_);
+            solve(UsEqn == -fac::grad(pf_*h_)/rho_ + pf_*fac::grad(h_)/rho_);
         }
 
-        for (int corr=1; corr<=nCorr_; corr++)
+        for (int corr=1; corr<=nCorr_; ++corr)
         {
             areaScalarField UsA(UsEqn.A());
 
@@ -126,7 +123,7 @@ void kinematicThinFilm::evolveRegion()
                 + fac::interpolate(pf_/(rho_*UsA))
                 * fac::lnGrad(h_)*regionMesh().magLe();
 
-            for (int nFilm=1; nFilm<=nFilmCorr_; nFilm++)
+            for (int nFilm=1; nFilm<=nFilmCorr_; ++nFilm)
             {
                 faScalarMatrix hEqn
                 (
diff --git a/src/regionFaModels/liquidFilm/liquidFilmBase.C b/src/regionFaModels/liquidFilm/liquidFilmBase.C
index b392609c86..065acc3cb5 100644
--- a/src/regionFaModels/liquidFilm/liquidFilmBase.C
+++ b/src/regionFaModels/liquidFilm/liquidFilmBase.C
@@ -60,7 +60,6 @@ liquidFilmBase::liquidFilmBase
 )
 :
     regionFaModel(mesh, liquidFilmName, modelType, dict, true),
-
     momentumPredictor_
     (
         this->solution().subDict("PIMPLE").get<bool>("momentumPredictor")
@@ -74,17 +73,11 @@ liquidFilmBase::liquidFilmBase
     (
         this->solution().subDict("PIMPLE").get<label>("nFilmCorr")
     ),
-
     h0_("h0", dimLength, 1e-7, dict),
-
     deltaWet_("deltaWet", dimLength, 1e-4, dict),
-
     UName_(dict.get<word>("U")),
-
     pName_(dict.getOrDefault<word>("p",  word::null)),
-
     pRef_(dict.get<scalar>("pRef")),
-
     h_
     (
         IOobject
@@ -97,7 +90,6 @@ liquidFilmBase::liquidFilmBase
         ),
         regionMesh()
     ),
-
     Uf_
     (
         IOobject
@@ -148,7 +140,6 @@ liquidFilmBase::liquidFilmBase
         ),
         fac::interpolate(Uf_) & regionMesh().Le()
     ),
-
     phi2s_
     (
         IOobject
@@ -161,7 +152,6 @@ liquidFilmBase::liquidFilmBase
         ),
         fac::interpolate(h_*Uf_) & regionMesh().Le()
     ),
-
     gn_
     (
         IOobject
@@ -175,9 +165,7 @@ liquidFilmBase::liquidFilmBase
         regionMesh(),
         dimensionedScalar(dimAcceleration, Zero)
     ),
-
     g_(meshObjects::gravity::New(primaryMesh().time())),
-
     massSource_
     (
         IOobject
@@ -189,7 +177,6 @@ liquidFilmBase::liquidFilmBase
         primaryMesh(),
         dimensionedScalar(dimMass, Zero)
     ),
-
     momentumSource_
     (
         IOobject
@@ -201,7 +188,6 @@ liquidFilmBase::liquidFilmBase
         primaryMesh(),
         dimensionedVector(dimPressure, Zero)
     ),
-
     pnSource_
     (
         IOobject
@@ -213,7 +199,6 @@ liquidFilmBase::liquidFilmBase
         primaryMesh(),
         dimensionedScalar(dimPressure, Zero)
     ),
-
     energySource_
     (
         IOobject
@@ -225,9 +210,7 @@ liquidFilmBase::liquidFilmBase
         primaryMesh(),
         dimensionedScalar(dimEnergy, Zero)
     ),
-
     addedMassTotal_(0),
-
     faOptions_(Foam::fa::options::New(primaryMesh()))
 {
     const areaVectorField& ns = regionMesh().faceAreaNormals();
@@ -401,8 +384,6 @@ tmp<areaScalarField> liquidFilmBase::pg() const
             primaryMesh().lookupObject<volScalarField>(pName_),
             pfg.primitiveFieldRef()
         );
-
-        //pfg -= pRef_;
     }
 
     return tpg;
diff --git a/src/regionFaModels/liquidFilm/liquidFilmBase.H b/src/regionFaModels/liquidFilm/liquidFilmBase.H
index 98d1ec0b62..d65197e484 100644
--- a/src/regionFaModels/liquidFilm/liquidFilmBase.H
+++ b/src/regionFaModels/liquidFilm/liquidFilmBase.H
@@ -105,13 +105,13 @@ protected:
 
         // Solution parameters
 
-            //- Momentum predictor
+            //- Flag to enable momentum predictor
             Switch momentumPredictor_;
 
             //- Number of outer correctors
             label nOuterCorr_;
 
-            //- Number of PISO-like correctors
+            //- Number of PISO-like inner correctors
             label nCorr_;
 
             //- Number of film thickness correctors
@@ -120,10 +120,10 @@ protected:
             //- Cumulative continuity error
             scalar cumulativeContErr_;
 
-            //- Smallest numerical thickness
+            //- Smallest film thickness
             dimensionedScalar h0_;
 
-            //- Delta wet for sub-models
+            //- Film thickness beyond which face is assumed to be wet
             dimensionedScalar deltaWet_;
 
 
@@ -139,7 +139,7 @@ protected:
 
         // Fields
 
-            //- Film hight
+            //- Film height
             areaScalarField h_;
 
             //- Film velocity
@@ -210,7 +210,6 @@ public:
 
     // Constructors
 
-
         //- Construct from type name and mesh and dict
         liquidFilmBase
         (
diff --git a/src/regionFaModels/liquidFilm/liquidFilmModel/liquidFilmModel.C b/src/regionFaModels/liquidFilm/liquidFilmModel/liquidFilmModel.C
index 1aa3078a31..b7e495be63 100644
--- a/src/regionFaModels/liquidFilm/liquidFilmModel/liquidFilmModel.C
+++ b/src/regionFaModels/liquidFilm/liquidFilmModel/liquidFilmModel.C
@@ -31,7 +31,6 @@ License
 #include "gravityMeshObject.H"
 #include "volFields.H"
 
-
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 namespace Foam
@@ -91,9 +90,7 @@ liquidFilmModel::liquidFilmModel
 )
 :
     liquidFilmBase(modelType, mesh, dict),
-
     thermo_(dict.subDict("thermo")),
-
     rho_
     (
         IOobject
@@ -224,7 +221,6 @@ liquidFilmModel::liquidFilmModel
         primaryMesh(),
         dimensionedScalar(dimMass, Zero)
     ),
-
     cloudDiameterTrans_
     (
         IOobject
@@ -238,13 +234,9 @@ liquidFilmModel::liquidFilmModel
         primaryMesh(),
         dimensionedScalar(dimLength, Zero)
     ),
-
     turbulence_(filmTurbulenceModel::New(*this, dict)),
-
     availableMass_(regionMesh().faces().size(), Zero),
-
     injection_(*this, dict),
-
     forces_(*this, dict)
 {
     if (dict.readIfPresent("T0", Tref_))
diff --git a/src/regionFaModels/liquidFilm/liquidFilmModel/liquidFilmModel.H b/src/regionFaModels/liquidFilm/liquidFilmModel/liquidFilmModel.H
index fce0f4f682..dc9ab25bf7 100644
--- a/src/regionFaModels/liquidFilm/liquidFilmModel/liquidFilmModel.H
+++ b/src/regionFaModels/liquidFilm/liquidFilmModel/liquidFilmModel.H
@@ -99,7 +99,7 @@ protected:
         //- Liquid thermo
         liquidMixtureProperties thermo_;
 
-        //- Reference tempararure
+        //- Reference temperature
         scalar Tref_;
 
 
@@ -111,16 +111,16 @@ protected:
         //- Dynamic viscosity [Pa.s]
         areaScalarField mu_;
 
-        //- Film temperature
+        //- Film temperature [K]
         areaScalarField Tf_;
 
-        //- Film Heat capacity
+        //- Film heat capacity [J/K]
         areaScalarField Cp_;
 
-        //- Surface tension [m/s2]
+        //- Surface tension [m/s^2]
         areaScalarField sigma_;
 
-        //- Film rho*height
+        //- Film rho*height [m.kg/m^3]
         areaScalarField hRho_;
 
 
@@ -138,7 +138,7 @@ protected:
 
     // Transfer fields
 
-        //- Film mass  for transfer to cloud
+        //- Film mass for transfer to cloud
         volScalarField cloudMassTrans_;
 
         //- Parcel diameters originating from film to cloud
@@ -159,9 +159,6 @@ protected:
             //- Cloud injection
             injectionModelList injection_;
 
-            //- Transfer with the continuous phase
-            //transferModelList transfer_;
-
             //- List of film forces
             forceList forces_;
 
diff --git a/src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModel.H b/src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModel.H
index df9e58e7d3..199cf53664 100644
--- a/src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModel.H
+++ b/src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModel.H
@@ -169,13 +169,13 @@ protected:
         //- Model dictionary
         const dictionary dict_;
 
-        //- Method used
+        //- Friction model
         const frictionMethodType method_;
 
-        //- Shear method used
+        //- Shear-stress model
         const shearMethodType shearMethod_;
 
-        //- Name of density field (optional)
+        //- Name of density field
         word rhoName_;
 
         //- Reference density needed for incompressible calculations
diff --git a/src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/laminar/laminar.C b/src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/laminar/laminar.C
index 20b764f3dd..eb33b6769c 100644
--- a/src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/laminar/laminar.C
+++ b/src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/laminar/laminar.C
@@ -28,7 +28,6 @@ License
 #include "laminar.H"
 #include "addToRunTimeSelectionTable.H"
 
-
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 namespace Foam
diff --git a/src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/curvatureSeparation/curvatureSeparation.H b/src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/curvatureSeparation/curvatureSeparation.H
index f97db0968d..e451a70b01 100644
--- a/src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/curvatureSeparation/curvatureSeparation.H
+++ b/src/regionFaModels/liquidFilm/subModels/kinematic/injectionModel/curvatureSeparation/curvatureSeparation.H
@@ -125,8 +125,7 @@ protected:
         //- Minimum gravity driven film thickness (non-dimensionalised delta/R1)
         scalar deltaByR1Min_;
 
-        //- List of radii for patches - if patch not defined, radius
-        //- calculated based on mesh geometry
+        //- Patch radius
         scalar definedPatchRadii_;
 
         //- Magnitude of gravity vector
diff --git a/src/regionFaModels/thermalShell/thermalShell.C b/src/regionFaModels/thermalShell/thermalShell.C
index ede4196f9a..0bcded7219 100644
--- a/src/regionFaModels/thermalShell/thermalShell.C
+++ b/src/regionFaModels/thermalShell/thermalShell.C
@@ -90,10 +90,7 @@ tmp<areaScalarField> thermalShell::qr()
 
 void thermalShell::solveEnergy()
 {
-    if (debug)
-    {
-        InfoInFunction << endl;
-    }
+    DebugInFunction << endl;
 
     const areaScalarField rhoCph(Cp()*rho()*h_);
 
diff --git a/src/regionFaModels/thermalShell/thermalShell.H b/src/regionFaModels/thermalShell/thermalShell.H
index de7e8e019a..f509aa2db0 100644
--- a/src/regionFaModels/thermalShell/thermalShell.H
+++ b/src/regionFaModels/thermalShell/thermalShell.H
@@ -123,16 +123,16 @@ protected:
 
         // Source term fields
 
-            //- External surface energy source  / [J/m2/s]
+            //- External surface energy source [J/m2/s]
             areaScalarField qs_;
 
-            //- Thickness
+            //- Film thickness [m]
             areaScalarField h_;
 
             //- Name of the primary region radiative flux
             const word qrName_;
 
-            //- Uniform thickness
+            //- Uniform film thickness [m]
             scalar thickness_;
 
 
@@ -178,7 +178,7 @@ public:
             //- Return the film specific heat capacity [J/kg/K]
             const tmp<areaScalarField> Cp() const;
 
-            //- Return density [Kg/m3]
+            //- Return density [kg/m3]
             const tmp<areaScalarField> rho() const;
 
             //- Return thermal conductivity [W/m/K]
diff --git a/src/regionFaModels/vibrationShellModel/vibrationShellModel.C b/src/regionFaModels/vibrationShellModel/vibrationShellModel.C
index f63bfdee4c..d6a989c444 100644
--- a/src/regionFaModels/vibrationShellModel/vibrationShellModel.C
+++ b/src/regionFaModels/vibrationShellModel/vibrationShellModel.C
@@ -40,7 +40,6 @@ namespace regionModels
 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
 defineTypeNameAndDebug(vibrationShellModel, 0);
-
 defineRunTimeSelectionTable(vibrationShellModel, dictionary);
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //