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:

The appropriate engine type instance is created
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

See also: FGEngine FGTank

Definition at line 98 of file FGPropulsion.h.

#include <FGPropulsion.h>

Inheritance diagram for FGPropulsion:

Collaboration diagram for FGPropulsion:

Public Member Functions
	FGPropulsion (FGFDMExec *)
	Constructor.

	~FGPropulsion () override
	Destructor.

const FGMatrix33 &	CalculateTankInertias (void)

void	DoRefuel (double time_slice)

void	DumpFuel (double time_slice)

SGPath	FindFullPathName (const SGPath &path) const override

int	GetActiveEngine (void) const

int	GetCutoff (void) const

auto	GetEngine (unsigned int index) const
	Retrieves an engine object pointer from the list of engines.

double	GetForces (int n) const

const FGColumnVector3 &	GetForces (void) const

bool	GetFuelFreeze (void) const

double	GetMoments (int n) const

const FGColumnVector3 &	GetMoments (void) const

size_t	GetNumEngines (void) const
	Retrieves the number of engines defined for the aircraft.

size_t	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

int	GetStarter (void) const

bool	GetSteadyState (void)
	Loops the engines until thrust output steady (used for trimming)

auto	GetTank (unsigned int index) const
	Retrieves a tank object pointer from the list of tanks.

const FGColumnVector3 &	GetTanksMoment (void)

double	GetTanksWeight (void) const

bool	InitModel (void) override

void	InitRunning (int n)
	Sets up the engines as running.

bool	Load (Element *el) override
	Loads the propulsion system (engine[s] and tank[s]).

bool	Run (bool Holding) override
	Executes the propulsion model.

void	SetActiveEngine (int engine)

void	SetCutoff (int setting=0)

void	SetEngineRunning (int index)

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.

	~FGModel () override
	Destructor.

FGFDMExec *	GetExec (void) const

const std::string &	GetName (void) const

unsigned int	GetRate (void) const
	Get the output rate for the model in frames.

