simple.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) 2014-2015 OpenFOAM Foundation
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::simple
26 
27 Description
28  Simple relative velocity model
29 
30 SourceFiles
31  simple.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef simple_H
36 #define simple_H
37 
38 #include "relativeVelocityModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace relativeVelocityModels
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class simple Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class simple
52 :
54 {
55  // Private data
56 
57  //- A coefficient
59 
60  //- Drift velocity
62 
63  //- Residual phase fraction
64  dimensionedScalar residualAlpha_;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("simple");
71 
72 
73  // Constructors
74 
75  //- Construct from components
76  simple
77  (
78  const dictionary& dict,
80  );
81 
82 
83  //- Destructor
84  ~simple();
85 
86 
87  // Member Functions
88 
89  //- Update the diffusion velocity
90  virtual void correct();
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace relativeVelocityModels
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual void correct()
Update the diffusion velocity.
dictionary dict
A two-phase incompressible transportModel for interacting phases requiring the direct evaluation of t...
simple(const dictionary &dict, const incompressibleTwoPhaseInteractingMixture &mixture)
Construct from components.
TypeName("simple")
Runtime type information.