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