docstrings

Author: Michael Zingale

advection/simulation.py

@@ -176,5 +176,8 @@ def dovis(self):
 
 
     def finalize(self):
-
+        """
+        Do any final clean-ups for the simulation and call the problem's
+        finalize() method.
+        """
         exec self.problem_name + '.finalize()'        

compressible/simulation.py

@@ -35,6 +35,19 @@ def __init__(self, idens=-1, ixmom=-1, iymom=-1, iener=-1):
 class Simulation:
 
     def __init__(self, problem_name, rp, timers=None):
+        """
+        Initialize the Simulation object for compressible hydrodynamics.
+
+        Parameters
+        ----------
+        problem_name : str
+            The name of the problem we wish to run.  This should
+            correspond to one of the modules in compressible/problems/
+        rp : RuntimeParameters object
+            The runtime parameters for the simulation
+        timers : TimerCollection object, optional
+            The timers used for profiling this simulation
+        """
 
         self.rp = rp
         self.cc_data = None
@@ -52,7 +65,8 @@ def __init__(self, problem_name, rp, timers=None):
 
     def initialize(self):
         """ 
-        initialize the grid and variables for compressible flow
+        Initialize the grid and variables for compressible flow and set
+        the initial conditions for the chosen problem.
         """
 
         # setup the grid
@@ -176,14 +190,17 @@ def timestep(self):
 
 
     def preevolve(self):
-    
-        # do nothing
+        """
+        Do any necessary evolution before the main evolve loop.  This
+        is not needed for compressible flow.
+        """
         pass
 
 
     def evolve(self, dt):
         """
-        Evolve the equations of compressible hydrodynamics through a timestep dt
+        Evolve the equations of compressible hydrodynamics through a 
+        timestep dt.
         """
 
         tm_evolve = self.tc.timer("evolve")
@@ -224,6 +241,9 @@ def evolve(self, dt):
 
 
     def dovis(self):
+        """ 
+        Do runtime visualization.
+        """
 
         pylab.clf()
 
@@ -338,4 +358,8 @@ def dovis(self):
 
 
     def finalize(self):
+        """
+        Do any final clean-ups for the simulation and call the problem's
+        finalize() method.
+        """
         exec self.problem_name + '.finalize()'

diffusion/simulation.py

@@ -9,6 +9,22 @@
 class Simulation:
 
     def __init__(self, problem_name, rp, timers=None):
+        """
+        Initialize the Simulation object for diffusion:
+
+           a  = k a
+            t      xx
+
+        Parameters
+        ----------
+        problem_name : str
+            The name of the problem we wish to run.  This should
+            correspond to one of the modules in diffusion/problems/
+        rp : RuntimeParameters object
+            The runtime parameters for the simulation
+        timers : TimerCollection object, optional
+            The timers used for profiling this simulation
+        """
 
         self.rp = rp
         self.cc_data = None
@@ -23,7 +39,8 @@ def __init__(self, problem_name, rp, timers=None):
 
     def initialize(self):
         """ 
-        initialize the grid and variables for diffusion
+        Initialize the grid and variables for diffusion and set the initial
+        conditions for the chosen problem.
         """
 
         # setup the grid
@@ -97,8 +114,10 @@ def timestep(self):
 
 
     def preevolve(myd):
-    
-        # do nothing
+        """
+        Do any necessary evolution before the main evolve loop.  This
+        is not needed for diffusion.
+        """    
         pass
 
 
@@ -160,6 +179,9 @@ def evolve(self, dt):
 
 
     def dovis(self):
+        """
+        Do runtime visualization. 
+        """
 
         pylab.clf()
 
@@ -184,6 +206,10 @@ def dovis(self):
 
 
     def finalize(self):
+        """
+        Do any final clean-ups for the simulation and call the problem's
+        finalize() method.
+        """
         exec self.problem_name + '.finalize()'
 
 

incompressible/simulation.py

@@ -11,6 +11,19 @@
 class Simulation:
 
     def __init__(self, problem_name, rp, timers=None):
+        """
+        Initialize the Simulation object for incompressible flow.
+
+        Parameters
+        ----------
+        problem_name : str
+            The name of the problem we wish to run.  This should
+            correspond to one of the modules in incompressible/problems/
+        rp : RuntimeParameters object
+            The runtime parameters for the simulation
+        timers : TimerCollection object, optional
+            The timers used for profiling this simulation
+        """
 
         self.rp = rp
         self.cc_data = None
@@ -25,7 +38,8 @@ def __init__(self, problem_name, rp, timers=None):
 
     def initialize(self):
         """ 
-        initialize the grid and variables for incompressible flow
+        Initialize the grid and variables for incompressible flow and
+        set the initial conditions for the chosen problem.
         """
 
         # setup the grid
@@ -214,7 +228,7 @@ def preevolve(self):
 
     def evolve(self, dt):
         """ 
-        Evolve the incompressible equations through one timestep 
+        Evolve the incompressible equations through one timestep. 
         """
 
         u = self.cc_data.get_var("x-velocity")
@@ -472,7 +486,9 @@ def evolve(self, dt):
 
 
     def dovis(self):
-
+        """ 
+        Do runtime visualization
+        """
         pylab.clf()
 
         pylab.rc("font", size=10)
@@ -525,4 +541,8 @@ def dovis(self):
 
 
     def finalize(self):
+        """
+        Do any final clean-ups for the simulation and call the problem's
+        finalize() method.
+        """
         exec self.problem_name + '.finalize()'