Virtual Testbed
Ship dynamics simulator for extreme conditions
Public Member Functions | List of all members
vtb::core::Propagating_cosine_wave< T, N > Class Template Reference

Propagating plain wave which has cosine shape. More...

#include <cosine_wave.hh>

Inheritance diagram for vtb::core::Propagating_cosine_wave< T, N >:
[legend]
Collaboration diagram for vtb::core::Propagating_cosine_wave< T, N >:
[legend]

Public Member Functions

 Propagating_cosine_wave (const Propagating_cosine_wave &)=default
 
Propagating_cosine_waveoperator= (const Propagating_cosine_wave &)=default
 
 Propagating_cosine_wave (Amplitude< T > amplitude, const vec &k)
 
 Propagating_cosine_wave (Amplitude< T > amplitude, Length< T > length, Direction< T > direction)
 
Grid< T, 3 > acf_grid () const
 
- Public Member Functions inherited from vtb::core::Linear_wave< T, N >
 Linear_wave (const Linear_wave &)=default
 
Linear_waveoperator= (const Linear_wave &)=default
 
 Linear_wave (Amplitude< T > amplitude, const vec &wave_number)
 
 Linear_wave (Amplitude< T > amplitude, Length< T > length, Direction< T > direction)
 
operator() (const vec &x, T t) const noexcept
 Returns wavy surface elevation at point x.
 
- 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::Propagating_cosine_wave< T, N >

Propagating plain wave which has cosine shape.

Date
2018-08-01
Author
Ivan Gankevich

Definition at line 17 of file cosine_wave.hh.