JACOUSTICS::JAbstractSoundVelocity Struct Reference

Interface for depth dependend velocity of sound. More...

#include <JAbstractSoundVelocity.hh>

Inheritance diagram for JACOUSTICS::JAbstractSoundVelocity:

Public Member Functions
virtual	~JAbstractSoundVelocity ()
	Virtual destructor.
virtual double	operator() () const =0
	Get velocity of sound.
virtual double	operator() (const double z) const
	Get velocity of sound at given depth relative to seabed.
virtual double	getDistance (const double t_s, const double z1, const double z2) const =0
	Get distance travelled by sound.
virtual double	getTime (const double D_m, const double z1, const double z2) const =0
	Get propagation time of sound.
virtual double	getInverseVelocity (const double D_m, const double z1, const double z2) const =0
	Get inverse velocity of sound.

Detailed Description

Interface for depth dependend velocity of sound.

Note that the z-axis is pointing upwards.

Definition at line 20 of file JAbstractSoundVelocity.hh.

Constructor & Destructor Documentation

~JAbstractSoundVelocity()

virtual JACOUSTICS::JAbstractSoundVelocity::~JAbstractSoundVelocity ( )

inlinevirtual

Virtual destructor.

Definition at line 24 of file JAbstractSoundVelocity.hh.

    {}

Member Function Documentation

operator()() [1/2]

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

pure virtual

Get velocity of sound.

Returns

velocity [m/s]

Implemented in JACOUSTICS::JConstantSoundVelocity, and JACOUSTICS::JSoundVelocity.

operator()() [2/2]

virtual double JACOUSTICS::JAbstractSoundVelocity::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 in JACOUSTICS::JConstantSoundVelocity, and JACOUSTICS::JSoundVelocity.

Definition at line 42 of file JAbstractSoundVelocity.hh.

    {
      return (*this)();
    }

getDistance()

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

pure virtual

Get distance travelled by sound.

Parameters

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

Returns

distance [m]

Implemented in JACOUSTICS::JConstantSoundVelocity, and JACOUSTICS::JSoundVelocity.

getTime()

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

pure virtual

Get propagation time of sound.

Parameters

D_m	distance [m]
z1	depth [m]
z2	depth [m]

Returns

time [s]

Implemented in JACOUSTICS::JConstantSoundVelocity, and JACOUSTICS::JSoundVelocity.

getInverseVelocity()

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

pure virtual

Get inverse velocity of sound.

Parameters

D_m	distance [m]
z1	depth [m]
z2	depth [m]

Returns

inverse velocity [s/m]

Implemented in JACOUSTICS::JConstantSoundVelocity, and JACOUSTICS::JSoundVelocity.

---

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

• JAbstractSoundVelocity.hh