/*******************************************************************************
-
+
Module: FGAircraft.cpp
Author: Jon S. Berndt
Date started: 12/12/98
Purpose: Encapsulates an aircraft
Called by: FGFDMExec
-
+
------------- Copyright (C) 1999 Jon S. Berndt (jsb@hal-pc.org) -------------
-
+
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
-
+
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
-
+
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.
-
+
FUNCTIONAL DESCRIPTION
--------------------------------------------------------------------------------
Models the aircraft reactions and forces. This class is instantiated by the
FGFDMExec class and scheduled as an FDM entry. LoadAircraft() is supplied with a
name of a valid, registered aircraft, and the data file is parsed.
-
+
HISTORY
--------------------------------------------------------------------------------
12/12/98 JSB Created
9/17/99 TP Combined force and moment functions. Added aero reference
point to config file. Added calculations for moments due to
difference in cg and aero reference point
-
+
********************************************************************************
COMMENTS, REFERENCES, and NOTES
********************************************************************************
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
-
+
The aerodynamic coefficients used in this model are:
-
+
Longitudinal
CL0 - Reference lift at zero alpha
CD0 - Reference drag at zero 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
-
+
********************************************************************************
INCLUDES
*******************************************************************************/
#include <sys/types.h>
#ifdef FGFS
-# ifndef __BORLANDC__
-# include <simgear/compiler.h>
-# endif
+# ifndef __BORLANDC__
+# include <simgear/compiler.h>
+# endif
# ifdef FG_HAVE_STD_INCLUDES
# include <cmath>
# else
#include "FGAuxiliary.h"
#include "FGOutput.h"
+static const char *IdSrc = "$Header$";
+static const char *IdHdr = ID_AIRCRAFT;
+
/*******************************************************************************
************************************ CODE **************************************
*******************************************************************************/
FGAircraft::FGAircraft(FGFDMExec* fdmex) : FGModel(fdmex),
- vMoments(3),
- vForces(3),
- vXYZrp(3),
- vbaseXYZcg(3),
- vXYZcg(3),
- vXYZep(3),
- vEuler(3),
- vFs(3)
+ vMoments(3),
+ vForces(3),
+ vFs(3),
+ vXYZrp(3),
+ vbaseXYZcg(3),
+ vXYZcg(3),
+ vXYZep(3),
+ vEuler(3)
+
{
Name = "FGAircraft";
AxisIdx["ROLL"] = 3;
AxisIdx["PITCH"] = 4;
AxisIdx["YAW"] = 5;
+
+ Coeff = new CoeffArray[6];
+
+ GearUp = false;
+
+ alphaclmin = alphaclmax = 0;
numTanks = numEngines = numSelectedFuelTanks = numSelectedOxiTanks = 0;
}
/******************************************************************************/
-FGAircraft::~FGAircraft(void)
-{
+FGAircraft::~FGAircraft(void) {
+ unsigned int i,j;
+
+ if (Engine != NULL) {
+ for (i=0; i<numEngines; i++)
+ delete Engine[i];
+ }
+ if (Tank != NULL) {
+ for (i=0; i<numTanks; i++)
+ delete Tank[i];
+ }
+ for (i=0; i<6; i++) {
+ for (j=0; j<Coeff[i].size(); j++) {
+ delete Coeff[i][j];
+ }
+ }
+ delete[] Coeff;
}
/******************************************************************************/
-bool FGAircraft::LoadAircraft(string aircraft_path, string engine_path, string fname)
-{
+bool FGAircraft::LoadAircraft(string aircraft_path, string engine_path, string fname) {
string path;
string filename;
string aircraftCfgFileName;
AircraftPath = aircraft_path;
EnginePath = engine_path;
- aircraftCfgFileName = AircraftPath + "/" + fname + "/" + fname + ".cfg";
+# ifndef macintosh
+ aircraftCfgFileName = AircraftPath + "/" + fname + "/" + fname + ".xml";
+# else
+ aircraftCfgFileName = AircraftPath + ";" + fname + ";" + fname + ".xml";
+# endif
FGConfigFile AC_cfg(aircraftCfgFileName);
+ if (!AC_cfg.IsOpen()) return false;
ReadPrologue(&AC_cfg);
while ((AC_cfg.GetNextConfigLine() != "EOF") &&
- (token = AC_cfg.GetValue()) != "/FDM_CONFIG")
- {
+ (token = AC_cfg.GetValue()) != "/FDM_CONFIG") {
if (token == "METRICS") {
cout << " Reading Metrics" << endl;
ReadMetrics(&AC_cfg);
/******************************************************************************/
-bool FGAircraft::Run(void)
-{
+bool FGAircraft::Run(void) {
if (!FGModel::Run()) { // if false then execute this Run()
GetState();
for (int i = 1; i <= 3; i++) vForces(i) = vMoments(i) = 0.0;
MassChange();
-
FMProp();
FMAero();
FMGear();
FMMass();
+
+ nlf = 0;
+ if (fabs(Position->GetGamma()) < 1.57) {
+ nlf = vFs(eZ)/(Weight*cos(Position->GetGamma()));
+ }
+
} else { // skip Run() execution this time
}
+
+
return false;
}
/******************************************************************************/
-void FGAircraft::MassChange()
-{
+void FGAircraft::MassChange() {
static FGColumnVector vXYZtank(3);
float Tw;
float IXXt, IYYt, IZZt, IXZt;
- int t;
+ unsigned int t;
unsigned int axis_ctr;
for (axis_ctr=1; axis_ctr<=3; axis_ctr++) vXYZtank(axis_ctr) = 0.0;
float Oshortage, Fshortage;
- for (int e=0; e<numEngines; e++) {
+ for (unsigned int e=0; e<numEngines; e++) {
Fshortage = Oshortage = 0.0;
for (t=0; t<numTanks; t++) {
switch(Engine[e]->GetType()) {
/******************************************************************************/
-void FGAircraft::FMAero(void)
-{
+void FGAircraft::FMAero(void) {
static FGColumnVector vDXYZcg(3);
+ static FGColumnVector vAeroBodyForces(3);
unsigned int axis_ctr,ctr;
for (axis_ctr=1; axis_ctr<=3; axis_ctr++) vFs(axis_ctr) = 0.0;
for (axis_ctr = 0; axis_ctr < 3; axis_ctr++) {
for (ctr=0; ctr < Coeff[axis_ctr].size(); ctr++) {
- vFs(axis_ctr+1) += Coeff[axis_ctr][ctr].TotalValue();
+ vFs(axis_ctr+1) += Coeff[axis_ctr][ctr]->TotalValue();
}
}
- vForces += State->GetTs2b(alpha, beta)*vFs;
+ vAeroBodyForces = State->GetTs2b(alpha, beta)*vFs;
+ vForces += vAeroBodyForces;
// The d*cg distances below, given in inches, are the distances FROM the c.g.
// TO the reference point. Since the c.g. and ref point are given in inches in
vDXYZcg(eY) = (vXYZrp(eY) - vXYZcg(eY))/12.0;
vDXYZcg(eZ) = -(vXYZrp(eZ) - vXYZcg(eZ))/12.0;
- vMoments(eL) += vForces(eZ)*vDXYZcg(eY) - vForces(eY)*vDXYZcg(eZ); // rolling moment
- vMoments(eM) += vForces(eX)*vDXYZcg(eZ) - vForces(eZ)*vDXYZcg(eX); // pitching moment
- vMoments(eN) += vForces(eY)*vDXYZcg(eX) - vForces(eX)*vDXYZcg(eY); // yawing moment
-
+ vMoments(eL) += vAeroBodyForces(eZ)*vDXYZcg(eY) - vAeroBodyForces(eY)*vDXYZcg(eZ); // rolling moment
+ vMoments(eM) += vAeroBodyForces(eX)*vDXYZcg(eZ) - vAeroBodyForces(eZ)*vDXYZcg(eX); // pitching moment
+ vMoments(eN) += vAeroBodyForces(eY)*vDXYZcg(eX) - vAeroBodyForces(eX)*vDXYZcg(eY); // yawing moment
+
for (axis_ctr = 0; axis_ctr < 3; axis_ctr++) {
for (ctr = 0; ctr < Coeff[axis_ctr+3].size(); ctr++) {
- vMoments(axis_ctr+1) += Coeff[axis_ctr+3][ctr].TotalValue();
+ vMoments(axis_ctr+1) += Coeff[axis_ctr+3][ctr]->TotalValue();
}
}
}
/******************************************************************************/
-void FGAircraft::FMGear(void)
-{
- if (GearUp) {
- // crash routine
- } else {
- for (unsigned int i=0;i<lGear.size();i++) {
- // lGear[i].
+void FGAircraft::FMGear(void) {
+
+ if ( !GearUp ) {
+ vector <FGLGear>::iterator iGear = lGear.begin();
+ while (iGear != lGear.end()) {
+ vForces += iGear->Force();
+ vMoments += iGear->Moment();
+ iGear++;
}
+ } else {
+ // Crash Routine
}
}
/******************************************************************************/
-void FGAircraft::FMMass(void)
-{
+void FGAircraft::FMMass(void) {
vForces(eX) += -GRAVITY*sin(vEuler(eTht)) * Mass;
vForces(eY) += GRAVITY*sin(vEuler(ePhi))*cos(vEuler(eTht)) * Mass;
vForces(eZ) += GRAVITY*cos(vEuler(ePhi))*cos(vEuler(eTht)) * Mass;
/******************************************************************************/
-void FGAircraft::FMProp(void)
-{
- for (int i=0;i<numEngines;i++) {
+void FGAircraft::FMProp(void) {
+ for (unsigned int i=0;i<numEngines;i++) {
+
+ // Changes required here for new engine placement parameters (i.e. location and direction)
+
vForces(eX) += Engine[i]->CalcThrust();
}
+
}
/******************************************************************************/
-void FGAircraft::GetState(void)
-{
+void FGAircraft::GetState(void) {
dt = State->Getdt();
alpha = Translation->Getalpha();
/******************************************************************************/
-void FGAircraft::ReadMetrics(FGConfigFile* AC_cfg)
-{
+void FGAircraft::ReadMetrics(FGConfigFile* AC_cfg) {
string token = "";
string parameter;
while ((token = AC_cfg->GetValue()) != "/METRICS") {
*AC_cfg >> parameter;
- if (parameter == "AC_WINGAREA") *AC_cfg >> WingArea;
- else if (parameter == "AC_WINGSPAN") *AC_cfg >> WingSpan;
- else if (parameter == "AC_CHORD") *AC_cfg >> cbar;
- else if (parameter == "AC_IXX") *AC_cfg >> baseIxx;
- else if (parameter == "AC_IYY") *AC_cfg >> baseIyy;
- else if (parameter == "AC_IZZ") *AC_cfg >> baseIzz;
- else if (parameter == "AC_IXZ") *AC_cfg >> baseIxz;
- else if (parameter == "AC_EMPTYWT") *AC_cfg >> EmptyWeight;
- else if (parameter == "AC_CGLOC") *AC_cfg >> vbaseXYZcg(eX) >> vbaseXYZcg(eY) >> vbaseXYZcg(eZ);
- else if (parameter == "AC_EYEPTLOC") *AC_cfg >> vXYZep(eX) >> vXYZep(eY) >> vXYZep(eZ);
- else if (parameter == "AC_AERORP") *AC_cfg >> vXYZrp(eX) >> vXYZrp(eY) >> vXYZrp(eZ);
+ if (parameter == "AC_WINGAREA") {
+ *AC_cfg >> WingArea;
+ cout << " WingArea: " << WingArea << endl;
+ } else if (parameter == "AC_WINGSPAN") {
+ *AC_cfg >> WingSpan;
+ cout << " WingSpan: " << WingSpan << endl;
+ } else if (parameter == "AC_CHORD") {
+ *AC_cfg >> cbar;
+ cout << " Chord: " << cbar << endl;
+ } else if (parameter == "AC_IXX") {
+ *AC_cfg >> baseIxx;
+ cout << " baseIxx: " << baseIxx << endl;
+ } else if (parameter == "AC_IYY") {
+ *AC_cfg >> baseIyy;
+ cout << " baseIyy: " << baseIyy << endl;
+ } else if (parameter == "AC_IZZ") {
+ *AC_cfg >> baseIzz;
+ cout << " baseIzz: " << baseIzz << endl;
+ } else if (parameter == "AC_IXZ") {
+ *AC_cfg >> baseIxz;
+ cout << " baseIxz: " << baseIxz << endl;
+ } else if (parameter == "AC_EMPTYWT") {
+ *AC_cfg >> EmptyWeight;
+ cout << " EmptyWeight: " << EmptyWeight << endl;
+ } else if (parameter == "AC_CGLOC") {
+ *AC_cfg >> vbaseXYZcg(eX) >> vbaseXYZcg(eY) >> vbaseXYZcg(eZ);
+ cout << " CG (x, y, z): " << vbaseXYZcg << endl;
+ } else if (parameter == "AC_EYEPTLOC") {
+ *AC_cfg >> vXYZep(eX) >> vXYZep(eY) >> vXYZep(eZ);
+ cout << " Eyepoint (x, y, z): " << vXYZep << endl;
+ } else if (parameter == "AC_AERORP") {
+ *AC_cfg >> vXYZrp(eX) >> vXYZrp(eY) >> vXYZrp(eZ);
+ cout << " Ref Pt (x, y, z): " << vXYZrp << endl;
+ } else if (parameter == "AC_ALPHALIMITS") {
+ *AC_cfg >> alphaclmin >> alphaclmax;
+ cout << " Maximum Alpha: " << alphaclmax
+ << " Minimum Alpha: " << alphaclmin
+ << endl;
+ }
}
}
/******************************************************************************/
-void FGAircraft::ReadPropulsion(FGConfigFile* AC_cfg)
-{
+void FGAircraft::ReadPropulsion(FGConfigFile* AC_cfg) {
string token;
string engine_name;
string parameter;
/******************************************************************************/
-void FGAircraft::ReadFlightControls(FGConfigFile* AC_cfg)
-{
+void FGAircraft::ReadFlightControls(FGConfigFile* AC_cfg) {
string token;
FCS->LoadFCS(AC_cfg);
/******************************************************************************/
-void FGAircraft::ReadAerodynamics(FGConfigFile* AC_cfg)
-{
+void FGAircraft::ReadAerodynamics(FGConfigFile* AC_cfg) {
string token, axis;
AC_cfg->GetNextConfigLine();
-
- Coeff.push_back(*(new CoeffArray()));
- Coeff.push_back(*(new CoeffArray()));
- Coeff.push_back(*(new CoeffArray()));
- Coeff.push_back(*(new CoeffArray()));
- Coeff.push_back(*(new CoeffArray()));
- Coeff.push_back(*(new CoeffArray()));
-
+
while ((token = AC_cfg->GetValue()) != "/AERODYNAMICS") {
if (token == "AXIS") {
+ CoeffArray ca;
axis = AC_cfg->GetValue("NAME");
AC_cfg->GetNextConfigLine();
while ((token = AC_cfg->GetValue()) != "/AXIS") {
- Coeff[AxisIdx[axis]].push_back(*(new FGCoefficient(FDMExec, AC_cfg)));
- DisplayCoeffFactors(Coeff[AxisIdx[axis]].back().Getmultipliers());
+ ca.push_back(new FGCoefficient(FDMExec, AC_cfg));
+ DisplayCoeffFactors(ca.back()->Getmultipliers());
}
+ Coeff[AxisIdx[axis]]=ca;
AC_cfg->GetNextConfigLine();
}
}
/******************************************************************************/
-void FGAircraft::ReadUndercarriage(FGConfigFile* AC_cfg)
-{
+void FGAircraft::ReadUndercarriage(FGConfigFile* AC_cfg) {
string token;
AC_cfg->GetNextConfigLine();
while ((token = AC_cfg->GetValue()) != "/UNDERCARRIAGE") {
- lGear.push_back(new FGLGear(AC_cfg));
+ lGear.push_back(FGLGear(AC_cfg, FDMExec));
}
}
/******************************************************************************/
-void FGAircraft::ReadOutput(FGConfigFile* AC_cfg)
-{
+void FGAircraft::ReadOutput(FGConfigFile* AC_cfg) {
string token, parameter;
int OutRate = 0;
int subsystems = 0;
*AC_cfg >> parameter;
if (parameter == "ON") subsystems += ssCoefficients;
}
+ if (parameter == "GROUND_REACTIONS") {
+ *AC_cfg >> parameter;
+ if (parameter == "ON") subsystems += ssGroundReactions;
+ }
}
Output->SetSubsystems(subsystems);
/******************************************************************************/
-void FGAircraft::ReadPrologue(FGConfigFile* AC_cfg)
-{
+void FGAircraft::ReadPrologue(FGConfigFile* AC_cfg) {
string token = AC_cfg->GetValue();
-
+ string scratch;
AircraftName = AC_cfg->GetValue("NAME");
cout << "Reading Aircraft Configuration File: " << AircraftName << endl;
- CFGVersion = strtod(AC_cfg->GetValue("VERSION").c_str(),NULL);
- cout << " Version: " << CFGVersion << endl;
+ scratch=AC_cfg->GetValue("VERSION").c_str();
- if (CFGVersion < NEEDED_CFG_VERSION) {
- cout << endl << "YOU HAVE AN OLD CFG FILE FOR THIS AIRCRAFT."
- " RESULTS WILL BE UNPREDICTABLE !!" << endl;
+ CFGVersion = AC_cfg->GetValue("VERSION");
+ cout << " Version: " << CFGVersion << endl;
+ if (CFGVersion != NEEDED_CFG_VERSION) {
+ cout << endl << "YOU HAVE AN INCOMPATIBLE CFG FILE FOR THIS AIRCRAFT."
+ " RESULTS WILL BE UNPREDICTABLE !!" << endl;
cout << "Current version needed is: " << NEEDED_CFG_VERSION << endl;
cout << " You have version: " << CFGVersion << endl << endl;
- exit(-1);
+ //exit(-1);
}
+
+
}
/******************************************************************************/
-void FGAircraft::DisplayCoeffFactors(int multipliers)
-{
+void FGAircraft::DisplayCoeffFactors(vector <eParam> multipliers) {
cout << " Non-Dimensionalized by: ";
- if (multipliers & FG_QBAR) cout << "qbar ";
- if (multipliers & FG_WINGAREA) cout << "S ";
- if (multipliers & FG_WINGSPAN) cout << "b ";
- if (multipliers & FG_CBAR) cout << "c ";
- if (multipliers & FG_ALPHA) cout << "alpha ";
- if (multipliers & FG_ALPHADOT) cout << "alphadot ";
- if (multipliers & FG_BETA) cout << "beta ";
- if (multipliers & FG_BETADOT) cout << "betadot ";
- if (multipliers & FG_PITCHRATE) cout << "q ";
- if (multipliers & FG_ROLLRATE) cout << "p ";
- if (multipliers & FG_YAWRATE) cout << "r ";
-
- if (multipliers & FG_ELEVATOR_CMD) cout << "De cmd ";
- if (multipliers & FG_AILERON_CMD) cout << "Da cmd ";
- if (multipliers & FG_RUDDER_CMD) cout << "Dr cmd ";
- if (multipliers & FG_FLAPS_CMD) cout << "Df cmd ";
- if (multipliers & FG_SPOILERS_CMD) cout << "Dsp cmd ";
- if (multipliers & FG_SPDBRAKE_CMD) cout << "Dsb cmd ";
-
- if (multipliers & FG_ELEVATOR_POS) cout << "De ";
- if (multipliers & FG_AILERON_POS) cout << "Da ";
- if (multipliers & FG_RUDDER_POS) cout << "Dr ";
- if (multipliers & FG_FLAPS_POS) cout << "Df ";
- if (multipliers & FG_SPOILERS_POS) cout << "Dsp ";
- if (multipliers & FG_SPDBRAKE_POS) cout << "Dsb ";
-
- if (multipliers & FG_MACH) cout << "Mach ";
- if (multipliers & FG_ALTITUDE) cout << "h ";
- if (multipliers & FG_BI2VEL) cout << "b /(2*Vt) ";
- if (multipliers & FG_CI2VEL) cout << "c /(2*Vt) ";
+ for (unsigned int i=0; i<multipliers.size();i++)
+ cout << State->paramdef[multipliers[i]];
cout << endl;
}
/******************************************************************************/
-string FGAircraft::GetCoefficientStrings(void)
-{
+string FGAircraft::GetCoefficientStrings(void) {
string CoeffStrings = "";
bool firstime = true;
} else {
CoeffStrings += ", ";
}
- CoeffStrings += Coeff[axis][sd].Getname();
+ CoeffStrings += Coeff[axis][sd]->Getname();
}
}
/******************************************************************************/
-string FGAircraft::GetCoefficientValues(void)
-{
+string FGAircraft::GetCoefficientValues(void) {
string SDValues = "";
char buffer[10];
bool firstime = true;
} else {
SDValues += ", ";
}
- sprintf(buffer, "%9.6f", Coeff[axis][sd].GetSD());
+ sprintf(buffer, "%9.6f", Coeff[axis][sd]->GetSD());
SDValues += string(buffer);
}
}
- return SDValues;;
+ return SDValues;
+ ;
+}
+
+/******************************************************************************/
+
+string FGAircraft::GetGroundReactionStrings(void) {
+ string GroundReactionStrings = "";
+ bool firstime = true;
+
+ for (unsigned int i=0;i<lGear.size();i++) {
+ if (!firstime) GroundReactionStrings += ", ";
+ GroundReactionStrings += (lGear[i].GetName() + "_WOW, ");
+ GroundReactionStrings += (lGear[i].GetName() + "_compressLength, ");
+ GroundReactionStrings += (lGear[i].GetName() + "_compressSpeed, ");
+ GroundReactionStrings += (lGear[i].GetName() + "_Force");
+
+ firstime = false;
+ }
+
+ return GroundReactionStrings;
}
+/******************************************************************************/
+
+string FGAircraft::GetGroundReactionValues(void) {
+ char buff[20];
+ string GroundReactionValues = "";
+
+ bool firstime = true;
+
+ for (unsigned int i=0;i<lGear.size();i++) {
+ if (!firstime) GroundReactionValues += ", ";
+ GroundReactionValues += string( lGear[i].GetWOW()?"1":"0" ) + ", ";
+ GroundReactionValues += (string(gcvt(lGear[i].GetCompLen(), 5, buff)) + ", ");
+ GroundReactionValues += (string(gcvt(lGear[i].GetCompVel(), 6, buff)) + ", ");
+ GroundReactionValues += (string(gcvt(lGear[i].GetCompForce(), 10, buff)));
+
+ firstime = false;
+ }
+
+ return GroundReactionValues;
+}