MoorDyn

https://moordyn.readthedocs.io
Admin
MoorDyn is a simple and efficient lumped-mass mooring dynamics model designed for simulating mooring...
Tokens:17,590
Snippets:30
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### MoorDyn Initialization and Control

Source: https://moordyn.readthedocs.io

Functions for creating, initializing, and controlling the MoorDyn simulation.

```APIDOC
## MoorDyn_Create()

### Description
Creates a MoorDyn object.

### Method
`MoorDyn_Create()`

### Endpoint
N/A (C function)

### Parameters
None

### Request Example
```c
MoorDyn* dyn = MoorDyn_Create();
```

### Response
#### Success Response
- `MoorDyn*` - Pointer to the created MoorDyn object.

#### Response Example
```c
// Success
```
```

```APIDOC
## MoorDyn_Init()

### Description
Initializes the MoorDyn simulation with a specified input file.

### Method
`MoorDyn_Init(MoorDyn* dyn, const char* inputFile)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **inputFile** (`const char*`) - Path to the MoorDyn input file.

### Request Example
```c
MoorDyn_Init(dyn, "moordyn.txt");
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on successful initialization.

#### Response Example
```c
int status = MoorDyn_Init(dyn, "moordyn.txt");
if (status == MOORDYN_SUCCESS) {
    // Initialization successful
}
```
```

```APIDOC
## MoorDyn_Init_NoIC()

### Description
Initializes the MoorDyn simulation without initial conditions, typically for loading a state.

### Method
`MoorDyn_Init_NoIC(MoorDyn* dyn, const char* inputFile)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **inputFile** (`const char*`) - Path to the MoorDyn input file.

### Request Example
```c
MoorDyn_Init_NoIC(dyn, "moordyn.txt");
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on successful initialization.

#### Response Example
```c
int status = MoorDyn_Init_NoIC(dyn, "moordyn.txt");
if (status == MOORDYN_SUCCESS) {
    // Initialization successful
}
```
```

```APIDOC
## MoorDyn_Step()

### Description
Advances the MoorDyn simulation by one time step.

### Method
`MoorDyn_Step(MoorDyn* dyn, double dt)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **dt** (`double`) - The time step size.

### Request Example
```c
MoorDyn_Step(dyn, 0.01);
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on successful step.

#### Response Example
```c
int status = MoorDyn_Step(dyn, 0.01);
if (status == MOORDYN_SUCCESS) {
    // Step successful
}
```
```

```APIDOC
## MoorDyn_Close()

### Description
Frees the memory associated with the MoorDyn object.

### Method
`MoorDyn_Close(MoorDyn* dyn)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.

### Request Example
```c
MoorDyn_Close(dyn);
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on successful closing.

#### Response Example
```c
MoorDyn_Close(dyn);
```
```

--------------------------------

### MoorDyn C API Helper Functions

Source: https://moordyn.readthedocs.io

Utility functions for logging and setting simulation parameters.

```APIDOC
## MoorDyn_SetVerbosity()

### Description
Sets the verbosity level for MoorDyn output.

### Method
`MoorDyn_SetVerbosity(MoorDyn* dyn, int verbosity)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **verbosity** (`int`) - The desired verbosity level.

### Request Example
```c
MoorDyn_SetVerbosity(dyn, 2);
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_SetVerbosity(dyn, 2);
```
```

```APIDOC
## MoorDyn_SetLogFile()

### Description
Sets the file to which MoorDyn logs will be written.

### Method
`MoorDyn_SetLogFile(MoorDyn* dyn, const char* filename)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **filename** (`const char*`) - The name of the log file.

### Request Example
```c
MoorDyn_SetLogFile(dyn, "moordyn.log");
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_SetLogFile(dyn, "moordyn.log");
```
```

```APIDOC
## MoorDyn_SetLogLevel()

### Description
Sets the logging level for MoorDyn messages.

### Method
`MoorDyn_SetLogLevel(MoorDyn* dyn, int level)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **level** (`int`) - The desired logging level.

### Request Example
```c
MoorDyn_SetLogLevel(dyn, 3);
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_SetLogLevel(dyn, 3);
```
```

```APIDOC
## MoorDyn_Log()

### Description
Writes a custom message to the MoorDyn log.

### Method
`MoorDyn_Log(MoorDyn* dyn, int level, const char* message)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **level** (`int`) - The logging level for the message.
- **message** (`const char*`) - The message string to log.

### Request Example
```c
MoorDyn_Log(dyn, 1, "Custom log message.");
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_Log(dyn, 1, "Custom log message.");
```
```

