dispersedDragModel.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::dispersedDragModel
26 
27 Description
28  Model for drag between two phases where one phase can be considered
29  dispersed in the other and the drag therefore characterised by a drag
30  coefficient
31 
32 SourceFiles
33  dispersedDragModel.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef dispersedDragModel_H
38 #define dispersedDragModel_H
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 #include "dragModel.H"
44 
45 namespace Foam
46 {
47 
48 class swarmCorrection;
49 
50 namespace dragModels
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class dispersedDragModel Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
59  public dragModel
60 {
61 protected:
62 
63  // Protected data
64 
65  //- Interface
67 
68  //- Swarm correction
70 
71 
72 public:
73 
74  // Constructors
75 
76  // Construct from a dictionary and an interface
78  (
79  const dictionary& dict,
80  const phaseInterface& interface,
81  const bool registerObject
82  );
83 
84 
85  //- Destructor
86  virtual ~dispersedDragModel();
87 
88 
89  // Member Functions
90 
91  //- Drag coefficient
92  virtual tmp<volScalarField> CdRe() const = 0;
93 
94  //- Return the phase-intensive drag coefficient Ki
95  // used in the momentum equations
96  // ddt(alpha1*rho1*U1) + ... = ... alphad*K*(U1-U2)
97  // ddt(alpha2*rho2*U2) + ... = ... alphad*K*(U2-U1)
98  virtual tmp<volScalarField> Ki() const;
99 
100  //- Return the drag coefficient K
101  // used in the momentum equations
102  // ddt(alpha1*rho1*U1) + ... = ... K*(U1-U2)
103  // ddt(alpha2*rho2*U2) + ... = ... K*(U2-U1)
104  virtual tmp<volScalarField> K() const;
105 
106  //- Return the drag coefficient Kf
107  // used in the face-momentum equations
108  virtual tmp<surfaceScalarField> Kf() const;
109 };
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 } // End namespace dragModels
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:346
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Class to represent a interface between phases where one phase is considered dispersed within the othe...
Model for drag between phases.
Definition: dragModel.H:55
dispersedDragModel(const dictionary &dict, const phaseInterface &interface, const bool registerObject)
virtual tmp< surfaceScalarField > Kf() const
Return the drag coefficient Kf.
const dispersedPhaseInterface interface_
Interface.
virtual tmp< volScalarField > CdRe() const =0
Drag coefficient.
virtual tmp< volScalarField > Ki() const
Return the phase-intensive drag coefficient Ki.
virtual tmp< volScalarField > K() const
Return the drag coefficient K.
autoPtr< swarmCorrection > swarmCorrection_
Swarm correction.
Class to represent an interface between phases. Derivations can further specify the configuration of ...
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
dictionary dict