absorber_vmr_imp_base.h

Go to the documentation of this file.

#ifndef ABSORBER_VMR_IMP_BASE_H
#define ABSORBER_VMR_IMP_BASE_H
#include "absorber_vmr.h"
#include "sub_state_vector_array.h"
#include <boost/function.hpp>

namespace FullPhysics {
/****************************************************************/
class AbsorberVmrImpBase: public SubStateVectorArray<AbsorberVmr> {
public:
  virtual ~AbsorberVmrImpBase() {}
  virtual std::string gas_name() const {return gas_name_;}
  virtual AutoDerivative<double> 
  volume_mixing_ratio(const AutoDerivative<double>& P) const
  { fill_cache(); return vmr(P); }
  virtual boost::shared_ptr<AbsorberVmr> clone() const = 0;
  virtual boost::shared_ptr<AbsorberVmr> 
  clone(const boost::shared_ptr<Pressure>& Press) const = 0;
  virtual void update_sub_state_hook() 
  { cache_stale = true; }
  
//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  virtual void print(std::ostream& Os) const { Os << desc(); }

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

  virtual blitz::Array<bool, 1> state_used() const
  {
    blitz::Array<bool, 1> res(sv_full.rows());
    res = false;
    if(state_vector_start_index() < res.rows())
      res(blitz::Range(state_vector_start_index(), 
           state_vector_start_index() + sub_vector_size() - 1)) = true;
    return res;
  }
protected:
//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  mutable bool cache_stale;

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  mutable boost::function<AutoDerivative<double>(AutoDerivative<double>)> vmr;

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

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

  void init(const std::string Gas_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<AbsorberVmr>::init(Coeff, Used_flag, Press,
                                           Mark_according_to_press,
                                           Pdep_start);
    gas_name_ = Gas_name;
  }

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

  AbsorberVmrImpBase() : cache_stale(true) { }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  AbsorberVmrImpBase(const std::string& Gas_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<AbsorberVmr>(Coeff, Used_flag, Press,
                                       Mark_according_to_press, Pdep_start),
      cache_stale(true), gas_name_(Gas_name) { }
private:
  void fill_cache() const
  {
    if(cache_stale)
      calc_vmr();
    cache_stale = false;
  }
  std::string gas_name_;
};
}
#endif