JSBSim Flight Dynamics Model  1.2.0 (05 Nov 2023)
An Open Source Flight Dynamics and Control Software Library in C++
Public Types | Public Member Functions | List of all members
FGTurboProp Class Reference

Detailed Description

Turboprop engine model.

For an example of this model in use see the file: engine/engtm601.xml

Configuration parameters:

milthrust   [LBS]
idlen1      [%]
maxn1       [%]
betarangeend[%]
    if ThrottleCmd < betarangeend/100.0 then engine power=idle, propeller pitch
    is controled by ThrottleCmd (between MINPITCH and  REVERSEPITCH).
    if ThrottleCmd > betarangeend/100.0 then engine power increases up to max reverse power
reversemaxpower [%]
    max engine power in reverse mode
maxpower    [HP]
psfc power specific fuel consumption [pph/HP] for N1=100%
n1idle_max_delay [-] time constant for N1 change
maxstartenginetime [sec]
    after this time the automatic starting cycle is interrupted when the engine
    doesn't start (0=automatic starting not present)
startern1   [%]
    when starting starter spin up engine to this spin
ielumaxtorque [lb.ft]
    if torque>ielumaxtorque limiters decrease the throttle
    (ielu = Integrated Electronic Limiter Unit)
itt_delay [-] time constant for ITT change
    (ITT = Inter Turbine Temperature)

Definition at line 92 of file FGTurboProp.h.

#include <FGTurboProp.h>

+ Inheritance diagram for FGTurboProp:
+ Collaboration diagram for FGTurboProp:

Public Types

enum  phaseType {
  tpOff , tpRun , tpSpinUp , tpStart ,
  tpTrim
}
 
- Public Types inherited from FGEngine
enum  EngineType {
  etUnknown , etRocket , etPiston , etTurbine ,
  etTurboprop , etElectric
}
 
- Public Types inherited from FGJSBBase
enum  { eL = 1 , eM , eN }
 Moments L, M, N.
 
enum  { eP = 1 , eQ , eR }
 Rates P, Q, R.
 
enum  { eU = 1 , eV , eW }
 Velocities U, V, W.
 
enum  { eX = 1 , eY , eZ }
 Positions X, Y, Z.
 
enum  { ePhi = 1 , eTht , ePsi }
 Euler angles Phi, Theta, Psi.
 
enum  { eDrag = 1 , eSide , eLift }
 Stability axis forces, Drag, Side force, Lift.
 
enum  { eRoll = 1 , ePitch , eYaw }
 Local frame orientation Roll, Pitch, Yaw.
 
enum  { eNorth = 1 , eEast , eDown }
 Local frame position North, East, Down.
 
enum  { eLat = 1 , eLong , eRad }
 Locations Radius, Latitude, Longitude.
 
enum  {
  inNone = 0 , inDegrees , inRadians , inMeters ,
  inFeet
}
 Conversion specifiers.
 

Public Member Functions

 FGTurboProp (FGFDMExec *Executive, Element *el, int engine_number, struct Inputs &input)
 Constructor. More...
 
double CalcFuelNeed (void)
 The fuel need is calculated based on power levels and flow rate for that power level. More...
 
void Calculate (void)
 Calculates the thrust of the engine, and other engine functions.
 
double ExpSeek (double *var, double target, double accel, double decel)
 
int GetCondition (void) const
 
bool GetCutoff (void) const
 
std::string GetEngineLabels (const std::string &delimiter)
 
std::string GetEngineValues (const std::string &delimiter)
 
double GetEngStarting (void) const
 
bool GetGeneratorPower (void) const
 
bool GetIeluIntervent (void) const
 
double GetIeluThrottle (void) const
 
double GetITT (void) const
 
double GetN1 (void) const
 
double getOilPressure_psi () const
 
double getOilTemp_degF (void)
 
phaseType GetPhase (void) const
 
double GetPowerAvailable (void) const
 
bool GetReversed (void) const
 
double GetRPM (void) const
 
int InitRunning (void)
 
double Seek (double *var, double target, double accel, double decel)
 
void SetCondition (bool c)
 
void SetCutoff (bool cutoff)
 
void SetGeneratorPower (bool gp)
 
void SetPhase (phaseType p)
 
void SetReverse (bool reversed)
 
- Public Member Functions inherited from FGEngine
 FGEngine (int engine_number, struct Inputs &input)
 
virtual double CalcOxidizerNeed (void)
 
virtual const FGColumnVector3 & GetBodyForces (void)
 
