Lamb.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::Lamb
26 
27 Description
28  Virtual mass model of Lamb.
29 
30  Reference:
31  \verbatim
32  Lamb, H. (1993).
33  Hydrodynamics.
34  Cambridge university press.
35  \endverbatim
36 
37 SourceFiles
38  Lamb.C
39 
40 \*---------------------------------------------------------------------------*/
41 
42 #ifndef Lamb_H
43 #define Lamb_H
44 
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 class aspectRatioModel;
53 
54 namespace virtualMassModels
55 {
56 
57 /*---------------------------------------------------------------------------*\
58  Class Lamb Declaration
59 \*---------------------------------------------------------------------------*/
60 
61 class Lamb
62 :
64 {
65 private:
66 
67  //- Private Data
68 
69  //- The aspect ratio model
70  autoPtr<aspectRatioModel> aspectRatio_;
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("Lamb");
77 
78 
79  // Constructors
80 
81  //- Construct from a dictionary and an interface
82  Lamb
83  (
84  const dictionary& dict,
85  const phaseInterface& interface,
86  const bool registerObject
87  );
88 
89 
90  //- Destructor
91  virtual ~Lamb();
92 
93 
94  // Member Functions
95 
96  //- Virtual mass coefficient
97  virtual tmp<volScalarField> Cvm() const;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace virtualMassModels
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:346
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
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
Virtual mass model of Lamb.
Definition: Lamb.H:63
virtual tmp< volScalarField > Cvm() const
Virtual mass coefficient.
Definition: Lamb.C:69
TypeName("Lamb")
Runtime type information.
Lamb(const dictionary &dict, const phaseInterface &interface, const bool registerObject)
Construct from a dictionary and an interface.
Definition: Lamb.C:50
virtual ~Lamb()
Destructor.
Definition: Lamb.C:63
Namespace for OpenFOAM.
dictionary dict