FlightGear: JSBSim::FGTurboProp Class Reference

Turboprop engine model. More...

#include <FGTurboProp.h>

Public Types
enum	phaseType { tpOff , tpRun , tpSpinUp , tpStart , tpTrim }

Public Types inherited from JSBSim::FGEngine
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
	FGTurboProp (FGFDMExec Executive, Element el, int engine_number, struct Inputs &input)
	Constructor.

	~FGTurboProp ()
	Destructor.

void	Calculate (void)
	Calculates the thrust of the engine, and other engine functions.

double	CalcFuelNeed (void)
	The fuel need is calculated based on power levels and flow rate for that power level.

double	GetPowerAvailable (void) const

double	GetRPM (void) const

double	GetIeluThrottle (void) const

bool	GetIeluIntervent (void) const

double	Seek (double *var, double target, double accel, double decel)

double	ExpSeek (double *var, double target, double accel, double decel)

phaseType	GetPhase (void) const

bool	GetReversed (void) const

bool	GetCutoff (void) const

double	GetN1 (void) const

double	GetITT (void) const

double	GetEngStarting (void) const

double	getOilPressure_psi () const

double	getOilTemp_degF (void)

bool	GetGeneratorPower (void) const

int	GetCondition (void) const

void	SetPhase (phaseType p)

void	SetReverse (bool reversed)

void	SetCutoff (bool cutoff)

void	SetGeneratorPower (bool gp)

void	SetCondition (bool c)

int	InitRunning (void)

std::string	GetEngineLabels (const std::string &delimiter)

std::string	GetEngineValues (const std::string &delimiter)

Public Member Functions inherited from JSBSim::FGEngine
	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 void	ResetToIC (void)
	Resets the Engine parameters to the initial conditions.

virtual double	GetThrust (void) const

virtual double	CalcOxidizerNeed (void)

virtual double	GetPowerAvailable (void)

virtual const FGColumnVector3 &	GetBodyForces (void)

virtual const FGColumnVector3 &	GetMoments (void)

void	LoadThruster (FGFDMExec exec, Element el)

FGThruster *	GetThruster (void) const

unsigned int	GetSourceTank (unsigned int i) const

size_t	GetNumSourceTanks () const

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.

FGFunction *	GetPreFunction (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.

Message *	ProcessNextMessage (void)
	Reads the next message on the queue and removes it from the queue.

void	disableHighLighting (void)
	Disables highlighting in the console output.

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)

Public Attributes inherited from JSBSim::FGEngine
struct Inputs &	in

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

Protected Member Functions inherited from JSBSim::FGEngine
bool	Load (FGFDMExec exec, Element el)

void	Debug (int from)

Protected Member Functions inherited from JSBSim::FGModelFunctions
virtual bool	InitModel (void)

static std::string	CreateIndexedPropertyName (const std::string &Property, int index)

Protected Attributes inherited from JSBSim::FGEngine
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

FGThruster *	Thruster

std::vector< int >	SourceTanks

Protected Attributes inherited from JSBSim::FGModelFunctions
std::vector< FGFunction * >	PreFunctions

std::vector< FGFunction * >	PostFunctions

FGPropertyReader	LocalProperties

static Message	localMsg

static std::queue< Message >	Messages

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/(fttomfttomfttom)

static constexpr double	in3tom3 = inchtoftinchtoftinchtoft/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

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.

Member Enumeration Documentation

◆ phaseType

enum JSBSim::FGTurboProp::phaseType

Enumerator
tpOff
tpRun
tpSpinUp
tpStart
tpTrim

Definition at line 103 of file FGTurboProp.h.

Constructor & Destructor Documentation

◆ FGTurboProp()

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

Constructor.

Parameters

Executive	pointer to executive structure
el	pointer to the XML element representing the turbine engine
engine_number	engine number

Definition at line 62 of file FGTurboProp.cpp.

◆ ~FGTurboProp()

JSBSim::FGTurboProp::~FGTurboProp ( )

Destructor.

Definition at line 74 of file FGTurboProp.cpp.

Member Function Documentation

◆ CalcFuelNeed()

double JSBSim::FGTurboProp::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 JSBSim::FGEngine.

Definition at line 439 of file FGTurboProp.cpp.

◆ Calculate()

void JSBSim::FGTurboProp::Calculate ( void )

virtual

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

Implements JSBSim::FGEngine.

Definition at line 196 of file FGTurboProp.cpp.

◆ ExpSeek()

double JSBSim::FGTurboProp::ExpSeek	(	double *	var,
		double	target,
		double	accel,
		double	decel )

Definition at line 464 of file FGTurboProp.cpp.

◆ GetCondition()

int JSBSim::FGTurboProp::GetCondition ( void ) const

inline

Definition at line 129 of file FGTurboProp.h.

