Mooring adjuster settings now stored in a dict (interim commit)

Mooring:
- Moved all adjuster settings into a dictionary, adjuster_settings,
  rather than a hardcoded set of top-level Mooring attributes since
  the parameters that are used could change or be customized.
- Removed a deepcopy (unlinking) of line type info between dd and ss.

A few small comment/format improvements.

Author: mattEhall

famodel/cables/cable.py

@@ -428,6 +428,3 @@ def updateSpan(self,newSpan):
             for i,bs in enumerate(sub.dd['buoyancy_sections']):
                 bs['L_mid'] = bs['L_mid'] + addL*(i+addS)
 
-
-
-        

famodel/design/LineDesign.py

@@ -1,13 +1,12 @@
 # New version of LineDesign that uses Subsystem
 
-import moorpy as mp # type: ignore
-#import moordesign.MoorSolve as msolve
+from famodel.mooring.mooring import Mooring
 from famodel.design.fadsolvers import dsolve2, dopt2, doptPlot
-from moorpy.MoorProps import getAnchorProps # type: ignore
-from moorpy.helpers import (loadLineProps, getLineProps,  # type: ignore
-                            rotationMatrix, getFromDict) 
+from famodel.helpers import getFromDict
 
-from famodel.mooring.mooring import Mooring
+import moorpy as mp
+from moorpy.MoorProps import getAnchorProps
+from moorpy.helpers import (loadLineProps, getLineProps, rotationMatrix)
 
 import numpy as np
 import matplotlib.pyplot as plt
@@ -114,7 +113,10 @@ def __init__(self, depth, lineProps=None, **kwargs):
             raise Exception("Xindices must be provided.")
 
         # find the largest integer to determine the number of desired design variables
-        self.nX = 1 + max([ix for ix in self.Xindices if isinstance(ix, int)])
+        if any([isinstance(ix, int) for ix in self.Xindices]):
+            self.nX = 1 + max([ix for ix in self.Xindices if isinstance(ix, int)])
+        else:
+            self.nX = 0  # no design variables listed
 
         # check for errors in Xindices
         for i in range(self.nX):
@@ -314,14 +316,14 @@ def __init__(self, depth, lineProps=None, **kwargs):
 
 
         # ----- optimization stuff -----
+        
         # get design variable bounds and last step size
         self.Xmin       = getFromDict(kwargs, 'Xmin'   , shape=self.nX)             # minimum bounds on each design variable
         self.Xmax       = getFromDict(kwargs, 'Xmax'   , shape=self.nX)             # maximum bounds on each design variable
         self.dX_last    = getFromDict(kwargs, 'dX_last', shape=self.nX, default=[]) # 'last' step size for each design variable
         if len(self.Xmin) != self.nX or len(self.Xmax) != self.nX or len(self.dX_last) != self.nX:
             raise Exception("The size of Xmin/Xmax/dX_last does not match the number of design variables")
 
-        
         # initialize the vector of the last design variables, which each iteration will compare against
         self.Xlast = np.zeros(self.nX)
 
@@ -379,6 +381,7 @@ def __init__(self, depth, lineProps=None, **kwargs):
                 con['unit'] = conUnitsDict[con['name']]
             else:
                 raise Exception(f"The constraint name '{con['name']}' is not recognized.")
+        
         # set up list of active constraint functions
         self.conList = []
         self.convals = np.zeros(len(self.constraints))  # array to hold constraint values

famodel/design/layout.py

@@ -881,9 +881,12 @@ def updateLayout(self, X, level=0, refresh=False):
             #print(self.nt, len(self.turb_depth), X)
             #print(self.turb_coords)
 
-            # Update Paltform class
+            # Update each turbine's platform and mooring system
             for i in range(self.nt):