virtual bool GetCranking (void) const
 
virtual double getFuelFlow_gph () const
 
virtual double getFuelFlow_pph () const
 
virtual double GetFuelFlowRate (void) const
 
virtual double GetFuelFlowRateGPH (void) const
 
virtual double GetFuelUsedLbs (void) const
 
virtual const FGColumnVector3 & GetMoments (void)
 
virtual const std::string & GetName (void) const
 
size_t GetNumSourceTanks () const
 
virtual double GetPowerAvailable (void)
 
virtual bool GetRunning (void) const
 
unsigned int GetSourceTank (unsigned int i) const
 
virtual bool GetStarter (void) const
 
virtual bool GetStarved (void) const
 
virtual double GetThrottleMax (void) const
 
virtual double GetThrottleMin (void) const
 
virtual double GetThrust (void) const
 
FGThruster * GetThruster (void) const
 
EngineType GetType (void) const
 
void LoadThruster (FGFDMExec *exec, Element *el)
 
void LoadThrusterInputs ()
 
virtual void ResetToIC (void)
 Resets the Engine parameters to the initial conditions.
 
virtual void SetFuelDensity (double d)
 
virtual void SetFuelFreeze (bool f)
 
virtual void SetName (const std::string &name)
 
virtual void SetRunning (bool bb)
 
virtual void SetStarter (bool s)
 
virtual void SetStarved (bool tt)
 
virtual void SetStarved (void)
 
- Public Member Functions inherited from FGModelFunctions
std::string GetFunctionStrings (const std::string &delimeter) const
 Gets the strings for the current set of functions. More...
 
std::string GetFunctionValues (const std::string &delimeter) const
 Gets the function values. More...
 
std::shared_ptr< FGFunction > GetPreFunction (const std::string &name)
 Get one of the "pre" function. More...
 
