segregated.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::dragModels::segregated
26 
27 Description
28  Segregated drag model for use in regions with no obvious dispersed phase.
29 
30  Reference:
31  \verbatim
32  "Towards the Numerical Simulation of Multi-scale Two-phase Flows",
33  Marschall, H.,
34  PhD Thesis, TU M√ľnchen, 2011
35  \endverbatim
36 
37 SourceFiles
38  segregated.C
39 
40 \*---------------------------------------------------------------------------*/
41 
42 #ifndef segregated_H
43 #define segregated_H
44 
45 #include "dragModel.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 class phasePair;
53 
54 namespace dragModels
55 {
56 
57 /*---------------------------------------------------------------------------*\
58  Class segregated Declaration
59 \*---------------------------------------------------------------------------*/
60 
61 class segregated
62 :
63  public dragModel
64 {
65  // Private data
66 
67  //- M coefficient
68  const dimensionedScalar m_;
69 
70  //- N coefficient
71  const dimensionedScalar n_;
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("segregated");
78 
79 
80  // Constructors
81 
82  //- Construct from components
84  (
85  const dictionary& dict,
86  const phasePair& pair,
87  const bool registerObject
88  );
89 
90 
91  //- Destructor
92  virtual ~segregated();
93 
94 
95  // Member Functions
96 
97  //- Drag coefficient
98  virtual tmp<volScalarField> CdRe() const;
99 
100  //- The drag function used in the momentum equation
101  virtual tmp<volScalarField> K() const;
102 
103  //- The drag function Kf used in the face-momentum equations
104  virtual tmp<surfaceScalarField> Kf() const;
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace dragModels
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:290
Namespace for OpenFOAM.
virtual tmp< volScalarField > CdRe() const
Drag coefficient.
dictionary dict
TypeName("segregated")
Runtime type information.
virtual ~segregated()
Destructor.
virtual tmp< surfaceScalarField > Kf() const
The drag function Kf used in the face-momentum equations.
segregated(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from components.
virtual tmp< volScalarField > K() const
The drag function used in the momentum equation.
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.