noVirtualMass.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-2015 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 
44 class phasePair;
45 
46 namespace virtualMassModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class noVirtualMass Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class noVirtualMass
54 :
55  public virtualMassModel
56 {
57 public:
58 
59  //- Runtime type information
60  TypeName("none");
61 
62 
63  // Constructors
64 
65  //- Construct from a dictionary and a phase pair
67  (
68  const dictionary& dict,
69  const phasePair& pair,
70  const bool registerObject
71  );
72 
73 
74  //- Destructor
75  virtual ~noVirtualMass();
76 
77 
78  // Member Functions
79 
80  //- Virtual mass coefficient
81  virtual tmp<volScalarField> Cvm() const;
82 
83  //- The virtual mass function K used in the momentum equation
84  virtual tmp<volScalarField> K() const;
85 };
86 
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 } // End namespace virtualMassModels
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
virtual ~noVirtualMass()
Destructor.
virtual tmp< volScalarField > K() const
The virtual mass function K used in the momentum equation.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:290
Namespace for OpenFOAM.
dictionary dict
TypeName("none")
Runtime type information.
virtual tmp< volScalarField > Cvm() const
Virtual mass coefficient.
noVirtualMass(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
A class for managing temporary objects.
Definition: PtrList.H:118