Typedefs
typedef struct __MoorDynBody *	MoorDynBody
	A mooring line instance.

typedef struct __MoorDynLine *	MoorDynLine
	A mooring line instance.

typedef struct __MoorDyn *	MoorDyn
	A mooring system instance.

typedef struct __MoorDynPoint *	MoorDynPoint
	A mooring point instance.

typedef struct __MoorDynRod *	MoorDynRod
	A mooring line instance.

typedef struct __MoorDynSeafloor *	MoorDynSeafloor
	A seafloor descriptor.

typedef struct __MoorDynWaves *	MoorDynWaves
	A mooring point instance.

Functions
int DECLDIR	MoorDyn_GetBodyID (MoorDynBody b, int *id)
	Get the body identifier. More...

int DECLDIR	MoorDyn_GetBodyType (MoorDynBody b, int *t)
	Get the point type. More...

int DECLDIR	MoorDyn_GetBodyState (MoorDynBody b, double r[6], double rd[6])
	Get the body state. More...

int DECLDIR	MoorDyn_GetBodyPos (MoorDynBody b, double r[3])
	Get the body position. More...

int DECLDIR	MoorDyn_GetBodyAngle (MoorDynBody b, double r[3])
	Get the body angle. More...

int DECLDIR	MoorDyn_GetBodyVel (MoorDynBody b, double rd[3])
	Get the body velocity. More...

int DECLDIR	MoorDyn_GetBodyAngVel (MoorDynBody b, double rd[3])
	Get the body angular velocity. More...

int DECLDIR	MoorDyn_GetBodyForce (MoorDynBody b, double f[6])
	Get the body angular velocity. More...

int DECLDIR	MoorDyn_GetBodyM (MoorDynBody b, double m[6][6])
	Get the body mass and intertia matrix. More...

int DECLDIR	MoorDyn_SaveBodyVTK (MoorDynBody b, const char *filename)
	Save the point to a VTK (.vtu) file. More...

int DECLDIR	MoorDyn_GetLineID (MoorDynLine l, int *id)
	Get the line identifier. More...

int DECLDIR	MoorDyn_GetLineN (MoorDynLine l, unsigned int *n)
	Get the line number of segments. More...

int DECLDIR	MoorDyn_GetLineNumberNodes (MoorDynLine l, unsigned int *n)
	Get the line number of nodes. More...

int DECLDIR	MoorDyn_GetLineUnstretchedLength (MoorDynLine l, double *ul)
	Get the line unstretched length. More...

int DECLDIR	MoorDyn_SetLineUnstretchedLength (MoorDynLine l, double ul)
	Set the line unstretched length. More...

int DECLDIR	MoorDyn_SetLineUnstretchedLengthVel (MoorDynLine l, double v)
	Set the line unstretched length rate of change. More...

int DECLDIR	MoorDyn_IsLineConstantEA (MoorDynLine l, int *b)
	Get whether the line is governed by a non-linear stiffness or a constant one. More...

int DECLDIR	MoorDyn_GetLineConstantEA (MoorDynLine l, double *EA)
	Get the constant stiffness of the line. More...

int DECLDIR	MoorDyn_SetLineConstantEA (MoorDynLine l, double EA)
	Set the constant stiffness of the line. More...

int DECLDIR	MoorDyn_IsLinePressBend (MoorDynLine l, int *b)
	Get whether the line pressure bending is considered or not. More...

int DECLDIR	MoorDyn_SetLinePressBend (MoorDynLine l, int b)
	Set whether the line pressure bending is considered or not. More...

int DECLDIR	MoorDyn_SetLinePressInt (MoorDynLine l, const double *p)
	Set the line internal pressure values at the nodes. More...

int DECLDIR	MoorDyn_GetLineNodePos (MoorDynLine l, unsigned int i, double pos[3])
	Get a line node position. More...

int DECLDIR	MoorDyn_GetLineNodeVel (MoorDynLine l, unsigned int i, double vel[3])
	Get a line node velocity. More...

int DECLDIR	MoorDyn_GetLineNodeForce (MoorDynLine l, unsigned int i, double f[3])
	Get a line node force. More...

int DECLDIR	MoorDyn_GetLineNodeTen (MoorDynLine l, unsigned int i, double t[3])
	Get a line node tension. More...

int DECLDIR	MoorDyn_GetLineNodeBendStiff (MoorDynLine l, unsigned int i, double t[3])
	Get a line node bending stiffness force. More...

int DECLDIR	MoorDyn_GetLineNodeWeight (MoorDynLine l, unsigned int i, double f[3])
	Get a line node weight and bouyancy. More...

int DECLDIR	MoorDyn_GetLineNodeDrag (MoorDynLine l, unsigned int i, double f[3])
	Get a line node drag force. More...

int DECLDIR	MoorDyn_GetLineNodeFroudeKrilov (MoorDynLine l, unsigned int i, double f[3])
	Get a line node Froude Krilov force. More...

int DECLDIR	MoorDyn_GetLineNodeSeabedForce (MoorDynLine l, unsigned int i, double f[3])
	Get a line node seabed reaction. More...

int DECLDIR	MoorDyn_GetLineNodeCurv (MoorDynLine l, unsigned int i, double *c)
	Get a line curvature at a node. More...

int DECLDIR	MoorDyn_GetLineNodeM (MoorDynLine l, unsigned int i, double m[3][3])
	Get a line node mass matrix. More...

int DECLDIR	MoorDyn_GetLineFairTen (MoorDynLine l, double *t)
	Get the tension module at the end point B (the fairlead) More...

int DECLDIR	MoorDyn_GetLineMaxTen (MoorDynLine l, double *t)
	Get the maximum tension module. More...

int DECLDIR	MoorDyn_SaveLineVTK (MoorDynLine l, const char *filename)
	Save the line to a VTK (.vtu) file. More...

MoorDyn DECLDIR	MoorDyn_Create (const char *infilename)
	Creates a MoorDyn instance. More...

int DECLDIR	MoorDyn_NCoupledDOF (MoorDyn system, unsigned int *n)
	Get the number of coupled Degrees Of Freedom (DOFs) More...

int DECLDIR	MoorDyn_SetVerbosity (MoorDyn system, int verbosity)
	Set the instance verbosity level. More...

int DECLDIR	MoorDyn_SetLogFile (MoorDyn system, const char *log_path)
	Set the instance log file. More...

int DECLDIR	MoorDyn_SetLogLevel (MoorDyn system, int verbosity)
	Set the instance log file printing level. More...

int DECLDIR	MoorDyn_Log (MoorDyn system, int level, const char *msg)
	Log a message. More...

int DECLDIR	MoorDyn_Init (MoorDyn system, const double x, const double xd)
	Compute the initial condition of a MoorDyn system. More...

int DECLDIR	MoorDyn_Init_NoIC (MoorDyn system, const double x, const double xd)
	The same than MoorDyn_Init(), but the initial condition is not computed at all. More...

int DECLDIR	MoorDyn_Step (MoorDyn system, const double x, const double xd, double f, double t, double *dt)
	Runs a time step of the MoorDyn system. More...

int DECLDIR	MoorDyn_Close (MoorDyn system)
	Releases MoorDyn allocated resources. More...

MoorDynWaves DECLDIR	MoorDyn_GetWaves (MoorDyn system)
	Get the wave kinematics instance. More...

MoorDynSeafloor DECLDIR	MoorDyn_GetSeafloor (MoorDyn system)
	Get the 3D seafloor instance. More...

int DECLDIR	MoorDyn_GetNumberBodies (MoorDyn system, unsigned int *n)
	Get the number of bodies. More...

MoorDynBody DECLDIR	MoorDyn_GetBody (MoorDyn system, unsigned int b)
	Get a rigid body. More...

