soundspeed.h

Go to the documentation of this file.

// Copyright 2010-2021:
//   GobySoft, LLC (2013-)
//   Massachusetts Institute of Technology (2007-2014)
//   Community contributors (see AUTHORS file)
// File authors:
//   Toby Schneider <toby@gobysoft.org>
//
//
// This file is part of the Goby Underwater Autonomy Project Libraries
// ("The Goby Libraries").
//
// The Goby Libraries are free software: you can redistribute them and/or modify
// them under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 2.1 of the License, or
// (at your option) any later version.
//
// The Goby Libraries are distributed in the hope that they will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Goby.  If not, see <http://www.gnu.org/licenses/>.
 
#ifndef GOBY_UTIL_SEAWATER_SOUNDSPEED_H
#define GOBY_UTIL_SEAWATER_SOUNDSPEED_H
 
#include <stdexcept>
 
#include <boost/units/quantity.hpp>
#include <boost/units/systems/si.hpp>
#include <boost/units/systems/temperature/celsius.hpp>
 
namespace goby
{
namespace util
{
namespace seawater
{
template <typename TemperatureUnit = boost::units::celsius::temperature,
          typename DimensionlessUnit = boost::units::si::dimensionless,
          typename LengthUnit = boost::units::si::length>
boost::units::quantity<boost::units::si::velocity>
mackenzie_soundspeed(boost::units::quantity<boost::units::absolute<TemperatureUnit>> temperature,
                     boost::units::quantity<DimensionlessUnit> salinity,
                     boost::units::quantity<LengthUnit> depth, bool ignore_bounds = false)
{
    using namespace boost::units;
 
    double T = quantity<absolute<celsius::temperature> >(temperature).value();
    double S = quantity<si::dimensionless>(salinity).value();
    double D = quantity<si::length>(depth).value();
 
    double min_T(-2);
    double max_T(30);
 
    double min_S(25);
    double max_S(40);
 
    double min_D(0);
    double max_D(8000);
 
    if (!ignore_bounds)
    {
        if (T < min_T || T > max_T)
            throw std::out_of_range("Temperature not in valid range [-2, 30] deg C");
        if (S < min_S || S > max_S)
            throw std::out_of_range("Salinity not in valid range [25, 40]");
        if (D < min_D || D > max_D)
            throw std::out_of_range("Depth not in valid range [0, 8000] meters");
    }
 
    return (1448.96 + 4.591 * T - 5.304e-2 * T * T + 2.374e-4 * T * T * T + 1.340 * (S - 35) +
            1.630e-2 * D + 1.675e-7 * D * D - 1.025e-2 * T * (S - 35) - 7.139e-13 * T * D * D * D) *
           si::meters_per_second;
}
 
template <typename TemperatureUnit = boost::units::celsius::temperature,
          typename LengthUnit = boost::units::si::length>
boost::units::quantity<boost::units::si::velocity>
mackenzie_soundspeed(boost::units::quantity<boost::units::absolute<TemperatureUnit>> temperature,
                     double salinity, boost::units::quantity<LengthUnit> depth,
                     bool ignore_bounds = false)
{
    return mackenzie_soundspeed(temperature,
                                boost::units::quantity<boost::units::si::dimensionless>(salinity),
                                depth, ignore_bounds);
}
} // namespace seawater
} // namespace util
} // namespace goby
 
#endif