ATMProfile.h

Go to the documentation of this file.

#ifndef _ATM_PROFILE_H
#define _ATM_PROFILE_H
/*******************************************************************************
 * ALMA - Atacama Large Millimiter Array
 * (c) Instituto de Estructura de la Materia, 2009
 *
 * This library 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.1 of the License, or (at your option) any later version.
 *
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 * "@(#) $Id: ATMProfile.h Exp $"
 *
 * who       when      what
 * --------  --------  ----------------------------------------------
 * pardo     24/03/09  created
 */

#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif

#include "ATMCommon.h"
#include "ATMHumidity.h"
#include "ATMLength.h"
#include "ATMMassDensity.h"
#include "ATMNumberDensity.h"
#include "ATMPressure.h"
#include "ATMTemperature.h"
#include "ATMEnumerations.h"

#include <string>
#include <vector>

using std::string;
using std::vector;


ATM_NAMESPACE_BEGIN

class AtmProfile
{
public:
  AtmProfile(unsigned int n);

  AtmProfile(const Length &altitude,
             const Pressure &groundPressure,
             const Temperature &groundTemperature,
             double tropoLapseRate,
             const Humidity &relativeHumidity,
             const Length &wvScaleHeight,
             const Pressure &pressureStep,
             double pressureStepFactor,
             const Length &topAtmProfile,
             unsigned int atmType); //Atmospheretype atmType);

  
  AtmProfile(const Length &altitude,
             const Pressure &groundPressure,
             const Temperature &groundTemperature,
             double tropoLapseRate,
             const Humidity &relativeHumidity,
             const Length &wvScaleHeight,
             const Pressure &pressureStep,
             double pressureStepFactor,
             const Length &topAtmProfile,
             unsigned int atmType,
             const vector<Length> &v_layerBoundaries,
             const vector<Temperature> &v_layerTemperature); 


  
  /*
   AtmProfile(Length altitude, Pressure    groundPressure,
   Temperature groundTemperature, double  tropoLapseRate,
   Humidity relativeHumidity, Length wvScaleHeight,
   Pressure pressureStep, double pressureStepFactor,
   Length topAtmProfile, int typeAtm);

   */

  AtmProfile(const Length &altitude,
             const Pressure &groundPressure,
             const Temperature &groundTemperature,
             double tropoLapseRate,
             const Humidity &relativeHumidity,
             const Length &wvScaleHeight,
             unsigned int atmType); //Atmospheretype atmType);

  /*AtmProfile(const Length &altitude,
             const Pressure &groundPressure,
             const Temperature &groundTemperature,
             const Humidity &relativeHumidity,
             const vector<Length> &v_layerTop,
             const vector<Pressure> &v_layerTopPressure,
             const vector<Temperature> &v_layerTopTemperature,
             const vector<Humidity> &v_layerTopHumidity); */
  
  AtmProfile(const Length &altitude,
             const vector<Length> &v_layerThickness,
             const vector<Pressure> &v_layerPressure,
             const vector<Temperature> &v_layerTemperature,
             const vector<MassDensity> &v_layerWaterVapor);
  AtmProfile(const vector<Length> &v_layerBoundaries,
             const vector<Pressure> &v_layerPressure,
             const vector<Temperature> &v_layerTemperature,
             const vector<MassDensity> &v_layerWaterVapor);

  AtmProfile(const Length &altitude,
             const vector<Length> &v_layerThickness,
             const vector<Pressure> &v_layerPressure,
             const vector<Temperature> &v_layerTemperature,
             const vector<NumberDensity> &v_layerWaterVapor);
  AtmProfile(const vector<Length> &v_layerBoundaries,
             const vector<Pressure> &v_layerPressure,
             const vector<Temperature> &v_layerTemperature,
             const vector<NumberDensity> &v_layerWaterVapor);