```APIDOC
## MoorDyn_GetDt()

### Description
Gets the current time step size.

### Method
`MoorDyn_GetDt(MoorDyn* dyn)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.

### Request Example
```c
double dt = MoorDyn_GetDt(dyn);
```

### Response
#### Success Response
- `double` - The current time step size.

#### Response Example
```c
double dt = MoorDyn_GetDt(dyn);
```
```

```APIDOC
## MoorDyn_SetDt()

### Description
Sets the time step size for the simulation.

### Method
`MoorDyn_SetDt(MoorDyn* dyn, double dt)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **dt** (`double`) - The desired time step size.

### Request Example
```c
MoorDyn_SetDt(dyn, 0.01);
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_SetDt(dyn, 0.01);
```
```

```APIDOC
## MoorDyn_GetCFL()

### Description
Gets the Courant-Friedrichs-Lewy (CFL) number.

### Method
`MoorDyn_GetCFL(MoorDyn* dyn)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.

### Request Example
```c
double cfl = MoorDyn_GetCFL(dyn);
```

### Response
#### Success Response
- `double` - The CFL number.

#### Response Example
```c
double cfl = MoorDyn_GetCFL(dyn);
```
```

```APIDOC
## MoorDyn_SetCFL()

### Description
Sets the Courant-Friedrichs-Lewy (CFL) number.

### Method
`MoorDyn_SetCFL(MoorDyn* dyn, double cfl)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **cfl** (`double`) - The desired CFL number.

### Request Example
```c
MoorDyn_SetCFL(dyn, 0.8);
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_SetCFL(dyn, 0.8);
```
```

```APIDOC
## MoorDyn_GetTimeScheme()

### Description
Gets the time integration scheme used by MoorDyn.

### Method
`MoorDyn_GetTimeScheme(MoorDyn* dyn)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.

### Request Example
```c
int scheme = MoorDyn_GetTimeScheme(dyn);
```

### Response
#### Success Response
- `int` - The time integration scheme.

#### Response Example
```c
int scheme = MoorDyn_GetTimeScheme(dyn);
```
```

```APIDOC
## MoorDyn_SetTimeScheme()

### Description
Sets the time integration scheme for MoorDyn.

### Method
`MoorDyn_SetTimeScheme(MoorDyn* dyn, int scheme)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **scheme** (`int`) - The desired time integration scheme.

### Request Example
```c
MoorDyn_SetTimeScheme(dyn, 1);
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_SetTimeScheme(dyn, 1);
```
```

--------------------------------

### MoorDyn C API File I/O

Source: https://moordyn.readthedocs.io

Functions for saving and loading simulation states to/from files.

```APIDOC
## MoorDyn_Save()

### Description
Saves the current simulation state to a file.

### Method
`MoorDyn_Save(MoorDyn* dyn, const char* filename)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **filename** (`const char*`) - The name of the file to save the state to.

### Request Example
```c
MoorDyn_Save(dyn, "simulation_save.txt");
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_Save(dyn, "simulation_save.txt");
```
```

```APIDOC
## MoorDyn_Load()

### Description
Loads a simulation state from a file.

### Method
`MoorDyn_Load(MoorDyn* dyn, const char* filename)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **filename** (`const char*`) - The name of the file to load the state from.

### Request Example
```c
MoorDyn_Load(dyn, "simulation_save.txt");
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_Load(dyn, "simulation_save.txt");
```
```

```APIDOC
## MoorDyn_SaveVTK()

### Description
Saves the entire simulation state to a VTK file.

### Method
`MoorDyn_SaveVTK(MoorDyn* dyn, const char* filename)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **filename** (`const char*`) - The name of the VTK file to save.

### Request Example
```c
MoorDyn_SaveVTK(dyn, "simulation.vtk");
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_SaveVTK(dyn, "simulation.vtk");
```
```

--------------------------------

### MoorDyn C API External Wave Kinematics

Source: https://moordyn.readthedocs.io

Functions for initializing and interacting with external wave kinematics data.

```APIDOC
## MoorDyn_ExternalWaveKinInit()

### Description
Initializes the external wave kinematics system.

### Method
`MoorDyn_ExternalWaveKinInit(MoorDyn* dyn, const char* filename)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **filename** (`const char*`) - Path to the wave kinematics file.

### Request Example
```c
MoorDyn_ExternalWaveKinInit(dyn, "waves.dat");
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_ExternalWaveKinInit(dyn, "waves.dat");
```
```

