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