src/regionModels/surfaceFilmModels/kinematicSingleLayer/kinematicSingleLayerI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "surfaceInterpolate.H"
  27 #include "fvcSurfaceIntegrate.H"
  28
  29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33 namespace regionModels
  34 {
  35 namespace surfaceFilmModels
  36 {
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 inline const Switch& kinematicSingleLayer::momentumPredictor() const
  41 {
  42     return momentumPredictor_;
  43 }
  44
  45
  46 inline label kinematicSingleLayer::nOuterCorr() const
  47 {
  48     return nOuterCorr_;
  49 }
  50
  51
  52 inline label kinematicSingleLayer::nCorr() const
  53 {
  54     return nCorr_;
  55 }
  56
  57
  58 inline label kinematicSingleLayer::nNonOrthCorr() const
  59 {
  60     return nNonOrthCorr_;
  61 }
  62
  63
  64 inline const volScalarField& kinematicSingleLayer::mu() const
  65 {
  66     return mu_;
  67 }
  68
  69
  70 inline const volScalarField& kinematicSingleLayer::sigma() const
  71 {
  72     return sigma_;
  73 }
  74
  75
  76 inline const volScalarField& kinematicSingleLayer::delta() const
  77 {
  78     return delta_;
  79 }
  80
  81
  82 inline volVectorField& kinematicSingleLayer::USpPrimary()
  83 {
  84     return USpPrimary_;
  85 }
  86
  87
  88 inline volScalarField& kinematicSingleLayer::pSpPrimary()
  89 {
  90     return pSpPrimary_;
  91 }
  92
  93
  94 inline volScalarField& kinematicSingleLayer::rhoSpPrimary()
  95 {
  96     return rhoSpPrimary_;
  97 }
  98
  99
 100 inline volVectorField& kinematicSingleLayer::USp()
 101 {
 102     return USp_;
 103 }
 104
 105
 106 inline volScalarField& kinematicSingleLayer::pSp()
 107 {
 108     return pSp_;
 109 }
 110
 111
 112 inline volScalarField& kinematicSingleLayer::rhoSp()
 113 {
 114     return rhoSp_;
 115 }
 116
 117
 118 inline const volVectorField& kinematicSingleLayer::USp() const
 119 {
 120     return USp_;
 121 }
 122
 123
 124 inline const volScalarField& kinematicSingleLayer::pSp() const
 125 {
 126     return pSp_;
 127 }
 128
 129
 130 inline const volScalarField& kinematicSingleLayer::rhoSp() const
 131 {
 132     return rhoSp_;
 133 }
 134
 135
 136 inline const volVectorField& kinematicSingleLayer::UPrimary() const
 137 {
 138     return UPrimary_;
 139 }
 140
 141
 142 inline const volScalarField& kinematicSingleLayer::pPrimary() const
 143 {
 144     return pPrimary_;
 145 }
 146
 147
 148 inline const volScalarField& kinematicSingleLayer::rhoPrimary() const
 149 {
 150     return rhoPrimary_;
 151 }
 152
 153
 154 inline const volScalarField& kinematicSingleLayer::muPrimary() const
 155 {
 156     return muPrimary_;
 157 }
 158
 159
 160 inline injectionModelList& kinematicSingleLayer::injection()
 161 {
 162     return injection_;
 163 }
 164
 165
 166 inline tmp<volScalarField> kinematicSingleLayer::mass() const
 167 {
 168     return rho_*delta_*magSf();
 169 }
 170
 171
 172 inline tmp<volScalarField> kinematicSingleLayer::netMass() const
 173 {
 174     dimensionedScalar d0("SMALL", dimLength, ROOTVSMALL);
 175     return
 176         fvc::surfaceSum(phi_/(fvc::interpolate(delta_) + d0))*time().deltaT()
 177       + rho_*delta_*magSf();
 178 }
 179
 180
 181 inline tmp<volScalarField> kinematicSingleLayer::gNorm() const
 182 {
 183     tmp<volScalarField> tgNorm
 184     (
 185         new volScalarField
 186         (
 187             IOobject
 188             (
 189                 "gNorm",
 190                 time().timeName(),
 191                 regionMesh(),
 192                 IOobject::NO_READ,
 193                 IOobject::NO_WRITE
 194             ),
 195             g_ & nHat(),
 196             zeroGradientFvPatchScalarField::typeName
 197         )
 198     );
 199
 200     return tgNorm;
 201 }
 202
 203
 204 inline tmp<volScalarField> kinematicSingleLayer::gNormClipped() const
 205 {
 206     tmp<volScalarField> tgNormClipped
 207     (
 208         new volScalarField
 209         (
 210             IOobject
 211             (
 212                 "gNormClipped",
 213                 time().timeName(),
 214                 regionMesh(),
 215                 IOobject::NO_READ,
 216                 IOobject::NO_WRITE
 217             ),
 218             g_ & nHat(),
 219             zeroGradientFvPatchScalarField::typeName
 220         )
 221     );
 222
 223     volScalarField& gNormClipped = tgNormClipped();
 224     gNormClipped.min(0.0);
 225
 226     return tgNormClipped;
 227 }
 228
 229
 230 inline tmp<volVectorField> kinematicSingleLayer::gTan() const
 231 {
 232     tmp<volVectorField> tgTan
 233     (
 234         new volVectorField
 235         (
 236             IOobject
 237             (
 238                 "gTan",
 239                 time().timeName(),
 240                 regionMesh(),
 241                 IOobject::NO_READ,
 242                 IOobject::NO_WRITE
 243             ),
 244             g_ - nHat()*gNorm(),
 245             zeroGradientFvPatchVectorField::typeName
 246         )
 247     );
 248
 249     return tgTan;
 250 }
 251
 252
 253 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 254
 255 } // End namespace surfaceFilmModels
 256 } // End namespace regionModels
 257 } // End namespace Foam
 258
 259 // ************************************************************************* //