FlightGear next
JSBSim::FGTransmission Class Reference

Utility class that handles power transmission in conjunction with FGRotor. More...

#include <FGTransmission.h>

Inherits JSBSim::FGJSBBase.

Public Member Functions

 FGTransmission (FGFDMExec *exec, int num, double dt)
 Constructor for FGTransmission.
 
 ~FGTransmission ()
 Destructor for FGTransmission.
 
void Calculate (double EnginePower, double ThrusterTorque, double dt)
 
void SetMaxBrakePower (double x)
 
double GetMaxBrakePower () const
 
void SetEngineFriction (double x)
 
double GetEngineFriction () const
 
void SetEngineMoment (double x)
 
double GetEngineMoment () const
 
void SetThrusterMoment (double x)
 
double GetThrusterMoment () const
 
double GetFreeWheelTransmission () const
 
void SetEngineRPM (double x)
 
double GetEngineRPM ()
 
void SetThrusterRPM (double x)
 
double GetThrusterRPM ()
 
double GetBrakeCtrlNorm () const
 
void SetBrakeCtrlNorm (double x)
 
double GetClutchCtrlNorm () const
 
void SetClutchCtrlNorm (double x)
 
- 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.
 
MessageProcessNextMessage (void)
 Reads the next message on the queue and removes it from the queue.
 
void disableHighLighting (void)
 Disables highlighting in the console output.
 

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
 
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
static Message localMsg
 
static std::queue< MessageMessages
 
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/(fttom*fttom*fttom)
 
static constexpr double in3tom3 = inchtoft*inchtoft*inchtoft/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

Utility class that handles power transmission in conjunction with FGRotor.

This class provides brake, clutch and free-wheel-unit (FWU) functionality for the rotor model. Also it is responsible for the RPM calculations.

When the engine is off the brake could be used to slow/hold down a spinning rotor. The maximum brake power is defined in the rotors' config file. (Right now there is no checking if the input is in the [0..1] range.)

The clutch operation is based on a heuristic approach. In the intermediate state the transfer is proportional to the clutch position. But equal RPM values are enforced on the thruster and rotor sides when approaching the closed state.

The FWU inhibits that the rotor is driving the engine. To do so, the code just predicts the upcoming FWU state based on current torque conditions.

Some engines won't work properly when the clutch is open. To keep them controllable some load must be provided on the engine side (EngineFriction, aka gear-loss). See the notes under 'Engine issues' in FGRotor.

Property tree

The following properties are created (with x = your thruster number):

    propulsion/engine[x]/brake-ctrl-norm
    propulsion/engine[x]/free-wheel-transmission
    propulsion/engine[x]/clutch-ctrl-norm
  

Notes

  • EngineFriction is assumed constant, so better orientate at low RPM values, because piston and turboprop engines don't 'like' high load at startup.
  • The model doesn't support backward operation.
  • And even worse, the torque calculations silently assume a minimal RPM value of approx. 1.

Definition at line 108 of file FGTransmission.h.

Constructor & Destructor Documentation

◆ FGTransmission()

JSBSim::FGTransmission::FGTransmission ( FGFDMExec * exec,
int num,
double dt )

Constructor for FGTransmission.

Parameters
execa pointer to the main executive object
numthe number of the thruster that uses this object
dtsimulation delta T

Definition at line 55 of file FGTransmission.cpp.

◆ ~FGTransmission()

JSBSim::FGTransmission::~FGTransmission ( )

Destructor for FGTransmission.

Definition at line 68 of file FGTransmission.cpp.

Member Function Documentation

◆ Calculate()

void JSBSim::FGTransmission::Calculate ( double EnginePower,
double ThrusterTorque,
double dt )

Definition at line 75 of file FGTransmission.cpp.

◆ GetBrakeCtrlNorm()

double JSBSim::FGTransmission::GetBrakeCtrlNorm ( ) const
inline

Definition at line 137 of file FGTransmission.h.

◆ GetClutchCtrlNorm()

double JSBSim::FGTransmission::GetClutchCtrlNorm ( ) const
inline

Definition at line 139 of file FGTransmission.h.

◆ GetEngineFriction()

double JSBSim::FGTransmission::GetEngineFriction ( ) const
inline

Definition at line 125 of file FGTransmission.h.

◆ GetEngineMoment()

double JSBSim::FGTransmission::GetEngineMoment ( ) const
inline

Definition at line 127 of file FGTransmission.h.

◆ GetEngineRPM()

double JSBSim::FGTransmission::GetEngineRPM ( )
inline

Definition at line 133 of file FGTransmission.h.

◆ GetFreeWheelTransmission()

double JSBSim::FGTransmission::GetFreeWheelTransmission ( ) const
inline

Definition at line 131 of file FGTransmission.h.

◆ GetMaxBrakePower()

double JSBSim::FGTransmission::GetMaxBrakePower ( ) const
inline

Definition at line 123 of file FGTransmission.h.

◆ GetThrusterMoment()

double JSBSim::FGTransmission::GetThrusterMoment ( ) const
inline

Definition at line 129 of file FGTransmission.h.

◆ GetThrusterRPM()

double JSBSim::FGTransmission::GetThrusterRPM ( )
inline

Definition at line 135 of file FGTransmission.h.

◆ SetBrakeCtrlNorm()

void JSBSim::FGTransmission::SetBrakeCtrlNorm ( double x)
inline

Definition at line 138 of file FGTransmission.h.

◆ SetClutchCtrlNorm()

void JSBSim::FGTransmission::SetClutchCtrlNorm ( double x)
inline

Definition at line 140 of file FGTransmission.h.

◆ SetEngineFriction()

void JSBSim::FGTransmission::SetEngineFriction ( double x)
inline

Definition at line 124 of file FGTransmission.h.

◆ SetEngineMoment()

void JSBSim::FGTransmission::SetEngineMoment ( double x)
inline

Definition at line 126 of file FGTransmission.h.

◆ SetEngineRPM()

void JSBSim::FGTransmission::SetEngineRPM ( double x)
inline

Definition at line 132 of file FGTransmission.h.

◆ SetMaxBrakePower()

void JSBSim::FGTransmission::SetMaxBrakePower ( double x)
inline

Definition at line 122 of file FGTransmission.h.

◆ SetThrusterMoment()

void JSBSim::FGTransmission::SetThrusterMoment ( double x)
inline

Definition at line 128 of file FGTransmission.h.

◆ SetThrusterRPM()

void JSBSim::FGTransmission::SetThrusterRPM ( double x)
inline

Definition at line 134 of file FGTransmission.h.


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