Changeset 25836 for issm/trunk/src/m/classes/toolkits.py

Timestamp:

12/08/20 08:45:53 (4 years ago)

Author:

Mathieu Morlighem

Message:

merged trunk-jpl and trunk for revision 25834

Location:

issm/trunk

Files:

• . (modified) (1 prop)
• src (modified) (1 prop)
• src/m/classes/toolkits.py (modified) (5 diffs)

issm/trunk/src/m/classes/toolkits.py

@@ -8 +8 @@
 
 class toolkits(object):
-    """
+    '''
     TOOLKITS class definition
 
-       Usage:
-          self = toolkits()
-    """
+        Usage:
+            self = toolkits()
+    '''
 
-    def __init__(self):  # {{{
+    def __init__(self): #{{{
         #default toolkits
         if IssmConfig('_HAVE_PETSC_')[0]:
@@ -34 +34 @@
         self.RecoveryAnalysis = self.DefaultAnalysis
 
-    #The other properties are dynamic
-    # }}}
+        #The other properties are dynamic
+    #}}}
 
-    def __repr__(self):  # {{{
+    def __repr__(self): #{{{
         s = "List of toolkits options per analysis:\n\n"
         for analysis in list(vars(self).keys()):
-            s += "%s\n" % fielddisplay(self, analysis, '')
+            s += "{}\n".format(fielddisplay(self, analysis, ''))
 
-            return s
-    # }}}
+        return s
+    #}}}
 
-    def addoptions(self, analysis, *args):  # {{{
+    def addoptions(self, analysis, *args): #{{{
         # Usage example:
         #    md.toolkits = addoptions(md.toolkits, 'StressbalanceAnalysis', FSoptions())
@@ -59 +59 @@
 
         return self
-    # }}}
+    #}}}
 
-    def checkconsistency(self, md, solution, analyses):  # {{{
+    def checkconsistency(self, md, solution, analyses): #{{{
+        # TODO
+        # - Implement something closer to a switch as in 
+        # src/m/classes/toolkits.m?
+        #
         for analysis in list(vars(self).keys()):
             if not getattr(self, analysis):
-                md.checkmessage("md.toolkits.%s is empty" % analysis)
+                md.checkmessage("md.toolkits.{} is empty".format(analysis))
 
         return md
-    # }}}
+    #}}}
 
-    def ToolkitsFile(self, filename):  # {{{
-        """
+    def ToolkitsFile(self, filename): #{{{
+        '''
         TOOLKITSFILE - build toolkits file
 
-           Build a Petsc compatible options file, from the toolkits model field + return options string
-           This file will also be used when the toolkit used is 'issm' instead of 'petsc'
+            Build a Petsc compatible options file, from the toolkits model 
+            field + return options string.
+            This file will also be used when the toolkit used is 'issm' instead 
+            of 'petsc'.s
 
+            Usage:
+                ToolkitsFile(toolkits, filename)
+        '''
 
-           Usage:     ToolkitsFile(toolkits, filename)
-        """
-
-    #open file for writing
+        #open file for writing
         try:
             fid = open(filename, 'w')
@@ -86 +92 @@
             raise IOError("ToolkitsFile error: could not open {}' for writing due to".format(filename), e)
 
-    #write header
+        #write header
         fid.write("%s%s%s\n" % ('%Toolkits options file: ', filename, ' written from Python toolkits array'))
 
-    #start writing options
+        #start writing options
         for analysis in list(vars(self).keys()):
             options = getattr(self, analysis)
 
-    #first write analysis:
+            #first write analysis:
             fid.write("\n+{}\n".format(analysis))  #append a + to recognize it's an analysis enum
-    #now, write options
+            #now, write options
             for optionname, optionvalue in list(options.items()):
 
@@ -111 +117 @@
 
         fid.close()
-    # }}}
+    #}}}