ENH: DES models - added access function for shielding function, fd

src/TurbulenceModels/turbulenceModels/DES/DESModel/DESModel.C

@@ -166,6 +166,25 @@ tmp<volScalarField> DESModel<BasicTurbulenceModel>::Ssigma
 }
 
 
+template<class BasicTurbulenceModel>
+tmp<volScalarField> DESModel<BasicTurbulenceModel>::fd() const
+{
+    return tmp<volScalarField>::New
+    (
+        IOobject
+        (
+            "fd",
+            this->mesh_.time().timeName(),
+            this->mesh_,
+            IOobject::NO_READ,
+            IOobject::NO_WRITE
+        ),
+        this->mesh_,
+        dimensionedScalar(dimless, Zero)
+    );
+}
+
+
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 } // End namespace LESModels

src/TurbulenceModels/turbulenceModels/DES/DESModel/DESModel.H

@@ -120,7 +120,10 @@ public:
 
         //- Return modified strain rate
         //  Note: uses Ctrans_ coefficient
-        tmp<volScalarField> Ssigma(const volTensorField& gradU) const;
+        virtual tmp<volScalarField> Ssigma(const volTensorField& gradU) const;
+
+        //- Return the shielding function
+        virtual tmp<volScalarField> fd() const;
 };
 
 

src/TurbulenceModels/turbulenceModels/DES/DESModel/DESModelBase.C

@@ -23,16 +23,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Class
-    Foam::DESModelBase
-
-Description
-    Base class for DES models providing an interfaces to the LESRegion
-    function.
-
-SourceFiles
-    DESModelBase.C
-
 \*---------------------------------------------------------------------------*/
 
 #include "DESModelBase.H"

src/TurbulenceModels/turbulenceModels/DES/DESModel/DESModelBase.H

@@ -6,7 +6,7 @@
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2015 OpenFOAM Foundation
-    Copyright (C) 2019 OpenCFD Ltd.
+    Copyright (C) 2019-2022 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -28,8 +28,7 @@ Class
     Foam::DESModelBase
 
 Description
-    Base class for DES models providing an interfaces to the LESRegion
-    function.
+    Base class for DES models providing an interfaces to DES fields.
 
 SourceFiles
     DESModelBase.C
@@ -70,6 +69,9 @@ public:
 
         //- Return the LES field indicator
         virtual tmp<volScalarField> LESRegion() const = 0;
+
+        //- Return the shielding function
+        virtual tmp<volScalarField> fd() const = 0;
 };
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasDDES/SpalartAllmarasDDES.C

@@ -189,6 +189,13 @@ bool SpalartAllmarasDDES<BasicTurbulenceModel>::read()
 }
 
 
+template<class BasicTurbulenceModel>
+tmp<volScalarField> SpalartAllmarasDDES<BasicTurbulenceModel>::fd() const
+{
+    return fd(mag(fvc::grad(this->U_)));
+}
+
+
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 } // End namespace LESModels

src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasDDES/SpalartAllmarasDDES.H

@@ -147,6 +147,9 @@ public:
 
         //- Read from dictionary
         virtual bool read();
+
+        //- Return the shielding function
+        virtual tmp<volScalarField> fd() const;
 };
 
 

src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.C

@@ -236,6 +236,17 @@ bool SpalartAllmarasIDDES<BasicTurbulenceModel>::read()
 }
 
 
+template<class BasicTurbulenceModel>
+tmp<volScalarField> SpalartAllmarasIDDES<BasicTurbulenceModel>::fd() const
+{
+    const volScalarField alpha(this->alpha());
+    const volScalarField expTerm(exp(sqr(alpha)));
+
+    tmp<volScalarField> fB = min(2*pow(expTerm, -9.0), scalar(1));
+    return max(1 - fdt(mag(fvc::grad(this->U_))), fB);
+}
+
+
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 } // End namespace LESModels

src/TurbulenceModels/turbulenceModels/DES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H

@@ -153,6 +153,9 @@ public:
 
         //- Re-read model coefficients if they have changed
         virtual bool read();
+
+        //- Return the shielding function
+        virtual tmp<volScalarField> fd() const;
 };
 
 

src/TurbulenceModels/turbulenceModels/DES/kOmegaSSTDDES/kOmegaSSTDDES.C

@@ -201,6 +201,13 @@ bool kOmegaSSTDDES<BasicTurbulenceModel>::read()
 }
 
 
+template<class BasicTurbulenceModel>
+tmp<volScalarField> kOmegaSSTDDES<BasicTurbulenceModel>::fd() const
+{
+    return fd(mag(fvc::grad(this->U_)));
+}
+
+
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 } // End namespace LESModels

src/TurbulenceModels/turbulenceModels/DES/kOmegaSSTDDES/kOmegaSSTDDES.H

@@ -157,6 +157,9 @@ public:
 
         //- Re-read model coefficients if they have changed
         virtual bool read();
+
+        //- Return the shielding function
+        virtual tmp<volScalarField> fd() const;
 };
 
 

src/TurbulenceModels/turbulenceModels/DES/kOmegaSSTDES/kOmegaSSTDES.H

@@ -93,7 +93,7 @@ protected:
 
             dimensionedScalar kappa_;
 
-	    //- DES coefficients
+            //- DES coefficients
             dimensionedScalar CDESkom_;
             dimensionedScalar CDESkeps_;
 

src/TurbulenceModels/turbulenceModels/DES/kOmegaSSTIDDES/kOmegaSSTIDDES.C

@@ -231,6 +231,17 @@ bool kOmegaSSTIDDES<BasicTurbulenceModel>::read()
 }
 
 
+template<class BasicTurbulenceModel>
+tmp<volScalarField> kOmegaSSTIDDES<BasicTurbulenceModel>::fd() const
+{
+    const volScalarField alpha(this->alpha());
+    const volScalarField expTerm(exp(sqr(alpha)));
+
+    tmp<volScalarField> fB = min(2*pow(expTerm, -9.0), scalar(1));
+    return max(1 - fdt(mag(fvc::grad(this->U_))), fB);
+}
+
+
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 } // End namespace LESModels

src/TurbulenceModels/turbulenceModels/DES/kOmegaSSTIDDES/kOmegaSSTIDDES.H

@@ -149,6 +149,9 @@ public:
 
         //- Re-read model coefficients if they have changed
         virtual bool read();
+
+        //- Return the shielding function
+        virtual tmp<volScalarField> fd() const;
 };