MoorDyn
Seafloor.h
Go to the documentation of this file.
1 
5 #ifndef SEAFLOOR_H
6 #define SEAFLOOR_H
7 
8 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
14 typedef struct __MoorDynSeafloor* MoorDynSeafloor;
15 
24 int DECLDIR
25 MoorDyn_GetDepthAt(MoorDynSeafloor seafloor, double x, double y, double* depth);
26 
36 int DECLDIR
37 MoorDyn_GetAverageDepth(MoorDynSeafloor seafloor, double* avgDepth);
38 
45 int DECLDIR
46 MoorDyn_GetMinDepth(MoorDynSeafloor seafloor, double* minDepth);
47 
48 #ifdef __cplusplus
49 }
50 #endif
51 
52 #endif // SEAFLOOR_H
#define DECLDIR
Prefix to export C functions on the compiled library.
Definition: MoorDynAPI.h:68
struct __MoorDynSeafloor * MoorDynSeafloor
A 3D Seafloor instance.
Definition: Seafloor.h:14
int DECLDIR MoorDyn_GetDepthAt(MoorDynSeafloor seafloor, double x, double y, double *depth)
Get the depth of the seafloor at some x and y.
Definition: Seafloor.cpp:153
int DECLDIR MoorDyn_GetMinDepth(MoorDynSeafloor seafloor, double *minDepth)
The depth of the seafloor at the shallowest point.
Definition: Seafloor.cpp:169
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...
Definition: Seafloor.cpp:161