JMechanics.hh

Go to the documentation of this file.

#ifndef __JACOUSTICS__JMECHANICS__
#define __JACOUSTICS__JMECHANICS__

#include <istream>
#include <ostream>
#include <iomanip>
#include <cmath>

#include "JLang/JManip.hh"
#include "JTools/JHashMap.hh"

/**
 * \file
 *
 * Mechanical modelling of string.
 * \author mdejong
 */
namespace JACOUSTICS {}
namespace JPP { using namespace JACOUSTICS; }

namespace JACOUSTICS {

  using JTOOLS::JHashMap;


  /**
   * Auxiliary data structure for parameters of mechanical model.\n
   * This data structure provides for the implementation of the effective height conform the mechanical model of string.
   */
  struct JMechanics {
    /**
     * Default constructor.
     */
    JMechanics() :
      a(0.0),
      b(0.0)
    {}


    /**
     * Constructor.
     *
     * \param  a                        logarithmic term
     * \param  b                        linear      term
     */
    JMechanics(const double a,
               const double b) :
      a(a),
      b(b)
    {}


    /**
     * Get effective height.
     *
     * \param  height                   height
     * \return                          height
     */
    double getHeight(const double height) const
    {
      return height  +  this->b * log(1.0 - this->a * height);
    }


    /**
     * Read parameters from input stream.
     *
     * \param  in                       input stream
     * \param  parameters               parameters
     * \return                          input stream
     */
    friend inline std::istream& operator>>(std::istream& in, JMechanics& parameters)
    {
      return in >> parameters.a >> parameters.b;
    }


    /**
     * Write parameters to output stream.
     *
     * \param  out                      output stream
     * \param  parameters               parameters
     * \return                          output stream
     */
    friend inline std::ostream& operator<<(std::ostream& out, const JMechanics& parameters)
    {
      return out << FIXED(7,5) << parameters.a << ' '
                 << FIXED(7,3) << parameters.b;
    }

    double a;   //!< <tt>0 <= a < (maximal height)⁻1;</tt>    [m^-1]
    double b;   //!< <tt>0 <= b;</tt>                         [m]
  };


  /**
   * Auxiliary data structure for mechanical model parameters of strings in a given detector.
   *
   * The template parameter corresponds to the detector identifier.\n
   * This scheme allows for extensions of an existing detector by derivation.
   */
  template<int detector = 0>
  struct JDetectorMechanics :
    public JHashMap<int, JMechanics>   
  {
    /**
     * Default constructor.
     */
    JDetectorMechanics()
    {}


    /**
     * Constructor.
     *
     * \param  mechanics               default mechanical parameters
     */
    JDetectorMechanics(const JMechanics& mechanics) :
      mechanics(mechanics)
    {}


    /**
     * Get mechanical parameters for given string.
     *
     * \param  string                  string number
     * \return                         mechanical parameters
     */
    virtual const JMechanics& get(const int string) const override
    {
      if (this->has(string))
        return static_cast<const JHashMap<int, JMechanics>&>(*this).get(string);
      else
        return mechanics;
    }

    JMechanics mechanics;              //!< default parameters
  };


  /**
   * Mechanical model parameters for specific detector.
   */
  template<>
  struct JDetectorMechanics<42> :
    public JDetectorMechanics<>
  {
    JDetectorMechanics() :
      JDetectorMechanics<>(JMechanics(0.00094, 294.291))
    {}
  };


  /**
   * Mechanical model parameters for specific detector.
   */
  template<>
  struct JDetectorMechanics<49> :
    public JDetectorMechanics<>
  {
    JDetectorMechanics() :
      JDetectorMechanics<>(JMechanics(0.00311,  85.967))
    {
      (*this)[9] = JMechanics();
    }
  };
 

  /**
   * Auxiliary data structure for mechanical model parameters of strings in any detector.
   */
  struct JGetMechanics : 
    public JHashMap<int, JDetectorMechanics<> > 
  {
    /**
     * Default constructor.
     */
    JGetMechanics()
    {
      (*this)[42] = JDetectorMechanics<42>();
      (*this)[49] = JDetectorMechanics<49>();
    }
  } getMechanics;
}

#endif