1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
42 # include <simgear/compiler.h>
43 # ifdef SG_HAVE_STD_INCLUDES
48 # include <iterator.h>
56 #include "FGPropulsion.h"
57 #include "FGConfigFile.h"
58 #include "FGMatrix33.h"
59 #include "FGColumnVector3.h"
60 #include "FGColumnVector4.h"
63 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
65 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
67 #define ID_AIRCRAFT "$Id$"
69 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
71 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
73 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
74 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
75 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
79 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
81 /** Encapsulates an Aircraft and its systems.
82 Owns all the parts (other classes) which make up this aircraft. This includes
83 the Engines, Tanks, Propellers, Nozzles, Aerodynamic and Mass properties,
84 landing gear, etc. These constituent parts may actually run as separate
85 JSBSim models themselves, but the responsibility for initializing them and
86 for retrieving their force and moment contributions falls to FGAircraft.<br>
91 <ol><li>Cooke, Zyda, Pratt, and McGhee, "NPSNET: Flight Simulation Dynamic Modeling
92 Using Quaternions", Presence, Vol. 1, No. 4, pp. 404-420 Naval Postgraduate
93 School, January 1994</li>
94 <li>D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices",
95 JSC 12960, July 1977</li>
96 <li>Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
97 NASA-Ames", NASA CR-2497, January 1975</li>
98 <li>Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
99 Wiley & Sons, 1979 ISBN 0-471-03032-5</li>
100 <li>Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons,
101 1982 ISBN 0-471-08936-2</li></ol>
104 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
106 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
108 class FGAircraft : public FGModel {
111 @param Executive a pointer to the parent executive object */
112 FGAircraft(FGFDMExec *Executive);
117 /** Runs the Aircraft model; called by the Executive
118 @see JSBSim.cpp documentation
119 @return false if no error */
122 /** Loads the aircraft.
123 The executive calls this method to load the aircraft into JSBSim.
124 @param AC_cfg a pointer to the config file instance
125 @return true if successful */
126 bool Load(FGConfigFile* AC_cfg);
128 /** Gets the aircraft name
129 @return the name of the aircraft as a string type */
130 inline string GetAircraftName(void) { return AircraftName; }
132 /// Gets the wing area
133 inline double GetWingArea(void) { return WingArea; }
134 /// Gets the wing span
135 inline double GetWingSpan(void) { return WingSpan; }
136 /// Gets the average wing chord
137 inline double Getcbar(void) { return cbar; }
138 inline double GetWingIncidence(void) { return WingIncidence; }
139 inline double GetHTailArea(void) { return HTailArea; }
140 inline double GetHTailArm(void) { return HTailArm; }
141 inline double GetVTailArea(void) { return VTailArea; }
142 inline double GetVTailArm(void) { return VTailArm; }
143 inline double Getlbarh(void) { return lbarh; } // HTailArm / cbar
144 inline double Getlbarv(void) { return lbarv; } // VTailArm / cbar
145 inline double Getvbarh(void) { return vbarh; } // H. Tail Volume
146 inline double Getvbarv(void) { return vbarv; } // V. Tail Volume
147 inline FGColumnVector3& GetMoments(void) { return vMoments; }
148 inline FGColumnVector3& GetForces(void) { return vForces; }
149 inline FGColumnVector3& GetBodyAccel(void) { return vBodyAccel; }
150 inline FGColumnVector3& GetNcg (void) { return vNcg; }
151 inline FGColumnVector3& GetXYZrp(void) { return vXYZrp; }
152 inline FGColumnVector3& GetXYZep(void) { return vXYZep; }
153 inline double GetXYZrp(int idx) { return vXYZrp(idx); }
154 inline double GetXYZep(int idx) { return vXYZep(idx); }
155 inline double GetAlphaCLMax(void) { return alphaclmax; }
156 inline double GetAlphaCLMin(void) { return alphaclmin; }
158 inline void SetAlphaCLMax(double tt) { alphaclmax=tt; }
159 inline void SetAlphaCLMin(double tt) { alphaclmin=tt; }
160 inline void SetAircraftName(string name) {AircraftName = name;}
162 inline double GetStallWarn(void) { return impending_stall; }
166 inline FGColumnVector3& GetNwcg(void) { return vNwcg; }
169 FGColumnVector3 vMoments;
170 FGColumnVector3 vForces;
171 FGColumnVector3 vXYZrp;
172 FGColumnVector3 vXYZep;
173 FGColumnVector3 vEuler;
174 FGColumnVector3 vDXYZcg;
175 FGColumnVector3 vBodyAccel;
176 FGColumnVector3 vNcg;
177 FGColumnVector3 vNwcg;
179 double WingArea, WingSpan, cbar, WingIncidence;
180 double HTailArea, VTailArea, HTailArm, VTailArm;
181 double lbarh,lbarv,vbarh,vbarv;
182 double alphaclmax,alphaclmin;
183 double impending_stall;
186 void Debug(int from);
189 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%