liftModel.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::liftModel
26 
27 Description
28 
29 SourceFiles
30  liftModel.C
31  newLiftModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef liftModel_H
36 #define liftModel_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 #include "volFields.H"
41 #include "dictionary.H"
42 #include "runTimeSelectionTables.H"
43 
44 namespace Foam
45 {
46 
47 class phasePair;
48 
49 /*---------------------------------------------------------------------------*\
50  Class liftModel Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class liftModel
54 {
55 protected:
56 
57  // Protected data
58 
59  //- Phase pair
60  const phasePair& pair_;
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("liftModel");
67 
68 
69  // Declare runtime construction
70 
72  (
73  autoPtr,
74  liftModel,
75  dictionary,
76  (
77  const dictionary& dict,
78  const phasePair& pair
79  ),
80  (dict, pair)
81  );
82 
83 
84  // Static data members
85 
86  //- Force dimensions
87  static const dimensionSet dimF;
88 
89 
90  // Constructors
91 
92  //- Construct from a dictionary and a phase pair
93  liftModel
94  (
95  const dictionary& dict,
96  const phasePair& pair
97  );
98 
99 
100  //- Destructor
101  virtual ~liftModel();
102 
103 
104  // Selectors
105 
106  static autoPtr<liftModel> New
107  (
108  const dictionary& dict,
109  const phasePair& pair
110  );
111 
112 
113  // Member Functions
114 
115  //- Return lift coefficient
116  virtual tmp<volScalarField> Cl() const = 0;
117 
118  //- Return phase-intensive lift force
119  virtual tmp<volVectorField> Fi() const;
120 
121  //- Return lift force
122  virtual tmp<volVectorField> F() const;
123 
124  //- Return face lift force
125  virtual tmp<surfaceScalarField> Ff() const;
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
const phasePair & pair_
Phase pair.
Definition: liftModel.H:59
Macros to ease declaration of run-time selection tables.
virtual tmp< volVectorField > Fi() const
Return phase-intensive lift force.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
static autoPtr< liftModel > New(const dictionary &dict, const phasePair &pair)
dictionary dict
virtual tmp< surfaceScalarField > Ff() const
Return face lift force.
Dimension set for the base types.
Definition: dimensionSet.H:116
static const dimensionSet dimF
Force dimensions.
Definition: liftModel.H:86
virtual ~liftModel()
Destructor.
virtual tmp< volScalarField > Cl() const =0
Return lift coefficient.
virtual tmp< volVectorField > F() const
Return lift force.
liftModel(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
declareRunTimeSelectionTable(autoPtr, liftModel, dictionary,( const dictionary &dict, const phasePair &pair ),(dict, pair))
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118
TypeName("liftModel")
Runtime type information.