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 Lesser 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 Lesser General Public License for more
19 You should have received a copy of the GNU Lesser 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 Lesser 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 <math/FGFunction.h>
57 #include <math/FGColumnVector3.h>
59 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
63 #define ID_AERODYNAMICS "$Id$"
65 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
67 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
71 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
73 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
75 /** Encapsulates the aerodynamic calculations.
76 This class owns and contains the list of force/coefficients that define the
77 aerodynamic properties of an aircraft. Here also, such unique phenomena
78 as ground effect, aerodynamic reference point shift, and maximum lift curve
83 <axis name="{LIFT|DRAG|SIDE|ROLL|PITCH|YAW}">
84 {force coefficient definitions}
86 {additional axis definitions}
90 @author Jon S. Berndt, Tony Peden
94 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
96 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
98 class FGAerodynamics : public FGModel {
102 @param Executive a pointer to the parent executive object */
103 FGAerodynamics(FGFDMExec* Executive);
107 /** Runs the Aerodynamics model; called by the Executive
108 @return false if no error */
111 /** Loads the Aerodynamics model.
112 The Load function for this class expects the XML parser to
113 have found the aerodynamics keyword in the configuration file.
114 @param element pointer to the current XML element for aerodynamics parameters.
115 @return true if successful */
116 bool Load(Element* element);
118 /** Gets the total aerodynamic force vector.
119 @return a force vector reference. */
120 FGColumnVector3& GetForces(void) {return vForces;}
122 /** Gets the aerodynamic force for an axis.
123 @param n Axis index. This could be 0, 1, or 2, or one of the
124 axis enums: eX, eY, eZ.
125 @return the force acting on an axis */
126 double GetForces(int n) const {return vForces(n);}
128 /** Gets the total aerodynamic moment vector.
129 @return a moment vector reference. */
130 FGColumnVector3& GetMoments(void) {return vMoments;}
132 /** Gets the aerodynamic moment for an axis.
133 @return the moment about a single axis (as described also in the
134 similar call to GetForces(int n).*/
135 double GetMoments(int n) const {return vMoments(n);}
137 /** Retrieves the aerodynamic forces in the stability axes.
138 @return a reference to a column vector containing the stability axis forces. */
139 FGColumnVector3& GetvFs(void) { return vFs; }
141 /** Retrieves the aerodynamic forces in the stability axes, given an axis.
142 @param axis the axis to return the force for (eX, eY, eZ).
143 @return a reference to a column vector containing the requested stability
145 double GetvFs(int axis) const { return vFs(axis); }
147 /** Retrieves the lift over drag ratio */
148 inline double GetLoD(void) const { return lod; }
150 /** Retrieves the square of the lift coefficient. */
151 inline double GetClSquared(void) const { return clsq; }
152 inline double GetAlphaCLMax(void) const { return alphaclmax; }
153 inline double GetAlphaCLMin(void) const { return alphaclmin; }
155 inline double GetHysteresisParm(void) const { return stall_hyst; }
156 inline double GetStallWarn(void) const { return impending_stall; }
157 double GetAlphaW(void) const { return alphaw; }
159 double GetBI2Vel(void) const { return bi2vel; }
160 double GetCI2Vel(void) const { return ci2vel; }
162 inline void SetAlphaCLMax(double tt) { alphaclmax=tt; }
163 inline void SetAlphaCLMin(double tt) { alphaclmin=tt; }
165 /** Gets the strings for the current set of coefficients.
166 @param delimeter either a tab or comma string depending on output type
167 @return a string containing the descriptive names for all coefficients */
168 string GetCoefficientStrings(string delimeter);
170 /** Gets the coefficient values.
171 @param delimeter either a tab or comma string depending on output type
172 @return a string containing the numeric values for the current set of
174 string GetCoefficientValues(string delimeter);
177 typedef map<string,int> AxisIndex;
179 FGFunction* AeroRPShift;
180 vector <FGFunction*> variables;
181 typedef vector <FGFunction*> CoeffArray;
184 FGColumnVector3 vForces;
185 FGColumnVector3 vMoments;
186 FGColumnVector3 vLastFs;
187 FGColumnVector3 vDXYZcg;
188 FGColumnVector3 vDeltaRP;
189 double alphaclmax, alphaclmin;
190 double alphahystmax, alphahystmin;
191 double impending_stall, stall_hyst;
192 double bi2vel, ci2vel,alphaw;
193 double clsq, lod, qbar_area;
195 typedef double (FGAerodynamics::*PMF)(int) const;
199 void Debug(int from);
202 } // namespace JSBSim
204 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%