marenv::WaterVelocityParts Struct Reference

#include <WaterVelocity.h>

Public Attributes
bool	current = true
	The ambient current u_amb.
bool	wakes = true
	The change of the wake fields, d_tot (u_s - u_amb).
bool	jets = true
	The jets' excess velocity sum Δu_j.
bool	waves = true
	The wave particle velocity.

Detailed Description

Any selection of the four parts of the water velocity, u = u_amb + d_tot (u_s - u_amb) + sum Δu_j + u_waves (EnvironmentFacade::GetWaterVelocity()).

Each part is one term of the sum, so the parts of a velocity add up to it: current is u_amb, wakes is the change the wake fields make to it, d_tot (u_s - u_amb), jets is sum Δu_j and waves is the wave particle velocity. The default selects all four (WaterVelocityTerms::Full).

---

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

• webfhsim/reloadrepos/marenv/include/marenv/WaterVelocity.h