interpolatedWallDamping.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::interpolated
26 
27 Description
28 
29 SourceFiles
30  interpolatedWallDamping.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef interpolatedWallDamping_H
35 #define interpolatedWallDamping_H
36 
37 #include "wallDampingModel.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 class phasePair;
45 
46 namespace wallDampingModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class interpolated Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class interpolated
54 :
55  public wallDampingModel
56 {
57 protected:
58 
59  // Protected member functions
60 
61  //- Return the force limiter field
62  virtual tmp<volScalarField> limiter() const = 0;
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("interpolated");
69 
70 
71  // Constructors
72 
73  //- Construct from components
75  (
76  const dictionary& dict,
77  const phasePair& pair
78  );
79 
80 
81  //- Destructor
82  virtual ~interpolated();
83 
84 
85  // Member Functions
86 
87  //- Return damped coefficient
89  (
90  const tmp<volScalarField>&
91  ) const;
92 
93  //- Return damped force
95  (
96  const tmp<volVectorField>&
97  ) const;
98 
99  //- Return damped face force
101  (
103  ) const;
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace wallDampingModels
110 } // End namespace Foam
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #endif
115 
116 // ************************************************************************* //
virtual tmp< volScalarField > limiter() const =0
Return the force limiter field.
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 > damp(const tmp< volScalarField > &) const
Return damped coefficient.
interpolated(const dictionary &dict, const phasePair &pair)
Construct from components.
A class for managing temporary objects.
Definition: PtrList.H:54
virtual ~interpolated()
Destructor.
TypeName("interpolated")
Runtime type information.
Namespace for OpenFOAM.