uwphysicalrogersmodel.h

Go to the documentation of this file.

//
// Copyright (c) 2017 Regents of the SIGNET lab, University of Padova.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. Neither the name of the University of Padova (SIGNET lab) nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
 
#ifndef UWPHYSICALROGERSMODEL_H
#define UWPHYSICALROGERSMODEL_H
 
#include <node-core.h>
#include <underwater-mpropagation.h>
#include <uwlib.h>
 
#include <cmath>
#include <iostream>
 
class UnderwaterPhysicalRogersModel : public UnderwaterMPropagation
{
 
public:
    UnderwaterPhysicalRogersModel();
 
    virtual ~UnderwaterPhysicalRogersModel()
    {
    }
 
    virtual int command(int, const char *const *);
 
protected:
    virtual double getGain(Packet *p);
 
    virtual double getAttenuation(const double &_sound_speed_water_bottom,
            const double &_distance, const double &_frequency,
            const double &_bottom_depth);
 
    inline const double
    getBeta() const
    {
        return (0.477 * get_M0() * get_N0() * get_Ks()) /
                sqrt(pow((1 - pow(get_N0(), 2)), 3));
    }
 
    inline const double
    get_Ks() const
    {
        // TODO: fix this and find the correct value
        return attenuation_coeff_sediment;
    }
 
    inline const double
    get_N0() const
    {
        return (sound_speed_water_bottom / sound_speed_sediment);
    }
 
    inline const double
    get_M0() const
    {
        return (density_sediment / density_water);
    }
 
    inline const double
    get_g() const
    {
        return std::abs(sound_speed_water_surface - sound_speed_water_bottom);
    }
 
    inline const double
    getTheta_g(const double &_bottom_depth, const double &_distance) const
    {
        return std::sqrt((1.7 * _bottom_depth) / (getBeta() * _distance));
    }
 
    inline const double
    getTheta_g_max(const double &_sound_speed_water_bottom) const
    {
        return std::sqrt((2 * get_g()) / (_sound_speed_water_bottom));
    }
 
    inline const double
    getTheta_c(const double &_sound_speed_water_bottom,
            const double &_frequency, const double &_bottom_depth) const
    {
        return (_sound_speed_water_bottom / (2 * _frequency * _bottom_depth));
    }
 
    double
    getThorp(double _frequency)
    {
        double f2_ = pow(_frequency, 2);
        // Thorp's eqution for frequencies above or below a few kHz is
        // different.
        if (_frequency >= 0.4)
            return (0.11 * f2_ / (1.0 + f2_) + 44.0 * f2_ / (4100.0 + f2_) +
                           2.75e-4 * f2_ + 0.003) *
                    FROMDBPERKYARDTODMPERM;
        else
            return (0.002 + 0.11 * f2_ / (1 + f2_) + 0.011 * f2_) *
                    FROMDBPERKYARDTODMPERM;
    }
 
#if __cplusplus <= 199711L
    static const double FROMDBPERKYARDTODMPERM =
            0.001093613298338; 
#else
    static constexpr double FROMDBPERKYARDTODMPERM =
            0.001093613298338; 
#endif
 
private:
    // Variables
    double bottom_depth; 
    double sound_speed_water_bottom; 
    double sound_speed_water_surface; 
    double sound_speed_sediment; 
    double density_sediment; 
    double density_water; 
    double attenuation_coeff_sediment; 
    int debug_; 
};
 
#endif /* UWPHYSICALROGERSMODEL_H  */