int DECLDIR	MoorDyn_GetNumberRods (MoorDyn system, unsigned int *n)
	Get the number of rods. More...

MoorDynRod DECLDIR	MoorDyn_GetRod (MoorDyn system, unsigned int r)
	Get a rod. More...

int DECLDIR	MoorDyn_GetNumberPoints (MoorDyn system, unsigned int *n)
	Get the number of points. More...

MoorDynPoint DECLDIR	MoorDyn_GetPoint (MoorDyn system, unsigned int c)
	Get a point. More...

int DECLDIR	MoorDyn_GetNumberLines (MoorDyn system, unsigned int *n)
	Get the number of lines. More...

MoorDynLine DECLDIR	MoorDyn_GetLine (MoorDyn system, unsigned int l)
	Get a line instance. More...

int DECLDIR	MoorDyn_GetFASTtens (MoorDyn system, const int *numLines, float FairHTen[], float FairVTen[], float AnchHTen[], float AnchVTen[])
	Function for providing FASTv7 customary line tension quantities. More...

int DECLDIR	MoorDyn_GetDt (MoorDyn system, double *dt)
	Get the current model time step. More...

int DECLDIR	MoorDyn_SetDt (MoorDyn system, double dt)
	Set the model time step. More...

int DECLDIR	MoorDyn_GetCFL (MoorDyn system, double *cfl)
	Get the current model Courant–Friedrichs–Lewy factor. More...

int DECLDIR	MoorDyn_SetCFL (MoorDyn system, double cfl)
	Set the model Courant–Friedrichs–Lewy factor. More...

int DECLDIR	MoorDyn_GetTimeScheme (MoorDyn system, char name, size_t name_len)
	Get the current time scheme name. More...

int DECLDIR	MoorDyn_SetTimeScheme (MoorDyn system, const char *name)
	Set the time scheme by its name. More...

int DECLDIR	MoorDyn_SaveState (MoorDyn system, const char *filepath)
	Save the system state, so it can be loaded afterwards. More...

int DECLDIR	MoorDyn_LoadState (MoorDyn system, const char *filepath)
	Load and set a system state. More...

int DECLDIR	MoorDyn_Serialize (MoorDyn system, size_t size, uint64_t data)
	Serialize the system to bytes. More...

int DECLDIR	MoorDyn_Deserialize (MoorDyn system, const uint64_t *data)
	Load the system from the serialized data before. More...

int DECLDIR	MoorDyn_Save (MoorDyn system, const char *filepath)
	Save the system so it can be loaded afterwards. More...

int DECLDIR	MoorDyn_Load (MoorDyn system, const char *filepath)
	Load the system saved before. More...

int DECLDIR	MoorDyn_SaveVTK (MoorDyn system, const char *filename)
	Save the whole system to a VTK (.vtm) file. More...

int DECLDIR	MoorDyn_GetPointID (MoorDynPoint point, int *id)
	Get the point identifier. More...

int DECLDIR	MoorDyn_GetPointType (MoorDynPoint point, int *t)
	Get the point type. More...

int DECLDIR	MoorDyn_GetPointPos (MoorDynPoint point, double pos[3])
	Get the position of a point. More...

int DECLDIR	MoorDyn_GetPointVel (MoorDynPoint point, double v[3])
	Get the velocity of a point. More...

int DECLDIR	MoorDyn_GetPointForce (MoorDynPoint point, double f[3])
	Get the force at a point. More...

int DECLDIR	MoorDyn_GetPointM (MoorDynPoint point, double m[3][3])
	Get the point mass matrix. More...

int DECLDIR	MoorDyn_GetPointNAttached (MoorDynPoint point, unsigned int *n)
	Get the number of connected lines. More...

int DECLDIR	MoorDyn_GetPointAttached (MoorDynPoint point, unsigned int i, MoorDynLine l, int e)
	Get the number of connected lines. More...

int DECLDIR	MoorDyn_SavePointVTK (MoorDynPoint point, const char *filename)
	Save the point to a VTK (.vtu) file. More...

int DECLDIR	MoorDyn_GetRodID (MoorDynRod l, int *id)
	Get the line identifier. More...

int DECLDIR	MoorDyn_GetRodType (MoorDynRod l, int *t)
	Get the line type. More...

int DECLDIR	MoorDyn_GetRodForce (MoorDynRod l, double f[6])
	Get the net force acting on the rod, as well as the moment at end point A if the node is not pinned. More...

int DECLDIR	MoorDyn_GetRodM (MoorDynRod l, double m[6][6])
	Get the total rod mass matrix. More...

int DECLDIR	MoorDyn_GetRodN (MoorDynRod l, unsigned int *n)
	Get the line number of segments. More...

int DECLDIR	MoorDyn_GetRodNumberNodes (MoorDynRod l, unsigned int *n)
	Get the line number of nodes. More...

int DECLDIR	MoorDyn_GetRodNodePos (MoorDynRod l, unsigned int i, double pos[3])
	Get a rod node position. More...

int DECLDIR	MoorDyn_GetRodNodeVel (MoorDynRod l, unsigned int i, double vel[3])
	Get a rod node velocity. More...

int DECLDIR	MoorDyn_SaveRodVTK (MoorDynRod l, const char *filename)
	Save the line to a VTK (.vtu) file. More...

int DECLDIR	MoorDyn_GetWavesKin (MoorDynWaves waves, double x, double y, double z, double U[3], double Ud[3], double zeta, double PDyn, MoorDynSeafloor seafloor)
	Get the velocity, acceleration, wave height and dynamic pressure at a specific position and time. More...

double DECLDIR	WaveNumber (double Omega, double g, double h)
	Compute the wave number. More...

External Wave Kinematics
The functions for setting external wave kinematics.
int DECLDIR	MoorDyn_ExternalWaveKinInit (MoorDyn system, unsigned int *n)
	Initializes the external Wave kinematics. More...

int DECLDIR	MoorDyn_ExternalWaveKinGetN (MoorDyn system, unsigned int *n)
	Get the number of points where the waves kinematics shall be provided. More...

int DECLDIR	MoorDyn_ExternalWaveKinGetCoordinates (MoorDyn system, double *r)
	Get the points where the waves kinematics shall be provided. More...

int DECLDIR DEPRECATED	MoorDyn_GetWaveKinCoordinates (MoorDyn system, double *r)
	Get the points where the waves kinematics shall be provided. More...

int DECLDIR	MoorDyn_ExternalWaveKinSet (MoorDyn system, const double U, const double Ud, double t)
	Set the kinematics of the waves. More...

int DECLDIR DEPRECATED	MoorDyn_SetWaveKin (MoorDyn system, const double U, const double Ud, double t)
	Set the kinematics of the waves. More...

Detailed Description

Function Documentation

◆ MoorDyn_Close()

int DECLDIR MoorDyn_Close ( MoorDyn system )

Releases MoorDyn allocated resources.

Parameters

system The Moordyn system

Returns: MOORDYN_SUCESS If the mooring system is correctly destroyed, an error code otherwise (see Errors reported by MoorDyn)

Here is the caller graph for this function:

◆ MoorDyn_Create()

MoorDyn DECLDIR MoorDyn_Create ( const char * infilename )

Creates a MoorDyn instance.

At the time of creating a new MoorDyn instance, the input file is read and all the objects and structures are created. You must call afterwards MoorDyn_Init() to compute the initial conditions

Parameters

infilename The input file, if either NULL or "", then "Mooring/lines.txt" will be considered

Returns: The mooring instance, NULL if errors happened

◆ MoorDyn_Deserialize()

int DECLDIR MoorDyn_Deserialize	(	MoorDyn	system,
		const uint64_t *	data
	)

Load the system from the serialized data before.

You can restore the system to a previous state retrieved calling MoorDyn_Serialize()

