Changeset 4088

Timestamp:

Dec 18, 2006, 3:00:34 PM (18 years ago)

Author:

sexton

Message:

tex usermanual updates

File:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (12 diffs)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -863 +863 @@
 introduces a second example, \file{runcairns.py}.  This refers to
 a real-life scenario, in which the domain of interest surrounds the
-Cairns region. A
+Cairns region. Two scenarios are given; firstly, a
 hypothetical tsunami wave is generated by a submarine mass failure
-situated on the edge of the continental shelf.
+situated on the edge of the continental shelf, and secondly, a fixed wave
+of given amplitude and period is introduced through the boundary.
 
 \subsection{Overview}
@@ -915 +916 @@
 maximal area of a triangle used for triangulation---and a triangular
 mesh is created inside the polygon using a mesh generation engine.
-On any given platform, the same mesh will be returned. Figure
-\ref{fig:pentagon} shows a simple example of this, in which the
-triangulation is carried out within a pentagon.
-
-
-\begin{figure}[hbt]
-
-  \caption{Mesh points are created inside the polygon}
-  \label{fig:pentagon}
-\end{figure}
+On any given platform, the same mesh will be returned. 
+%Figure
+%\ref{fig:pentagon} shows a simple example of this, in which the
+%triangulation is carried out within a pentagon.
+
+
+%\begin{figure}[hbt]
+
+%  \caption{Mesh points are created inside the polygon}
+  %\label{fig:pentagon}
+%\end{figure}
 
 Boundary tags are not restricted to \code{`left'}, \code{`bottom'},
@@ -935 +937 @@
 increase in resolution. This is done by allowing the user to specify
 a number of \emph{interior polygons}, each with a specified
-resolution, see Figure \ref{fig:interior meshes}. It is also
+resolution. It is also
 possible to specify one or more `holes'---that is, areas bounded by
 polygons in which no triangulation is required.
 
-\begin{figure}[hbt]
-
-
-
-  \caption{Interior meshes with individual resolution}
-  \label{fig:interior meshes}
-\end{figure}
+%\begin{figure}[hbt]
+%  \caption{Interior meshes with individual resolution}
+%  \label{fig:interior meshes}
+%\end{figure}
 
 In its general form, \code{pmesh} takes for its input a bounding
@@ -958 +957 @@
 list of pairs \code{[polygon, resolution]}, specifying the interior
 polygons and their resolutions.
-
-In practice, the details of the polygons used are read from a
-separate file \file{project.py}. Here is a complete listing of
-\file{project.py}:
-
-\verbatiminput{demos/cairns/project.py}
 
 The resulting mesh is output to a \emph{mesh file}\index{mesh
@@ -973 +966 @@
 \code{.msh} is used. See Section \ref{sec:file formats} (page
 \pageref{sec:file formats}) for more on file formats.)
+
+In practice, the details of the polygons used are read from a
+separate file \file{project.py}. Here is a complete listing of
+\file{project.py}:
+
+\verbatiminput{demos/cairns/project.py}
 
 Figure \ref{fig:cairns3d} illustrates the landscape of the region
@@ -1019 +1018 @@
 The statement
 
+
 {\small \begin{verbatim}
 remainder_res = 10000000  
@@ -1041 +1041 @@
 
 
+
 \subsection{Initialising the Domain}
 
@@ -1093 +1094 @@
 For the scenario we are modelling in this case, we use a callable
 object \code{tsunami\_source}, assigned by means of a function
-\function{slump\_tsunami}. This is similar to how we set elevation in
+\function{slide\_tsunami}. This is similar to how we set elevation in
 \file{runup.py} using a function---however, in this case the
 function is both more complex and more interesting.
@@ -1166 +1167 @@
 very similar to the corresponding step in \file{runup.py}. For the slide
 scenario, 
-the simulation is run for 5000 seconds with the output stored every five seconds.
+the simulation is run for 5000 seconds with the output stored every ten seconds.
 For this example, we choose to apply the slide at 60 seconds into the simulation.
 
@@ -1173 +1174 @@
 
     
-    for t in domain.evolve(yieldstep = 5, finaltime = 60): 
+    for t in domain.evolve(yieldstep = 10, finaltime = 60): 
             domain.write_time()
             domain.write_boundary_statistics(tags = 'ocean_east')     
@@ -1184 +1185 @@
             domain.set_quantity('stage', slide + thisstagestep)
     
-        # save every two mins leading up to wave approaching land
-        for t in domain.evolve(yieldstep = 5, finaltime = 5000, 
+        for t in domain.evolve(yieldstep = 10, finaltime = 5000, 
                                skip_initial_step = True):
             domain.write_time()
@@ -1270 +1270 @@
 each desired quantity for each point location. 
 
-verbatiminput{demos/cairns/GetTimeseries.py}
+\verbatiminput{demos/cairns/GetTimeseries.py}
 
 Here, the time series for the quantities stage and speed will be generated for
-each gauge defined in the gauge file defined in file{\project.py}. As an example output,
-Figure \ref{fig:trinitybeach} shows the time series for the quantity stage for the
-Trinity Beach location.
+each gauge defined in the gauge file. Typically, stage is used over depth, particularly
+for offshore gauges. In being able to interpret the output for onshore gauges however,
+we use depth rather than stage. As an example output,
+Figure \ref{fig:reef} shows the time series for the quantity stage (or depth for
+onshore gauges) for the Elford Reef location for the slide scenario.
 
 \begin{figure}[hbt]
-%\centerline{\includegraphics[scale=0.5]{graphics/}}
-\caption{Time series information of the quantity stage for the Trinity Beach location.}
-\label{fig:trinitybeach}
+\centerline{\includegraphics[scale=0.5]{graphics/gaugeElfordReefslide.png}}
+\caption{Time series information of the quantity depth for the Elford Reef location for the slide scenario.}
+\label{fig:reef}
 \end{figure}
+
+Note, the user may choose to compare the output for each scenario by updating
+the \code{production\_dirs} as required. For example,
+
+{\small \begin{verbatim}
+
+        production_dirs = {'slide': 'Slide',
+                           'fixed_wave': 'Fixed Wave'}
+        
+\end{verbatim}}
+
+In this case, the time series output for Elford Reef would be:
+
+\begin{figure}[hbt]
+\centerline{\includegraphics[scale=0.5]{graphics/gaugeElfordReefboth.png}}
+\caption{Time series information of the quantity depth for the Elford Reef location for the slide and fixed wave scenario.}
+\label{fig:reefboth}
+\end{figure}
+
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%