bool Load (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void PostLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void PreLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void RunPostFunctions (void)
 
void RunPreFunctions (void)
 
- Public Member Functions inherited from FGJSBBase
 FGJSBBase ()
 Constructor for FGJSBBase.
 
virtual ~FGJSBBase ()
 Destructor for FGJSBBase.
 
void disableHighLighting (void)
 Disables highlighting in the console output.
 

Additional Inherited Members

- Static Public Member Functions inherited from FGJSBBase
static const std::string & GetVersion (void)
 Returns the version number of JSBSim. More...
 
static constexpr double KelvinToFahrenheit (double kelvin)
 Converts from degrees Kelvin to degrees Fahrenheit. More...
 
static constexpr double CelsiusToRankine (double celsius)
 Converts from degrees Celsius to degrees Rankine. More...
 
static constexpr double RankineToCelsius (double rankine)
 Converts from degrees Rankine to degrees Celsius. More...
 
static constexpr double KelvinToRankine (double kelvin)
 Converts from degrees Kelvin to degrees Rankine. More...
 
static constexpr double RankineToKelvin (double rankine)
 Converts from degrees Rankine to degrees Kelvin. More...
 
static constexpr double FahrenheitToCelsius (double fahrenheit)
 Converts from degrees Fahrenheit to degrees Celsius. More...
 
static constexpr double CelsiusToFahrenheit (double celsius)
 Converts from degrees Celsius to degrees Fahrenheit. More...
 
static constexpr double CelsiusToKelvin (double celsius)
 Converts from degrees Celsius to degrees Kelvin. More...
 
static constexpr double KelvinToCelsius (double kelvin)
 Converts from degrees Kelvin to degrees Celsius. More...
 
static constexpr double FeetToMeters (double measure)
 Converts from feet to meters. More...
 
static bool EqualToRoundoff (double a, double b)
 Finite precision comparison. More...
 
static bool EqualToRoundoff (float a, float b)
 Finite precision comparison. More...
 
static bool EqualToRoundoff (float a, double b)
 Finite precision comparison. More...
 
static bool EqualToRoundoff (double a, float b)
 Finite precision comparison. More...
 
static constexpr double Constrain (double min, double value, double max)
 Constrain a value between a minimum and a maximum value.
 
static constexpr double sign (double num)
 
- Public Attributes inherited from FGEngine
struct Inputs & in
 
- Static Public Attributes inherited from FGJSBBase
static char highint [5] = {27, '[', '1', 'm', '\0' }
 highlights text
 
static char halfint [5] = {27, '[', '2', 'm', '\0' }
 low intensity text
 
static char normint [6] = {27, '[', '2', '2', 'm', '\0' }
 normal intensity text
 
static char reset [5] = {27, '[', '0', 'm', '\0' }
 resets text properties
 
static char underon [5] = {27, '[', '4', 'm', '\0' }
 underlines text
 
static char underoff [6] = {27, '[', '2', '4', 'm', '\0' }
 underline off
 
static char fgblue [6] = {27, '[', '3', '4', 'm', '\0' }
 blue text
 
static char fgcyan [6] = {27, '[', '3', '6', 'm', '\0' }
 cyan text
 
static char fgred [6] = {27, '[', '3', '1', 'm', '\0' }
 red text
 
static char fggreen [6] = {27, '[', '3', '2', 'm', '\0' }
 green text
 
static char fgdef [6] = {27, '[', '3', '9', 'm', '\0' }
 default text
 
static short debug_lvl = 1
 
- Protected Member Functions inherited from FGEngine
void Debug (int from)
 
bool Load (FGFDMExec *exec, Element *el)
 
- Protected Member Functions inherited from FGModelFunctions
virtual bool InitModel (void)
 
- Static Protected Member Functions inherited from FGJSBBase
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
- Protected Attributes inherited from FGEngine
bool Cranking
 
const int EngineNumber
 
double FuelDensity
 
double FuelExpended
 
double FuelFlow_gph
 
double FuelFlow_pph
 
double FuelFlowRate
 
bool FuelFreeze
 
double FuelUsedLbs
 
double MaxThrottle
 
double MinThrottle
 
std::string Name
 
double PctPower
 
bool Running
 
double SLFuelFlowMax
 
std::vector< int > SourceTanks
 
bool Starter
 
bool Starved
 
FGThruster * Thruster
 
EngineType Type
 
- Protected Attributes inherited from FGModelFunctions
FGPropertyReader LocalProperties
 
std::vector< std::shared_ptr< FGFunction > > PostFunctions
 
std::vector< std::shared_ptr< FGFunction > > PreFunctions
 
- Static Protected Attributes inherited from FGJSBBase
static constexpr double radtodeg = 180. / M_PI
 
static constexpr double degtorad = M_PI / 180.
 
static constexpr double hptoftlbssec = 550.0
 
static constexpr double psftoinhg = 0.014138
 
static constexpr double psftopa = 47.88
 
static constexpr double fttom = 0.3048
 
static constexpr double ktstofps = 1852./(3600*fttom)
 
static constexpr double fpstokts = 1.0 / ktstofps
 
static constexpr double inchtoft = 1.0/12.0
 
static constexpr double m3toft3 = 1.0/(fttom*fttom*fttom)
 
static constexpr double in3tom3 = inchtoft*inchtoft*inchtoft/m3toft3
 
static constexpr double inhgtopa = 3386.38
 
static constexpr double slugtolb = 32.174049
 Note that definition of lbtoslug by the inverse of slugtolb and not to a different constant you can also get from some tables will make lbtoslug*slugtolb == 1 up to the magnitude of roundoff. More...
 
static constexpr double lbtoslug = 1.0/slugtolb
 
static constexpr double kgtolb = 2.20462
 
static constexpr double kgtoslug = 0.06852168
 
static const std::string needed_cfg_version = "2.0"
 
static const std::string JSBSim_version = JSBSIM_VERSION " " __DATE__ " " __TIME__
 

Constructor & Destructor Documentation

◆ FGTurboProp()

FGTurboProp ( FGFDMExec *  Executive,
Element *  el,
int  engine_number,
struct Inputs &  input 
)

Constructor.

Parameters
Executivepointer to executive structure
elpointer to the XML element representing the turbine engine
engine_numberengine number

Definition at line 62 of file FGTurboProp.cpp.

63  : FGEngine(engine_number, input)
64 {
65  SetDefaults();
66  Load(exec, el);
67  Debug(0);
68 }

Member Function Documentation

◆ CalcFuelNeed()

double CalcFuelNeed ( void  )
virtual

The fuel need is calculated based on power levels and flow rate for that power level.

It is also turned from a rate into an actual amount (pounds) by multiplying it by the delta T and the rate.

Returns
Total fuel requirement for this engine in pounds.

Reimplemented from FGEngine.

Definition at line 425 of file FGTurboProp.cpp.

426 {
427  FuelFlowRate = FuelFlow_pph / 3600.0;
428  FuelExpended = FuelFlowRate * in.TotalDeltaT;
429  if (!Starved) FuelUsedLbs += FuelExpended;
430  return FuelExpended;
431 }
The documentation for this class was generated from the following files: