linearWallDamping.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) 2015-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::wallDampingModels::linear
26 
27 Description
28 
29 SourceFiles
30  linearWallDamping.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef linearWallDamping_H
35 #define linearWallDamping_H
36 
37 #include "wallDampingModel.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 namespace wallDampingModels
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class linear Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class linear
51 :
52  public wallDampingModel
53 {
54 protected:
55 
56  // Protected member functions
57 
58  //- Return the force limiter field
59  virtual tmp<volScalarField> limiter() const;
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("linear");
66 
67 
68  // Constructors
69 
70  //- Construct from a dictionary and an interface
71  linear
72  (
73  const dictionary& dict,
74  const phaseInterface& interface
75  );
76 
77 
78  //- Destructor
79  virtual ~linear();
80 };
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 } // End namespace wallDampingModels
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
Class to represent an interface between phases. Derivations can further specify the configuration of ...
A class for managing temporary objects.
Definition: tmp.H:55
Wall damping models can be used to filter interfacial models near the walls. This is particularly use...
virtual tmp< volScalarField > limiter() const
Return the force limiter field.
linear(const dictionary &dict, const phaseInterface &interface)
Construct from a dictionary and an interface.
TypeName("linear")
Runtime type information.
Namespace for OpenFOAM.
dictionary dict