marenv::current::CurrentField3DArray Class Reference

#include <CurrentField3DArray.h>

Inheritance diagram for marenv::current::CurrentField3DArray:

Collaboration diagram for marenv::current::CurrentField3DArray:

Public Member Functions
	CurrentField3DArray (std::vector< double > velocityX, std::vector< double > velocityY, std::vector< double > velocityZ, int numX, int numY, int numZ, std::vector< double > depthZ, double lengthX, double lengthY)
Status	GetCurrent (double time, const double position[3], double currentVelocity[3]) override
Public Member Functions inherited from marenv::current::CurrentField
virtual	~CurrentField ()=default
	Virtual destructor.

Detailed Description

Ocean current using a 3D array representation.

This class models an ocean current field defined on a structured 3D grid. Current velocity components (x, y, z) are stored in vectors across spatial dimensions, allowing queries of current velocity at arbitrary positions in space and time.

Constructor & Destructor Documentation

CurrentField3DArray()

marenv::current::CurrentField3DArray::CurrentField3DArray	(	std::vector< double >	velocityX,
		std::vector< double >	velocityY,
		std::vector< double >	velocityZ,
		int	numX,
		int	numY,
		int	numZ,
		std::vector< double >	depthZ,
		double	lengthX,
		double	lengthY
	)

Constructs a 3D current field.

Parameters

[in]	velocityX	X-component velocities [m/s].
[in]	velocityY	Y-component velocities [m/s].
[in]	velocityZ	Z-component velocities [m/s].
[in]	numX	Number of grid points in the x-direction.
[in]	numY	Number of grid points in the y-direction.
[in]	numZ	Number of grid points in the z-direction (depth layers).
[in]	depthZ	Depth values [m] corresponding to z-layers.
[in]	lengthX	Physical length of the domain in the x-direction [m].
[in]	lengthY	Physical length of the domain in the y-direction [m].

Member Function Documentation

GetCurrent()

Status marenv::current::CurrentField3DArray::GetCurrent ( double  time, const double  position[3], double  currentVelocity[3]  )

overridevirtual

Returns the ocean current velocity at a given position.

Parameters

[in]	time	Simulation time [s].
[in]	position	Position (x,y,z) in meters where the current is queried.
[out]	currentVelocity	Current velocity vector [m/s] at the given position.

Returns

marenv::Status::OK on success. See marenv::Status for other values.

Implements marenv::current::CurrentField.

---

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

• /update_root/webfhsim/reloadrepos/marenv/include/marenv/current/CurrentField3DArray.h