src/transportModels/incompressible/incompressibleTwoPhaseMixture/twoPhaseMixture.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::twoPhaseMixture
  26
  27 Description
  28     A two-phase incompressible transportModel
  29
  30 SourceFiles
  31     twoPhaseMixture.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef twoPhaseMixture_H
  36 #define twoPhaseMixture_H
  37
  38 #include "incompressible/transportModel/transportModel.H"
  39 #include "incompressible/viscosityModels/viscosityModel/viscosityModel.H"
  40 #include "dimensionedScalar.H"
  41 #include "volFields.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                       Class twoPhaseMixture Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class twoPhaseMixture
  53 :
  54     public transportModel
  55 {
  56 protected:
  57
  58     // Protected data
  59
  60         word phase1Name_;
  61         word phase2Name_;
  62
  63         autoPtr<viscosityModel> nuModel1_;
  64         autoPtr<viscosityModel> nuModel2_;
  65
  66         dimensionedScalar rho1_;
  67         dimensionedScalar rho2_;
  68
  69         const volVectorField& U_;
  70         const surfaceScalarField& phi_;
  71
  72         const volScalarField& alpha1_;
  73
  74         volScalarField nu_;
  75
  76
  77     // Private Member Functions
  78
  79         //- Get phase name (backward compatibility)
  80         word getPhaseName(const word& key) const;
  81
  82         //- Calculate and return the laminar viscosity
  83         void calcNu();
  84
  85
  86 public:
  87
  88     // Constructors
  89
  90         //- Construct from components
  91         twoPhaseMixture
  92         (
  93             const volVectorField& U,
  94             const surfaceScalarField& phi,
  95             const word& alpha1Name = "alpha1"
  96         );
  97
  98
  99     // Destructor
 100
 101         virtual ~twoPhaseMixture()
 102         {}
 103
 104
 105     // Member Functions
 106
 107         const word& phase1Name() const
 108         {
 109             return phase1Name_;
 110         }
 111
 112         const word& phase2Name() const
 113         {
 114             return phase2Name_;
 115         }
 116
 117         //- Return const-access to phase1 viscosityModel
 118         const viscosityModel& nuModel1() const
 119         {
 120             return nuModel1_();
 121         }
 122
 123         //- Return const-access to phase2 viscosityModel
 124         const viscosityModel& nuModel2() const
 125         {
 126             return nuModel2_();
 127         }
 128
 129         //- Return const-access to phase1 density
 130         const dimensionedScalar& rho1() const
 131         {
 132             return rho1_;
 133         }
 134
 135         //- Return const-access to phase2 density
 136         const dimensionedScalar& rho2() const
 137         {
 138             return rho2_;
 139         };
 140
 141         //- Return the density
 142         tmp<volScalarField> rho() const;
 143
 144         //- Return the dynamic laminar viscosity
 145         tmp<volScalarField> mu() const;
 146
 147         //- Return the face-interpolated dynamic laminar viscosity
 148         tmp<surfaceScalarField> muf() const;
 149
 150         //- Return the kinematic laminar viscosity
 151         virtual const volScalarField& nu() const
 152         {
 153             return nu_;
 154         }
 155
 156         //- Return the face-interpolated dynamic laminar viscosity
 157         tmp<surfaceScalarField> nuf() const;
 158
 159         //- Correct the laminar viscosity
 160         virtual void correct()
 161         {
 162             calcNu();
 163         }
 164
 165         //- Read base transportProperties dictionary
 166         virtual bool read();
 167 };
 168
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 } // End namespace Foam
 173
 174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 175
 176 #endif
 177
 178 // ************************************************************************* //