MoorDyn2.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022, Matt Hall
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __MOORDYN2_H__
#define __MOORDYN2_H__
 
#include "MoorDynAPI.h"
#include "Waves.h"
#include "Seafloor.h"
#include "Point.h"
#include "Rod.h"
#include "Line.h"
#include "Body.h"
#include <stdlib.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#ifdef WIN32
#include <windows.h>
#endif
 
typedef struct __MoorDyn* MoorDyn;
 
MoorDyn DECLDIR
MoorDyn_Create(const char* infilename);
 
int DECLDIR
MoorDyn_NCoupledDOF(MoorDyn system, unsigned int* n);
 
int DECLDIR
MoorDyn_SetVerbosity(MoorDyn system, int verbosity);
 
int DECLDIR
MoorDyn_SetLogFile(MoorDyn system, const char* log_path);
 
int DECLDIR
MoorDyn_SetLogLevel(MoorDyn system, int verbosity);
 
int DECLDIR
MoorDyn_Log(MoorDyn system, int level, const char* msg);
 
int DECLDIR
MoorDyn_Init(MoorDyn system, const double* x, const double* xd);
 
int DECLDIR
MoorDyn_Init_NoIC(MoorDyn system, const double* x, const double* xd);
 
int DECLDIR
MoorDyn_Step(MoorDyn system,
             const double* x,
             const double* xd,
             double* f,
             double* t,
             double* dt);
 
int DECLDIR
MoorDyn_Close(MoorDyn system);
 
MoorDynWaves DECLDIR
MoorDyn_GetWaves(MoorDyn system);
 
MoorDynSeafloor DECLDIR
MoorDyn_GetSeafloor(MoorDyn system);
 
 
int DECLDIR
MoorDyn_ExternalWaveKinInit(MoorDyn system, unsigned int* n);
 
int DECLDIR
MoorDyn_ExternalWaveKinGetN(MoorDyn system, unsigned int* n);
 
int DECLDIR
MoorDyn_ExternalWaveKinGetCoordinates(MoorDyn system, double* r);
 
inline int DECLDIR DEPRECATED
MoorDyn_GetWaveKinCoordinates(MoorDyn system, double* r)
{
    return MoorDyn_ExternalWaveKinGetCoordinates(system, r);
}
 
int DECLDIR
MoorDyn_ExternalWaveKinSet(MoorDyn system,
                           const double* U,
                           const double* Ud,
                           double t);
 
inline int DECLDIR DEPRECATED
MoorDyn_SetWaveKin(MoorDyn system, const double* U, const double* Ud, double t)
{
    return MoorDyn_ExternalWaveKinSet(system, U, Ud, t);
}
 
 
int DECLDIR
MoorDyn_GetNumberBodies(MoorDyn system, unsigned int* n);
 
MoorDynBody DECLDIR
MoorDyn_GetBody(MoorDyn system, unsigned int b);
 
int DECLDIR
MoorDyn_GetNumberRods(MoorDyn system, unsigned int* n);
 
MoorDynRod DECLDIR
MoorDyn_GetRod(MoorDyn system, unsigned int r);
 
int DECLDIR
MoorDyn_GetNumberPoints(MoorDyn system, unsigned int* n);
 
MoorDynPoint DECLDIR
MoorDyn_GetPoint(MoorDyn system, unsigned int c);
 
int DECLDIR
MoorDyn_GetNumberLines(MoorDyn system, unsigned int* n);
 
MoorDynLine DECLDIR
MoorDyn_GetLine(MoorDyn system, unsigned int l);
 
int DECLDIR
MoorDyn_GetFASTtens(MoorDyn system,
                    const int* numLines,
                    float FairHTen[],
                    float FairVTen[],
                    float AnchHTen[],
                    float AnchVTen[]);
 
int DECLDIR
MoorDyn_GetDt(MoorDyn system, double* dt);
 
int DECLDIR
MoorDyn_SetDt(MoorDyn system, double dt);
 
int DECLDIR
MoorDyn_GetCFL(MoorDyn system, double* cfl);
 
int DECLDIR
MoorDyn_SetCFL(MoorDyn system, double cfl);
 
int DECLDIR
MoorDyn_GetTimeScheme(MoorDyn system, char* name, size_t* name_len);
 
int DECLDIR
MoorDyn_SetTimeScheme(MoorDyn system, const char* name);
 
int DECLDIR
MoorDyn_SaveState(MoorDyn system, const char* filepath);
 
int DECLDIR
MoorDyn_LoadState(MoorDyn system, const char* filepath);
 
int DECLDIR
MoorDyn_Serialize(MoorDyn system, size_t* size, uint64_t* data);
 
int DECLDIR
MoorDyn_Deserialize(MoorDyn system, const uint64_t* data);
 
int DECLDIR
MoorDyn_Save(MoorDyn system, const char* filepath);
 
int DECLDIR
MoorDyn_Load(MoorDyn system, const char* filepath);
 
int DECLDIR
MoorDyn_SaveVTK(MoorDyn system, const char* filename);
 
#ifdef __cplusplus
}
#endif
 
#endif