swarmCorrection.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) 2014-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::swarmCorrection
26 
27 Description
28  Drag model modifier to take into account large fractions (swarms) of the
29  dispersed phase. Often not appropriate as these effects are a fundamental
30  part of the drag model formulation (e.g. Ergun). Use with care.
31 
32 SourceFiles
33  swarmCorrection.C
34  swarmCorrectionNew.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef swarmCorrection_H
39 #define swarmCorrection_H
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 #include "volFields.H"
44 #include "dictionary.H"
45 #include "runTimeSelectionTables.H"
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class swarmCorrection Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class swarmCorrection
56 {
57 protected:
58 
59  // Protected data
60 
61  //- Interface
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("swarmCorrection");
69 
70 
71  // Declare runtime construction
73  (
74  autoPtr,
76  dictionary,
77  (
78  const dictionary& dict,
79  const phaseInterface& interface
80  ),
81  (dict, interface)
82  );
83 
84 
85  // Constructors
86 
87  //- Construct from a dictionary and an interface
89  (
90  const dictionary& dict,
91  const phaseInterface& interface
92  );
93 
94 
95  //- Destructor
96  virtual ~swarmCorrection();
97 
98 
99  // Selectors
100 
102  (
103  const dictionary& dict,
104  const phaseInterface& interface
105  );
106 
107 
108  // Member Functions
109 
110  //- Swarm correction coefficient
111  virtual tmp<volScalarField> Cs() const = 0;
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************************************************************* //
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...
Class to represent an interface between phases. Derivations can further specify the configuration of ...
Drag model modifier to take into account large fractions (swarms) of the dispersed phase....
virtual tmp< volScalarField > Cs() const =0
Swarm correction coefficient.
static autoPtr< swarmCorrection > New(const dictionary &dict, const phaseInterface &interface)
virtual ~swarmCorrection()
Destructor.
TypeName("swarmCorrection")
Runtime type information.
declareRunTimeSelectionTable(autoPtr, swarmCorrection, dictionary,(const dictionary &dict, const phaseInterface &interface),(dict, interface))
const dispersedPhaseInterface interface_
Interface.
swarmCorrection(const dictionary &dict, const phaseInterface &interface)
Construct from a dictionary and an interface.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
Macros to ease declaration of run-time selection tables.
dictionary dict