linearWallDamping.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) 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::wallDampingModels::linear
26 
27 Description
28 
29 SourceFiles
30  linearWallDamping.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef linearWallDamping_H
35 #define linearWallDamping_H
36 
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 class phasePair;
45 
46 namespace wallDampingModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class linear Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class linear
54 :
55  public interpolated
56 {
57  // Private data
58 
59  //- Diameter coefficient
60  const dimensionedScalar Cd_;
61 
62 
63 protected:
64 
65  // Protected member functions
66 
67  //- Return the force limiter field
68  virtual tmp<volScalarField> limiter() const;
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("linear");
75 
76 
77  // Constructors
78 
79  //- Construct from components
80  linear
81  (
82  const dictionary& dict,
83  const phasePair& pair
84  );
85 
86 
87  //- Destructor
88  virtual ~linear();
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace wallDampingModels
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
virtual ~linear()
Destructor.
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual tmp< volScalarField > limiter() const
Return the force limiter field.
linear(const dictionary &dict, const phasePair &pair)
Construct from components.
TypeName("linear")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:54
Namespace for OpenFOAM.