Inheritance diagram for Ship::CycloidalPropellerCurrentField:

Collaboration diagram for Ship::CycloidalPropellerCurrentField:

Public Member Functions
void	setPropeller (CycloidalPropeller *propeller)

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 Ship::CycloidalPropellerCurrentField::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.

Threading contract, for every implementation: GetCurrent() may be called from several threads at once (a visualiser sampling in parallel while the simulation waits), so it must not change the field's state; it is non-const for historical reasons only. A field may read state the simulation writes between steps, so it need not be safe against a writer. Registration (EnvironmentFacade::AddCurrentField()) happens during setup.

Implements marenv::current::CurrentField.

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

webfhsim/reloadrepos/fhsim_maritime/src/ship/CycloidalPropeller.h

Public Member Functions

Member Function Documentation

◆ GetCurrent()