noWallDamping.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2015-2018 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::wallDampingModels::noWallDamping
28 
29 Description
30 
31 SourceFiles
32  noWallDamping.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef noWallDamping_H
37 #define noWallDamping_H
38 
39 #include "wallDampingModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class phasePair;
47 
48 namespace wallDampingModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class noWallDamping Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class noWallDamping
56 :
57  public wallDampingModel
58 {
59 public:
60 
61  //- Runtime type information
62  TypeName("none");
63 
64 
65  // Constructors
66 
67  //- Construct from components
69  (
70  const dictionary& dict,
71  const phasePair& pair
72  );
73 
74 
75  //- Destructor
76  virtual ~noWallDamping();
77 
78 
79  // Member Functions
80 
81  //- Return damped coefficient
83  (
84  const tmp<volScalarField>&
85  ) const;
86 
87  //- Return damped force
89  (
90  const tmp<volVectorField>&
91  ) const;
92 
93  //- Return damped face force
95  (
97  ) const;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace wallDampingModels
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
Foam::phasePair
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:53
Foam::wallDampingModel
Definition: wallDampingModel.H:56
wallDampingModel.H
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::wallDampingModels::noWallDamping::noWallDamping
noWallDamping(const dictionary &dict, const phasePair &pair)
Construct from components.
Definition: noWallDamping.C:52
Foam::wallDampingModels::noWallDamping::TypeName
TypeName("none")
Runtime type information.
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::wallDampingModels::noWallDamping::damp
virtual tmp< volScalarField > damp(const tmp< volScalarField > &) const
Return damped coefficient.
Definition: noWallDamping.C:71
Foam::wallDampingModels::noWallDamping
Definition: noWallDamping.H:54
Foam::wallDampingModels::noWallDamping::~noWallDamping
virtual ~noWallDamping()
Destructor.
Definition: noWallDamping.C:63