Bathymetry description for MoorDyn. More...

#include <Seafloor.hpp>

Inheritance diagram for moordyn::Seafloor:

Collaboration diagram for moordyn::Seafloor:

Public Member Functions
	Seafloor (moordyn::Log *log)

void	setup (EnvCondRef env, const string &filepath)
	Setup the seafloor. More...

real	getDepthAt (real x, real y)
	Get the depth at a particular x/y coordinate. More...

real	getAverageDepth ()
	The average of the depth at all the grid points.

real	getMinimumDepth ()
	The depth of the seafloor at the shallowest point Potentially useful for optimizing collision against the seafloor.

Detailed Description

Bathymetry description for MoorDyn.

Seafloor can provide a 2-D map of depths for MoorDyn

Member Function Documentation

real moordyn::Seafloor::getDepthAt	(	real	x,
		real	y
	)

Get the depth at a particular x/y coordinate.

This should default to nearest edge depth if beyond the grid where depths have been explicitly defined.

Parameters

x	The x-coordinate of the point being assessed
y	The x-coordinate of the point being assessed

Setup the seafloor.

Always call this function after the constructor

Parameters

env	The environmental options
filepath	The depths map file

Exceptions

moordyn::input_file_error	If an input file cannot be read, or if a file is ill-formatted
moordyn::invalid_value_error	If invalid values are found

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

/home/docs/checkouts/readthedocs.org/user_builds/moordyn/checkouts/latest/source/Seafloor.hpp
/home/docs/checkouts/readthedocs.org/user_builds/moordyn/checkouts/latest/source/Seafloor.cpp