-/*******************************************************************************
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Module: FGEngine.cpp
Author: Jon Berndt
09/03/99 JSB Changed Rocket thrust equation to correct -= Thrust instead of
+= Thrust (thanks to Tony Peden)
-********************************************************************************
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
-*******************************************************************************/
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
#ifdef FGFS
-# include <Include/compiler.h>
-# ifdef FG_HAVE_STD_INCLUDES
+# include <simgear/compiler.h>
+# ifdef SG_HAVE_STD_INCLUDES
# include <fstream>
# else
# include <fstream.h>
# endif
#else
-# include <fstream>
+# if defined(sgi) && !defined(__GNUC__) && (_COMPILER_VERSION < 740)
+# include <fstream.h>
+# else
+# include <fstream>
+# endif
#endif
#include "FGEngine.h"
-#include "FGState.h"
-#include "FGFDMExec.h"
-#include "FGAtmosphere.h"
-#include "FGFCS.h"
-#include "FGAircraft.h"
-#include "FGTranslation.h"
-#include "FGRotation.h"
-#include "FGPosition.h"
-#include "FGAuxiliary.h"
-#include "FGOutput.h"
-
-/*******************************************************************************
-************************************ CODE **************************************
-*******************************************************************************/
-
-
-FGEngine::FGEngine(FGFDMExec* fdex, string enginePath, string engineName, int num)
-{
- string fullpath;
- string tag;
-
- FDMExec = fdex;
-
- State = FDMExec->GetState();
- Atmosphere = FDMExec->GetAtmosphere();
- FCS = FDMExec->GetFCS();
- Aircraft = FDMExec->GetAircraft();
- Translation = FDMExec->GetTranslation();
- Rotation = FDMExec->GetRotation();
- Position = FDMExec->GetPosition();
- Auxiliary = FDMExec->GetAuxiliary();
- Output = FDMExec->GetOutput();
-
- Name = engineName;
- fullpath = enginePath + "/" + engineName + ".dat";
- ifstream enginefile(fullpath.c_str());
-
- if (enginefile) {
- enginefile >> tag;
-
- if (tag == "ROCKET") Type = etRocket;
- else if (tag == "PISTON") Type = etPiston;
- else if (tag == "TURBOPROP") Type = etTurboProp;
- else if (tag == "TURBOJET") Type = etTurboJet;
- else Type = etUnknown;
-
- enginefile >> X;
- enginefile >> Y;
- enginefile >> Z;
- enginefile >> SLThrustMax;
- enginefile >> VacThrustMax;
- enginefile >> MaxThrottle;
- enginefile >> MinThrottle;
- enginefile >> SLFuelFlowMax;
- if (Type == 1)
- enginefile >> SLOxiFlowMax;
- enginefile.close();
- } else {
- cerr << "Unable to open engine definition file " << engineName << endl;
- }
+#include "FGTank.h"
+#include "FGPropeller.h"
+#include "FGNozzle.h"
- EngineNumber = num;
+namespace JSBSim {
+
+static const char *IdSrc = "$Id$";
+static const char *IdHdr = ID_ENGINE;
+
+/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+CLASS IMPLEMENTATION
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
+
+
+FGEngine::FGEngine(FGFDMExec* exec, int engine_number) : EngineNumber(engine_number)
+{
+ Name = "";
+ Type = etUnknown;
+ X = Y = Z = 0.0;
+ EnginePitch = EngineYaw = 0.0;
+ SLFuelFlowMax = SLOxiFlowMax = 0.0;
+ MaxThrottle = 1.0;
+ MinThrottle = 0.0;
Thrust = 0.0;
- Starved = Flameout = false;
+ Throttle = 0.0;
+ Mixture = 1.0;
+ Starter = false;
+ FuelNeed = OxidizerNeed = 0.0;
+ Starved = Running = Cranking = false;
+ PctPower = 0.0;
+ TrimMode = false;
+ FuelFlow_gph = 0.0;
+ FuelFlow_pph = 0.0;
+
+ FDMExec = exec;
+ State = FDMExec->GetState();
+ Atmosphere = FDMExec->GetAtmosphere();
+ FCS = FDMExec->GetFCS();
+ Propulsion = FDMExec->GetPropulsion();
+ Aircraft = FDMExec->GetAircraft();
+ Propagate = FDMExec->GetPropagate();
+ Auxiliary = FDMExec->GetAuxiliary();
+ Output = FDMExec->GetOutput();
+
+ PropertyManager = FDMExec->GetPropertyManager();
+
+ Debug(0);
}
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-FGEngine::~FGEngine(void)
+FGEngine::~FGEngine()
{
+ Debug(1);
}
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+// This base class function should be called from within the
+// derived class' Calculate() function before any other calculations are done.
+// This base class method removes fuel from the fuel tanks as appropriate,
+// and sets the starved flag if necessary.
-float FGEngine::CalcRocketThrust(void)
+void FGEngine::ConsumeFuel(void)
{
- float lastThrust;
+ double Fshortage, Oshortage, TanksWithFuel;
+ FGTank* Tank;
+
+ if (TrimMode) return;
+ Fshortage = Oshortage = TanksWithFuel = 0.0;
+
+ // count how many assigned tanks have fuel
+ for (unsigned int i=0; i<SourceTanks.size(); i++) {
+ Tank = Propulsion->GetTank(SourceTanks[i]);
+ if (Tank->GetContents() > 0.0) {
+ ++TanksWithFuel;
+ }
+ }
+ if (!TanksWithFuel) return;
+
+ for (unsigned int i=0; i<SourceTanks.size(); i++) {
+ Tank = Propulsion->GetTank(SourceTanks[i]);
+ if (Tank->GetType() == FGTank::ttFUEL) {
+ Fshortage += Tank->Drain(CalcFuelNeed()/TanksWithFuel);
+ } else {
+ Oshortage += Tank->Drain(CalcOxidizerNeed()/TanksWithFuel);
+ }
+ }
- Throttle = FCS->GetThrottle(EngineNumber);
- lastThrust = Thrust; // last actual thrust
+ if (Fshortage < 0.00 || Oshortage < 0.00) Starved = true;
+ else Starved = false;
+}
- if (Throttle < MinThrottle || Starved) {
- PctPower = Thrust = 0.0; // desired thrust
- Flameout = true;
- } else {
- PctPower = Throttle / MaxThrottle;
- Thrust = PctPower*((1.0 - Atmosphere->Getrho() / 0.002378)*(VacThrustMax - SLThrustMax) +
- SLThrustMax); // desired thrust
- Flameout = false;
- }
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
- Thrust -= 0.8*(Thrust - lastThrust); // actual thrust
+double FGEngine::CalcFuelNeed(void)
+{
+ FuelNeed = SLFuelFlowMax*PctPower*State->Getdt()*Propulsion->GetRate();
+ return FuelNeed;
+}
- return Thrust;
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+double FGEngine::CalcOxidizerNeed(void)
+{
+ OxidizerNeed = SLOxiFlowMax*PctPower*State->Getdt()*Propulsion->GetRate();
+ return OxidizerNeed;
}
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-float FGEngine::CalcPistonThrust(void)
+void FGEngine::SetPlacement(double x, double y, double z, double pitch, double yaw)
{
- return Thrust;
+ X = x;
+ Y = y;
+ Z = z;
+ EnginePitch = pitch;
+ EngineYaw = yaw;
}
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-float FGEngine::CalcThrust(void)
+void FGEngine::AddFeedTank(int tkID)
{
- switch(Type) {
- case etRocket:
- return CalcRocketThrust();
- // break;
- case etPiston:
- return CalcPistonThrust();
- // break;
- default:
- return 9999.0;
- // break;
- }
+ SourceTanks.push_back(tkID);
}
-float FGEngine::CalcFuelNeed() {
- FuelNeed = SLFuelFlowMax*PctPower;
- return FuelNeed;
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+FGColumnVector3& FGEngine::GetBodyForces(void)
+{
+ return Thruster->GetBodyForces();
}
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-float FGEngine::CalcOxidizerNeed() {
- OxidizerNeed = SLOxiFlowMax*PctPower;
- return OxidizerNeed;
+FGColumnVector3& FGEngine::GetMoments(void)
+{
+ return Thruster->GetMoments();
}
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+bool FGEngine::LoadThruster(FGConfigFile* AC_cfg)
+{
+ string token, fullpath, localpath;
+ string thrusterFileName, thrType, engineFileName;
+ FGConfigFile* Cfg_ptr = 0;
+ double xLoc, yLoc, zLoc, Pitch, Yaw;
+ double P_Factor = 0, Sense = 0.0;
+ string enginePath = FDMExec->GetEnginePath();
+ string aircraftPath = FDMExec->GetAircraftPath();
+ thrusterFileName = AC_cfg->GetValue("FILE");
+
+# ifndef macintosh
+ fullpath = enginePath + "/";
+ localpath = aircraftPath + "/" + "/Engines/";
+# else
+ fullpath = enginePath + ";";
+ localpath = aircraftPath + ";" + ";Engines;";
+# endif
+
+ // Look in the Aircraft/Engines directory first
+ FGConfigFile Local_Thruster_cfg(localpath + thrusterFileName + ".xml");
+ FGConfigFile Thruster_cfg(fullpath + thrusterFileName + ".xml");
+
+ if (Local_Thruster_cfg.IsOpen()) {
+ Cfg_ptr = &Local_Thruster_cfg;
+ if (debug_lvl > 0) cout << "\n Reading thruster from file: " << localpath
+ + thrusterFileName + ".xml"<< endl;
+ } else {
+ if (Thruster_cfg.IsOpen()) {
+ Cfg_ptr = &Thruster_cfg;
+ if (debug_lvl > 0) cout << "\n Reading thruster from file: " << fullpath
+ + thrusterFileName + ".xml"<< endl;
+ }
+ }
+
+ if (Cfg_ptr) {
+ Cfg_ptr->GetNextConfigLine();
+ thrType = Cfg_ptr->GetValue();
+
+ if (thrType == "FG_PROPELLER") {
+ Thruster = new FGPropeller(FDMExec, Cfg_ptr);
+ } else if (thrType == "FG_NOZZLE") {
+ Thruster = new FGNozzle(FDMExec, Cfg_ptr);
+ } else if (thrType == "FG_DIRECT") {
+ Thruster = new FGThruster( FDMExec, Cfg_ptr);
+ }
+
+ AC_cfg->GetNextConfigLine();
+ while ((token = AC_cfg->GetValue()) != string("/AC_THRUSTER")) {
+ *AC_cfg >> token;
+ if (token == "XLOC") *AC_cfg >> xLoc;
+ else if (token == "YLOC") *AC_cfg >> yLoc;
+ else if (token == "ZLOC") *AC_cfg >> zLoc;
+ else if (token == "PITCH") *AC_cfg >> Pitch;
+ else if (token == "YAW") *AC_cfg >> Yaw;
+ else if (token == "P_FACTOR") *AC_cfg >> P_Factor;
+ else if (token == "SENSE") *AC_cfg >> Sense;
+ else cerr << "Unknown identifier: " << token << " in engine file: "
+ << engineFileName << endl;
+ }
+
+ Thruster->SetLocation(xLoc, yLoc, zLoc);
+ Thruster->SetAnglesToBody(0, Pitch, Yaw);
+ if (thrType == "FG_PROPELLER" && P_Factor > 0.001) {
+ ((FGPropeller*)Thruster)->SetPFactor(P_Factor);
+ if (debug_lvl > 0) cout << " P-Factor: " << P_Factor << endl;
+ ((FGPropeller*)Thruster)->SetSense(fabs(Sense)/Sense);
+ if (debug_lvl > 0) cout << " Sense: " << Sense << endl;
+ }
+ Thruster->SetdeltaT(State->Getdt() * Propulsion->GetRate());
+ return true;
+ } else {
+
+ cerr << "Could not read thruster config file: " << fullpath
+ + thrusterFileName + ".xml" << endl;
+ return false;
+ }
+
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+// The bitmasked value choices are as follows:
+// unset: In this case (the default) JSBSim would only print
+// out the normally expected messages, essentially echoing
+// the config files as they are read. If the environment
+// variable is not set, debug_lvl is set to 1 internally
+// 0: This requests JSBSim not to output any messages
+// whatsoever.
+// 1: This value explicity requests the normal JSBSim
+// startup messages
+// 2: This value asks for a message to be printed out when
+// a class is instantiated
+// 4: When this value is set, a message is displayed when a
+// FGModel object executes its Run() method
+// 8: When this value is set, various runtime state variables
+// are printed out periodically
+// 16: When set various parameters are sanity checked and
+// a message is printed out when they go out of bounds
+
+void FGEngine::Debug(int from)
+{
+ if (debug_lvl <= 0) return;
+
+ if (debug_lvl & 1) { // Standard console startup message output
+ if (from == 0) { // Constructor
+
+ }
+ }
+ if (debug_lvl & 2 ) { // Instantiation/Destruction notification
+ if (from == 0) cout << "Instantiated: FGEngine" << endl;
+ if (from == 1) cout << "Destroyed: FGEngine" << endl;
+ }
+ if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
+ }
+ if (debug_lvl & 8 ) { // Runtime state variables
+ }
+ if (debug_lvl & 16) { // Sanity checking
+ }
+ if (debug_lvl & 64) {
+ if (from == 0) { // Constructor
+ cout << IdSrc << endl;
+ cout << IdHdr << endl;
+ }
+ }
+}
+}
projects / flightgear.git / blobdiff