Contains the data and functionality for the Wave grid kinematics modes. More...

#include <Waves.hpp>

Inheritance diagram for moordyn::WaveGrid:

[legend]

Collaboration diagram for moordyn::WaveGrid:

[legend]

Public Member Functions
	WaveGrid (moordyn::Log *log, const std::vector< real > &px, const std::vector< real > &py, const std::vector< real > &pz, unsigned int nt, real dt)

void	allocateKinematicArrays ()

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...

Vec3D< real > &	Zetas ()

const Vec3D< real > &	getZetas () const

Vec4D< real > &	PDyn ()

const Vec4D< real > &	getPDyn () const

Vec4D< vec3 > &	WaveVel ()

const Vec4D< vec3 > &	getWaveVel () const

Vec4D< vec3 > &	WaveAcc ()

const Vec4D< vec3 > &	getWaveAcc () const

const std::vector< real > &	Px () const

const std::vector< real > &	Py () const

const std::vector< real > &	Pz () const

Public Member Functions inherited from moordyn::GridXYZT
	GridXYZT (const std::vector< real > &px, const std::vector< real > &py, const std::vector< real > &pz, unsigned int nt, real dt)

Additional Inherited Members
Public Attributes inherited from moordyn::GridXYZT
unsigned int	nx
	number of grid points in x direction

unsigned int	ny
	number of grid points in y direction

unsigned int	nz
	number of grid points in z direction

unsigned int	nt = 0
	number of time steps used in wave kinematics time series

real	dtWave
	time step for wave kinematics time series

Protected Attributes inherited from moordyn::GridXYZT
std::vector< real >	px
	grid x coordinate arrays

std::vector< real >	py
	grid y coordinate arrays

std::vector< real >	pz
	grid z coordinate arrays

Detailed Description

Contains the data and functionality for the Wave grid kinematics modes.

Member Function Documentation

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

overridevirtual

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 files:

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