FreeFOAM The Cross-Platform CFD Toolkit
phaseModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
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 Class
25  Foam::phaseModel
26 
27 SourceFiles
28  phaseModel.C
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef phaseModel_H
33 #define phaseModel_H
34 
35 #include <OpenFOAM/dictionary.H>
37 #include <finiteVolume/volFields.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class phaseModel Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 {
51  // Private data
52 
53  dictionary dict_;
54 
55  //- Name of phase
56  word name_;
57 
58  //- Characteristic diameter of phase
60 
61  //- kinematic viscosity
63 
64  //- density
65  dimensionedScalar rho_;
66 
67  //- Velocity
68  volVectorField U_;
69 
70  //- Fluxes
72 
73 
74 public:
75 
76  // Constructors
77 
79  (
80  const fvMesh& mesh,
82  const word& phaseName
83  );
84 
85 
86  // Selectors
87 
88  //- Return a reference to the selected turbulence model
90  (
91  const fvMesh& mesh,
92  const dictionary& transportProperties,
93  const word& phaseName
94  );
95 
96 
97  //- Destructor
98  virtual ~phaseModel();
99 
100 
101  // Member Functions
102 
103  const word& name() const
104  {
105  return name_;
106  }
107 
108  const dimensionedScalar& d() const
109  {
110  return d_;
111  }
112 
113  const dimensionedScalar& nu() const
114  {
115  return nu_;
116  }
117 
118  const dimensionedScalar& rho() const
119  {
120  return rho_;
121  }
122 
123  const volVectorField& U() const
124  {
125  return U_;
126  }
127 
129  {
130  return U_;
131  }
132 
133  const surfaceScalarField& phi() const
134  {
135  return phiPtr_();
136  }
137 
139  {
140  return phiPtr_();
141  }
142 };
143 
144 
145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146 
147 } // End namespace Foam
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 #endif
152 
153 // ************************ vim: set sw=4 sts=4 et: ************************ //