turbulentDispersionModel.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-2026 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::turbulentDispersionModel
26 
27 Description
28  Model for turbulent dispersion between two phases
29 
30 SourceFiles
31  turbulentDispersionModel.C
32  turbulentDispersionModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef turbulentDispersionModel_H
37 #define turbulentDispersionModel_H
38 
39 #include "volFields.H"
40 #include "dictionary.H"
41 #include "runTimeSelectionTables.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class turbulentDispersionModel Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 {
55 public:
56 
57  //- Runtime type information
58  TypeName("turbulentDispersionModel");
59 
60 
61  // Declare runtime construction
62 
64  (
65  autoPtr,
67  dictionary,
68  (
69  const dictionary& dict,
70  const phaseInterface& interface
71  ),
72  (dict, interface)
73  );
74 
75  // Static Data Members
76 
77  //- Diffusivity dimensions
78  static const dimensionSet dimD;
79 
80 
81  // Constructors
82 
83  //- Construct from a dictionary and an interface
85  (
86  const dictionary& dict,
87  const phaseInterface& interface
88  );
89 
90 
91  //- Destructor
92  virtual ~turbulentDispersionModel();
93 
94 
95  // Selectors
96 
98  (
99  const dictionary& subDicts,
100  const phaseInterface& interface,
101  const bool outer = false
102  );
103 
105  (
106  const UPtrList<const dictionary>& subDicts,
107  const phaseInterface& interface
108  );
109 
110 
111  // Member Functions
112 
113  //- Return the turbulent diffusivity multiplying the gradient of the
114  // phase-fraction
115  virtual tmp<volScalarField> D() const = 0;
116 };
117 
118 
119 /*---------------------------------------------------------------------------*\
120  Class blendedTurbulentDispersionModel Declaration
121 \*---------------------------------------------------------------------------*/
122 
124 :
125  public BlendedInterfacialModel<turbulentDispersionModel>
126 {
127 public:
128 
129  // Constructors
130 
131  //- Inherit base class constructors
132  using
135 
136 
137  // Selectors
138 
140  (
141  const UPtrList<const dictionary>& subDicts,
142  const phaseInterface& interface,
143  const dictionary& blendingDict
144  )
145  {
146  return
148  (
150  (
151  subDicts,
152  interface,
154  )
155  );
156  }
157 
158 
159  // Member Functions
160 
161  //- Return the turbulent diffusivity multiplying the gradient of the
162  // phase-fraction
163  tmp<volScalarField> D() const;
164 };
165 
166 
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168 
169 } // End namespace Foam
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 #endif
174 
175 // ************************************************************************* //
Wrapper class for interfacial models for which multiple instances of the model are used for different...
const phaseInterface & interface() const
Access the interface.
BlendedInterfacialModel(const UPtrList< const dictionary > &subDicts, const phaseInterface &interface, const dictionary &blendingDict, const Args &... args)
Construct from a dictionary, an interface and a blending dictionary.
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: UPtrList.H:66
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< volScalarField > D() const
Return the turbulent diffusivity multiplying the gradient of the.
static autoPtr< blendedTurbulentDispersionModel > New(const UPtrList< const dictionary > &subDicts, const phaseInterface &interface, const dictionary &blendingDict)
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Dimension set for the base types.
Definition: dimensionSet.H:125
Class to represent an interface between phases. Derivations can further specify the configuration of ...
A class for managing temporary objects.
Definition: tmp.H:55
Model for turbulent dispersion between two phases.
turbulentDispersionModel(const dictionary &dict, const phaseInterface &interface)
Construct from a dictionary and an interface.
static const dimensionSet dimD
Diffusivity dimensions.
virtual tmp< volScalarField > D() const =0
Return the turbulent diffusivity multiplying the gradient of the.
virtual ~turbulentDispersionModel()
Destructor.
declareRunTimeSelectionTable(autoPtr, turbulentDispersionModel, dictionary,(const dictionary &dict, const phaseInterface &interface),(dict, interface))
TypeName("turbulentDispersionModel")
Runtime type information.
static autoPtr< turbulentDispersionModel > New(const dictionary &subDicts, const phaseInterface &interface, const bool outer=false)
Namespace for OpenFOAM.
void outer(GeometricField< typename outerProduct< Type1, Type2 >::type, GeoMesh, PrimitiveField1 > &gf, const GeometricField< Type1, GeoMesh, PrimitiveField2 > &gf1, const GeometricField< Type2, GeoMesh, PrimitiveField3 > &gf2)
const dictionary & blendingDict(const phaseSystem &fluid, const dictionary &dict)
Macros to ease declaration of run-time selection tables.
dictionary dict