JACOUSTICS::JSoundVelocity Struct Reference

Implementation for velocity of sound. More...

#include <JSoundVelocity.hh>

Inheritance diagram for JACOUSTICS::JSoundVelocity:

Public Member Functions
	JSoundVelocity (const double a, const double b, const double z0)
	Constructor. More...
JSoundVelocity &	set (const double z0)
	Set depth. More...
JSoundVelocity	operator[] (const double z0) const
	Get sound velocity at given depth. More...
virtual double	operator() () const
	Get velocity of sound. More...
virtual double	operator() (const double z) const
	Get velocity of sound at given depth relative to seabed. More...
virtual double	getDistance (const double t_s, const double z1, const double z2) const
	Get distance travelled by sound. More...
virtual double	getTime (const double D_m, const double z1, const double z2) const
	Get propagation time of sound. More...
virtual double	getInverseVelocity (const double D_m, const double z1, const double z2) const
	Get inverse velocity of sound. More...

Private Attributes
double	a
double	b
double	z0

Friends
std::istream &	operator>> (std::istream &in, JSoundVelocity &velocity)
	Read sound velocity from input. More...
std::ostream &	operator<< (std::ostream &out, const JSoundVelocity &velocity)
	Write sound velocity to output. More...

Detailed Description

Implementation for velocity of sound.

Note that

• z-axis is pointing upwards; and
• velocity is defined at a given depth.

The depth is commonly referred to as the seabed.

Definition at line 31 of file JSoundVelocity.hh.

Constructor & Destructor Documentation

JACOUSTICS::JSoundVelocity::JSoundVelocity ( const double  a, const double  b, const double  z0  )

inline

Constructor.

Note that depth is negative.

Parameters

a	velocity [m/s]
b	d(v)/d(z) [m/s/m]
z0	depth [m]

Definition at line 43 of file JSoundVelocity.hh.

                                                                    :
      a (a),
      b (b),
      z0(z0)
    {}

Member Function Documentation

JSoundVelocity& JACOUSTICS::JSoundVelocity::set ( const double  z0 )

inline

Set depth.

Note that depth is negative.

Parameters

z0

depth [m]

Returns

this sound velocity

Definition at line 58 of file JSoundVelocity.hh.

    {
      this->a  += this->b * (z0 - this->z0);
      this->z0  = z0;
      
      return *this;
    }

JSoundVelocity JACOUSTICS::JSoundVelocity::operator[] ( const double  z0 ) const

inline

Get sound velocity at given depth.

Note that depth is negative.

Parameters

z0

depth [m]

Returns

sound velocity

Definition at line 75 of file JSoundVelocity.hh.

    {
      return JSoundVelocity(*this).set(z0);
    }

virtual double JACOUSTICS::JSoundVelocity::operator() ( ) const

inlinevirtual

Get velocity of sound.

Returns

velocity [m/s]

Implements JACOUSTICS::JAbstractSoundVelocity.

Definition at line 86 of file JSoundVelocity.hh.

    {
      return a;
    }

virtual double JACOUSTICS::JSoundVelocity::operator() ( const double  z ) const

inlinevirtual

Get velocity of sound at given depth relative to seabed.

Parameters

z

depth [m]

Returns

velocity [m/s]

Reimplemented from JACOUSTICS::JAbstractSoundVelocity.

Definition at line 98 of file JSoundVelocity.hh.

    {
      return a + b * z;
    }

virtual double JACOUSTICS::JSoundVelocity::getDistance ( const double  t_s, const double  z1, const double  z2  ) const

inlinevirtual

Get distance travelled by sound.

Parameters

t_s	time [s]
z1	depth [m]
z2	depth [m] return distance [m]

Implements JACOUSTICS::JAbstractSoundVelocity.

Definition at line 112 of file JSoundVelocity.hh.

    {
      const double eps = 1.0e-8;

      const double v1  = (*this)(z1);
      const double v2  = (*this)(z2);
      const double lv  = log(v2/v1);

      if (fabs(lv) > eps)
        return t_s * fabs((z2 - z1) * b / lv);
      else
        return 0.5 * t_s * (v1 + v2);
    }

virtual double JACOUSTICS::JSoundVelocity::getTime ( const double  D_m, const double  z1, const double  z2  ) const

inlinevirtual

Get propagation time of sound.

Parameters

D_m	distance [m]
z1	depth [m]
z2	depth [m] return time [s]

Implements JACOUSTICS::JAbstractSoundVelocity.

Definition at line 137 of file JSoundVelocity.hh.

    {
      const double eps = 1.0e-8;

      const double ct  = (z2 - z1) / D_m;
      const double v1  = (*this)(z1);
      const double v2  = (*this)(z2);

      if (fabs(ct) > eps)
        return fabs(log(v2/v1) / (ct*b));
      else
        return 2.0 * D_m / (v1 + v2);
    }

virtual double JACOUSTICS::JSoundVelocity::getInverseVelocity ( const double  D_m, const double  z1, const double  z2  ) const

inlinevirtual

Get inverse velocity of sound.

Parameters

D_m	distance [m]
z1	depth [m]
z2	depth [m] return inverse velocity [s/m]

Implements JACOUSTICS::JAbstractSoundVelocity.

Definition at line 162 of file JSoundVelocity.hh.

    {
      const double eps = 1.0e-8;

      const double ct  = (z2 - z1) / D_m;
      const double v1  = (*this)(z1);
      const double v2  = (*this)(z2);

      if (fabs(ct) > eps)
        return fabs(log(v2/v1) / ((z2 - z1) * b));
      else
        return 2.0 / (v1 + v2);
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JSoundVelocity &  velocity  )

friend

Read sound velocity from input.

Parameters

in	input stream
velocity	sound velocity

Returns

input stream

Definition at line 186 of file JSoundVelocity.hh.

    {
      if (in >> velocity.a) {

        in >> velocity.b
           >> velocity.z0;

        in.clear();
      }

      return in;
    }

std::ostream& operator<< ( std::ostream &  out, const JSoundVelocity &  velocity  )

friend

Write sound velocity to output.

Parameters

out	output stream
velocity	sound velocity

Returns

output stream

Definition at line 207 of file JSoundVelocity.hh.

    {
      out << velocity.a << ' ' << velocity.b << ' ' << velocity.z0;

      return out;
    }

Member Data Documentation

double JACOUSTICS::JSoundVelocity::a

private

Definition at line 215 of file JSoundVelocity.hh.

double JACOUSTICS::JSoundVelocity::b

private

Definition at line 216 of file JSoundVelocity.hh.

double JACOUSTICS::JSoundVelocity::z0

private

Definition at line 217 of file JSoundVelocity.hh.

---

The documentation for this struct was generated from the following file:

• JSoundVelocity.hh