#include <BathymetryField.h>

Inheritance diagram for marenv::seafloor::BathymetryField:

Collaboration diagram for marenv::seafloor::BathymetryField:

Public Member Functions
virtual	~BathymetryField ()=default
	Virtual destructor.

virtual Status	GetDepth (const double pos[2], double &depthOut)=0

virtual Status	ComputeSurfaceUnitNormal (const double pos[2], double unitNormalOut[3])=0

virtual Status	GetSeabedSigma (const double pos[3], double &sigmaOut)=0

virtual Status	GetSeabedTau (const double pos[3], double &tauOut)=0

virtual Status	GetSeabedRho (const double pos[3], double &rhoOut)=0

virtual Status	ComputeRayIntersection (const double origin[3], const double direction[3], double &distanceOut, double maxSearchDistance, double startSearchDistance, double stepSize, double convergenceTolerance)=0

Protected Member Functions
	BathymetryField ()=default
	Constructor is empty.

Detailed Description

The interface for an representing seafloor depths and material properties

As a basis for calculation seafloor forces, the following seafloor properties are defined:

Sigma (σ): Represents stress (force per unit area). It is a key parameter in understanding a material's strength, and is measured in Pascals (Pa).
Tau (τ): Represents shear stress or relaxation time. In the context of viscoelastic materials, relaxation time is a characteristic parameter that quantifies how fast a material responds to external forces.
Rho (ρ): Represents density (mass per unit volume), measured in kg/m³.

Member Function Documentation

◆ ComputeRayIntersection()

virtual Status marenv::seafloor::BathymetryField::ComputeRayIntersection	(	const double	origin[3],
		const double	direction[3],
		double &	distanceOut,
		double	maxSearchDistance,
		double	startSearchDistance,
		double	stepSize,
		double	convergenceTolerance
	)

pure virtual

Returns the distance a ray must travel before intercepting the seafloor.

Parameters

[in]	origin	Position (x,y,z) of the origin of the ray
[in]	direction	The unit direction (x,y,z) of the ray
[out]	distanceOut	The distance the beam travelled before reaching the seabed.
[in]	maxSearchDistance	The maximum distance from the origin to search for an intersection.
[in]	startSearchDistance	The distance from the origin to start searching for an intersection (initial guess). If less then zero, the algorithm will coarsely estimate the crossing assuming a flat seabed and search from there.
[in]	stepSize	The search step size.
[in]	convergenceTolerance	The vertical error tolerance between a computed point on the ray and a point on the seafloor to consider an intersection found.

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

Implemented in environmentmodels::NetCdfSeafloorBathymetry, marenv::seafloor::BathymetryWaves, and marenv::seafloor::FlatSeafloor.

◆ ComputeSurfaceUnitNormal()

virtual Status marenv::seafloor::BathymetryField::ComputeSurfaceUnitNormal	(	const double	pos[2],
		double	unitNormalOut[3]
	)

pure virtual

Returns the unit normal vector of the seafloor at a specific position.

Parameters

[in]	pos	Position (x,y) for which the unit normal surface vector is desired.
[out]	unitNormalOut	The unit normal surface vector at pos.

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

Implemented in environmentmodels::NetCdfSeafloorBathymetry, marenv::seafloor::BathymetryWaves, and marenv::seafloor::FlatSeafloor.

◆ GetDepth()

virtual Status marenv::seafloor::BathymetryField::GetDepth	(	const double	pos[2],
		double &	depthOut
	)

pure virtual

Returns the seafloor depth at a specific position.

Parameters

[in]	pos	Position (x,y) for which depth is desired.
[out]	depthOut	Depth at pos.

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

Implemented in environmentmodels::NetCdfSeafloorBathymetry, marenv::seafloor::BathymetryWaves, and marenv::seafloor::FlatSeafloor.

◆ GetSeabedRho()

virtual Status marenv::seafloor::BathymetryField::GetSeabedRho	(	const double	pos[3],
		double &	rhoOut
	)

pure virtual

Returns seabed density (ρ) in kg/m³.

Parameters

[in]	pos	The position in question.
[out]	rhoOut	Density in the specified position.

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

Implemented in environmentmodels::NetCdfSeafloorBathymetry, marenv::seafloor::BathymetryWaves, and marenv::seafloor::FlatSeafloor.

◆ GetSeabedSigma()

virtual Status marenv::seafloor::BathymetryField::GetSeabedSigma	(	const double	pos[3],
		double &	sigmaOut
	)

pure virtual

Returns seabed σ in Pascals (Pa).

Parameters

[in]	pos	The position in question.
[out]	sigmaOut	Sigma in the specified position.

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

Implemented in environmentmodels::NetCdfSeafloorBathymetry, marenv::seafloor::BathymetryWaves, and marenv::seafloor::FlatSeafloor.

◆ GetSeabedTau()

virtual Status marenv::seafloor::BathymetryField::GetSeabedTau	(	const double	pos[3],
		double &	tauOut
	)

pure virtual

Returns seabed shear stress τ.

Parameters

[in]	pos	The position in question.
[out]	tauOut	Shear stress in the specified position.

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

Implemented in environmentmodels::NetCdfSeafloorBathymetry, marenv::seafloor::BathymetryWaves, and marenv::seafloor::FlatSeafloor.

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ ComputeRayIntersection()

◆ ComputeSurfaceUnitNormal()

◆ GetDepth()

◆ GetSeabedRho()

◆ GetSeabedSigma()

◆ GetSeabedTau()