Skip to content

Commit f423408

Browse files
luwang00luwang00
authored
Update api_change.rst for the new rectangular members in HD and SD
1 parent 5281849 commit f423408

1 file changed

Lines changed: 49 additions & 8 deletions

File tree

‎docs/source/user/api_change.rst‎

Lines changed: 49 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,56 @@ OpenFAST v4.0.3 to OpenFAST v4.1.0
1313
----------------------------------
1414
Supercontroller module has been removed from FAST.Farm.
1515

16-
============================================= ==== =============== ========================================================================================================================================================================================================
16+
============================================= ==== ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================
1717
Removed in OpenFAST `v4.1.0`
18-
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
19-
Module Line Flag Name Example Value
20-
============================================= ==== =============== ========================================================================================================================================================================================================
21-
FAST.Farm 7 UseSC False UseSC - Use a super controller? (flag)
22-
FAST.Farm 11 na --- SUPER CONTROLLER --- [used only for UseSC=True]
23-
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)
24-
============================================= ==== =============== ========================================================================================================================================================================================================
18+
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
19+
Module Line Flag Name Example Value
20+
============================================= ==== ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================
21+
FAST.Farm 7 UseSC False UseSC - Use a super controller? (flag)
22+
FAST.Farm 11 na --- SUPER CONTROLLER --- [used only for UseSC=True]
23+
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)
24+
============================================= ==== ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================
25+
26+
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.
27+
28+
============================================= ========= ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================
29+
Added/Modified in OpenFAST `v4.1.0`
30+
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
31+
Module Change Flag Name Example Value
32+
============================================= ========= ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================
33+
HydroDyn Modified na ---------------- CYLINDRICAL MEMBER CROSS-SECTION PROPERTIES -------------------
34+
HydroDyn Modified NPropSetsCyl 1 NPropSetsCyl - Number of cylindrical member property sets (-)
35+
HydroDyn Added na ---------------- RECTANGULAR MEMBER CROSS-SECTION PROPERTIES -------------------
36+
HydroDyn Added NPropSetsRec 1 NPropSetsRec - Number of rectangular member property sets (-)
37+
HydroDyn Added na PropSetID PropA PropB PropThck
38+
HydroDyn Added na (-) (m) (m) (m)
39+
HydroDyn Modified na -------- SIMPLE CYLINDRICAL-MEMBER HYDRODYNAMIC COEFFICIENTS (model 1) ---------
40+
HydroDyn Added na -------- SIMPLE RECTANGULAR-MEMBER HYDRODYNAMIC COEFFICIENTS (model 1) ---------
41+
HydroDyn Added na SimplCdA SimplCdAMG SimplCdB SimplCdBMG SimplCaA SimplCaAMG SimplCaB SimplCaBMG SimplCp SimplCpMG SimplAxCd SimplAxCdMG SimplAxCa SimplAxCaMG SimplAxCp SimplAxCpMG SimplCb SimplCbMG
42+
HydroDyn Added na (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-)
43+
HydroDyn Modified na ------ DEPTH-BASED CYLINDRICAL-MEMBER HYDRODYNAMIC COEFFICIENTS (model 2) -------
44+
HydroDyn Modified NCoefDpthCyl 0 NCoefDpthCyl - Number of depth-dependent cylindrical member coefficients (-)
45+
HydroDyn Added na ------ DEPTH-BASED RECTANGULAR-MEMBER HYDRODYNAMIC COEFFICIENTS (model 2) -------
46+
HydroDyn Added NCoefDpthRec 0 NCoefDpthRec - Number of depth-dependent rectangular member coefficients (-)
47+
HydroDyn Added na Dpth DpthCdA DpthCdAMG DpthCdB DpthCdBMG DpthCaA DpthCaAMG DpthCaB DpthCaBMG DpthCp DpthCpMG DpthAxCd DpthAxCdMG DpthAxCa DpthAxCaMG DpthAxCp DpthAxCpMG DpthCb DpthCbMG
48+
HydroDyn Added na `(m)` (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-)
49+
HydroDyn Modified na ------ MEMBER-BASED CYLINDRICAL-MEMBER HYDRODYNAMIC COEFFICIENTS (model 3) ------
50+
HydroDyn Modified NCoefMembersCyl 0 NCoefMembersCyl - Number of member-based cylindrical member coefficients (-)
51+
HydroDyn Added na ------ MEMBER-BASED RECTANGULAR-MEMBER HYDRODYNAMIC COEFFICIENTS (model 3) ------
52+
HydroDyn Added NCoefMembersRec 0 NCoefMembersRec - Number of member-based rectangular member coefficients (-)
53+
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
54+
HydroDyn Added na (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-) (-)
55+
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]
56+
HydroDyn Modified na (-) (-) (-) (-) (-) (switch) (deg) (m) (switch) (switch) (flag)
57+
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}]
58+
SubDyn Modified na (-) (-) (-) (-) (-) (-) (deg/-)
59+
SubDyn Added na ----------------- RECTANGULAR BEAM CROSS-SECTION PROPERTIES ---------------------------
60+
SubDyn Added na 0 NPropSets - Number of structurally unique cross-sections (if 0 the following table is ignored)
61+
SubDyn Added na PropSetID YoungE ShearG MatDens XsecSa XsecSb XsecT
62+
SubDyn Added na (-) (N/m2) (N/m2) (kg/m3) (m) (m) (m)
63+
SubDyn Modified na PropSetID YoungE ShearG MatDens XsecA XsecAsx XsecAsy XsecJxx XsecJyy XsecJ0 XsecJt
64+
SubDyn Modified na (-) (N/m2) (N/m2) (kg/m3) (m2) (m2) (m2) (m4) (m4) (m4) (m4)
65+
============================================= ========= ================== ===============================================================================================================================================================================================================================================================================================================================================================================================================================================================
2566

2667

2768
OpenFAST v4.0.3 to OpenFAST v4.0.4

0 commit comments

Comments
 (0)