Solvers based on p_rgh: Added support for optional hRef

Allows the specification of a reference height, for example the height
of the free-surface in a VoF simulation, which reduces the range of p_rgh.

hRef is a uniformDimensionedScalarField specified via the constant/hRef
file, equivalent to the way in which g is specified, so that it can be
looked-up from the database.  For example see the constant/hRef file in
the DTCHull LTSInterFoam and interDyMFoam cases.

applications/solvers/combustion/fireFoam/createFields.H

@@ -101,10 +101,14 @@
     volScalarField K("K", 0.5*magSqr(U));
 
 
-    Info<< "Calculating field g.h\n" << endl;
+    #include "readGravitationalAcceleration.H"
-    volScalarField gh("gh", g & mesh.C());
+    #include "readhRef.H"
+
+    Info<< "Calculating field g.h\n" << endl;
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
 
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
 
     volScalarField p_rgh
     (

applications/solvers/combustion/fireFoam/fireFoam.C

@@ -54,7 +54,6 @@ int main(int argc, char *argv[])
 
     pimpleControl pimple(mesh);
 
-    #include "readGravitationalAcceleration.H"
     #include "createFields.H"
     #include "createFvOptions.H"
     #include "createClouds.H"

applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/createFields.H

@@ -63,9 +63,14 @@ autoPtr<compressible::turbulenceModel> turbulence
 reaction->setTurbulence(turbulence());
 
 
+#include "readGravitationalAcceleration.H"
+#include "readhRef.H"
+
 Info<< "Calculating field g.h\n" << endl;
-volScalarField gh("gh", g & mesh.C());
+dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
-surfaceScalarField ghf("ghf", g & mesh.Cf());
+volScalarField gh("gh", (g & mesh.C()) - ghRef);
+surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
+
 
 Info<< "Reading field p_rgh\n" << endl;
 volScalarField p_rgh

applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C

@@ -48,7 +48,6 @@ int main(int argc, char *argv[])
 
     pimpleControl pimple(mesh);
 
-    #include "readGravitationalAcceleration.H"
     #include "createFields.H"
     #include "createFvOptions.H"
     #include "initContinuityErrs.H"

applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C

@@ -63,7 +63,6 @@ int main(int argc, char *argv[])
 
     pimpleControl pimple(mesh);
 
-    #include "readGravitationalAcceleration.H"
     #include "createFields.H"
     #include "createIncompressibleRadiationModel.H"
     #include "createFvOptions.H"

applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/createFields.H

@@ -79,9 +79,15 @@
         mesh
     );
 
+
+    #include "readGravitationalAcceleration.H"
+    #include "readhRef.H"
+
     Info<< "Calculating field g.h\n" << endl;
-    volScalarField gh("gh", g & mesh.C());
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
+
 
     volScalarField p
     (

applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C

@@ -62,7 +62,6 @@ int main(int argc, char *argv[])
 
     simpleControl simple(mesh);
 
-    #include "readGravitationalAcceleration.H"
     #include "createFields.H"
     #include "createFvOptions.H"
     #include "initContinuityErrs.H"

applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/createFields.H

@@ -79,9 +79,15 @@
         mesh
     );
 
+
+    #include "readGravitationalAcceleration.H"
+    #include "readhRef.H"
+
     Info<< "Calculating field g.h\n" << endl;
-    volScalarField gh("gh", g & mesh.C());
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
+
 
     volScalarField p
     (

applications/solvers/lagrangian/reactingParcelFilmFoam/createFields.H

@@ -80,10 +80,15 @@
     Info<< "Creating field kinetic energy K\n" << endl;
     volScalarField K("K", 0.5*magSqr(U));
 
-    Info<< "Calculating field g.h\n" << endl;
-    volScalarField gh("gh", g & mesh.C());
 
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
+    #include "readGravitationalAcceleration.H"
+    #include "readhRef.H"
+
+    Info<< "Calculating field g.h\n" << endl;
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
+
 
     volScalarField p_rgh
     (

applications/solvers/lagrangian/reactingParcelFilmFoam/reactingParcelFilmFoam.C

@@ -52,7 +52,6 @@ int main(int argc, char *argv[])
 
     pimpleControl pimple(mesh);
 
-    #include "readGravitationalAcceleration.H"
     #include "createFields.H"
     #include "createFvOptions.H"
     #include "createClouds.H"

applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C

@@ -56,7 +56,6 @@ int main(int argc, char *argv[])
     #include "setRootCase.H"
     #include "createTime.H"
     #include "createDynamicFvMesh.H"
-    #include "readGravitationalAcceleration.H"
     #include "initContinuityErrs.H"
 
     pimpleControl pimple(mesh);
@@ -98,8 +97,8 @@ int main(int argc, char *argv[])
                     << runTime.elapsedCpuTime() - timeBeforeMeshUpdate
                     << " s" << endl;
 
-                gh = g & mesh.C();
+                gh = (g & mesh.C()) - ghRef;
-                ghf = g & mesh.Cf();
+                ghf = (g & mesh.Cf()) - ghRef;
             }
 
             if (mesh.changing() && correctPhi)

applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C

@@ -53,7 +53,6 @@ int main(int argc, char *argv[])
     #include "setRootCase.H"
     #include "createTime.H"
     #include "createMesh.H"
-    #include "readGravitationalAcceleration.H"
 
     pimpleControl pimple(mesh);
 

applications/solvers/multiphase/compressibleInterFoam/createFields.H

@@ -57,11 +57,22 @@
     );
 
 
-    dimensionedScalar pMin(mixture.lookup("pMin"));
+    dimensionedScalar pMin
+    (
+        "pMin",
+        dimPressure,
+        mixture.lookup("pMin")
+    );
+
+
+    #include "readGravitationalAcceleration.H"
+    #include "readhRef.H"
 
     Info<< "Calculating field g.h\n" << endl;
-    volScalarField gh("gh", g & mesh.C());
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
+
 
     // Mass flux
     // Initialisation does not matter because rhoPhi is reset after the

applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C

@@ -48,7 +48,6 @@ int main(int argc, char *argv[])
     #include "setRootCase.H"
     #include "createTime.H"
     #include "createMesh.H"
-    #include "readGravitationalAcceleration.H"
 
     pimpleControl pimple(mesh);
 

applications/solvers/multiphase/compressibleMultiphaseInterFoam/createFields.H

@@ -49,9 +49,14 @@
     dimensionedScalar pMin(mixture.lookup("pMin"));
 
 
+    #include "readGravitationalAcceleration.H"
+    #include "readhRef.H"
+
     Info<< "Calculating field g.h\n" << endl;
-    volScalarField gh("gh", g & mesh.C());
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
+
 
     // Construct compressible turbulence model
     autoPtr<compressible::turbulenceModel> turbulence

applications/solvers/multiphase/driftFluxFoam/createFields.H

@@ -90,9 +90,15 @@
         ::New(rho, U, rhoPhi, mixture)
     );
 
-    Info<< "Calculating field (g.h)f\n" << endl;
+
-    volScalarField gh("gh", g & mesh.C());
+    #include "readGravitationalAcceleration.H"
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
+    #include "readhRef.H"
+
+    Info<< "Calculating field g.h\n" << endl;
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
+
 
     volScalarField p
     (

applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C

@@ -57,7 +57,6 @@ int main(int argc, char *argv[])
 
     pimpleControl pimple(mesh);
 
-    #include "readGravitationalAcceleration.H"
     #include "createFields.H"
     #include "createFvOptions.H"
     #include "initContinuityErrs.H"

applications/solvers/multiphase/interFoam/createFields.H

@@ -77,10 +77,12 @@
     );
 
     #include "readGravitationalAcceleration.H"
+    #include "readhRef.H"
 
     Info<< "Calculating field g.h\n" << endl;
-    volScalarField gh("gh", g & mesh.C());
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
 
     volScalarField p
     (

applications/solvers/multiphase/interFoam/interDyMFoam/interDyMFoam.C

@@ -110,8 +110,8 @@ int main(int argc, char *argv[])
                         << runTime.elapsedCpuTime() - timeBeforeMeshUpdate
                         << " s" << endl;
 
-                    gh = g & mesh.C();
+                    gh = (g & mesh.C()) - ghRef;
-                    ghf = g & mesh.Cf();
+                    ghf = (g & mesh.Cf()) - ghRef;
                 }
 
                 if (mesh.changing() && correctPhi)

applications/solvers/multiphase/interFoam/interMixingFoam/createFields.H

@@ -79,10 +79,13 @@
         incompressible::turbulenceModel::New(U, phi, mixture)
     );
 
+    #include "readGravitationalAcceleration.H"
+    #include "readhRef.H"
 
     Info<< "Calculating field g.h\n" << endl;
-    volScalarField gh("gh", g & mesh.C());
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
 
     volScalarField p
     (

applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C

@@ -50,7 +50,6 @@ int main(int argc, char *argv[])
 
     pimpleControl pimple(mesh);
 
-    #include "readGravitationalAcceleration.H"
     #include "initContinuityErrs.H"
     #include "createFields.H"
     #include "createFvOptions.H"

applications/solvers/multiphase/interPhaseChangeFoam/createFields.H

@@ -67,9 +67,14 @@
     );
 
 
+    #include "readGravitationalAcceleration.H"
+    #include "readhRef.H"
+
     Info<< "Calculating field g.h\n" << endl;
