noVirtualMass.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::virtualMassModels::noVirtualMass
26 
27 Description
28 
29 SourceFiles
30  noVirtualMass.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef noVirtualMass_H
35 #define noVirtualMass_H
36 
37 #include "virtualMassModel.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 namespace virtualMassModels
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class noVirtualMass Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class noVirtualMass
51 :
52  public virtualMassModel
53 {
54 protected:
55 
56  // Protected data
57 
58  //- Interface
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("none");
66 
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
80  virtual ~noVirtualMass();
81 
82 
83  // Member Functions
84 
85  //- Return the virtual mass coefficient K
86  // used in the momentum equations
87  virtual tmp<volScalarField> K() const;
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace virtualMassModels
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
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:162
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.
noVirtualMass(const dictionary &dict, const phaseInterface &interface, const bool registerObject)
Construct from a dictionary and an interface.
Definition: noVirtualMass.C:44
TypeName("none")
Runtime type information.
const phaseInterface interface_
Interface.
Definition: noVirtualMass.H:58
virtual tmp< volScalarField > K() const
Return the virtual mass coefficient K.
Definition: noVirtualMass.C:64
Namespace for OpenFOAM.
dictionary dict