aerosol_extinction_imp_base.h

Go to the documentation of this file.

#ifndef AEROSOL_EXTINCTION_IMP_BASE_H
#define AEROSOL_EXTINCTION_IMP_BASE_H
#include "aerosol_extinction.h"
#include "sub_state_vector_array.h"

namespace FullPhysics {
/****************************************************************/
class AerosolExtinctionImpBase: public SubStateVectorArray<AerosolExtinction> {
public:
  virtual ~AerosolExtinctionImpBase() {}
  virtual std::string aerosol_name() const {return aerosol_name_;}
  virtual ArrayAd<double, 1> aerosol_extinction() const
  { fill_cache(); return aext; }
  virtual AutoDerivative<double> extinction_for_layer(int i) const
  { fill_cache(); range_check(i, 0, aext.rows() - 1); 
    return (aext(i) + aext(i + 1)) / 2; }
  virtual boost::shared_ptr<AerosolExtinction> clone() const = 0;
  virtual boost::shared_ptr<AerosolExtinction> 
  clone(const boost::shared_ptr<Pressure>& Press) const = 0;
  virtual void update_sub_state_hook() 
  { cache_stale = true; }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  virtual std::string model_short_name() const = 0;
  
//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  virtual void print(std::ostream& Os) const { Os << desc(); }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  virtual std::string desc() const { return "AerosolExtinctionImpBase"; }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  blitz::Array<double, 1> aerosol_parameter() const
  {
    return coefficient().value();
  }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  blitz::Array<double, 1> aerosol_parameter_uncertainty() const
  {
    blitz::Array<double, 1> uncert(coefficient().rows());
    for(int i = 0; i < sv_cov_sub.rows(); i++)
      uncert(i) = (sv_cov_sub(i,i) > 0 ? sqrt(sv_cov_sub(i, i)) : 0.0);
    return uncert;
  }

protected:
//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  mutable bool cache_stale;

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  mutable ArrayAd<double, 1> aext;

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  virtual void calc_aerosol_extinction() const = 0;

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  virtual AutoDerivative<double> total_aod() const
  {
    ArrayAd<double, 1> pressure_grid = pressure()->pressure_grid().value;
    AutoDerivative<double> tot_aod = 0.0;
    for(int layer_idx = 0; layer_idx < pressure()->number_layer(); layer_idx++) {
      AutoDerivative<double> delta_press = (pressure_grid(layer_idx + 1) - pressure_grid(layer_idx)) / 2.0;
      tot_aod += (delta_press * (aext(layer_idx) + aext(layer_idx + 1) ));
    }
    return tot_aod;
  }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  void init(const std::string Aerosol_name,
            const blitz::Array<double, 1>& Coeff, 
            const blitz::Array<bool, 1>& Used_flag,
            const boost::shared_ptr<Pressure>& Press,
            bool Mark_according_to_press = true,
            int Pdep_start = 0)
  { SubStateVectorArray<AerosolExtinction>::init(Coeff, Used_flag, Press,
                                           Mark_according_to_press,
                                           Pdep_start);
    aerosol_name_ = Aerosol_name;
  }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  AerosolExtinctionImpBase() : cache_stale(true) { }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  AerosolExtinctionImpBase(const std::string& Aerosol_name,
                     const blitz::Array<double, 1>& Coeff, 
                     const blitz::Array<bool, 1>& Used_flag,
                     const boost::shared_ptr<Pressure>& Press,
                     bool Mark_according_to_press = true,
                      int Pdep_start = 0)
    : SubStateVectorArray<AerosolExtinction>(Coeff, Used_flag, Press,
                                             Mark_according_to_press, Pdep_start),
      cache_stale(true), aerosol_name_(Aerosol_name) { }
private:
  void fill_cache() const
  {
    if(cache_stale) {
      aext.resize_number_variable(coeff.number_variable());
      calc_aerosol_extinction();
    }
    cache_stale = false;
  }
  std::string aerosol_name_;
};
}
#endif