fixedTrim.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) 2012-2014 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::fixedTrim
26 
27 Description
28  Fixed trim coefficients
29 
30 SourceFiles
31  fixedTrim.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef fixedTrim_H
36 #define fixedTrim_H
37 
38 #include "trimModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class fixedTrim Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class fixedTrim
50 :
51  public trimModel
52 {
53 
54 protected:
55 
56  // Protected data
57 
58  //- Geometric angle of attack [rad]
60 
61 
62 public:
63 
64  //- Run-time type information
65  TypeName("fixedTrim");
66 
67  //- Constructor
68  fixedTrim(const fv::rotorDiskSource& rotor, const dictionary& dict);
69 
70  //- Destructor
71  virtual ~fixedTrim();
72 
73 
74  // Member functions
75 
76  //- Read
77  void read(const dictionary& dict);
78 
79  //- Return the geometric angle of attack [rad]
80  virtual tmp<scalarField> thetag() const;
81 
82  //- Correct the model
83  virtual void correct
84  (
85  const vectorField& U,
86  vectorField& force
87  );
88 
89  //- Correct the model for compressible flow
90  virtual void correct
91  (
92  const volScalarField rho,
93  const vectorField& U,
94  vectorField& force
95  );
96 };
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
dictionary dict
U
Definition: pEqn.H:83
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Trim model base class.
Definition: trimModel.H:50
virtual void correct(const vectorField &U, vectorField &force)
Correct the model.
Definition: fixedTrim.C:90
Rotor disk source.
fixedTrim(const fv::rotorDiskSource &rotor, const dictionary &dict)
Constructor.
Definition: fixedTrim.C:46
void read(const dictionary &dict)
Read.
Definition: fixedTrim.C:66
virtual tmp< scalarField > thetag() const
Return the geometric angle of attack [rad].
Definition: fixedTrim.C:83
Fixed trim coefficients.
Definition: fixedTrim.H:48
scalarField thetag_
Geometric angle of attack [rad].
Definition: fixedTrim.H:58
TypeName("fixedTrim")
Run-time type information.
A class for managing temporary objects.
Definition: PtrList.H:53
virtual ~fixedTrim()
Destructor.
Definition: fixedTrim.C:60
Namespace for OpenFOAM.