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 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::dragModels::SyamlalOBrien
28 
29 Description
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 
34 SourceFiles
35  SyamlalOBrien.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef SyamlalOBrien_H
40 #define SyamlalOBrien_H
41 
42 #include "dragModel.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace dragModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class SyamlalOBrien Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class SyamlalOBrien
56 :
57  public dragModel
58 {
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("SyamlalOBrien");
64 
65 
66  // Constructors
67 
68  //- Construct from components
70  (
71  const dictionary& interfaceDict,
72  const phaseModel& phase1,
73  const phaseModel& phase2
74  );
75 
76 
77  //- Destructor
78  virtual ~SyamlalOBrien();
79 
80 
81  // Member Functions
82 
83  tmp<volScalarField> K(const volScalarField& Ur) const;
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace dragModels
90 } // End namespace Foam
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 #endif
95 
96 // ************************************************************************* //
Foam::phaseModel
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:54
Foam::dragModel::phase1
const phaseModel & phase1() const
Definition: dragModel.H:111
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::dragModel::K
virtual tmp< volScalarField > K() const
Return the drag coefficient K.
Definition: dragModel.C:153
Foam::dragModel::phase2
const phaseModel & phase2() const
Definition: dragModel.H:116
Foam::dragModels::SyamlalOBrien::~SyamlalOBrien
virtual ~SyamlalOBrien()
Destructor.
Definition: SyamlalOBrien.C:64
Foam::dragModels::SyamlalOBrien
Syamlal, M., Rogers, W. and O'Brien, T. J. (1993) MFIX documentation, Theory Guide....
Definition: SyamlalOBrien.H:54
Foam::dragModels::SyamlalOBrien::SyamlalOBrien
SyamlalOBrien(const dictionary &interfaceDict, const phaseModel &phase1, const phaseModel &phase2)
Construct from components.
Definition: SyamlalOBrien.C:52
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::dragModel
Definition: dragModel.H:51
Foam::GeometricField< scalar, fvPatchField, volMesh >
Foam::dragModels::SyamlalOBrien::TypeName
TypeName("SyamlalOBrien")
Runtime type information.