JSBSim Flight Dynamics Model  1.1.11 (13 Feb 2022)
An Open Source Flight Dynamics and Control Software Library in C++
FGRotor Class Reference

Detailed Description

Models a helicopter rotor.

Configuration File Format

<rotor name="{string}">
<diameter unit="{LENGTH}"> {number} </diameter>
<numblades> {number} </numblades>
<gearratio> {number} </gearratio>
<nominalrpm> {number} </nominalrpm>
<minrpm> {number} </minrpm>
<maxrpm> {number} </maxrpm>
<chord unit="{LENGTH}"> {number} </chord>
<liftcurveslope Xunit="1/RAD"> {number} </liftcurveslope>
<twist unit="{ANGLE}"> {number} </twist>
<hingeoffset unit="{LENGTH}"> {number} </hingeoffset>
<flappingmoment unit="{MOMENT}"> {number} </flappingmoment>
<massmoment Xunit="SLUG*FT"> {number} </massmoment>
<polarmoment unit="{MOMENT}"> {number} </polarmoment>
<inflowlag> {number} </inflowlag>
<tiplossfactor> {number} </tiplossfactor>
<maxbrakepower unit="{POWER}"> {number} </maxbrakepower>
<gearloss unit="{POWER}"> {number} </gearloss>
<gearmoment unit="{MOMENT}"> {number} </gearmoment>
<controlmap> {MAIN|TAIL|TANDEM} </controlmap>
<ExternalRPM> {number} </ExternalRPM>
<groundeffectexp> {number} </groundeffectexp>
<groundeffectshift unit="{LENGTH}"> {number} </groundeffectshift>
</rotor>
// LENGTH means any of the supported units, same for ANGLE and MOMENT.
// Xunit-attributes are a hint for currently unsupported units, so
// values must be provided accordingly.

Configuration Parameters:

Brief description and the symbol frequently found in the literature.

    <diameter>           - Rotor disk diameter (2x R).
    <numblades>          - Number of blades (b).
    <gearratio>          - Ratio of (engine rpm) / (rotor rpm), usually > 1.
    <nominalrpm>         - RPM at which the rotor usally operates.
    <minrpm>             - Lowest RPM used in the model, optional and defaults to 1.
    <maxrpm>             - Largest RPM used in the model, optional and defaults to 2 x nominalrpm.
    <chord>              - Blade chord, (c).
    <liftcurveslope>     - Slope of curve of section lift against section angle of attack,
                             per rad (a).
    <twist>              - Blade twist from root to tip, (theta_1).
    <hingeoffset>        - Rotor flapping-hinge offset (e).
    <flappingmoment>     - Flapping moment of inertia (I_b).
    <massmoment>         - Blade mass moment. Mass of a single blade times the blade's
                             cg-distance from the hub, optional.
    <polarmoment>        - Moment of inertia for the whole rotor disk, optional.
    <inflowlag>          - Rotor inflow time constant, sec. Smaller values yield to quicker
                              responses (typical values for main rotor: 0.1 - 0.2 s).
    <tiplossfactor>      - Tip-loss factor. The Blade fraction that produces lift.
                              Value usually ranges between 0.95 - 1.0, optional (B).
    <maxbrakepower>      - Rotor brake, 20-30 hp should work for a mid size helicopter.
    <gearloss>           - Friction in gear, 0.2% to 3% of the engine power, optional (see notes).
    <gearmoment>         - Approximation for the moment of inertia of the gear (and engine),
                              defaults to 0.1 * polarmoment, optional.
    <controlmap>         - Defines the control inputs used (see notes).
    <ExternalRPM>        - Links the rotor to another rotor, or an user controllable property.
    Experimental properties
    <groundeffectexp>    - Exponent for ground effect approximation. Values usually range from 0.04
                            for large rotors to 0.1 for smaller ones. As a rule of thumb the effect
                            vanishes at a height 2-3 times the rotor diameter.
                              formula used: exp ( - groundeffectexp * (height+groundeffectshift) )
                            Omitting or setting to 0.0 disables the effect calculation.
    <groundeffectshift>  - Further adjustment of ground effect, approx. hub height or slightly above
                            (This lessens the influence of the ground effect).

Notes:

- Controls -