◆ GetCutoff()

bool JSBSim::FGTurboProp::GetCutoff ( void ) const

inline

Definition at line 119 of file FGTurboProp.h.

◆ GetEngineLabels()

string JSBSim::FGTurboProp::GetEngineLabels ( const std::string & delimiter )

virtual

Implements JSBSim::FGEngine.

Definition at line 507 of file FGTurboProp.cpp.

◆ GetEngineValues()

string JSBSim::FGTurboProp::GetEngineValues ( const std::string & delimiter )

virtual

Implements JSBSim::FGEngine.

Definition at line 520 of file FGTurboProp.cpp.

◆ GetEngStarting()

double JSBSim::FGTurboProp::GetEngStarting ( void ) const

inline

Definition at line 123 of file FGTurboProp.h.

◆ GetGeneratorPower()

bool JSBSim::FGTurboProp::GetGeneratorPower ( void ) const

inline

Definition at line 128 of file FGTurboProp.h.

◆ GetIeluIntervent()

bool JSBSim::FGTurboProp::GetIeluIntervent ( void ) const

inline

Definition at line 111 of file FGTurboProp.h.

◆ GetIeluThrottle()

double JSBSim::FGTurboProp::GetIeluThrottle ( void ) const

inline

Definition at line 110 of file FGTurboProp.h.

◆ GetITT()

double JSBSim::FGTurboProp::GetITT ( void ) const

inline

Definition at line 122 of file FGTurboProp.h.

◆ GetN1()

double JSBSim::FGTurboProp::GetN1 ( void ) const

inline

Definition at line 121 of file FGTurboProp.h.

◆ getOilPressure_psi()

double JSBSim::FGTurboProp::getOilPressure_psi ( ) const

inline

Definition at line 125 of file FGTurboProp.h.

◆ getOilTemp_degF()

double JSBSim::FGTurboProp::getOilTemp_degF ( void )

inline

Definition at line 126 of file FGTurboProp.h.

◆ GetPhase()

phaseType JSBSim::FGTurboProp::GetPhase ( void ) const

inline

Definition at line 116 of file FGTurboProp.h.

◆ GetPowerAvailable()

double JSBSim::FGTurboProp::GetPowerAvailable ( void ) const

inline

Definition at line 108 of file FGTurboProp.h.

◆ GetReversed()

bool JSBSim::FGTurboProp::GetReversed ( void ) const

inline

Definition at line 118 of file FGTurboProp.h.

◆ GetRPM()

double JSBSim::FGTurboProp::GetRPM ( void ) const

inline

Definition at line 109 of file FGTurboProp.h.

◆ InitRunning()

int JSBSim::FGTurboProp::InitRunning ( void )

virtual

Reimplemented from JSBSim::FGEngine.

Definition at line 533 of file FGTurboProp.cpp.

◆ Seek()

double JSBSim::FGTurboProp::Seek	(	double *	var,
		double	target,
		double	accel,
		double	decel )

Definition at line 449 of file FGTurboProp.cpp.

◆ SetCondition()

void JSBSim::FGTurboProp::SetCondition ( bool c )

inline

Definition at line 136 of file FGTurboProp.h.

◆ SetCutoff()

void JSBSim::FGTurboProp::SetCutoff ( bool cutoff )

inline

Definition at line 133 of file FGTurboProp.h.

◆ SetGeneratorPower()

void JSBSim::FGTurboProp::SetGeneratorPower ( bool gp )

inline

Definition at line 135 of file FGTurboProp.h.

◆ SetPhase()

void JSBSim::FGTurboProp::SetPhase ( phaseType p )

inline

Definition at line 131 of file FGTurboProp.h.

◆ SetReverse()

void JSBSim::FGTurboProp::SetReverse ( bool reversed )

inline

Definition at line 132 of file FGTurboProp.h.

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Configuration parameters:

Member Enumeration Documentation

◆ phaseType

Constructor & Destructor Documentation

◆ FGTurboProp()

◆ ~FGTurboProp()

Member Function Documentation

◆ CalcFuelNeed()

◆ Calculate()

◆ ExpSeek()

◆ GetCondition()

◆ GetCutoff()

◆ GetEngineLabels()

◆ GetEngineValues()

◆ GetEngStarting()

◆ GetGeneratorPower()

◆ GetIeluIntervent()

◆ GetIeluThrottle()

◆ GetITT()

◆ GetN1()

◆ getOilPressure_psi()

◆ getOilTemp_degF()

◆ GetPhase()

◆ GetPowerAvailable()

◆ GetReversed()

◆ GetRPM()

◆ InitRunning()

◆ Seek()

◆ SetCondition()

◆ SetCutoff()

◆ SetGeneratorPower()

◆ SetPhase()

◆ SetReverse()