Parameters

system	The Moordyn system
data	Bytes array

Returns: MOORDYN_SUCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

See also: MoorDyn_Save; MoorDyn_Init_NoIC

◆ MoorDyn_ExternalWaveKinGetCoordinates()

int DECLDIR MoorDyn_ExternalWaveKinGetCoordinates	(	MoorDyn	system,
		double *	r
	)

Get the points where the waves kinematics shall be provided.

The kinematics on those points shall be provided just if WaveKin is set to 1 in the input file. The pointer r should be to an array with enough space for 3 * N doubles, where N is the value from MoorDyn_ExternalWaveKinGetN or MoorDyn_ExternalWaveKinInit.

Parameters

system	The Moordyn system
r	The output coordinates (3 components per point)

Returns: MOORDYN_SUCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

See also: MoorDyn_ExternalWaveKinInit()

Here is the caller graph for this function:

◆ MoorDyn_ExternalWaveKinGetN()

int DECLDIR MoorDyn_ExternalWaveKinGetN	(	MoorDyn	system,
		unsigned int *	n
	)

Get the number of points where the waves kinematics shall be provided.

This is useless unless WaveKin option is set to 1 in the input file

Parameters

system	The Moordyn system
n	The output number of points where the wave kinematics shall be provided

Returns: MOORDYN_SUCESS

See also: MoorDyn_ExternalWaveKinInit()

Here is the caller graph for this function:

◆ MoorDyn_ExternalWaveKinInit()

int DECLDIR MoorDyn_ExternalWaveKinInit	(	MoorDyn	system,
		unsigned int *	n
	)

Initializes the external Wave kinematics.

This is useless unless the WaveKin option is set to 1 in the input file. If that is the case, remember to call this function after MoorDyn_Init()

Parameters

system	The Moordyn system
n	The number of points where the wave kinematics shall be provided

Returns: MOORDYN_SUCESS If the external waves are correctly initialized, an error code otherwise (see Errors reported by MoorDyn)

Here is the caller graph for this function:

◆ MoorDyn_ExternalWaveKinSet()

int DECLDIR MoorDyn_ExternalWaveKinSet	(	MoorDyn	system,
		const double *	U,
		const double *	Ud,
		double	t
	)

Set the kinematics of the waves.

Use this function if the WaveKin option is set to 1 in the input file

Parameters

system	The Moordyn system
U	The velocities at the points (3 components per point)
Ud	The accelerations at the points (3 components per point)
t	Simulation time

Returns: MOORDYN_SUCCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

See also: MoorDyn_ExternalWaveKinInit(); MoorDyn_ExternalWaveKinGetCoordinates()

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MoorDyn_GetBody()

MoorDynBody DECLDIR MoorDyn_GetBody	(	MoorDyn	system,
		unsigned int	b
	)

Get a rigid body.

Remember that the first body index is 1

Parameters

system	The Moordyn system
b	The body index

Returns: The body instance, NULL if errors happened

◆ MoorDyn_GetBodyAngle()

int DECLDIR MoorDyn_GetBodyAngle	(	MoorDynBody	b,
		double	r[3]
	)

Get the body angle.

Parameters

b	The Moordyn body
r	The output angles (3dof)

Returns: MOORDYN_INVALID_VALUE if a NULL body is provided, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetBodyAngVel()

int DECLDIR MoorDyn_GetBodyAngVel	(	MoorDynBody	b,
		double	rd[3]
	)

Get the body angular velocity.

Parameters

b	The Moordyn body
rd	The output angular velocity (3dof)

Returns: MOORDYN_INVALID_VALUE if a NULL body is provided, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetBodyForce()

int DECLDIR MoorDyn_GetBodyForce	(	MoorDynBody	b,
		double	f[6]
	)

Get the body angular velocity.

Parameters

b	The Moordyn body
rd	The output angular velocity (3dof)

Returns: MOORDYN_INVALID_VALUE if a NULL body is provided, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetBodyID()

int DECLDIR MoorDyn_GetBodyID	(	MoorDynBody	b,
		int *	id
	)

Get the body identifier.

Parameters

b	The Moordyn body
id	The output id

Returns: MOORDYN_INVALID_VALUE if a NULL point is provided, MOORDYN_SUCCESS otherwise

◆ MoorDyn_GetBodyM()

int DECLDIR MoorDyn_GetBodyM	(	MoorDynBody	b,
		double	m[6][6]
	)

Get the body mass and intertia matrix.

Parameters

b	The Moordyn body
m	The output mass matrix

Returns: MOORDYN_INVALID_VALUE if a NULL body is provided, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetBodyPos()

int DECLDIR MoorDyn_GetBodyPos	(	MoorDynBody	b,
		double	r[3]
	)

Get the body position.

Parameters

b	The Moordyn body
r	The output position (3dof)

Returns: MOORDYN_INVALID_VALUE if a NULL body is provided, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetBodyState()

int DECLDIR MoorDyn_GetBodyState	(	MoorDynBody	b,
		double	r[6],
		double	rd[6]
	)

Get the body state.

Parameters

b	The Moordyn body
r	The output position (6dof)
rd	The output velocity (6dof)

Returns: MOORDYN_INVALID_VALUE if a NULL body is provided, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetBodyType()

int DECLDIR MoorDyn_GetBodyType	(	MoorDynBody	b,
		int *	t
	)

Get the point type.

Parameters

b	The Moordyn body
t	The output type

Returns: MOORDYN_INVALID_VALUE if a NULL point is provided, MOORDYN_SUCCESS otherwise

See also: Point::types

◆ MoorDyn_GetBodyVel()

int DECLDIR MoorDyn_GetBodyVel	(	MoorDynBody	b,
		double	rd[3]
	)

Get the body velocity.

Parameters

b	The Moordyn body
rd	The output velocity (3dof)

Returns: MOORDYN_INVALID_VALUE if a NULL body is provided, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetCFL()

int DECLDIR MoorDyn_GetCFL	(	MoorDyn	system,
		double *	cfl
	)

Get the current model Courant–Friedrichs–Lewy factor.

Parameters

system	The Moordyn system
cfl	The output Courant–Friedrichs–Lewy factor

Returns: MOORDYN_SUCESS if the data is correctly got, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_GetDt()

int DECLDIR MoorDyn_GetDt	(	MoorDyn	system,
		double *	dt
	)

Get the current model time step.

Parameters

system	The Moordyn system
dt	The output time step

Returns: MOORDYN_SUCESS if the data is correctly got, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_GetFASTtens()

int DECLDIR MoorDyn_GetFASTtens	(	MoorDyn	system,
		const int *	numLines,
		float	FairHTen[],
		float	FairVTen[],
		float	AnchHTen[],
		float	AnchVTen[]
	)

Function for providing FASTv7 customary line tension quantities.

Parameters

system	The Moordyn system
numLines	The number of lines
FairHTen	Allocated memory for the `numLines` horizontal forces at the fairlead
FairVTen	Allocated memory for the `numLines` vertical forces at the fairlead
AnchHTen	Allocated memory for the `numLines` horizontal forces at the anchor
AnchVTen	Allocated memory for the `numLines` vertical forces at the anchor

Returns: MOORDYN_SUCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_GetLine()

MoorDynLine DECLDIR MoorDyn_GetLine	(	MoorDyn	system,
		unsigned int	l
	)

Get a line instance.

Parameters

system	The Moordyn system
l	The line identifier (from 1 to the number of lines)

Returns: The line instance, NULL if errors happened

◆ MoorDyn_GetLineConstantEA()

int DECLDIR MoorDyn_GetLineConstantEA	(	MoorDynLine	l,
		double *	EA
	)

Get the constant stiffness of the line.

This value is useless if non-linear stiffness is considered

Parameters

