Models an empty, abstract base atmosphere class. More...

#include <FGAtmosphere.h>

Inheritance diagram for FGAtmosphere:

Collaboration diagram for FGAtmosphere:

Classes
struct	Inputs

Public Types
enum	ePressure { eNoPressUnit =0, ePSF, eMillibars, ePascals, eInchesHg }
	Enums for specifying pressure units.

enum	eTemperature { eNoTempUnit =0, eFahrenheit, eCelsius, eRankine, eKelvin }
	Enums for specifying temperature units.

Public Types inherited from FGJSBBase
enum	{ eL = 1, eM, eN }
	Moments L, M, N.

enum	{ eP = 1, eQ, eR }
	Rates P, Q, R.

enum	{ eU = 1, eV, eW }
	Velocities U, V, W.

enum	{ eX = 1, eY, eZ }
	Positions X, Y, Z.

enum	{ ePhi = 1, eTht, ePsi }
	Euler angles Phi, Theta, Psi.

enum	{ eDrag = 1, eSide, eLift }
	Stability axis forces, Drag, Side force, Lift.

enum	{ eRoll = 1, ePitch, eYaw }
	Local frame orientation Roll, Pitch, Yaw.

enum	{ eNorth = 1, eEast, eDown }
	Local frame position North, East, Down.

enum	{ eLat = 1, eLong, eRad }
	Locations Radius, Latitude, Longitude.

enum	{ inNone = 0, inDegrees, inRadians, inMeters, inFeet }
	Conversion specifiers.

Public Member Functions
	FGAtmosphere (FGFDMExec *)
	Constructor.

virtual	~FGAtmosphere ()
	Destructor.

virtual double	GetDensityAltitude () const

virtual double	GetPressureAltitude () const

bool	InitModel (void)

bool	Run (bool Holding)
	Runs the atmosphere forces model; called by the Executive. More...

Temperature access functions.
There are several ways to get the temperature, and several modeled temperature values that can be retrieved.
virtual double	GetTemperature () const
	Returns the actual, modeled temperature at the current altitude in degrees Rankine. More...

virtual double	GetTemperature (double altitude) const =0
	Returns the actual modeled temperature in degrees Rankine at a specified altitude. More...

virtual double	GetTemperatureSL () const
	Returns the actual, modeled sea level temperature in degrees Rankine. More...

virtual double	GetTemperatureRatio () const
	Returns the ratio of the at-current-altitude temperature as modeled over the sea level value. More...

virtual double	GetTemperatureRatio (double h) const
	Returns the ratio of the temperature as modeled at the supplied altitude over the sea level value. More...

virtual void	SetTemperatureSL (double t, eTemperature unit=eFahrenheit)
	Sets the Sea Level temperature. More...

virtual void	SetTemperature (double t, double h, eTemperature unit=eFahrenheit)=0
	Sets the temperature at the supplied altitude. More...

Pressure access functions.
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. More...

Density access functions.
virtual double	GetDensity (void) const
	Returns the density in slugs/ft^3. More...

virtual double	GetDensity (double altitude) const
	Returns the density in slugs/ft^3 at a given altitude in ft. More...

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.

Speed of sound access functions.
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.

Viscosity access functions.
virtual double	GetAbsoluteViscosity (void) const
	Returns the absolute viscosity.

virtual double	GetKinematicViscosity (void) const
	Returns the kinematic viscosity.

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

virtual	~FGModel ()
	Destructor.

virtual SGPath	FindFullPathName (const SGPath &path) const

FGFDMExec *	GetExec (void)

unsigned int	GetRate (void)
	Get the output rate for the model in frames.

void	SetPropertyManager (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. More...

std::string	GetFunctionValues (const std::string &delimeter) const
	Gets the function values. More...

FGFunction *	GetPreFunction (const std::string &name)
	Get one of the "pre" function. More...

bool	Load (Element el, FGPropertyManager PropertyManager, std::string prefix="")

void	PostLoad (Element el, FGPropertyManager PropertyManager, std::string prefix="")

void	PreLoad (Element el, FGPropertyManager PropertyManager, 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.

std::string	GetVersion (void)
	Returns the version number of JSBSim. More...

void	PutMessage (const Message &msg)
	Places a Message structure on the Message queue. More...

void	PutMessage (const std::string &text)
	Creates a message with the given text and places it on the queue. More...

void	PutMessage (const std::string &text, bool bVal)
	Creates a message with the given text and boolean value and places it on the queue. More...

void	PutMessage (const std::string &text, int iVal)
	Creates a message with the given text and integer value and places it on the queue. More...

void	PutMessage (const std::string &text, double dVal)
	Creates a message with the given text and double value and places it on the queue. More...

int	SomeMessages (void)
	Reads the message on the queue (but does not delete it). More...

void	ProcessMessage (void)
	Reads the message on the queue and removes it from the queue. More...

Message *	ProcessNextMessage (void)
	Reads the next message on the queue and removes it from the queue. More...

Public Attributes
struct JSBSim::FGAtmosphere::Inputs	in

Public Attributes inherited from FGModel
std::string	Name

Protected Member Functions
virtual void	bind (void)

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

virtual double	ConvertFromPSF (double t, ePressure unit=ePSF) const

virtual double	ConvertToPSF (double t, ePressure unit=ePSF) const

virtual double	ConvertToRankine (double t, eTemperature unit) const

void	Debug (int from)

Protected Member Functions inherited from FGModel
virtual bool	Load (Element *el)
	Loads this model. More...

Protected Member Functions inherited from FGJSBBase
void	Debug (int)

Protected Attributes
const double	Beta

double	Density

double	DensityAltitude

double	KinematicViscosity

double	Pressure

double	PressureAltitude

double	rSLdensity

double	rSLpressure

double	rSLsoundspeed

double	rSLtemperature

double	SLdensity

double	SLpressure

double	SLsoundspeed

double	SLtemperature

double	Soundspeed

const double	SutherlandConstant

double	Temperature

double	Viscosity

Protected Attributes inherited from FGModel
unsigned int	exe_ctr

FGFDMExec *	FDMExec

FGPropertyManager *	PropertyManager

unsigned int	rate

Protected Attributes inherited from FGModelFunctions
FGPropertyReader	LocalProperties

std::vector< FGFunction * >	PostFunctions

std::vector< FGFunction * >	PreFunctions

Additional Inherited Members
Static Public Member Functions inherited from FGJSBBase
static double	CelsiusToFahrenheit (double celsius)
	Converts from degrees Celsius to degrees Fahrenheit. More...

static double	CelsiusToKelvin (double celsius)
	Converts from degrees Celsius to degrees Kelvin. More...

static double	CelsiusToRankine (double celsius)
	Converts from degrees Celsius to degrees Rankine. More...

static double	Constrain (double min, double value, double max)
	Constrain a value between a minimum and a maximum value.

static bool	EqualToRoundoff (double a, double b)
	Finite precision comparison. More...

static bool	EqualToRoundoff (float a, float b)
	Finite precision comparison. More...

static bool	EqualToRoundoff (float a, double b)
	Finite precision comparison. More...

static bool	EqualToRoundoff (double a, float b)
	Finite precision comparison. More...

static double	FahrenheitToCelsius (double fahrenheit)
	Converts from degrees Fahrenheit to degrees Celsius. More...

static double	FeetToMeters (double measure)
	Converts from feet to meters. More...

static double	GaussianRandomNumber (void)

static double	KelvinToCelsius (double kelvin)
	Converts from degrees Kelvin to degrees Celsius. More...

static double	KelvinToFahrenheit (double kelvin)
	Converts from degrees Kelvin to degrees Fahrenheit. More...

static double	KelvinToRankine (double kelvin)
	Converts from degrees Kelvin to degrees Rankine. More...

static double	MachFromVcalibrated (double vcas, double p, double psl, double rhosl)
	Calculate the Mach number from the calibrated airspeed. More...

static double	PitotTotalPressure (double mach, double p)
	Compute the total pressure in front of the Pitot tube. More...

static double	RankineToCelsius (double rankine)
	Converts from degrees Rankine to degrees Celsius. More...

static double	RankineToKelvin (double rankine)
	Converts from degrees Rankine to degrees Kelvin. More...

static double	sign (double num)

static double	VcalibratedFromMach (double mach, double p, double psl, double rhosl)
	Calculate the calibrated airspeed from the Mach number. More...

Static Public Attributes inherited from FGJSBBase
static short	debug_lvl = 1

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 Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)

Static Protected Attributes inherited from FGJSBBase
static const double	degtorad = 0.017453292519943295769236907684886

static const double	fpstokts = 1.0/ktstofps

static const double	fttom = 0.3048

static int	gaussian_random_number_phase = 0

static const double	hptoftlbssec = 550.0

static const double	in3tom3 = 1.638706E-5

static const double	inchtoft = 0.08333333

static const double	inhgtopa = 3386.38

static const std::string	JSBSim_version = "1.0 " __DATE__ " " __TIME__

static const double	kgtolb = 2.20462

static const double	kgtoslug = 0.06852168

static const double	ktstofps = 1.68781

static const double	lbtoslug = 1.0/slugtolb

static Message	localMsg

static const double	m3toft3 = 1.0/(fttomfttomfttom)

static double	Mair = 28.9645

static unsigned int	messageId = 0

static std::queue< Message >	Messages

static const std::string	needed_cfg_version = "2.0"

static const double	psftoinhg = 0.014138

static const double	psftopa = 47.88

static const double	radtodeg = 57.295779513082320876798154814105

static double	Reng = 1716.56

static double	Rstar = 1545.348

static const double	SHRatio = 1.40

static const double	slugtolb = 32.174049

Detailed Description

Models an empty, abstract base atmosphere class.

Properties

atmosphere/T-R The current modeled temperature in degrees Rankine.
atmosphere/rho-slugs_ft3
atmosphere/P-psf
atmosphere/a-fps
atmosphere/T-sl-R
atmosphere/rho-sl-slugs_ft3
atmosphere/P-sl-psf
atmosphere/a-sl-fps
atmosphere/theta
atmosphere/sigma
atmosphere/delta
atmosphere/a-ratio

Author: Jon Berndt

Version

Id: FGAtmosphere.h,v 1.32 2016/01/10 15:56:30 bcoconni Exp

Definition at line 84 of file FGAtmosphere.h.

Member Function Documentation

◆ GetDensity() [1/2]

virtual double GetDensity ( void ) const

inlinevirtual

Returns the density in slugs/ft^3.

This function may only be used if Run() is called first.

Definition at line 175 of file FGAtmosphere.h.

175 {return Density;}

Here is the caller graph for this function:

◆ GetDensity() [2/2]

double GetDensity ( double altitude ) const

virtual

Returns the density in slugs/ft^3 at a given altitude in ft.

Definition at line 152 of file FGAtmosphere.cpp.

 {
   return GetPressure(altitude)/(Reng * GetTemperature(altitude));
 }

Here is the call graph for this function:

◆ GetTemperature() [1/2]

virtual double GetTemperature ( ) const

inlinevirtual

Returns the actual, modeled temperature at the current altitude in degrees Rankine.

Returns: Modeled temperature in degrees Rankine.

Definition at line 117 of file FGAtmosphere.h.

117 {return Temperature;}

Here is the caller graph for this function:

◆ GetTemperature() [2/2]

virtual double GetTemperature ( double altitude ) const

pure virtual

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.

Implemented in FGStandardAtmosphere.

◆ GetTemperatureRatio() [1/2]

virtual double GetTemperatureRatio ( ) const

inlinevirtual

Returns the ratio of the at-current-altitude temperature as modeled over the sea level value.

Definition at line 130 of file FGAtmosphere.h.

130 { return GetTemperature()*rSLtemperature; }

JSBSim::FGAtmosphere::GetTemperature

virtual double GetTemperature() const

Returns the actual, modeled temperature at the current altitude in degrees Rankine.

Definition: FGAtmosphere.h:117

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTemperatureRatio() [2/2]

virtual double GetTemperatureRatio ( double h ) const

inlinevirtual

Returns the ratio of the temperature as modeled at the supplied altitude over the sea level value.

Definition at line 134 of file FGAtmosphere.h.

134 { return GetTemperature(h)*rSLtemperature; }

JSBSim::FGAtmosphere::GetTemperature

virtual double GetTemperature() const

Returns the actual, modeled temperature at the current altitude in degrees Rankine.

Definition: FGAtmosphere.h:117

Here is the call graph for this function:

◆ GetTemperatureSL()

virtual double GetTemperatureSL ( ) const

inlinevirtual

Returns the actual, modeled sea level temperature in degrees Rankine.

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

Definition at line 126 of file FGAtmosphere.h.

126 { return GetTemperature(0.0); }

JSBSim::FGAtmosphere::GetTemperature

virtual double GetTemperature() const

Returns the actual, modeled temperature at the current altitude in degrees Rankine.

Definition: FGAtmosphere.h:117

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Run()

bool Run ( bool Holding )

virtual

Runs the atmosphere forces model; called by the Executive.

Can pass in a value indicating if the executive is directing the simulation to Hold.

Parameters

Holding if 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 FGModel.

Reimplemented in MSIS.

Definition at line 101 of file FGAtmosphere.cpp.

 {
   if (FGModel::Run(Holding)) return true;
   if (Holding) return false;
 
   Calculate(in.altitudeASL);
 
   Debug(2);
   return false;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPressureSL()

void SetPressureSL	(	ePressure	unit,
		double	pressure
	)

virtual

Sets the sea level pressure for modeling.

Parameters

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

Reimplemented in FGStandardAtmosphere.

Definition at line 142 of file FGAtmosphere.cpp.

 {
   double press = ConvertToPSF(pressure, unit);
 
   SLpressure = press;
 }

Here is the caller graph for this function:

◆ SetTemperature()

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

pure virtual

Sets the temperature at the supplied altitude.

Parameters

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

Implemented in FGStandardAtmosphere.

Here is the caller graph for this function:

◆ SetTemperatureSL()

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

virtual

Sets the Sea Level temperature.

Parameters

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

Reimplemented in FGStandardAtmosphere.

Definition at line 169 of file FGAtmosphere.cpp.

 {
   SLtemperature = ConvertToRankine(t, unit);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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

Classes

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Properties

Member Function Documentation

◆ GetDensity() [1/2]

◆ GetDensity() [2/2]

◆ GetTemperature() [1/2]

◆ GetTemperature() [2/2]

◆ GetTemperatureRatio() [1/2]

◆ GetTemperatureRatio() [2/2]

◆ GetTemperatureSL()

◆ Run()

◆ SetPressureSL()

◆ SetTemperature()

◆ SetTemperatureSL()