FGTurbine Class Reference

#include <FGTurbine.h>

Detailed Description

Based on Jon Berndt's FGTurbine module. Here the term "phase" signifies the engine's mode of operation. At any given time the engine is in only one phase. At simulator startup the engine will be placed in the Trim phase in order to provide a simplified thrust value without throttle lag. When trimming is complete the engine will go to the Off phase, unless the value FGEngine::Running has been previously set to true, in which case the engine will go to the Run phase. Once an engine is in the Off phase the full starting procedure (or airstart) must be used to get it running.

STARTING (on ground):
1. Set the control FGEngine::Starter to true. The engine will spin up to a maximum of about 25 N2 (5.2 N1). This simulates the action of a pneumatic starter.
2. After reaching 15 N2 set the control FGEngine::Cutoff to false. If fuel is available the engine will now accelerate to idle. The starter will automatically be set to false after the start cycle.

STARTING (in air):
1. Increase speed to obtain a minimum of 15 N2. If this is not possible, the starter may be used to assist.
2. Place the control FGEngine::Cutoff to false.

Ignition is assumed to be on anytime the Cutoff control is set to false, therefore a seperate ignition system is not modeled.

Configuration File Format:

 <turbine_engine name="{string}">
  <milthrust unit="{LBS | N}"> {number} </milthrust>
  <maxthrust unit="{LBS | N}"> {number} </maxthrust>
  <bypassratio> {number} </bypassratio>
  <bleed> {number} </bleed>
  <tsfc> {number} </tsfc>
  <atsfc> {number} </atsfc>
  <idlen1> {number} </idlen1>
  <idlen2> {number} </idlen2>
  <maxn1> {number} </maxn1>
  <maxn2> {number} </maxn2>
  <augmented> {0 | 1} </augmented>
  <augmethod> {0 | 1 | 2} </augmethod>
  <injected> {0 | 1} </injected>
  <injection-time> {number} </injection-time>
 </turbine_engine>

Definition of the turbine engine configuration file parameters:

  milthrust   - Maximum thrust, static, at sea level.
  maxthrust   - Afterburning thrust, static, at sea level.
  bypassratio - Ratio of bypass air flow to core air flow.
  bleed       - Thrust reduction factor due to losses (0.0 to 1.0).
  tsfc        - Thrust-specific fuel consumption at cruise, lbm/hr/lbf
  atsfc       - Afterburning TSFC, lbm/hr/lbf
  idlen1      - Fan rotor rpm (% of max) at idle
  idlen2      - Core rotor rpm (% of max) at idle
  maxn1       - Fan rotor rpm (% of max) at full throttle 
  maxn2       - Core rotor rpm (% of max) at full throttle
  augmented
              0 = afterburner not installed
              1 = afterburner installed
  augmethod
              0 = afterburner activated by property /engines/engine[n]/augmentation
              1 = afterburner activated by pushing throttle above 99% position
              2 = throttle range is expanded in the FCS, and values above 1.0 are afterburner range
  injected
              0 = Water injection not installed
              1 = Water injection installed
  injection-time - Time, in seconds, of water injection duration

NOTES:

    Bypass ratio is used only to estimate engine acceleration time.  The
    effect of bypass ratio on engine efficiency is already included in
    the TSFC value.  Feel free to set this parameter (even for turbojets) to
    whatever value gives a desired spool-up rate. Default value is 0.

    The bleed factor is multiplied by thrust to give a resulting thrust
    after losses.  This can represent losses due to bleed, or any other cause.
    Default value is 0.  A common value would be 0.04.

    Nozzle position, for variable area exhaust nozzles, is provided for users
    needing to drive a nozzle gauge or animate a virtual nozzle.

    This model can only be used with the "direct" thruster.  See the file:
    /engine/direct.xml

Author:: David P. Culp

Version:: "$Id: FGTurbine.h,v 1.15 2009/03/23 17:34:55 dpculp Exp $"

Definition at line 156 of file FGTurbine.h.


Public Types
enum	phaseType { tpOff, tpRun, tpSpinUp, tpStart, tpStall, tpSeize, tpTrim }
Public Member Functions
double	CalcFuelNeed (void)
	The fuel need is calculated based on power levels and flow rate for that power level.
double	Calculate (void)
	Calculates the thrust of the engine, and other engine functions.
	FGTurbine (FGFDMExec Executive, Element el, int engine_number)
	Constructor.
bool	GetAugmentation (void) const
double	GetBleedDemand (void) const
bool	GetCutoff (void) const
double	GetEGT (void) const
string	GetEngineLabels (string delimeter)
string	GetEngineValues (string delimeter)
double	GetEPR (void) const
bool	GetFire (void) const
int	GetIgnition (void) const
bool	GetInjection (void) const
double	GetInlet (void) const
double	GetN1 (void) const
double	GetN2 (void) const
double	GetNozzle (void) const
double	getOilPressure_psi () const
double	getOilTemp_degF (void)
bool	GetOvertemp (void) const
phaseType	GetPhase (void)
double	GetPowerAvailable (void)
bool	GetReversed (void) const
int	InitRunning (void)
void	ResetToIC (void)
	Resets the Engine parameters to the initial conditions.
double	Seek (double *var, double target, double accel, double decel)
	A lag filter.
void	SetAugmentation (bool augmentation)
void	SetBleedDemand (double bleedDemand)
void	SetCutoff (bool cutoff)
void	SetEPR (double epr)
void	SetIgnition (int ignition)
void	SetInjection (bool injection)
void	SetPhase (phaseType p)
void	SetReverse (bool reversed)
	~FGTurbine ()
	Destructor.

Constructor & Destructor Documentation

FGTurbine	(	FGFDMExec *	Executive,
		Element *	el,
		int	engine_number
	)

Parameters:

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

Definition at line 57 of file FGTurbine.cpp.

Member Function Documentation

double CalcFuelNeed ( void ) [virtual]

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 365 of file FGTurbine.cpp.

double Calculate ( void ) [virtual]

Returns:: Thrust in pounds

Reimplemented from FGEngine.

Definition at line 109 of file FGTurbine.cpp.

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

Used to control the rate at which values are allowed to change.

Parameters:

	var	a pointer to a variable of type double
	target	the desired (target) value
	accel	the rate, per second, the value may increase
	decel	the rate, per second, the value may decrease

Definition at line 384 of file FGTurbine.cpp.

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