MoorDyn
Public Member Functions | List of all members
moordyn::AbstractCurrentKin Class Referenceabstract

An abstract class representing the capability of providing water current data at some point and time. More...

#include <Waves.hpp>

Inheritance diagram for moordyn::AbstractCurrentKin:
Inheritance graph
[legend]

Public Member Functions

virtual void getCurrentKin (const vec3 &pos, real time, const SeafloorProvider &seafloor, vec3 *vel, vec3 *acc)=0
 Get the velocity and acceleration at a specific position and time. More...
 

Detailed Description

An abstract class representing the capability of providing water current data at some point and time.

Member Function Documentation

◆ getCurrentKin()

virtual void moordyn::AbstractCurrentKin::getCurrentKin ( const vec3 pos,
real  time,
const SeafloorProvider seafloor,
vec3 vel,
vec3 acc 
)
pure virtual

Get the velocity and acceleration at a specific position and time.

Parameters
posThe location
timeThe time
seafloorA SeafloorProvider, could be used for kinematic stretching
velThe output velocity, not set if null
accThe output acceleration, not set if null

Implemented in moordyn::CurrentGrid.


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