Skip to content

Docs Update for the New Rectangular Members in HydroDyn and SubDyn #2850

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.

Sign up for GitHub

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

Merged
andrew-platt merged 7 commits into from
Jun 16, 2025
Merged

Docs Update for the New Rectangular Members in HydroDyn and SubDyn #2850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c9ec085
Docs: update HydroDyn input documentation for the new rectangular mem…
luwang00 Jun 6, 2025
70b5d30
Docs: Slightly edited the HydroDyn input file documentation
luwang00 Jun 6, 2025
57d6bfb
Docs: Update HydroDyn example input file
luwang00 Jun 7, 2025
5281849
Update SubDyn input file documentation with the new member types
luwang00 Jun 7, 2025
f423408
Update api_change.rst for the new rectangular members in HD and SD
luwang00 Jun 8, 2025
964d8cf
Update the example SubDyn input file OC4_Jacket_SD_Input.dat for the …
luwang00 Jun 8, 2025
8c03aa4
Update appendixD.rst
luwang00 Jun 8, 2025
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
57 changes: 49 additions & 8 deletions docs/source/user/api_change.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,56 @@ OpenFAST v4.0.3 to OpenFAST v4.1.0
----------------------------------
Supercontroller module has been removed from FAST.Farm.

============================================= ==== =============== ========================================================================================================================================================================================================
============================================= ==== ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================
Removed in OpenFAST `v4.1.0`
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Module Line Flag Name Example Value
============================================= ==== =============== ========================================================================================================================================================================================================
FAST.Farm 7 UseSC False UseSC - Use a super controller? (flag)
FAST.Farm 11 na --- SUPER CONTROLLER --- [used only for UseSC=True]
FAST.Farm 12 SC_FileName "SC_DLL.dll" SC_FileName Name/location of the dynamic library {.dll [Windows] or .so [Linux]} containing the Super Controller algorithms (quoted string)
============================================= ==== =============== ========================================================================================================================================================================================================
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Module Line Flag Name Example Value
============================================= ==== ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================
FAST.Farm 7 UseSC False UseSC - Use a super controller? (flag)
FAST.Farm 11 na --- SUPER CONTROLLER --- [used only for UseSC=True]
FAST.Farm 12 SC_FileName "SC_DLL.dll" SC_FileName Name/location of the dynamic library {.dll [Windows] or .so [Linux]} containing the Super Controller algorithms (quoted string)
============================================= ==== ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================

Line numbers are not provided in the table below because the line numbers can change depending on the number of entries in the input files. Please refer to the User Documentation on the input files for examples.

