Detailed Description

Models the 1976 U.S.

Standard Atmosphere, with the ability to modify the temperature and pressure. A base feature of the model is the temperature profile that is stored as an FGTable object with this data:

GeoMet Alt    Temp      GeoPot Alt  GeoMet Alt
   (ft)      (deg R)      (km)        (km)
 ---------  --------    ----------  ----------
       0.0    518.67 //    0.000       0.000
   36151.6    390.0  //   11.000      11.019
   65823.5    390.0  //   20.000      20.063
  105518.4    411.6  //   32.000      32.162
  155347.8    487.2  //   47.000      47.350
  168677.8    487.2  //   51.000      51.413
  235570.9    386.4  //   71.000      71.802
  282152.2    336.5; //   84.852      86.000

The pressure is calculated at lower altitudes through the use of two equations that are presented in the U.S. Standard Atmosphere document (see references). Density, kinematic viscosity, speed of sound, etc., are all calculated based on various constants and temperature and pressure. At higher altitudes (above 86 km (282152 ft) a different and more complicated method of calculating pressure is used.

The temperature may be modified through the use of several methods. Ultimately, these access methods allow the user to modify the sea level standard temperature, and/or the sea level standard pressure, so that the entire profile will be consistently and accurately calculated.

Properties

atmosphere/delta-T
atmosphere/T-sl-dev-F

Author: Jon Berndt

See also: "U.S. Standard Atmosphere, 1976", NASA TM-X-74335

Definition at line 98 of file FGStandardAtmosphere.h.

#include <FGStandardAtmosphere.h>

Inheritance diagram for FGStandardAtmosphere:

Collaboration diagram for FGStandardAtmosphere:

Public Member Functions
	FGStandardAtmosphere (FGFDMExec *)
	Constructor.

virtual	~FGStandardAtmosphere ()
	Destructor.

bool	InitModel (void) override

Temperature access functions.
There are several ways to get the temperature, and several modeled temperature values that can be retrieved. The U.S. Standard Atmosphere temperature either at a specified altitude, or at sea level can be retrieved. These two temperatures do NOT include the effects of any bias or delta gradient that may have been supplied by the user. The modeled temperature and the modeled temperature at sea level can also be retrieved. These two temperatures DO include the effects of an optionally user-supplied bias or delta gradient.
double	GetTemperature (double altitude) const override
	Returns the actual modeled temperature in degrees Rankine at a specified altitude.

virtual double	GetStdTemperature (double altitude) const
	Returns the standard temperature in degrees Rankine at a specified altitude.

virtual double	GetStdTemperatureSL () const
	Returns the standard sea level temperature in degrees Rankine.

virtual double	GetStdTemperatureRatio (double h) const
	Returns the ratio of the standard temperature at the supplied altitude over the standard sea level temperature.

virtual double	GetTemperatureBias (eTemperature to) const
	Returns the temperature bias over the sea level value in degrees Rankine.

virtual double	GetTemperatureDeltaGradient (eTemperature to)
	Returns the temperature gradient to be applied on top of the standard temperature gradient.

void	SetTemperatureSL (double t, eTemperature unit=eFahrenheit) override
	Sets the Sea Level temperature, if it is to be different than the standard.

void	SetTemperature (double t, double h, eTemperature unit=eFahrenheit) override
	Sets the temperature at the supplied altitude, if it is to be different than the standard temperature.

virtual void	SetTemperatureBias (eTemperature unit, double t)
	Sets the temperature bias to be added to the standard temperature at all altitudes.

virtual void	SetSLTemperatureGradedDelta (eTemperature unit, double t)
	Sets a Sea Level temperature delta that is ramped out by 86 km.

virtual void	SetTemperatureGradedDelta (double t, double h, eTemperature unit=eFahrenheit)
	Sets the temperature delta value at the supplied altitude/elevation above sea level, to be added to the standard temperature and ramped out by 86 km.

virtual void	ResetSLTemperature ()
	This function resets the model to apply no bias or delta gradient to the temperature.

Pressure access functions.
double	GetPressure (double altitude) const override
	Returns the pressure at a specified altitude in psf.

virtual double	GetStdPressure (double altitude) const
	Returns the standard pressure at the specified altitude.

void	SetPressureSL (ePressure unit, double pressure) override
	Sets the sea level pressure for modeling an off-standard pressure profile.

virtual void	ResetSLPressure ()
	Resets the sea level to the Standard sea level pressure, and recalculates dependent parameters so that the pressure calculations are standard.

Density access functions.
virtual double	GetStdDensity (double altitude) const
	Returns the standard density at a specified altitude.

Public Member Functions inherited from FGAtmosphere
	FGAtmosphere (FGFDMExec *)
	Constructor.

virtual	~FGAtmosphere ()
	Destructor.

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	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 double	GetPressure (void) const
	Returns the pressure 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 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.

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.

Humidity access functions
double	StdSLtemperature
	Standard sea level conditions.

double	StdSLdensity

double	StdSLpressure

double	StdSLsoundspeed

double	TemperatureBias

double	TemperatureDeltaGradient

double	GradientFadeoutAltitude

double	VaporMassFraction

double	SaturatedVaporPressure

FGTable	StdAtmosTemperatureTable

FGTable	MaxVaporMassFraction

std::vector< double >	LapseRates

std::vector< double >	PressureBreakpoints

std::vector< double >	StdPressureBreakpoints

std::vector< double >	StdDensityBreakpoints

std::vector< double >	StdLapseRates

static constexpr double	EarthRadius = 6356766.0 / fttom
	Earth radius in ft as defined for ISA 1976.

static constexpr double	a = 611.2/psftopa
	Sonntag constants based on ref [2].

static constexpr double	b = 17.62

static constexpr double	c = 243.12

static constexpr double	Mwater = 18.016 * kgtoslug / 1000.0
	Mean molecular weight for water - slug/mol.

static constexpr double	Rdry = Rstar / Mair

static constexpr double	Rwater = Rstar / Mwater

void	SetDewPoint (eTemperature unit, double dewpoint)
	Sets the dew point.

double	GetDewPoint (eTemperature to) const
	Returns the dew point.

void	SetVaporPressure (ePressure unit, double Pv)
	Sets the partial pressure of water vapor.

double	GetVaporPressure (ePressure to) const
	Returns the partial pressure of water vapor.

double	GetSaturatedVaporPressure (ePressure to) const
	Returns the saturated pressure of water vapor.

void	SetRelativeHumidity (double RH)
	Sets the relative humidity.

double	GetRelativeHumidity (void) const
	Returns the relative humidity in percent.

void	SetVaporMassFractionPPM (double frac)
	Sets the vapor mass per million of dry air mass units.

double	GetVaporMassFractionPPM (void) const
	Returns the vapor mass per million of dry air mass units (ppm).

virtual void	PrintStandardAtmosphereTable ()
	Prints the U.S. Standard Atmosphere table.

void	Calculate (double altitude) override
	Calculate the atmosphere for the given altitude.

void	CalculateLapseRates ()
	Recalculate the lapse rate vectors when the temperature profile is altered in a way that would change the lapse rates, such as when a gradient is applied.

void	CalculatePressureBreakpoints (double SLpress)
	Calculate (or recalculate) the atmospheric pressure breakpoints at the altitudes in the standard temperature table.

void	CalculateStdDensityBreakpoints ()
	Calculate the atmospheric density breakpoints at the altitudes in the standard temperature table.

double	GeopotentialAltitude (double geometalt) const
	Convert a geometric altitude to a geopotential altitude.

double	GeometricAltitude (double geopotalt) const
	Convert a geopotential altitude to a geometric altitude.

double	CalculateDensityAltitude (double density, double geometricAlt) override
	Calculates the density altitude given any temperature or pressure bias.

double	CalculatePressureAltitude (double pressure, double geometricAlt) override
	Calculates the pressure altitude given any temperature or pressure bias.

double	CalculateVaporPressure (double temperature)
	Calculate the pressure of water vapor with the Magnus formula.

void	ValidateVaporMassFraction (double geometricAlt)
	Validate the value of the vapor mass fraction.

void	CalculateSLDensity (void)
	Calculate the SL density.

void	CalculateSLSoundSpeedAndDensity (void)
	Calculate the SL density and sound speed.

void	bind (void) override

void	Debug (int from) override

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
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.

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/(fttomfttomfttom)

static constexpr double	in3tom3 = inchtoftinchtoftinchtoft/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 & Destructor Documentation

◆ FGStandardAtmosphere()

FGStandardAtmosphere ( FGFDMExec * fdmex )

Constructor.

Definition at line 61 of file FGStandardAtmosphere.cpp.

  : FGAtmosphere(fdmex), StdSLpressure(StdDaySLpressure), TemperatureBias(0.0),
    TemperatureDeltaGradient(0.0), VaporMassFraction(0.0),
    SaturatedVaporPressure(StdDaySLpressure), StdAtmosTemperatureTable(9),
    MaxVaporMassFraction(10)
{
  Name = "FGStandardAtmosphere";
 
  // This is the U.S. Standard Atmosphere table for temperature in degrees
  // Rankine, based on geometric altitude. The table values are often given
  // in literature relative to geopotential altitude. 
  //
  //                        GeoMet Alt    Temp      GeoPot Alt  GeoMet Alt
  //                           (ft)      (deg R)      (km)        (km)
  //                         --------   --------    ----------  ----------
  //StdAtmosTemperatureTable <<      0.00 << 518.67  //    0.000       0.000
  //                         <<  36151.80 << 389.97  //   11.000      11.019
  //                         <<  65823.90 << 389.97  //   20.000      20.063
  //                         << 105518.06 << 411.60  //   32.000      32.162
  //                         << 155348.07 << 487.20  //   47.000      47.350
  //                         << 168676.12 << 487.20  //   51.000      51.413
  //                         << 235570.77 << 386.40  //   71.000      71.802
  //                         << 282152.08 << 336.50  //   84.852      86.000
  //                         << 298556.40 << 336.50; //               91.000 - First layer in high altitude regime 
 
  //                            GeoPot Alt    Temp       GeoPot Alt  GeoMet Alt
  //                               (ft)      (deg R)        (km)        (km)
  //                           -----------   --------     ----------  ----------
  StdAtmosTemperatureTable <<      0.0000 << 518.67  //    0.000       0.000
                           <<  36089.2388 << 389.97  //   11.000      11.019
                           <<  65616.7979 << 389.97  //   20.000      20.063
                           << 104986.8766 << 411.57  //   32.000      32.162
                           << 154199.4751 << 487.17  //   47.000      47.350
                           << 167322.8346 << 487.17  //   51.000      51.413
                           << 232939.6325 << 386.37  //   71.000      71.802
                           << 278385.8268 << 336.5028  // 84.852      86.000
                           << 298556.4304 << 336.5028; //             91.000 - First layer in high altitude regime
 
 
  // This is the maximum water vapor mass fraction in ppm (parts per million) of
  // dry air measured in the atmosphere according to the ISA 1976 document.
  // Values at altitude below 8 km are record high. All other values are 1%
  // high.
 
  //                      Geopot Alt    Water     Geopot Alt
  //                         (ft)       (ppm)        (km)
  //                      ----------    -----     ----------
  MaxVaporMassFraction <<     0.0000 << 35000.  //  0.0000 - Record high
                       <<  3280.8399 << 31000.  //  1.0000
                       <<  6561.6798 << 28000.  //  2.0000
                       << 13123.3596 << 22000.  //  4.0000
                       << 19685.0394 <<  8900.  //  6.0000
                       << 26246.7192 <<  4700.  //  8.0000 - Record high
                       << 32808.3990 <<  1300.  // 10.0000 - 1% high
                       << 39370.0787 <<   230.  // 12.0000
                       << 45931.7585 <<    48.  // 14.0000
                       << 52493.4383 <<    38.; // 16.0000 - 1% high
 
  unsigned int numRows = StdAtmosTemperatureTable.GetNumRows();
 
  // Initialize the standard atmosphere lapse rates.
  CalculateLapseRates();
  StdLapseRates = LapseRates;
 
  // Assume the altitude to fade out the gradient at is at the highest
  // altitude in the table. Above that, other functions are used to
  // calculate temperature.
  GradientFadeoutAltitude = StdAtmosTemperatureTable(numRows, 0);
 
  // Initialize the standard atmosphere pressure break points.
  PressureBreakpoints.resize(numRows);
  CalculatePressureBreakpoints(StdSLpressure);
  StdPressureBreakpoints = PressureBreakpoints;
 
  StdSLtemperature = StdAtmosTemperatureTable(1, 1);
  StdSLdensity     = StdSLpressure / (Rdry * StdSLtemperature);
 
  CalculateStdDensityBreakpoints();
  StdSLsoundspeed = sqrt(SHRatio*Rdry*StdSLtemperature);
 
  bind();
  Debug(0);
}

Here is the call graph for this function:

◆ ~FGStandardAtmosphere()

~FGStandardAtmosphere ( )

virtual

Destructor.

Definition at line 147 of file FGStandardAtmosphere.cpp.

{
  Debug(1);
}

Member Function Documentation

◆ bind()

void bind ( void )

overrideprotectedvirtual

Reimplemented from FGAtmosphere.

Definition at line 742 of file FGStandardAtmosphere.cpp.

{
  typedef double (FGStandardAtmosphere::*PMFi)(int) const;
  typedef void (FGStandardAtmosphere::*PMF)(int, double);
  PropertyManager->Tie("atmosphere/delta-T", this, eRankine,
                                    (PMFi)&FGStandardAtmosphere::GetTemperatureBias,
                                    (PMF)&FGStandardAtmosphere::SetTemperatureBias);
  PropertyManager->Tie("atmosphere/SL-graded-delta-T", this, eRankine,
                                    (PMFi)&FGStandardAtmosphere::GetTemperatureDeltaGradient,
                                    (PMF)&FGStandardAtmosphere::SetSLTemperatureGradedDelta);
  PropertyManager->Tie("atmosphere/P-sl-psf", this, ePSF,
                                   (PMFi)&FGStandardAtmosphere::GetPressureSL,
                                   (PMF)&FGStandardAtmosphere::SetPressureSL);
  PropertyManager->Tie("atmosphere/dew-point-R", this, eRankine,
                       (PMFi)&FGStandardAtmosphere::GetDewPoint,
                       (PMF)&FGStandardAtmosphere::SetDewPoint);
  PropertyManager->Tie("atmosphere/vapor-pressure-psf", this, ePSF,
                       (PMFi)&FGStandardAtmosphere::GetVaporPressure,
                       (PMF)&FGStandardAtmosphere::SetVaporPressure);
  PropertyManager->Tie("atmosphere/saturated-vapor-pressure-psf", this, ePSF,
                       (PMFi)&FGStandardAtmosphere::GetSaturatedVaporPressure);
  PropertyManager->Tie("atmosphere/RH", this,
                       &FGStandardAtmosphere::GetRelativeHumidity,
                       &FGStandardAtmosphere::SetRelativeHumidity);
  PropertyManager->Tie("atmosphere/vapor-fraction-ppm", this,
                       &FGStandardAtmosphere::GetVaporMassFractionPPM,
                       &FGStandardAtmosphere::SetVaporMassFractionPPM);
}

◆ Calculate()

void Calculate ( double altitude )

overrideprotectedvirtual

Calculate the atmosphere for the given altitude.

Reimplemented from FGAtmosphere.

Definition at line 181 of file FGStandardAtmosphere.cpp.

{
  FGAtmosphere::Calculate(altitude);
  SaturatedVaporPressure = CalculateVaporPressure(Temperature);
  ValidateVaporMassFraction(altitude);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateDensityAltitude()

double CalculateDensityAltitude	(	double	density,
		double	geometricAlt
	)

overrideprotectedvirtual

Calculates the density altitude given any temperature or pressure bias.

Calculated density for the specified geometric altitude given any temperature or pressure biases is passed in.

Parameters

density
geometricAlt

See also: https://en.wikipedia.org/wiki/Density_altitude https://wahiduddin.net/calc/density_altitude.htm

Reimplemented from FGAtmosphere.

Definition at line 528 of file FGStandardAtmosphere.cpp.

{
  // Work out which layer we're dealing with
  unsigned int b = 0;
  for (; b < StdDensityBreakpoints.size() - 2; b++) {
    if (density >= StdDensityBreakpoints[b + 1])
      break;
  }
 
  // Get layer properties
  double Tmb = StdAtmosTemperatureTable(b + 1, 1);
  double Hb = StdAtmosTemperatureTable(b + 1, 0);
  double Lmb = StdLapseRates[b];
  double pb = StdDensityBreakpoints[b];
 
  double density_altitude = 0.0;
 
  // https://en.wikipedia.org/wiki/Barometric_formula for density solved for H
  if (Lmb != 0.0) {
    double Exp = -1.0 / (1.0 + g0/(Rdry*Lmb));
    density_altitude = Hb + (Tmb / Lmb) * (pow(density / pb, Exp) - 1);
  } else {
    double Factor = -Rdry*Tmb / g0;
    density_altitude = Hb + Factor * log(density / pb);
  }
 
  return GeometricAltitude(density_altitude);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateLapseRates()

void CalculateLapseRates ( )

protected

Recalculate the lapse rate vectors when the temperature profile is altered in a way that would change the lapse rates, such as when a gradient is applied.

This function is also called to initialize the lapse rate vector.

Definition at line 456 of file FGStandardAtmosphere.cpp.

{
  unsigned int numRows = StdAtmosTemperatureTable.GetNumRows();
  LapseRates.clear();
 
  for (unsigned int bh=0; bh < numRows-1; bh++)
  {
    double t0 = StdAtmosTemperatureTable(bh+1,1);
    double t1 = StdAtmosTemperatureTable(bh+2,1);
    double h0 = StdAtmosTemperatureTable(bh+1,0);
    double h1 = StdAtmosTemperatureTable(bh+2,0);
    LapseRates.push_back((t1 - t0) / (h1 - h0) - TemperatureDeltaGradient);
  }
}

Here is the caller graph for this function:

◆ CalculatePressureAltitude()

double CalculatePressureAltitude	(	double	pressure,
		double	geometricAlt
	)

overrideprotectedvirtual

Calculates the pressure altitude given any temperature or pressure bias.

Calculated density for the specified geometric altitude given any temperature or pressure biases is passed in.

Parameters

pressure
geometricAlt

See also: https://en.wikipedia.org/wiki/Pressure_altitude

Reimplemented from FGAtmosphere.

Definition at line 559 of file FGStandardAtmosphere.cpp.

{
  // Work out which layer we're dealing with
  unsigned int b = 0;
  for (; b < StdPressureBreakpoints.size() - 2; b++) {
    if (pressure >= StdPressureBreakpoints[b + 1])
      break;
  }
 
  // Get layer properties
  double Tmb = StdAtmosTemperatureTable(b + 1, 1);
  double Hb = StdAtmosTemperatureTable(b + 1, 0);
  double Lmb = StdLapseRates[b];
  double Pb = StdPressureBreakpoints[b];
 
  double pressure_altitude = 0.0;
 
  if (Lmb != 0.00) {
    // Equation 33(a) from ISA document solved for H
    double Exp = -Rdry*Lmb / g0;
    pressure_altitude = Hb + (Tmb / Lmb) * (pow(pressure / Pb, Exp) - 1);
  } else {
    // Equation 33(b) from ISA document solved for H
    double Factor = -Rdry*Tmb / g0;
    pressure_altitude = Hb + Factor * log(pressure / Pb);
  }
 
  return GeometricAltitude(pressure_altitude);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculatePressureBreakpoints()

void CalculatePressureBreakpoints ( double SLpress )

protected

Calculate (or recalculate) the atmospheric pressure breakpoints at the altitudes in the standard temperature table.

Definition at line 473 of file FGStandardAtmosphere.cpp.

{
  PressureBreakpoints[0] = SLpress;
 
  for (unsigned int b=0; b<PressureBreakpoints.size()-1; b++) {
    double BaseTemp = StdAtmosTemperatureTable(b+1,1);
    double BaseAlt = StdAtmosTemperatureTable(b+1,0);
    double UpperAlt = StdAtmosTemperatureTable(b+2,0);
    double deltaH = UpperAlt - BaseAlt;
    double Tmb = BaseTemp
                 + TemperatureBias 
                 + (GradientFadeoutAltitude - BaseAlt)*TemperatureDeltaGradient;
    if (LapseRates[b] != 0.00) {
      double Lmb = LapseRates[b];
      double Exp = g0 / (Rdry*Lmb);
      double factor = Tmb/(Tmb + Lmb*deltaH);
      PressureBreakpoints[b+1] = PressureBreakpoints[b]*pow(factor, Exp);
    } else {
      PressureBreakpoints[b+1] = PressureBreakpoints[b]*exp(-g0*deltaH/(Rdry*Tmb));
    }
  }
}

Here is the caller graph for this function:

◆ CalculateSLDensity()

void CalculateSLDensity ( void )

inlineprotected

Calculate the SL density.

Definition at line 352 of file FGStandardAtmosphere.h.

352{ SLdensity = SLpressure / (Reng * SLtemperature); }

Here is the caller graph for this function:

◆ CalculateSLSoundSpeedAndDensity()

void CalculateSLSoundSpeedAndDensity ( void )

protected

Calculate the SL density and sound speed.

Definition at line 237 of file FGStandardAtmosphere.cpp.

{
  SLsoundspeed = sqrt(SHRatio*Reng*SLtemperature);
  CalculateSLDensity();
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateStdDensityBreakpoints()

void CalculateStdDensityBreakpoints ( )

protected

Calculate the atmospheric density breakpoints at the altitudes in the standard temperature table.

Definition at line 519 of file FGStandardAtmosphere.cpp.

{
  StdDensityBreakpoints.clear();
  for (unsigned int i = 0; i < StdPressureBreakpoints.size(); i++)
    StdDensityBreakpoints.push_back(StdPressureBreakpoints[i] / (Rdry * StdAtmosTemperatureTable(i + 1, 1)));
}

Here is the caller graph for this function:

◆ CalculateVaporPressure()

double CalculateVaporPressure ( double temperature )

protected

Calculate the pressure of water vapor with the Magnus formula.

Definition at line 591 of file FGStandardAtmosphere.cpp.

{
  double temperature_degC = RankineToCelsius(temperature);
  return a*exp(b*temperature_degC/(c+temperature_degC));
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Debug()

void Debug ( int from )

overrideprotectedvirtual

Reimplemented from FGAtmosphere.

Definition at line 790 of file FGStandardAtmosphere.cpp.

{
  if (debug_lvl <= 0) return;
 
  if (debug_lvl & 1) { // Standard console startup message output
    if (from == 0) { // Constructor
    }
  }
  if (debug_lvl & 2 ) { // Instantiation/Destruction notification
    if (from == 0) std::cout << "Instantiated: FGStandardAtmosphere" << std::endl;
    if (from == 1) std::cout << "Destroyed:    FGStandardAtmosphere" << std::endl;
  }
  if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
  }
  if (debug_lvl & 8 ) { // Runtime state variables
  }
  if (debug_lvl & 16) { // Sanity checking
  }
  if (debug_lvl & 128) { // 
  }
  if (debug_lvl & 64) {
    if (from == 0) { // Constructor
    }
  }
}

◆ GeometricAltitude()

double GeometricAltitude ( double geopotalt ) const

inlineprotected

Convert a geopotential altitude to a geometric altitude.

Definition at line 322 of file FGStandardAtmosphere.h.

322{ return (geopotalt * EarthRadius) / (EarthRadius - geopotalt); }

JSBSim::FGStandardAtmosphere::EarthRadius

static constexpr double EarthRadius

Earth radius in ft as defined for ISA 1976.

Definition FGStandardAtmosphere.h:361

Here is the caller graph for this function:

◆ GeopotentialAltitude()

double GeopotentialAltitude ( double geometalt ) const

inlineprotected

Convert a geometric altitude to a geopotential altitude.

Definition at line 319 of file FGStandardAtmosphere.h.

319{ return (geometalt * EarthRadius) / (EarthRadius + geometalt); }

Here is the caller graph for this function:

◆ GetDewPoint()

double GetDewPoint ( eTemperature to ) const

Returns the dew point.

Parameters

to	The unit of measure that the dew point should be supplied in.

Definition at line 643 of file FGStandardAtmosphere.cpp.

{
  double dewpoint_degC;
  double VaporPressure = Pressure*VaporMassFraction / (VaporMassFraction+Rdry/Rwater);
 
  if (VaporPressure <= 0.0)
    dewpoint_degC = -c;
  else {
    double x = log(VaporPressure/a);
    dewpoint_degC = c*x / (b - x);
  }
 
  return ConvertFromRankine(CelsiusToRankine(dewpoint_degC), to);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPressure()

double GetPressure ( double altitude ) const

overridevirtual

Returns the pressure at a specified altitude in psf.

Implements FGAtmosphere.

Definition at line 193 of file FGStandardAtmosphere.cpp.

{
  double GeoPotAlt = GeopotentialAltitude(altitude);
 
  // Iterate through the altitudes to find the current Base Altitude
  // in the table. That is, if the current altitude (the argument passed in)
  // is 20000 ft, then the base altitude from the table is 0.0. If the
  // passed-in altitude is 40000 ft, the base altitude is 36089.2388 ft (and
  // the index "b" is 2 - the second entry in the table).
  double BaseAlt = StdAtmosTemperatureTable(1,0);
  unsigned int numRows = StdAtmosTemperatureTable.GetNumRows();
  unsigned int b;
 
  for (b=0; b < numRows-2; ++b) {
    double testAlt = StdAtmosTemperatureTable(b+2,0);
    if (GeoPotAlt < testAlt)
      break;
    BaseAlt = testAlt;
  }
 
  double Tmb = GetTemperature(GeometricAltitude(BaseAlt));
  double deltaH = GeoPotAlt - BaseAlt;
  double Lmb = LapseRates[b];
 
  if (Lmb != 0.0) {
    double Exp = g0 / (Rdry*Lmb);
    double factor = Tmb/(Tmb + Lmb*deltaH);
    return PressureBreakpoints[b]*pow(factor, Exp);
  } else
    return PressureBreakpoints[b]*exp(-g0*deltaH/(Rdry*Tmb));
}

Here is the call graph for this function:

◆ GetRelativeHumidity()

double GetRelativeHumidity ( void ) const

Returns the relative humidity in percent.

Definition at line 695 of file FGStandardAtmosphere.cpp.

{
  double VaporPressure = Pressure*VaporMassFraction / (VaporMassFraction+Rdry/Rwater);
  return 100.0*VaporPressure/SaturatedVaporPressure;
}

◆ GetSaturatedVaporPressure()

double GetSaturatedVaporPressure ( ePressure to ) const

Returns the saturated pressure of water vapor.

Parameters

to	The unit of measure that the water vapor should be supplied in.

Definition at line 688 of file FGStandardAtmosphere.cpp.

{
  return ConvertFromPSF(SaturatedVaporPressure, to);
}

Here is the call graph for this function:

◆ GetStdDensity()

double GetStdDensity ( double altitude ) const

virtual

Returns the standard density at a specified altitude.

Definition at line 323 of file FGStandardAtmosphere.cpp.

{
  return GetStdPressure(altitude)/(Rdry * GetStdTemperature(altitude));
}

Here is the call graph for this function:

◆ GetStdPressure()

double GetStdPressure ( double altitude ) const

virtual

Returns the standard pressure at the specified altitude.

Definition at line 288 of file FGStandardAtmosphere.cpp.

{
  double GeoPotAlt = GeopotentialAltitude(altitude);
 
  // Iterate through the altitudes to find the current Base Altitude
  // in the table. That is, if the current altitude (the argument passed in)
  // is 20000 ft, then the base altitude from the table is 0.0. If the
  // passed-in altitude is 40000 ft, the base altitude is 36089.2388 ft (and
  // the index "b" is 2 - the second entry in the table).
  double BaseAlt = StdAtmosTemperatureTable(1,0);
  unsigned int numRows = StdAtmosTemperatureTable.GetNumRows();
  unsigned int b;
 
  for (b=0; b < numRows-2; ++b) {
    double testAlt = StdAtmosTemperatureTable(b+2,0);
    if (GeoPotAlt < testAlt)
      break;
    BaseAlt = testAlt;
  }
 
  double Tmb = GetStdTemperature(GeometricAltitude(BaseAlt));
  double deltaH = GeoPotAlt - BaseAlt;
  double Lmb = LapseRates[b];
 
  if (Lmb != 0.0) {
    double Exp = g0 / (Rdry*Lmb);
    double factor = Tmb/(Tmb + Lmb*deltaH);
    return StdPressureBreakpoints[b]*pow(factor, Exp);
  } else
    return StdPressureBreakpoints[b]*exp(-g0*deltaH/(Rdry*Tmb));
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetStdTemperature()

double GetStdTemperature ( double altitude ) const

virtual

Returns the standard temperature in degrees Rankine at a specified altitude.

Parameters

altitude The altitude in feet above sea level (ASL) to get the temperature at.

Returns: The STANDARD temperature in degrees Rankine at the specified altitude.

Definition at line 276 of file FGStandardAtmosphere.cpp.

{
  double GeoPotAlt = GeopotentialAltitude(altitude);
 
  if (GeoPotAlt >= 0.0)
    return StdAtmosTemperatureTable.GetValue(GeoPotAlt);
  else
    return StdAtmosTemperatureTable.GetValue(0.0) + GeoPotAlt*LapseRates[0];
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetStdTemperatureRatio()

virtual double GetStdTemperatureRatio ( double h ) const

inlinevirtual

Returns the ratio of the standard temperature at the supplied altitude over the standard sea level temperature.

Definition at line 139 of file FGStandardAtmosphere.h.

139{ return GetStdTemperature(h)/StdSLtemperature; }

◆ GetStdTemperatureSL()

virtual double GetStdTemperatureSL ( ) const

inlinevirtual

Returns the standard sea level temperature in degrees Rankine.

Returns: The STANDARD temperature at sea level in degrees Rankine.

Definition at line 135 of file FGStandardAtmosphere.h.

135{ return StdSLtemperature; }

◆ GetTemperature()

double GetTemperature ( double altitude ) const

overridevirtual

Returns the actual modeled temperature in degrees Rankine at a specified altitude.

Parameters

altitude The altitude above sea level (ASL) in feet.

Returns: Modeled temperature in degrees Rankine at the specified altitude.

Implements FGAtmosphere.

Definition at line 247 of file FGStandardAtmosphere.cpp.

{
  double GeoPotAlt = GeopotentialAltitude(altitude);
 
  double T;
 
  if (GeoPotAlt >= 0.0) {
    T = StdAtmosTemperatureTable.GetValue(GeoPotAlt);
 
    if (GeoPotAlt <= GradientFadeoutAltitude)
      T -= TemperatureDeltaGradient * GeoPotAlt;
  }
  else {
    // We don't need to add TemperatureDeltaGradient*GeoPotAlt here because
    // the lapse rate vector already accounts for the temperature gradient.
    T = StdAtmosTemperatureTable.GetValue(0.0) + GeoPotAlt*LapseRates[0];
  }
 
  T += TemperatureBias;
 
  if (GeoPotAlt <= GradientFadeoutAltitude)
    T += TemperatureDeltaGradient * GradientFadeoutAltitude;
 
  return T;
}

Here is the call graph for this function:

◆ GetTemperatureBias()

virtual double GetTemperatureBias ( eTemperature to ) const

inlinevirtual

Returns the temperature bias over the sea level value in degrees Rankine.

Definition at line 142 of file FGStandardAtmosphere.h.

143 { if (to == eCelsius || to == eKelvin) return TemperatureBias/1.80; else return TemperatureBias; }

◆ GetTemperatureDeltaGradient()

virtual double GetTemperatureDeltaGradient ( eTemperature to )

inlinevirtual

Returns the temperature gradient to be applied on top of the standard temperature gradient.

Definition at line 147 of file FGStandardAtmosphere.h.

148 { if (to == eCelsius || to == eKelvin) return TemperatureDeltaGradient/1.80; else return TemperatureDeltaGradient; }

◆ GetVaporMassFractionPPM()

double GetVaporMassFractionPPM ( void ) const

Returns the vapor mass per million of dry air mass units (ppm).

Definition at line 721 of file FGStandardAtmosphere.cpp.

{
  return VaporMassFraction*1E6;
}

◆ GetVaporPressure()

double GetVaporPressure ( ePressure to ) const

Returns the partial pressure of water vapor.

Parameters

to	The unit of measure that the water vapor should be supplied in.

Definition at line 680 of file FGStandardAtmosphere.cpp.

{
  double VaporPressure = Pressure*VaporMassFraction / (VaporMassFraction+Rdry/Rwater);
  return ConvertFromPSF(VaporPressure, to);
}

Here is the call graph for this function:

◆ InitModel()

bool InitModel ( void )

overridevirtual

Reimplemented from FGAtmosphere.

Definition at line 154 of file FGStandardAtmosphere.cpp.

{
 
  // Assume the altitude to fade out the gradient at is at the highest
  // altitude in the table. Above that, other functions are used to
  // calculate temperature.
  GradientFadeoutAltitude = StdAtmosTemperatureTable(StdAtmosTemperatureTable.GetNumRows(), 0);
 
  TemperatureDeltaGradient = 0.0;
  TemperatureBias = 0.0;
  LapseRates = StdLapseRates;
 
  PressureBreakpoints = StdPressureBreakpoints;
 
  SLpressure    = StdSLpressure;
  SLtemperature = StdSLtemperature;
  SLdensity     = StdSLdensity;
  SLsoundspeed  = StdSLsoundspeed;
 
  Calculate(0.0);
 
//  PrintStandardAtmosphereTable();
 
  return true;
}

◆ PrintStandardAtmosphereTable()

void PrintStandardAtmosphereTable ( )

virtual

Prints the U.S. Standard Atmosphere table.

Definition at line 432 of file FGStandardAtmosphere.cpp.

{
  std::cout << "Altitude (ft)   Temp (F)   Pressure (psf)   Density (sl/ft3)" << std::endl;
  std::cout << "-------------   --------   --------------   ----------------" << std::endl;
  for (int i=0; i<280000; i+=1000) {
    Calculate(i);
    std::cout  << std::setw(12) << std::setprecision(2) << i
       << "  " << std::setw(9)  << std::setprecision(2) << Temperature - 459.67
       << "  " << std::setw(13) << std::setprecision(4) << Pressure
       << "  " << std::setw(18) << std::setprecision(8) << Density
       << std::endl;
  }
 
  // Re-execute the Run() method to reset the calculated values
  Run(false);
}

Here is the call graph for this function:

◆ ResetSLPressure()

void ResetSLPressure ( )

virtual

Resets the sea level to the Standard sea level pressure, and recalculates dependent parameters so that the pressure calculations are standard.

Definition at line 510 of file FGStandardAtmosphere.cpp.

{
  SLpressure  = StdSLpressure;
  CalculateSLDensity();
  CalculatePressureBreakpoints(StdSLpressure);
}

Here is the call graph for this function:

◆ ResetSLTemperature()

void ResetSLTemperature ( )

virtual

This function resets the model to apply no bias or delta gradient to the temperature.

The delta gradient and bias values are reset to 0.0, and the standard temperature is used for the entire temperature profile at all altitudes.

Definition at line 498 of file FGStandardAtmosphere.cpp.

{
  TemperatureBias = TemperatureDeltaGradient = 0.0;
  CalculateLapseRates();
  CalculatePressureBreakpoints(SLpressure);
 
  SLtemperature = StdSLtemperature;
  CalculateSLSoundSpeedAndDensity();
}

Here is the call graph for this function:

◆ SetDewPoint()

void SetDewPoint	(	eTemperature	unit,
		double	dewpoint
	)

Sets the dew point.

Parameters

dewpoint	The dew point in the units specified
unit	The unit of measure that the specified dew point is supplied in.

Definition at line 619 of file FGStandardAtmosphere.cpp.

{
  double dewPoint_R = ConvertToRankine(dewpoint, unit);
  constexpr double minDewPoint = -CelsiusToRankine(c) + 1.0;
 
  if (dewPoint_R <= minDewPoint) {
    cerr << "The dew point temperature " << dewPoint_R << " is lower than "
         << minDewPoint << " R." << endl
         << "Dew point is therefore capped to " << minDewPoint << endl;
    dewPoint_R = minDewPoint;
  }
 
  double VaporPressure = CalculateVaporPressure(dewPoint_R);
  SetVaporPressure(ePSF, VaporPressure);
 
  double finalizedDewPoint = GetDewPoint(eRankine);
  if (finalizedDewPoint < dewPoint_R) {
    cerr << "Dew point temperature has been capped to " << finalizedDewPoint
         << endl;
  }
}

Here is the call graph for this function:

◆ SetPressureSL()

void SetPressureSL	(	ePressure	unit,
		double	pressure
	)

overridevirtual

Sets the sea level pressure for modeling an off-standard pressure profile.

This could be useful in the case where the pressure at an airfield is known or set for a particular simulation run.

Parameters

pressure	The pressure in the units specified.
unit	the unit of measure that the specified pressure is supplied in.

Reimplemented from FGAtmosphere.

Definition at line 227 of file FGStandardAtmosphere.cpp.

{
  double p = ConvertToPSF(pressure, unit);
  SLpressure = ValidatePressure(p, "Sea Level pressure");
  CalculateSLDensity();
  CalculatePressureBreakpoints(SLpressure);
}

Here is the call graph for this function:

◆ SetRelativeHumidity()

void SetRelativeHumidity ( double RH )

Sets the relative humidity.

Parameters

RH	The relative humidity in percent.

Definition at line 703 of file FGStandardAtmosphere.cpp.

{
  if (RH < 0.0) {
    cerr << "The relative humidity cannot be negative." << endl
         << "Relative humidity is set to 0%" << endl;
    RH = 0.0;
  } else if (RH > 100.0) {
    cerr << "The relative humidity cannot be higher than 100%." << endl
         << "Relative humidity is set to 100%" << endl;
    RH = 100.0;
  }
 
  double VaporPressure = 0.01*RH*SaturatedVaporPressure;
  SetVaporPressure(ePSF, VaporPressure);
}

Here is the call graph for this function:

◆ SetSLTemperatureGradedDelta()

void SetSLTemperatureGradedDelta	(	eTemperature	unit,
		double	t
	)

virtual

Sets a Sea Level temperature delta that is ramped out by 86 km.

The value of the delta is used to calculate a delta gradient that is applied to the temperature at all altitudes below 86 km (282152 ft). For instance, if a temperature of 20 degrees F is supplied, the delta gradient would be 20/282152 - or, about 7.09E-5 degrees/ft. At sea level, the full 20 degrees would be added to the standard temperature, but that 20 degree delta would be reduced by 7.09E-5 degrees for every foot of altitude above sea level, so that by 86 km, there would be no further delta added to the standard temperature. The graded delta can be used along with the a bias to tailor the temperature profile as desired.

Parameters

t	the sea level temperature delta value in the unit provided.
unit	the unit of the temperature.

Definition at line 392 of file FGStandardAtmosphere.cpp.

{
  SetTemperatureGradedDelta(deltemp, 0.0, unit);
}

Here is the call graph for this function:

◆ SetTemperature()

void SetTemperature	(	double	t,
		double	h,
		eTemperature	unit = `eFahrenheit`
	)

overridevirtual

Sets the temperature at the supplied altitude, if it is to be different than the standard temperature.

This function will calculate a bias - a difference - from the standard atmosphere temperature at the supplied altitude and will apply that calculated bias to the entire temperature profile. If a graded delta is present, that will be included in the calculation - that is, regardless of any graded delta present, a temperature bias will be determined so that the temperature requested in this function call will be reached.

Parameters

t	The temperature value in the unit provided.
h	The altitude in feet above sea level.
unit	The unit of the temperature.

Implements FGAtmosphere.

Definition at line 330 of file FGStandardAtmosphere.cpp.

{
  double targetTemp = ConvertToRankine(t, unit);
  double GeoPotAlt = GeopotentialAltitude(h);
  double bias = targetTemp - GetStdTemperature(h);
 
  if (GeoPotAlt <= GradientFadeoutAltitude)
    bias -= TemperatureDeltaGradient * (GradientFadeoutAltitude - GeoPotAlt);
 
  SetTemperatureBias(eRankine, bias);
  CalculatePressureBreakpoints(SLpressure);
 
  SLtemperature = GetTemperature(0.0);
  CalculateSLSoundSpeedAndDensity();
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTemperatureBias()

void SetTemperatureBias	(	eTemperature	unit,
		double	t
	)

virtual

Sets the temperature bias to be added to the standard temperature at all altitudes.

This function sets the bias - the difference - from the standard atmosphere temperature. This bias applies to the entire temperature profile. Another way to set the temperature bias is to use the SetSLTemperature function, which replaces the value calculated by this function with a calculated bias.

Parameters

t	the temperature value in the unit provided.
unit	the unit of the temperature.

Definition at line 348 of file FGStandardAtmosphere.cpp.

{
  // Retrieve the minimum temperature in the standard atmosphere, may not be the
  // last row in future if for example it's extended and maybe there is some
  // temperature inversion layer etc. So run through and find the minimum.
  const double minStdAtmosphereTemp = StdAtmosTemperatureTable.GetMinValue();
 
  // Minimum known temperature in the universe currently
  constexpr double minUniverseTemperature = KelvinToRankine(1.0);
 
  if (unit == eCelsius || unit == eKelvin)
    t *= 1.80; // If temp delta "t" is given in metric, scale up to English
 
  TemperatureBias = t;
  // Confirm the temperature bias isn't going to result in an atmosphere
  // temperature lower than the  lowest known temperature in the universe
  if (minStdAtmosphereTemp + TemperatureBias < minUniverseTemperature) {
    double minBias = minUniverseTemperature - minStdAtmosphereTemp;
    cerr << "The temperature bias " << TemperatureBias << " R is too low. "
         << "It could result in temperatures below the absolute zero." << endl
         << "Temperature bias is therefore capped to " << minBias << endl;
    TemperatureBias = minBias;
  }
 
  CalculatePressureBreakpoints(SLpressure);
 
  SLtemperature = GetTemperature(0.0);
  CalculateSLSoundSpeedAndDensity();
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTemperatureGradedDelta()

void SetTemperatureGradedDelta	(	double	t,
		double	h,
		eTemperature	unit = `eFahrenheit`
	)

virtual

Sets the temperature delta value at the supplied altitude/elevation above sea level, to be added to the standard temperature and ramped out by 86 km.

This function computes the sea level delta from the standard atmosphere temperature at sea level.

Parameters

t	the temperature skew value in the unit provided.
unit	the unit of the temperature.

Definition at line 404 of file FGStandardAtmosphere.cpp.

{
  // Retrieve the minimum temperature in the standard atmosphere, may not be the
  // last row in future if for example it's extended and maybe there is some
  // temperature inversion layer etc. So run through and find the minimum.
  const double minStdAtmosphereTemp = StdAtmosTemperatureTable.GetMinValue();
  const double minDeltaTemperature = minStdAtmosphereTemp - StdSLtemperature;
 
  if (unit == eCelsius || unit == eKelvin)
    deltemp *= 1.80; // If temp delta "t" is given in metric, scale up to English
 
  if (deltemp <= minDeltaTemperature) {
    cerr << "The temperature delta " << deltemp << " R is too low. "
         << "It could result in temperatures below the absolute zero." << endl
         << "Temperature delta is therefore capped to " << minDeltaTemperature << endl;
    deltemp = minDeltaTemperature;
  }
 
  TemperatureDeltaGradient = deltemp/(GradientFadeoutAltitude - GeopotentialAltitude(h));
  CalculateLapseRates();
  CalculatePressureBreakpoints(SLpressure);
 
  SLtemperature = GetTemperature(0.0);
  CalculateSLSoundSpeedAndDensity();
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTemperatureSL()

void SetTemperatureSL	(	double	t,
		eTemperature	unit = `eFahrenheit`
	)

overridevirtual

Sets the Sea Level temperature, if it is to be different than the standard.

This function will calculate a bias - a difference - from the standard atmosphere temperature and will apply that bias to the entire temperature profile. This is one way to set the temperature bias. Using the SetTemperatureBias function will replace the value calculated by this function.

Parameters

t	the temperature value in the unit provided.
unit	the unit of the temperature.

Reimplemented from FGAtmosphere.

Definition at line 384 of file FGStandardAtmosphere.cpp.

{
  SetTemperature(t, 0.0, unit);
}

Here is the call graph for this function:

◆ SetVaporMassFractionPPM()

void SetVaporMassFractionPPM ( double frac )

Sets the vapor mass per million of dry air mass units.

Parameters

frac	The fraction of water in ppm of dry air.

Definition at line 728 of file FGStandardAtmosphere.cpp.

{
  double altitude = CalculatePressureAltitude(Pressure, 0.0);
  VaporMassFraction = frac*1E-6;
  ValidateVaporMassFraction(altitude);
 
  if (fabs(VaporMassFraction*1E6-frac)>1E-2) {
    cerr << "The vapor mass fraction " << frac << " has been capped to "
         << VaporMassFraction*1E6 << "PPM." << endl;
  }
}

Here is the call graph for this function:

◆ SetVaporPressure()

void SetVaporPressure	(	ePressure	unit,
		double	Pv
	)

Sets the partial pressure of water vapor.

Parameters

Pv	The vapor pressure in the units specified
unit	The unit of measure that the specified vapor pressure is supplied in.

Definition at line 660 of file FGStandardAtmosphere.cpp.

{
  double altitude = CalculatePressureAltitude(Pressure, 0.0);
  double VaporPressure = ConvertToPSF(Pa, unit);
  if (VaporPressure < 0.0) {
    cerr << "The vapor pressure cannot be negative." << endl
         << "Vapor pressure is set to 0.0" << endl;
    VaporPressure = 0.0;
  } else if (VaporPressure >= Pressure) {
    cerr << "The vapor pressure " << VaporPressure
         << " PSF is higher than the ambient pressure." << endl
         << "Vapor pressure is therefore capped to " << Pressure-1.0 << endl;
    VaporPressure = Pressure - 1.0;
  }
  VaporMassFraction = Rdry * VaporPressure / (Rwater * (Pressure - VaporPressure));
  ValidateVaporMassFraction(altitude);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ValidateVaporMassFraction()

void ValidateVaporMassFraction ( double geometricAlt )

protected

Validate the value of the vapor mass fraction.

Definition at line 599 of file FGStandardAtmosphere.cpp.

{
  if (SaturatedVaporPressure < Pressure) {
    double VaporPressure = Pressure*VaporMassFraction / (VaporMassFraction+Rdry/Rwater);
    if (VaporPressure > SaturatedVaporPressure)
      VaporMassFraction = Rdry * SaturatedVaporPressure / (Rwater * (Pressure - SaturatedVaporPressure));
  }
 
  double GeoPotAlt = GeopotentialAltitude(h);
  double maxFraction = 1E-6*MaxVaporMassFraction.GetValue(GeoPotAlt);
 
  if ((VaporMassFraction > maxFraction) || (VaporMassFraction < 0.0))
    VaporMassFraction = maxFraction;
 
  // Update the gas constant factor
  Reng = (VaporMassFraction*Rwater + Rdry)/(1.0 + VaporMassFraction);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ a

constexpr double a = 611.2/psftopa

staticconstexprprotected

Sonntag constants based on ref [2].

They are valid for temperatures between -45 degC (-49 degF) and 60 degC (140 degF) with a precision of +/-0.35 degC (+/-0.63 degF)

Definition at line 365 of file FGStandardAtmosphere.h.

◆ b

constexpr double b = 17.62

staticconstexprprotected

Definition at line 366 of file FGStandardAtmosphere.h.

◆ c

constexpr double c = 243.12

staticconstexprprotected

Definition at line 367 of file FGStandardAtmosphere.h.

◆ EarthRadius

constexpr double EarthRadius = 6356766.0 / fttom

staticconstexprprotected

Earth radius in ft as defined for ISA 1976.

Definition at line 361 of file FGStandardAtmosphere.h.

◆ GradientFadeoutAltitude

double GradientFadeoutAltitude

protected

Definition at line 290 of file FGStandardAtmosphere.h.

◆ LapseRates

std::vector<double> LapseRates

protected

Definition at line 296 of file FGStandardAtmosphere.h.

◆ MaxVaporMassFraction

FGTable MaxVaporMassFraction

protected

Definition at line 295 of file FGStandardAtmosphere.h.

◆ Mwater

constexpr double Mwater = 18.016 * kgtoslug / 1000.0

staticconstexprprotected

Mean molecular weight for water - slug/mol.

Definition at line 369 of file FGStandardAtmosphere.h.

◆ PressureBreakpoints

std::vector<double> PressureBreakpoints

protected

Definition at line 297 of file FGStandardAtmosphere.h.

◆ Rdry

constexpr double Rdry = Rstar / Mair

staticconstexprprotected

Definition at line 370 of file FGStandardAtmosphere.h.

◆ Rwater

constexpr double Rwater = Rstar / Mwater

staticconstexprprotected

Definition at line 371 of file FGStandardAtmosphere.h.

◆ SaturatedVaporPressure

double SaturatedVaporPressure

protected

Definition at line 292 of file FGStandardAtmosphere.h.

◆ StdAtmosTemperatureTable

FGTable StdAtmosTemperatureTable

protected

Definition at line 294 of file FGStandardAtmosphere.h.

◆ StdDensityBreakpoints

std::vector<double> StdDensityBreakpoints

protected

Definition at line 299 of file FGStandardAtmosphere.h.

◆ StdLapseRates

std::vector<double> StdLapseRates

protected

Definition at line 300 of file FGStandardAtmosphere.h.

◆ StdPressureBreakpoints

std::vector<double> StdPressureBreakpoints

protected

Definition at line 298 of file FGStandardAtmosphere.h.

◆ StdSLdensity

double StdSLdensity

protected

Definition at line 286 of file FGStandardAtmosphere.h.

◆ StdSLpressure

double StdSLpressure

protected

Definition at line 286 of file FGStandardAtmosphere.h.

◆ StdSLsoundspeed

double StdSLsoundspeed

protected

Definition at line 286 of file FGStandardAtmosphere.h.

◆ StdSLtemperature

double StdSLtemperature

protected

Standard sea level conditions.

Definition at line 286 of file FGStandardAtmosphere.h.

◆ TemperatureBias

double TemperatureBias

protected

Definition at line 288 of file FGStandardAtmosphere.h.

◆ TemperatureDeltaGradient

double TemperatureDeltaGradient

protected

Definition at line 289 of file FGStandardAtmosphere.h.

◆ VaporMassFraction

double VaporMassFraction

protected

Definition at line 291 of file FGStandardAtmosphere.h.

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

Detailed Description

Properties

Public Member Functions

Humidity access functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ FGStandardAtmosphere()

◆ ~FGStandardAtmosphere()

Member Function Documentation

◆ bind()

◆ Calculate()

◆ CalculateDensityAltitude()

◆ CalculateLapseRates()

◆ CalculatePressureAltitude()

◆ CalculatePressureBreakpoints()

◆ CalculateSLDensity()

◆ CalculateSLSoundSpeedAndDensity()

◆ CalculateStdDensityBreakpoints()

◆ CalculateVaporPressure()

◆ Debug()

◆ GeometricAltitude()

◆ GeopotentialAltitude()

◆ GetDewPoint()

◆ GetPressure()

◆ GetRelativeHumidity()

◆ GetSaturatedVaporPressure()

◆ GetStdDensity()

◆ GetStdPressure()

◆ GetStdTemperature()

◆ GetStdTemperatureRatio()

◆ GetStdTemperatureSL()

◆ GetTemperature()

◆ GetTemperatureBias()

◆ GetTemperatureDeltaGradient()

◆ GetVaporMassFractionPPM()

◆ GetVaporPressure()

◆ InitModel()

◆ PrintStandardAtmosphereTable()

◆ ResetSLPressure()

◆ ResetSLTemperature()

◆ SetDewPoint()

◆ SetPressureSL()

◆ SetRelativeHumidity()

◆ SetSLTemperatureGradedDelta()

◆ SetTemperature()

◆ SetTemperatureBias()

◆ SetTemperatureGradedDelta()

◆ SetTemperatureSL()

◆ SetVaporMassFractionPPM()

◆ SetVaporPressure()

◆ ValidateVaporMassFraction()

Member Data Documentation

◆ a

◆ b

◆ c

◆ EarthRadius

◆ GradientFadeoutAltitude

◆ LapseRates

◆ MaxVaporMassFraction

◆ Mwater

◆ PressureBreakpoints

◆ Rdry

◆ Rwater

◆ SaturatedVaporPressure

◆ StdAtmosTemperatureTable

◆ StdDensityBreakpoints

◆ StdLapseRates

◆ StdPressureBreakpoints

◆ StdSLdensity

◆ StdSLpressure

◆ StdSLsoundspeed

◆ StdSLtemperature

◆ TemperatureBias

◆ TemperatureDeltaGradient

◆ VaporMassFraction