  AtmProfile(const Length &altitude,
             const vector<Length> &v_layerThickness,
             const vector<Pressure> &v_layerPressure,
             const vector<Temperature> &v_layerTemperature,
             const vector<MassDensity> &v_layerWaterVapor,
             const vector<NumberDensity> &v_layerO3);
  AtmProfile(const Length &altitude,
             const vector<Length> &v_layerThickness,
             const vector<Pressure> &v_layerPressure,
             const vector<Temperature> &v_layerTemperature,
             const vector<NumberDensity> &v_layerWaterVapor,
             const vector<NumberDensity> &v_layerO3);

  AtmProfile(const Length &altitude,
             const vector<Length> &v_layerThickness,
             const vector<Pressure> &v_layerPressure,
             const vector<Temperature> &v_layerTemperature,
             const vector<MassDensity> &v_layerWaterVapor,
             const vector<NumberDensity> &v_layerO3,
             const vector<NumberDensity> &v_layerCO,
             const vector<NumberDensity> &v_layerN2O,
             const vector<NumberDensity> &v_layerNO2,
             const vector<NumberDensity> &v_layerSO2);

  AtmProfile(const Length &altitude,
             const vector<Length> &v_layerThickness,
             const vector<Pressure> &v_layerPressure,
             const vector<Temperature> &v_layerTemperature,
             const vector<NumberDensity> &v_layerWaterVapor,
             const vector<NumberDensity> &v_layerO3,
             const vector<NumberDensity> &v_layerCO,
             const vector<NumberDensity> &v_layerN2O,
             const vector<NumberDensity> &v_layerNO2,
             const vector<NumberDensity> &v_layerSO2);

  AtmProfile(const AtmProfile &a); // copy constructor

  virtual ~AtmProfile() {}

  bool setBasicAtmosphericParameters(const Length &altitude,
                                     const Pressure &groundPressure,
                                     const Temperature &groundTemperature,
                                     double tropoLapseRate,
                                     const Humidity &relativeHumidity,
                                     const Length &wvScaleHeight);

  string getAtmosphereType() const;

  static string getAtmosphereType(unsigned int typeAtm);
 
  Temperature getGroundTemperature() const { return groundTemperature_; }

  double getTropoLapseRate() const { return tropoLapseRate_; }

  Pressure getGroundPressure() const { return groundPressure_; }

  Temperature getTropopauseTemperature() const { return tropoTemperature_; }

  Humidity getRelativeHumidity() const { return relativeHumidity_; }

  Length getWvScaleHeight() const { return wvScaleHeight_; }

  Pressure getPressureStep() const { return pressureStep_; }

  Pressure getPressureStepFactor() const { return pressureStepFactor_; }

  Length getAltitude() const { return altitude_; }

  Length getGroundAltitude() const { return altitude_; }

  void setAltitude(const Length &groundaltitude);

  // void setGroundAltitude(const Length &groundaltitude);
 
  Length getTropopauseAltitude() const { return tropoAltitude_; }

  Length getTopAtmProfile() const { return topAtmProfile_; }

  unsigned int getNumLayer() const { return numLayer_; }

  vector<Temperature> getTemperatureProfile() const;

  Temperature getLayerTemperature(unsigned int i) const;

  Temperature getLayerBottomTemperature(unsigned int i) const;

  Temperature getLayerTopTemperature(unsigned int i) const;
  
  void setLayerTemperature(unsigned int i, const Temperature &layerTemperature);

  vector<Length> getThicknessProfile() const;

  Length getLayerThickness(unsigned int i) const;

  void setLayerThickness(unsigned int i, const Length &layerThickness);
  //void setLayerThickness(const Length &layerThickness, unsigned int i) { setLayerThickness(i, layerThickness); }

  Length getLayerBottomHeightAboveGround(unsigned int i) const;

  Length getLayerBottomHeightAboveSeaLevel(unsigned int i) const;
  
  
  Length getLayerTopHeightAboveGround(unsigned int i) const;
  