void	SetPropertyManager (std::shared_ptr< 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.

std::string	GetFunctionValues (const std::string &delimeter) const
	Gets the function values.

std::shared_ptr< FGFunction >	GetPreFunction (const std::string &name)
	Get one of the "pre" function.

bool	Load (Element el, FGFDMExec fdmex, std::string prefix="")

void	PostLoad (Element el, FGFDMExec fdmex, std::string prefix="")

void	PreLoad (Element el, FGFDMExec fdmex, 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.

Public Attributes
struct FGEngine::Inputs	in

Additional Inherited Members
Public Types inherited from 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...

Static Public Member Functions inherited from FGJSBBase
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 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 Public Attributes inherited from 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 FGModel
bool	Upload (Element *el, bool preLoad)
	Uploads this model in memory.

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

std::string	Name

std::shared_ptr< FGPropertyManager >	PropertyManager

unsigned int	rate

Protected Attributes inherited from FGModelFunctions
FGPropertyReader	LocalProperties

std::vector< std::shared_ptr< FGFunction > >	PostFunctions

std::vector< std::shared_ptr< FGFunction > >	PreFunctions

Static Protected Attributes inherited from FGJSBBase
static constexpr double	radtodeg = 180. / M_PI

static constexpr double	degtorad = M_PI / 180.

static constexpr double	hptoftlbssec = 550.0

static constexpr double	psftoinhg = 0.014138

static constexpr double	psftopa = 47.88

static constexpr double	fttom = 0.3048

static constexpr double	ktstofps = 1852./(3600*fttom)

static constexpr double	fpstokts = 1.0 / ktstofps

static constexpr double	inchtoft = 1.0/12.0

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__

Constructor & Destructor Documentation

◆ FGPropulsion()

FGPropulsion ( FGFDMExec * exec )

Constructor.

Definition at line 75 of file FGPropulsion.cpp.

                                          : FGModel(exec)
{
  Name = "FGPropulsion";
 
  ActiveEngine = -1; // -1: ALL, 0: Engine 1, 1: Engine 2 ...
  tankJ.InitMatrix();
  DumpRate = 0.0;
  RefuelRate = 6000.0;
  FuelFreeze = false;
 
  Debug(0);
}

Here is the call graph for this function:

◆ ~FGPropulsion()

~FGPropulsion ( )

override

Destructor.

Definition at line 90 of file FGPropulsion.cpp.

{
  Debug(1);
}

Member Function Documentation

◆ CalculateTankInertias()

const FGMatrix33 & CalculateTankInertias ( void )

Definition at line 601 of file FGPropulsion.cpp.

{
  if (Tanks.empty()) return tankJ;
 
  tankJ.InitMatrix();
 
  for (const auto& tank: Tanks) {
    tankJ += FDMExec->GetMassBalance()->GetPointmassInertia( lbtoslug * tank->GetContents(),
                                                             tank->GetXYZ());
    tankJ(1,1) += tank->GetIxx();
    tankJ(2,2) += tank->GetIyy();
    tankJ(3,3) += tank->GetIzz();
  }
 
  return tankJ;
}

◆ DoRefuel()

void DoRefuel ( double time_slice )

Definition at line 772 of file FGPropulsion.cpp.

{
  double fillrate = RefuelRate / 60.0 * time_slice;
  int TanksNotFull = 0;
 
  for (const auto& tank: Tanks) {
    if (tank->GetPctFull() < 99.99) ++TanksNotFull;
  }
 
  // adds fuel equally to all tanks that are not full
  if (TanksNotFull) {
    for (unsigned int i=0; i<Tanks.size(); i++) {
      if (Tanks[i]->GetPctFull() < 99.99)
          Transfer(-1, i, fillrate/TanksNotFull);
    }
  }
}

◆ DumpFuel()

void DumpFuel ( double time_slice )

Definition at line 792 of file FGPropulsion.cpp.

{
  int TanksDumping = 0;
 
  for (const auto& tank: Tanks) {
    if (tank->GetContents() > tank->GetStandpipe()) ++TanksDumping;
  }
 
  if (TanksDumping == 0) return;
 
  double dump_rate_per_tank = DumpRate / 60.0 * time_slice / TanksDumping;
 
  for (unsigned int i=0; i<Tanks.size(); i++) {
    if (Tanks[i]->GetContents() > Tanks[i]->GetStandpipe()) {
      Transfer(i, -1, dump_rate_per_tank);
    }
  }
}

◆ FindFullPathName()

SGPath FindFullPathName ( const SGPath & path ) const

overridevirtual

Reimplemented from FGModel.

Definition at line 468 of file FGPropulsion.cpp.

{
  SGPath name = FGModel::FindFullPathName(path);
  if (!ReadingEngine && !name.isNull()) return name;
 
#ifdef _WIN32
  // Singular and plural are allowed for the folder names for consistency with
  // the default engine folder name "engine" and for backward compatibility
  // regarding the folder name "Engines".
  const array<string, 2> dir_names = {"Engines", "engine"};
#else
  // Allow alternative capitalization for case sensitive OSes.
  const array<string, 4> dir_names = {"Engines", "engines", "Engine", "engine"};
#endif
 
  for(const string& dir_name: dir_names) {
    name = CheckPathName(FDMExec->GetFullAircraftPath()/dir_name, path);
    if (!name.isNull()) return name;
  }
 
  return CheckPathName(FDMExec->GetEnginePath(), path);
}

◆ GetActiveEngine()

int GetActiveEngine ( void ) const

inline

Definition at line 173 of file FGPropulsion.h.

173{return ActiveEngine;}

◆ GetCutoff()

int GetCutoff ( void ) const

Definition at line 707 of file FGPropulsion.cpp.

{
  if (ActiveEngine < 0) {
    bool cutoff = true;
 
    for (auto& engine: Engines) {
      switch (engine->GetType()) {
      case FGEngine::etTurbine:
        cutoff &= static_pointer_cast<FGTurbine>(engine)->GetCutoff();
        break;
      case FGEngine::etTurboprop:
        cutoff &= static_pointer_cast<FGTurboProp>(engine)->GetCutoff();
        break;
      default:
        return -1;
      }
    }
 
    return cutoff ? 1 : 0;
  } else {
    auto engine = Engines[ActiveEngine];
    switch (engine->GetType()) {
    case FGEngine::etTurbine:
      return static_pointer_cast<FGTurbine>(engine)->GetCutoff() ? 1 : 0;
    case FGEngine::etTurboprop:
      return static_pointer_cast<FGTurboProp>(engine)->GetCutoff() ? 1 : 0;
    default:
      break;
    }
  }
 
  return -1;
}

◆ GetEngine()

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

                                           {
    assert(index < Engines.size());
    return Engines[index];
  }

◆ GetForces() [1/2]

double GetForces ( int n ) const

inline

Definition at line 161 of file FGPropulsion.h.

161{ return vForces(n);}

◆ GetForces() [2/2]

const FGColumnVector3 & GetForces ( void ) const

inline

Definition at line 160 of file FGPropulsion.h.

160{return vForces; }

◆ GetFuelFreeze()

bool GetFuelFreeze ( void ) const

inline

Definition at line 174 of file FGPropulsion.h.

174{return FuelFreeze;}

◆ GetMoments() [1/2]

double GetMoments ( int n ) const

inline

Definition at line 163 of file FGPropulsion.h.

163{return vMoments(n);}

◆ GetMoments() [2/2]

const FGColumnVector3 & GetMoments ( void ) const

inline

Definition at line 162 of file FGPropulsion.h.

162{return vMoments;}

◆ GetNumEngines()

size_t GetNumEngines ( void ) const

inline

Retrieves the number of engines defined for the aircraft.

Definition at line 126 of file FGPropulsion.h.

126{return Engines.size();}

Here is the caller graph for this function:

◆ GetNumTanks()

size_t GetNumTanks ( void ) const

inline

Retrieves the number of tanks defined for the aircraft.

Definition at line 138 of file FGPropulsion.h.

138{return Tanks.size();}

◆ GetPropulsionStrings()

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

Definition at line 493 of file FGPropulsion.cpp.

{
  unsigned int i = 0;
 
  string PropulsionStrings;
  bool firstime = true;
  stringstream buf;
 
  for (auto& engine: Engines) {
    if (firstime)  firstime = false;
    else           PropulsionStrings += delimiter;
 
    PropulsionStrings += engine->GetEngineLabels(delimiter);
  }
  for (auto& tank: Tanks) {
    if (tank->GetType() == FGTank::ttFUEL) buf << delimiter << "Fuel Tank " << i++;
    else if (tank->GetType() == FGTank::ttOXIDIZER) buf << delimiter << "Oxidizer Tank " << i++;
 
    const string& name = tank->GetName();
    if (!name.empty()) buf << " (" << name << ")";
  }
 
  PropulsionStrings += buf.str();
 
  return PropulsionStrings;
}

◆ GetPropulsionTankReport()

string GetPropulsionTankReport ( )

Definition at line 546 of file FGPropulsion.cpp.

{
  string out;
  stringstream outstream;
  unsigned int i = 0;
 
  /*const FGMatrix33& mTkI =*/ CalculateTankInertias();
 
  for (const auto& tank: Tanks) {
    string tankdesc;
    const string& tankname = tank->GetName();
    if (!tankname.empty()) tankdesc = tankname + " (";
    if (tank->GetType() == FGTank::ttFUEL && tank->GetGrainType() != FGTank::gtUNKNOWN) {
      tankdesc += "Solid Fuel";
    } else if (tank->GetType() == FGTank::ttFUEL) {
      tankdesc += "Fuel";
    } else if (tank->GetType() == FGTank::ttOXIDIZER) {
      tankdesc += "Oxidizer";
    } else {
      tankdesc += "Unknown tank type";
    }
    if (!tankname.empty()) tankdesc += ")";
    outstream << highint << left << setw(4) << i++ << setw(30) << tankdesc << normint
      << right << setw(12) << tank->GetContents() << setw(8) << tank->GetXYZ(eX)
      << setw(8) << tank->GetXYZ(eY) << setw(8) << tank->GetXYZ(eZ)
      << setw(12) << tank->GetIxx() << setw(12) << tank->GetIyy()
      << setw(12) << tank->GetIzz() << "\n";
  }
  return outstream.str();
}

◆ GetPropulsionValues()

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

Definition at line 522 of file FGPropulsion.cpp.

{
  string PropulsionValues;
  bool firstime = true;
  stringstream buf;
 
  for (const auto& engine: Engines) {
    if (firstime)  firstime = false;
    else           PropulsionValues += delimiter;
 
    PropulsionValues += engine->GetEngineValues(delimiter);
  }
  for (const auto& tank: Tanks) {
    buf << delimiter;
    buf << tank->GetContents();
  }
 
  PropulsionValues += buf.str();
 
  return PropulsionValues;
}

◆ GetStarter()

int GetStarter ( void ) const

Definition at line 658 of file FGPropulsion.cpp.

{
  if (ActiveEngine < 0) {
    bool starter = true;
 
    for (auto& engine: Engines)
      starter &= engine->GetStarter();
 
    return starter ? 1 : 0;
  } else
    return Engines[ActiveEngine]->GetStarter() ? 1: 0;
}

◆ GetSteadyState()

bool GetSteadyState ( void )

Loops the engines until thrust output steady (used for trimming)

Definition at line 267 of file FGPropulsion.cpp.

{
  double currentThrust = 0, lastThrust = -1;
  int steady_count = 0, j = 0;
  bool steady = false;
  bool TrimMode = FDMExec->GetTrimStatus();
  double TimeStep = FDMExec->GetDeltaT();
 
  vForces.InitMatrix();
  vMoments.InitMatrix();
 
  if (!FGModel::Run(false)) {
    FDMExec->SetTrimStatus(true);
    // This is a time marching algorithm so it needs a non-zero time step to
    // reach a steady state.
    in.TotalDeltaT = 0.5;
 
    for (auto& engine: Engines) {
      steady=false;
      steady_count=0;
      j=0;
      while (!steady && j < 6000) {
        engine->Calculate();
        lastThrust = currentThrust;
        currentThrust = engine->GetThrust();
        if (fabs(lastThrust-currentThrust) < 0.0001) {
          steady_count++;
          if (steady_count > 120) {
            steady=true;
          }
        } else {
          steady_count=0;
        }
        j++;
      }
      vForces  += engine->GetBodyForces();  // sum body frame forces
      vMoments += engine->GetMoments();     // sum body frame moments
    }
 
    FDMExec->SetTrimStatus(TrimMode);
    in.TotalDeltaT = TimeStep;
 
    return false;
  } else {
    return true;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTank()

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

                                         {
    assert(index < Tanks.size());
    return Tanks[index];
  }

◆ GetTanksMoment()

const FGColumnVector3 & GetTanksMoment ( void )

Definition at line 579 of file FGPropulsion.cpp.

{
  vXYZtank_arm.InitMatrix();
  for (const auto& tank: Tanks)
    vXYZtank_arm += tank->GetXYZ() * tank->GetContents();
 
  return vXYZtank_arm;
}

◆ GetTanksWeight()

double GetTanksWeight ( void ) const

Definition at line 590 of file FGPropulsion.cpp.

{
  double Tw = 0.0;
 
  for (const auto& tank: Tanks) Tw += tank->GetContents();
 
  return Tw;
}

◆ InitModel()

bool InitModel ( void )

overridevirtual

Reimplemented from FGModel.

Definition at line 97 of file FGPropulsion.cpp.

{
  bool result = true;
 
  if (!FGModel::InitModel()) return false;
 
  vForces.InitMatrix();
  vMoments.InitMatrix();
 
  for (auto& tank: Tanks) tank->ResetToIC();
  TotalFuelQuantity = 0.0;
  TotalOxidizerQuantity = 0.0;
  refuel = dump = false;
 
  for (auto& engine: Engines) engine->ResetToIC();
 
  return result;
}

◆ InitRunning()

void InitRunning ( int n )

Sets up the engines as running.

Definition at line 317 of file FGPropulsion.cpp.

{
  if (n >= 0) { // A specific engine is supposed to be initialized
 
    if (n >= (int)GetNumEngines() ) {
      LogException err;
      err << "Tried to initialize a non-existent engine!";
      throw err;
    }
 
    SetEngineRunning(n);
 
  } else if (n < 0) { // -1 refers to "All Engines"
 
    for (unsigned int i=0; i<GetNumEngines(); i++) {
      SetEngineRunning(i);
    }
  }
 
  GetSteadyState();
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Load()

bool Load ( Element * el )

overridevirtual

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 352 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::Upload(el, true))
    return false;
 
  // Process tank definitions first to establish the number of fuel tanks
 
  Element* tank_element = el->FindElement("tank");
  unsigned int numTanks = 0;
 
  while (tank_element) {
    Tanks.push_back(make_shared<FGTank>(FDMExec, tank_element, numTanks));
    const auto& tank = Tanks.back();
    if (tank->GetType() == FGTank::ttFUEL)
      FuelDensity = tank->GetDensity();
    else if (tank->GetType() != FGTank::ttOXIDIZER) {
      FGXMLLogging log(tank_element, LogLevel::ERROR);
      log << "Unknown tank type specified.\n";
      return false;
    }
    numTanks++;
    tank_element = el->FindNextElement("tank");
  }
 
  ReadingEngine = true;
  Element* engine_element = el->FindElement("engine");
  unsigned int numEngines = 0;
 
  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) {
        XMLLogException err(engine_element);
        err << "No thruster definition supplied with engine definition.";
        throw err;
      }
      if (!ModelLoader.Open(thruster_element)) {
        XMLLogException err(thruster_element);
        err << "Cannot open the thruster element.";
        throw err;
      }
 
      if (engine_element->FindElement("piston_engine")) {
        Element *element = engine_element->FindElement("piston_engine");
        Engines.push_back(make_shared<FGPiston>(FDMExec, element, numEngines, in));
      } else if (engine_element->FindElement("turbine_engine")) {
        Element *element = engine_element->FindElement("turbine_engine");
        Engines.push_back(make_shared<FGTurbine>(FDMExec, element, numEngines, in));
      } else if (engine_element->FindElement("turboprop_engine")) {
        Element *element = engine_element->FindElement("turboprop_engine");
        Engines.push_back(make_shared<FGTurboProp>(FDMExec, element, numEngines, in));
      } else if (engine_element->FindElement("rocket_engine")) {
        Element *element = engine_element->FindElement("rocket_engine");
        Engines.push_back(make_shared<FGRocket>(FDMExec, element, numEngines, in));
      } else if (engine_element->FindElement("electric_engine")) {
        Element *element = engine_element->FindElement("electric_engine");
        Engines.push_back(make_shared<FGElectric>(FDMExec, element, numEngines, in));
      } else if (engine_element->FindElement("brushless_dc_motor")) {
        Element *element = engine_element->FindElement("brushless_dc_motor");
        Engines.push_back(make_shared<FGBrushLessDCMotor>(FDMExec, element, numEngines, in));
      }
      else {
        FGXMLLogging log(engine_element, LogLevel::ERROR);
        log << " Unknown engine type\n";
        return false;
      }
    } catch (XMLLogException& err) {
      err << "Cannot load " << Name << "\n";
      return false;
    } catch (LogException& e) {
      XMLLogException err(e, engine_element);
      err << "Cannot load " << Name << "\n";
      return false;
    } catch (const BaseException& e) {
      FGXMLLogging err(engine_element, LogLevel::FATAL);
      err << "\n" << LogFormat::RED << e.what() << LogFormat::RESET
          << "\nCannot load " << Name << "\n";
      return false;
    }
 
    numEngines++;
 
    engine_element = el->FindNextElement("engine");
  }
 
  if (numEngines) bind();
 
  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");
 
  for (auto& engine: Engines)
    engine->SetFuelDensity(FuelDensity);
 
  PostLoad(el, FDMExec);
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Run()

bool Run ( bool Holding )

overridevirtual

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

{
  if (FGModel::Run(Holding)) return true;
  if (Holding) return false;
 
  RunPreFunctions();
 
  vForces.InitMatrix();
  vMoments.InitMatrix();
 
  for (auto& engine: Engines) {
    engine->Calculate();
    ConsumeFuel(engine.get());
    vForces  += engine->GetBodyForces();  // sum body frame forces
    vMoments += engine->GetMoments();     // sum body frame moments
  }
 
  TotalFuelQuantity = 0.0;
  TotalOxidizerQuantity = 0.0;
  for (auto& tank: Tanks) {
    tank->Calculate( in.TotalDeltaT, in.TAT_c);
    switch (tank->GetType()) {
    case FGTank::ttFUEL:
      TotalFuelQuantity += tank->GetContents();
      break;
    case FGTank::ttOXIDIZER:
      TotalOxidizerQuantity += tank->GetContents();
      break;
    default:
      break;
    }
  }
 
  if (refuel) DoRefuel( in.TotalDeltaT );
  if (dump) DumpFuel( in.TotalDeltaT );
 
  RunPostFunctions();
 
  return false;
}

Here is the call graph for this function:

◆ SetActiveEngine()

void SetActiveEngine ( int engine )

Definition at line 743 of file FGPropulsion.cpp.

{
  if (engine >= (int)Engines.size() || engine < 0)
    ActiveEngine = -1;
  else
    ActiveEngine = engine;
}

◆ SetCutoff()

void SetCutoff ( int setting = 0 )

Definition at line 673 of file FGPropulsion.cpp.

{
  bool bsetting = setting == 0 ? false : true;
 
  if (ActiveEngine < 0) {
    for (auto& engine: Engines) {
      switch (engine->GetType()) {
        case FGEngine::etTurbine:
          static_pointer_cast<FGTurbine>(engine)->SetCutoff(bsetting);
          break;
        case FGEngine::etTurboprop:
          static_pointer_cast<FGTurboProp>(engine)->SetCutoff(bsetting);
          break;
        default:
          break;
      }
    }
  } else {
    auto engine = Engines[ActiveEngine];
    switch (engine->GetType()) {
      case FGEngine::etTurbine:
        static_pointer_cast<FGTurbine>(engine)->SetCutoff(bsetting);
        break;
      case FGEngine::etTurboprop:
        static_pointer_cast<FGTurboProp>(engine)->SetCutoff(bsetting);
        break;
      default:
        break;
    }
  }
}

◆ SetEngineRunning()

void SetEngineRunning ( int index )

Definition at line 341 of file FGPropulsion.cpp.

{
  in.ThrottleCmd[engineIndex] = in.ThrottlePos[engineIndex] = 1; // Set the throttle command and position
  in.MixtureCmd[engineIndex] = in.MixturePos[engineIndex] = 1;   // Set the mixture command and position
  FDMExec->GetFCS()->SetMixturePos(engineIndex, 1);    // Also set FCS values
  FDMExec->GetFCS()->SetMixtureCmd(engineIndex, 1);
  GetEngine(engineIndex)->InitRunning();
}

◆ SetFuelFreeze()

void SetFuelFreeze ( bool f )

Definition at line 813 of file FGPropulsion.cpp.

{
  FuelFreeze = f;
  for (auto& engine: Engines) engine->SetFuelFreeze(f);
}

◆ SetMagnetos()

void SetMagnetos ( int setting )

Definition at line 620 of file FGPropulsion.cpp.

{
  if (ActiveEngine < 0) {
    for (auto& engine: Engines) {
      // ToDo: first need to make sure the engine Type is really appropriate:
      //   do a check to see if it is of type Piston. This should be done for
      //   all of this kind of possibly across-the-board settings.
      if (engine->GetType() == FGEngine::etPiston)
        static_pointer_cast<FGPiston>(engine)->SetMagnetos(setting);
    }
  } else {
    auto engine = dynamic_pointer_cast<FGPiston>(Engines[ActiveEngine]);
    if (engine)
      engine->SetMagnetos(setting);
  }
}

◆ SetStarter()

void SetStarter ( int setting )

Definition at line 639 of file FGPropulsion.cpp.

{
  if (ActiveEngine < 0) {
    for (auto& engine: Engines) {
      if (setting == 0)
        engine->SetStarter(false);
      else
        engine->SetStarter(true);
    }
  } else {
    if (setting == 0)
      Engines[ActiveEngine]->SetStarter(false);
    else
      Engines[ActiveEngine]->SetStarter(true);
  }
}

◆ Transfer()

double Transfer	(	int	source,
		int	target,
		double	amount
	)

Definition at line 753 of file FGPropulsion.cpp.

{
 double shortage, overage;
 
  if (source == -1) {
     shortage = 0.0;
  } else {
     shortage = Tanks[source]->Drain(amount);
  }
  if (target == -1) {
     overage = 0.0;
  } else {
     overage = Tanks[target]->Fill(amount - shortage);
  }
  return overage;
}

Member Data Documentation

◆ in

struct FGEngine::Inputs in

Definition at line 185 of file FGPropulsion.h.

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

Detailed Description

Configuration File Format:

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ FGPropulsion()

◆ ~FGPropulsion()

Member Function Documentation

◆ CalculateTankInertias()

◆ DoRefuel()

◆ DumpFuel()

◆ FindFullPathName()

◆ GetActiveEngine()

◆ GetCutoff()

◆ GetEngine()

◆ GetForces() [1/2]

◆ GetForces() [2/2]

◆ GetFuelFreeze()

◆ GetMoments() [1/2]

◆ GetMoments() [2/2]

◆ GetNumEngines()

◆ GetNumTanks()

◆ GetPropulsionStrings()

◆ GetPropulsionTankReport()

◆ GetPropulsionValues()

◆ GetStarter()

◆ GetSteadyState()

◆ GetTank()

◆ GetTanksMoment()

◆ GetTanksWeight()

◆ InitModel()

◆ InitRunning()

◆ Load()

◆ Run()

◆ SetActiveEngine()

◆ SetCutoff()

◆ SetEngineRunning()

◆ SetFuelFreeze()

◆ SetMagnetos()

◆ SetStarter()

◆ Transfer()

Member Data Documentation

◆ in