FGPropulsion Class Reference

Propulsion management class. More...

#include <FGPropulsion.h>

Inheritance diagram for FGPropulsion:

Collaboration diagram for FGPropulsion:

Public Member Functions
	FGPropulsion (FGFDMExec *)
	Constructor.
	~FGPropulsion ()
	Destructor.
const FGMatrix33 &	CalculateTankInertias (void)
void	DoRefuel (double time_slice)
void	DumpFuel (double time_slice)
SGPath	FindFullPathName (const SGPath &path) const
int	GetActiveEngine (void) const
FGEngine *	GetEngine (unsigned int index) const
	Retrieves an engine object pointer from the list of engines. More...
const FGColumnVector3 &	GetForces (void) const
double	GetForces (int n) const
bool	GetFuelFreeze (void) const
const FGColumnVector3 &	GetMoments (void) const
double	GetMoments (int n) const
unsigned int	GetNumEngines (void) const
	Retrieves the number of engines defined for the aircraft.
int	GetnumSelectedFuelTanks (void) const
	Returns the number of fuel tanks currently actively supplying fuel.
int	GetnumSelectedOxiTanks (void) const
	Returns the number of oxidizer tanks currently actively supplying oxidizer.
unsigned int	GetNumTanks (void) const
	Retrieves the number of tanks defined for the aircraft.
std::string	GetPropulsionStrings (const std::string &delimiter) const
std::string	GetPropulsionTankReport ()
std::string	GetPropulsionValues (const std::string &delimiter) const
bool	GetSteadyState (void)
	Loops the engines until thrust output steady (used for trimming)
FGTank *	GetTank (unsigned int index) const
	Retrieves a tank object pointer from the list of tanks. More...
const FGColumnVector3 &	GetTanksMoment (void)
double	GetTanksWeight (void) const
bool	InitModel (void)
void	InitRunning (int n)
	Sets up the engines as running.
bool	Load (Element *el)
	Loads the propulsion system (engine[s] and tank[s]). More...
bool	Run (bool Holding)
	Executes the propulsion model. More...
void	SetActiveEngine (int engine)
void	SetCutoff (int setting=0)
void	SetFuelFreeze (bool f)
void	SetMagnetos (int setting)
void	SetStarter (int setting)
double	Transfer (int source, int target, double amount)
Public Member Functions inherited from FGModel
	FGModel (FGFDMExec *)
	Constructor.
virtual	~FGModel ()
	Destructor.
FGFDMExec *	GetExec (void)
unsigned int	GetRate (void)
	Get the output rate for the model in frames.
void	SetPropertyManager (FGPropertyManager *fgpm)
void	SetRate (unsigned int tt)
	Set the ouput rate for the model in frames.
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 FGEngine::Inputs	in
Public Attributes inherited from FGModel
std::string	Name

Additional Inherited Members
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.
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
Protected Member Functions inherited from FGJSBBase
void	Debug (int)
Static Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)
Protected Attributes inherited from FGModel
unsigned int	exe_ctr
FGFDMExec *	FDMExec
FGPropertyManager *	PropertyManager
unsigned int	rate
Protected Attributes inherited from FGModelFunctions
FGPropertyReader	LocalProperties
std::vector< FGFunction * >	PostFunctions
std::vector< FGFunction * >	PreFunctions
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

Propulsion management class.

The Propulsion class is the container for the entire propulsion system, which is comprised of engines, and tanks. Once the Propulsion class gets the config file, it reads in the <propulsion> section. Then:

1. The appropriate engine type instance is created
2. At least one tank object is created, and is linked to an engine.

At Run time each engine's Calculate() method is called.

Configuration File Format:

<propulsion>
    <engine file="{string}">
      ... see FGEngine, FGThruster, and class for engine type ...
    </engine>
    ... more engines ...
    <tank type="{FUEL | OXIDIZER}"> 
      ... see FGTank ...
    </tank>
    ... more tanks ...
    <dump-rate unit="{LBS/MIN | KG/MIN}"> {number} </dump-rate>
    <refuel-rate unit="{LBS/MIN | KG/MIN}"> {number} </refuel-rate>
</propulsion>

Author

Jon S. Berndt

Version

Id

FGPropulsion.h,v 1.37 2017/02/25 14:23:19 bcoconni Exp

See also

FGEngine FGTank

Definition at line 106 of file FGPropulsion.h.

Member Function Documentation

GetEngine()

FGEngine* GetEngine ( unsigned int  index ) const

inline

Retrieves an engine object pointer from the list of engines.

Parameters

index

the engine index within the vector container

Returns

the address of the specific engine, or zero if no such engine is available

Definition at line 140 of file FGPropulsion.h.

                                                {
                      if (index < Engines.size()) return Engines[index];
                      else                        return 0L;      }

Here is the caller graph for this function:

GetTank()

FGTank* GetTank ( unsigned int  index ) const

inline

Retrieves a tank object pointer from the list of tanks.

Parameters

index

the tank index within the vector container

Returns

the address of the specific tank, or zero if no such tank is available

Definition at line 151 of file FGPropulsion.h.

                                            {
                      if (index < Tanks.size()) return Tanks[index];
                      else                      return 0L;        }

Here is the caller graph for this function:

Load()

bool Load ( Element *  el )

virtual

Loads the propulsion system (engine[s] and tank[s]).

Characteristics of the propulsion system are read in from the config file.

Parameters

el	pointer to an XML element that contains the engine information.

Returns

true if successfully loaded, otherwise false

Reimplemented from FGModel.

Definition at line 365 of file FGPropulsion.cpp.

