FlightGear: JSBSim::FGPropulsion Class Reference

Propulsion management class. More...

#include <FGPropulsion.h>

Public Member Functions
	FGPropulsion (FGFDMExec *)
	Constructor.

	~FGPropulsion () override
	Destructor.

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

bool	InitModel (void) override

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

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

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

unsigned int	GetNumTanks (void) const
	Retrieves the number of tanks defined for the aircraft.

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

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.

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

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

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

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

std::string	GetPropulsionTankReport ()

const FGColumnVector3 &	GetForces (void) const

double	GetForces (int n) const

const FGColumnVector3 &	GetMoments (void) const

double	GetMoments (int n) const

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

void	DoRefuel (double time_slice)

void	DumpFuel (double time_slice)

const FGColumnVector3 &	GetTanksMoment (void)

double	GetTanksWeight (void) const

SGPath	FindFullPathName (const SGPath &path) const override

int	GetActiveEngine (void) const

bool	GetFuelFreeze (void) const

void	SetMagnetos (int setting)

void	SetStarter (int setting)

int	GetStarter (void) const

void	SetCutoff (int setting=0)

int	GetCutoff (void) const

void	SetActiveEngine (int engine)

void	SetFuelFreeze (bool f)

const FGMatrix33 &	CalculateTankInertias (void)

Public Member Functions inherited from JSBSim::FGModel
	FGModel (FGFDMExec *)
	Constructor.

	~FGModel () override
	Destructor.

void	SetRate (unsigned int tt)
	Set the ouput rate for the model in frames.

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

FGFDMExec *	GetExec (void)

void	SetPropertyManager (FGPropertyManager *fgpm)

const std::string &	GetName (void)

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.

Public Attributes
struct FGEngine::Inputs	in

Additional Inherited Members
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...

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)

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::FGModel
bool	Upload (Element *el, bool preLoad)
	Uploads this model in memory.

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

Protected Attributes inherited from JSBSim::FGModel
unsigned int	exe_ctr

unsigned int	rate

std::string	Name

FGFDMExec *	FDMExec

FGPropertyManager *	PropertyManager

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

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

Constructor & Destructor Documentation

◆ FGPropulsion()

JSBSim::FGPropulsion::FGPropulsion ( FGFDMExec * exec )

Constructor.

Definition at line 70 of file FGPropulsion.cpp.

◆ ~FGPropulsion()

JSBSim::FGPropulsion::~FGPropulsion ( )

override

Destructor.

Definition at line 94 of file FGPropulsion.cpp.

Member Function Documentation

◆ CalculateTankInertias()

const FGMatrix33 & JSBSim::FGPropulsion::CalculateTankInertias ( void )

Definition at line 578 of file FGPropulsion.cpp.

◆ DoRefuel()

void JSBSim::FGPropulsion::DoRefuel ( double time_slice )

Definition at line 747 of file FGPropulsion.cpp.

◆ DumpFuel()

void JSBSim::FGPropulsion::DumpFuel ( double time_slice )

Definition at line 769 of file FGPropulsion.cpp.

◆ FindFullPathName()

SGPath JSBSim::FGPropulsion::FindFullPathName ( const SGPath & path ) const

overridevirtual

Reimplemented from JSBSim::FGModel.

Definition at line 458 of file FGPropulsion.cpp.

◆ GetActiveEngine()

int JSBSim::FGPropulsion::GetActiveEngine ( void ) const

inline

Definition at line 177 of file FGPropulsion.h.

◆ GetCutoff()

int JSBSim::FGPropulsion::GetCutoff ( void ) const

Definition at line 683 of file FGPropulsion.cpp.

◆ GetEngine()

FGEngine * JSBSim::FGPropulsion::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 133 of file FGPropulsion.h.

◆ GetForces() [1/2]

double JSBSim::FGPropulsion::GetForces ( int n ) const

inline

Definition at line 165 of file FGPropulsion.h.

◆ GetForces() [2/2]

const FGColumnVector3 & JSBSim::FGPropulsion::GetForces ( void ) const

inline

Definition at line 164 of file FGPropulsion.h.

◆ GetFuelFreeze()

bool JSBSim::FGPropulsion::GetFuelFreeze ( void ) const

inline

Definition at line 178 of file FGPropulsion.h.

◆ GetMoments() [1/2]

double JSBSim::FGPropulsion::GetMoments ( int n ) const

inline

Definition at line 167 of file FGPropulsion.h.

◆ GetMoments() [2/2]

const FGColumnVector3 & JSBSim::FGPropulsion::GetMoments ( void ) const

inline

Definition at line 166 of file FGPropulsion.h.

