FGPropulsion Class Reference

#include <FGPropulsion.h>

Inherits FGModel, and FGXMLFileRead.

List of all members.


Detailed Description

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>
    </propulsion>

Author:
Jon S. Berndt
Version:
Id
FGPropulsion.h,v 1.19 2008/07/22 02:42:18 jberndt Exp
See also:
FGEngine FGTank

Definition at line 103 of file FGPropulsion.h.


Public Member Functions

FGMatrix33CalculateTankInertias (void)
void DoRefuel (double time_slice)
void DumpFuel (double time_slice)
 FGPropulsion (FGFDMExec *)
 Constructor.
ifstream * FindEngineFile (string filename)
string FindEngineFullPathname (string engine_filename)
int GetActiveEngine (void) const
FGEngineGetEngine (unsigned int index)
 Retrieves an engine object pointer from the list of engines.
double GetForces (int n) const
FGColumnVector3GetForces (void)
bool GetFuelDump (void) const
bool GetFuelFreeze (void)
double GetMoments (int n) const
FGColumnVector3GetMoments (void)
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.
string GetPropulsionStrings (string delimeter)
string GetPropulsionValues (string delimeter)
bool GetRefuel (void) const
bool GetSteadyState (void)
 Loops the engines until thrust output steady (used for trimming).
FGTankGetTank (unsigned int index)
 Retrieves a tank object pointer from the list of tanks.
FGColumnVector3GetTanksMoment (void)
double GetTanksWeight (void)
double GetTotalFuelQuantity (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]).
bool Run (void)
 Executes the propulsion model.
void SetActiveEngine (int engine)
void SetCutoff (int setting=0)
void SetFuelDump (bool setting)
void SetFuelFreeze (bool f)
void SetMagnetos (int setting)
void SetRefuel (bool setting)
void SetStarter (int setting)
double Transfer (int source, int target, double amount)
 ~FGPropulsion ()
 Destructor.

Member Function Documentation

FGEngine* GetEngine ( unsigned int  index  )  [inline]

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 133 of file FGPropulsion.h.

FGTank* GetTank ( unsigned int  index  )  [inline]

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 144 of file FGPropulsion.h.

bool Load ( Element el  )  [virtual]

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 249 of file FGPropulsion.cpp.

bool Run ( void   )  [virtual]

The initial plan for the FGPropulsion class calls for Run() to be executed, calculating the power available from the engine.

[Note: Should we be checking the Starved flag here?]

Reimplemented from FGModel.

Definition at line 134 of file FGPropulsion.cpp.


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

Generated on Tue May 26 00:55:12 2009 for JSBSim Flight Dynamics Model by  doxygen 1.5.5