FlightGear next
JSBSim::FGThruster Class Reference

Base class for specific thrusting devices such as propellers, nozzles, etc. More...

#include <FGThruster.h>

Inherits JSBSim::FGForce.

Inherited by JSBSim::FGNozzle, JSBSim::FGPropeller, and JSBSim::FGRotor.

Classes

struct  Inputs
 

Public Types

enum  eType { ttNozzle , ttRotor , ttPropeller , ttDirect }
 
- Public Types inherited from JSBSim::FGForce
enum  TransformType { tNone , tWindBody , tLocalBody , tCustom }
 
- 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...
 

Public Member Functions

 FGThruster (FGFDMExec *FDMExec, Element *el, int num)
 Constructor.
 
virtual ~FGThruster ()
 Destructor.
 
virtual double Calculate (double tt)
 
void SetName (std::string name)
 
virtual void SetRPM (double rpm)
 
virtual void SetEngineRPM (double rpm)
 
virtual double GetPowerRequired (void)
 
double GetThrust (void) const
 
eType GetType (void)
 
std::string GetName (void)
 
void SetReverserAngle (double angle)
 
double GetReverserAngle (void) const
 
virtual double GetRPM (void) const
 
virtual double GetEngineRPM (void) const
 
double GetGearRatio (void)
 
virtual std::string GetThrusterLabels (int id, const std::string &delimeter)
 
virtual std::string GetThrusterValues (int id, const std::string &delimeter)
 
virtual void ResetToIC (void)
 
- Public Member Functions inherited from JSBSim::FGForce
 FGForce (FGFDMExec *FDMExec)
 Constructor.
 
 FGForce (const FGForce &force)
 
virtual ~FGForce ()
 Destructor.
 
virtual const FGColumnVector3GetBodyForces (void)
 
double GetBodyXForce (void) const
 
double GetBodyYForce (void) const
 
double GetBodyZForce (void) const
 
const FGColumnVector3GetMoments (void) const
 
void SetLocation (double x, double y, double z)
 
void SetActingLocation (double x, double y, double z)
 Acting point of application.
 
void SetLocationX (double x)
 
void SetLocationY (double y)
 
void SetLocationZ (double z)
 
double SetActingLocationX (double x)
 
double SetActingLocationY (double y)
 
double SetActingLocationZ (double z)
 
void SetLocation (const FGColumnVector3 &vv)
 
void SetActingLocation (const FGColumnVector3 &vv)
 
double GetLocationX (void) const
 
double GetLocationY (void) const
 
double GetLocationZ (void) const
 
double GetActingLocationX (void) const
 
double GetActingLocationY (void) const
 
double GetActingLocationZ (void) const
 
const FGColumnVector3GetLocation (void) const
 
const FGColumnVector3GetActingLocation (void) const
 
void SetAnglesToBody (double broll, double bpitch, double byaw)
 
void SetAnglesToBody (const FGColumnVector3 &vv)
 
void UpdateCustomTransformMatrix (void)
 
void SetPitch (double pitch)
 
void SetYaw (double yaw)
 
double GetPitch (void) const
 
double GetYaw (void) const
 
const FGColumnVector3GetAnglesToBody (void) const
 
double GetAnglesToBody (int axis) const
 
void SetTransformType (TransformType ii)
 
TransformType GetTransformType (void) const
 
const FGMatrix33Transform (void) const
 
- 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.
 

Public Attributes

struct JSBSim::FGThruster::Inputs in
 

Protected Member Functions

virtual void Debug (int from)
 

Protected Attributes

eType Type
 
std::string Name
 
double Thrust
 
double PowerRequired
 
double GearRatio
 
double ThrustCoeff
 
double ReverserAngle
 
int EngineNum
 
- Protected Attributes inherited from JSBSim::FGForce
FGFDMExecfdmex
 
FGMassBalanceMassBalance
 
FGColumnVector3 vFn
 
FGColumnVector3 vMn
 
FGColumnVector3 vOrient
 
TransformType ttype
 
FGColumnVector3 vXYZn
 
FGColumnVector3 vActingXYZn
 
FGMatrix33 mT
 

Additional Inherited Members

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

Base class for specific thrusting devices such as propellers, nozzles, etc.

reverser angle:

"Reverser angle" as used here is a way to manipulate the thrust vector,
along the thrust axis ONLY, during run time.  This should not be confused
with a thrust vectoring nozzle.  The angle is defined in radians, and is
used thus:  Final_thrust = cosine( reverser_angle ) * unmodified_thrust.  
Therefore a reverser angle of 0 results in no change, and a reverser angle
of 3.14 (pi) results in a completely reversed thrust vector.  An angle of
1.57 (pi/2) results in no thrust at all.

@author Jon Berndt

Definition at line 77 of file FGThruster.h.

Member Enumeration Documentation

◆ eType

Enumerator
ttNozzle 
ttRotor 
ttPropeller 
ttDirect 

Definition at line 85 of file FGThruster.h.

Constructor & Destructor Documentation

◆ FGThruster()

