initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / applications / solvers / multiphase / twoPhaseEulerFoam / interfacialModels / dragModels / SyamlalOBrien / SyamlalOBrien.H
blob58a6ee8c1c0fe13576f3831ab40de863c5a99e58
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::SyamlalOBrien
28 Description
29     Syamlal, M., Rogers, W. and O'Brien, T. J. (1993) MFIX documentation,
30     Theory Guide. Technical Note DOE/METC-94/1004. Morgantown, West Virginia,
31     USA.
33 SourceFiles
34     SyamlalOBrien.C
36 \*---------------------------------------------------------------------------*/
38 #ifndef SyamlalOBrien_H
39 #define SyamlalOBrien_H
41 #include "dragModel.H"
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
48 /*---------------------------------------------------------------------------*\
49                            Class SyamlalOBrien Declaration
50 \*---------------------------------------------------------------------------*/
52 class SyamlalOBrien
54     public dragModel
57 public:
59     //- Runtime type information
60     TypeName("SyamlalOBrien");
63     // Constructors
65         //- Construct from components
66         SyamlalOBrien
67         (
68             const dictionary& interfaceDict,
69             const volScalarField& alpha,
70             const phaseModel& phasea,
71             const phaseModel& phaseb
72         );
75     //- Destructor
76     virtual ~SyamlalOBrien();
79     // Member Functions
81         tmp<volScalarField> K(const volScalarField& Ur) const;
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 } // End namespace Foam
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 #endif
93 // ************************************************************************* //