```APIDOC
## MoorDyn_ExternalWaveKinGetN()

### Description
Gets the number of wave kinematics data points.

### Method
`MoorDyn_ExternalWaveKinGetN(MoorDyn* dyn)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.

### Request Example
```c
int nWaves = MoorDyn_ExternalWaveKinGetN(dyn);
```

### Response
#### Success Response
- `int` - The number of wave kinematics data points.

#### Response Example
```c
int nWaves = MoorDyn_ExternalWaveKinGetN(dyn);
```
```

```APIDOC
## MoorDyn_ExternalWaveKinGetCoordinates()

### Description
Gets the coordinates for a given wave kinematics data point.

### Method
`MoorDyn_ExternalWaveKinGetCoordinates(MoorDyn* dyn, int wave_idx, double* x, double* y, double* z)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **wave_idx** (`int`) - The index of the wave kinematics data point.
- **x, y, z** (`double*`) - Pointers to store the coordinates.

### Request Example
```c
double x, y, z;
MoorDyn_ExternalWaveKinGetCoordinates(dyn, 0, &x, &y, &z);
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
double x, y, z;
MoorDyn_ExternalWaveKinGetCoordinates(dyn, 0, &x, &y, &z);
```
```

```APIDOC
## MoorDyn_ExternalWaveKinSet()

### Description
Sets the wave kinematics data for a specific point.

### Method
`MoorDyn_ExternalWaveKinSet(MoorDyn* dyn, int wave_idx, double x, double y, double z, double vx, double vy, double vz, double ax, double ay, double az)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **wave_idx** (`int`) - The index of the wave kinematics data point.
- **x, y, z** (`double`) - Position coordinates.
- **vx, vy, vz** (`double`) - Velocity components.
- **ax, ay, az** (`double`) - Acceleration components.

### Request Example
```c
MoorDyn_ExternalWaveKinSet(dyn, 0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0);
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
MoorDyn_ExternalWaveKinSet(dyn, 0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0);
```
```

--------------------------------

### MoorDyn C API Serialization/Deserialization

Source: https://moordyn.readthedocs.io

Functions for serializing and deserializing the MoorDyn simulation state.

```APIDOC
## MoorDyn_Serialize()

### Description
Serializes the current state of the MoorDyn simulation.

### Method
`MoorDyn_Serialize(MoorDyn* dyn)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.

### Request Example
```c
// This function likely returns a representation of the state, e.g., a byte array or string.
// The exact return type and usage depend on implementation details not fully specified.
void* serialized_state = MoorDyn_Serialize(dyn);
```

### Response
#### Success Response
- `void*` - A pointer to the serialized state data. The caller is responsible for managing this memory.

#### Response Example
```c
void* serialized_state = MoorDyn_Serialize(dyn);
// Use serialized_state...
// free(serialized_state); // If applicable
```
```

```APIDOC
## MoorDyn_Deserialize()

### Description
Deserializes a simulation state into the MoorDyn object.

### Method
`MoorDyn_Deserialize(MoorDyn* dyn, void* serialized_state)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **serialized_state** (`void*`) - Pointer to the serialized state data.

### Request Example
```c
// Assuming 'serialized_data' holds the state obtained from MoorDyn_Serialize or a file.
void* serialized_data = ...;
MoorDyn_Deserialize(dyn, serialized_data);
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
void* serialized_data = ...;
MoorDyn_Deserialize(dyn, serialized_data);
```
```

--------------------------------

### MoorDyn C API Coupling Functions

Source: https://moordyn.readthedocs.io

Functions related to coupled degrees of freedom and initialization without initial conditions.

```APIDOC
## MoorDyn_NCoupledDOF()

### Description
Gets the number of coupled degrees of freedom.

### Method
`MoorDyn_NCoupledDOF(MoorDyn* dyn)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.

### Request Example
```c
int nDOF = MoorDyn_NCoupledDOF(dyn);
```

### Response
#### Success Response
- `int` - The number of coupled degrees of freedom.

#### Response Example
```c
int nDOF = MoorDyn_NCoupledDOF(dyn);
```
```

```APIDOC
## MoorDyn_Init_NoIC()

### Description
Initializes MoorDyn without setting initial conditions, useful for loading states.

### Method
`MoorDyn_Init_NoIC(MoorDyn* dyn, const char* inputFile)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **inputFile** (`const char*`) - Path to the MoorDyn input file.

