dispersedVirtualMassModel.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::dispersedVirtualMassModel
26 
27 Description
28  Model for virtual mass between two phases where one phase can be considered
29  dispersed in the other and the virtual mass therefore characterised by a
30  virtual mass coefficient
31 
32 SourceFiles
33  dispersedVirtualMassModel.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef dispersedVirtualMassModel_H
38 #define dispersedVirtualMassModel_H
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 #include "virtualMassModel.H"
44 
45 namespace Foam
46 {
47 namespace virtualMassModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class dispersedVirtualMassModel Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public virtualMassModel
57 {
58 protected:
59 
60  // Protected data
61 
62  //- Interface
64 
65 
66 public:
67 
68  // Constructors
69 
70  // Construct from a dictionary and an interface
72  (
73  const dictionary& dict,
74  const phaseInterface& interface,
75  const bool registerObject
76  );
77 
78 
79  //- Destructor
81 
82 
83  // Member Functions
84 
85  //- Return the virtual mass coefficient
86  virtual tmp<volScalarField> Cvm() const = 0;
87 
88  //- Return the phase-intensive virtual mass coefficient Ki
89  // used in the momentum equation
90  // ddt(alpha1*rho1*U1) + ... = ... alphad*K*(DU1_Dt - DU2_Dt)
91  // ddt(alpha2*rho2*U2) + ... = ... alphad*K*(DU1_Dt - DU2_Dt)
92  virtual tmp<volScalarField> Ki() const;
93 
94  //- Return the virtual mass coefficient K
95  // used in the momentum equation
96  // ddt(alpha1*rho1*U1) + ... = ... K*(DU1_Dt - DU2_Dt)
97  // ddt(alpha2*rho2*U2) + ... = ... K*(DU1_Dt - DU2_Dt)
98  virtual tmp<volScalarField> K() const;
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace virtualMassModels
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:346
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
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 ...
A class for managing temporary objects.
Definition: tmp.H:55
Model for virtual mass between phases.
dispersedVirtualMassModel(const dictionary &dict, const phaseInterface &interface, const bool registerObject)
const dispersedPhaseInterface interface_
Interface.
virtual tmp< volScalarField > Ki() const
Return the phase-intensive virtual mass coefficient Ki.
virtual tmp< volScalarField > K() const
Return the virtual mass coefficient K.
virtual tmp< volScalarField > Cvm() const =0
Return the virtual mass coefficient.
Namespace for OpenFOAM.
dictionary dict