l	The Moordyn line
EA	The constant stiffness EA value

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

See also: MoorDyn_IsLineConstantEA(); MoorDyn_SetLineConstantEA()

◆ MoorDyn_GetLineFairTen()

int DECLDIR MoorDyn_GetLineFairTen	(	MoorDynLine	l,
		double *	t
	)

Get the tension module at the end point B (the fairlead)

Parameters

l	The Moordyn line
t	The output node tension module

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

◆ MoorDyn_GetLineID()

int DECLDIR MoorDyn_GetLineID	(	MoorDynLine	l,
		int *	id
	)

Get the line identifier.

Parameters

l	The Moordyn line
id	The output id

Returns: MOORDYN_INVALID_VALUE if a NULL point is provided, MOORDYN_SUCCESS otherwise

◆ MoorDyn_GetLineMaxTen()

int DECLDIR MoorDyn_GetLineMaxTen	(	MoorDynLine	l,
		double *	t
	)

Get the maximum tension module.

Parameters

l	The Moordyn line
t	The output maximum tension module

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

◆ MoorDyn_GetLineN()

int DECLDIR MoorDyn_GetLineN	(	MoorDynLine	l,
		unsigned int *	n
	)

Get the line number of segments.

The number of nodes is equal to this value plus 1

Parameters

l	The Moordyn line
n	The output number of nodes

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

Here is the caller graph for this function:

◆ MoorDyn_GetLineNodeBendStiff()

int DECLDIR MoorDyn_GetLineNodeBendStiff	(	MoorDynLine	l,
		unsigned int	i,
		double	t[3]
	)

Get a line node bending stiffness force.

The bending stiffness is computed at each segment as

$\bar{Bs}(i) = E I \frac{\bar{k}(i)}{l_0}$

with the unstretched segment length, the Young's modulus, the segment normal axis inertia, and $\bar{k}$ the curvature vector.

To get the node bending stiffness forces the surrounding segments forces are accumulated

Parameters

l	The Moordyn line
i	The node index
t	The output node force

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetLineNodeCurv()

int DECLDIR MoorDyn_GetLineNodeCurv	(	MoorDynLine	l,
		unsigned int	i,
		double *	c
	)

Get a line curvature at a node.

Parameters

l	The Moordyn line
i	The node index
c	The output line curvature

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Note: The curvature is only computed if bending stiffness (moordyn::Line::EI) is not zero. Otherwise the curvature of every single node will be zero.

◆ MoorDyn_GetLineNodeDrag()

int DECLDIR MoorDyn_GetLineNodeDrag	(	MoorDynLine	l,
		unsigned int	i,
		double	f[3]
	)

Get a line node drag force.

This is computed at each segment as

$\bar{D}(i) = \frac{1}{2} l_0 F(i) \rho_w \left( Cd_t \pi d \vert \bar{v}_t(i) \vert \bar{v}_t(i) + Cd_n d \vert \bar{v}_n(i) \vert \bar{v}_n(i) \right)$

with the unstretched segment length, the portion of the segment submerged, $\rho_w$ the water density, the line diameter, and the normal and tangential drag coefficients, and $\bar{v}_t$ and $\bar{v}_n$ the tangential and normal velocities:

$\bar{v}_t = (\bar{v} - \bar{U}) \cdot \bar{q}$

$\bar{v}_n = (\bar{v} - \bar{U}) - \bar{v}_t$

with $\bar{v}$ the velocity, $\bar{U}$ the flow velocity and $\bar{q}$ the direction verctor of the segment

The drag at any internal node is computed as the average of the surrounding segments, while on the line-ends half of the associated ending segment drag force is returned.

Parameters

l	The Moordyn line
i	The node index
f	The output node force

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetLineNodeForce()

int DECLDIR MoorDyn_GetLineNodeForce	(	MoorDynLine	l,
		unsigned int	i,
		double	f[3]
	)

Get a line node force.

To get the components of the force use MoorDyn_GetLineNodeTen() , MoorDyn_GetLineNodeBendStiff(), MoorDyn_GetLineNodeWeight() , MoorDyn_GetLineNodeDrag() , MoorDyn_GetLineNodeFroudeKrilov() and MoorDyn_GetLineNodeSeaBedForce()

Note: The net force is not the sum of all the components that you cat extract from the API. For instance, the tension contribution on the internal nodes is the difference between the tensions of the adjacent segments, while MoorDyn_GetLineNodeTen() is returning the averaged value.

Parameters

l	The Moordyn line
i	The node index
f	The output node net force

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetLineNodeFroudeKrilov()

int DECLDIR MoorDyn_GetLineNodeFroudeKrilov	(	MoorDynLine	l,
		unsigned int	i,
		double	f[3]
	)

Get a line node Froude Krilov force.

This is computed at each segment as

$\bar{Fk}(i) = V(i) F(i) \rho_w \left( (1 + Ca_t) \frac{\mathrm{d} \bar{v}_t}{\mathrm{d} t} + (1 + Ca_n) \frac{\mathrm{d} \bar{v}_n}{\mathrm{d} t} \right)$

with the segment volume, the portion of the segment submerged, $\rho_w$ the water density, and the normal and tangential drag coefficients, and $\frac{\mathrm{d} \bar{v}_t}{\mathrm{d} t}$ and $\frac{\mathrm{d} \bar{v}_n}{\mathrm{d} t}$ the tangential and normal accelerations:

$\frac{\mathrm{d} \bar{v}_t}{\mathrm{d} t} = \frac{\mathrm{d} \bar{v}}{\mathrm{d} t} \cdot \bar{q}(i)$

$\frac{\mathrm{d} \bar{v}_n}{\mathrm{d} t} = \frac{\mathrm{d} \bar{v}}{\mathrm{d} t} - \frac{\mathrm{d} \bar{v}_t}{\mathrm{d} t}$

with $\bar{q}(i)$ the direction verctor of the segment

The force at any internal node is computed as the average of the surrounding segments, while on the line-ends half of the associated ending segment Froude-Krylov force is returned.

Parameters

l	The Moordyn line
i	The node index
f	The output node force

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetLineNodeM()

int DECLDIR MoorDyn_GetLineNodeM	(	MoorDynLine	l,
		unsigned int	i,
		double	m[3][3]
	)

Get a line node mass matrix.

The mass matrix includes the node mass as well as the added mass

Parameters

l	The Moordyn line
i	The node index
m	The output mass matrix

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetLineNodePos()

int DECLDIR MoorDyn_GetLineNodePos	(	MoorDynLine	l,
		unsigned int	i,
		double	pos[3]
	)

Get a line node position.

Parameters

l	The Moordyn line
i	The node index
pos	The output node position

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetLineNodeSeabedForce()

int DECLDIR MoorDyn_GetLineNodeSeabedForce	(	MoorDynLine	l,
		unsigned int	i,
		double	f[3]
	)

Get a line node seabed reaction.

This is computed at each segment as

$\bar{B}(i) = l_0 d \left( Kb (\bar{r}_b - \bar{r}(i)) \cdot \bar{k} Cb \bar{v} \cdot \bar{k} + \right) \bar{k}$

with the unstretched segment length, the line diameter and the bottom stiff and drag coefficients, $\bar{r}_b$ the seabed position, $\bar{r}$ the position, $\bar{v}$ the velocity and $\bar{k}$ the upward direction vector.

If bottom friction is configured, the force is added to this magnitude as well.

The reaction force at any internal node is computed as the average of the surrounding segments, while on the line-ends half of the associated ending segment weight force is returned.

Parameters

l	The Moordyn line
i	The node index
f	The output node force

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetLineNodeTen()

int DECLDIR MoorDyn_GetLineNodeTen	(	MoorDynLine	l,
		unsigned int	i,
		double	t[3]
	)

Get a line node tension.

