FGEngine Class Reference

Base class for all engines. More...

#include <FGEngine.h>

Inheritance diagram for FGEngine:

Collaboration diagram for FGEngine:

Classes
struct	Inputs

Public Types
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
	FGEngine (int engine_number, struct Inputs &input)
virtual double	CalcFuelNeed (void)
	The fuel need is calculated based on power levels and flow rate for that power level. More...
virtual double	CalcOxidizerNeed (void)
virtual void	Calculate (void)=0
	Calculates the thrust of the engine, and other engine functions. More...
virtual const FGColumnVector3 &	GetBodyForces (void)
virtual bool	GetCranking (void) const
virtual std::string	GetEngineLabels (const std::string &delimiter)=0
virtual std::string	GetEngineValues (const std::string &delimiter)=0
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
virtual int	InitRunning (void)
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	SetPlacement (const FGColumnVector3 &location, const FGColumnVector3 &orientation)
	Sets engine placement information.
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...
FGFunction *	GetPreFunction (const std::string &name)
	Get one of the "pre" function. More...
bool	Load (Element *el, FGPropertyManager *PropertyManager, std::string prefix="")
void	PostLoad (Element *el, FGPropertyManager *PropertyManager, std::string prefix="")
void	PreLoad (Element *el, FGPropertyManager *PropertyManager, 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.
std::string	GetVersion (void)
	Returns the version number of JSBSim. More...
void	PutMessage (const Message &msg)
	Places a Message structure on the Message queue. More...
void	PutMessage (const std::string &text)
	Creates a message with the given text and places it on the queue. More...
void	PutMessage (const std::string &text, bool bVal)
	Creates a message with the given text and boolean value and places it on the queue. More...
void	PutMessage (const std::string &text, int iVal)
	Creates a message with the given text and integer value and places it on the queue. More...
void	PutMessage (const std::string &text, double dVal)
	Creates a message with the given text and double value and places it on the queue. More...
int	SomeMessages (void)
	Reads the message on the queue (but does not delete it). More...
void	ProcessMessage (void)
	Reads the message on the queue and removes it from the queue. More...
Message *	ProcessNextMessage (void)
	Reads the next message on the queue and removes it from the queue. More...

Public Attributes
struct Inputs &	in

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

Protected Attributes
bool	Cranking
const int	EngineNumber
double	EnginePitch
double	EngineYaw
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
double	X
double	Y
double	Z
Protected Attributes inherited from FGModelFunctions
FGPropertyReader	LocalProperties
std::vector< FGFunction * >	PostFunctions
std::vector< FGFunction * >	PreFunctions

Additional Inherited Members
Static Public Member Functions inherited from FGJSBBase
static double	CelsiusToFahrenheit (double celsius)
	Converts from degrees Celsius to degrees Fahrenheit. More...
static double	CelsiusToKelvin (double celsius)
	Converts from degrees Celsius to degrees Kelvin. More...
static double	CelsiusToRankine (double celsius)
	Converts from degrees Celsius to degrees Rankine. More...
static double	Constrain (double min, double value, double max)
	Constrain a value between a minimum and a maximum value.
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 double	FahrenheitToCelsius (double fahrenheit)
	Converts from degrees Fahrenheit to degrees Celsius. More...
static double	FeetToMeters (double measure)
	Converts from feet to meters. More...
static double	GaussianRandomNumber (void)
static double	KelvinToCelsius (double kelvin)
	Converts from degrees Kelvin to degrees Celsius. More...
static double	KelvinToFahrenheit (double kelvin)
	Converts from degrees Kelvin to degrees Fahrenheit. More...
static double	KelvinToRankine (double kelvin)
	Converts from degrees Kelvin to degrees Rankine. More...
static double	MachFromVcalibrated (double vcas, double p, double psl, double rhosl)
	Calculate the Mach number from the calibrated airspeed. More...
static double	PitotTotalPressure (double mach, double p)
	Compute the total pressure in front of the Pitot tube. More...
static double	RankineToCelsius (double rankine)
	Converts from degrees Rankine to degrees Celsius. More...
static double	RankineToKelvin (double rankine)
	Converts from degrees Rankine to degrees Kelvin. More...
static double	sign (double num)
static double	VcalibratedFromMach (double mach, double p, double psl, double rhosl)
	Calculate the calibrated airspeed from the Mach number. More...
Static Public Attributes inherited from FGJSBBase
static short	debug_lvl = 1
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 Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)
Static Protected Attributes inherited from FGJSBBase
static const double	degtorad = 0.017453292519943295769236907684886
static const double	fpstokts = 1.0/ktstofps
static const double	fttom = 0.3048
static int	gaussian_random_number_phase = 0
static const double	hptoftlbssec = 550.0
static const double	in3tom3 = 1.638706E-5
static const double	inchtoft = 0.08333333
static const double	inhgtopa = 3386.38
static const std::string	JSBSim_version = "1.0 " __DATE__ " " __TIME__
static const double	kgtolb = 2.20462
static const double	kgtoslug = 0.06852168
static const double	ktstofps = 1.68781
static const double	lbtoslug = 1.0/slugtolb
static Message	localMsg
static const double	m3toft3 = 1.0/(fttom*fttom*fttom)
static double	Mair = 28.9645
static unsigned int	messageId = 0
static std::queue< Message >	Messages
static const std::string	needed_cfg_version = "2.0"
static const double	psftoinhg = 0.014138
static const double	psftopa = 47.88
static const double	radtodeg = 57.295779513082320876798154814105
static double	Reng = 1716.56
static double	Rstar = 1545.348
static const double	SHRatio = 1.40
static const double	slugtolb = 32.174049

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}">
    <location unit="{IN | M}">
        <x> {number} </x>
        <y> {number} </y>
        <z> {number} </z>
    </location>
    <!-- optional orientation definition -->
    <orient unit="{RAD | DEG}">
        <roll>  {number} </roll>
        <pitch> {number} </pitch>
        <yaw> {number} </yaw>
    </orient>
    <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

Version

Id

FGEngine.h,v 1.47 2015/09/27 10:16:57 bcoconni Exp

Definition at line 121 of file FGEngine.h.

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

Definition at line 103 of file FGEngine.cpp.

{
  FuelFlowRate = SLFuelFlowMax*PctPower;
  FuelExpended = FuelFlowRate*in.TotalDeltaT;
  if (!Starved) FuelUsedLbs += FuelExpended;
  return FuelExpended;
}

Here is the caller graph for this function:

Calculate()

virtual void Calculate ( void  )

pure virtual

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

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

---

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

• FGEngine.h
• FGEngine.cpp