dovis does not need the n argument

Author: Michael Zingale

advection/advectiveFluxes.py

@@ -38,6 +38,8 @@ def unsplitFluxes(my_data, rp, dt, scalar_name):
     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
     dt : float
         The timestep we are advancing through.
     scalar_name : str

advection/simulation.py

@@ -9,6 +9,19 @@
 class Simulation:
 
     def __init__(self, problem_name, rp, timers=None):
+        """
+        Initialize the Simulation object for linear advection.
+
+        Parameters
+        ----------
+        problem_name : str
+            The name of the problem we wish to run.  This should
+            correspond to one of the modules in advection/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
@@ -73,7 +86,7 @@ def initialize(self):
 
     def timestep(self):
         """
-        Computes the advective timestep (CFL) constraint.  We use the 
+        Compute the advective timestep (CFL) constraint.  We use the 
         driver.cfl parameter to control what fraction of the CFL
         step we actually take.
         """
@@ -93,21 +106,21 @@ def timestep(self):
 
 
     def preevolve(self):
-    
-        # do nothing
+        """
+        Do any necessary evolution before the main evolve loop.  This
+        is not needed for advection
+        """
         pass
 
 
     def evolve(self, dt):
         """ 
         Evolve the linear advection equation through one timestep.  We only
-        consider the "density" variable in the CellCenterData2d object input
-        here.
+        consider the "density" variable in the CellCenterData2d object that
+        is part of the Simulation.
 
         Parameters
         ----------
-        self.cc_data : CellCenterData2d object
-            The data object containing the scalar quantity we are advecting
         dt : float
             The timestep to evolve through
         
@@ -137,8 +150,10 @@ def evolve(self, dt):
                    dtdy*(flux_y[0:qx-1,0:qy-1] - flux_y[0:qx-1,1:qy])  
 
 
-    def dovis(self, n):
-
+    def dovis(self):
+        """
+        Do runtime visualization. 
+        """
         pylab.clf()
 
         dens = self.cc_data.get_var("density")

diffusion/simulation.py

@@ -159,7 +159,7 @@ def evolve(self, dt):
         phi[:,:] = mg.get_solution()
 
 
-    def dovis(self, n):
+    def dovis(self):
 
         pylab.clf()
 

incompressible/simulation.py

@@ -471,7 +471,7 @@ def evolve(self, dt):
         self.cc_data.fill_BC("y-velocity")
 
 
-    def dovis(self, n):
+    def dovis(self):
 
         pylab.clf()
 

plot.py

@@ -18,7 +18,7 @@ def makeplot(myd, solverName, outfile):
 
     pylab.figure(num=1, figsize=(8,4.5), dpi=100, facecolor='w')
 
-    sim.dovis(0)
+    sim.dovis()
     pylab.savefig(outfile)
     pylab.show()
 

pyro.py

@@ -180,7 +180,7 @@
 dovis = rp.get_param("vis.dovis")
 if dovis: 
     pylab.figure(num=1, figsize=(8,6), dpi=100, facecolor='w')
-    sim.dovis(0)
+    sim.dovis()
 
 nout = 0
 
@@ -239,7 +239,7 @@
         tm_vis = tc.timer("vis")
         tm_vis.begin()
 
-        sim.dovis(n)
+        sim.dovis()
         store = rp.get_param("vis.store_images")
 
         if store == 1: