SyamlalOBrien.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 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 
29  Reference:
30  \verbatim
31  Syamlal, M., Rogers, W., & O’Brien, T. J. (1993).
32  Mfix documentation: Theory guide, technical note, doe/metc-94/1004,
33  ntis/de94000087.
34  National Technical Information Service.
35  \endverbatim
36 
37 SourceFiles
38  SyamlalOBrien.C
39 
40 \*---------------------------------------------------------------------------*/
41 
42 #ifndef SyamlalOBrien_H
43 #define SyamlalOBrien_H
44 
45 #include "dragModel.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 namespace dragModels
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class SyamlalOBrien Declaration
56 \*---------------------------------------------------------------------------*/
57 
58 class SyamlalOBrien
59 :
60  public dragModel
61 {
62 public:
63 
64  //- Runtime type information
65  TypeName("SyamlalOBrien");
66 
67 
68  // Constructors
69 
70  //- Construct from a dictionary and a phase pair
72  (
73  const dictionary& dict,
74  const phasePair& pair,
75  const bool registerObject
76  );
77 
78 
79  //- Destructor
80  virtual ~SyamlalOBrien();
81 
82 
83  // Member Functions
84 
85  //- Drag coefficient
86  virtual tmp<volScalarField> CdRe() const;
87 };
88 
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 } // End namespace dragModels
93 } // End namespace Foam
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #endif
98 
99 // ************************************************************************* //
dictionary dict
SyamlalOBrien(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
TypeName("SyamlalOBrien")
Runtime type information.
virtual ~SyamlalOBrien()
Destructor.
virtual tmp< volScalarField > CdRe() const
Drag coefficient.
A class for managing temporary objects.
Definition: PtrList.H:53
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:339
Namespace for OpenFOAM.