JSBSim::FGThruster::FGThruster ( FGFDMExec * FDMExec,
Element * el,
int num )

Constructor.

Definition at line 55 of file FGThruster.cpp.

◆ ~FGThruster()

JSBSim::FGThruster::~FGThruster ( )
virtual

Destructor.

Definition at line 121 of file FGThruster.cpp.

Member Function Documentation

◆ Calculate()

virtual double JSBSim::FGThruster::Calculate ( double tt)
inlinevirtual

Reimplemented in JSBSim::FGNozzle, JSBSim::FGPropeller, and JSBSim::FGRotor.

Definition at line 87 of file FGThruster.h.

◆ Debug()

void JSBSim::FGThruster::Debug ( int from)
protectedvirtual

Definition at line 176 of file FGThruster.cpp.

◆ GetEngineRPM()

virtual double JSBSim::FGThruster::GetEngineRPM ( void ) const
inlinevirtual

Reimplemented in JSBSim::FGPropeller, and JSBSim::FGRotor.

Definition at line 102 of file FGThruster.h.

◆ GetGearRatio()

double JSBSim::FGThruster::GetGearRatio ( void )
inline

Definition at line 103 of file FGThruster.h.

◆ GetName()

std::string JSBSim::FGThruster::GetName ( void )
inline

Definition at line 98 of file FGThruster.h.

◆ GetPowerRequired()

virtual double JSBSim::FGThruster::GetPowerRequired ( void )
inlinevirtual

Reimplemented in JSBSim::FGPropeller.

Definition at line 95 of file FGThruster.h.

◆ GetReverserAngle()

double JSBSim::FGThruster::GetReverserAngle ( void ) const
inline

Definition at line 100 of file FGThruster.h.

◆ GetRPM()

virtual double JSBSim::FGThruster::GetRPM ( void ) const
inlinevirtual

Reimplemented in JSBSim::FGPropeller, and JSBSim::FGRotor.

Definition at line 101 of file FGThruster.h.

◆ GetThrust()

double JSBSim::FGThruster::GetThrust ( void ) const
inline

Definition at line 96 of file FGThruster.h.

◆ GetThrusterLabels()

string JSBSim::FGThruster::GetThrusterLabels ( int id,
const std::string & delimeter )
virtual

Reimplemented in JSBSim::FGNozzle, JSBSim::FGPropeller, and JSBSim::FGRotor.

Definition at line 137 of file FGThruster.cpp.

◆ GetThrusterValues()

string JSBSim::FGThruster::GetThrusterValues ( int id,
const std::string & delimeter )
virtual

Reimplemented in JSBSim::FGNozzle, JSBSim::FGPropeller, and JSBSim::FGRotor.

Definition at line 148 of file FGThruster.cpp.

◆ GetType()

eType JSBSim::FGThruster::GetType ( void )
inline

Definition at line 97 of file FGThruster.h.

◆ ResetToIC()

void JSBSim::FGThruster::ResetToIC ( void )
virtual

Reimplemented in JSBSim::FGPropeller.

Definition at line 128 of file FGThruster.cpp.

◆ SetEngineRPM()

virtual void JSBSim::FGThruster::SetEngineRPM ( double rpm)
inlinevirtual

Reimplemented in JSBSim::FGPropeller, and JSBSim::FGRotor.

Definition at line 94 of file FGThruster.h.

◆ SetName()

void JSBSim::FGThruster::SetName ( std::string name)
inline

Definition at line 92 of file FGThruster.h.

◆ SetReverserAngle()

void JSBSim::FGThruster::SetReverserAngle ( double angle)
inline

Definition at line 99 of file FGThruster.h.

◆ SetRPM()

virtual void JSBSim::FGThruster::SetRPM ( double rpm)
inlinevirtual

Reimplemented in JSBSim::FGPropeller, and JSBSim::FGRotor.

Definition at line 93 of file FGThruster.h.

Member Data Documentation

◆ EngineNum

int JSBSim::FGThruster::EngineNum
protected

Definition at line 131 of file FGThruster.h.

◆ GearRatio

double JSBSim::FGThruster::GearRatio
protected

Definition at line 128 of file FGThruster.h.

◆ in

struct JSBSim::FGThruster::Inputs JSBSim::FGThruster::in

◆ Name

std::string JSBSim::FGThruster::Name
protected

Definition at line 125 of file FGThruster.h.

◆ PowerRequired

double JSBSim::FGThruster::PowerRequired
protected

Definition at line 127 of file FGThruster.h.

◆ ReverserAngle

double JSBSim::FGThruster::ReverserAngle
protected

Definition at line 130 of file FGThruster.h.

◆ Thrust

double JSBSim::FGThruster::Thrust
protected

Definition at line 126 of file FGThruster.h.

◆ ThrustCoeff

double JSBSim::FGThruster::ThrustCoeff
protected

Definition at line 129 of file FGThruster.h.

◆ Type

eType JSBSim::FGThruster::Type
protected

Definition at line 124 of file FGThruster.h.


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