src/transportModels/interfaceProperties/interfaceProperties.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::interfaceProperties
  26
  27 Description
  28     Contains the interface properties.
  29
  30     Properties to aid interFoam:
  31     -# Correct the alpha boundary condition for dynamic contact angle.
  32     -# Calculate interface curvature.
  33
  34 SourceFiles
  35     interfaceProperties.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef interfaceProperties_H
  40 #define interfaceProperties_H
  41
  42 #include "IOdictionary.H"
  43 #include "volFields.H"
  44 #include "surfaceFields.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                     Class interfaceProperties Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class interfaceProperties
  56 {
  57     // Private data
  58
  59         //- Keep a reference to the transportProperties dictionary
  60         const dictionary& transportPropertiesDict_;
  61
  62         //- Compression coefficient
  63         scalar cAlpha_;
  64
  65         //- Surface tension
  66         dimensionedScalar sigma_;
  67
  68         //- Stabilisation for normalisation of the interface normal
  69         const dimensionedScalar deltaN_;
  70
  71         const volScalarField& alpha1_;
  72         const volVectorField& U_;
  73         surfaceScalarField nHatf_;
  74         volScalarField K_;
  75
  76
  77     // Private Member Functions
  78
  79         //- Disallow default bitwise copy construct and assignment
  80         interfaceProperties(const interfaceProperties&);
  81         void operator=(const interfaceProperties&);
  82
  83         //- Correction for the boundary condition on the unit normal nHat on
  84         //  walls to produce the correct contact dynamic angle
  85         //  calculated from the component of U parallel to the wall
  86         void correctContactAngle
  87         (
  88             surfaceVectorField::GeometricBoundaryField& nHat
  89         ) const;
  90
  91         //- Re-calculate the interface curvature
  92         void calculateK();
  93
  94
  95 public:
  96
  97     //- Conversion factor for degrees into radians
  98     static const scalar convertToRad;
  99
 100
 101     // Constructors
 102
 103         //- Construct from volume fraction field gamma and IOdictionary
 104         interfaceProperties
 105         (
 106             const volScalarField& alpha1,
 107             const volVectorField& U,
 108             const IOdictionary&
 109         );
 110
 111
 112     // Member Functions
 113
 114         scalar cAlpha() const
 115         {
 116             return cAlpha_;
 117         }
 118
 119         const dimensionedScalar& deltaN() const
 120         {
 121             return deltaN_;
 122         }
 123
 124         const surfaceScalarField& nHatf() const
 125         {
 126             return nHatf_;
 127         }
 128
 129         const volScalarField& K() const
 130         {
 131             return K_;
 132         }
 133
 134         const dimensionedScalar& sigma() const
 135         {
 136             return sigma_;
 137         }
 138
 139         tmp<volScalarField> sigmaK() const
 140         {
 141             return sigma_*K_;
 142         }
 143
 144         void correct()
 145         {
 146             calculateK();
 147         }
 148 };
 149
 150
 151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 152
 153 } // End namespace Foam
 154
 155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 156
 157 #endif
 158
 159 // ************************************************************************* //