The behavior of the rotor is controlled/influenced by following inputs.

  • The power provided by the engine. This is handled by the regular engine controls.
  • The collective control input. This is read from the fdm property propulsion/engine[x]/collective-ctrl-rad. See below for tail rotor
  • The lateral cyclic input. Read from propulsion/engine[x]/lateral-ctrl-rad.
  • The longitudinal cyclic input. Read from propulsion/engine[x]/longitudinal-ctrl-rad.
  • The tail rotor collective (aka antitorque, aka pedal) control input. Read from propulsion/engine[x]/antitorque-ctrl-rad or propulsion/engine[x]/tail-collective-ctrl-rad.

- Tail/tandem rotor -

Providing <ExternalRPM> 0 </ExternalRPM> the tail rotor's RPM is linked to to the main (=first, =0) rotor, and specifing <controlmap> TAIL </controlmap> tells this rotor to read the collective input from propulsion/engine[1]/antitorque-ctrl-rad (The TAIL-map ignores lateral and longitudinal input). The rotor needs to be attached to a dummy engine, e.g. an 1HP electrical engine. A tandem rotor is setup analogous.

- Sense -

The 'sense' parameter from the thruster is interpreted as follows, sense=1 means counter clockwise rotation of the main rotor, as viewed from above. This is as a far as I know more popular than clockwise rotation, which is defined by setting sense to -1. Concerning coaxial designs - by setting 'sense' to zero, a Kamov-style rotor is modeled (i.e. the rotor produces no torque).

- Engine issues -

In order to keep the rotor/engine speed constant, use of a RPM-Governor system is encouraged (see examples).

In case the model requires the manual use of a clutch the <gearloss> property might need attention.

  • Electrical: here the gear-loss should be rather large to keep the engine controllable when the clutch is open (although full throttle might still make it spin away).
  • Piston: this engine model already has some internal friction loss and also looses power if it spins too high. Here the gear-loss could be set to 0.25% of the engine power (which is also the approximated default).
  • Turboprop: Here the default value might be a bit too small. Also it's advisable to adjust the power table for rpm values that are far beyond the nominal value.

- Scaling the ground effect -

The property propulsion/engine[x]/groundeffect-scale-norm allows fdm based scaling of the ground effect influence. For instance the effect vanishes at speeds above approx. 50kts, or one likes to land on a 'perforated' helipad.

- Development hints -

Setting <ExternalRPM> -1 </ExternalRPM> the rotor's RPM is controlled by the propulsion/engine[x]/x-rpm-dict property. This feature can be useful when developing a FDM.

References:

<dl>    
<dt>/SH79/</dt><dd>Shaugnessy, J. D., Deaux, Thomas N., and Yenni, Kenneth R.,
          "Development and Validation of a Piloted Simulation of a
          Helicopter and External Sling Load",  NASA TP-1285, 1979.</dd>
<dt>/BA41/</dt><dd>Bailey,F.J.,Jr., "A Simplified Theoretical Method of Determining
          the Characteristics of a Lifting Rotor in Forward Flight", NACA Rep.716, 1941.</dd>
<dt>/AM50/</dt><dd>Amer, Kenneth B.,"Theory of Helicopter Damping in Pitch or Roll and a
          Comparison With Flight Measurements", NACA TN-2136, 1950.</dd>
<dt>/TA77/</dt><dd>Talbot, Peter D., Corliss, Lloyd D., "A Mathematical Force and Moment
          Model of a UH-1H Helicopter for Flight Dynamics Simulations", NASA TM-73,254, 1977.</dd>
<dt>/GE49/</dt><dd>Gessow, Alfred, Amer, Kenneth B. "An Introduction to the Physical 
          Aspects of Helicopter Stability", NACA TN-1982, 1949.</dd>
</dl>

@author Thomas Kreitler

Definition at line 235 of file FGRotor.h.

#include <FGRotor.h>

+ Inheritance diagram for FGRotor:
+ Collaboration diagram for FGRotor:

Public Member Functions

 FGRotor (FGFDMExec *exec, Element *rotor_element, int num)
 Constructor for FGRotor. More...
 
 ~FGRotor ()
 Destructor for FGRotor.
 
double Calculate (double EnginePower)
 Returns the scalar thrust of the rotor, and adjusts the RPM value.
 
double GetA0 (void) const
 Retrieves the rotor's coning angle.
 
double GetA1 (void) const
 Retrieves the longitudinal flapping angle with respect to the rotor shaft.
 
double GetB1 (void) const
 Retrieves the lateral flapping angle with respect to the rotor shaft.
 
