applications/solvers/multiphase/twoPhaseEulerFoam/phaseModel/phaseModel/phaseModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::phaseModel
  27
  28 SourceFiles
  29     phaseModel.C
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef phaseModel_H
  34 #define phaseModel_H
  35
  36 #include "dictionary.H"
  37 #include "dimensionedScalar.H"
  38 #include "volFields.H"
  39 #include "surfaceFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class phaseModel Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class phaseModel
  51 {
  52     // Private data
  53
  54         dictionary dict_;
  55
  56         //- Name of phase
  57         word name_;
  58
  59         //- Characteristic diameter of phase
  60         dimensionedScalar d_;
  61
  62         //- kinematic viscosity
  63         dimensionedScalar nu_;
  64
  65         //- density
  66         dimensionedScalar rho_;
  67
  68         //- Velocity
  69         volVectorField U_;
  70
  71         //- Fluxes
  72         autoPtr<surfaceScalarField> phiPtr_;
  73
  74
  75 public:
  76
  77     // Constructors
  78
  79         phaseModel
  80         (
  81             const fvMesh& mesh,
  82             const dictionary& transportProperties,
  83             const word& phaseName
  84         );
  85
  86
  87     // Selectors
  88
  89         //- Return a reference to the selected turbulence model
  90         static autoPtr<phaseModel> New
  91         (
  92             const fvMesh& mesh,
  93             const dictionary& transportProperties,
  94             const word& phaseName
  95         );
  96
  97
  98     //- Destructor
  99     virtual ~phaseModel();
 100
 101
 102     // Member Functions
 103
 104         const word& name() const
 105         {
 106             return name_;
 107         }
 108
 109         const dimensionedScalar& d() const
 110         {
 111             return d_;
 112         }
 113
 114         const dimensionedScalar& nu() const
 115         {
 116             return nu_;
 117         }
 118
 119         const dimensionedScalar& rho() const
 120         {
 121             return rho_;
 122         }
 123
 124         const volVectorField& U() const
 125         {
 126             return U_;
 127         }
 128
 129         volVectorField& U()
 130         {
 131             return U_;
 132         }
 133
 134         const surfaceScalarField& phi() const
 135         {
 136             return phiPtr_();
 137         }
 138
 139         surfaceScalarField& phi()
 140         {
 141             return phiPtr_();
 142         }
 143 };
 144
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 } // End namespace Foam
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 #endif
 153
 154 // ************************************************************************* //