Changeset 2277

Timestamp:

Jan 25, 2006, 12:20:23 PM (18 years ago)

Author:

ole

Message:

Updated program example format

Location:

documentation

Files:

• AnuGA_user_manual.dvi (modified) (previous)
• AnuGA_user_manual.tex (modified) (19 diffs)
• simple_example.dvi (modified) (previous)

documentation/AnuGA_user_manual.tex

@@ +1 @@
+%\newcommand{\code}[1]{{\small \tt #1}} %For use with one-line code snippets
+        
 \documentclass{report}
+
 
 \title{AnuGA User Manual}
@@ -131 +134 @@
 \verb+\\+\emph{s at the ends of lines!]}
 
-\begin{verbatim}
-from pyvolution.mesh_factory import rectangular \\
+{\scriptsize \begin{verbatim}
+from pyvolution.mesh_factory import rectangular
 from pyvolution.shallow_water import Domain, Reflective_boundary,
      Dirichlet_boundary, Time_boundary, Transmissive_boundary
@@ -139 +142 @@
 points, vertices, boundary = rectangular(10,10)
 
-#Create shallow water domain \\
-domain = Domain(points, vertices,boundary) \\
+#Create shallow water domain
+domain = Domain(points, vertices,boundary)
 domain.smooth = False domain.visualise = False
 domain.store = True domain.filename = 'bedslope'
@@ -157 +160 @@
 
 
-# Boundary conditions \\
-from math import sin, pi \\
-Br = Reflective_boundary(domain)\\
-Bt = Transmissive_boundary(domain) \\
-Bd = Dirichlet_boundary([0.2,0.,0.])\\
+# Boundary conditions
+from math import sin, pi
+Br = Reflective_boundary(domain)
+Bt = Transmissive_boundary(domain) 
+Bd = Dirichlet_boundary([0.2,0.,0.])
 
 Bw = Time_boundary(domain=domain,
@@ -167 +170 @@
 
 
-domain.set_boundary({'left': Bd, 'right': Br, 'top': Br, 'bottom':
-Br}) \\
-#domain.set_boundary({'left': Bw, 'right': Br, 'top': Br,
-'bottom': Br})
-
-
-###################### \\
+domain.set_boundary({'left': Bd, 'right': Br, 'top': Br, 'bottom': Br})
+
+
+######################
 #Evolution
 
@@ -182 +182 @@
 
 
-\end{verbatim}
+\end{verbatim}}
 
 
@@ -190 +190 @@
 scenario. This is carried out through the statement:
 
-\begin{verbatim}
+{\small \begin{verbatim}
     points, vertices, boundary = rectangular(10, 10) .
-\end{verbatim}
+\end{verbatim}}
 
 The function \texttt{rectangular} is imported from a module
@@ -201 +201 @@
 specific way. In general, the assignment
 
-\begin{verbatim}
+{\small \begin{verbatim}
     points, vertices, boundary = rectangular(m, n)
-\end{verbatim}
+\end{verbatim}}
 
 returns:
@@ -230 +230 @@
 \texttt{domain}, through the assignment:
 
-\begin{verbatim}
+{\small \begin{verbatim}
     domain = Domain(points, vertices, boundary)
-\end{verbatim}
+\end{verbatim}}
 
 This uses a Python class \texttt{Domain}, imported from
@@ -242 +242 @@
 of what these do]}
 
-\begin{verbatim}
+{\scriptsize \begin{verbatim}
     domain.smooth = False
     domain.visualise = False
@@ -248 +248 @@
     domain.filename = 'bedslope'
     domain.default_order = 2
-\end{verbatim}
+\end{verbatim}}
 
 
@@ -271 +271 @@
 purposes:
 
-\begin{verbatim}
+{\small \begin{verbatim}
     \# Initial conditions
     def f(x,y):
         return -x/2
-\end{verbatim}
+\end{verbatim}}
 
 This simply associates an elevation with each point $(x, y)$ of
@@ -285 +285 @@
 \texttt{elevation} is assigned through the simple statement:
 
+{\small \begin{verbatim}
 \begin{verbatim}
     domain.set_quantity('elevation', f)
-\end{verbatim}
+\end{verbatim}}
 
 
@@ -296 +297 @@
 assign them to a constant numerical value:
 
-\begin{verbatim}
+{\small \begin{verbatim}
     domain.set_quantity('friction', 0.1)
-\end{verbatim}
+\end{verbatim}}
 
 This just specifies that the Manning friction coefficient is set
@@ -309 +310 @@
 quantities:
 
-\begin{verbatim}
+{\small \begin{verbatim}
     h = 0.05 \# Constant depth
     domain.set_quantity('stage', expression = 'elevation + %f' %h)
-\end{verbatim}
+\end{verbatim}}
 
 Here the quantity \texttt{stage} is defined by taking the quantity
@@ -324 +325 @@
 The boundary conditions are specified as follows:
 
-\begin{verbatim}
+{\small \begin{verbatim}
     Br = Reflective_boundary(domain)
 
@@ -333 +334 @@
     Bw = Time_boundary(domain=domain,
                 f=lambda t: [(0.1*sin(t*2*pi)), 0.0, 0.0])
-\end{verbatim}
+\end{verbatim}}
 
 The effect of these statements is to set up four alternative
@@ -359 +360 @@
 form
 
-\begin{verbatim}
-    domain.set_boundary({'left': Bd, 'right': Br, 'top': Br, 'bottom':
-Br})
-\end{verbatim}
+{\small \begin{verbatim}
+    domain.set_boundary({'left': Bd, 'right': Br, 'top': Br, 'bottom': Br})
+\end{verbatim}}
 
 This statement stipulates that, in the current example, the left
@@ -372 +372 @@
 
 The final statement \nopagebreak[3]
-\begin{verbatim}
+{\small \begin{verbatim}
     for t in domain.evolve(yieldstep = 0.1, finaltime = 4.0):
         domain.write_time()
-\end{verbatim}
+\end{verbatim}}
 
 is the key step that causes the configuration of the domain to