Simulators::StreamVelocity::StreamGenerator::StreamGenerator Class Reference

Public Member Functions
	StreamGenerator (double wx, double wy, double wz=0.0)
	~StreamGenerator ()=default
virtual std::array< double, 3 >	getVelocity (double lat, double lon, double depth, double time=0.0) const
std::array< double, 3 >	getDefaultVelocity () const
void	setVelocity (double wx, double wy, double wz=0.0)

Constructor & Destructor Documentation

Simulators::StreamVelocity::StreamGenerator::StreamGenerator::StreamGenerator	(	double	wx,
		double	wy,
		double	wz = 0.0
	)

Constructor.

Parameters

[in]	wx	default stream speed in the North direction (m/s).
[in]	wy	default stream speed in the East direction (m/s).
[in]	wz	default stream speed in the Down direction (m/s).

Simulators::StreamVelocity::StreamGenerator::StreamGenerator::~StreamGenerator ( )

default

Member Function Documentation

std::array< double, 3 > Simulators::StreamVelocity::StreamGenerator::StreamGenerator::getDefaultVelocity

(

)

const

Get the default stream velocity.

Returns

3-dimensional array containing the default stream velocity value in the North, East and Down directions in meters per second.

Referenced by getVelocity(), and Simulators::StreamVelocity::StreamGenerator::Gridded2DModelDataStreamGenerator::getVelocity().

std::array< double, 3 > Simulators::StreamVelocity::StreamGenerator::StreamGenerator::getVelocity ( double  lat, double  lon, double  depth, double  time = 0.0  ) const

virtual

Get a stream velocity value.

Parameters

[in]	lat	WGS84 latitude in degrees.
[in]	lon	WGS84 longitude in degrees.
[in]	depth	depth in meters.
[in]	time	time elapsed since the simulation started.

Returns

3-dimensional array containing the stream velocity in the North, East and Down directions in meters per second.

Reimplemented in Simulators::StreamVelocity::StreamGenerator::Gridded2DModelDataStreamGenerator.

References getDefaultVelocity().

void Simulators::StreamVelocity::StreamGenerator::StreamGenerator::setVelocity	(	double	wx,
		double	wy,
		double	wz = 0.0
	)

Set the default stream velocity.

Parameters

[in]	wx	default stream speed in the North direction (m/s).
[in]	wy	default stream speed in the East direction (m/s).
[in]	wz	default stream speed in the Down direction (m/s).

Collaboration diagram for Simulators::StreamVelocity::StreamGenerator::StreamGenerator: