Inheritance diagram for VirtualCurrentFieldInDir:

Collaboration diagram for VirtualCurrentFieldInDir:

Public Member Functions
void	setVirtualCurrentInDir (VirtualCurrentInDir *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 VirtualCurrentFieldInDir::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.

Order rule (owner ruling D46): the answer depends only on time, position and state that is fixed during a step. A field that depends on simulation state (a propeller jet that follows its propeller) reads its own copy of that state, written between steps (for example in AcceptedStep), never members that port functions or OdeFcn write during the step. Such a field lags the simulation by one step, the same for any number of threads.

Implements marenv::current::CurrentField.

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

webfhsim/reloadrepos/fhsim_bio/src/artificial/VirtualCurrentInDir.h

Public Member Functions

Member Function Documentation

◆ GetCurrent()