MSIS Class Reference

Inheritance diagram for MSIS:

Collaboration diagram for MSIS:

Public Member Functions
	MSIS (FGFDMExec *)
	Constructor.
	~MSIS ()
	Destructor.
bool	InitModel (void)
bool	Run (bool Holding)
	Runs the MSIS-00 atmosphere model; called by the Executive Can pass in a value indicating if the executive is directing the simulation to Hold. More...
void	UseExternal (void)
	Does nothing. External control is not allowed.
Public Member Functions inherited from FGAtmosphere
	FGAtmosphere (FGFDMExec *)
	Constructor.
virtual	~FGAtmosphere ()
	Destructor.
virtual double	GetDensityAltitude () const
virtual double	GetPressureAltitude () const
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...
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...
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.
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.
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...

Additional Inherited Members
Public Types inherited from FGAtmosphere
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.
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...
Public Attributes inherited from FGAtmosphere
struct JSBSim::FGAtmosphere::Inputs	in
Public Attributes inherited from FGModel
std::string	Name
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
Protected Member Functions inherited from FGAtmosphere
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
Protected Member Functions inherited from FGModel
virtual bool	Load (Element *el)
	Loads this model. More...
Protected Member Functions inherited from FGJSBBase
void	Debug (int)
Static Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)
Protected Attributes inherited from FGAtmosphere
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
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/(fttom*fttom*fttom)
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

Definition at line 229 of file FGMSIS.h.

Member Function Documentation

Run()

bool Run ( bool  Holding )

virtual

Runs the MSIS-00 atmosphere 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 FGAtmosphere.

Definition at line 159 of file FGMSIS.cpp.

{
  if (FGModel::Run(Holding)) return true;
  if (Holding) return false;

  double h = FDMExec->GetPropagate()->GetAltitudeASL();

  //do temp, pressure, and density first
  //if (!useExternal) {
    // get sea-level values
    Calculate(FDMExec->GetAuxiliary()->GetDayOfYear(),
              FDMExec->GetAuxiliary()->GetSecondsInDay(),
              0.0,
              FDMExec->GetPropagate()->GetLocation().GetLatitudeDeg(),
              FDMExec->GetPropagate()->GetLocation().GetLongitudeDeg());
    SLtemperature = output.t[1] * 1.8;
    SLdensity     = output.d[5] * 1.940321;
    SLpressure    = 1716.488 * SLdensity * SLtemperature;
    SLsoundspeed  = sqrt(2403.0832 * SLtemperature);
    rSLtemperature = 1.0/SLtemperature;
    rSLpressure    = 1.0/SLpressure;
    rSLdensity     = 1.0/SLdensity;
    rSLsoundspeed  = 1.0/SLsoundspeed;

    // get at-altitude values
    Calculate(FDMExec->GetAuxiliary()->GetDayOfYear(),
              FDMExec->GetAuxiliary()->GetSecondsInDay(),
              h,
              FDMExec->GetPropagate()->GetLocation().GetLatitudeDeg(),
              FDMExec->GetPropagate()->GetLocation().GetLongitudeDeg());
    //intTemperature = output.t[1] * 1.8;
    //intDensity     = output.d[5] * 1.940321;
    //intPressure    = 1716.488 * intDensity * intTemperature;
    //cout << "T=" << intTemperature << " D=" << intDensity << " P=";
    //cout << intPressure << " a=" << soundspeed << endl;
  //}

  Debug(2);

  return false;
}

Here is the call graph for this function:

---

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

• FGMSIS.h
• FGMSIS.cpp