Added MoorDyn support to FastFarmCaseCreation

openfast_toolbox/fastfarm/examples/Ex2_FFarmInputSetup.py

@@ -13,7 +13,7 @@
 import matplotlib.pyplot as plt
 import pandas as pd
 # Local packages
-from openfast_toolbox.fastfarm import fastFarmTurbSimExtent, writeFastFarm, plotFastFarmSetup
+from openfast_toolbox.fastfarm.fastfarm import fastFarmTurbSimExtent, writeFastFarm, plotFastFarmSetup
 from openfast_toolbox.io.fast_input_file import FASTInputFile
 
 MyDir=os.path.dirname(__file__)

openfast_toolbox/fastfarm/examples/Ex3_FFarmCompleteSetup.py

@@ -87,28 +87,31 @@ def main():
     # ----------- Template files
     templatePath            = '/full/path/where/template/files/are'
 
-    # Put None on any input that is not applicable to your case
+    # remove from dict or put None on any input that is not applicable to your case
     # Files should be in templatePath
-    EDfilename              = 'ElastoDyn.T'
-    SEDfilename             = 'SimplifiedElastoDyn.T'
-    HDfilename              = 'HydroDyn.dat'
-    SrvDfilename            = 'ServoDyn.T'
-    ADfilename              = 'AeroDyn.dat'
-    ADskfilename            = 'AeroDisk.dat'
-    SubDfilename            = 'SubDyn.dat'
-    IWfilename              = 'InflowWind.dat'
-    BDfilepath              = None
-    bladefilename           = 'Blade.dat'
-    towerfilename           = 'Tower.dat'
-    turbfilename            = 'Model.T'
-    libdisconfilepath       = '/full/path/to/controller/libdiscon.so'
-    controllerInputfilename = 'DISCON.IN'
-    coeffTablefilename      = 'CpCtCq.csv'
-    FFfilename              = 'Model_FFarm.fstf'
-
-    # TurbSim setups
-    turbsimLowfilepath      = './SampleFiles/template_Low_InflowXX_SeedY.inp'
-    turbsimHighfilepath     = './SampleFiles/template_HighT1_InflowXX_SeedY.inp'
+    templateFiles = {
+        "EDfilename"    : 'ElastoDyn.T',
+        'SEDfilename'   : 'SimplifiedElastoDyn.T',
+        'HDfilename'    : 'HydroDyn.dat',
+        'SrvDfilename'  : 'ServoDyn.T',
+        'ADfilename'    : 'AeroDyn.dat',
+        'ADskfilename'  : 'AeroDisk.dat',
+        'SubDfilename'  : 'SubDyn.dat',
+        'IWfilename'    : 'InflowWind.dat',
+        'BDfilepath'    : None,
+        'bladefilename' : 'Blade.dat',
+        'towerfilename' : 'Tower.dat',
+        'turbfilename'  : 'Model.T',
+        'coeffTablefilename'    : 'CpCtCq.csv',
+        'FFfilename'    : 'Model_FFarm.fstf',
+        'controllerInputfilename'   : 'DISCON.IN',
+        'libdisconfilepath' : '/full/path/to/controller/libdiscon.so',
+        # MoorDyn Support
+        'mDynfilename': 'MoorDyn.dat',
+        # TurbSim setups
+        'turbsimLowfilepath'    : './SampleFiles/template_Low_InflowXX_SeedY.inp',
+        'turbsimHighfilepath'   : './SampleFiles/template_HighT1_InflowXX_SeedY.inp'
+    }
 
     # SLURM scripts
     slurm_TS_high           = './SampleFiles/runAllHighBox.sh'
@@ -129,10 +132,7 @@ def main():
                           nSeeds=nSeeds, LESpath=LESpath, refTurb_rot=refTurb_rot,
                           verbose=1)
 
-    case.setTemplateFilename(templatePath, EDfilename, SEDfilename, HDfilename, SrvDfilename, ADfilename,
-                             ADskfilename, SubDfilename, IWfilename, BDfilepath, bladefilename, towerfilename,
-                             turbfilename, libdisconfilepath, controllerInputfilename, coeffTablefilename,
-                             turbsimLowfilepath, turbsimHighfilepath, FFfilename)
+    case.setTemplateFilename(templatePath, templateFiles)
 
     # Get domain paramters
     case.getDomainParameters()

openfast_toolbox/fastfarm/tests/test_moordyn_support.py

