wallDampedLift.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::liftModels::wallDamped
26 
27 Description
28 
29 SourceFiles
30  wallDamped.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef wallDampedLift_H
35 #define wallDampedLift_H
36 
37 #include "liftModel.H"
38 #include "wallDampingModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 class phasePair;
46 
47 namespace liftModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class wallDamped Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class wallDamped
55 :
56  public liftModel
57 {
58  // Private data
59 
60  //- The lift model to damp
61  autoPtr<liftModel> liftModel_;
62 
63  //- The wall-damping model
64  autoPtr<wallDampingModel> wallDampingModel_;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("wallDamped");
71 
72 
73  // Constructors
74 
75  //- Construct from a dictionary and a phase pair
77  (
78  const dictionary& dict,
79  const phasePair& pair
80  );
81 
82 
83  //- Destructor
84  virtual ~wallDamped();
85 
86 
87  // Member Functions
88 
89  //- Return lift coefficient
90  virtual tmp<volScalarField> Cl() const;
91 
92  //- Return phase-intensive lift force
93  virtual tmp<volVectorField> Fi() const;
94 
95  //- Return lift force
96  virtual tmp<volVectorField> F() const;
97 
98  //- Return face lift force
99  virtual tmp<surfaceScalarField> Ff() const;
100 };
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace liftModels
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual tmp< volVectorField > Fi() const
Return phase-intensive lift force.
virtual tmp< volScalarField > Cl() const
Return lift coefficient.
virtual ~wallDamped()
Destructor.
TypeName("wallDamped")
Runtime type information.
wallDamped(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
virtual tmp< surfaceScalarField > Ff() const
Return face lift force.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
A class for managing temporary objects.
Definition: PtrList.H:54
virtual tmp< volVectorField > F() const
Return lift force.
Namespace for OpenFOAM.