  Length getLayerTopHeightAboveSeaLevel(unsigned int i) const;

  
  MassDensity getLayerWaterVaporMassDensity(unsigned int i) const;
  MassDensity getLayerBottomWaterVaporMassDensity(unsigned int i) const;
  MassDensity getLayerTopWaterVaporMassDensity(unsigned int i) const;
  NumberDensity getLayerWaterVaporNumberDensity(unsigned int i) const;
  NumberDensity getLayerBottomWaterVaporNumberDensity(unsigned int i) const;
  NumberDensity getLayerTopWaterVaporNumberDensity(unsigned int i) const;

  void setLayerWaterVaporMassDensity(unsigned int i, const MassDensity &layerWaterVapor);
  //void setLayerWaterVaporMassDensity(const MassDensity &layerWaterVapor, unsigned int i) { setLayerWaterVaporMassDensity(i, layerWaterVapor); }
  void setLayerWaterVaporNumberDensity(unsigned int i, const NumberDensity &layerWaterVapor);
  //void setLayerWaterVapor(const NumberDensity &layerWaterVapor, unsigned int i) { setLayerWaterVapor(i, layerWaterVapor); }

  vector<Pressure> getPressureProfile() const;

  Pressure getLayerPressure(unsigned int i) const;

  Pressure getLayerBottomPressure(unsigned int i) const;

  Pressure getLayerTopPressure(unsigned int i) const;

  void setLayerPressure(unsigned int i, const Pressure &layerPressure) { v_layerPressure_[i] = layerPressure.get("mb"); }
  //void setLayerPressure(const Pressure &layerPressure, unsigned int i) { setLayerPressure(i, layerPressure); }

  NumberDensity getLayerCO(unsigned int i) const { return NumberDensity(v_layerCO_[i], "m**-3"); }
  void setLayerCO(unsigned int i, const NumberDensity &layerCO) { v_layerCO_[i] = layerCO.get("m**-3"); }
  //void setLayerCO(const NumberDensity &layerCO, unsigned int i) { setLayerCO(i, layerCO); }

  NumberDensity getLayerO3(unsigned int i) const { return NumberDensity(v_layerO3_[i], "m**-3"); }
  void setLayerO3(unsigned int i, const NumberDensity &layerO3) { v_layerO3_[i] = layerO3.get("m**-3"); }
  //void setLayerO3(const NumberDensity &layerO3, unsigned int i) { setLayerO3(i, layerO3); }

  NumberDensity getLayerN2O(unsigned int i) const { return NumberDensity(v_layerN2O_[i], "m**-3"); }
  void setLayerN2O(unsigned int i, const NumberDensity &layerN2O) { v_layerN2O_[i] = layerN2O.get("m**-3"); }
  //void setLayerN2O(const NumberDensity &layerN2O, unsigned int i) { setLayerN2O(i, layerN2O); }

  NumberDensity getLayerNO2(unsigned int i) const { return NumberDensity(v_layerNO2_[i], "m**-3"); }
  void setLayerNO2(unsigned int i, const NumberDensity &layerNO2) { v_layerNO2_[i] = layerNO2.get("m**-3"); }
  //void setLayerNO2(const NumberDensity &layerNO2, unsigned int i) { setLayerNO2(i, layerNO2); }

  NumberDensity getLayerSO2(unsigned int i) const { return NumberDensity(v_layerSO2_[i], "m**-3"); }
  void setLayerSO2(unsigned int i, const NumberDensity &layerSO2) { v_layerSO2_[i] = layerSO2.get("m**-3"); }
  //void setLayerSO2(const NumberDensity &layerSO2, unsigned int i) { setLayerSO2(i, layerSO2); }

  void setBasicAtmosphericParameterThresholds(const Length &altitudeThreshold,
                                             const Pressure &groundPressureThreshold,
                                             const Temperature &groundTemperatureThreshold,
                                             double tropoLapseRateThreshold,
                                             const Humidity &relativeHumidityThreshold,
                                             const Length &wvScaleHeightThreshold);
  

  Length getGroundWH2O() const;

