sim_impulse.hpp

/* sim_impulse.hpp */
/* $Id$ */
#ifndef __sim_impulse_hpp
#define __sim_impulse_hpp

#include <s2proc/trace.hpp>
#include <s2proc/sim_service.hpp>

namespace sim
{
  enum ImpulseType
  {
    IT_RICKER = 0, 
    IT_DIRAC,      
    IT_USER        
  };
  
  std::string toString(const ImpulseType &it);
  
  class Impulse
  {
  public:
    
    Impulse(const AmplT &gain = 1.): m_gain(gain) {/* nothing to do. */}
    
    virtual ~Impulse() {/* nothing to do. */}
    
    virtual Impulse* clone() const = 0;
    
    
    virtual void setGain(const AmplT &gain) {m_gain = gain;}

    virtual const AmplT& gain() const {return m_gain;}


    virtual AmplT operator()(const TimeT &t) const = 0;
    
    virtual ImpulseType type() const = 0; 
    
  protected:
    
    AmplT m_gain; 
  };
  
  
  class RickerImpulse : public Impulse
  {
  public:
    
    RickerImpulse(const FreqT &i_w, const AmplT &gain = 1.): 
      Impulse(gain), m_w(i_w){/* nothing to do */}
        
    virtual ~RickerImpulse() 
    {/* nothing to do. */}
    
    virtual Impulse* clone() const;
    
    FreqT w() const {return m_w;}
    
    virtual AmplT operator()(const TimeT &t) const;
    
    virtual ImpulseType type() const {return IT_RICKER;}
    
  private:
    
    FreqT m_w;  
  };
  
  
  class DiracImpulse : public Impulse
  {
  public:
    
    DiracImpulse(const TimeT &i_eps, const AmplT &gain = 1.): 
      Impulse(gain), m_eps(i_eps) {/* nothing to do. */}
    
    virtual ~DiracImpulse() {/* nothing to do. */}
    
    virtual Impulse* clone() const;
        
    virtual AmplT operator()(const TimeT &t) const;
    
    virtual ImpulseType type() const {return IT_DIRAC;}
    
  protected:
    
    TimeT m_eps; 
  };

  
  class UserImpulse : public Impulse
  {
  public:
    
    UserImpulse(const Trace &tr, const AmplT &gain = 1.): 
      Impulse(gain), m_tr(tr) {/* nothing to do. */}
    
    virtual ~UserImpulse() {/* nothing to do. */}
    
    virtual Impulse* clone() const;
        
    virtual AmplT operator()(const TimeT &t) const;
    
    virtual ImpulseType type() const {return IT_USER;}
    
  protected:
    
    Trace m_tr; 
  };
  
}; // simulation namespace

#endif /* sim_impulse.hpp */