Inheritance diagram for VirtualCurrentField:

Collaboration diagram for VirtualCurrentField:

Public Member Functions
void	setVirtualCurrent (VirtualCurrent *virtCurr)

marenv::Status	GetCurrent (const double T, const double position[3], double currentVelocity[3])

Public Member Functions inherited from marenv::current::CurrentField
virtual	~CurrentField ()=default
	Virtual destructor.

Member Function Documentation

◆ GetCurrent()

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

virtual

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.

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