The node tension is the sum of the axial stiffness plus the internal damping

$\bar{T}(i) = E A \left( \frac{l(i) - l_0}{l_0} - \frac{\beta A}{l_0} \frac{\mathrm{d}l(i)}{\mathrm{d}t} \right) \bar{q}(i)$

with and the stretched and unstretched segment lengths respectively, the Young's modulus, the transversal area, $\beta$ the internal damping coefficient and $\bar{q}(i)$ the direction verctor of the segment.

As can be appreciated, the node tension is computed at each segment. So to get the node one the surrounding segments are averaged (in case of line-ends the associated ending segment tension is returned)

Parameters

l	The Moordyn line
i	The node index
t	The output node tension

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetLineNodeVel()

int DECLDIR MoorDyn_GetLineNodeVel	(	MoorDynLine	l,
		unsigned int	i,
		double	vel[3]
	)

Get a line node velocity.

Parameters

l	The Moordyn line
i	The node index
vel	The output node velocity

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetLineNodeWeight()

int DECLDIR MoorDyn_GetLineNodeWeight	(	MoorDynLine	l,
		unsigned int	i,
		double	f[3]
	)

Get a line node weight and bouyancy.

This is computed at each segment as

$\bar{W}(i) = A l_0 \left(\rho - F(i) \rho_w \right) \bar{g}$

with the unstretched segment length, the transversal area, $\rho$ the line material density, $\rho_w$ the water density, the portion of the segment submerged and $\bar{g}$ the gravity acceleration.

The weight and buoyancy force at any internal node is computed as the average of the surrounding segments, while on the line-ends half of the associated ending segment weight force is returned.

Parameters

l	The Moordyn line
i	The node index
f	The output node force

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetLineNumberNodes()

int DECLDIR MoorDyn_GetLineNumberNodes	(	MoorDynLine	l,
		unsigned int *	n
	)

Get the line number of nodes.

Parameters

l	The Moordyn line
n	The output number of nodes

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

See also: MoorDyn_GetLineN()

Here is the call graph for this function:

◆ MoorDyn_GetLineUnstretchedLength()

int DECLDIR MoorDyn_GetLineUnstretchedLength	(	MoorDynLine	l,
		double *	ul
	)

Get the line unstretched length.

Parameters

l	The Moordyn line
ul	The output length

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

See also: MoorDyn_SetLineUnstretchedLength()

◆ MoorDyn_GetNumberBodies()

int DECLDIR MoorDyn_GetNumberBodies	(	MoorDyn	system,
		unsigned int *	n
	)

Get the number of bodies.

Remember that the first body index is 1

Parameters

system	The Moordyn system
n	The output number of bodies

Returns: MOORDYN_SUCESS If the number is successfully got, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_GetNumberLines()

int DECLDIR MoorDyn_GetNumberLines	(	MoorDyn	system,
		unsigned int *	n
	)

Get the number of lines.

Remember that the first line index is 1

Parameters

system	The Moordyn system
n	The output number of lines

Returns: MOORDYN_SUCESS If the number is successfully got, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_GetNumberPoints()

int DECLDIR MoorDyn_GetNumberPoints	(	MoorDyn	system,
		unsigned int *	n
	)

Get the number of points.

Remember that the first point index is 1

Parameters

system	The Moordyn system
n	The output number of points

Returns: MOORDYN_SUCESS If the number is successfully got, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_GetNumberRods()

int DECLDIR MoorDyn_GetNumberRods	(	MoorDyn	system,
		unsigned int *	n
	)

Get the number of rods.

Remember that the first rod index is 1

Parameters

system	The Moordyn system
n	The output number of rods

Returns: MOORDYN_SUCESS If the number is successfully got, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_GetPoint()

MoorDynPoint DECLDIR MoorDyn_GetPoint	(	MoorDyn	system,
		unsigned int	c
	)

Get a point.

Parameters

system	The Moordyn system
c	The point

Returns: The point instance, NULL if errors happened

◆ MoorDyn_GetPointAttached()

int DECLDIR MoorDyn_GetPointAttached	(	MoorDynPoint	point,
		unsigned int	i,
		MoorDynLine *	l,
		int *	e
	)

Get the number of connected lines.

Parameters

point	The Moordyn point
i	The index of the attached line
l	The output attached line
e	The output endpoint, see moordyn::EndPoints

Returns: MOORDYN_SUCCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_GetPointForce()

int DECLDIR MoorDyn_GetPointForce	(	MoorDynPoint	point,
		double	f[3]
	)

Get the force at a point.

Parameters

point	The Moordyn point
f	The output force

Returns: MOORDYN_SUCCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

Here is the call graph for this function:

◆ MoorDyn_GetPointID()

int DECLDIR MoorDyn_GetPointID	(	MoorDynPoint	point,
		int *	id
	)

Get the point identifier.

Parameters

point	The Moordyn point
id	The output id

Returns: MOORDYN_INVALID_VALUE if a NULL point is provided, MOORDYN_SUCCESS otherwise

◆ MoorDyn_GetPointM()

int DECLDIR MoorDyn_GetPointM	(	MoorDynPoint	point,
		double	m[3][3]
	)

Get the point mass matrix.

Parameters

point	The Moordyn point
f	The output force

Returns: MOORDYN_SUCCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

Here is the call graph for this function:

◆ MoorDyn_GetPointNAttached()

int DECLDIR MoorDyn_GetPointNAttached	(	MoorDynPoint	point,
		unsigned int *	n
	)

Get the number of connected lines.

Parameters

point	The Moordyn point
n	The output number of connected lines

Returns: MOORDYN_SUCCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_GetPointPos()

int DECLDIR MoorDyn_GetPointPos	(	MoorDynPoint	point,
		double	pos[3]
	)

Get the position of a point.

Parameters

point	The Moordyn point
pos	The output position

Returns: MOORDYN_SUCCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

Here is the call graph for this function:

◆ MoorDyn_GetPointType()

int DECLDIR MoorDyn_GetPointType	(	MoorDynPoint	point,
		int *	t
	)

Get the point type.

Parameters

point	The Moordyn point
t	The output type

Returns: MOORDYN_INVALID_VALUE if a NULL point is provided, MOORDYN_SUCCESS otherwise

See also: Point::types

◆ MoorDyn_GetPointVel()

int DECLDIR MoorDyn_GetPointVel	(	MoorDynPoint	point,
		double	v[3]
	)

Get the velocity of a point.

Parameters

point	The Moordyn point
v	The output velocity

Returns: MOORDYN_SUCCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

Here is the call graph for this function:

◆ MoorDyn_GetRod()

MoorDynRod DECLDIR MoorDyn_GetRod	(	MoorDyn	system,
		unsigned int	r
	)

Get a rod.

Parameters

system	The Moordyn system
r	The rod

Returns: The rod instance, NULL if errors happened

◆ MoorDyn_GetRodForce()

int DECLDIR MoorDyn_GetRodForce	(	MoorDynRod	l,
		double	f[6]
	)

Get the net force acting on the rod, as well as the moment at end point A if the node is not pinned.

Parameters

l	The Moordyn rod
f	The output force

Returns: MOORDYN_INVALID_VALUE if a NULL point is provided, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetRodID()

int DECLDIR MoorDyn_GetRodID	(	MoorDynRod	l,
		int *	id
	)

Get the line identifier.

Parameters

l	The Moordyn rod
id	The output id

Returns: MOORDYN_INVALID_VALUE if a NULL point is provided, MOORDYN_SUCCESS otherwise

◆ MoorDyn_GetRodM()

int DECLDIR MoorDyn_GetRodM	(	MoorDynRod	l,
		double	m[6][6]
	)

Get the total rod mass matrix.

Parameters

l	The Moordyn rod
m	The output mass matrix

