FlightGear next
JSBSim::FGEngine Class Referenceabstract

Base class for all engines. More...

#include <FGEngine.h>

Inherits JSBSim::FGModelFunctions.

Inherited by JSBSim::FGElectric, JSBSim::FGPiston, JSBSim::FGRocket, JSBSim::FGTurbine, and JSBSim::FGTurboProp.

Classes

struct  Inputs
 

Public Types

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

Public Member Functions

 FGEngine (int engine_number, struct Inputs &input)
 
 ~FGEngine () override
 
EngineType GetType (void) const
 
virtual const std::string & GetName (void) const
 
virtual double GetThrottleMin (void) const
 
virtual double GetThrottleMax (void) const
 
virtual bool GetStarter (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 bool GetStarved (void) const
 
virtual bool GetRunning (void) const
 
virtual bool GetCranking (void) const
 
virtual void SetStarved (bool tt)
 
virtual void SetStarved (void)
 
virtual void SetRunning (bool bb)
 
virtual void SetName (const std::string &name)
 
virtual void SetFuelFreeze (bool f)
 
virtual void SetFuelDensity (double d)
 
virtual void SetStarter (bool s)
 
virtual int InitRunning (void)
 
virtual void ResetToIC (void)
 Resets the Engine parameters to the initial conditions.
 
virtual void Calculate (void)=0
 Calculates the thrust of the engine, and other engine functions.
 
virtual double GetThrust (void) const
 
virtual double CalcFuelNeed (void)
 The fuel need is calculated based on power levels and flow rate for that power level.
 
virtual double CalcOxidizerNeed (void)
 
virtual double GetPowerAvailable (void)
 
virtual const FGColumnVector3GetBodyForces (void)
 
virtual const FGColumnVector3GetMoments (void)
 
void LoadThruster (FGFDMExec *exec, Element *el)
 
FGThrusterGetThruster (void) const
 
unsigned int GetSourceTank (unsigned int i) const
 
size_t GetNumSourceTanks () const
 
virtual std::string GetEngineLabels (const std::string &delimiter)=0
 
virtual std::string GetEngineValues (const std::string &delimiter)=0
 
void LoadThrusterInputs ()
 
- Public Member Functions inherited from JSBSim::FGModelFunctions
virtual ~FGModelFunctions ()
 
void RunPreFunctions (void)
 
void RunPostFunctions (void)
 
bool Load (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void PreLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void PostLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
std::string GetFunctionStrings (const std::string &delimeter) const
 Gets the strings for the current set of functions.
 
std::string GetFunctionValues (const std::string &delimeter) const
 Gets the function values.
 
FGFunctionGetPreFunction (const std::string &name)
 Get one of the "pre" function.
 
- Public Member Functions inherited from JSBSim::FGJSBBase
 FGJSBBase ()
 Constructor for FGJSBBase.
 
virtual ~FGJSBBase ()
 Destructor for FGJSBBase.
 
void PutMessage (const Message &msg)
 Places a Message structure on the Message queue.
 
void PutMessage (const std::string &text)
 Creates a message with the given text and places it on the queue.
 
void PutMessage (const std::string &text, bool bVal)
 Creates a message with the given text and boolean value and places it on the queue.
 
void PutMessage (const std::string &text, int iVal)
 Creates a message with the given text and integer value and places it on the queue.
 
void PutMessage (const std::string &text, double dVal)
 Creates a message with the given text and double value and places it on the queue.
 
int SomeMessages (void) const
 Reads the message on the queue (but does not delete it).
 
void ProcessMessage (void)
 Reads the message on the queue and removes it from the queue.
 
MessageProcessNextMessage (void)
 Reads the next message on the queue and removes it from the queue.
 
void disableHighLighting (void)
 Disables highlighting in the console output.
 

Public Attributes

struct Inputsin
 

Protected Member Functions

bool Load (FGFDMExec *exec, Element *el)
 
void Debug (int from)
 
- Protected Member Functions inherited from JSBSim::FGModelFunctions
virtual bool InitModel (void)
 

Protected Attributes

std::string Name
 
const int EngineNumber
 
EngineType Type
 
double SLFuelFlowMax
 
double MaxThrottle
 
double MinThrottle
 
double FuelExpended
 
double FuelFlowRate
 
double PctPower
 
bool Starter
 
bool Starved
 
bool Running
 
bool Cranking
 
bool FuelFreeze
 
double FuelFlow_gph
 
double FuelFlow_pph
 
double FuelUsedLbs
 
double FuelDensity
 
FGThrusterThruster
 
std::vector< int > SourceTanks
 
- Protected Attributes inherited from JSBSim::FGModelFunctions
std::vector< FGFunction * > PreFunctions
 
std::vector< FGFunction * > PostFunctions
 
FGPropertyReader LocalProperties
 

Additional Inherited Members

static const std::string & GetVersion (void)
 Returns the version number of JSBSim.
 
static constexpr double KelvinToFahrenheit (double kelvin)
 Converts from degrees Kelvin to degrees Fahrenheit.
 
static constexpr double CelsiusToRankine (double celsius)
 Converts from degrees Celsius to degrees Rankine.
 
static constexpr double RankineToCelsius (double rankine)
 Converts from degrees Rankine to degrees Celsius.
 
static constexpr double KelvinToRankine (double kelvin)
 Converts from degrees Kelvin to degrees Rankine.
 
static constexpr double RankineToKelvin (double rankine)
 Converts from degrees Rankine to degrees Kelvin.
 
static constexpr double FahrenheitToCelsius (double fahrenheit)
 Converts from degrees Fahrenheit to degrees Celsius.
 
static constexpr double CelsiusToFahrenheit (double celsius)
 Converts from degrees Celsius to degrees Fahrenheit.
 
static constexpr double CelsiusToKelvin (double celsius)
 Converts from degrees Celsius to degrees Kelvin.
 
static constexpr double KelvinToCelsius (double kelvin)
 Converts from degrees Kelvin to degrees Celsius.
 
static constexpr double FeetToMeters (double measure)
 Converts from feet to meters.
 
static double PitotTotalPressure (double mach, double p)
 Compute the total pressure in front of the Pitot tube.
 
static double MachFromImpactPressure (double qc, double p)
 Compute the Mach number from the differential pressure (qc) and the static pressure.
 
static double VcalibratedFromMach (double mach, double p)
 Calculate the calibrated airspeed from the Mach number.
 
static double MachFromVcalibrated (double vcas, double p)
 Calculate the Mach number from the calibrated airspeed.Based on the formulas in the US Air Force Aircraft Performance Flight Testing Manual (AFFTC-TIH-99-01).
 
static bool EqualToRoundoff (double a, double b)
 Finite precision comparison.
 
static bool EqualToRoundoff (float a, float b)
 Finite precision comparison.
 
static bool EqualToRoundoff (float a, double b)
 Finite precision comparison.
 
static bool EqualToRoundoff (double a, float b)
 Finite precision comparison.
 
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)
 
static double GaussianRandomNumber (void)
 
- Static Public Attributes inherited from JSBSim::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
 
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
static Message localMsg
 
static std::queue< MessageMessages
 
static unsigned int messageId = 0
 
static constexpr double radtodeg = 180. / 3.14159265358979323846
 
static constexpr double degtorad = 3.14159265358979323846 / 180.
 
static constexpr double hptoftlbssec = 550.0
 
static constexpr double psftoinhg = 0.014138
 
static constexpr double psftopa = 47.88
 
static constexpr double ktstofps = 1.68781
 
static constexpr double fpstokts = 1.0 / ktstofps
 
static constexpr double inchtoft = 1.0/12.0
 
static constexpr double fttom = 0.3048
 
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.
 
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__
 
static int gaussian_random_number_phase = 0
 

Detailed Description

Base class for all engines.

This base class contains methods and members common to all engines, such as logic to drain fuel from the appropriate tank, etc.

Configuration File Format:

<engine file="{string}">
<feed> {integer} </feed>
... optional more feed tank index numbers ...
<thruster file="{string}">
<location unit="{IN | M}">
<x> {number} </x>
<y> {number} </y>
<z> {number} </z>
</location>
<orient unit="{RAD | DEG}">
<roll> {number} </roll>
<pitch> {number} </pitch>
<yaw> {number} </yaw>
</orient>
</thruster>
</engine>
    NOTES:

  Not all thruster types can be matched with a given engine type.  See the class
  documentation for engine and thruster classes.
Author
Jon S. Berndt

Definition at line 103 of file FGEngine.h.

Member Enumeration Documentation

◆ EngineType

Enumerator
etUnknown 
etRocket 
etPiston 
etTurbine 
etTurboprop 
etElectric 

Definition at line 136 of file FGEngine.h.

Constructor & Destructor Documentation

◆ FGEngine()

JSBSim::FGEngine::FGEngine ( int engine_number,
struct Inputs & input )

Definition at line 55 of file FGEngine.cpp.

◆ ~FGEngine()

JSBSim::FGEngine::~FGEngine ( )
override

Definition at line 69 of file FGEngine.cpp.

Member Function Documentation

◆ CalcFuelNeed()

double JSBSim::FGEngine::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 in JSBSim::FGPiston, JSBSim::FGRocket, JSBSim::FGTurbine, and JSBSim::FGTurboProp.

Definition at line 93 of file FGEngine.cpp.

◆ CalcOxidizerNeed()

virtual double JSBSim::FGEngine::CalcOxidizerNeed ( void )
inlinevirtual

Reimplemented in JSBSim::FGRocket.

Definition at line 181 of file FGEngine.h.

◆ Calculate()

virtual void JSBSim::FGEngine::Calculate ( void )
pure virtual

Calculates the thrust of the engine, and other engine functions.

Implemented in JSBSim::FGElectric, JSBSim::FGPiston, JSBSim::FGRocket, JSBSim::FGTurbine, and JSBSim::FGTurboProp.

◆ Debug()

void JSBSim::FGEngine::Debug ( int from)
protected

Definition at line 263 of file FGEngine.cpp.

◆ GetBodyForces()

const FGColumnVector3 & JSBSim::FGEngine::GetBodyForces ( void )
virtual

Definition at line 121 of file FGEngine.cpp.

◆ GetCranking()

virtual bool JSBSim::FGEngine::GetCranking ( void ) const
inlinevirtual

Definition at line 153 of file FGEngine.h.

◆ GetEngineLabels()

virtual std::string JSBSim::FGEngine::GetEngineLabels ( const std::string & delimiter)
pure virtual

◆ GetEngineValues()

virtual std::string JSBSim::FGEngine::GetEngineValues ( const std::string & delimiter)
pure virtual

◆ getFuelFlow_gph()

virtual double JSBSim::FGEngine::getFuelFlow_gph ( ) const
inlinevirtual

Definition at line 146 of file FGEngine.h.

◆ getFuelFlow_pph()

virtual double JSBSim::FGEngine::getFuelFlow_pph ( ) const
inlinevirtual

Definition at line 147 of file FGEngine.h.

◆ GetFuelFlowRate()

virtual double JSBSim::FGEngine::GetFuelFlowRate ( void ) const
inlinevirtual

Definition at line 148 of file FGEngine.h.

◆ GetFuelFlowRateGPH()

virtual double JSBSim::FGEngine::GetFuelFlowRateGPH ( void ) const
inlinevirtual

Definition at line 149 of file FGEngine.h.

◆ GetFuelUsedLbs()

virtual double JSBSim::FGEngine::GetFuelUsedLbs ( void ) const
inlinevirtual

Definition at line 150 of file FGEngine.h.

◆ GetMoments()

const FGColumnVector3 & JSBSim::FGEngine::GetMoments ( void )
virtual

Definition at line 128 of file FGEngine.cpp.

◆ GetName()

virtual const std::string & JSBSim::FGEngine::GetName ( void ) const
inlinevirtual

Definition at line 139 of file FGEngine.h.

◆ GetNumSourceTanks()

size_t JSBSim::FGEngine::GetNumSourceTanks ( ) const
inline

Definition at line 192 of file FGEngine.h.

◆ GetPowerAvailable()

virtual double JSBSim::FGEngine::GetPowerAvailable ( void )
inlinevirtual

Reimplemented in JSBSim::FGElectric, and JSBSim::FGTurbine.

Definition at line 183 of file FGEngine.h.

◆ GetRunning()

virtual bool JSBSim::FGEngine::GetRunning ( void ) const
inlinevirtual

Definition at line 152 of file FGEngine.h.

◆ GetSourceTank()

unsigned int JSBSim::FGEngine::GetSourceTank ( unsigned int i) const

Definition at line 103 of file FGEngine.cpp.

◆ GetStarter()

virtual bool JSBSim::FGEngine::GetStarter ( void ) const
inlinevirtual

Definition at line 144 of file FGEngine.h.

◆ GetStarved()

virtual bool JSBSim::FGEngine::GetStarved ( void ) const
inlinevirtual

Definition at line 151 of file FGEngine.h.

◆ GetThrottleMax()

virtual double JSBSim::FGEngine::GetThrottleMax ( void ) const
inlinevirtual

Definition at line 143 of file FGEngine.h.

◆ GetThrottleMin()

virtual double JSBSim::FGEngine::GetThrottleMin ( void ) const
inlinevirtual

Definition at line 142 of file FGEngine.h.

◆ GetThrust()

double JSBSim::FGEngine::GetThrust ( void ) const
virtual

Definition at line 114 of file FGEngine.cpp.

◆ GetThruster()

FGThruster * JSBSim::FGEngine::GetThruster ( void ) const
inline

Definition at line 189 of file FGEngine.h.

◆ GetType()

EngineType JSBSim::FGEngine::GetType ( void ) const
inline

Definition at line 138 of file FGEngine.h.

◆ InitRunning()

virtual int JSBSim::FGEngine::InitRunning ( void )
inlinevirtual

Reimplemented in JSBSim::FGTurbine, and JSBSim::FGTurboProp.

Definition at line 165 of file FGEngine.h.

◆ Load()

bool JSBSim::FGEngine::Load ( FGFDMExec * exec,
Element * el )
protected

Definition at line 176 of file FGEngine.cpp.

◆ LoadThruster()

void JSBSim::FGEngine::LoadThruster ( FGFDMExec * exec,
Element * el )

Definition at line 152 of file FGEngine.cpp.

◆ LoadThrusterInputs()

void JSBSim::FGEngine::LoadThrusterInputs ( )

Definition at line 135 of file FGEngine.cpp.

◆ ResetToIC()

void JSBSim::FGEngine::ResetToIC ( void )
virtual

Resets the Engine parameters to the initial conditions.

Reimplemented in JSBSim::FGPiston, and JSBSim::FGTurbine.

Definition at line 77 of file FGEngine.cpp.

◆ SetFuelDensity()

virtual void JSBSim::FGEngine::SetFuelDensity ( double d)
inlinevirtual

Definition at line 161 of file FGEngine.h.

◆ SetFuelFreeze()

virtual void JSBSim::FGEngine::SetFuelFreeze ( bool f)
inlinevirtual

Definition at line 160 of file FGEngine.h.

◆ SetName()

virtual void JSBSim::FGEngine::SetName ( const std::string & name)
inlinevirtual

Definition at line 159 of file FGEngine.h.

◆ SetRunning()

virtual void JSBSim::FGEngine::SetRunning ( bool bb)
inlinevirtual

Definition at line 158 of file FGEngine.h.

◆ SetStarter()

virtual void JSBSim::FGEngine::SetStarter ( bool s)
inlinevirtual

Definition at line 163 of file FGEngine.h.

◆ SetStarved() [1/2]

virtual void JSBSim::FGEngine::SetStarved ( bool tt)
inlinevirtual

Definition at line 155 of file FGEngine.h.

◆ SetStarved() [2/2]

virtual void JSBSim::FGEngine::SetStarved ( void )
inlinevirtual

Definition at line 156 of file FGEngine.h.

Member Data Documentation

◆ Cranking

bool JSBSim::FGEngine::Cranking
protected

Definition at line 215 of file FGEngine.h.

◆ EngineNumber

const int JSBSim::FGEngine::EngineNumber
protected

Definition at line 203 of file FGEngine.h.

◆ FuelDensity

double JSBSim::FGEngine::FuelDensity
protected

Definition at line 221 of file FGEngine.h.

◆ FuelExpended

double JSBSim::FGEngine::FuelExpended
protected

Definition at line 209 of file FGEngine.h.

◆ FuelFlow_gph

double JSBSim::FGEngine::FuelFlow_gph
protected

Definition at line 218 of file FGEngine.h.

◆ FuelFlow_pph

double JSBSim::FGEngine::FuelFlow_pph
protected

Definition at line 219 of file FGEngine.h.

◆ FuelFlowRate

double JSBSim::FGEngine::FuelFlowRate
protected

Definition at line 210 of file FGEngine.h.

◆ FuelFreeze

bool JSBSim::FGEngine::FuelFreeze
protected

Definition at line 216 of file FGEngine.h.

◆ FuelUsedLbs

double JSBSim::FGEngine::FuelUsedLbs
protected

Definition at line 220 of file FGEngine.h.

◆ in

struct Inputs& JSBSim::FGEngine::in

Definition at line 197 of file FGEngine.h.

◆ MaxThrottle

double JSBSim::FGEngine::MaxThrottle
protected

Definition at line 206 of file FGEngine.h.

◆ MinThrottle

double JSBSim::FGEngine::MinThrottle
protected

Definition at line 207 of file FGEngine.h.

◆ Name

std::string JSBSim::FGEngine::Name
protected

Definition at line 202 of file FGEngine.h.

◆ PctPower

double JSBSim::FGEngine::PctPower
protected

Definition at line 211 of file FGEngine.h.

◆ Running

bool JSBSim::FGEngine::Running
protected

Definition at line 214 of file FGEngine.h.

◆ SLFuelFlowMax

double JSBSim::FGEngine::SLFuelFlowMax
protected

Definition at line 205 of file FGEngine.h.

◆ SourceTanks

std::vector<int> JSBSim::FGEngine::SourceTanks
protected

Definition at line 225 of file FGEngine.h.

◆ Starter

bool JSBSim::FGEngine::Starter
protected

Definition at line 212 of file FGEngine.h.

◆ Starved

bool JSBSim::FGEngine::Starved
protected

Definition at line 213 of file FGEngine.h.

◆ Thruster

FGThruster* JSBSim::FGEngine::Thruster
protected

Definition at line 223 of file FGEngine.h.

◆ Type

EngineType JSBSim::FGEngine::Type
protected

Definition at line 204 of file FGEngine.h.


The documentation for this class was generated from the following files: