FGAtmosphere.h

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 Header:       FGAtmosphere.h
 Author:       Jon Berndt
 Date started: 6/2011

 ------------- Copyright (C) 2011  Jon S. Berndt (jon@jsbsim.org) -------------

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU Lesser General Public License as published by the Free Software
 Foundation; either version 2 of the License, or (at your option) any later
 version.

 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 details.

 You should have received a copy of the GNU Lesser General Public License along with
 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 Place - Suite 330, Boston, MA  02111-1307, USA.

 Further information about the GNU Lesser General Public License can also be found on
 the world wide web at http://www.gnu.org.

HISTORY
--------------------------------------------------------------------------------
5/2011   JSB   Created

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/

#ifndef FGATMOSPHERE_H
#define FGATMOSPHERE_H

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/

#include <vector>
#include "models/FGModel.h"

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DEFINITIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/

#define ID_ATMOSPHERE "$Id: FGAtmosphere.h,v 1.32 2016/01/10 15:56:30 bcoconni Exp $"

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/

namespace JSBSim {

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DOCUMENTATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/

class FGAtmosphere : public FGModel {
public:

  enum eTemperature {eNoTempUnit=0, eFahrenheit, eCelsius, eRankine, eKelvin};

  enum ePressure {eNoPressUnit=0, ePSF, eMillibars, ePascals, eInchesHg};

  FGAtmosphere(FGFDMExec*);

  virtual ~FGAtmosphere();

  bool Run(bool Holding);

  bool InitModel(void);

  //  *************************************************************************
  // @{
  virtual double GetTemperature() const {return Temperature;}

  virtual double GetTemperature(double altitude) const = 0; 

  virtual double GetTemperatureSL() const { return GetTemperature(0.0); }

  virtual double GetTemperatureRatio() const { return GetTemperature()*rSLtemperature; }

  virtual double GetTemperatureRatio(double h) const { return GetTemperature(h)*rSLtemperature; }

  virtual void SetTemperatureSL(double t, eTemperature unit=eFahrenheit);

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

  //  *************************************************************************

  virtual double GetPressure(void)  const {return Pressure;}

  virtual double GetPressure(double altitude) const = 0;

  // Returns the sea level pressure in target units, default in psf.
  virtual double GetPressureSL(ePressure to=ePSF) const { return ConvertFromPSF(SLpressure, to);  }

  virtual double GetPressureRatio(void) const { return Pressure*rSLpressure; }

  virtual void SetPressureSL(ePressure unit, double pressure);

  //  *************************************************************************


  virtual double GetDensity(void)  const {return Density;}

  virtual double GetDensity(double altitude) const;

  virtual double GetDensitySL(void)  const { return SLdensity; }

  virtual double GetDensityRatio(void) const { return Density*rSLdensity; }

  //  *************************************************************************

  virtual double GetSoundSpeed(void) const {return Soundspeed;}

  virtual double GetSoundSpeed(double altitude) const;
  
  virtual double GetSoundSpeedSL(void) const { return SLsoundspeed; }

  virtual double GetSoundSpeedRatio(void) const { return Soundspeed*rSLsoundspeed; }

  //  *************************************************************************

  virtual double GetAbsoluteViscosity(void) const {return Viscosity;}

  virtual double GetKinematicViscosity(void) const {return KinematicViscosity;}

  virtual double GetDensityAltitude() const {return DensityAltitude;}

  virtual double GetPressureAltitude() const {return PressureAltitude;}

  struct Inputs {
    double altitudeASL;
  } in;

protected:
  double    SLtemperature,    SLdensity,    SLpressure,    SLsoundspeed; // Sea level conditions
  double      Temperature,      Density,      Pressure,      Soundspeed; // Current actual conditions at altitude
  double   rSLtemperature,   rSLdensity,   rSLpressure,   rSLsoundspeed; // Reciprocal of sea level conditions

  double PressureAltitude;
  double DensityAltitude;

  const double SutherlandConstant, Beta;
  double Viscosity, KinematicViscosity;

  void Calculate(double altitude);

  // Converts to Rankine from one of several unit systems.
  virtual double ConvertToRankine(double t, eTemperature unit) const;
  
  // Converts to PSF (pounds per square foot) from one of several unit systems.
  virtual double ConvertToPSF(double t, ePressure unit=ePSF) const;

  // Converts from PSF (pounds per square foot) to one of several unit systems.
  virtual double ConvertFromPSF(double t, ePressure unit=ePSF) const;

  virtual void bind(void);
  void Debug(int from);
};

} // namespace JSBSim

//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#endif