Returns: MOORDYN_INVALID_VALUE if a NULL point is provided, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetRodN()

int DECLDIR MoorDyn_GetRodN	(	MoorDynRod	l,
		unsigned int *	n
	)

Get the line number of segments.

The number of nodes is equal to this value plus 1

Parameters

l	The Moordyn rod
n	The output number of nodes

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

Here is the caller graph for this function:

◆ MoorDyn_GetRodNodePos()

int DECLDIR MoorDyn_GetRodNodePos	(	MoorDynRod	l,
		unsigned int	i,
		double	pos[3]
	)

Get a rod node position.

Parameters

l	The Moordyn rod
i	The node index
pos	The output node position

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetRodNodeVel()

int DECLDIR MoorDyn_GetRodNodeVel	(	MoorDynRod	l,
		unsigned int	i,
		double	vel[3]
	)

Get a rod node velocity.

Parameters

l	The Moordyn rod
i	The node index
vel	The output node velocity

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided or if the node index is bigger than the number of segments, MOORDYN_SUCCESS otherwise

Here is the call graph for this function:

◆ MoorDyn_GetRodNumberNodes()

int DECLDIR MoorDyn_GetRodNumberNodes	(	MoorDynRod	l,
		unsigned int *	n
	)

Get the line number of nodes.

Parameters

l	The Moordyn rod
n	The output number of nodes

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

See also: MoorDyn_GetRodN()

Here is the call graph for this function:

◆ MoorDyn_GetRodType()

int DECLDIR MoorDyn_GetRodType	(	MoorDynRod	l,
		int *	t
	)

Get the line type.

Parameters

l	The Moordyn rod
t	The output type

Returns: MOORDYN_INVALID_VALUE if a NULL point is provided, MOORDYN_SUCCESS otherwise

◆ MoorDyn_GetSeafloor()

MoorDynSeafloor DECLDIR MoorDyn_GetSeafloor ( MoorDyn system )

Get the 3D seafloor instance.

The seafloor instance is only not null if a SeafloorPath was given as an option.

Parameters

system The Moordyn system

Returns: The Seafloor instance, NULL if errors happened or there is no 3D seafloor

◆ MoorDyn_GetTimeScheme()

int DECLDIR MoorDyn_GetTimeScheme	(	MoorDyn	system,
		char *	name,
		size_t *	name_len
	)

Get the current time scheme name.

Parameters

system	The Moordyn system
name	The output name. Can be NULL.
name_len	The output number of bytes written. Can be NULL.

Returns: MOORDYN_SUCESS if the data is correctly got, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_GetWaveKinCoordinates()

int DECLDIR DEPRECATED MoorDyn_GetWaveKinCoordinates	(	MoorDyn	system,
		double *	r
	)

inline

Get the points where the waves kinematics shall be provided.

The kinematics on those points shall be provided just if WaveKin is set to 1 in the input file

Parameters

system	The Moordyn system
r	The output coordinates (3 components per point)

Returns: MOORDYN_SUCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

Deprecated:: This function has been renamed as MoorDyn_ExternalWaveKinGetCoordinates()

See also: MoorDyn_ExternalWaveKinInit()

Here is the call graph for this function:

◆ MoorDyn_GetWaves()

MoorDynWaves DECLDIR MoorDyn_GetWaves ( MoorDyn system )

Get the wave kinematics instance.

The wave kinematics instance is only useful if WaveKin option is set to 2 in the input file.

Parameters

system The Moordyn system

Returns: The waves instance, NULL if errors happened

◆ MoorDyn_GetWavesKin()

int DECLDIR MoorDyn_GetWavesKin	(	MoorDynWaves	waves,
		double	x,
		double	y,
		double	z,
		double	U[3],
		double	Ud[3],
		double *	zeta,
		double *	PDyn,
		MoorDynSeafloor	seafloor
	)

Get the velocity, acceleration, wave height and dynamic pressure at a specific position and time.

Parameters

waves	The Waves instance
x	The point x coordinate
y	The point y coordinate
z	The point z coordinate
U	The output velocity
Ud	The output acceleration
zeta	The output wave height
PDyn	The output dynamic pressure
seafloor	The seafloor instance, see MoorDyn_GetSeafloor()

Returns: 0 If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

Here is the call graph for this function:

◆ MoorDyn_Init()

int DECLDIR MoorDyn_Init	(	MoorDyn	system,
		const double *	x,
		const double *	xd
	)

Compute the initial condition of a MoorDyn system.

At the time of creating a new MoorDyn instance, the input file is read and all the objects and structures are created. You must call afterwards MoorDyn_Init() to compute the initial conditions

Parameters

system	The Moordyn system
x	Position vector (6 components per coupled body or cantilevered rod and 3 components per pinned rod or coupled point)
xd	Velocity vector (6 components per coupled body or cantilevered rod and 3 components per pinned rod or coupled point)

Returns: MOORDYN_SUCESS If the mooring system is correctly initialized, an error code otherwise (see Errors reported by MoorDyn)

Note: MoorDyn_NCoupledDOF() can be used to know the number of components required for x and xd

◆ MoorDyn_Init_NoIC()

int DECLDIR MoorDyn_Init_NoIC	(	MoorDyn	system,
		const double *	x,
		const double *	xd
	)

The same than MoorDyn_Init(), but the initial condition is not computed at all.

This is of use when you are loading a state file afterwards with Moordyn_Load()

Parameters

system	The Moordyn system
x	Position vector (6 components per coupled body or cantilevered rod and 3 components per pinned rod or coupled point)
xd	Velocity vector (6 components per coupled body or cantilevered rod and 3 components per pinned rod or coupled point)

Returns: MOORDYN_SUCESS If the mooring system is correctly initialized, an error code otherwise (see Errors reported by MoorDyn)

Note: MoorDyn_NCoupledDOF() can be used to know the number of components required for x and xd

◆ MoorDyn_IsLineConstantEA()

int DECLDIR MoorDyn_IsLineConstantEA	(	MoorDynLine	l,
		int *	b
	)

Get whether the line is governed by a non-linear stiffness or a constant one.

Parameters

l	The Moordyn line
b	1 if the stiffness of the line is constant, 0 if a non-linear stiffness has been set

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

See also: MoorDyn_GetLineConstantEA(); MoorDyn_SetLineConstantEA()

◆ MoorDyn_IsLinePressBend()

int DECLDIR MoorDyn_IsLinePressBend	(	MoorDynLine	l,
		int *	b
	)

Get whether the line pressure bending is considered or not.

Parameters

l	The Moordyn line
b	1 if the pressure bending of the line is enabled, 0 otherwise

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

See also: MoorDyn_SetLinePressBend(); MoorDyn_SetLinePressInt()

◆ MoorDyn_Load()

int DECLDIR MoorDyn_Load	(	MoorDyn	system,
		const char *	filepath
	)

Load the system saved before.

You must still call MoorDyn_Create() and MoorDyn_Init_NoIC() before calling this function

Parameters

system	The Moordyn system
filepath	The path of the MoorDyn saved system

Returns: MOORDYN_SUCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

See also: MoorDyn_Save; MoorDyn_Init_NoIC

◆ MoorDyn_LoadState()

int DECLDIR MoorDyn_LoadState	(	MoorDyn	system,
		const char *	filepath
	)

Load and set a system state.

The system state contains the system position and velocity.

Parameters

system	The Moordyn system
filepath	The path of the MoorDyn saved system

Returns: MOORDYN_SUCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

See also: MoorDyn_SaveState; MoorDyn_Init_NoIC

Note: This function can be used to load the state exported by MoorPy

◆ MoorDyn_Log()

int DECLDIR MoorDyn_Log	(	MoorDyn	system,
		int	level,
		const char *	msg
	)

Log a message.

Parameters

