This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Typedefs | |
| typedef struct __MoorDynSeafloor * | MoorDynSeafloor |
| A 3D Seafloor instance. | |
Functions | |
| int DECLDIR | MoorDyn_GetDepthAt (MoorDynSeafloor seafloor, double x, double y, double *depth) |
| Get the depth of the seafloor at some x and y. More... | |
| int DECLDIR | MoorDyn_GetAverageDepth (MoorDynSeafloor seafloor, double *avgDepth) |
| Get the average of depth of the seafloor This value is calculated as the average value of every depth point. If the rectilinear grid is not even, this average may not be the actual average depth of the surface the data describes. More... | |
| int DECLDIR | MoorDyn_GetMinDepth (MoorDynSeafloor seafloor, double *minDepth) |
| The depth of the seafloor at the shallowest point. More... | |
Detailed Description
C API for the moordyn::Seafloor object
Function Documentation
◆ MoorDyn_GetAverageDepth()
| int DECLDIR MoorDyn_GetAverageDepth | ( | MoorDynSeafloor | seafloor, |
| double * | avgDepth | ||
| ) |
Get the average of depth of the seafloor This value is calculated as the average value of every depth point. If the rectilinear grid is not even, this average may not be the actual average depth of the surface the data describes.
- Parameters
-
seafloor The Seafloor instance avgDepth The output average seafloor depth
- Returns
- 0 If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)
◆ MoorDyn_GetDepthAt()
| int DECLDIR MoorDyn_GetDepthAt | ( | MoorDynSeafloor | seafloor, |
| double | x, | ||
| double | y, | ||
| double * | depth | ||
| ) |
Get the depth of the seafloor at some x and y.
- Parameters
-
seafloor The Seafloor instance x The x coordinate y The y coordinate depth The output seafloor depth at that (x, y) point
- Returns
- 0 If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)
◆ MoorDyn_GetMinDepth()
| int DECLDIR MoorDyn_GetMinDepth | ( | MoorDynSeafloor | seafloor, |
| double * | minDepth | ||
| ) |
The depth of the seafloor at the shallowest point.
- Parameters
-
seafloor The Seafloor instance minDepth The output minimum seafloor depth
- Returns
- 0 If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)
