docstrings

Author: Michael Zingale

compressible/BC.py

@@ -9,8 +9,29 @@
 import eos
 from util import msg
 
-def user(bcName, bcEdge, variable, my_data):
-
+def user(bc_name, bc_edge, variable, my_data):
+    """
+    A hydrostatic boundary.  This integrates the equation of HSE into
+    the ghost cells to get the pressure and density under the assumption
+    that the specific internal energy is constant.
+
+    Upon exit, the ghost cells for the input variable will be set
+
+    Parameters
+    ----------
+    bc_name : {'hse'}
+        The descriptive name for the boundary condition -- this allows
+        for pyro to have multiple types of user-supplied boundary 
+        conditions.  For this module, it needs to be 'hse'.
+    bc_edge : {'ylb', 'yrb'}
+        The boundary to update: ylb = lower y boundary; yrb = upper y
+        boundary.
+    variable : {'density', 'x-momentum', 'y-momentum', 'energy'}
+        The variable whose ghost cells we are filling
+    my_data : CellCenterData2d object
+        The data object
+
+    """
     dens = my_data.get_var("density")
     xmom = my_data.get_var("x-momentum")
     ymom = my_data.get_var("y-momentum")
@@ -21,9 +42,9 @@ def user(bcName, bcEdge, variable, my_data):
 
     myg = my_data.grid
 
-    if (bcName == "hse"):
+    if (bc_name == "hse"):
 
-        if (bcEdge == "ylb"):
+        if (bc_edge == "ylb"):
 
             # lower y boundary
 
@@ -73,7 +94,7 @@ def user(bcName, bcEdge, variable, my_data):
                 msg.fail("error: variable not defined")
 
 
-        elif (bcEdge == "yrb"):
+        elif (bc_edge == "yrb"):
 
             # upper y boundary
 
@@ -128,4 +149,4 @@ def user(bcName, bcEdge, variable, my_data):
 
 
     else:
-        msg.fail("error: bc type %s not supported" % (bcName) )
+        msg.fail("error: bc type %s not supported" % (bc_name) )

compressible/eos.py

@@ -1,23 +1,73 @@
 """
-This is a gamma-law equation of state.  
+This is a gamma-law equation of state: p = rho e (gamma - 1), where
+gamma is the constant ratio of specific heats.
 """
 
 def pres(gamma, dens, eint):
-    """ given the density and the specific internal energy, return the
-        pressure """
+    """ 
+    Given the density and the specific internal energy, return the
+    pressure 
+
+    Parameters
+    ----------
+    gamma : float
+        The ratio of specific heats
+    dens : float
+        The density
+    eint : float
+        The specific internal energy
+
+    Returns
+    -------
+    out : float
+       The pressure
+
+     """
     p = dens*eint*(gamma - 1.0)
     return p
 
 
 def dens(gamma, pres, eint):
-    """ given the pressure and the specific internal energy, return
-        the density """
+    """ 
+    Given the pressure and the specific internal energy, return
+    the density 
+
+    Parameters
+    ----------
+    gamma : float
+        The ratio of specific heats
+    pres : float
+        The pressure
+    eint : float
+        The specific internal energy
+
+    Returns
+    -------
+    out : float
+       The density
+
+    """
     dens = pres/(eint*(gamma - 1.0))
     return dens
 
 
 def rhoe(gamma, pres):
-    """ given the pressure, return (rho * e) """
+    """ 
+    Given the pressure, return (rho * e) 
+
+    Parameters
+    ----------
+    gamma : float
+        The ratio of specific heats
+    pres : float
+        The pressure
+ 
+    Returns
+    -------
+    out : float
+       The internal energy density, rho e
+
+    """
     rhoe = pres/(gamma - 1.0)
     return rhoe
 

compressible/unsplitFluxes.py

@@ -138,7 +138,29 @@ def unsplitFluxes(my_data, rp, vars, tc, dt):
                                                                                
     currently we assume a gamma-law EOS 
 
-    grav is the gravitational acceleration in the y-direction            
+    The runtime parameter grav is assumed to be the gravitational 
+    acceleration in the y-direction            
+
+    Parameters
+    ----------
+    my_data : CellCenterData2d object
+        The data object containing the grid and advective scalar that
+        we are advecting.
+    rp : RuntimeParameters object
+        The runtime parameters for the simulation                              
+    vars : Variables object
+        The Variables object that tells us which indices refer to which
+        variables
+    tc : TimerCollection object
+        The timers we are using to profile
+    dt : float
+        The timestep we are advancing through. 
+
+    Returns
+    -------
+    out : ndarray, ndarray 
+        The fluxes on the x- and y-interfaces
+
     """
 
     tm_flux = tc.timer("unsplitFluxes")