Changeset 2494

Timestamp:

Mar 8, 2006, 2:26:58 PM (19 years ago)

Author:

ole

Message:

Introduced duration keyword in evolve and updated dependencies

Files:

• development/euler/euler.py (modified) (3 diffs)
• development/euler/test_euler.py (modified) (1 diff)
• inundation/pyvolution/advection.py (modified) (2 diffs)
• inundation/pyvolution/domain.py (modified) (4 diffs)
• inundation/pyvolution/shallow_water.py (modified) (2 diffs)

development/euler/euler.py

@@ -139 +139 @@
 
 
-    def evolve(self, yieldstep = None, finaltime = None,
+    def evolve(self,
+               yieldstep = None,
+               finaltime = None,
+               duration = None,               
                skip_initial_step = False):
+        
         """Specialisation of basic evolve method from parent class
         """
@@ -170 +174 @@
 
         #Call basic machinery from parent class
-        for t in Generic_domain.evolve(self, yieldstep, finaltime,
-                                       skip_initial_step):
+        #for t in Generic_domain.evolve(self, yieldstep, finaltime,
+        #                               skip_initial_step):
+
+        for t in Generic_domain.evolve(self,
+                                       yieldstep=yieldstep,
+                                       finaltime=finaltime,
+                                       duration=duration,
+                                       skip_initial_step=skip_initial_step):            
             #Real time viz
             if self.visualise is True:
@@ -295 +305 @@
     """
 
-    from config import g, epsilon
+    from pyvolution.config import g, epsilon
     from math import sqrt
     from Numeric import array

development/euler/test_euler.py

@@ -4 +4 @@
 from math import sqrt, pi
 
-from config import g, epsilon
+from pyvolution.config import g, epsilon
 from Numeric import allclose, array, zeros, ones, Float, take
 from shallow_water import *

inundation/pyvolution/advection.py

@@ -339 +339 @@
 
 
-    def evolve(self, yieldstep = None, finaltime = None):
+
+    def evolve(self,
+               yieldstep = None,
+               finaltime = None,
+               duration = None,               
+               skip_initial_step = False):
+        
         """Specialisation of basic evolve method from parent class
         """
@@ -354 +360 @@
 
         #Call basic machinery from parent class
-        for t in Generic_domain.evolve(self, yieldstep, finaltime):
+        for t in Generic_domain.evolve(self,
+                                       yieldstep=yieldstep,
+                                       finaltime=finaltime,
+                                       duration=duration,
+                                       skip_initial_step=skip_initial_step):
+            
+
 
 

inundation/pyvolution/domain.py

@@ -487 +487 @@
     #Main components of evolve
 
-    def evolve(self, yieldstep = None, finaltime = None,
+    def evolve(self,
+               yieldstep = None,
+               finaltime = None,
+               duration = None,              
                skip_initial_step = False):
-        """Evolve model from time=0.0 to finaltime yielding results
-        every yieldstep.
-
-        Internally, smaller timesteps may be taken.
+        """Evolve model through time starting from self.starttime.
+        
+       
+        yieldstep: Interval between yields where results are stored,
+                   statistics written and domain inspected or
+                   possibly modified. If omitted the internal predefined
+                   max timestep is used.
+                   Internally, smaller timesteps may be taken.               
+
+        duration: Duration of simulation
+
+        finaltime: Time where simulation should end
+
+        If both duration and finaltime are given an exception is thrown.
+
+
+        skip_initial_step: Boolean flag that decides whether the first
+        yield step is skipped or not. This is useful for example to avoid
+        duplicate steps when multiple evolve processes are dove tailed. 
+
 
         Evolve is implemented as a generator and is to be called as such, e.g.
 
-        for t in domain.evolve(timestep, yieldstep, finaltime):
+        for t in domain.evolve(yieldstep, finaltime):
             <Do something with domain and t>
+
+
+        All times are given in seconds        
 
         """
@@ -506 +528 @@
         msg = 'Boundary tags must be bound to boundary objects before evolving system, '
         msg += 'e.g. using the method set_boundary.\n'
-        msg += 'This system has the boundary tags %s ' %self.get_boundary_tags()
+        msg += 'This system has the boundary tags %s '\
+               %self.get_boundary_tags()
         assert hasattr(self, 'boundary_objects'), msg
 
@@ -519 +542 @@
 
 
+        if finaltime is not None and duration is not None:
+            print 'F', finaltime, duration
+            msg = 'Only one of finaltime and duration may be specified'
+            raise msg
+        else:
+            if finaltime is not None:
+                self.finaltime = float(finaltime)
+            if duration is not None:
+                self.finaltime = self.starttime + float(duration)
+                
+
+        
+
         self.yieldtime = 0.0 #Time between 'yields'
 
@@ -524 +560 @@
         self.min_timestep = max_timestep
         self.max_timestep = min_timestep
-        self.finaltime = finaltime
         self.number_of_steps = 0
         self.number_of_first_order_steps = 0

inundation/pyvolution/shallow_water.py

@@ -213 +213 @@
 
 
-    def evolve(self, yieldstep = None, finaltime = None,
+    def evolve(self,
+               yieldstep = None,
+               finaltime = None,
+               duration = None,               
                skip_initial_step = False):
         """Specialisation of basic evolve method from parent class
@@ -251 +254 @@
 
         #Call basic machinery from parent class
-        for t in Generic_Domain.evolve(self, yieldstep, finaltime,
-                                       skip_initial_step):
+        for t in Generic_Domain.evolve(self,
+                                       yieldstep=yieldstep,
+                                       finaltime=finaltime,
+                                       duration=duration,
+                                       skip_initial_step=skip_initial_step):
             #Real time viz
             if self.visualise is True: