constantLiftCoefficient.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) 2014-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::constantLiftCoefficient
26 
27 Description
28  Constant coefficient lift model.
29 
30 SourceFiles
31  constantLiftCoefficient.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef constantLiftCoefficient_H
36 #define constantLiftCoefficient_H
37 
38 #include "liftModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 class phasePair;
46 
47 namespace liftModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class constantLiftCoefficient Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public liftModel
57 {
58  // Private data
59 
60  //- Constant lift coefficient
61  const dimensionedScalar Cl_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("constantCoefficient");
68 
69 
70  // Constructors
71 
72  //- Construct from a dictionary and a phase pair
74  (
75  const dictionary& dict,
76  const phasePair& pair
77  );
78 
79 
80  //- Destructor
81  virtual ~constantLiftCoefficient();
82 
83 
84  // Member Functions
85 
86  //- Lift coefficient
87  virtual tmp<volScalarField> Cl() const;
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace liftModels
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
dictionary dict
virtual tmp< volScalarField > Cl() const
Lift coefficient.
TypeName("constantCoefficient")
Runtime type information.
constantLiftCoefficient(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
virtual ~constantLiftCoefficient()
Destructor.
A class for managing temporary objects.
Definition: PtrList.H:118