FlightGear next
JSBSim::FGWinds Class Reference

Models atmospheric disturbances: winds, gusts, turbulence, downbursts, etc. More...

#include <FGWinds.h>

Inherits JSBSim::FGModel.

Classes

struct  Inputs
 
struct  OneMinusCosineGust
 Stores the information about a single one minus cosine gust instance. More...
 
struct  OneMinusCosineProfile
 
struct  UpDownBurst
 Stores information about a specified Up- or Down-burst. More...
 

Public Types

enum  tType {
  ttNone , ttStandard , ttCulp , ttMilspec ,
  ttTustin
}
 
enum  eGustFrame { gfNone =0 , gfBody , gfWind , gfLocal }
 
- 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

 FGWinds (FGFDMExec *)
 Constructor.
 
 ~FGWinds ()
 Destructor.
 
bool Run (bool Holding) override
 Runs the winds model; called by the Executive Can pass in a value indicating if the executive is directing the simulation to Hold.
 
bool InitModel (void) override
 
virtual const FGColumnVector3GetTotalWindNED (void) const
 Retrieves the total wind components in NED frame.
 
virtual double GetTotalWindNED (int idx) const
 Retrieves a total wind component in NED frame.
 
virtual void SetWindNED (double wN, double wE, double wD)
 Sets the wind components in NED frame.
 
virtual void SetWindNED (int idx, double wind)
 Sets a wind component in NED frame.
 
virtual void SetWindNED (const FGColumnVector3 &wind)
 Sets the wind components in NED frame.
 
virtual const FGColumnVector3GetWindNED (void) const
 Retrieves the wind components in NED frame.
 
virtual double GetWindNED (int idx) const
 Retrieves a wind component in NED frame.
 
virtual double GetWindPsi (void) const
 Retrieves the direction that the wind is coming from.
 
virtual void SetWindPsi (double dir)
 Sets the direction that the wind is coming from.
 
virtual void SetWindspeed (double speed)
 
virtual double GetWindspeed (void) const
 
virtual void SetGustNED (int idx, double gust)
 Sets a gust component in NED frame.
 
virtual void SetTurbNED (int idx, double turb)
 Sets a turbulence component in NED frame.
 
virtual void SetGustNED (double gN, double gE, double gD)
 Sets the gust components in NED frame.
 
virtual double GetGustNED (int idx) const
 Retrieves a gust component in NED frame.
 
virtual double GetTurbNED (int idx) const
 Retrieves a turbulence component in NED frame.
 
virtual const FGColumnVector3GetGustNED (void) const
 Retrieves the gust components in NED frame.
 
virtual void SetTurbType (tType tt)
 Turbulence models available: ttNone, ttStandard, ttBerndt, ttCulp, ttMilspec, ttTustin.
 
virtual tType GetTurbType () const
 
virtual void SetTurbGain (double tg)
 
virtual double GetTurbGain () const
 
virtual void SetTurbRate (double tr)
 
virtual double GetTurbRate () const
 
virtual void SetRhythmicity (double r)
 
virtual double GetRhythmicity () const
 
virtual double GetTurbPQR (int idx) const
 
virtual double GetTurbMagnitude (void) const
 
virtual double GetTurbDirection (void) const
 
virtual const FGColumnVector3GetTurbPQR (void) const
 
virtual void SetWindspeed20ft (double ws)
 
virtual double GetWindspeed20ft () const
 
virtual void SetProbabilityOfExceedence (int idx)
 allowable range: 0-7, 3=light, 4=moderate, 6=severe turbulence
 
virtual int GetProbabilityOfExceedence () const
 
virtual void StartGust (bool running)
 Initiates the execution of the gust.
 
virtual void StartupGustDuration (double dur)
 Specifies the duration of the startup portion of the gust.
 
virtual void SteadyGustDuration (double dur)
 Specifies the length of time that the gust is at a steady, full strength.
 
virtual void EndGustDuration (double dur)
 Specifies the length of time it takes for the gust to return to zero velocity.
 
virtual void GustMagnitude (double mag)
 Specifies the magnitude of the gust in feet/second.
 
virtual void GustFrame (eGustFrame gFrame)
 Specifies the frame that the gust direction vector components are specified in.
 
