FF: update example file

Author: rthedin

openfast_toolbox/fastfarm/FASTFarmCaseCreation.py

@@ -620,7 +620,7 @@ def copyTurbineFilesForEachCase(self, writeFiles=True):
                 Vhub_ = self.allCond.sel(cond=cond)['vhub'].values
 
                 # Update parameters to be changed in the SeaState files
-                if self.hasSS
+                if self.hasSS:
                     self.SeaStateFile['WaveHs']     = self.bins.sel(wspd=Vhub_, method='nearest').WaveHs.values
                     self.SeaStateFile['WaveTp']     = self.bins.sel(wspd=Vhub_, method='nearest').WaveTp.values
                     self.SeaStateFile['WvHiCOffD']  = 2.0*np.pi/self.SeaStateFile['WaveTp']
@@ -780,14 +780,14 @@ def copyTurbineFilesForEachCase(self, writeFiles=True):
                     else:
                         self.turbineFile['CompSeaState'] = 0
 
-                   if self.hasMD:
-                       if self.multi_MD:
-                           self.turbineFile['CompMooring'] = 3  # {0=None; 1=MAP++; 2=FEAMooring; 3=MoorDyn; 4=OrcaFlex}
-                           self.turbineFile['MooringFile']  = f'"{self.MDfilename}{t+1}_mod.dat'
-                       else:
-                           # Should be in .fstf and not in .fst (updated later when ff file is written).
-                           pass
-                   else:
+                    if self.hasMD:
+                        if self.multi_MD:
+                            self.turbineFile['CompMooring'] = 3  # {0=None; 1=MAP++; 2=FEAMooring; 3=MoorDyn; 4=OrcaFlex}
+                            self.turbineFile['MooringFile']  = f'"{self.MDfilename}{t+1}_mod.dat'
+                        else:
+                            # Should be in .fstf and not in .fst (updated later when ff file is written).
+                            pass
+                    else:
                        self.turbineFile['CompMooring'] = 0
                        self.turbineFile['MooringFile']  = f'"unused"' 
 
@@ -867,7 +867,7 @@ def _were_all_turbine_files_copied(self):
                 if self.hasHD and not self.multi_HD:
                     _ = checkIfExists(os.path.join(currPath, self.HDfilename))
                     if not _: return False
-                elif self.hasHD and self.multi_HD::
+                elif self.hasHD and self.multi_HD:
                     for t in range(self.nTurbines):
                         _ = checkIfExists(os.path.join(currPath,f'{self.HDfilename}{t+1}_mod.dat'))
                         if not _: return False

openfast_toolbox/fastfarm/examples/Ex3_FFarmCompleteSetup.py

@@ -28,6 +28,10 @@ def main():
     Cmeander = 1.9    # Meandering constant (-)
 
     # ----------- Wind farm
+    # The wts dictionary holds information of each wind turbine. The allowed entries
+    # are: x, y, z, D, zhub, cmax, fmax, Cmeander, and phi_deg. The phi_deg is the
+    # only entry that is optional and is related to floating platform heading angle,
+    # given in degrees. The angle phi_deg is not illustrated on the example below.
     D = 240
     zhub = 150
     wts  = {
@@ -92,7 +96,9 @@ def main():
     templateFiles = {
         "EDfilename"              : 'ElastoDyn.T',
         'SEDfilename'             : None,  #'SimplifiedElastoDyn.T',
-        'HDfilename'              : 'HydroDyn.dat',
+        'HDfilename'              : None,  # 'HydroDyn.dat', # ending with .T for per-turbine HD, .dat for holisitc
+        'MDfilename'              : None,  # 'MoorDyn.T',    # ending with .T for per-turbine MD, .dat for holistic
+        'SSfilename'              : None,  # 'SeaState.dat',
         'SrvDfilename'            : 'ServoDyn.T',
         'ADfilename'              : 'AeroDyn.dat',
         'ADskfilename'            : 'AeroDisk.dat',
@@ -105,6 +111,7 @@ def main():
         'libdisconfilepath'       : '/full/path/to/controller/libdiscon.so',
         'controllerInputfilename' : 'DISCON.IN',
         'coeffTablefilename'      : 'CpCtCq.csv',
+        'hydroDatapath'           : None,  # '/full/path/to/hydroData',
         'FFfilename'              : 'Model_FFarm.fstf',
 
         # TurbSim setups