applications/solvers/multiphase/multiphaseInterFoam/multiphaseMixture/phase/phase.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::phase
  26
  27 Description
  28     Single incompressible phase derived from the phase-fraction.
  29     Used as part of the multiPhaseMixture for interface-capturing multi-phase
  30     simulations.
  31
  32 SourceFiles
  33     phase.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef phase_H
  38 #define phase_H
  39
  40 #include "volFields.H"
  41 #include "dictionaryEntry.H"
  42 #include "incompressible/viscosityModels/viscosityModel/viscosityModel.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class phase Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class phase
  54 :
  55     public volScalarField
  56 {
  57     // Private data
  58
  59         word name_;
  60         dictionary phaseDict_;
  61         autoPtr<viscosityModel> nuModel_;
  62         dimensionedScalar rho_;
  63
  64
  65 public:
  66
  67     // Constructors
  68
  69         //- Construct from components
  70         phase
  71         (
  72             const word& name,
  73             const dictionary& phaseDict,
  74             const volVectorField& U,
  75             const surfaceScalarField& phi
  76         );
  77
  78         //- Return clone
  79         autoPtr<phase> clone() const;
  80
  81         //- Return a pointer to a new phase created on freestore
  82         //  from Istream
  83         class iNew
  84         {
  85             const volVectorField& U_;
  86             const surfaceScalarField& phi_;
  87
  88         public:
  89
  90             iNew
  91             (
  92                 const volVectorField& U,
  93                 const surfaceScalarField& phi
  94             )
  95             :
  96                 U_(U),
  97                 phi_(phi)
  98             {}
  99
 100             autoPtr<phase> operator()(Istream& is) const
 101             {
 102                 dictionaryEntry ent(dictionary::null, is);
 103                 return autoPtr<phase>(new phase(ent.keyword(), ent, U_, phi_));
 104             }
 105         };
 106
 107
 108     // Member Functions
 109
 110         const word& name() const
 111         {
 112             return name_;
 113         }
 114
 115         const word& keyword() const
 116         {
 117             return name();
 118         }
 119
 120         //- Return const-access to phase1 viscosityModel
 121         const viscosityModel& nuModel() const
 122         {
 123             return nuModel_();
 124         }
 125
 126         //- Return limited phase indicator
 127         tmp<volScalarField> limitedAlpha() const
 128         {
 129             const volScalarField& alpha = *this;
 130
 131             return Foam::min(Foam::max(alpha, scalar(0)), scalar(1));
 132         }
 133
 134         //- Return the kinematic laminar viscosity
 135         tmp<volScalarField> nu() const
 136         {
 137             return nuModel_->nu();
 138         }
 139
 140         //- Return const-access to phase density
 141         const dimensionedScalar& rho() const
 142         {
 143             return rho_;
 144         }
 145
 146         //- Correct the phase properties
 147         void correct();
 148
 149         //- Read base transportProperties dictionary
 150         bool read(const dictionary& phaseDict);
 151 };
 152
 153
 154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 155
 156 } // End namespace Foam
 157
 158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 159
 160 #endif
 161
 162 // ************************************************************************* //