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