initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / applications / solvers / multiphase / twoPhaseEulerFoam / kineticTheoryModels / frictionalStressModel / frictionalStressModel / frictionalStressModel.H
blob9b123b381a70b6401fb7af446215c92883488fee
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::frictionalStressModel
28 SourceFiles
29     frictionalStressModel.C
31 \*---------------------------------------------------------------------------*/
33 #ifndef frictionalStressModel_H
34 #define frictionalStressModel_H
36 #include "dictionary.H"
37 #include "volFields.H"
38 #include "dimensionedTypes.H"
39 #include "runTimeSelectionTables.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                            Class frictionalStressModel Declaration
48 \*---------------------------------------------------------------------------*/
50 class frictionalStressModel
52     // Private member functions
54         //- Disallow default bitwise copy construct
55         frictionalStressModel(const frictionalStressModel&);
57         //- Disallow default bitwise assignment
58         void operator=(const frictionalStressModel&);
61 protected:
63     // Protected data
65         const dictionary& dict_;
68 public:
70     //- Runtime type information
71     TypeName("frictionalStressModel");
73     // Declare runtime constructor selection table
74     declareRunTimeSelectionTable
75     (
76         autoPtr,
77         frictionalStressModel,
78         dictionary,
79         (
80             const dictionary& dict
81         ),
82         (dict)
83     );
86     // Constructors
88         //- Construct from components
89         frictionalStressModel(const dictionary& dict);
92     // Selectors
94         static autoPtr<frictionalStressModel> New
95         (
96             const dictionary& dict
97         );
100     //- Destructor
101     virtual ~frictionalStressModel();
104     // Member Functions
106         virtual tmp<volScalarField> frictionalPressure
107         (
108             const volScalarField& alpha,
109             const dimensionedScalar& alphaMinFriction,
110             const dimensionedScalar& alphaMax,
111             const dimensionedScalar& Fr,
112             const dimensionedScalar& eta,
113             const dimensionedScalar& p
114         ) const = 0;
116         virtual tmp<volScalarField> frictionalPressurePrime
117         (
118             const volScalarField& alphaf,
119             const dimensionedScalar& alphaMinFriction,
120             const dimensionedScalar& alphaMax,
121             const dimensionedScalar& Fr,
122             const dimensionedScalar& eta,
123             const dimensionedScalar& p
124         ) const = 0;
126         virtual tmp<volScalarField> muf
127         (
128             const volScalarField& alpha,
129             const dimensionedScalar& alphaMax,
130             const volScalarField& pf,
131             const volTensorField& D,
132             const dimensionedScalar& phi
133         ) const = 0;
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 } // End namespace Foam
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 #endif
145 // ************************************************************************* //