Virtual Testbed
Ship dynamics simulator for extreme conditions
Public Member Functions | List of all members
vtb::core::Shallow_water_wave< T, N > Class Template Reference
Inheritance diagram for vtb::core::Shallow_water_wave< T, N >:
[legend]
Collaboration diagram for vtb::core::Shallow_water_wave< T, N >:
[legend]

Public Member Functions

 Shallow_water_wave (const Shallow_water_wave &)=default
 
Shallow_water_waveoperator= (const Shallow_water_wave &)=default
 
 Shallow_water_wave (Amplitude< T > amplitude, const vec &wave_number, T depth)
 
 Shallow_water_wave (Amplitude< T > amplitude, Length< T > length, Direction< T > direction, T depth)
 
- Public Member Functions inherited from vtb::core::Wave_base< T, N >
 Wave_base (const Wave_base &)=default
 
Wave_baseoperator= (const Wave_base &)=default
 
 Wave_base (Amplitude< T > amplitude, const vec &k, Frequency< T > freq)
 
 Wave_base (Amplitude< T > amplitude, Length< T > length, Direction< T > direction, Frequency< T > velocity)
 
amplitude () const noexcept
 Get wave amplitude.
 
const vec & wave_number () const noexcept
 Get wave numbers for each dimension.
 
angular_frequency () const noexcept
 Get wave angular frequency.
 
vec length () const noexcept
 Get wave length.
 
scalar_length () const noexcept
 Get wave length.
 
direction () const noexcept
 Get wave direction in radians.
 
period () const noexcept
 Get wave period.
 
vec phase_velocity () const noexcept
 Get phase velocity.
 

Additional Inherited Members

- Public Types inherited from vtb::core::Wave_base< T, N >
typedef T value_type
 
typedef blitz::TinyVector< T, N-1 > vec
 
- Static Public Member Functions inherited from vtb::core::Wave_base< T, N >
static constexpr int dimensions () noexcept
 
- Protected Attributes inherited from vtb::core::Wave_base< T, N >
_amplitude {1}
 
vec _k {T{0.05}}
 
_angfrequency {1}
 

Detailed Description

template<class T, int N>
class vtb::core::Shallow_water_wave< T, N >

Definition at line 35 of file shallow_water_wave.hh.