Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / applications / solvers / multiphase / twoPhaseEulerFoam / interfacialModels / dragModels / SyamlalOBrien / SyamlalOBrien.H
bloba2bb47e29c7416847b9f6516ce85f40ccb0a602e
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2004-2010 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
13     the Free Software Foundation, either version 3 of the License, or
14     (at your 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, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::SyamlalOBrien
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.
32 SourceFiles
33     SyamlalOBrien.C
35 \*---------------------------------------------------------------------------*/
37 #ifndef SyamlalOBrien_H
38 #define SyamlalOBrien_H
40 #include "dragModel.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                            Class SyamlalOBrien Declaration
49 \*---------------------------------------------------------------------------*/
51 class SyamlalOBrien
53     public dragModel
56 public:
58     //- Runtime type information
59     TypeName("SyamlalOBrien");
62     // Constructors
64         //- Construct from components
65         SyamlalOBrien
66         (
67             const dictionary& interfaceDict,
68             const volScalarField& alpha,
69             const phaseModel& phasea,
70             const phaseModel& phaseb
71         );
74     //- Destructor
75     virtual ~SyamlalOBrien();
78     // Member Functions
80         tmp<volScalarField> K(const volScalarField& Ur) const;
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 } // End namespace Foam
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 #endif
92 // ************************************************************************* //