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