  // Thresholds
  Length      getAltitudeThreshold()   const {return altitudeThreshold_;};
  Pressure    getGroundPressureThreshold() const {return groundPressureThreshold_;};
  Temperature getGroundTemperatureThreshold() const {return groundTemperatureThreshold_;};
  double      getTropoLapseRateThreshold() const {return tropoLapseRateThreshold_;};
  Humidity    getRelativeHumidityThreshold() const {return relativeHumidityThreshold_;};
  Length      getWvScaleHeightThreshold() const {return wvScaleHeightThreshold_;};

  void        setAltitudeThreshold(const Length &altitudeThreshold) {altitudeThreshold_=altitudeThreshold;};
  void        setGroundPressureThreshold(const Pressure &groundPressureThreshold) {groundPressureThreshold_=groundPressureThreshold;};
  void        setGroundTemperatureThreshold(const Temperature &groundTemperatureThreshold) {groundTemperatureThreshold_=groundTemperatureThreshold;};



protected:
  unsigned int typeAtm_; 
  Temperature groundTemperature_; 
  double tropoLapseRate_; 
  Temperature tropoTemperature_; 
  unsigned int tropoLayer_; 
  Length tropoAltitude_; 
  Pressure groundPressure_; 
  Humidity relativeHumidity_; 
  Length wvScaleHeight_; 
  Pressure pressureStep_; 
  double pressureStepFactor_; 
  Length altitude_; 
  Length topAtmProfile_; 
  unsigned int numLayer_; 
  double fractionLast_;  
  bool newBasicParam_;
  vector<double> v_layerThickness_; 
  vector<double> v_layerTemperature_; 
  vector<double> v_layerTemperature0_; 
  vector<double> v_layerTemperature1_; 
  vector<double> v_layerWaterVapor_; 
  vector<double> v_layerWaterVapor0_; 
  vector<double> v_layerWaterVapor1_; 
  vector<double> v_layerPressure_; 
  vector<double> v_layerPressure0_; 
  vector<double> v_layerPressure1_; 
  vector<double> v_layerCO_; 
  vector<double> v_layerO3_; 
  vector<double> v_layerN2O_; 
  vector<double> v_layerNO2_; 
  vector<double> v_layerSO2_; 
  Length altitudeThreshold_;
  Pressure groundPressureThreshold_;
  Temperature groundTemperatureThreshold_;
  double tropoLapseRateThreshold_;
  Humidity relativeHumidityThreshold_;
  Length wvScaleHeightThreshold_;

  unsigned int ier_;

  AtmProfile() {}

  /*
   * \fn Method to build the profile,
   */
  unsigned int mkAtmProfile(); 
  bool updateAtmProfile(const Length &altitude,
                        const Pressure &groundPressure,
                        const Temperature &groundTemperature,
                        double tropoLapseRate,
                        const Humidity &relativeHumidity,
                        const Length &wvScaleHeight);
  void initBasicAtmosphericParameterThresholds();

private:
  MassDensity rwat(const Temperature &t, const Humidity &rh, const Pressure &p) const;
  Humidity rwat_inv(const Temperature &tt, const MassDensity &dd, const Pressure &pp) const;
  vector<NumberDensity> st76(const Length &ha, unsigned int tip) const;
  double poli2(double ha,
               double x1,
               double x2,
               double x3,
               double y1,
               double y2,
               double y3) const;
  /*
   // static Pressure pressureStep_default(  10.0,"mb");
   //  static double pSd; // = 10.0;  // pressureStep_default in mb
   static Pressure pressureStep_default_;


   static double pressureStepFactor_default_; // =    1.2;
   //static double pSFd; // = 1.2;



   static Length  topAtmProfile_default_; //(  48.0,"km");
   //static tAPd; // = 48.0;
   */

  //static Atmospheretype atmType_default =  tropical;

}; // class AtmProfile

ATM_NAMESPACE_END
/*
  Pressure AtmProfile::pressureStep_default_(Pressure(1.2,"mb"));
  double AtmProfile::pressureStepFactor_default_(1.2);
  Length AtmProfile::topAtmProfile_default_(Length(48,"km"));
*/

#endif