### Request Example
```c
MoorDyn_Init_NoIC(dyn, "moordyn_config.txt");
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on successful initialization.

#### Response Example
```c
MoorDyn_Init_NoIC(dyn, "moordyn_config.txt");
```
```

--------------------------------

### MoorDyn C API Wave and Seafloor Data

Source: https://moordyn.readthedocs.io

Functions for retrieving wave and seafloor data from the simulation.

```APIDOC
## MoorDyn_GetWaves()

### Description
Gets a pointer to the wave data structure.

### Method
`MoorDyn_GetWaves(MoorDyn* dyn)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.

### Request Example
```c
MoorDynWaves* waves = MoorDyn_GetWaves(dyn);
```

### Response
#### Success Response
- `MoorDynWaves*` - Pointer to the `MoorDynWaves` structure.

#### Response Example
```c
MoorDynWaves* waves = MoorDyn_GetWaves(dyn);
```
```

```APIDOC
## MoorDyn_GetSeafloor()

### Description
Gets a pointer to the seafloor data structure.

### Method
`MoorDyn_GetSeafloor(MoorDyn* dyn)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.

### Request Example
```c
MoorDynSeafloor* seafloor = MoorDyn_GetSeafloor(dyn);
```

### Response
#### Success Response
- `MoorDynSeafloor*` - Pointer to the `MoorDynSeafloor` structure.

#### Response Example
```c
MoorDynSeafloor* seafloor = MoorDyn_GetSeafloor(dyn);
```
```

--------------------------------

### MoorDyn Data Retrieval - Rods

Source: https://moordyn.readthedocs.io

Functions for retrieving information about rods in the MoorDyn simulation.

```APIDOC
## MoorDyn_GetNumberRods()

### Description
Gets the total number of rods in the simulation.

### Method
`MoorDyn_GetNumberRods(MoorDyn* dyn)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.

### Request Example
```c
int numRods = MoorDyn_GetNumberRods(dyn);
```

### Response
#### Success Response
- `int` - The number of rods.

#### Response Example
```c
int numRods = MoorDyn_GetNumberRods(dyn);
```
```

```APIDOC
## MoorDyn_GetRod()

### Description
Gets a pointer to a specific rod object by its ID.

### Method
`MoorDyn_GetRod(MoorDyn* dyn, int id)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **id** (`int`) - The ID of the rod to retrieve.

### Request Example
```c
MoorDynRod* rod = MoorDyn_GetRod(dyn, 0);
```

### Response
#### Success Response
- `MoorDynRod*` - Pointer to the `MoorDynRod` object.

#### Response Example
```c
MoorDynRod* rod = MoorDyn_GetRod(dyn, 0);
```
```

```APIDOC
## MoorDyn_GetRodID()

### Description
Gets the ID of a rod.

### Method
`MoorDyn_GetRodID(MoorDyn* dyn, int rod_idx)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **rod_idx** (`int`) - The index of the rod.

### Request Example
```c
int id = MoorDyn_GetRodID(dyn, 0);
```

### Response
#### Success Response
- `int` - The ID of the rod.

#### Response Example
```c
int id = MoorDyn_GetRodID(dyn, 0);
```
```

```APIDOC
## MoorDyn_GetRodType()

### Description
Gets the type of a rod.

### Method
`MoorDyn_GetRodType(MoorDyn* dyn, int rod_idx)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **rod_idx** (`int`) - The index of the rod.

### Request Example
```c
int type = MoorDyn_GetRodType(dyn, 0);
```

### Response
#### Success Response
- `int` - The type of the rod.

#### Response Example
```c
int type = MoorDyn_GetRodType(dyn, 0);
```
```

```APIDOC
## MoorDyn_GetRodForce()

### Description
Gets the force acting on a rod.

### Method
`MoorDyn_GetRodForce(MoorDyn* dyn, int rod_idx, double* fx, double* fy, double* fz)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **rod_idx** (`int`) - The index of the rod.
- **fx, fy, fz** (`double*`) - Pointers to store the force components.

### Request Example
```c
double fx, fy, fz;
MoorDyn_GetRodForce(dyn, 0, &fx, &fy, &fz);
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on success.

#### Response Example
```c
double fx, fy, fz;
MoorDyn_GetRodForce(dyn, 0, &fx, &fy, &fz);
```
```

