Changeset 25688 for issm/trunk-jpl/src/m/classes/lovenumbers.py

Timestamp:

10/19/20 13:31:26 (4 years ago)

Author:

jdquinn

Message:

CHG: MATLAB -> Python translations in support of tests 2005 and 2006 (still have errors to work out here); clean up; various minor improvements

Location:

issm/trunk-jpl/src

Files:

• . (modified) (1 prop)
• m/classes/lovenumbers.py (modified) (6 diffs)

issm/trunk-jpl/src/m/classes/lovenumbers.py

@@ -9 +9 @@
 
 class lovenumbers(object): #{{{
-    '''
-    LOVENUMBERS numbers class definition
+    """LOVENUMBERS class definition
 
-        Usage:
-            lovenumbers = lovenumbers() #will setup love numbers deg 1001 by default
-            lovenumbers = lovenumbers('maxdeg', 10001);  #supply numbers of degrees required (here, 10001)
-    '''
+    Usage:
+        lovenumbers = lovenumbers() #will setup love numbers deg 1001 by default
+        lovenumbers = lovenumbers('maxdeg', 10001);  #supply numbers of degrees required (here, 10001)
+    """
 
     def __init__(self, *args): #{{{
-        #regular love numbers:
-        self.h = []  #provided by PREM model
-        self.k = []  #idem
-        self.l = []  #idem
+        # Regular love numbers
+        self.h = []  # Provided by PREM model
+        self.k = []  # idem
+        self.l = []  # idem
 
-        #tidal love numbers for computing rotational feedback:
+        # Tidal love numbers for computing rotational feedback
         self.th = []
         self.tk = []
         self.tl = []
-        self.tk2secular = 0 #deg 2 secular number.
+        self.tk2secular = 0 # deg 2 secular number
 
         options = pairoptions(*args)
@@ -36 +35 @@
 
     def setdefaultparameters(self, maxdeg, referenceframe): #{{{
-        #initialize love numbers:
+        # Initialize love numbers
         self.h = getlovenumbers('type', 'loadingverticaldisplacement', 'referenceframe', referenceframe, 'maxdeg', maxdeg)
         self.k = getlovenumbers('type', 'loadinggravitationalpotential', 'referenceframe', referenceframe, 'maxdeg', maxdeg)
@@ -44 +43 @@
         self.tl = getlovenumbers('type', 'tidalhorizontaldisplacement', 'referenceframe', referenceframe, 'maxdeg', maxdeg)
 
-        #secular fluid love number:
+        # Secular fluid love number
         self.tk2secular = 0.942
+        return self
     #}}}
 
     def checkconsistency(self, md, solution, analyses): #{{{
-        if ('SealevelriseAnalysis' not in analyses) or (solution == 'TransientSolution' and md.transient.isslr == 0):
+        if ('SealevelriseAnalysis' not in analyses) or (solution == 'TransientSolution' and not md.transient.isslr):
             return
-
         md = checkfield(md, 'fieldname', 'solidearth.lovenumbers.h', 'NaN', 1, 'Inf', 1)
         md = checkfield(md, 'fieldname', 'solidearth.lovenumbers.k', 'NaN', 1, 'Inf', 1)
@@ -59 +58 @@
         md = checkfield(md, 'fieldname', 'solidearth.lovenumbers.tk', 'NaN', 1, 'Inf', 1)
         md = checkfield(md, 'fieldname', 'solidearth.lovenumbers.tk2secular', 'NaN', 1, 'Inf', 1)
-
-        #check that love numbers are provided at the same level of accuracy:
+        # Check that love numbers are provided at the same level of accuracy
         if (self.h.shape[0] != self.k.shape[0]) or (self.h.shape[0] != self.l.shape[0]):
             raise ValueError('lovenumbers error message: love numbers should be provided at the same level of accuracy')
+        return md
     #}}}
 
@@ -70 +69 @@
 
     def __repr__(self): #{{{
-        s = '   lovenumbers parameters:'
-
+        s = '   lovenumbers parameters:\n'
         s += '{}\n'.format(fielddisplay(self, 'h', 'load Love number for radial displacement'))
         s += '{}\n'.format(fielddisplay(self, 'k', 'load Love number for gravitational potential perturbation'))
@@ -78 +76 @@
         s += '{}\n'.format(fielddisplay(self, 'tk', 'tidal load Love number (deg 2)'))
         s += '{}\n'.format(fielddisplay(self, 'tk2secular', 'secular fluid Love number'))
-
         return s
     #}}}