Add configureAdjuster helpers func, update project.addMooring

-- added helpers.configureAdjuster to configure a given mooring adjuster function for the specific mooring line
	- this will add the necessary adjuster properties to the mooring object
-- altered project.addMooring to unpack an optional adjuster_settings dictionary which can contain the adjuster settings
	- This information is then sent to the helpers.configureAdjuster for the mooring line to save the settings as properties

Author: lsirkis

famodel/helpers.py

@@ -833,6 +833,66 @@ def getAnchors(lineAnch, arrayAnchor, proj):
 
     return(ad, mass)
 
+def configureAdjuster(mooring, adjuster=None, method='horizontal',
+                      i_line=0, span=None, project=None, target=None):
+    '''Configures adjuster function for mooring object
+    
+    mooring : FAModel Mooring object
+    adjuster : function, optional
+        Function to adjust the mooring object
+    method : str
+        'horizontal' or 'pretension' ; method of adjusting the mooring
+    i_line : int
+        Line section number (0 is closest to end A) to adjust the length of 
+    span : float
+        Horizontal distance from fairlead to anchor (or fairlead to fairlead for shared lines)
+    project : FAModel project class 
+        Project class this mooring object is associated with. Required if adjuster function provided and 
+        target is not provided, or method=pretension
+    target : target value(s) for method - either pretension value or horizontal force value in x and y
+    
+    '''
+    #calculate target pretension or horizontal tension if none provided
+    if adjuster != None and target == None:
+        targetdd = deepcopy(mooring.dd)
+        if project == None:
+            raise Exception('Project class instance needs to be provided to determine target')
+        targetdd['zAnchor'] = project.depth
+        mooring.createSubsystem()
+        
+        if method == 'horizontal':
+            mooring.target = np.linalg.norm(mooring.ss.fB_L[:2])
+        elif method =='pretension':
+            mooring.target = np.linalg.norm(mooring.ss.fB_L)
+        else:
+            raise Exception('Invalid adjustment method. Must be pretension or horizontal')
+    else:
+        mooring.target = target
+    
+    if adjuster!= None:
+        mooring.adjuster = adjuster 
+        mooring.i_line = i_line 
+        
+        # check if method is 'pretension' then save slope
+        if method == 'pretension':
+            
+            if project == None:
+                raise Exception('Project class instance needs to be provided to determine slope')
+            
+            if mooring.dd:
+                
+                #calculate mooring slope using base depth
+                #**** this assumes that the mooring system is designed for the base depth*****
+                mooring.slope = project.depth / mooring.dd['span']
+                
+            else:   
+                if span:
+                    mooring.slope = project.depth / span
+                else:
+                    raise Exception('Span required to perform adjustment')
+                    
+    return(mooring)
+
 def adjustMooring(mooring, method = 'horizontal', r=[0,0,0], project=None, target=1e6,
                        i_line = 0, slope = 0.58 ):
     '''Custom function to adjust a mooring, called by
@@ -857,7 +917,7 @@ def adjustMooring(mooring, method = 'horizontal', r=[0,0,0], project=None, targe
         depth over span for baseline case (to match same geometric angle for 'pretension' option)
     
         '''
-    from fadesign.fadsolvers import dsolve2
+    from moorpy.helpers import dsolve2
     ss = mooring.ss  # shorthand for the mooring's subsystem
 
     if method == 'pretension':

famodel/project.py

@@ -34,7 +34,7 @@
 # Import select required helper functions
 from famodel.helpers import (check_headings, head_adjust, getCableDD, getDynamicCables, 
                             getMoorings, getAnchors, getFromDict, cleanDataTypes, 
-                            getStaticCables, getCableDesign,m2nm, loadYAML)
+                            getStaticCables, getCableDesign,m2nm, loadYAML, configureAdjuster)
 
 
 class Project():
@@ -1486,9 +1486,10 @@ def addPlatform(self,r=[0,0,0], id=None, phi=0, entity='',
 
     def addMooring(self, id=None, endA=None, endB=None, heading=0, dd={}, 
                    section_types=[], section_lengths=[], 
-                   connectors=[], span=0, shared=0, reposition=False, adjuster=None,
-                   method = 'horizontal', target = None, i_line = 0, subsystem=None):
-
+                   connectors=[], span=0, shared=0, reposition=False, subsystem=None, 
+                   **adjuster_settings):
+        # adjuster=None,
+        # method = 'horizontal', target = None, i_line = 0,
         '''
         Function to create a mooring object  and save in mooringList
         Optionally does the following:
@@ -1567,21 +1568,6 @@ def addMooring(self, id=None, endA=None, endB=None, heading=0, dd={},
                   'z_fair':self.platformList[id_part[0]].zFair if id_part else 0}
 
         mooring = Mooring(dd=dd, id=id, subsystem=subsystem) # create mooring object
-        
-        #calculate target pretension or horizontal tension if none provided
-        if adjuster != None and target == None:
-            targetdd = deepcopy(mooring.dd)
-            targetdd['zAnchor'] = self.depth
-            mooring.createSubsystem()
-            
-            if method == 'horizontal':
-                mooring.target = np.linalg.norm(mooring.ss.fB_L[:2])
-            elif method =='pretension':
-                mooring.target = np.linalg.norm(mooring.ss.fB_L)
-            else:
-                raise Exception('Invalid adjustment method. Must be pretension or horizontal')
-        else:
-            mooring.target = target
 
         # update shared prop if needed
         if len(id_part)==2 and shared<1:
@@ -1611,26 +1597,18 @@ def addMooring(self, id=None, endA=None, endB=None, heading=0, dd={},
             mooring.heading = np.degrees(heading)
 
         #add mooring adjuster if porivded
-        if adjuster!= None:
-            mooring.adjuster = adjuster 
-            mooring.i_line = i_line 
-            
-            # check if method is 'pretension' then save slope
-            if method == 'pretension':
-                
-                if dd:
-                    
-                    #calculate mooring slope using base depth
-                    #**** this assumes that the mooring system is designed for the base depth*****
-                    mooring.slope = self.depth / dd['span']
-                    
-                else:   
-                    
-                    mooring.slope = self.depth / span
+        adjuster = adjuster_settings.get('adjuster',None)
+        method = adjuster_settings.get('method', None)
+        i_line = adjuster_settings.get('i_line', None)
+        target = adjuster_settings.get('target', None)
+        mooring = configureAdjuster(mooring, adjuster=adjuster, method=method,
+                                    i_line=i_line, target=target, span=span, 
+                                    project=self)
 
         self.mooringList[id] = mooring
 
         return(mooring)
+    
 
 
     def addAnchor(self, id=None, dd=None, design=None, cost=0, atype=None, platform=None,