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 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 namespace dragModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class SyamlalOBrien Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class SyamlalOBrien
54 :
55  public dragModel
56 {
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("SyamlalOBrien");
62 
63 
64  // Constructors
65 
66  //- Construct from components
68  (
69  const dictionary& interfaceDict,
70  const phaseModel& phase1,
71  const phaseModel& phase2
72  );
73 
74 
75  //- Destructor
76  virtual ~SyamlalOBrien();
77 
78 
79  // Member Functions
80 
81  tmp<volScalarField> K(const volScalarField& Ur) const;
82 };
83 
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 } // End namespace dragModels
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************************************************************* //
virtual ~SyamlalOBrien()
Destructor.
TypeName("SyamlalOBrien")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
const phaseModel & phase2() const
Definition: dragModel.H:115
Syamlal, M., Rogers, W. and O&#39;Brien, T. J. (1993) MFIX documentation, Theory Guide. Technical Note DOE/METC-94/1004. Morgantown, West Virginia, USA.
Definition: SyamlalOBrien.H:52
const phaseModel & phase1() const
Definition: dragModel.H:110
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:53
virtual tmp< volScalarField > K() const
Return the drag coefficient K.
SyamlalOBrien(const dictionary &interfaceDict, const phaseModel &phase1, const phaseModel &phase2)
Construct from components.
A class for managing temporary objects.
Definition: PtrList.H:118