plane_wave_generator.hh

`template <class T, class Wave, Policy P = Policy::OpenMP>`
`class vtb::core::Plane_wave_generator`

Wavy surface generator that produces elevation grid for individual wave.

Wave: a function that returns wavy surface elevation for given point

Base classes

public vtb::core::Wavy_surface_generator< T >

Types

using array_type = Array< T, 2 >
using grid_type = Grid< T, 2 >
using wave_type = Wave

Methods

acf_grid() const -> Grid< T, 3 >virtual
wave() const -> const Wave &
generate(T t, const grid_type & grid) -> voidvirtual
Plane_wave_generator(const Wave & wave)explicit
operator=(const Plane_wave_generator &) -> Plane_wave_generator &
Plane_wave_generator(const Plane_wave_generator &)
Plane_wave_generator()

Date: 2018-08-01

Author: Ivan Gankevich

`template <class T, int N>`
`class vtb::core::Irregular_wave_surface_generator`

Wavy surface generator that produces elevation grid for multiple waves.

The resulting elevation is a sum of elevations for individual waves.

Base classes

public vtb::core::Wavy_surface_generator< T >

Types

using container_type = std::vector< pointer_type >
using pointer_type = std::unique_ptr< generator_type >
using generator_type = Wavy_surface_generator< T >

Methods

generate(T t, const grid_type & grid) -> voidvirtual
Irregular_wave_surface_generator(container_type && generators)explicit
operator=(const Irregular_wave_surface_generator &) -> Irregular_wave_surface_generator &
Irregular_wave_surface_generator(const Irregular_wave_surface_generator &)
Irregular_wave_surface_generator()

Date: 2018-08-01

Author: Ivan Gankevich

`template <class T, class Wave, Policy P>`
`make_plane_wave_generator() -> std::unique_ptr< Plane_wave_generator< T, Wave, P > >`

`template <class T>`
`make_plane_wave_generator(std::any wave, Policy policy) -> std::unique_ptr< Wavy_surface_generator< T > >`

`template <class T, int N, class Wave>`
`generate_wave(T t, const Grid< T, N > & grid, Array< T, N > & result, Wave wave) -> void`

Generate wavy surface for specified wave and spatio-temporal grid.

Wave: a function that returns wavy surface elevation for given point

Date: 2018-08-01

Author: Ivan Gankevich

See: Propagating_cosine_wave

See: Propagating_stokes_wave

See: Standing_cosine_wave

`template <class T, int N, class Wave>`
`generate_wave(const Grid< T, N > & grid, Array< T, N > & result, Wave wave) -> void`

`template <class T, int N, class Wave>`
`generate_wave(T t, const Grid< T, N > & grid, Wave wave) -> Array< T, N >`

`template <class T, int N, class Wave>`
`generate_wave(const Grid< T, N > & grid, Wave wave) -> Array< T, N >`

`template <class T, class Wave, Policy P>`
`make_plane_wave_generator(const Wave & wave) -> std::unique_ptr< Plane_wave_generator< T, Wave, P > >`