system	The Moordyn system
level	The message level. It can take the following values MOORDYN_DBG_LEVEL for debugging messages MOORDYN_MSG_LEVEL for regular information messages MOORDYN_WRN_LEVEL for warnings MOORDYN_ERR_LEVEL for errors
msg	The message to log

Returns: MOORDYN_SUCESS If the printing level is correctly set, an error code otherwise (see Errors reported by MoorDyn)

Note: This messages are subjected to the same rules than the inner messages, i.e. if level is lower than the threshold levels set with MoorDyn_SetVerbosity() and MoorDyn_SetLogLevel(), the message will not be logged in the terminal and the log file respectively; This function will not log the file, line and function where it is called from, not even in case of warnings or errors

◆ MoorDyn_NCoupledDOF()

int DECLDIR MoorDyn_NCoupledDOF	(	MoorDyn	system,
		unsigned int *	n
	)

Get the number of coupled Degrees Of Freedom (DOFs)

The number of components for some parameters in MoorDyn_Init() and MoorDyn_Step() can be known using this function

Returns: MOORDYN_INVALID_VALUE if system is NULL, MOORDYN_SUCESS otherwise

◆ MoorDyn_Save()

int DECLDIR MoorDyn_Save	(	MoorDyn	system,
		const char *	filepath
	)

Save the system so it can be loaded afterwards.

At the time of loading the system, it is still required to create the system reading the same definition file and calling MoorDyn_Init_NoIC()

Parameters

system	The Moordyn system
filepath	The path of the file to write

Returns: MOORDYN_SUCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

See also: MoorDyn_Load; MoorDyn_Init_NoIC

◆ MoorDyn_SaveBodyVTK()

int DECLDIR MoorDyn_SaveBodyVTK	(	MoorDynBody	b,
		const char *	filename
	)

Save the point to a VTK (.vtu) file.

Parameters

b	The Moordyn body
filename	The output maximum tension module

Returns: MOORDYN_SUCCESS if the file is correctly written, an error code otherwise

Note: If MoorDyn has been built without VTK support, this function will return a MOORDYN_NON_IMPLEMENTED error, but it will be still available anyway

◆ MoorDyn_SaveLineVTK()

int DECLDIR MoorDyn_SaveLineVTK	(	MoorDynLine	l,
		const char *	filename
	)

Save the line to a VTK (.vtu) file.

Parameters

l	The Moordyn line
filename	The output maximum tension module

Returns: MOORDYN_SUCCESS if the file is correctly written, an error code otherwise

Note: If MoorDyn has been built without VTK support, this function will return a MOORDYN_NON_IMPLEMENTED error, but it will be still available anyway

◆ MoorDyn_SavePointVTK()

int DECLDIR MoorDyn_SavePointVTK	(	MoorDynPoint	point,
		const char *	filename
	)

Save the point to a VTK (.vtu) file.

Parameters

point	The Moordyn point
filename	The output maximum tension module

Returns: MOORDYN_SUCCESS if the file is correctly written, an error code otherwise

Note: If MoorDyn has been built without VTK support, this function will return a MOORDYN_NON_IMPLEMENTED error, but it will be still available anyway

◆ MoorDyn_SaveRodVTK()

int DECLDIR MoorDyn_SaveRodVTK	(	MoorDynRod	l,
		const char *	filename
	)

Save the line to a VTK (.vtu) file.

Parameters

l	The Moordyn rod
filename	The output maximum tension module

Returns: MOORDYN_SUCCESS if the file is correctly written, an error code otherwise

Note: If MoorDyn has been built without VTK support, this function will return a MOORDYN_NON_IMPLEMENTED error, but it will be still available anyway

◆ MoorDyn_SaveState()

int DECLDIR MoorDyn_SaveState	(	MoorDyn	system,
		const char *	filepath
	)

Save the system state, so it can be loaded afterwards.

The system state contains the system position and velocity.

Parameters

system	The Moordyn system
filepath	The path of the file to write

Returns: MOORDYN_SUCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

See also: MoorDyn_LoadState; MoorDyn_Init_NoIC

Note: This function can be used to load the state exported by MoorPy

◆ MoorDyn_SaveVTK()

int DECLDIR MoorDyn_SaveVTK	(	MoorDyn	system,
		const char *	filename
	)

Save the whole system to a VTK (.vtm) file.

In general it is more convenient to handle each object independently, using MoorDyn_SaveLineVTK() and MoorDyn_SaveRodVTK() functions. However, if the number of subinstances is large, that would not be an option anymore. In that case you can use this function to pack everything together in a single file

Parameters

system	The Moordyn system
filename	The output maximum tension module

Returns: MOORDYN_SUCCESS if the file is correctly written, an error code otherwise

Note: If MoorDyn has been built without VTK support, this function will return a MOORDYN_NON_IMPLEMENTED error, but it will be still available anyway

◆ MoorDyn_Serialize()

int DECLDIR MoorDyn_Serialize	(	MoorDyn	system,
		size_t *	size,
		uint64_t *	data
	)

Serialize the system to bytes.

Typically you want to call this function twice. A first call to know the amount of memory to be allocated for the bytes array and a second one to actually get the bytes array

The returned bytes can be used afterwards to restore the model calling to MoorDyn_Deserialize()

Parameters

system	The Moordyn system
size	Output size of the bytes array. It can be null
data	Allocated memory for the output bytes array. It can be null

Returns: MOORDYN_SUCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_SetCFL()

int DECLDIR MoorDyn_SetCFL	(	MoorDyn	system,
		double	cfl
	)

Set the model Courant–Friedrichs–Lewy factor.

Parameters

system	The Moordyn system
cfl	The new Courant–Friedrichs–Lewy factor

Returns: MOORDYN_SUCESS if the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_SetDt()

int DECLDIR MoorDyn_SetDt	(	MoorDyn	system,
		double	dt
	)

Set the model time step.

Parameters

system	The Moordyn system
dt	The new time step

Returns: MOORDYN_SUCESS if the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_SetLineConstantEA()

int DECLDIR MoorDyn_SetLineConstantEA	(	MoorDynLine	l,
		double	EA
	)

Set the constant stiffness of the line.

This value is useless if non-linear stiffness is considered

Parameters

l	The Moordyn line
EA	The constant axial stiffness EA value [N]

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

See also: MoorDyn_IsLineConstantEA(); MoorDyn_GetLineConstantEA()

◆ MoorDyn_SetLinePressBend()

int DECLDIR MoorDyn_SetLinePressBend	(	MoorDynLine	l,
		int	b
	)

Set whether the line pressure bending is considered or not.

Parameters

l	The Moordyn line
b	1 if the pressure bending of the line shall be considered, 0 otherwise

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

See also: MoorDyn_IsLinePressBend(); MoorDyn_SetLinePressInt()

◆ MoorDyn_SetLinePressInt()

int DECLDIR MoorDyn_SetLinePressInt	(	MoorDynLine	l,
		const double *	p
	)

Set the line internal pressure values at the nodes.

Parameters

l	The Moordyn line
p	Pressure values, and array with MoorDyn_GetLineN() + 1 values

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

See also: MoorDyn_IsLinePressBend(); MoorDyn_SetLinePressBend()

◆ MoorDyn_SetLineUnstretchedLength()

int DECLDIR MoorDyn_SetLineUnstretchedLength	(	MoorDynLine	l,
		double	ul
	)

Set the line unstretched length.

Parameters

l	The Moordyn line
ul	The new length

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

See also: MoorDyn_GetLineUnstretchedLength()

◆ MoorDyn_SetLineUnstretchedLengthVel()

int DECLDIR MoorDyn_SetLineUnstretchedLengthVel	(	MoorDynLine	l,
		double	v
	)

Set the line unstretched length rate of change.

Parameters

