1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 Header: FGAerodynamics.h
7 ------------- Copyright (C) 1999 Jon S. Berndt (jsb@hal-pc.org) -------------
9 This program is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License as published by the Free Software
11 Foundation; either version 2 of the License, or (at your option) any later
14 This program is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 You should have received a copy of the GNU General Public License along with
20 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
21 Place - Suite 330, Boston, MA 02111-1307, USA.
23 Further information about the GNU General Public License can also be found on
24 the world wide web at http://www.gnu.org.
27 --------------------------------------------------------------------------------
30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
34 #ifndef FGAERODYNAMICS_H
35 #define FGAERODYNAMICS_H
37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
42 # include <simgear/compiler.h>
43 # ifdef SG_HAVE_STD_INCLUDES
56 #include "FGConfigFile.h"
58 #include "FGMassBalance.h"
59 #include "FGTranslation.h"
60 #include "FGCoefficient.h"
61 #include "FGFactorGroup.h"
63 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
65 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
67 #define ID_AERODYNAMICS "$Id$"
70 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
72 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
74 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
75 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
76 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
78 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
80 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
82 /** Encapsulates the aerodynamic calculations.
83 This class owns and contains the list of coefficients that define the
84 aerodynamic properties of this aircraft. Here also, such unique phenomena
85 as ground effect and maximum lift curve tailoff are handled.
91 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
93 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
95 class FGAerodynamics : public FGModel {
99 @param Executive a pointer to the parent executive object */
100 FGAerodynamics(FGFDMExec*);
104 /** Runs the Aerodynamics model; called by the Executive
105 @return false if no error */
108 /** Loads the Aerodynamics model
109 @return true if successful */
110 bool Load(FGConfigFile* AC_cfg);
112 /** Gets the total aerodynamic force vector.
113 @return a force vector reference. */
114 FGColumnVector3& GetForces(void) {return vForces;}
115 inline double GetForces(int n) const {return vForces(n);}
117 /** Gets the total aerodynamic moment vector.
118 @return a moment vector reference. */
119 FGColumnVector3& GetMoments(void) {return vMoments;}
120 inline double GetMoments(int n) const {return vMoments(n);}
122 inline FGColumnVector3& GetvLastFs(void) { return vLastFs; }
123 inline double GetvLastFs(int axis) const { return vLastFs(axis); }
124 inline FGColumnVector3& GetvFs(void) { return vFs; }
125 inline double GetvFs(int axis) const { return vFs(axis); }
126 inline double GetLoD(void) const { return lod; }
127 inline double GetClSquared(void) const { return clsq; }
129 /** Gets the strings for the current set of coefficients.
130 @return a string containing the descriptive names for all coefficients */
131 string GetCoefficientStrings(void);
133 /** Gets the coefficient values.
134 @return a string containing the numeric values for the current set of
136 string GetCoefficientValues(void);
139 void bindModel(void);
143 typedef map<string,int> AxisIndex;
145 typedef vector<FGCoefficient*> CoeffArray;
148 FGColumnVector3 vForces;
149 FGColumnVector3 vMoments;
150 FGColumnVector3 vLastFs;
151 FGColumnVector3 vDXYZcg;
154 void Debug(int from);
157 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%