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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2014 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::dragModels::SyamlalOBrien
28
29Description
30 Syamlal, M., Rogers, W. and O'Brien, T. J. (1993) MFIX documentation,
31 Theory Guide. Technical Note DOE/METC-94/1004. Morgantown, West Virginia,
32 USA.
33
34SourceFiles
35 SyamlalOBrien.C
36
37\*---------------------------------------------------------------------------*/
38
39#ifndef SyamlalOBrien_H
40#define SyamlalOBrien_H
41
42#include "dragModel.H"
43
44// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46namespace Foam
47{
48
49class phasePair;
50
51namespace dragModels
52{
53
54/*---------------------------------------------------------------------------*\
55 Class SyamlalOBrien Declaration
56\*---------------------------------------------------------------------------*/
57
58class SyamlalOBrien
59:
60 public dragModel
61{
62public:
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// ************************************************************************* //
bool registerObject() const noexcept
Should object created with this IOobject be registered?
Definition: IOobjectI.H:107
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
virtual ~SyamlalOBrien()
Destructor.
Definition: SyamlalOBrien.C:59
virtual ~SyamlalOBrien()
Destructor.
TypeName("SyamlalOBrien")
Runtime type information.
SyamlalOBrien(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
virtual tmp< volScalarField > CdRe() const
Drag coefficient.
virtual tmp< volScalarField > CdRe() const
Drag coefficient.
Definition: SyamlalOBrien.C:65
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:56
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73