Updated docs and changelog with semisub model. Also had to add it as …

…a phase in manager.
WISDEM · Jul 29, 2024 · e5c9300 · e5c9300
1 parent 05adb4a
commit e5c9300
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 1 deletion.
diff --git a/ORBIT/manager.py b/ORBIT/manager.py
@@ -40,6 +40,7 @@
     SemiSubmersibleDesign,
     CustomArraySystemDesign,
     OffshoreSubstationDesign,
+    CustomSemiSubmersibleDesign,
     SemiTautMooringSystemDesign,
     OffshoreFloatingSubstationDesign,
 )
@@ -80,6 +81,7 @@ class ProjectManager:
         MooringSystemDesign,
         SemiTautMooringSystemDesign,
         SemiSubmersibleDesign,
+        CustomSemiSubmersibleDesign,
         SparDesign,
         ElectricalDesign,
     )

diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -5,6 +5,15 @@ ORBIT Changelog
 
 Unreleased (TBD)
 ----------------
+Custom Semi-Submersible Design
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+- The ``CustomSemiSubmersibleDesign`` class was added to semi_submersible_design.py.
+- Based on VolturnUS-S by U-Maine. `https://www.nrel.gov/docs/fy20osti/76773.pdf`
+- All design defaults are set to be consistent with 15MW IEA turbine
+- Scaling logic added based on U-Mass paper. `https://wes.copernicus.org/preprints/wes-2023-18/wes-2023-18.pdf`
+- Added tests to confirm that volumns and masses are calculated appropriately
+- Added Example - Custom Semisubmersible notebook and yaml config file.
+- Updated docs with citations.
 
 Merged SemiTaut Moorings
 ~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/source/phases/design/doc_SemiSubmersibleDesign.rst b/docs/source/phases/design/doc_SemiSubmersibleDesign.rst
@@ -11,8 +11,36 @@ The semi-submersible design module in ORBIT is based on previous modeling
 efforts undertaken by NREL, [#maness2017]_. The technical documentation for
 this tool can be found `here <https://www.nrel.gov/docs/fy17osti/66874.pdf>_`.
 
+Custom Semi-Submersible Design Methodology
+==========================================
+For details of the code implementation, please see
+:doc:`Semi-Submersible Design API <api_SemiSubmersibleDesign>`.
+
+(Custom) Overview
+-----------------
+
+This new addition to ORBIT's semi-submersible design capabilities by letting
+the user specify all the dimensions of the platform. IEAt was designed based on
+the IEA-15MW reference turbine and the VolturnUS-S Reference Platform developed
+by the University of Maine.[#allen2020]_.The triangular base uses three steel
+columns equipped with ballast material. Each column is connected to a
+central-column, where the turbine is afixed, by pontoons and spars.
+Additionally, this new model uses the methodology proposed in [#roach2023]_ to
+scale the platform to other turbine sizes.
+
 References
 ----------
 
 .. [#maness2017] Michael Maness, Benjamin Maples, Aaron Smith,
-    NREL Offshore Balance-of-System Model, 2017
+    NREL Offshore Balance-of-System Model, 2017.
+    `https://www.nrel.gov/docs/fy17osti/66874.pdf`
+
+.. [#allen2020] Christopher Allen, Anthony Viselli, Habib Dagher,
+    Andrew Goupee, Evan Gaertner, Nikhar Abbas, Matthew Hall,
+    and Garrett Barter. Definition of the UMaine VolturnUS-S Reference Platform
+    Developed for the IEA Wind 15-Megawatt Offshore Reference Wind Turbine.
+    `https://www.nrel.gov/docs/fy20osti/76773.pdf`
+
+.. [#roach2023] Kaylie Roach, Matthew Lackner, James Manwell. A New Method for
+    Upscaling Semi-submersible Platforms for Floating Offshore Wind Turbines.
+    `https://wes.copernicus.org/preprints/wes-2023-18/wes-2023-18.pdf`