FGMSIS.h

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 Header:       FGMSIS.h
 Description:  MSIS-00 Atmosphere
 Author:       David Culp
 Date started: 12/14/03
 
 ------------- Copyright (C) 2003  David P. Culp (davidculp2@comcast.net) ------
 
 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
--------------------------------------------------------------------------------
12/14/03   DPC   Created
01/11/04   DPC   Derive from FGAtmosphere
03/18/23   BC    Refactored
 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#ifndef FGMSIS_H
#define FGMSIS_H
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#include "models/atmosphere/FGStandardAtmosphere.h"
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
extern "C" {
#include "MSIS/nrlmsise-00.h"
}
 
namespace JSBSim {
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DOCUMENTATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
class JSBSIM_API FGMSIS : public FGStandardAtmosphere
{
public:
 
  FGMSIS(FGFDMExec*);
  ~FGMSIS();
  bool InitModel(void) override;
  bool Load(Element* el) override;
 
  using FGAtmosphere::GetTemperature;  // Prevent C++ from hiding GetTemperature(void)
  double GetTemperature(double altitude) const override {
    double t, p, rho, R;
    Compute(altitude, p, t, rho, R);
    return t;
  }
 
  using FGAtmosphere::GetPressure;  // Prevent C++ from hiding GetPressure(void)
  double GetPressure(double altitude) const override {
    double t, p, rho, R;
    Compute(altitude, p, t, rho, R);
    return p;
  }
 
  using FGAtmosphere::GetDensity;  // Prevent C++ from hiding GetDensity(void)
  double GetDensity(double altitude) const override {
    double t, p, rho, R;
    Compute(altitude, p, t, rho, R);
    return rho;
  }
 
  using FGAtmosphere::GetSoundSpeed;  // Prevent C++ from hiding GetSoundSpeed(void)
  double GetSoundSpeed(double altitude) const override {
    double t, p, rho, R;
    Compute(altitude, p, t, rho, R);
    return sqrt(FGAtmosphere::SHRatio*R*t);
  }
 
protected:
  void Calculate(double altitude) override;
  void Compute(double altitude, double& pression, double& temperature,
                double& density, double &Rair) const;
 
  double day_of_year = 1.0;
  double seconds_in_day = 0.0;
 
  mutable struct nrlmsise_flags flags;
  mutable struct nrlmsise_input input;
 
private:
  // Setting temperature & pressure is not allowed in this model.
  void SetTemperature(double t, double h, eTemperature unit) override {};
  void SetTemperatureSL(double t, eTemperature unit) override {};
  void SetPressureSL(ePressure unit, double pressure) override {};
  void Debug(int from) override;
};
 
} // namespace JSBSim
 
//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
#endif