virtual void GustXComponent (double x)
 Specifies the X component of velocity in the specified gust frame (ft/sec).
 
virtual void GustYComponent (double y)
 Specifies the Y component of velocity in the specified gust frame (ft/sec).
 
virtual void GustZComponent (double z)
 Specifies the Z component of velocity in the specified gust frame (ft/sec).
 
void NumberOfUpDownburstCells (int num)
 
- 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.
 
FGFDMExecGetExec (void)
 
void SetPropertyManager (FGPropertyManager *fgpm)
 
virtual SGPath FindFullPathName (const SGPath &path) const
 
const std::string & GetName (void)
 
virtual bool Load (Element *el)
 
- 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.
 
FGFunctionGetPreFunction (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.
 
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

enum JSBSim::FGWinds::tType turbType
 
struct JSBSim::FGWinds::Inputs in
 

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
 
- 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
 
FGFDMExecFDMExec
 
FGPropertyManagerPropertyManager
 
- Protected Attributes inherited from JSBSim::FGModelFunctions
std::vector< FGFunction * > PreFunctions
 
std::vector< FGFunction * > PostFunctions
 
FGPropertyReader LocalProperties
 
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

Models atmospheric disturbances: winds, gusts, turbulence, downbursts, etc.

Turbulence

Various turbulence models are available. They are specified via the property atmosphere/turb-type. The following models are available:

  • 0: ttNone (turbulence disabled)
  • 1: ttStandard
  • 2: ttCulp
  • 3: ttMilspec (Dryden spectrum)
  • 4: ttTustin (Dryden spectrum)

The Milspec and Tustin models are described in the Yeager report cited below. They both use a Dryden spectrum model whose parameters (scale lengths and intensities) are modelled according to MIL-F-8785C. Parameters are modelled differently for altitudes below 1000ft and above 2000ft, for altitudes in between they are interpolated linearly.

The two models differ in the implementation of the transfer functions described in the milspec.

To use one of these two models, set atmosphere/turb-type to 4 resp. 5, and specify values for atmosphere/turbulence/milspec/windspeed_at_20ft_AGL-fps and atmosphere/turbulence/milspec/severity (the latter corresponds to the probability of exceedence curves from Fig. 7 of the milspec, allowable range is 0 (disabled) to 7). atmosphere/psiw-rad is respected as well; note that you have to specify a positive wind magnitude to prevent psiw from being reset to zero.

Reference values (cf. figures 7 and 9 from the milspec):

Intensity windspeed_at_20ft_AGL-fps severity
light 25 (15 knots) 3
moderate 50 (30 knots) 4
severe 75 (45 knots) 6

Cosine Gust

A one minus cosine gust model is available. This permits a configurable, predictable gust to be input to JSBSim for testing handling and dynamics. Here is how a gust can be entered in a script:

<event name="Introduce gust">
<condition> simulation/sim-time-sec ge 10 </condition>
<set name="atmosphere/cosine-gust/startup-duration-sec" value="5"/>
<set name="atmosphere/cosine-gust/steady-duration-sec" value="1"/>
<set name="atmosphere/cosine-gust/end-duration-sec" value="5"/>
<set name="atmosphere/cosine-gust/magnitude-ft_sec" value="30"/>
<set name="atmosphere/cosine-gust/frame" value="2"/>
<set name="atmosphere/cosine-gust/X-velocity-ft_sec" value="-1"/>
<set name="atmosphere/cosine-gust/Y-velocity-ft_sec" value="0"/>
<set name="atmosphere/cosine-gust/Z-velocity-ft_sec" value="0"/>
<set name="atmosphere/cosine-gust/start" value="1"/>
<notify/>
</event>

The x, y, z velocity components are meant to define the direction vector. The vector will be normalized by the routine, so it does not need to be a unit vector.

The startup duration is the time it takes to build up to full strength (magnitude-ft_sec) from zero. Steady duration is the time the gust stays at the specified magnitude. End duration is the time it takes to dwindle to zero from the specified magnitude. The start and end transients are in a smooth cosine shape.

The frame is specified from the following enum:

enum eGustFrame {gfNone=0, gfBody, gfWind, gfLocal};

That is, if you specify the X, Y, Z gust direction vector in the body frame, frame will be "1". If the X, Y, and Z gust direction vector is in the Wind frame, use frame = 2. If you specify the gust direction vector in the local frame (N-E-D) use frame = 3. Note that an internal local frame direction vector is created based on the X, Y, Z direction vector you specify and the frame at the time the gust is begun. The direction vector is not updated after the initial creation. This is to keep the gust at the same direction independent of aircraft dynamics.

The gust is triggered when the property atmosphere/cosine-gust/start is set to 1. It can be used repeatedly - the gust resets itself after it has completed.

The cosine gust is global: it affects the whole world not just the vicinity of the aircraft.

See also
Yeager, Jessie C.: "Implementation and Testing of Turbulence Models for the F18-HARV" (pdf), NASA CR-1998-206937, 1998
MIL-F-8785C: Military Specification: Flying Qualities of Piloted Aircraft

Definition at line 166 of file FGWinds.h.

Member Enumeration Documentation

◆ eGustFrame

Enumerator
gfNone 
gfBody 
gfWind 
gfLocal 

Definition at line 291 of file FGWinds.h.

◆ tType

Enumerator
ttNone 
ttStandard 
ttCulp 
ttMilspec 
ttTustin 

Definition at line 182 of file FGWinds.h.

Constructor & Destructor Documentation

◆ FGWinds()

JSBSim::FGWinds::FGWinds ( FGFDMExec * fdmex)
explicit

Constructor.

Definition at line 74 of file FGWinds.cpp.

◆ ~FGWinds()

JSBSim::FGWinds::~FGWinds ( )

Destructor.

Definition at line 113 of file FGWinds.cpp.

Member Function Documentation

◆ EndGustDuration()

virtual void JSBSim::FGWinds::EndGustDuration ( double dur)
inlinevirtual

Specifies the length of time it takes for the gust to return to zero velocity.

Definition at line 334 of file FGWinds.h.

◆ GetGustNED() [1/2]

virtual double JSBSim::FGWinds::GetGustNED ( int idx) const
inlinevirtual

Retrieves a gust component in NED frame.

Definition at line 239 of file FGWinds.h.

◆ GetGustNED() [2/2]

virtual const FGColumnVector3 & JSBSim::FGWinds::GetGustNED ( void ) const
inlinevirtual

Retrieves the gust components in NED frame.

Definition at line 245 of file FGWinds.h.

◆ GetProbabilityOfExceedence()

virtual int JSBSim::FGWinds::GetProbabilityOfExceedence ( ) const
inlinevirtual

Definition at line 271 of file FGWinds.h.

◆ GetRhythmicity()

virtual double JSBSim::FGWinds::GetRhythmicity ( ) const
inlinevirtual

Definition at line 259 of file FGWinds.h.

◆ GetTotalWindNED() [1/2]

virtual double JSBSim::FGWinds::GetTotalWindNED ( int idx) const
inlinevirtual

Retrieves a total wind component in NED frame.

Definition at line 190 of file FGWinds.h.

◆ GetTotalWindNED() [2/2]

virtual const FGColumnVector3 & JSBSim::FGWinds::GetTotalWindNED ( void ) const
inlinevirtual

Retrieves the total wind components in NED frame.

Definition at line 187 of file FGWinds.h.

◆ GetTurbDirection()

virtual double JSBSim::FGWinds::GetTurbDirection ( void ) const
inlinevirtual

Definition at line 263 of file FGWinds.h.

◆ GetTurbGain()

virtual double JSBSim::FGWinds::GetTurbGain ( ) const
inlinevirtual

Definition at line 253 of file FGWinds.h.

◆ GetTurbMagnitude()

virtual double JSBSim::FGWinds::GetTurbMagnitude ( void ) const
inlinevirtual

Definition at line 262 of file FGWinds.h.

◆ GetTurbNED()

virtual double JSBSim::FGWinds::GetTurbNED ( int idx) const
inlinevirtual

Retrieves a turbulence component in NED frame.

Definition at line 242 of file FGWinds.h.

◆ GetTurbPQR() [1/2]

virtual double JSBSim::FGWinds::GetTurbPQR ( int idx) const
inlinevirtual

Definition at line 261 of file FGWinds.h.

◆ GetTurbPQR() [2/2]

virtual const FGColumnVector3 & JSBSim::FGWinds::GetTurbPQR ( void ) const
inlinevirtual

Definition at line 264 of file FGWinds.h.

◆ GetTurbRate()

virtual double JSBSim::FGWinds::GetTurbRate ( ) const
inlinevirtual

Definition at line 256 of file FGWinds.h.

◆ GetTurbType()

virtual tType JSBSim::FGWinds::GetTurbType ( ) const
inlinevirtual

Definition at line 250 of file FGWinds.h.

◆ GetWindNED() [1/2]

virtual double JSBSim::FGWinds::GetWindNED ( int idx) const
inlinevirtual

Retrieves a wind component in NED frame.

Definition at line 207 of file FGWinds.h.

◆ GetWindNED() [2/2]

virtual const FGColumnVector3 & JSBSim::FGWinds::GetWindNED ( void ) const
inlinevirtual

Retrieves the wind components in NED frame.

Definition at line 204 of file FGWinds.h.

◆ GetWindPsi()

virtual double JSBSim::FGWinds::GetWindPsi ( void ) const
inlinevirtual

Retrieves the direction that the wind is coming from.

The direction is defined as north=0 and increases counterclockwise. The wind heading is returned in radians.

Definition at line 212 of file FGWinds.h.

◆ GetWindspeed()

double JSBSim::FGWinds::GetWindspeed ( void ) const
virtual

Definition at line 175 of file FGWinds.cpp.

◆ GetWindspeed20ft()

virtual double JSBSim::FGWinds::GetWindspeed20ft ( ) const
inlinevirtual

Definition at line 267 of file FGWinds.h.

◆ GustFrame()

virtual void JSBSim::FGWinds::GustFrame ( eGustFrame gFrame)
inlinevirtual

Specifies the frame that the gust direction vector components are specified in.

The body frame is defined with the X direction forward, and the Y direction positive out the right wing. The wind frame is defined with the X axis pointing into the velocity vector, the Z axis perpendicular to the X axis, in the aircraft XZ plane, and the Y axis completing the system. The local axis is a navigational frame with X pointing north, Y pointing east, and Z pointing down. This is a locally vertical, locally horizontal frame, with the XY plane tangent to the geocentric surface.

Definition at line 344 of file FGWinds.h.

◆ GustMagnitude()

virtual void JSBSim::FGWinds::GustMagnitude ( double mag)
inlinevirtual

Specifies the magnitude of the gust in feet/second.

Definition at line 336 of file FGWinds.h.

◆ GustXComponent()

virtual void JSBSim::FGWinds::GustXComponent ( double x)
inlinevirtual

Specifies the X component of velocity in the specified gust frame (ft/sec).

Definition at line 346 of file FGWinds.h.

◆ GustYComponent()

virtual void JSBSim::FGWinds::GustYComponent ( double y)
inlinevirtual

Specifies the Y component of velocity in the specified gust frame (ft/sec).

Definition at line 348 of file FGWinds.h.

◆ GustZComponent()

virtual void JSBSim::FGWinds::GustZComponent ( double z)
inlinevirtual

Specifies the Z component of velocity in the specified gust frame (ft/sec).

Definition at line 350 of file FGWinds.h.

◆ InitModel()

bool JSBSim::FGWinds::InitModel ( void )
overridevirtual

Reimplemented from JSBSim::FGModel.

Definition at line 121 of file FGWinds.cpp.

◆ NumberOfUpDownburstCells()

void JSBSim::FGWinds::NumberOfUpDownburstCells ( int num)

Definition at line 448 of file FGWinds.cpp.

◆ Run()

bool JSBSim::FGWinds::Run ( bool Holding)
overridevirtual

Runs the winds model; called by the Executive Can pass in a value indicating if the executive is directing the simulation to Hold.

Parameters
Holdingif 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 139 of file FGWinds.cpp.

◆ SetGustNED() [1/2]

virtual void JSBSim::FGWinds::SetGustNED ( double gN,
double gE,
double gD )
inlinevirtual

Sets the gust components in NED frame.

Definition at line 236 of file FGWinds.h.

◆ SetGustNED() [2/2]

virtual void JSBSim::FGWinds::SetGustNED ( int idx,
double gust )
inlinevirtual

Sets a gust component in NED frame.

Definition at line 230 of file FGWinds.h.

◆ SetProbabilityOfExceedence()

virtual void JSBSim::FGWinds::SetProbabilityOfExceedence ( int idx)
inlinevirtual

allowable range: 0-7, 3=light, 4=moderate, 6=severe turbulence

Definition at line 270 of file FGWinds.h.

◆ SetRhythmicity()

virtual void JSBSim::FGWinds::SetRhythmicity ( double r)
inlinevirtual

Definition at line 258 of file FGWinds.h.

◆ SetTurbGain()

virtual void JSBSim::FGWinds::SetTurbGain ( double tg)
inlinevirtual

Definition at line 252 of file FGWinds.h.

◆ SetTurbNED()

virtual void JSBSim::FGWinds::SetTurbNED ( int idx,
double turb )
inlinevirtual

Sets a turbulence component in NED frame.

Definition at line 233 of file FGWinds.h.

◆ SetTurbRate()

virtual void JSBSim::FGWinds::SetTurbRate ( double tr)
inlinevirtual

Definition at line 255 of file FGWinds.h.

◆ SetTurbType()

virtual void JSBSim::FGWinds::SetTurbType ( tType tt)
inlinevirtual

Turbulence models available: ttNone, ttStandard, ttBerndt, ttCulp, ttMilspec, ttTustin.

Definition at line 249 of file FGWinds.h.

◆ SetWindNED() [1/3]

virtual void JSBSim::FGWinds::SetWindNED ( const FGColumnVector3 & wind)
inlinevirtual

Sets the wind components in NED frame.

Definition at line 201 of file FGWinds.h.

◆ SetWindNED() [2/3]

virtual void JSBSim::FGWinds::SetWindNED ( double wN,
double wE,
double wD )
inlinevirtual

Sets the wind components in NED frame.

Definition at line 195 of file FGWinds.h.

◆ SetWindNED() [3/3]

virtual void JSBSim::FGWinds::SetWindNED ( int idx,
double wind )
inlinevirtual

Sets a wind component in NED frame.

Definition at line 198 of file FGWinds.h.

◆ SetWindPsi()

void JSBSim::FGWinds::SetWindPsi ( double dir)
virtual

Sets the direction that the wind is coming from.

The direction is defined as north=0 and increases counterclockwise to 2*pi (radians). The vertical component of wind is assumed to be zero - and is forcibly set to zero. This function sets the vWindNED vector components based on the supplied direction. The magnitude of the wind set in the vector is preserved (assuming the vertical component is non-zero).

Parameters
dirwind direction in the horizontal plane, in radians.

Definition at line 184 of file FGWinds.cpp.

◆ SetWindspeed()

void JSBSim::FGWinds::SetWindspeed ( double speed)
virtual

Definition at line 161 of file FGWinds.cpp.

◆ SetWindspeed20ft()

virtual void JSBSim::FGWinds::SetWindspeed20ft ( double ws)
inlinevirtual

Definition at line 266 of file FGWinds.h.

◆ StartGust()

virtual void JSBSim::FGWinds::StartGust ( bool running)
inlinevirtual

Initiates the execution of the gust.

Definition at line 328 of file FGWinds.h.

◆ StartupGustDuration()

virtual void JSBSim::FGWinds::StartupGustDuration ( double dur)
inlinevirtual

Specifies the duration of the startup portion of the gust.

Definition at line 330 of file FGWinds.h.

◆ SteadyGustDuration()

virtual void JSBSim::FGWinds::SteadyGustDuration ( double dur)
inlinevirtual

Specifies the length of time that the gust is at a steady, full strength.

Definition at line 332 of file FGWinds.h.

Member Data Documentation

◆ in

struct JSBSim::FGWinds::Inputs JSBSim::FGWinds::in

◆ turbType

enum JSBSim::FGWinds::tType JSBSim::FGWinds::turbType

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