Changeset 7804 for trunk/anuga_core/documentation

Timestamp:

Jun 7, 2010, 4:19:31 PM (15 years ago)

Author:

James Hudson

Message:

Fixed up failing tests, updated user guide with new API (first few chapters only).

Location:

trunk/anuga_core/documentation/user_manual

Files:

• anuga_user_manual.tex (modified) (12 diffs)
• version.tex (modified) (1 diff)

trunk/anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -72 +72 @@
                 % will be used.
 
-%\release{1.0}   % release version; this is used to define the
+%\release{1.2}   % release version; this is used to define the
 %                % \version macro
 
@@ -147 +147 @@
 where the more adventurous reader might like to go.
 
-This manual describes \anuga version 1.0. To check for later versions of this manual
+This manual describes \anuga version 1.2. To check for later versions of this manual
 go to \url{https://datamining.anu.edu.au/anuga}.
 
@@ -335 +335 @@
 
 \begin{verbatim}
-points, vertices, boundary = rectangular_cross(10, 10)
+points, vertices, boundary = anuga.rectangular_cross(10, 10)
 \end{verbatim}
 
@@ -345 +345 @@
 
 \begin{verbatim}
-points, vertices, boundary = rectangular_cross(m, n)
+points, vertices, boundary = anuga.rectangular_cross(m, n)
 \end{verbatim}
 
@@ -372 +372 @@
 
 \begin{verbatim}
-domain = Domain(points, vertices, boundary)
+domain = anuga.Domain(points, vertices, boundary)
 \end{verbatim}
 
@@ -499 +499 @@
 
 \begin{verbatim}
-Br = Reflective_boundary(domain)
-Bt = Transmissive_boundary(domain)
-Bd = Dirichlet_boundary([0.2, 0.0, 0.0])
-Bw = Time_boundary(domain=domain,
+Br = anuga.Reflective_boundary(domain)
+Bt = anuga.Transmissive_boundary(domain)
+Bd = anuga.Dirichlet_boundary([0.2, 0.0, 0.0])
+Bw = anuga.Time_boundary(domain=domain,
                    f=lambda t: [(0.1*sin(t*2*pi)-0.3)*exp(-t), 0.0, 0.0])
 \end{verbatim}
@@ -609 +609 @@
 
 \begin{verbatim}
-Bw = Time_boundary(domain=domain, f=lambda t: [(0.1*sin(t*2*pi)-0.3), 0.0, 0.0])
+Bw = anuga.Time_boundary(domain=domain, f=lambda t: [(0.1*sin(t*2*pi)-0.3), 0.0, 0.0])
 \end{verbatim}
 
@@ -726 +726 @@
 
 \begin{verbatim}
-points, vertices, boundary = rectangular_cross(m, n, len1=length, len2=width)
+points, vertices, boundary = anuga.rectangular_cross(m, n, len1=length, len2=width)
 \end{verbatim}
 
@@ -742 +742 @@
 dx = dy = 1           # Resolution: Length of subdivisions on both axes
 
-points, vertices, boundary = rectangular_cross(int(length/dx), int(width/dy),
+points, vertices, boundary = anuga.rectangular_cross(int(length/dx), int(width/dy),
                                                len1=length, len2=width)
 \end{verbatim}
@@ -780 +780 @@
 
 \begin{verbatim}
-Bo = Dirichlet_boundary([-5, 0, 0])    # Outflow
+Bo = anuga.Dirichlet_boundary([-5, 0, 0])    # Outflow
 \end{verbatim}
 
@@ -1024 +1024 @@
 \begin{verbatim}
 remainder_res = 10000000
-domain = create_domain_from_regions(project.bounding_polygon,
+domain = anuga.create_domain_from_regions(project.bounding_polygon,
                                     boundary_tags={'top': [0],
                                                    'ocean_east': [1],
@@ -1145 +1145 @@
 
 \begin{verbatim}
-Bd = Dirichlet_boundary([tide,0,0]) # Mean water level
-Bs = Transmissive_stage_zero_momentum_boundary(domain) # Neutral boundary
+Bd = anuga.Dirichlet_boundary([tide,0,0]) # Mean water level
+Bs = anuga.Transmissive_stage_zero_momentum_boundary(domain) # Neutral boundary
 
 if project.scenario == 'fixed_wave':
     # Huge 50m wave starting after 60 seconds and lasting 1 hour.
-    Bw = Time_boundary(domain=domain,
+    Bw = anuga.Time_boundary(domain=domain,
                        function=lambda t: [(60<t<3660)*50, 0, 0])
     domain.set_boundary({'ocean_east': Bw,

trunk/anuga_core/documentation/user_manual/version.tex

@@ -7 +7 @@
 % release version; this is used to define the
 % \version macro
-\release{1.0beta\_6051}
+\release{1.2beta\_6051}