dragModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2023 OpenFOAM Foundation
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::dragModel
26 
27 Description
28  Model for drag between phases
29 
30 SourceFiles
31  dragModel.C
32  dragModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef dragModel_H
37 #define dragModel_H
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 #include "volFields.H"
42 #include "dictionary.H"
43 #include "runTimeSelectionTables.H"
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class dragModel Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class dragModel
54 :
55  public regIOobject
56 {
57 public:
58 
59  //- Runtime type information
60  TypeName("dragModel");
61 
62 
63  // Declare runtime construction
64 
66  (
67  autoPtr,
68  dragModel,
69  dictionary,
70  (
71  const dictionary& dict,
72  const phaseInterface& interface,
73  const bool registerObject
74  ),
75  (dict, interface, registerObject)
76  );
77 
78 
79  // Static Data Members
80 
81  //- Coefficient dimensions
82  static const dimensionSet dimK;
83 
84  //- This model MUST NOT be set to 0 on fixed flux boundaries
85  static const bool correctFixedFluxBCs = false;
86 
87 
88  // Constructors
89 
90  // Construct from a dictionary and an interface
91  dragModel
92  (
93  const dictionary& dict,
94  const phaseInterface& interface,
95  const bool registerObject
96  );
97 
98 
99  //- Destructor
100  virtual ~dragModel();
101 
102 
103  // Selectors
104 
105  static autoPtr<dragModel> New
106  (
107  const dictionary& dict,
108  const phaseInterface& interface,
109  const bool outer=true,
110  const bool registerObject=true
111  );
112 
113 
114  // Member Functions
115 
116  //- Return the drag coefficient K
117  // used in the momentum equations
118  // ddt(alpha1*rho1*U1) + ... = ... K*(U1-U2)
119  // ddt(alpha2*rho2*U2) + ... = ... K*(U2-U1)
120  virtual tmp<volScalarField> K() const = 0;
121 
122  //- Return the drag coefficient Kf
123  // used in the face-momentum equations
124  virtual tmp<surfaceScalarField> Kf() const = 0;
125 
126  //- Dummy write for regIOobject
127  bool writeData(Ostream& os) const;
128 };
129 
130 
131 /*---------------------------------------------------------------------------*\
132  Class blendedDragModel Declaration
133 \*---------------------------------------------------------------------------*/
134 
135 class blendedDragModel
136 :
137  public BlendedInterfacialModel<dragModel>
138 {
139 public:
140 
141  // Constructors
142 
143  //- Inherit base class constructors
145 
146 
147  // Selectors
148 
150  (
151  const dictionary& dict,
153  );
154 
155 
156  // Member Functions
157 
158  //- Return the drag coefficient K
159  tmp<volScalarField> K() const;
160 
161  //- Return the drag coefficient Kf
162  tmp<surfaceScalarField> Kf() const;
163 };
164 
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 } // End namespace Foam
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 #endif
173 
174 // ************************************************************************* //
const phaseInterface & interface() const
Access the interface.
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:346
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
tmp< surfaceScalarField > Kf() const
Return the drag coefficient Kf.
Definition: dragModel.C:85
static autoPtr< blendedDragModel > New(const dictionary &dict, const phaseInterface &interface)
Definition: dragModelNew.C:65
tmp< volScalarField > K() const
Return the drag coefficient K.
Definition: dragModel.C:79
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Dimension set for the base types.
Definition: dimensionSet.H:125
Model for drag between phases.
Definition: dragModel.H:55
dragModel(const dictionary &dict, const phaseInterface &interface, const bool registerObject)
Definition: dragModel.C:44
declareRunTimeSelectionTable(autoPtr, dragModel, dictionary,(const dictionary &dict, const phaseInterface &interface, const bool registerObject),(dict, interface, registerObject))
virtual ~dragModel()
Destructor.
Definition: dragModel.C:67
virtual tmp< surfaceScalarField > Kf() const =0
Return the drag coefficient Kf.
static autoPtr< dragModel > New(const dictionary &dict, const phaseInterface &interface, const bool outer=true, const bool registerObject=true)
Definition: dragModelNew.C:32
bool writeData(Ostream &os) const
Dummy write for regIOobject.
Definition: dragModel.C:73
virtual tmp< volScalarField > K() const =0
Return the drag coefficient K.
static const bool correctFixedFluxBCs
This model MUST NOT be set to 0 on fixed flux boundaries.
Definition: dragModel.H:84
TypeName("dragModel")
Runtime type information.
static const dimensionSet dimK
Coefficient dimensions.
Definition: dragModel.H:81
Class to represent an interface between phases. Derivations can further specify the configuration of ...
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:55
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
void outer(FieldField< Field1, typename outerProduct< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Macros to ease declaration of run-time selection tables.
dictionary dict