From 399031e003ba5f94d3e2c0a948c1faac0af1eaa9 Mon Sep 17 00:00:00 2001 From: andrew-platt Date: Wed, 31 May 2023 15:26:20 -0600 Subject: [PATCH 1/3] Docs: update links in SeaState docs. This documentation isn't complete --- docs/source/user/hydrodyn/input_files.rst | 8 ++++---- docs/source/user/index.rst | 1 + .../figs/current_sub_models.jpg | Bin docs/source/user/seastate/index.rst | 11 +++++++++++ docs/source/user/seastate/input_files.rst | 6 +++--- 5 files changed, 19 insertions(+), 7 deletions(-) rename docs/source/user/{hydrodyn => seastate}/figs/current_sub_models.jpg (100%) create mode 100644 docs/source/user/seastate/index.rst diff --git a/docs/source/user/hydrodyn/input_files.rst b/docs/source/user/hydrodyn/input_files.rst index fd3f27877f..6d4826561e 100644 --- a/docs/source/user/hydrodyn/input_files.rst +++ b/docs/source/user/hydrodyn/input_files.rst @@ -230,17 +230,17 @@ real surface waves, permitting more accurate modeling of sea states and the associated wave loads at the expense of greater computational effort (mostly at HydroDyn initialization). -While the cut-off frequencies in the :ref:`hd-2nd_order_waves_input` section -above apply to both the second-order wave kinematics used by strip +While the cut-off frequencies in the :ref:`sea-2nd_order_waves_input` section +of the SeaState module to apply to both the second-order wave kinematics used by strip theory and the second-order diffraction loads in potential-flow theory, the second-order terms themselves are enabled separately. The second-order wave kinematics used by strip theory are enabled in the -:ref:`hd-2nd_order_waves_input` section above while the second-order +:ref:`sea-2nd_order_waves_input` section while the second-order diffraction loads in potential-flow theory are enabled in this section. While the second-order effects are included when enabled, the wave elevations output from HydroDyn will only include the second-order terms when the second-order wave kinematics are enabled in the -:ref:`hd-2nd_order_waves_input` section above. +:ref:`sea-2nd_order_waves_input` section in the SeaState module documetation. The second-order difference-frequency potential-flow terms can be enabled in one of three ways. To compute only the mean-drift term, set diff --git a/docs/source/user/index.rst b/docs/source/user/index.rst index 65a9a4badc..37ec220855 100644 --- a/docs/source/user/index.rst +++ b/docs/source/user/index.rst @@ -53,6 +53,7 @@ Documentation covers usage of models, underlying theory, and in some cases modul ExtPtfm ElastoDyn HydroDyn + SeaState InflowWind MoorDyn ServoDyn diff --git a/docs/source/user/hydrodyn/figs/current_sub_models.jpg b/docs/source/user/seastate/figs/current_sub_models.jpg similarity index 100% rename from docs/source/user/hydrodyn/figs/current_sub_models.jpg rename to docs/source/user/seastate/figs/current_sub_models.jpg diff --git a/docs/source/user/seastate/index.rst b/docs/source/user/seastate/index.rst new file mode 100644 index 0000000000..098e8789ee --- /dev/null +++ b/docs/source/user/seastate/index.rst @@ -0,0 +1,11 @@ +SeaState User Guide and Theory Manual +===================================== + +.. toctree:: + :maxdepth: 1 + + input_files.rst + +SeaState generates wave field information used by HydroDyn. This module had +once been part of HydroDyn, so see the HydroDyn documentation for information on +the waves and current. diff --git a/docs/source/user/seastate/input_files.rst b/docs/source/user/seastate/input_files.rst index 050acacfcc..b34bda6827 100644 --- a/docs/source/user/seastate/input_files.rst +++ b/docs/source/user/seastate/input_files.rst @@ -57,7 +57,7 @@ first-order waves or the use of externally generated waves, used by both the strip-theory and potential-flow solutions. The wave spectrum settings in this section only pertain to the first-order wave frequency components. When second-order terms are optionally enabled—see the -:ref:`sea-2nd_order_waves_input` and :ref:`sea-2nd_order_floating_platform_forces_input` +:ref:`sea-2nd_order_waves_input` and :ref:`hd-2nd_order_floating_platform_forces_input` sections below—the second-order terms are calculated using the first-order wave-component amplitudes and extra energy is added to the wave spectrum (at the difference and sum frequencies). @@ -276,7 +276,7 @@ diffraction loads in potential-flow theory, the second-order terms themselves are enabled separately. The second-order wave kinematics used by strip theory are enabled in this section while the second-order diffraction loads in potential-flow theory are enabled in the -:ref:`sea-2nd_order_floating_platform_forces_input` section below. While the +:ref:`hd-2nd_order_floating_platform_forces_input` section below. While the second-order effects are included when enabled, the wave elevations output from HydroDyn will only include the second-order terms when the second-order wave kinematics are enabled in this section. @@ -408,7 +408,7 @@ with the string "END" at the beginning of the line or at the beginning of a quoted string found at the beginning of the line will cause HydroDyn to quit scanning for more lines of channel names. Member- and joint-related quantities are generated for the requested -:ref:`sea-member-output-list` and :ref:`sea-joint-output-list`. +:ref:`hd-member-output-list` and :ref:`hd-joint-output-list`. If HydroDyn encounters an unknown/invalid channel name, it warns the users but will remove the suspect channel from the output file. Please refer to Appendix C for a complete list of From 0b6ef93e57b872534b64cae6d187860ec441822b Mon Sep 17 00:00:00 2001 From: andrew-platt Date: Wed, 31 May 2023 15:34:30 -0600 Subject: [PATCH 2/3] Reduce memory footprint of regression tests Tests will need updating. --- .github/actions/tests-module-hydrodyn/action.yml | 2 +- reg_tests/r-test | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/actions/tests-module-hydrodyn/action.yml b/.github/actions/tests-module-hydrodyn/action.yml index a58e130c0f..edf61aeff3 100644 --- a/.github/actions/tests-module-hydrodyn/action.yml +++ b/.github/actions/tests-module-hydrodyn/action.yml @@ -4,6 +4,6 @@ author: 'Rafael Mudafort https://github.com/rafmudaf' runs: using: "composite" steps: - - run: ctest -VV -j1 -R hd_ -LE python + - run: ctest -VV -j6 -R hd_ -LE python working-directory: ${{runner.workspace}}/openfast/build shell: bash diff --git a/reg_tests/r-test b/reg_tests/r-test index 485315de22..0a20920111 160000 --- a/reg_tests/r-test +++ b/reg_tests/r-test @@ -1 +1 @@ -Subproject commit 485315de2207d4b047a5c8f908e995800f7ab6f5 +Subproject commit 0a20920111c22d261dd815e39dd596f0f21a4e8d From 9f8e3d78a1a939a154c886890b0c56b73c11c062 Mon Sep 17 00:00:00 2001 From: andrew-platt Date: Wed, 31 May 2023 22:02:06 -0600 Subject: [PATCH 3/3] Update regression test results --- reg_tests/r-test | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reg_tests/r-test b/reg_tests/r-test index 0a20920111..46105ab128 160000 --- a/reg_tests/r-test +++ b/reg_tests/r-test @@ -1 +1 @@ -Subproject commit 0a20920111c22d261dd815e39dd596f0f21a4e8d +Subproject commit 46105ab128f6dbe8e4c97f61934db89a11075cb3