SyamlalOBrien.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) 2011-2014 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::SyamlalOBrien
26 
27 Description
28  Syamlal, M., Rogers, W. and O'Brien, T. J. (1993) MFIX documentation,
29  Theory Guide. Technical Note DOE/METC-94/1004. Morgantown, West Virginia,
30  USA.
31 
32 SourceFiles
33  SyamlalOBrien.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef SyamlalOBrien_H
38 #define SyamlalOBrien_H
39 
40 #include "dragModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 class phasePair;
48 
49 namespace dragModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class SyamlalOBrien Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class SyamlalOBrien
57 :
58  public dragModel
59 {
60 public:
61 
62  //- Runtime type information
63  TypeName("SyamlalOBrien");
64 
65 
66  // Constructors
67 
68  //- Construct from a dictionary and a phase pair
70  (
71  const dictionary& dict,
72  const phasePair& pair,
73  const bool registerObject
74  );
75 
76 
77  //- Destructor
78  virtual ~SyamlalOBrien();
79 
80 
81  // Member Functions
82 
83  //- Drag coefficient
84  virtual tmp<volScalarField> CdRe() const;
85 };
86 
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 } // End namespace dragModels
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
virtual ~SyamlalOBrien()
Destructor.
TypeName("SyamlalOBrien")
Runtime type information.
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:290
Namespace for OpenFOAM.
dictionary dict
virtual tmp< volScalarField > CdRe() const
Drag coefficient.
SyamlalOBrien(const dictionary &interfaceDict, const phaseModel &phase1, const phaseModel &phase2)
Construct from components.