 |
JSBSim Flight Dynamics Model 1.2.3 (07 Jun 2025)
An Open Source Flight Dynamics and Control Software Library in C++
|
|
JSBSim Flight Dynamics Model 1.2.3 (07 Jun 2025)
An Open Source Flight Dynamics and Control Software Library in C++
|
#include <FGMars.h>
Inheritance diagram for FGMars: Collaboration diagram for FGMars:Public Member Functions | |
| FGMars (FGFDMExec *) | |
| Constructor. | |
| Public Member Functions inherited from FGAtmosphere | |
| FGAtmosphere (FGFDMExec *) | |
| Constructor. | |
| virtual | ~FGAtmosphere () |
| Destructor. | |
| bool | InitModel (void) override |
| bool | Run (bool Holding) override |
| Runs the atmosphere forces model; called by the Executive. | |
| virtual double | GetTemperature () const |
| Returns the actual, modeled temperature at the current altitude in degrees Rankine. | |
| virtual double | GetTemperature (double altitude) const =0 |
| Returns the actual modeled temperature in degrees Rankine at a specified altitude. | |
| virtual double | GetTemperatureSL () const |
| Returns the actual, modeled sea level temperature in degrees Rankine. | |
| virtual double | GetTemperatureRatio () const |
| Returns the ratio of the at-current-altitude temperature as modeled over the sea level value. | |
| virtual double | GetTemperatureRatio (double h) const |
| Returns the ratio of the temperature as modeled at the supplied altitude over the sea level value. | |
| virtual void | SetTemperatureSL (double t, eTemperature unit=eFahrenheit) |
| Sets the Sea Level temperature. | |
| virtual void | SetTemperature (double t, double h, eTemperature unit=eFahrenheit)=0 |
| Sets the temperature at the supplied altitude. | |
| virtual double | GetPressure (void) const |
| Returns the pressure in psf. | |
| virtual double | GetPressure (double altitude) const =0 |
| Returns the pressure at a specified altitude in psf. | |
| virtual double | GetPressureSL (ePressure to=ePSF) const |
| virtual double | GetPressureRatio (void) const |
| Returns the ratio of at-altitude pressure over the sea level value. | |
| virtual void | SetPressureSL (ePressure unit, double pressure) |
| Sets the sea level pressure for modeling. | |
| virtual double | GetDensity (void) const |
| Returns the density in slugs/ft^3. | |
| virtual double | GetDensity (double altitude) const |
| Returns the density in slugs/ft^3 at a given altitude in ft. | |
| virtual double | GetDensitySL (void) const |
| Returns the sea level density in slugs/ft^3. | |
| virtual double | GetDensityRatio (void) const |
| Returns the ratio of at-altitude density over the sea level value. | |
| virtual double | GetSoundSpeed (void) const |
| Returns the speed of sound in ft/sec. | |
| virtual double | GetSoundSpeed (double altitude) const |
| Returns the speed of sound in ft/sec at a given altitude in ft. | |
| virtual double | GetSoundSpeedSL (void) const |
| Returns the sea level speed of sound in ft/sec. | |
| virtual double | GetSoundSpeedRatio (void) const |
| Returns the ratio of at-altitude sound speed over the sea level value. | |
| virtual double | GetAbsoluteViscosity (void) const |
| Returns the absolute viscosity. | |
| virtual double | GetKinematicViscosity (void) const |
| Returns the kinematic viscosity. | |
| virtual double | GetDensityAltitude () const |
| virtual double | GetPressureAltitude () const |
| Public Member Functions inherited from FGModel | |
| FGModel (FGFDMExec *) | |
| Constructor. | |
| ~FGModel () override | |
| Destructor. | |
| virtual SGPath | FindFullPathName (const SGPath &path) const |
| FGFDMExec * | GetExec (void) |
| const std::string & | GetName (void) |
| unsigned int | GetRate (void) |
| Get the output rate for the model in frames. | |
| bool | InitModel (void) override |
| virtual bool | Load (Element *el) |
| void | SetPropertyManager (std::shared_ptr< FGPropertyManager > fgpm) |
| void | SetRate (unsigned int tt) |
| Set the ouput rate for the model in frames. | |
| Public Member Functions inherited from FGModelFunctions | |
| 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. | |
| std::shared_ptr< FGFunction > | GetPreFunction (const std::string &name) |
| Get one of the "pre" function. | |
| bool | Load (Element *el, FGFDMExec *fdmex, std::string prefix="") |
| void | PostLoad (Element *el, FGFDMExec *fdmex, std::string prefix="") |
| void | PreLoad (Element *el, FGFDMExec *fdmex, std::string prefix="") |
| void | RunPostFunctions (void) |
| void | RunPreFunctions (void) |
| Public Member Functions inherited from FGJSBBase | |
| FGJSBBase () | |
| Constructor for FGJSBBase. | |
| virtual | ~FGJSBBase () |
| Destructor for FGJSBBase. | |
| void | disableHighLighting (void) |
| Disables highlighting in the console output. | |
Additional Inherited Members | |
| Public Types inherited from FGAtmosphere | |
| enum | ePressure { eNoPressUnit =0 , ePSF , eMillibars , ePascals , eInchesHg } |
| Enums for specifying pressure units. More... | |
| enum | eTemperature { eNoTempUnit =0 , eFahrenheit , eCelsius , eRankine , eKelvin } |
| Enums for specifying temperature units. More... | |
| Public Types inherited from 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 Public Member Functions inherited from FGJSBBase | |
| 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 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) |
| Public Attributes inherited from FGAtmosphere | |
| struct JSBSim::FGAtmosphere::Inputs | in |
| const double | StdDaySLsoundspeed |
| Static Public Attributes inherited from FGAtmosphere | |
| static constexpr double | StdDaySLtemperature = 518.67 |
| static constexpr double | StdDaySLpressure = 2116.228 |
| static constexpr double | SHRatio = 1.4 |
| static constexpr double | StdDaySLdensity = StdDaySLpressure / (Reng0 * StdDaySLtemperature) |
| 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 |
| Protected Member Functions inherited from FGAtmosphere | |
| virtual double | CalculateDensityAltitude (double density, double geometricAlt) |
| Calculates the density altitude given any temperature or pressure bias. | |
| virtual double | CalculatePressureAltitude (double pressure, double geometricAlt) |
| Calculates the pressure altitude given any temperature or pressure bias. | |
| double | ConvertToRankine (double t, eTemperature unit) const |
| Converts to Rankine from one of several unit systems. | |
| double | ConvertFromRankine (double t, eTemperature unit) const |
| Converts from Rankine to one of several unit systems. | |
| double | ConvertToPSF (double t, ePressure unit=ePSF) const |
| Converts to PSF (pounds per square foot) from one of several unit systems. | |
| double | ConvertFromPSF (double t, ePressure unit=ePSF) const |
| Converts from PSF (pounds per square foot) to one of several unit systems. | |
| double | ValidatePressure (double p, const std::string &msg, bool quiet=false) const |
| Check that the pressure is within plausible boundaries. | |
| double | ValidateTemperature (double t, const std::string &msg, bool quiet=false) const |
| Check that the temperature is within plausible boundaries. | |
| virtual void | bind (void) |
| Protected Member Functions inherited from FGModel | |
| bool | Upload (Element *el, bool preLoad) |
| Uploads this model in memory. | |
| Static Protected Member Functions inherited from FGJSBBase | |
| static std::string | CreateIndexedPropertyName (const std::string &Property, int index) |
| Protected Attributes inherited from FGAtmosphere | |
| double | SLtemperature = 1.8 |
| double | SLdensity = 1.0 |
| double | SLpressure = 1.0 |
| double | SLsoundspeed = 1.0 |
| double | Temperature = 1.8 |
| double | Density = 0.0 |
| double | Pressure = 0.0 |
| double | Soundspeed = 0.0 |
| double | PressureAltitude = 0.0 |
| double | DensityAltitude = 0.0 |
| double | Viscosity = 0.0 |
| double | KinematicViscosity = 0.0 |
| double | Reng = Reng0 |
| Protected Attributes inherited from FGModel | |
| unsigned int | exe_ctr |
| FGFDMExec * | FDMExec |
| std::string | Name |
| std::shared_ptr< FGPropertyManager > | PropertyManager |
| unsigned int | rate |
| Protected Attributes inherited from FGModelFunctions | |
| FGPropertyReader | LocalProperties |
| std::vector< std::shared_ptr< FGFunction > > | PostFunctions |
| std::vector< std::shared_ptr< FGFunction > > | PreFunctions |
| Static Protected Attributes inherited from FGAtmosphere | |
| static constexpr double | SutherlandConstant = 198.72 |
| static constexpr double | Beta = 2.269690E-08 |
| static constexpr double | Rstar = 8.31432 * kgtoslug / KelvinToRankine(fttom * fttom) |
| Universal gas constant - ft*lbf/R/mol. | |
| static constexpr double | Mair = 28.9645 * kgtoslug / 1000.0 |
| Mean molecular weight for air - slug/mol. | |
| static constexpr double | g0 = 9.80665 / fttom |
| Sea-level acceleration of gravity - ft/s^2. | |
| static constexpr double | Reng0 = Rstar / Mair |
| Specific gas constant for air - ft*lbf/slug/R. | |
| Static Protected Attributes inherited from FGJSBBase | |
| 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 | fttom = 0.3048 |
| static constexpr double | ktstofps = 1852./(3600*fttom) |
| static constexpr double | fpstokts = 1.0 / ktstofps |
| static constexpr double | inchtoft = 1.0/12.0 |
| 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__ |
Constructor.
Definition at line 56 of file FGMars.cpp.
1.9.8 
