marenv::current::ConstantCurrent Class Reference

#include <ConstantCurrent.h>

Inheritance diagram for marenv::current::ConstantCurrent:

Collaboration diagram for marenv::current::ConstantCurrent:

Public Member Functions
	ConstantCurrent (const double velocity[3])
	ConstantCurrent (double velocity, double directionRad)
Status	GetCurrent (double time, const double position[3], double currentVelocity[3]) override
Public Member Functions inherited from marenv::current::CurrentField
virtual	~CurrentField ()=default
	Virtual destructor.

Detailed Description

An ocean current providing a time- and position independent current.

Example usage:

    double velocity  = 1.0;
    double direction = 0.5;
    auto current     = std::make_shared<marenv::current::ConstantCurrent>(velocity, direction);
 
    double pos[3] = {0.0, 0.0, -5.0};
    double currentVelocity[3];
    current->GetCurrent(0.0, pos, currentVelocity);

Constructor & Destructor Documentation

ConstantCurrent() [1/2]

marenv::current::ConstantCurrent::ConstantCurrent ( const double  velocity[3] )

explicit

Constructor for the ocean current

Parameters

[in]

velocity

The 3 DOF ocean current velocity [m/s]

ConstantCurrent() [2/2]

marenv::current::ConstantCurrent::ConstantCurrent	(	double	velocity,
		double	directionRad
	)

Constructor for the ocean current

Parameters

[in]	velocity	The ocean current velocity amplitude [m/s]
[in]	directionRad	The ocean current direction [rad]

Member Function Documentation

GetCurrent()

Status marenv::current::ConstantCurrent::GetCurrent ( double  time, const double  position[3], double  currentVelocity[3]  )

overridevirtual

Return the ocean current velocity in a given position and time.

Parameters

[in]	time	Time stamp in simulation time.
[in]	position	The position to query for.
[out]	currentVelocity	The velocity of the ocean current in the given time and position.

Returns

marenv::Status::OK on success. See marenv::Status for other values.

Implements marenv::current::CurrentField.

---

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

• /update_root/webfhsim/reloadrepos/marenv/include/marenv/current/ConstantCurrent.h