l	The Moordyn line
v	The rate of change

Returns: MOORDYN_INVALID_VALUE if a NULL line is provided, MOORDYN_SUCCESS otherwise

See also: MoorDyn_GetLineUnstretchedLength(); MoorDyn_SetLineUnstretchedLength()

◆ MoorDyn_SetLogFile()

int DECLDIR MoorDyn_SetLogFile	(	MoorDyn	system,
		const char *	log_path
	)

Set the instance log file.

Parameters

system	The Moordyn system
log_path	The file path to print the log file

Returns: MOORDYN_SUCESS If the log file is correctly set, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_SetLogLevel()

int DECLDIR MoorDyn_SetLogLevel	(	MoorDyn	system,
		int	verbosity
	)

Set the instance log file printing level.

Parameters

system	The Moordyn system
verbosity	The log file print level. It can take the following values MOORDYN_DBG_LEVEL Every single message will be printed MOORDYN_MSG_LEVEL Messages specially designed to help debugging the code will be omitted MOORDYN_WRN_LEVEL Just errors and warnings will be reported MOORDYN_ERR_LEVEL Just errors will be reported MOORDYN_NO_OUTPUT No info will be reported

Returns: MOORDYN_SUCESS If the printing level is correctly set, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_SetTimeScheme()

int DECLDIR MoorDyn_SetTimeScheme	(	MoorDyn	system,
		const char *	name
	)

Set the time scheme by its name.

Parameters

system	The Moordyn system
name	The new time scheme name.

Returns: MOORDYN_SUCESS if the data is correctly got, an error code otherwise (see Errors reported by MoorDyn)

Here is the call graph for this function:

◆ MoorDyn_SetVerbosity()

int DECLDIR MoorDyn_SetVerbosity	(	MoorDyn	system,
		int	verbosity
	)

Set the instance verbosity level.

Parameters

system	The Moordyn system
verbosity	The verbosity level. It can take the following values MOORDYN_DBG_LEVEL Every single message will be printed MOORDYN_MSG_LEVEL Messages specially designed to help debugging the code will be omitted MOORDYN_WRN_LEVEL Just errors and warnings will be reported MOORDYN_ERR_LEVEL Just errors will be reported MOORDYN_NO_OUTPUT No info will be reported

Returns: MOORDYN_SUCESS If the verbosity level is correctly set, an error code otherwise (see Errors reported by MoorDyn)

◆ MoorDyn_SetWaveKin()

int DECLDIR DEPRECATED MoorDyn_SetWaveKin	(	MoorDyn	system,
		const double *	U,
		const double *	Ud,
		double	t
	)

inline

Set the kinematics of the waves.

Use this function if WaveKin option is set to 1 in the input file

Parameters

system	The Moordyn system
U	The velocities at the points (3 components per point)
Ud	The accelerations at the points (3 components per point)
t	Simulation time

Returns: MOORDYN_SUCESS If the data is correctly set, an error code otherwise (see Errors reported by MoorDyn)

Deprecated:: This function has been renamed as MoorDyn_ExternalWaveKinSet()

See also: MoorDyn_ExternalWaveKinInit(); MoorDyn_ExternalWaveKinGetCoordinates()

Here is the call graph for this function:

◆ MoorDyn_Step()

int DECLDIR MoorDyn_Step	(	MoorDyn	system,
		const double *	x,
		const double *	xd,
		double *	f,
		double *	t,
		double *	dt
	)

Runs a time step of the MoorDyn system.

Parameters

system	The Moordyn system
x	Position vector
xd	Velocity vector
f	Output forces
t	Simulation time
dt	Time step

Returns: MOORDYN_SUCESS if the mooring system has correctly evolved, an error code otherwise (see Errors reported by MoorDyn)

Note: MoorDyn_NCoupledDOF() can be used to know the number of components required for x, xd and f

Here is the caller graph for this function:

◆ WaveNumber()

double DECLDIR WaveNumber	(	double	Omega,
		double	g,
		double	h
	)

Compute the wave number.

Parameters

Omega	The wave angular frequency
g	The gravity acceleration
h	The water depth

Returns: The wave number

Note: credit: FAST source

Typedefs

Functions

External Wave Kinematics

Detailed Description

Function Documentation

◆ MoorDyn_Close()

◆ MoorDyn_Create()

◆ MoorDyn_Deserialize()

◆ MoorDyn_ExternalWaveKinGetCoordinates()

◆ MoorDyn_ExternalWaveKinGetN()

◆ MoorDyn_ExternalWaveKinInit()

◆ MoorDyn_ExternalWaveKinSet()

◆ MoorDyn_GetBody()

◆ MoorDyn_GetBodyAngle()

◆ MoorDyn_GetBodyAngVel()

◆ MoorDyn_GetBodyForce()

◆ MoorDyn_GetBodyID()

◆ MoorDyn_GetBodyM()

◆ MoorDyn_GetBodyPos()

◆ MoorDyn_GetBodyState()

◆ MoorDyn_GetBodyType()

◆ MoorDyn_GetBodyVel()

◆ MoorDyn_GetCFL()

◆ MoorDyn_GetDt()

◆ MoorDyn_GetFASTtens()

◆ MoorDyn_GetLine()

◆ MoorDyn_GetLineConstantEA()

◆ MoorDyn_GetLineFairTen()

◆ MoorDyn_GetLineID()

◆ MoorDyn_GetLineMaxTen()

◆ MoorDyn_GetLineN()

◆ MoorDyn_GetLineNodeBendStiff()

◆ MoorDyn_GetLineNodeCurv()

◆ MoorDyn_GetLineNodeDrag()

◆ MoorDyn_GetLineNodeForce()

◆ MoorDyn_GetLineNodeFroudeKrilov()

◆ MoorDyn_GetLineNodeM()

◆ MoorDyn_GetLineNodePos()

◆ MoorDyn_GetLineNodeSeabedForce()

◆ MoorDyn_GetLineNodeTen()

◆ MoorDyn_GetLineNodeVel()

◆ MoorDyn_GetLineNodeWeight()

◆ MoorDyn_GetLineNumberNodes()

◆ MoorDyn_GetLineUnstretchedLength()

◆ MoorDyn_GetNumberBodies()

◆ MoorDyn_GetNumberLines()

◆ MoorDyn_GetNumberPoints()

◆ MoorDyn_GetNumberRods()

◆ MoorDyn_GetPoint()

◆ MoorDyn_GetPointAttached()

◆ MoorDyn_GetPointForce()

◆ MoorDyn_GetPointID()

◆ MoorDyn_GetPointM()

◆ MoorDyn_GetPointNAttached()

◆ MoorDyn_GetPointPos()

◆ MoorDyn_GetPointType()

◆ MoorDyn_GetPointVel()

◆ MoorDyn_GetRod()

◆ MoorDyn_GetRodForce()

◆ MoorDyn_GetRodID()

◆ MoorDyn_GetRodM()

◆ MoorDyn_GetRodN()

◆ MoorDyn_GetRodNodePos()

◆ MoorDyn_GetRodNodeVel()

◆ MoorDyn_GetRodNumberNodes()

◆ MoorDyn_GetRodType()

◆ MoorDyn_GetSeafloor()

◆ MoorDyn_GetTimeScheme()

◆ MoorDyn_GetWaveKinCoordinates()

◆ MoorDyn_GetWaves()

◆ MoorDyn_GetWavesKin()

◆ MoorDyn_Init()

◆ MoorDyn_Init_NoIC()

◆ MoorDyn_IsLineConstantEA()

◆ MoorDyn_IsLinePressBend()

◆ MoorDyn_Load()

◆ MoorDyn_LoadState()

◆ MoorDyn_Log()

◆ MoorDyn_NCoupledDOF()

◆ MoorDyn_Save()