environmentmodels::NetCdfSeafloorBathymetry Class Reference

#include <NetCdfSeafloorBathymetry.h>

Inheritance diagram for environmentmodels::NetCdfSeafloorBathymetry:

Collaboration diagram for environmentmodels::NetCdfSeafloorBathymetry:

Public Member Functions
	NetCdfSeafloorBathymetry (const std::string &filename)
marenv::Status	GetDepth (const double pos[2], double &depthOut) override
marenv::Status	ComputeSurfaceUnitNormal (const double pos[2], double unitNormalOut[3]) override
marenv::Status	GetSeabedSigma (const double pos[3], double &sigmaOut) override
marenv::Status	GetSeabedTau (const double pos[3], double &tauOut) override
marenv::Status	GetSeabedRho (const double pos[3], double &rhoOut) override
const netcdf_sinmod::Grid &	GetGrid () const
const double *	GetDepthMap () const
double	GetLengthX () const
double	GetLengthY () const
Public Member Functions inherited from marenv::seafloor::BathymetryField
virtual	~BathymetryField ()=default
	Virtual destructor.
virtual Status	ComputeRayIntersection (const double origin[3], const double direction[3], double &distanceOut, double maxSearchDistance=100, double startSearchDistance=-1.0, double stepSize=1.0, double convergenceTolerance=0.01)

Additional Inherited Members
Protected Member Functions inherited from marenv::seafloor::BathymetryField
	BathymetryField ()=default
	Constructor is empty.
Static Protected Member Functions inherited from marenv::seafloor::BathymetryField
static bool	IsValidRay (const double origin[3], double directionNorm, double maxSearchDistance)
	True for an origin with finite coordinates, and a direction norm and a maximum search distance that ComputeRayIntersection accepts: positive and finite.
static double	ValidTolerance (double convergenceTolerance)
	The convergence tolerance ComputeRayIntersection uses: convergenceTolerance, raised to 1e-12 if smaller or NaN.

Detailed Description

Bathymetry field backed by NetCDF depth grid.

Loads a 2D bathymetry grid from a NetCDF file and provides depth queries through bilinear interpolation. Areas outside grid bounds return 11034 m. The Environment builds it for Bathymetry.Model = "NetCDF" (owner ruling R124); the NetCdfSeafloor SimObject that also did was removed (owner ruling R129, ENV-0086).

Constructor & Destructor Documentation

NetCdfSeafloorBathymetry()

environmentmodels::NetCdfSeafloorBathymetry::NetCdfSeafloorBathymetry ( const std::string &  filename )

explicit

Construct bathymetry from NetCDF file.

Parameters

[in]

filename

Path to NetCDF bathymetry file.

Member Function Documentation

ComputeSurfaceUnitNormal()

marenv::Status environmentmodels::NetCdfSeafloorBathymetry::ComputeSurfaceUnitNormal ( const double  pos[2], double  unitNormalOut[3]  )

overridevirtual

Compute seabed surface unit normal.

Parameters

[in]	pos	Position [x, y] [m].
[out]	unitNormalOut	Normal vector [nx, ny, nz].

Returns

Status code.

Implements marenv::seafloor::BathymetryField.

GetDepth()

marenv::Status environmentmodels::NetCdfSeafloorBathymetry::GetDepth ( const double  pos[2], double &  depthOut  )

overridevirtual

Get interpolated depth at position.

Parameters

[in]	pos	Position in NED frame [x, y] [m].
[out]	depthOut	Interpolated depth [m].

Returns

Status code.

Note

Returns 11034 m (Mariana Trench depth) for positions outside the grid bounds.

Implements marenv::seafloor::BathymetryField.

GetDepthMap()

const double * environmentmodels::NetCdfSeafloorBathymetry::GetDepthMap ( ) const

inline

Get depth map array.

Returns

Pointer to depth values.

GetGrid()

const netcdf_sinmod::Grid & environmentmodels::NetCdfSeafloorBathymetry::GetGrid ( ) const

inline

Get underlying grid.

Returns

Const reference to the NetCDF grid.

GetLengthX()

double environmentmodels::NetCdfSeafloorBathymetry::GetLengthX ( ) const

inline

Get grid length in X direction.

Returns

Length [m].

GetLengthY()

double environmentmodels::NetCdfSeafloorBathymetry::GetLengthY ( ) const

inline

Get grid length in Y direction.

Returns

Length [m].

GetSeabedRho()

marenv::Status environmentmodels::NetCdfSeafloorBathymetry::GetSeabedRho ( const double  pos[3], double &  rhoOut  )

overridevirtual

Get seabed rho parameter.

Parameters

[in]	pos	Position [x, y, z] [m].
[out]	rhoOut	Rho value.

Returns

Status code.

Implements marenv::seafloor::BathymetryField.

GetSeabedSigma()

marenv::Status environmentmodels::NetCdfSeafloorBathymetry::GetSeabedSigma ( const double  pos[3], double &  sigmaOut  )

overridevirtual

Get seabed sigma parameter.

Parameters

[in]	pos	Position [x, y, z] [m].
[out]	sigmaOut	Sigma value.

Returns

Status code.

Implements marenv::seafloor::BathymetryField.

GetSeabedTau()

marenv::Status environmentmodels::NetCdfSeafloorBathymetry::GetSeabedTau ( const double  pos[3], double &  tauOut  )

overridevirtual

Get seabed tau parameter.

Parameters

[in]	pos	Position [x, y, z] [m].
[out]	tauOut	Tau value.

Returns

Status code.

Implements marenv::seafloor::BathymetryField.

---

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

• webfhsim/reloadrepos/fhsim_environment/src/environment/NetCdfSeafloorBathymetry.h