FreeFOAM The Cross-Platform CFD Toolkit
frictionalStressModel.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 | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
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.
15 
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.
20 
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/>.
23 
24 Class
25  Foam::frictionalStressModel
26 
27 SourceFiles
28  frictionalStressModel.C
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef frictionalStressModel_H
33 #define frictionalStressModel_H
34 
35 #include <OpenFOAM/dictionary.H>
36 #include <finiteVolume/volFields.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class frictionalStressModel Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 {
51  // Private member functions
52 
53  //- Disallow default bitwise copy construct
55 
56  //- Disallow default bitwise assignment
57  void operator=(const frictionalStressModel&);
58 
59 
60 protected:
61 
62  // Protected data
63 
64  const dictionary& dict_;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("frictionalStressModel");
71 
72  // Declare runtime constructor selection table
74  (
75  autoPtr,
77  dictionary,
78  (
79  const dictionary& dict
80  ),
81  (dict)
82  );
83 
84 
85  // Constructors
86 
87  //- Construct from components
88  frictionalStressModel(const dictionary& dict);
89 
90 
91  // Selectors
92 
94  (
95  const dictionary& dict
96  );
97 
98 
99  //- Destructor
100  virtual ~frictionalStressModel();
101 
102 
103  // Member Functions
104 
106  (
107  const volScalarField& alpha,
108  const dimensionedScalar& alphaMinFriction,
110  const dimensionedScalar& Fr,
111  const dimensionedScalar& eta,
112  const dimensionedScalar& p
113  ) const = 0;
114 
116  (
117  const volScalarField& alphaf,
118  const dimensionedScalar& alphaMinFriction,
120  const dimensionedScalar& Fr,
121  const dimensionedScalar& eta,
122  const dimensionedScalar& p
123  ) const = 0;
124 
125  virtual tmp<volScalarField> muf
126  (
127  const volScalarField& alpha,
129  const volScalarField& pf,
130  const volSymmTensorField& D,
131  const dimensionedScalar& phi
132  ) const = 0;
133 };
134 
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 } // End namespace Foam
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 #endif
143 
144 // ************************ vim: set sw=4 sts=4 et: ************************ //