============================================= ========= ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================
Added/Modified in OpenFAST `v4.1.0`
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Module Change Flag Name Example Value
============================================= ========= ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================
HydroDyn Modified na ---------------- CYLINDRICAL MEMBER CROSS-SECTION PROPERTIES -------------------
HydroDyn Modified NPropSetsCyl 1 NPropSetsCyl - Number of cylindrical member property sets (-)
HydroDyn Added na ---------------- RECTANGULAR MEMBER CROSS-SECTION PROPERTIES -------------------
HydroDyn Added NPropSetsRec 1 NPropSetsRec - Number of rectangular member property sets (-)
HydroDyn Added na PropSetID PropA PropB PropThck
HydroDyn Added na (-) (m) (m) (m)
HydroDyn Modified na -------- SIMPLE CYLINDRICAL-MEMBER HYDRODYNAMIC COEFFICIENTS (model 1) ---------
HydroDyn Added na -------- SIMPLE RECTANGULAR-MEMBER HYDRODYNAMIC COEFFICIENTS (model 1) ---------
HydroDyn Added na SimplCdA SimplCdAMG SimplCdB SimplCdBMG SimplCaA SimplCaAMG SimplCaB SimplCaBMG SimplCp SimplCpMG SimplAxCd SimplAxCdMG SimplAxCa SimplAxCaMG SimplAxCp SimplAxCpMG SimplCb SimplCbMG
HydroDyn Added na (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-)
HydroDyn Modified na ------ DEPTH-BASED CYLINDRICAL-MEMBER HYDRODYNAMIC COEFFICIENTS (model 2) -------
HydroDyn Modified NCoefDpthCyl 0 NCoefDpthCyl - Number of depth-dependent cylindrical member coefficients (-)
HydroDyn Added na ------ DEPTH-BASED RECTANGULAR-MEMBER HYDRODYNAMIC COEFFICIENTS (model 2) -------
HydroDyn Added NCoefDpthRec 0 NCoefDpthRec - Number of depth-dependent rectangular member coefficients (-)
HydroDyn Added na Dpth DpthCdA DpthCdAMG DpthCdB DpthCdBMG DpthCaA DpthCaAMG DpthCaB DpthCaBMG DpthCp DpthCpMG DpthAxCd DpthAxCdMG DpthAxCa DpthAxCaMG DpthAxCp DpthAxCpMG DpthCb DpthCbMG
HydroDyn Added na `(m)` (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-)
HydroDyn Modified na ------ MEMBER-BASED CYLINDRICAL-MEMBER HYDRODYNAMIC COEFFICIENTS (model 3) ------
HydroDyn Modified NCoefMembersCyl 0 NCoefMembersCyl - Number of member-based cylindrical member coefficients (-)
HydroDyn Added na ------ MEMBER-BASED RECTANGULAR-MEMBER HYDRODYNAMIC COEFFICIENTS (model 3) ------
HydroDyn Added NCoefMembersRec 0 NCoefMembersRec - Number of member-based rectangular member coefficients (-)
HydroDyn Added na MemberID MemberCdA1 MemberCdA2 MemberCdAMG1 MemberCdAMG2 MemberCdB1 MemberCdB2 MemberCdBMG1 MemberCdBMG2 MemberCaA1 MemberCaA2 MemberCaAMG1 MemberCaAMG2 MemberCaB1 MemberCaB2 MemberCaBMG1 MemberCaBMG2 MemberCp1 MemberCp2 MemberCpMG1 MemberCpMG2 MemberAxCd1 MemberAxCd2 MemberAxCdMG1 MemberAxCdMG2 MemberAxCa1 MemberAxCa2 MemberAxCaMG1 MemberAxCaMG2 MemberAxCp1 MemberAxCp2 MemberAxCpMG1 MemberAxCpMG2 MemberCb1 MemberCb2 MemberCbMG1 MemberCbMG2
HydroDyn Added na (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-)
HydroDyn Modified na MemberID MJointID1 MJointID2 MPropSetID1 MPropSetID2 MSecGeom MSpinOrient MDivSize MCoefMod MHstLMod PropPot [MCoefMod=1: use simple coeff table, 2: use depth-based coeff table, 3: use member-based coeff table] [PropPot/=0 if member is modeled with potential-flow theory]
HydroDyn Modified na (-) (-) (-) (-) (-) (switch) (deg) (m) (switch) (switch) (flag)
SubDyn Modified na MemberID MJointID1 MJointID2 MPropSetID1 MPropSetID2 MType MSpin/COSMID ![MType={1c:beam circ., 1r:beam rect., 2:cable, 3:rigid, 4:beam arb., 5:spring}. COMSID={-1:none}]
SubDyn Modified na (-) (-) (-) (-) (-) (-) (deg/-)
SubDyn Added na ----------------- RECTANGULAR BEAM CROSS-SECTION PROPERTIES ---------------------------
SubDyn Added na 0 NPropSets - Number of structurally unique cross-sections (if 0 the following table is ignored)
SubDyn Added na PropSetID YoungE ShearG MatDens XsecSa XsecSb XsecT
SubDyn Added na (-) (N/m2) (N/m2) (kg/m3) (m) (m) (m)
SubDyn Modified na PropSetID YoungE ShearG MatDens XsecA XsecAsx XsecAsy XsecJxx XsecJyy XsecJ0 XsecJt
SubDyn Modified na (-) (N/m2) (N/m2) (kg/m3) (m2) (m2) (m2) (m4) (m4) (m4) (m4)
============================================= ========= ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================


OpenFAST v4.0.3 to OpenFAST v4.0.4
Expand Down
Loading