constantVirtualMassCoefficient.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::virtualMassModels::constantVirtualMassCoefficient
26 
27 Description
28  Constant coefficient virtual mass model.
29 
30 SourceFiles
31  constantVirtualMassCoefficient.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef constantVirtualMassCoefficient_H
36 #define constantVirtualMassCoefficient_H
37 
38 #include "virtualMassModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 class phasePair;
46 
47 namespace virtualMassModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class constantVirtualMassCoefficient Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class constantVirtualMassCoefficient
55 :
56  public virtualMassModel
57 {
58  // Private data
59 
60  //- Constant virtual mass coefficient
61  const dimensionedScalar Cvm_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("constantCoefficient");
68 
69 
70  // Constructors
71 
72  //- Construct from a dictionary and a phase pair
74  (
75  const dictionary& dict,
76  const phasePair& pair,
77  const bool registerObject
78  );
79 
80 
81  //- Destructor
83 
84 
85  // Member Functions
86 
87  //- Virtual mass coefficient
88  virtual tmp<volScalarField> Cvm() const;
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace virtualMassModels
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
TypeName("constantCoefficient")
Runtime type information.
constantVirtualMassCoefficient(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:290
Namespace for OpenFOAM.
dictionary dict
virtual tmp< volScalarField > Cvm() const
Virtual mass coefficient.
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.