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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2014 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::virtualMassModels::noVirtualMass
28
29Description
30
31SourceFiles
32 noVirtualMass.C
33
34\*---------------------------------------------------------------------------*/
35
36#ifndef noVirtualMass_H
37#define noVirtualMass_H
38
39#include "virtualMassModel.H"
40
41// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43namespace Foam
44{
45
46class phasePair;
47
48namespace virtualMassModels
49{
50
51/*---------------------------------------------------------------------------*\
52 Class noVirtualMass Declaration
53\*---------------------------------------------------------------------------*/
54
55class noVirtualMass
56:
57 public virtualMassModel
58{
59public:
60
61 //- Runtime type information
62 TypeName("none");
63
64
65 // Constructors
66
67 //- Construct from a dictionary and a phase pair
69 (
70 const dictionary& dict,
71 const phasePair& pair,
72 const bool registerObject
73 );
74
75
76 //- Destructor
77 virtual ~noVirtualMass();
78
79
80 // Member Functions
81
82 //- Virtual mass coefficient
83 virtual tmp<volScalarField> Cvm() const;
84
85 //- The virtual mass function K used in the momentum equation
86 virtual tmp<volScalarField> K() const;
87};
88
89
90// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91
92} // End namespace virtualMassModels
93} // End namespace Foam
94
95// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96
97#endif
98
99// ************************************************************************* //
bool registerObject() const noexcept
Should object created with this IOobject be registered?
Definition: IOobjectI.H:107
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:56
A class for managing temporary objects.
Definition: tmp.H:65
virtual tmp< volScalarField > Cvm() const
Virtual mass coefficient.
Definition: noVirtualMass.C:66
TypeName("none")
Runtime type information.
virtual tmp< volScalarField > Cvm() const
Virtual mass coefficient.
virtual tmp< volScalarField > K() const
The virtual mass function K used in the momentum equation.
Definition: noVirtualMass.C:80
noVirtualMass(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
virtual tmp< volScalarField > K() const
The virtual mass function K used in the momentum equation.
Namespace for OpenFOAM.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73