@@ -0,0 +1,115 @@
+import os
+import unittest
+from pathlib import Path
+from openfast_toolbox.fastfarm.FASTFarmCaseCreation import FFCaseCreation
+
+class TestMoorDynSupport(unittest.TestCase):
+    def setUp(self):
+        """
+        Setup the testing environment.
+        """
+        # Create a temporary directory for the test
+        self.test_dir = Path('test_moordyn_support')
+        self.test_dir.mkdir(exist_ok=True)
+
+        # Define MoorDyn template
+        self.moordyn_template = self.test_dir / "MoorDyn_template.dat"
+        self.moordyn_template.write_text(
+            """Node    X     Y     Z    M     B
+            0.0   0.0  -20.0  0.0   0.0
+            100.0 0.0  -20.0  0.0   0.0
+            0.0   100.0 -20.0 0.0   0.0
+            """
+        )
+        # Initialize FFCaseCreation with minimal parameters
+        self.case = FFCaseCreation(
+            path=str(self.test_dir),
+            wts={
+                0: {
+                    'x': 0.0,
+                    'y': 0.0,
+                    'z': 0.0,
+                    'D': 240,          # Rotor diameter
+                    'zhub': 150,       # Hub height
+                    'cmax': 5,         # Maximum blade chord (m)
+                    'fmax': 10 / 6,    # Maximum excitation frequency (Hz)
+                    'Cmeander': 1.9    # Meandering constant (-)
+                }
+            },
+            tmax=600,
+            zbot=1.0,
+            vhub=[10.0],
+            shear=[0.2],
+            TIvalue=[10],
+            inflow_deg=[30.0],  # Rotate MoorDyn file by 30 degrees
+            dt_high_les=0.6,
+            ds_high_les=10.0,
+            extent_high=1.2,
+            dt_low_les=3.0,
+            ds_low_les=20.0,
+            extent_low=[3, 8, 3, 3, 2],
+            ffbin="/Users/ombahiwal/Desktop/WS24/Courses_WS24/Simulation Software Engineering/contri/openfast/glue-codes/fast-farm/FAST.Farm",
+            mod_wake=1,
+            yaw_init=None,
+            nSeeds=1,
+            LESpath=None,
+            refTurb_rot=0,
+            verbose=1,
+        )
+
+    # def tearDown(self):
+    #     """
+    #     Cleanup after tests.
+    #     """
+    #     for file in self.test_dir.glob("*"):
+    #         file.unlink()
+    #     self.test_dir.rmdir()
+
+    def test_moordyn_file_copy_and_rotation(self):
+        """
+        Test the copying and rotation of the MoorDyn file.
+        """
+        # TODO: Test moordyn support.
+        """case = self.case
+        # Set the MoorDyn template
+        case.setTemplateFilename(str(self.test_dir), templateFiles={
+            "mDynfilename": self.moordyn_template.name,
+            "EDfilename": ""
+        })
+
+        # Simulate case generation
+        case.copyTurbineFilesForEachCase()
+
+        # Verify MoorDyn file is created
+        output_file = self.test_dir / "case_0_inflow30_Seed0" / "MoorDyn.dat"
+        self.assertTrue(output_file.exists(), "MoorDyn file was not created")
+
+        # Check the MoorDyn file content for rotation
+        with open(output_file, "r") as f_out:
+            rotated_lines = f_out.readlines()
+
+        # Expected rotated values (30 degrees rotation)
+        import numpy as np
+        rotation_matrix = np.array([
+            [np.cos(np.radians(30)), -np.sin(np.radians(30)), 0],
+            [np.sin(np.radians(30)), np.cos(np.radians(30)), 0],
+            [0, 0, 1],
+        ])
+        expected_coordinates = [
+            [0.0, 0.0, -20.0],
+            [100.0, 0.0, -20.0],
+            [0.0, 100.0, -20.0],
+        ]
+        rotated_coordinates = [np.dot(rotation_matrix, np.array(coord)) for coord in expected_coordinates]
+
+        # Validate each node's position
+        for i, expected_coord in enumerate(rotated_coordinates):
+            parts = rotated_lines[i + 1].split()
+            x, y, z = map(float, parts[1:4])
+            self.assertAlmostEqual(x, expected_coord[0], places=4, msg=f"Node {i} X mismatch")
+            self.assertAlmostEqual(y, expected_coord[1], places=4, msg=f"Node {i} Y mismatch")
+            self.assertAlmostEqual(z, expected_coord[2], places=4, msg=f"Node {i} Z mismatch")
+        """
+
+if __name__ == "__main__":
+    unittest.main()

openfast_toolbox/fastfarm/tests/test_moordyn_support/MoorDyn_template.dat

@@ -0,0 +1,5 @@
+Node    X     Y     Z    M     B
+            0.0   0.0  -20.0  0.0   0.0
+            100.0 0.0  -20.0  0.0   0.0
+            0.0   100.0 -20.0 0.0   0.0
+

openfast_toolbox/fastfarm/tests/test_turbsimExtent.py

@@ -2,7 +2,7 @@
 import os
 import numpy as np    
 
-from openfast_toolbox.fastfarm import *
+from openfast_toolbox.fastfarm.fastfarm import *
 
 MyDir=os.path.dirname(__file__)