-/*******************************************************************************
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Header: FGAircraft.h
Author: Jon S. Berndt
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA.
-
+
Further information about the GNU General Public License can also be found on
the world wide web at http://www.gnu.org.
--------------------------------------------------------------------------------
12/12/98 JSB Created
-********************************************************************************
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
#ifndef FGAIRCRAFT_H
#define FGAIRCRAFT_H
-/*******************************************************************************
-COMMENTS, REFERENCES, and NOTES
-*******************************************************************************/
-/*
-The aerodynamic coefficients used in this model typically are:
-
-Longitudinal
- CL0 - Reference lift at zero alpha
- CD0 - Reference drag at zero alpha
- CDM - Drag due to Mach
- CLa - Lift curve slope (w.r.t. alpha)
- CDa - Drag curve slope (w.r.t. alpha)
- CLq - Lift due to pitch rate
- CLM - Lift due to Mach
- CLadt - Lift due to alpha rate
-
- Cmadt - Pitching Moment due to alpha rate
- Cm0 - Reference Pitching moment at zero alpha
- Cma - Pitching moment slope (w.r.t. alpha)
- Cmq - Pitch damping (pitch moment due to pitch rate)
- CmM - Pitch Moment due to Mach
-
-Lateral
- Cyb - Side force due to sideslip
- Cyr - Side force due to yaw rate
-
- Clb - Dihedral effect (roll moment due to sideslip)
- Clp - Roll damping (roll moment due to roll rate)
- Clr - Roll moment due to yaw rate
- Cnb - Weathercocking stability (yaw moment due to sideslip)
- Cnp - Rudder adverse yaw (yaw moment due to roll rate)
- Cnr - Yaw damping (yaw moment due to yaw rate)
-
-Control
- CLDe - Lift due to elevator
- CDDe - Drag due to elevator
- CyDr - Side force due to rudder
- CyDa - Side force due to aileron
-
- CmDe - Pitch moment due to elevator
- ClDa - Roll moment due to aileron
- ClDr - Roll moment due to rudder
- CnDr - Yaw moment due to rudder
- CnDa - Yaw moment due to aileron
-
-[1] Cooke, Zyda, Pratt, and McGhee, "NPSNET: Flight Simulation Dynamic Modeling
- Using Quaternions", Presence, Vol. 1, No. 4, pp. 404-420 Naval Postgraduate
- School, January 1994
-[2] D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices",
- JSC 12960, July 1977
-[3] Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
- NASA-Ames", NASA CR-2497, January 1975
-[4] Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
- Wiley & Sons, 1979 ISBN 0-471-03032-5
-[5] Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons,
- 1982 ISBN 0-471-08936-2
-*/
-
-/*******************************************************************************
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
#ifdef FGFS
# include <simgear/compiler.h>
-# ifdef FG_HAVE_STD_INCLUDES
+# ifdef SG_HAVE_STD_INCLUDES
# include <vector>
-# include <map>
+# include <iterator>
# else
# include <vector.h>
-# include <map.h>
+# include <iterator.h>
# endif
#else
# include <vector>
-# include <map>
+# include <iterator>
#endif
#include "FGModel.h"
-#include "FGCoefficient.h"
-#include "FGEngine.h"
-#include "FGTank.h"
-#include "FGLGear.h"
+#include "FGPropulsion.h"
#include "FGConfigFile.h"
-#include "FGMatrix.h"
+#include "FGMatrix33.h"
+#include "FGColumnVector3.h"
+#include "FGColumnVector4.h"
+#include "FGLGear.h"
-/*******************************************************************************
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DEFINITIONS
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+#define ID_AIRCRAFT "$Id$"
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+FORWARD DECLARATIONS
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+CLASS DOCUMENTATION
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+/** Encapsulates an Aircraft and its systems.
+ Owns all the parts (other classes) which make up this aircraft. This includes
+ the Engines, Tanks, Propellers, Nozzles, Aerodynamic and Mass properties,
+ landing gear, etc. These constituent parts may actually run as separate
+ JSBSim models themselves, but the responsibility for initializing them and
+ for retrieving their force and moment contributions falls to FGAircraft.<br>
+
+ @author Jon S. Berndt
+ @version $Id$
+ @see
+ <ol><li>Cooke, Zyda, Pratt, and McGhee, "NPSNET: Flight Simulation Dynamic Modeling
+ Using Quaternions", Presence, Vol. 1, No. 4, pp. 404-420 Naval Postgraduate
+ School, January 1994</li>
+ <li>D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices",
+ JSC 12960, July 1977</li>
+ <li>Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
+ NASA-Ames", NASA CR-2497, January 1975</li>
+ <li>Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
+ Wiley & Sons, 1979 ISBN 0-471-03032-5</li>
+ <li>Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons,
+ 1982 ISBN 0-471-08936-2</li></ol>
+ @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGAircraft.h?rev=HEAD&content-type=text/vnd.viewcvs-markup">
+ Header File </a>
+ @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGAircraft.cpp?rev=HEAD&content-type=text/vnd.viewcvs-markup">
+ Source File </a>
+*/
-/*******************************************************************************
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
class FGAircraft : public FGModel {
- enum {eL=1, eM, eN};
- enum {eX=1, eY, eZ};
- enum {eP=1, eQ, eR};
- enum {ePhi=1, eTht, ePsi};
-
public:
- FGAircraft(FGFDMExec*);
- ~FGAircraft(void);
+ /** Constructor
+ @param Executive a pointer to the parent executive object */
+ FGAircraft(FGFDMExec *Executive);
+
+ /// Destructor
+ ~FGAircraft();
+ /** Runs the Aircraft model; called by the Executive
+ @see JSBSim.cpp documentation
+ @return false if no error */
bool Run(void);
- bool LoadAircraft(string, string, string);
+
+ /** Loads the aircraft.
+ The executive calls this method to load the aircraft into JSBSim.
+ @param AC_cfg a pointer to the config file instance
+ @return true if successful */
+ bool Load(FGConfigFile* AC_cfg);
+
+ /** Gets the aircraft name
+ @return the name of the aircraft as a string type */
inline string GetAircraftName(void) { return AircraftName; }
- inline void SetGearUp(bool tt) { GearUp = tt; }
- inline bool GetGearUp(void) { return GearUp; }
- inline int GetNumGearUnits(void) { return lGear.size(); }
- inline FGLGear* GetGearUnit(int ii) { return lGear[ii]; }
- inline float GetWingArea(void) { return WingArea; }
- inline float GetWingSpan(void) { return WingSpan; }
- inline float Getcbar(void) { return cbar; }
- inline FGEngine* GetEngine(int tt) { return Engine[tt]; }
- inline FGTank* GetTank(int tt) { return Tank[tt]; }
- inline float GetWeight(void) { return Weight; }
- inline float GetMass(void) { return Mass; }
- inline FGColumnVector GetMoments(void) { return vMoments; }
- inline FGColumnVector GetForces(void) { return vForces; }
- inline FGColumnVector GetvFs(void) { return vFs; }
- inline float GetIxx(void) { return Ixx; }
- inline float GetIyy(void) { return Iyy; }
- inline float GetIzz(void) { return Izz; }
- inline float GetIxz(void) { return Ixz; }
- inline unsigned int GetNumEngines(void) { return numEngines; }
- inline FGColumnVector GetXYZcg(void) { return vXYZcg; }
- inline FGColumnVector GetXYZrp(void) { return vXYZrp; }
- inline FGColumnVector GetXYZep(void) { return vXYZep; }
- inline float GetNlf(void) { return nlf; }
- inline float GetAlphaCLMax(void) { return alphaclmax; }
- inline float GetAlphaCLMin(void) { return alphaclmin; }
-
- inline void SetAlphaCLMax(float tt) { alphaclmax=tt; }
- inline void SetAlphaCLMin(float tt) { alphaclmin=tt; }
-
- inline FGCoefficient* GetCoeff(int axis, int idx) { return Coeff[axis][idx]; }
- string GetCoefficientStrings(void);
- string GetCoefficientValues(void);
- string GetGroundReactionStrings(void);
- string GetGroundReactionValues(void);
-
- enum { ssSimulation = 1,
- ssAerosurfaces = 2,
- ssRates = 4,
- ssVelocities = 8,
- ssForces = 16,
- ssMoments = 32,
- ssAtmosphere = 64,
- ssMassProps = 128,
- ssCoefficients = 256,
- ssPosition = 512,
- ssGroundReactions = 1024 } subsystems;
+
+ /// Gets the wing area
+ double GetWingArea(void) const { return WingArea; }
+ /// Gets the wing span
+ double GetWingSpan(void) const { return WingSpan; }
+ /// Gets the average wing chord
+ double Getcbar(void) const { return cbar; }
+ inline double GetWingIncidence(void) const { return WingIncidence; }
+ inline double GetHTailArea(void) const { return HTailArea; }
+ inline double GetHTailArm(void) const { return HTailArm; }
+ inline double GetVTailArea(void) const { return VTailArea; }
+ inline double GetVTailArm(void) const { return VTailArm; }
+ inline double Getlbarh(void) const { return lbarh; } // HTailArm / cbar
+ inline double Getlbarv(void) const { return lbarv; } // VTailArm / cbar
+ inline double Getvbarh(void) const { return vbarh; } // H. Tail Volume
+ inline double Getvbarv(void) const { return vbarv; } // V. Tail Volume
+ inline FGColumnVector3& GetMoments(void) { return vMoments; }
+ inline double GetMoments(int idx) const { return vMoments(idx); }
+ inline FGColumnVector3& GetForces(void) { return vForces; }
+ inline double GetForces(int idx) const { return vForces(idx); }
+ inline FGColumnVector3& GetBodyAccel(void) { return vBodyAccel; }
+ inline FGColumnVector3& GetNcg (void) { return vNcg; }
+ inline FGColumnVector3& GetXYZrp(void) { return vXYZrp; }
+ inline FGColumnVector3& GetXYZep(void) { return vXYZep; }
+ inline double GetXYZrp(int idx) const { return vXYZrp(idx); }
+ inline double GetXYZep(int idx) const { return vXYZep(idx); }
+ inline void SetAircraftName(string name) {AircraftName = name;}
+
+ float GetNlf(void);
+
+ inline FGColumnVector3& GetNwcg(void) { return vNwcg; }
+
+ void bind(void);
+ void unbind(void);
private:
- void GetState(void);
- void FMAero(void);
- void FMGear(void);
- void FMMass(void);
- void FMProp(void);
- void MassChange(void);
- FGColumnVector vMoments;
- FGColumnVector vForces;
- FGColumnVector vFs;
- FGColumnVector vXYZrp;
- FGColumnVector vbaseXYZcg;
- FGColumnVector vXYZcg;
- FGColumnVector vXYZep;
- FGColumnVector vEuler;
- float baseIxx, baseIyy, baseIzz, baseIxz, EmptyMass, Mass;
- float Ixx, Iyy, Izz, Ixz;
- float alpha, beta;
- float WingArea, WingSpan, cbar;
- float Weight, EmptyWeight;
- float nlf,alphaclmax,alphaclmin;
- float dt;
- string CFGVersion;
+ FGColumnVector3 vMoments;
+ FGColumnVector3 vForces;
+ FGColumnVector3 vXYZrp;
+ FGColumnVector3 vXYZep;
+ FGColumnVector3 vEuler;
+ FGColumnVector3 vDXYZcg;
+ FGColumnVector3 vBodyAccel;
+ FGColumnVector3 vNcg;
+ FGColumnVector3 vNwcg;
+
+ double WingArea, WingSpan, cbar, WingIncidence;
+ double HTailArea, VTailArea, HTailArm, VTailArm;
+ double lbarh,lbarv,vbarh,vbarv;
string AircraftName;
- unsigned int numTanks;
- unsigned int numEngines;
- unsigned int numSelectedOxiTanks;
- unsigned int numSelectedFuelTanks;
- FGTank* Tank[MAX_TANKS]; // need to make a vector
- FGEngine *Engine[MAX_ENGINES]; // need to make a vector
-
- typedef map<string,int> AxisIndex;
- AxisIndex AxisIdx;
-
- typedef vector<FGCoefficient*> CoeffArray;
-
- CoeffArray* Coeff;
-
- void DisplayCoeffFactors(vector <eParam> multipliers);
-
- bool GearUp;
-
- string Axis[6];
- vector <FGLGear*> lGear;
- string AircraftPath;
- string EnginePath;
- void ReadMetrics(FGConfigFile*);
- void ReadPropulsion(FGConfigFile*);
- void ReadFlightControls(FGConfigFile*);
- void ReadAerodynamics(FGConfigFile*);
- void ReadUndercarriage(FGConfigFile*);
- void ReadPrologue(FGConfigFile*);
- void ReadOutput(FGConfigFile*);
+ void Debug(int from);
};
-/******************************************************************************/
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#endif
+
projects / flightgear.git / blobdiff