Public Member Functions
std::vector< float >	GetData ()

void	AddWave (double angleRad, double amplitude, double waveLength)

	BathymetryWavesSpec (double averageDepth, int numComponents, double sumAmplitudes, double minWavelength, double maxWavelength, uint32_t seed)

Public Attributes
float	averageDepth
	Average water depth [m].

float	sumAmplitudes
	Total sum of amplitudes across all components.

std::vector< BathymetryWave >	waves
	Collection of bathymetry wave components.

Detailed Description

Specification of a set of bathymetry waves.

Contains average depth and a collection of bathymetry wave components. Provides methods to generate wave data and add new waves.

Constructor & Destructor Documentation

marenv::seafloor::BathymetryWavesSpec::BathymetryWavesSpec	(	double	averageDepth,
		int	numComponents,
		double	sumAmplitudes,
		double	minWavelength,
		double	maxWavelength,
		uint32_t	seed
	)

Constructs a bathymetry wave specification with randomized components.

Parameters

[in]	averageDepth	Average water depth [m].
[in]	numComponents	Number of wave components to generate.
[in]	sumAmplitudes	Total sum of amplitudes across all components.
[in]	minWavelength	Minimum wavelength [m].
[in]	maxWavelength	Maximum wavelength [m].
[in]	seed	Random seed for reproducibility.

void marenv::seafloor::BathymetryWavesSpec::AddWave	(	double	angleRad,
		double	amplitude,
		double	waveLength
	)

Adds a new bathymetry wave to the specification.

Parameters

[in]	angleRad	Wave propagation angle in radians.
[in]	amplitude	Wave amplitude [m].
[in]	waveLength	Wavelength [m].

std::vector< float > marenv::seafloor::BathymetryWavesSpec::GetData ( )

Retrieves wave data as a flat vector.

Returns: Vector of floats containing wave data (implementation-defined format).

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

/update_root/webfhsim/reloadrepos/marenv/include/marenv/seafloor/BathymetryWavesSpec.h