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-2018 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 
29 SourceFiles
30  turbulentDispersionModel.C
31  newTurbulentDispersionModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef turbulentDispersionModel_H
36 #define turbulentDispersionModel_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 #include "volFields.H"
41 #include "dictionary.H"
42 #include "runTimeSelectionTables.H"
43 #include "phaseCompressibleTurbulenceModelFwd.H"
44 
45 namespace Foam
46 {
47 
48 class phasePair;
49 
50 /*---------------------------------------------------------------------------*\
51  Class turbulentDispersionModel Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 {
56 protected:
57 
58  // Protected data
59 
60  //- Phase pair
61  const phasePair& pair_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("turbulentDispersionModel");
68 
69 
70  // Declare runtime construction
71 
73  (
74  autoPtr,
76  dictionary,
77  (
78  const dictionary& dict,
79  const phasePair& pair
80  ),
81  (dict, pair)
82  );
83 
84  // Static data members
85 
86  //- Diffusivity dimensions
87  static const dimensionSet dimD;
88 
89  //- Force dimensions
90  static const dimensionSet dimF;
91 
92 
93  // Constructors
94 
95  //- Construct from a dictionary and a phase pair
97  (
98  const dictionary& dict,
99  const phasePair& pair
100  );
101 
102 
103  //- Destructor
104  virtual ~turbulentDispersionModel();
105 
106 
107  // Selectors
108 
110  (
111  const dictionary& dict,
112  const phasePair& pair
113  );
114 
115 
116  // Member Functions
117 
118  //- Return a reference to the turbulence model for the continuous phase
120 
121  //- Turbulent diffusivity
122  // multiplying the gradient of the phase-fraction
123  virtual tmp<volScalarField> D() const = 0;
124 
125  //- Turbulent dispersion force
126  virtual tmp<volVectorField> F() const;
127 
128  //- Turbulent dispersion force on faces
129  virtual tmp<surfaceScalarField> Ff() const;
130 };
131 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 } // End namespace Foam
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 #endif
140 
141 // ************************************************************************* //
dictionary dict
declareRunTimeSelectionTable(autoPtr, turbulentDispersionModel, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual tmp< surfaceScalarField > Ff() const
Turbulent dispersion force on faces.
static const dimensionSet dimF
Force dimensions.
virtual tmp< volVectorField > F() const
Turbulent dispersion force.
static autoPtr< turbulentDispersionModel > New(const dictionary &dict, const phasePair &pair)
Dimension set for the base types.
Definition: dimensionSet.H:120
static const dimensionSet dimD
Diffusivity dimensions.
virtual tmp< volScalarField > D() const =0
Turbulent diffusivity.
const phasePair & pair_
Phase pair.
virtual ~turbulentDispersionModel()
Destructor.
const phaseCompressibleTurbulenceModel & continuousTurbulence() const
Return a reference to the turbulence model for the continuous phase.
TypeName("turbulentDispersionModel")
Runtime type information.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Macros to ease declaration of run-time selection tables.
A class for managing temporary objects.
Definition: PtrList.H:53
turbulentDispersionModel(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
Namespace for OpenFOAM.