double GetCollectiveCtrl (void) const
 Retrieves the collective control input in radians.
 
double GetCT (void) const
 Retrieves the thrust coefficient.
 
double GetEngineRPM (void) const
 Retrieves the RPMs of the Engine, as seen from this rotor.
 
double GetGearRatio (void)
 Tells the rotor's gear ratio, usually the engine asks for this.
 
double GetGroundEffectScaleNorm (void) const
 Retrieves the ground effect scaling factor.
 
double GetLambda (void) const
 Retrieves the inflow ratio.
 
double GetLateralCtrl (void) const
 Retrieves the lateral control input in radians.
 
double GetLongitudinalCtrl (void) const
 Retrieves the longitudinal control input in radians.
 
double GetMu (void) const
 Retrieves the tip-speed (aka advance) ratio.
 
double GetNu (void) const
 Retrieves the induced inflow ratio.
 
double GetPhiDW (void) const
 Downwash angle - positive values point leftward (given a horizontal spinning rotor)
 
double GetPowerRequired (void) const
 Returns the power required by the rotor.
 
double GetRPM (void) const
 Retrieves the RPMs of the rotor.
 
double GetThetaDW (void) const
 Downwash angle - positive values point forward (given a horizontal spinning rotor)
 
double GetThrust (void) const
 Retrieves the thrust of the rotor.
 
std::string GetThrusterLabels (int id, const std::string &delimeter)
 
std::string GetThrusterValues (int id, const std::string &delimeter)
 
double GetTorque (void) const
 Retrieves the torque.
 
double GetVi (void) const
 Retrieves the induced velocity.
 
void SetCollectiveCtrl (double c)
 Sets the collective control input in radians.
 
void SetEngineRPM (double rpm)
 
void SetGroundEffectScaleNorm (double g)
 Sets the ground effect scaling factor.
 
void SetLateralCtrl (double c)
 Sets the lateral control input in radians.
 
void SetLongitudinalCtrl (double c)
 Sets the longitudinal control input in radians.
 
void SetRPM (double rpm)
 
- Public Member Functions inherited from FGThruster
 FGThruster (FGFDMExec *FDMExec, Element *el, int num)
 Constructor.
 
virtual ~FGThruster ()
 Destructor.
 
double GetGearRatio (void)
 
std::string GetName (void)
 
virtual double GetPowerRequired (void)
 
double GetReverserAngle (void) const
 
double GetThrust (void) const
 
eType GetType (void)
 
virtual void ResetToIC (void)
 
void SetName (std::string name)
 
void SetReverserAngle (double angle)
 
- Public Member Functions inherited from FGForce
 FGForce (const FGForce &force)
 
 FGForce (FGFDMExec *FDMExec)
 Constructor.
 
virtual ~FGForce ()
 Destructor.
 
const FGColumnVector3GetActingLocation (void) const
 
double GetActingLocationX (void) const
 
double GetActingLocationY (void) const
 
double GetActingLocationZ (void) const
 
double GetAnglesToBody (int axis) const
 
const FGColumnVector3GetAnglesToBody (void) const
 
virtual const FGColumnVector3GetBodyForces (void)
 
double GetBodyXForce (void) const
 
double GetBodyYForce (void) const
 
double GetBodyZForce (void) const
 
const FGColumnVector3GetLocation (void) const
 
double GetLocationX (void) const
 
double GetLocationY (void) const
 
double GetLocationZ (void) const
 
const FGColumnVector3GetMoments (void) const
 
double GetPitch (void) const
 
TransformType GetTransformType (void) const
 
double GetYaw (void) const
 
void SetActingLocation (const FGColumnVector3 &vv)
 
void SetActingLocation (double x, double y, double z)
 Acting point of application. More...
 
double SetActingLocationX (double x)
 
double SetActingLocationY (double y)
 
double SetActingLocationZ (double z)
 
void SetAnglesToBody (const FGColumnVector3 &vv)
 
void SetAnglesToBody (double broll, double bpitch, double byaw)
 
void SetLocation (const FGColumnVector3 &vv)
 
void SetLocation (double x, double y, double z)
 
void SetLocationX (double x)
 
void SetLocationY (double y)
 
void SetLocationZ (double z)
 
void SetPitch (double pitch)
 
void SetTransformType (TransformType ii)
 
void SetYaw (double yaw)
 
