absorber.h

Go to the documentation of this file.

#ifndef ABSORBER_H
#define ABSORBER_H
#include "absorber_vmr.h"
#include "state_vector_observer.h"
#include "observer.h"
#include "auto_derivative.h"
#include "accumulated_timer.h"
#include <vector>

namespace FullPhysics {
  class Pressure;
  class Temperature;
  class Altitude;
/****************************************************************/
class Absorber : virtual public StateVectorObserver,
                    public Observable<Absorber> {
public:
  virtual ~Absorber() {}
  static AccumulatedTimer timer;
  virtual void add_observer(Observer<Absorber>& Obs) 
  { add_observer_do(Obs, *this);}
  virtual void remove_observer(Observer<Absorber>& Obs) 
  { remove_observer_do(Obs, *this);}

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

  virtual int number_species() const 
  { 
    // Not sure of what the issue is, but SWIG 2.0.9 isn't happy with this
    // being a pure virtual. Just return a default value, this function gets
    // overridden by any "real" class derived from Absorber.
    return 0; 
  }

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

  virtual std::string gas_name(int Species_index) const = 0;

  virtual int gas_index(const std::string& Name) const;

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

  virtual ArrayAd<double, 2> 
  optical_depth_each_layer(double wn, int spec_index) const = 0;

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------
  
  virtual AutoDerivative<double> xgas(const std::string& Gas_name) const = 0;

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

  virtual boost::shared_ptr<AbsorberVmr> absorber_vmr(const std::string& gas_name) const = 0;

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

  virtual boost::shared_ptr<Absorber> clone() const = 0;

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

  virtual boost::shared_ptr<Absorber> clone
    (const boost::shared_ptr<Pressure>& Press,
     const boost::shared_ptr<Temperature>& Temp,
     const std::vector<boost::shared_ptr<Altitude> >& Alt) const = 0;

};
}
#endif