relativeVelocityModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2014 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::relativeVelocityModel
26 
27 Description
28 
29 SourceFiles
30  relativeVelocityModel.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef relativeVelocityModel_H
35 #define relativeVelocityModel_H
36 
37 #include "fvCFD.H"
38 #include "dictionary.H"
40 #include "runTimeSelectionTables.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class relativeVelocityModel Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 {
53  // Private Member Functions
54 
55  //- Disallow default bitwise copy construct
57 
58  //- Disallow default bitwise assignment
59  void operator=(const relativeVelocityModel&);
60 
61 protected:
62 
63  // Protected data
64 
65  //- Mixture properties
67 
68  //- Name of the continuous phase
70 
71  //- Continuous phase fraction
72  const volScalarField& alphac_;
73 
74  //- Dispersed phase fraction
75  const volScalarField& alphad_;
76 
77  //- Continuous density
78  const dimensionedScalar& rhoc_;
79 
80  //- Dispersed density
81  const dimensionedScalar& rhod_;
82 
83  //- Dispersed diffusion velocity
84  mutable volVectorField Udm_;
85 
86 
87 public:
88 
89  //- Runtime type information
90  TypeName("relativeVelocityModel");
91 
92  //- Declare runtime constructor selection table
94  (
95  autoPtr,
97  dictionary,
98  (const dictionary& dict,
100  (dict, mixture)
101  );
102 
103 
104  // Constructors
105 
106  //- Construct from components
108  (
109  const dictionary& dict,
111  );
112 
113 
114  // Selector
116  (
117  const dictionary& dict,
119  );
120 
121 
122  //- Destructor
123  virtual ~relativeVelocityModel();
124 
125 
126  // Member Functions
127 
128  //- Mixture properties
130  {
131  return mixture_;
132  }
133 
134  //- Return the mixture mean density
135  tmp<volScalarField> rho() const;
136 
137  //- Return the diffusion velocity of the dispersed phase
138  const volVectorField& Udm() const
139  {
140  return Udm_;
141  }
142 
143  //- Return the stress tensor due to the phase transport
145 
146  //- Update the diffusion velocity
147  virtual void correct() = 0;
148 };
149 
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 } // End namespace Foam
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 #endif
158 
159 // ************************************************************************* //
const volScalarField & alphac_
Continuous phase fraction.
const incompressibleTwoPhaseInteractingMixture & mixture() const
Mixture properties.
TypeName("relativeVelocityModel")
Runtime type information.
const volScalarField & alphad_
Dispersed phase fraction.
tmp< volScalarField > rho() const
Return the mixture mean density.
const volVectorField & Udm() const
Return the diffusion velocity of the dispersed phase.
Macros to ease declaration of run-time selection tables.
const dimensionedScalar & rhod_
Dispersed density.
A class for handling words, derived from string.
Definition: word.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual ~relativeVelocityModel()
Destructor.
dictionary dict
A two-phase incompressible transportModel for interacting phases requiring the direct evaluation of t...
const dimensionedScalar & rhoc_
Continuous density.
const word continuousPhaseName_
Name of the continuous phase.
static autoPtr< relativeVelocityModel > New(const dictionary &dict, const incompressibleTwoPhaseInteractingMixture &mixture)
tmp< volSymmTensorField > tauDm() const
Return the stress tensor due to the phase transport.
declareRunTimeSelectionTable(autoPtr, relativeVelocityModel, dictionary,(const dictionary &dict, const incompressibleTwoPhaseInteractingMixture &mixture),(dict, mixture))
Declare runtime constructor selection table.
virtual void correct()=0
Update the diffusion velocity.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118
const incompressibleTwoPhaseInteractingMixture & mixture_
Mixture properties.
volVectorField Udm_
Dispersed diffusion velocity.