const FGMatrix33Transform (void) const
 
void UpdateCustomTransformMatrix (void)
 
- Public Member Functions inherited from FGJSBBase
 FGJSBBase ()
 Constructor for FGJSBBase.
 
virtual ~FGJSBBase ()
 Destructor for FGJSBBase.
 
void PutMessage (const Message &msg)
 Places a Message structure on the Message queue. More...
 
void PutMessage (const std::string &text)
 Creates a message with the given text and places it on the queue. More...
 
void PutMessage (const std::string &text, bool bVal)
 Creates a message with the given text and boolean value and places it on the queue. More...
 
void PutMessage (const std::string &text, int iVal)
 Creates a message with the given text and integer value and places it on the queue. More...
 
void PutMessage (const std::string &text, double dVal)
 Creates a message with the given text and double value and places it on the queue. More...
 
int SomeMessages (void) const
 Reads the message on the queue (but does not delete it). More...
 
void ProcessMessage (void)
 Reads the message on the queue and removes it from the queue. More...
 
MessageProcessNextMessage (void)
 Reads the next message on the queue and removes it from the queue. More...
 
void disableHighLighting (void)
 Disables highlighting in the console output.
 

Additional Inherited Members

- Public Types inherited from FGThruster
enum  eType { ttNozzle, ttRotor, ttPropeller, ttDirect }
 
- Public Types inherited from FGForce
enum  TransformType { tNone, tWindBody, tLocalBody, tCustom }
 
- Public Types inherited from FGJSBBase
enum  { eL = 1, eM, eN }
 Moments L, M, N.
 
enum  { eP = 1, eQ, eR }
 Rates P, Q, R.
 
enum  { eU = 1, eV, eW }
 Velocities U, V, W.
 
enum  { eX = 1, eY, eZ }
 Positions X, Y, Z.
 
enum  { ePhi = 1, eTht, ePsi }
 Euler angles Phi, Theta, Psi.
 
enum  { eDrag = 1, eSide, eLift }
 Stability axis forces, Drag, Side force, Lift.
 
enum  { eRoll = 1, ePitch, eYaw }
 Local frame orientation Roll, Pitch, Yaw.
 
enum  { eNorth = 1, eEast, eDown }
 Local frame position North, East, Down.
 
enum  { eLat = 1, eLong, eRad }
 Locations Radius, Latitude, Longitude.
 
enum  {
  inNone = 0, inDegrees, inRadians, inMeters,
  inFeet
}
 Conversion specifiers.
 
- Static Public Member Functions inherited from FGJSBBase
static const std::string & GetVersion (void)
 Returns the version number of JSBSim. More...
 
static constexpr double KelvinToFahrenheit (double kelvin)
 Converts from degrees Kelvin to degrees Fahrenheit. More...
 
static constexpr double CelsiusToRankine (double celsius)
 Converts from degrees Celsius to degrees Rankine. More...
 
static constexpr double RankineToCelsius (double rankine)
 Converts from degrees Rankine to degrees Celsius. More...
 
static constexpr double KelvinToRankine (double kelvin)
 Converts from degrees Kelvin to degrees Rankine. More...
 
static constexpr double RankineToKelvin (double rankine)
 Converts from degrees Rankine to degrees Kelvin. More...
 
static constexpr double FahrenheitToCelsius (double fahrenheit)
 Converts from degrees Fahrenheit to degrees Celsius. More...
 
static constexpr double CelsiusToFahrenheit (double celsius)
 Converts from degrees Celsius to degrees Fahrenheit. More...
 
static constexpr double CelsiusToKelvin (double celsius)
 Converts from degrees Celsius to degrees Kelvin. More...
 
static constexpr double KelvinToCelsius (double kelvin)
 Converts from degrees Kelvin to degrees Celsius. More...
 
static constexpr double FeetToMeters (double measure)
 Converts from feet to meters. More...
 
static double PitotTotalPressure (double mach, double p)
 Compute the total pressure in front of the Pitot tube. More...
 
static double MachFromImpactPressure (double qc, double p)
 Compute the Mach number from the differential pressure (qc) and the static pressure. More...
 
static double VcalibratedFromMach (double mach, double p)
 Calculate the calibrated airspeed from the Mach number. More...
 
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). More...
 
static bool EqualToRoundoff (double a, double b)
 Finite precision comparison. More...
 
static bool EqualToRoundoff (float a, float b)
 Finite precision comparison. More...
 
