Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Updated docs for OpenFAST/openfast#2597 #286

Merged
merged 1 commit into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/inputs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,31 @@ to run the .mdl file are available in the OpenFAST GitHub repo under `glue-codes
to show how to pass in values. A .dll OpenFAST shared library file and .mex OpenFAST S function file need to be in
the same directory the controller is being run from.

External Loads (MoorDyn-F only)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This section (optional) allows users to specify external forces (constant) and translational linear and quadratic
damping coefficients to MoorDyn point, rod, and body objects.

.. code-block:: none

---------------------- EXTERNAL LOADS --------------------------------
ID Object Fext Blin Bquad CSys
(#) (name) (N) (Ns/m) (Ns^2/m^2) (-)
1 Body1 0.0|0.0|0.0 0.0|0.0|0.0 0.0|0.0|0.0 G
2 Body1 0.0|0.0|0.0 0.0|0.0|0.0 0.0|0.0|0.0 L
3 Point1 0.0|0.0|0.0 0.0|0.0|0.0 0.0|0.0|0.0 -
4 Rod1 0.0|0.0|0.0 0.0|0.0 0.0|0.0 -

For bodies, the force and damping are applied at the
body reference point in the global earth-fixed coordinate system if CSys is G for global or in the local body-fixed
coordinate system if CSys is L for local. CSys can only be G or L for bodies. For points, the force and damping are
applied at the point location in the global earth-fixed coordinate system always. CSys should be -. Otherwise, a
warning message with explanation will be shown. For rods, the force is applied at the rod end A in the earth-fixed
coordinate system always. Only two linear and two quadratic damping coefficients can be specified for rods. The first
one is for the transverse direction, and the second one is for the axial/tangential direction. The damping force is
always evaluated in the body-fixed system. CSys should be -. Otherwise, a warning message with explanation will be shown.

Options
^^^^^^^

Expand Down
7 changes: 6 additions & 1 deletion docs/references.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Version 1
The v1 lumped-mass formulation of MoorDyn as well as its validation against experiments:

`M. Hall and A. Goupee, “Validation of a lumped-mass mooring line model with DeepCwind semisubmersible model test data,”
Ocean Engineering, vol. 104, pp. 590–603, Aug. 2015.' <http://www.sciencedirect.com/science/article/pii/S0029801815002279>`_
Ocean Engineering, vol. 104, pp. 590–603, Aug. 2015. <http://www.sciencedirect.com/science/article/pii/S0029801815002279>`_

Coupling with WEC-Sim or any Simulink code for wave energy converter simulation:

Expand Down Expand Up @@ -102,6 +102,11 @@ Viscoelastic approach for non-linear rope behavior:
`Hall, Matthew, Brian Duong, and Ericka Lozon, “Streamlined Loads Analysis of Floating Wind Turbines With Fiber Rope Mooring Lines.” In ASME 2023
5th International Offshore Wind Technical Conference, V001T01A029. Exeter, UK: American Society of Mechanical Engineers, 2023. <https://doi.org/10.1115/IOWTC2023-119524>`_

Updated MoorDyn-OpenFOAM Coupling:
`Haifei Chen, Tanausú Almeida Medina, and Jose Luis Cercos-Pita, "CFD simulation of multiple moored floating structures using OpenFOAM: An open-access mooring restraints
library." Ocean Engineering, vol. 303, Jul. 2024. <https://doi.org/10.1016/j.oceaneng.2024.117697>`_`


The Fortran version of MoorDyn is available as a module inside of OpenFAST:

https://openfast.readthedocs.io/en/main/
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ lines. The highest axial vibration mode of the lumped-mass cable representation
be when adjacent nodes oscillate out of phase with each other, as depicted below.

In this mode, the midpoint of each segment would not move. The motion of each node can
then be characterized by mass-spring-damper values of
then be characterized by mass-spring-damper values of (where *w* is mass per length):

.. math::

Expand Down
Loading