--------------------------------

### MoorDyn State Management

Source: https://moordyn.readthedocs.io

Functions for saving and loading the state of a MoorDyn simulation.

```APIDOC
## MoorDyn_SaveState()

### Description
Saves the current state of the MoorDyn simulation to a file.

### Method
`MoorDyn_SaveState(MoorDyn* dyn, const char* filename)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **filename** (`const char*`) - The name of the file to save the state to.

### Request Example
```c
MoorDyn_SaveState(dyn, "simulation.state");
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on successful save.

#### Response Example
```c
int status = MoorDyn_SaveState(dyn, "simulation.state");
if (status == MOORDYN_SUCCESS) {
    // State saved successfully
}
```
```

```APIDOC
## MoorDyn_LoadState()

### Description
Loads a previously saved state into the MoorDyn simulation.

### Method
`MoorDyn_LoadState(MoorDyn* dyn, const char* filename)`

### Endpoint
N/A (C function)

### Parameters
- **dyn** (`MoorDyn*`) - Pointer to the MoorDyn object.
- **filename** (`const char*`) - The name of the file to load the state from.

### Request Example
```c
MoorDyn_LoadState(dyn, "simulation.state");
```

### Response
#### Success Response
- `int` - Returns `MOORDYN_SUCCESS` on successful load.

#### Response Example
```c
int status = MoorDyn_LoadState(dyn, "simulation.state");
if (status == MOORDYN_SUCCESS) {
    // State loaded successfully
}
```
```

--------------------------------

### MoorDyn C API Data Structures

Source: https://moordyn.readthedocs.io

Definitions for key data structures used in the MoorDyn C API.

```APIDOC
## MoorDynBody

### Description
Represents a body in the MoorDyn simulation.

### Fields
(Specific fields are not detailed in the source, but typically include properties like mass, inertia, position, velocity, forces, etc.)

### Usage Example
```c
MoorDynBody* body = MoorDyn_GetBody(dyn, 0);
// Access body properties using functions like MoorDyn_GetBodyPos, MoorDyn_GetBodyVel, etc.
```
```

```APIDOC
## MoorDynLine

### Description
Represents a line (e.g., mooring line) in the MoorDyn simulation.

### Fields
(Specific fields are not detailed in the source, but typically include properties like nodes, unstretched length, stiffness, etc.)

### Usage Example
```c
MoorDynLine* line = MoorDyn_GetLine(dyn, 0);
// Access line properties using functions like MoorDyn_GetLineNodePos, MoorDyn_GetLineUnstretchedLength, etc.
```
```

```APIDOC
## MoorDyn

### Description
Represents the main MoorDyn simulation object.

### Fields
(This is the primary object used to interact with the simulation. Specific fields are not detailed in the source.)

### Usage Example
```c
MoorDyn* dyn = MoorDyn_Create();
// Use this pointer for all other MoorDyn API calls.
MoorDyn_Close(dyn);
```
```

```APIDOC
## MoorDynPoint

### Description
Represents a point in the MoorDyn simulation, often a connection point.

### Fields
(Specific fields are not detailed in the source, but typically include properties like position, velocity, attached objects, etc.)

### Usage Example
```c
MoorDynPoint* point = MoorDyn_GetPoint(dyn, 0);
// Access point properties using functions like MoorDyn_GetPointPos, MoorDyn_GetPointVel, etc.
```
```

```APIDOC
## MoorDynRod

### Description
Represents a rod in the MoorDyn simulation.

### Fields
(Specific fields are not detailed in the source, but typically include properties like type, forces, etc.)

### Usage Example
```c
MoorDynRod* rod = MoorDyn_GetRod(dyn, 0);
// Access rod properties using functions like MoorDyn_GetRodType, MoorDyn_GetRodForce, etc.
```
```

```APIDOC
## MoorDynSeafloor

### Description
Represents the seafloor data in the MoorDyn simulation.

### Fields
(Specific fields are not detailed in the source.)

### Usage Example
```c
MoorDynSeafloor* seafloor = MoorDyn_GetSeafloor(dyn);
// Access seafloor properties if available.
```
```

```APIDOC
## MoorDynWaves

### Description
Represents the wave data in the MoorDyn simulation.

### Fields
(Specific fields are not detailed in the source.)

### Usage Example
```c
MoorDynWaves* waves = MoorDyn_GetWaves(dyn);
// Access wave properties if available.
```
```
Tokens:
Raw