static bool EqualToRoundoff (float a, double b)
 Finite precision comparison. More...
 
static bool EqualToRoundoff (double a, float b)
 Finite precision comparison. More...
 
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)
 
- Public Attributes inherited from FGThruster
struct JSBSim::FGThruster::Inputs in
 
- 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
 
- Static Protected Member Functions inherited from FGJSBBase
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
- Protected Attributes inherited from FGThruster
int EngineNum
 
double GearRatio
 
std::string Name
 
double PowerRequired
 
double ReverserAngle
 
double Thrust
 
double ThrustCoeff
 
eType Type
 
- Protected Attributes inherited from FGForce
FGFDMExecfdmex
 
FGMassBalanceMassBalance
 
FGMatrix33 mT
 
TransformType ttype
 
FGColumnVector3 vActingXYZn
 
FGColumnVector3 vFn
 
FGColumnVector3 vMn
 
FGColumnVector3 vOrient
 
FGColumnVector3 vXYZn
 
- Static Protected Attributes inherited from FGJSBBase
static Message localMsg
 
static std::queue< MessageMessages
 
static unsigned int messageId = 0
 
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 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. More...
 
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
 

Constructor & Destructor Documentation

◆ FGRotor()

FGRotor ( FGFDMExec exec,
Element rotor_element,
int  num 
)

Constructor for FGRotor.

Parameters
execa pointer to the main executive object
rotor_elementa pointer to the thruster config file XML element
numthe number of this rotor

Definition at line 74 of file FGRotor.cpp.

