Wrapper around waves::SpectrumKin to make it adhere to the AbstractWaveKin interface. More...

#include <Waves.hpp>

Inheritance diagram for moordyn::SpectrumKinWrapper:

Collaboration diagram for moordyn::SpectrumKinWrapper:

Public Member Functions
	SpectrumKinWrapper (waves::SpectrumKin &&spectrum)
	Construct a new Spectrum Kin Wrapper object. More...

void	getWaveKin (const vec3 &pos, real time, const SeafloorProvider &seafloor, real zeta, vec3 vel, vec3 acc, real pdyn) override
	Get the velocity, acceleration, wave height and dynamic pressure at a specific position and time. More...

Detailed Description

Wrapper around waves::SpectrumKin to make it adhere to the AbstractWaveKin interface.

This probably shouldn't exist, and SpectrumKin should do this by itself, but this is easy enough

Constructor & Destructor Documentation

moordyn::SpectrumKinWrapper::SpectrumKinWrapper ( waves::SpectrumKin && spectrum )

inline

Construct a new Spectrum Kin Wrapper object.

SpectrumKin should be fully initialized, including having called setup. Move the spectrum into the wrapper just to avoid an unnecessary copy.

Parameters

spectrum

void moordyn::SpectrumKinWrapper::getWaveKin	(	const vec3 &	pos,
		real	time,
		const SeafloorProvider &	seafloor,
		real *	zeta,
		vec3 *	vel,
		vec3 *	acc,
		real *	pdyn
	)

inlineoverridevirtual

Get the velocity, acceleration, wave height and dynamic pressure at a specific position and time.

Parameters

pos	The location
time	The time
seafloor	A SeafloorProvider used for kinematic stretching
zeta	The output wave height, not set if null
U	The output velocity, not set if null
Ud	The output acceleration, not set if null
PDyn	The output dynamic pressure, not set if null

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

/home/docs/checkouts/readthedocs.org/user_builds/moordyn/checkouts/latest/source/Waves.hpp