An abstract class representing having the capability of providing wave kinematics data. More...

#include <Waves.hpp>

Inheritance diagram for moordyn::AbstractWaveKin:

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

Detailed Description

An abstract class representing having the capability of providing wave kinematics data.

Member Function Documentation

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

pure virtual

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