Changeset 2619

Timestamp:

Mar 28, 2006, 1:08:47 PM (19 years ago)

Author:

ole

Message:

Cleaned up island example

Location:

inundation

Files:

• examples/bedslope.py (modified) (1 diff)
• examples/island.py (modified) (5 diffs)
• pyvolution/island.py (deleted)

inundation/examples/bedslope.py

@@ -7 +7 @@
 ######################
 # Module imports 
-#
 from pyvolution.mesh_factory import rectangular
 from pyvolution.shallow_water import Domain, Reflective_boundary,\

inundation/examples/island.py

@@ -1 +1 @@
 """Example of shallow water wave equation.
 
-Island surrounded by water
+Island surrounded by water.
+This example investigates onshore 'creep' 
 
 """
 
-######################
-# Module imports
-#
-from os import sep, path
-from mesh_factory import rectangular
-from shallow_water import Domain, Reflective_boundary, Dirichlet_boundary,\
-     Constant_height
-from Numeric import array
-from utilities.polygon import Polygon_function, read_polygon
+
+#-------------------------------------------------------------------------------
+# Import necessary modules
+#-------------------------------------------------------------------------------
+
+# Standard modules
 from math import exp
 
+# Application specific imports
+from pyvolution.mesh_factory import rectangular
+from pyvolution.shallow_water import Domain, Reflective_boundary
+from utilities.polygon import Polygon_function, read_polygon
+
+
+#-------------------------------------------------------------------------------   
+# Setup computational domain
+#-------------------------------------------------------------------------------
 
 #Create basic mesh
@@ -23 +30 @@
 #Create shallow water domain
 domain = Domain(points, vertices, boundary)
-domain.store = True
 domain.smooth = False
-domain.visualise = False
 domain.set_name('island')
-print 'Output being written to ' + domain.get_datadir() + sep + \
-              domain.get_name() + '.' + domain.format
-
-
-domain.default_order=2
+domain.set_default_order(2)
 
 
@@ -44 +45 @@
 
 
-#Initial conditions
+#-------------------------------------------------------------------------------
+# Setup initial conditions
+#-------------------------------------------------------------------------------
 
 def island(x, y):
@@ -57 +60 @@
 
 
+#-------------------------------------------------------------------------------
+# Setup boundary conditions (all reflective)
+#-------------------------------------------------------------------------------
 
-######################
-# Boundary conditions
 Br = Reflective_boundary(domain)
 
@@ -66 +70 @@
 
 
-######################
-#Evolution
+#-------------------------------------------------------------------------------
+# Evolve system through time
+#-------------------------------------------------------------------------------
+
 import time
 for t in domain.evolve(yieldstep = 1, finaltime = 100):