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  Copyright (C) 2022 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::multiphaseEuler::dragModels::SyamlalOBrien
29 
30 Description
31  Syamlal, M., Rogers, W. and O'Brien, T. J. (1993) MFIX documentation,
32  Theory Guide. Technical Note DOE/METC-94/1004. Morgantown, West Virginia,
33  USA.
34 
35 SourceFiles
36  SyamlalOBrien.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef Foam_multiphaseEuler_dragModels_SyamlalOBrien_H
41 #define Foam_multiphaseEuler_dragModels_SyamlalOBrien_H
42 
43 #include "dragModel.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace multiphaseEuler
50 {
51 namespace dragModels
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class SyamlalOBrien Declaration
56 \*---------------------------------------------------------------------------*/
57 
58 class SyamlalOBrien
59 :
60  public dragModel
61 {
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("SyamlalOBrien");
67 
68 
69  // Constructors
70 
71  //- Construct from components
73  (
74  const dictionary& interfaceDict,
75  const phaseModel& phase1,
76  const phaseModel& phase2
77  );
78 
79 
80  //- Destructor
81  virtual ~SyamlalOBrien();
82 
83 
84  // Member Functions
85 
86  tmp<volScalarField> K(const volScalarField& Ur) const;
87 };
88 
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 } // End namespace dragModels
93 } // End namespace multiphaseEuler
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
const phaseModel & phase1() const
Definition: dragModel.H:114
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
SyamlalOBrien(const dictionary &interfaceDict, const phaseModel &phase1, const phaseModel &phase2)
Construct from components.
Definition: SyamlalOBrien.C:49
tmp< volScalarField > K(const volScalarField &Ur) const
The drag function K used in the momentum eq.
Definition: SyamlalOBrien.C:69
const phaseModel & phase2() const
Definition: dragModel.H:119
TypeName("SyamlalOBrien")
Runtime type information.
A class for managing temporary objects.
Definition: HashPtrTable.H:50
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:53
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:53
Namespace for OpenFOAM.