75  : FGThruster(exec, rotor_element, num),
76  rho(0.002356), // environment
77  Radius(0.0), BladeNum(0), // configuration parameters
78  Sense(1.0), NominalRPM(0.0), MinimalRPM(0.0), MaximalRPM(0.0),
79  ExternalRPM(0), RPMdefinition(0), ExtRPMsource(NULL), SourceGearRatio(1.0),
80  BladeChord(0.0), LiftCurveSlope(0.0), BladeTwist(0.0), HingeOffset(0.0),
81  BladeFlappingMoment(0.0), BladeMassMoment(0.0), PolarMoment(0.0),
82  InflowLag(0.0), TipLossB(0.0),
83  GroundEffectExp(0.0), GroundEffectShift(0.0), GroundEffectScaleNorm(1.0),
84  LockNumberByRho(0.0), Solidity(0.0), // derived parameters
85  RPM(0.0), Omega(0.0), // dynamic values
86  beta_orient(0.0),
87  a0(0.0), a_1(0.0), b_1(0.0), a_dw(0.0),
88  a1s(0.0), b1s(0.0),
89  H_drag(0.0), J_side(0.0), Torque(0.0), C_T(0.0),
90  lambda(-0.001), mu(0.0), nu(0.001), v_induced(0.0),
91  theta_downwash(0.0), phi_downwash(0.0),
92  ControlMap(eMainCtrl), // control
93  CollectiveCtrl(0.0), LateralCtrl(0.0), LongitudinalCtrl(0.0),
94  Transmission(NULL), // interaction with engine
95  EngineRPM(0.0), MaxBrakePower(0.0), GearLoss(0.0), GearMoment(0.0)
96 {
97  FGColumnVector3 location(0.0, 0.0, 0.0), orientation(0.0, 0.0, 0.0);
98  Element *thruster_element;
99  double engine_power_est = 0.0;
100 
101  // initialise/set remaining variables
102  SetTransformType(FGForce::tCustom);
103  Type = ttRotor;
104  GearRatio = 1.0;
105 
106  dt = exec->GetDeltaT();
107  for (int i=0; i<5; i++) R[i] = 0.0;
108  for (int i=0; i<5; i++) B[i] = 0.0;
109 
110  // get positions
111  thruster_element = rotor_element->GetParent()->FindElement("sense");
112  if (thruster_element) {
113  double s = thruster_element->GetDataAsNumber();
114  if (s < -0.1) {
115  Sense = -1.0; // 'CW' as seen from above
116  } else if (s < 0.1) {
117  Sense = 0.0; // 'coaxial'
118  } else {
119  Sense = 1.0; // 'CCW' as seen from above
120  }
121  }
122 
123  thruster_element = rotor_element->GetParent()->FindElement("location");
124  if (thruster_element) {
125  location = thruster_element->FindElementTripletConvertTo("IN");
126  } else {
127  cerr << "No thruster location found." << endl;
128  }
129 
130  thruster_element = rotor_element->GetParent()->FindElement("orient");
131  if (thruster_element) {
132  orientation = thruster_element->FindElementTripletConvertTo("RAD");
133  } else {
134  cerr << "No thruster orientation found." << endl;
135  }
136 
137  SetLocation(location);
138  SetAnglesToBody(orientation);
139  InvTransform = Transform().Transposed(); // body to custom/native
140 
141  // wire controls
142  ControlMap = eMainCtrl;
143  if (rotor_element->FindElement("controlmap")) {
144  string cm = rotor_element->FindElementValue("controlmap");
145  cm = to_upper(cm);
146  if (cm == "TAIL") {
147  ControlMap = eTailCtrl;
148  } else if (cm == "TANDEM") {
149  ControlMap = eTandemCtrl;
150  } else {
151  cerr << "# found unknown controlmap: '" << cm << "' using main rotor config." << endl;
152  }
153  }
154 
155  // ExternalRPM -- is the RPM dictated ?
156  if (rotor_element->FindElement("ExternalRPM")) {
157  ExternalRPM = 1;
158  SourceGearRatio = 1.0;
159  RPMdefinition = (int) rotor_element->FindElementValueAsNumber("ExternalRPM");
160  int rdef = RPMdefinition;
161  if (RPMdefinition>=0) {
162  // avoid ourself and (still) unknown engines.
163  if (!exec->GetPropulsion()->GetEngine(RPMdefinition) || RPMdefinition==num) {
164  RPMdefinition = -1;
165  } else {
166  FGThruster *tr = exec->GetPropulsion()->GetEngine(RPMdefinition)->GetThruster();
167  SourceGearRatio = tr->GetGearRatio();
168  // cout << "# got sources' GearRatio: " << SourceGearRatio << endl;
169  }
170  }
171  if (RPMdefinition != rdef) {
172  cerr << "# discarded given RPM source (" << rdef << ") and switched to external control (-1)." << endl;
173  }
174  }
175 
176  // process rotor parameters
177  engine_power_est = Configure(rotor_element);
178 
179  // setup transmission if needed
180  if (!ExternalRPM) {
181 
182  Transmission = new FGTransmission(exec, num, dt);
183 
184  Transmission->SetThrusterMoment(PolarMoment);
185 
186  // The MOI sensed behind the gear ( MOI_engine*sqr(GearRatio) ).
187  GearMoment = ConfigValueConv(rotor_element, "gearmoment", 0.1*PolarMoment, "SLUG*FT2");
188  GearMoment = Constrain(1e-6, GearMoment, 1e9);
189  Transmission->SetEngineMoment(GearMoment);
190 
191  Transmission->SetMaxBrakePower(MaxBrakePower);
192 
193  GearLoss = ConfigValueConv(rotor_element, "gearloss", 0.0025 * engine_power_est, "HP");
194  GearLoss = Constrain(0.0, GearLoss, 1e9);
195  GearLoss *= hptoftlbssec;
196  Transmission->SetEngineFriction(GearLoss);
197 
198  }
199 
200  // shaft representation - a rather simple transform,
201  // but using a matrix is safer.
202  TboToHsr = { 0.0, 0.0, 1.0,
203  0.0, 1.0, 0.0,
204  -1.0, 0.0, 0.0 };
205  HsrToTbo = TboToHsr.Transposed();
206 
207  // smooth out jumps in hagl reported, otherwise the ground effect
208  // calculation would cause jumps too. 1Hz seems sufficient.
209  damp_hagl = Filter(1.0, dt);
210 
211  // enable import-export
212  bindmodel(exec->GetPropertyManager());
213 
214  Debug(0);
215 
216 } // Constructor
+ Here is the call graph for this function:

The documentation for this class was generated from the following files:
JSBSim::FGMatrix33::Transposed
FGMatrix33 Transposed(void) const
Transposed matrix.
Definition: FGMatrix33.h:221
JSBSim::FGJSBBase::Constrain
static constexpr double Constrain(double min, double value, double max)
Constrain a value between a minimum and a maximum value.
Definition: FGJSBBase.h:333
JSBSim::FGThruster::FGThruster
FGThruster(FGFDMExec *FDMExec, Element *el, int num)
Constructor.
Definition: FGThruster.cpp:55