-                self.platformList[i].setPosition(self.turb_coords[i], heading=self.turb_rot[i], degrees=False, project = self)  
+                
+                self.platformList[i].setPosition(self.turb_coords[i], 
+                    heading=self.turb_rot[i], degrees=False, project=self)
+                
                 # switch anchor type
                 anchs = self.platformList[i].getAnchors() 
                 for anch in anchs.values():

famodel/mooring/mooring.py

@@ -395,8 +395,9 @@ def reposition(self, r_center=None, heading=None, project=None,
                 self.i_line = 0
 
 
-            if hasattr(self,'slope'):
-                self.adjuster(self, method = 'pretension', r=r_centerB, project=project, target = self.target, i_line = self.i_line, slope = self.slope)
+            if 'slope'in self.adjuster_settings:
+                self.adjuster_settings.update(dict(method='pretension', r=r_centerB))
+                self.adjuster(self, project)
 
             else:
 
@@ -408,8 +409,9 @@ def reposition(self, r_center=None, heading=None, project=None,
                 else:
                     print('Warning: depth of mooring line, anchor, and subsystem must be updated manually.')
 
-                self.setEndPosition(np.hstack([self.rB[:2] + self.span*u, self.z_anch]), 'a', sink=True)                
-                self.adjuster(self, method = 'horizontal', r=r_centerB, project=project, target = self.target, i_line = self.i_line)
+                self.setEndPosition(np.hstack([self.rB[:2] + self.span*u, self.z_anch]), 'a', sink=True)
+                self.adjuster_settings.update(dict(method='horizontal', r=r_centerB))
+                self.adjuster(self, project)
 
         elif self.shared == 1: # set position of end A at platform end A if no fairlead objects
             if not len(self.subcons_A[0].attachments) > 1:
@@ -484,7 +486,9 @@ def configureAdjuster(self, adjuster=None, method='horizontal',
                           i_line=0, span=None, project=None, target=None):
         '''Configures adjuster function for mooring object
         
-        #MH: >>> moved in from helpers. To be worked on <<<
+        #MH: >>> moved in from helpers. To be worked on. Support passing any dict of settings... <<<
+        
+        The following are now stored in Mooring.adjuster_settings: target, i_line, slope
         
         mooring : FAModel Mooring object
         adjuster : function, optional
@@ -501,6 +505,9 @@ def configureAdjuster(self, adjuster=None, method='horizontal',
         target : target value(s) for method - either pretension value or horizontal force value in x and y
         
         '''
+        
+        asets = self.adjuster_settings  # shorthand for the settings dictionary
+        
         #calculate target pretension or horizontal tension if none provided
         if adjuster != None and target == None:
             targetdd = deepcopy(self.dd)
@@ -512,21 +519,21 @@ def configureAdjuster(self, adjuster=None, method='horizontal',
             self.createSubsystem(dd=targetdd)
 
             if method == 'horizontal':
-                self.target = np.linalg.norm(self.ss.fB_L[:2])
+                asets['target'] = np.linalg.norm(self.ss.fB_L[:2])
             elif method =='pretension':
-                self.target = np.linalg.norm(self.ss.fB_L)
+                asets['target'] = np.linalg.norm(self.ss.fB_L)
             else:
                 raise Exception('Invalid adjustment method. Must be pretension or horizontal')
             # return mooring depth to accurate val
             if not self.shared:
                 depth = project.getDepthAtLocation(self.rA[0], self.rA[1])
                 self.rA[2] = -depth
         else:
-            self.target = target
+            asets['target'] = target
 
         if adjuster!= None:
             self.adjuster = adjuster 
-            self.i_line = i_line 
+            asets['i_line'] = i_line 
 
             # check if method is 'pretension' then save slope
             if method == 'pretension':
@@ -537,11 +544,11 @@ def configureAdjuster(self, adjuster=None, method='horizontal',
 
                     #calculate mooring slope using base depth
                     #**** this assumes that the mooring system is designed for the base depth*****
-                    self.slope = (project.depth+self.rB[2]) / self.dd['span']
+                    asets['slope'] = (project.depth+self.rB[2]) / self.dd['span']
 
                 else:   
                     if span:
-                        self.slope = (project.depth+self.rB[2]) / span
+                        asets['slope'] = (project.depth+self.rB[2]) / span
                     else:
                         raise Exception('Span required to perform adjustment')
 
@@ -714,8 +721,8 @@ def createSubsystem(self, case=0, dd=None, ms=None, ss_number=None):
             # run through each line section and collect the length and type
             for sec in secs:
                 lengths.append(sec['L'])
-                types.append(deepcopy(sec['type'])) # list of type names
-            
+                types.append(sec['type']) #types.append(deepcopy(sec['type'])) # list of type names
+                # <<< is there a reason we were deepcopying (unlinking) this? <<<
 
             # make the lines and set the points 
             ss.makeGeneric(lengths, types, 
@@ -1817,20 +1824,24 @@ def fairleads(self, end):
     #             ind[level] += 1
 
 
-def adjustMooring(mooring, method = 'horizontal', r=[0,0,0], project=None, target=1e6,
-                       i_line = [0], slope = 0.58, display=False ):
-    '''Custom function to adjust a mooring, called by
-    Mooring.adjust. Fairlead point should have already
-    been adjusted.
+def adjustMooring(mooring, project, display=0):
+    '''Default/example function to adjust a mooring after it has been 
+    repositioned. This function would be assigned to Mooring.adjuster,
+    and it is expected that settings for the adjustment process are
+    stored in a Mooring.adjuster_settings dictionary. 
+    Note that the mooring line endpoints should already be in place when
+    this function is called.
+    
+    This example function looks for some of the following types of info:
     
-    There are two methods: "pretension" geometrically adjusts the anchor point and matches pretension, intended for taut moorings.
-    "horizontal" leaves anchor point in the same position and matches the horizontal forces, intended for catenary and semi-taut moorings
+    method = 'horizontal', r=[0,0,0], project=None, target=1e6,
+    i_line = [0], slope = 0.58, display=False 
+    
+    There are two methods: "pretension" geometrically adjusts the anchor 
+    point and matches pretension, intended for taut moorings.
+    "horizontal" leaves anchor point in the same position and matches the 
+    horizontal forces, intended for catenary and semi-taut moorings
     
-    Parameters
-    ----------
-    mooring : FAModel Mooring object
-    r : array
-        platform center location (only used for pretension method)
     project : FAModel Project object this is a part of. 
         This is a required input for the "pretension" option to correctly move the anchor position, not used in the 'horizontal method'
     target_pretension : float
@@ -1839,10 +1850,17 @@ def adjustMooring(mooring, method = 'horizontal', r=[0,0,0], project=None, targe
         List of indexes of line section to adjust
     slope: float
         depth over span for baseline case (to match same geometric angle for 'pretension' option)
+    '''
 
-        '''
     from moorpy.helpers import dsolve2
+    
     ss = mooring.ss  # shorthand for the mooring's subsystem
+    asets = mooring.adjuster_settings  # shorthand for settings dict
+    method = getFromDict(asets, 'method', default='horizontal')
+    r = getFromDict(asets, 'r', default=[0,0,0])
+    target = getFromDict(asets, 'target', default=1e6)  #<<< shouldn't have a default
+    i_line = getFromDict(asets, 'i_line', default=[0])
+    slope = getFromDict(asets, 'slope', default=.58)  #<<< shouldn't have a default
 
     if method == 'pretension':
 

famodel/platform/platform.py

@@ -119,6 +119,7 @@ def setPosition(self, r, heading=None, degrees=False,project=None, update_moorin
                 moor.dd['span'] = np.linalg.norm(moor.rA[:2]-moor.rB[:2])
                 moor.span=moor.dd['span']
 
+    
     def mooringSystem(self,rotateBool=0,mList=None,bodyInfo=None, project=None):
         '''
         Create a MoorPy system for the platform based on the mooring subsystems provided in