{
  FGModelLoader ModelLoader(this);

  Debug(2);
  ReadingEngine = false;
  double FuelDensity = 6.0;

  Name = "Propulsion Model: " + el->GetAttributeValue("name");

  // Perform base class Pre-Load
  if (!FGModel::Load(el))
    return false;

  // Process tank definitions first to establish the number of fuel tanks

  Element* tank_element = el->FindElement("tank");
  while (tank_element) {
    Tanks.push_back(new FGTank(FDMExec, tank_element, numTanks));
    if (Tanks.back()->GetType() == FGTank::ttFUEL) { 
      FuelDensity = Tanks[numFuelTanks]->GetDensity();
      numFuelTanks++;
      }
    else if (Tanks.back()->GetType() == FGTank::ttOXIDIZER) numOxiTanks++;
    else {cerr << "Unknown tank type specified." << endl; return false;}
    numTanks++;
    tank_element = el->FindNextElement("tank");
  }
  numSelectedFuelTanks = numFuelTanks;
  numSelectedOxiTanks  = numOxiTanks;

  ReadingEngine = true;
  Element* engine_element = el->FindElement("engine");
  while (engine_element) {
    if (!ModelLoader.Open(engine_element)) return false;

    try {
      // Locate the thruster definition
      Element* thruster_element = engine_element->FindElement("thruster");
      if (!thruster_element || !ModelLoader.Open(thruster_element))
        throw("No thruster definition supplied with engine definition.");

      if (engine_element->FindElement("piston_engine")) {
        HavePistonEngine = true;
        if (!IsBound) bind();
        Element *element = engine_element->FindElement("piston_engine");
        Engines.push_back(new FGPiston(FDMExec, element, numEngines, in));
      } else if (engine_element->FindElement("turbine_engine")) {
        HaveTurbineEngine = true;
        if (!IsBound) bind();
        Element *element = engine_element->FindElement("turbine_engine");
        Engines.push_back(new FGTurbine(FDMExec, element, numEngines, in));
      } else if (engine_element->FindElement("turboprop_engine")) {
        HaveTurboPropEngine = true;
        if (!IsBound) bind();
        Element *element = engine_element->FindElement("turboprop_engine");
        Engines.push_back(new FGTurboProp(FDMExec, element, numEngines, in));
      } else if (engine_element->FindElement("rocket_engine")) {
        HaveRocketEngine = true;
        if (!IsBound) bind();
        Element *element = engine_element->FindElement("rocket_engine");
        Engines.push_back(new FGRocket(FDMExec, element, numEngines, in));
      } else if (engine_element->FindElement("electric_engine")) {
        HaveElectricEngine = true;
        if (!IsBound) bind();
        Element *element = engine_element->FindElement("electric_engine");
        Engines.push_back(new FGElectric(FDMExec, element, numEngines, in));
      } else {
        cerr << engine_element->ReadFrom() << " Unknown engine type" << endl;
        return false;
      }
    } catch (std::string& str) {
      cerr << endl << fgred << str << reset << endl;
      return false;
    }

    numEngines++;

    engine_element = el->FindNextElement("engine");
  }

  CalculateTankInertias();

  if (el->FindElement("dump-rate"))
    DumpRate = el->FindElementValueAsNumberConvertTo("dump-rate", "LBS/MIN");
  if (el->FindElement("refuel-rate"))
    RefuelRate = el->FindElementValueAsNumberConvertTo("refuel-rate", "LBS/MIN");

  unsigned int i;
  for (i=0; i<Engines.size(); i++) {
    Engines[i]->SetFuelDensity(FuelDensity);
  }


  PostLoad(el, PropertyManager);

  return true;
}

Here is the call graph for this function:

Run()

bool Run ( bool  Holding )

virtual

Executes the propulsion model.

The initial plan for the FGPropulsion class calls for Run() to be executed, calculating the power available from the engine. Can pass in a value indicating if the executive is directing the simulation to Hold.

Parameters

Holding

if true, the executive has been directed to hold the sim from advancing time. Some models may ignore this flag, such as the Input model, which may need to be active to listen on a socket for the "Resume" command to be given.

Returns

false if no error

Reimplemented from FGModel.

Definition at line 135 of file FGPropulsion.cpp.

{
  unsigned int i;

  if (FGModel::Run(Holding)) return true;
  if (Holding) return false;

  RunPreFunctions();

  vForces.InitMatrix();
  vMoments.InitMatrix();

  for (i=0; i<numEngines; i++) {
    Engines[i]->Calculate();
    ConsumeFuel(Engines[i]);
    vForces  += Engines[i]->GetBodyForces();  // sum body frame forces
    vMoments += Engines[i]->GetMoments();     // sum body frame moments
  }

  TotalFuelQuantity = 0.0;
  TotalOxidizerQuantity = 0.0;
  for (i=0; i<numTanks; i++) {
    Tanks[i]->Calculate( in.TotalDeltaT, in.TAT_c);
    switch (Tanks[i]->GetType()) {
    case FGTank::ttFUEL:
      TotalFuelQuantity += Tanks[i]->GetContents();
      break;
    case FGTank::ttOXIDIZER:
      TotalOxidizerQuantity += Tanks[i]->GetContents();
      break;
    default:
      break;
    }
  }

  if (refuel.node() && refuel) DoRefuel( in.TotalDeltaT );
  if (dump.node() && dump) DumpFuel( in.TotalDeltaT );

  RunPostFunctions();

  return false;
}

Here is the call graph for this function:

---

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

• FGPropulsion.h
• FGPropulsion.cpp