◆ GetNumEngines()

unsigned int JSBSim::FGPropulsion::GetNumEngines ( void ) const

inline

Retrieves the number of engines defined for the aircraft.

Definition at line 127 of file FGPropulsion.h.

◆ GetnumSelectedFuelTanks()

int JSBSim::FGPropulsion::GetnumSelectedFuelTanks ( void ) const

inline

Returns the number of fuel tanks currently actively supplying fuel.

Definition at line 149 of file FGPropulsion.h.

◆ GetnumSelectedOxiTanks()

int JSBSim::FGPropulsion::GetnumSelectedOxiTanks ( void ) const

inline

Returns the number of oxidizer tanks currently actively supplying oxidizer.

Definition at line 152 of file FGPropulsion.h.

◆ GetNumTanks()

unsigned int JSBSim::FGPropulsion::GetNumTanks ( void ) const

inline

Retrieves the number of tanks defined for the aircraft.

Definition at line 138 of file FGPropulsion.h.

◆ GetPropulsionStrings()

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

Definition at line 471 of file FGPropulsion.cpp.

◆ GetPropulsionTankReport()

string JSBSim::FGPropulsion::GetPropulsionTankReport ( )

Definition at line 525 of file FGPropulsion.cpp.

◆ GetPropulsionValues()

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

Definition at line 498 of file FGPropulsion.cpp.

◆ GetStarter()

int JSBSim::FGPropulsion::GetStarter ( void ) const

Definition at line 635 of file FGPropulsion.cpp.

◆ GetSteadyState()

bool JSBSim::FGPropulsion::GetSteadyState ( void )

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

Definition at line 279 of file FGPropulsion.cpp.

◆ GetTank()

FGTank * JSBSim::FGPropulsion::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.

◆ GetTanksMoment()

const FGColumnVector3 & JSBSim::FGPropulsion::GetTanksMoment ( void )

Definition at line 556 of file FGPropulsion.cpp.

◆ GetTanksWeight()

double JSBSim::FGPropulsion::GetTanksWeight ( void ) const

Definition at line 567 of file FGPropulsion.cpp.

◆ InitModel()

bool JSBSim::FGPropulsion::InitModel ( void )

overridevirtual

Reimplemented from JSBSim::FGModel.

Definition at line 105 of file FGPropulsion.cpp.

◆ InitRunning()

void JSBSim::FGPropulsion::InitRunning ( int n )

Sets up the engines as running.

Definition at line 329 of file FGPropulsion.cpp.

◆ Load()

bool JSBSim::FGPropulsion::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 JSBSim::FGModel.

Definition at line 357 of file FGPropulsion.cpp.

◆ Run()

bool JSBSim::FGPropulsion::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 JSBSim::FGModel.

Definition at line 127 of file FGPropulsion.cpp.

◆ SetActiveEngine()

void JSBSim::FGPropulsion::SetActiveEngine ( int engine )

Definition at line 718 of file FGPropulsion.cpp.

◆ SetCutoff()

void JSBSim::FGPropulsion::SetCutoff ( int setting = 0 )

Definition at line 650 of file FGPropulsion.cpp.

◆ SetFuelFreeze()

void JSBSim::FGPropulsion::SetFuelFreeze ( bool f )

Definition at line 791 of file FGPropulsion.cpp.

◆ SetMagnetos()

void JSBSim::FGPropulsion::SetMagnetos ( int setting )

Definition at line 599 of file FGPropulsion.cpp.

◆ SetStarter()

void JSBSim::FGPropulsion::SetStarter ( int setting )

Definition at line 616 of file FGPropulsion.cpp.

◆ Transfer()

double JSBSim::FGPropulsion::Transfer	(	int	source,
		int	target,
		double	amount )

Definition at line 728 of file FGPropulsion.cpp.

Member Data Documentation

◆ in

struct FGEngine::Inputs JSBSim::FGPropulsion::in

Definition at line 189 of file FGPropulsion.h.

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Configuration File Format:

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

◆ GetnumSelectedFuelTanks()

◆ GetnumSelectedOxiTanks()

◆ GetNumTanks()

◆ GetPropulsionStrings()

◆ GetPropulsionTankReport()

◆ GetPropulsionValues()

◆ GetStarter()

◆ GetSteadyState()

◆ GetTank()

◆ GetTanksMoment()

◆ GetTanksWeight()

◆ InitModel()

◆ InitRunning()

◆ Load()

◆ Run()

◆ SetActiveEngine()

◆ SetCutoff()

◆ SetFuelFreeze()

◆ SetMagnetos()

◆ SetStarter()

◆ Transfer()

Member Data Documentation

◆ in