-    volScalarField gh("gh", g & mesh.C());
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
+
 
     volScalarField p
     (

applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C

@@ -63,7 +63,6 @@ int main(int argc, char *argv[])
 
     pimpleControl pimple(mesh);
 
-    #include "readGravitationalAcceleration.H"
     #include "initContinuityErrs.H"
     #include "createFields.H"
     #include "createFvOptions.H"
@@ -122,8 +121,8 @@ int main(int argc, char *argv[])
                         << runTime.elapsedCpuTime() - timeBeforeMeshUpdate
                         << " s" << endl;
 
-                    gh = g & mesh.C();
+                    gh = (g & mesh.C()) - ghRef;
-                    ghf = g & mesh.Cf();
+                    ghf = (g & mesh.Cf()) - ghRef;
                 }
 
                 if (mesh.changing() && correctPhi)

applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C

@@ -60,7 +60,6 @@ int main(int argc, char *argv[])
 
     pimpleControl pimple(mesh);
 
-    #include "readGravitationalAcceleration.H"
     #include "initContinuityErrs.H"
     #include "createFields.H"
     #include "createFvOptions.H"

applications/solvers/multiphase/multiphaseInterFoam/createFields.H

@@ -52,11 +52,15 @@
         incompressible::turbulenceModel::New(U, phi, mixture)
     );
 
+
     #include "readGravitationalAcceleration.H"
+    #include "readhRef.H"
 
     Info<< "Calculating field g.h\n" << endl;
-    volScalarField gh("gh", g & mesh.C());
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
+
 
     volScalarField p
     (

applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterDyMFoam/multiphaseInterDyMFoam.C

@@ -106,8 +106,8 @@ int main(int argc, char *argv[])
                         << runTime.elapsedCpuTime() - timeBeforeMeshUpdate
                         << " s" << endl;
 
-                    gh = g & mesh.C();
+                    gh = (g & mesh.C()) - ghRef;
-                    ghf = g & mesh.Cf();
+                    ghf = (g & mesh.Cf()) - ghRef;
                 }
 
                 if (mesh.changing() && correctPhi)

applications/solvers/multiphase/twoLiquidMixingFoam/createFields.H

@@ -69,9 +69,15 @@
         incompressible::turbulenceModel::New(U, phi, mixture)
     );
 
+
+    #include "readGravitationalAcceleration.H"
+    #include "readhRef.H"
+
     Info<< "Calculating field g.h\n" << endl;
-    volScalarField gh("gh", g & mesh.C());
+    dimensionedScalar ghRef(g & (cmptMag(g.value())/mag(g.value()))*hRef);
-    surfaceScalarField ghf("ghf", g & mesh.Cf());
+    volScalarField gh("gh", (g & mesh.C()) - ghRef);
+    surfaceScalarField ghf("ghf", (g & mesh.Cf()) - ghRef);
+
 
     volScalarField p
     (

applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C

@@ -49,7 +49,6 @@ int main(int argc, char *argv[])
 
     pimpleControl pimple(mesh);
 
-    #include "readGravitationalAcceleration.H"
     #include "initContinuityErrs.H"
     #include "createFields.H"
     #include "readTimeControls.H"

src/finiteVolume/cfdTools/general/include/readhRef.H

@@ -0,0 +1,13 @@
+    Info<< "\nReading hRef" << endl;
+    uniformDimensionedScalarField hRef
+    (
+        IOobject
+        (
+            "hRef",
+            runTime.constant(),
+            mesh,
+            IOobject::READ_IF_PRESENT,
+            IOobject::NO_WRITE
+        ),
+        dimensionedScalar("hRef", dimLength, 0)
+    );

tutorials/multiphase/LTSInterFoam/DTCHull/constant/hRef

@@ -0,0 +1,21 @@
+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  dev                                   |
+|   \\  /    A nd           | Web:      www.OpenFOAM.org                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+FoamFile
+{
+    version     2.0;
+    format      ascii;
+    class       uniformDimensionedScalarField;
+    location    "constant";
+    object      hRef;
+}
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+dimensions      [0 1 0 0 0 0 0];
+value           0.244;
+
+// ************************************************************************* //

tutorials/multiphase/interDyMFoam/ras/DTCHull/constant/hRef

@@ -0,0 +1,21 @@
+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  dev                                   |
+|   \\  /    A nd           | Web:      www.OpenFOAM.org                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+FoamFile
+{
+    version     2.0;
+    format      ascii;
+    class       uniformDimensionedScalarField;
+    location    "constant";
+    object      hRef;
+}
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+dimensions      [0 1 0 0 0 0 0];
+value           0.244;
+
+// ************************************************************************* //