Changeset 26744 for issm/trunk/src/m/classes/constants.py

Timestamp:

12/22/21 10:39:44 (3 years ago)

Author:

Mathieu Morlighem

Message:

merged trunk-jpl and trunk for revision 26742

Location:

issm/trunk

Files:

• . (modified) (1 prop)
• src (modified) (1 prop)
• src/m/classes/constants.py (modified) (2 diffs)

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

@@ +1 @@
+from checkfield import checkfield
 from fielddisplay import fielddisplay
-from checkfield import checkfield
 from WriteData import WriteData
 
 
 class constants(object):
-    """
-    CONSTANTS class definition
+    """CONSTANTS class definition
 
        Usage:
@@ -13 +12 @@
 
     def __init__(self):  # {{{
-        self.g = 0.
-        self.omega = 0.
-        self.yts = 0.
-        self.referencetemperature = 0.
+        self.g                      = 0.
+        self.omega                  = 0.
+        self.yts                    = 0.
+        self.referencetemperature   = 0.
+        self.gravitational_constant = 0.;
 
-    #set defaults
+        #set defaults
         self.setdefaultparameters()
-
     #}}}
     def __repr__(self):  # {{{
-        string = "   constants parameters:"
-
-        string = "%s\n%s" % (string, fielddisplay(self, "g", "gravitational acceleration [m / s^2]"))
-        string = "%s\n%s" % (string, fielddisplay(self, "omega", "angular velocity of Earth [rad / s]"))
-        string = "%s\n%s" % (string, fielddisplay(self, "yts", "number of seconds in a year [s / yr]"))
-        string = "%s\n%s" % (string, fielddisplay(self, "referencetemperature", "reference temperature used in the enthalpy model [K]"))
-
-        return string
+        s = '   constants parameters:\n'
+        s += '{}\n'.format(fielddisplay(self, 'g', 'gravitational acceleration [m/s^2]'))
+        s += '{}\n'.format(fielddisplay(self, 'omega', 'angular velocity of Earth [rad/s]'))
+        s += '{}\n'.format(fielddisplay(self, 'yts', 'number of seconds in a year [s/yr]'))
+        s += '{}\n'.format(fielddisplay(self, 'referencetemperature', 'reference temperature used in the enthalpy model [K]'))
+        s += '{}\n'.format(fielddisplay(self, 'gravitational_constant', 'Newtonian constant of gravitation [m^3/kg/s^2]'))
+        return s
     #}}}
-
     def setdefaultparameters(self):  # {{{
-        #acceleration due to gravity (m / s^2)
+        # Acceleration due to gravity (m / s^2)
         self.g = 9.81
 
-        #Earth's rotation speed
+        # Earth's rotation speed
         self.omega = 7.292 * 1e-5
 
-        #converstion from year to seconds
-        self.yts = 365. * 24. * 3600.
+        # Converstion from year to seconds
+        self.yts = 365.0 * 24.0 * 3600.0
 
-        #the reference temperature for enthalpy model (cf Aschwanden)
+        # The reference temperature for enthalpy model (cf Aschwanden)
         self.referencetemperature = 223.15
+
+        # Gravitational constant:
+        self.gravitational_constant = 6.67259e-11
 
         return self
     #}}}
-
     def checkconsistency(self, md, solution, analyses):  # {{{
-        md = checkfield(md, 'fieldname', 'constants.g', '>=', 0, 'size', [1])
+        md = checkfield(md, 'fieldname', 'constants.g', '>=', 0, 'size', [1]) # We allow 0 for validation tests
         md = checkfield(md, 'fieldname', 'constants.omega', '>=', 0, 'size', [1])
         md = checkfield(md, 'fieldname', 'constants.yts', '>', 0, 'size', [1])
         md = checkfield(md, 'fieldname', 'constants.referencetemperature', 'size', [1])
+        md = checkfield(md, 'fieldname', 'constants.gravitational_constant','size',[1]);
 
         return md
     # }}}
-
     def marshall(self, prefix, md, fid):  # {{{
         WriteData(fid, prefix, 'object', self, 'fieldname', 'g', 'format', 'Double')
         WriteData(fid, prefix, 'object', self, 'fieldname', 'yts', 'format', 'Double')
         WriteData(fid, prefix, 'object', self, 'fieldname', 'referencetemperature', 'format', 'Double')
+        WriteData(fid, prefix, 'object', self, 'fieldname', 'gravitational_constant', 'format', 'Double');
     # }}}