marenv::current::NullCurrentField Class Reference

#include <NullCurrentField.h>

Inheritance diagram for marenv::current::NullCurrentField:

Collaboration diagram for marenv::current::NullCurrentField:

Public Member Functions
	NullCurrentField ()=default
	Constructor.
	~NullCurrentField () override=default
	Destructor.
marenv::Status	GetCurrent (double time, const double pos[3], double velOut[3]) override
Public Member Functions inherited from marenv::current::CurrentField
virtual	~CurrentField ()=default
	Virtual destructor.

Detailed Description

A null current field that represents no currents.

Returns zero velocity for all queries.

Member Function Documentation

GetCurrent()

marenv::Status marenv::current::NullCurrentField::GetCurrent ( double  time, const double  pos[3], double  velOut[3]  )

overridevirtual

Return the ocean current velocity (always zero for this null ).

Parameters

[in]	time	Time stamp in simulation time.
[in]	pos	The position to query for.
[out]	velOut	The velocity of the ocean current (always zero).

Returns

marenv::Status::OK on success.

Implements marenv::current::CurrentField.

---

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

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