Changeset 5508

Timestamp:

Jul 16, 2008, 12:50:05 PM (17 years ago)

Author:

ole

Message:

Minor fixes in the manual

File:

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

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -494 +494 @@
 The reader will probably appreciate that this capability to
 incorporate expressions into statements using \method{set\_quantity}
-greatly expands its power.) See Section \ref{sec:Initial Conditions} for more
+greatly expands its power.) See Section \ref{sec:initial conditions} for more
 details.
 
@@ -1383 +1383 @@
 
 \begin{itemize}
-    \item Establishing the Mesh
-    \item Initialising the Domain
-    \item Specifying the Quantities
-    \item Initial Conditions
-    \item Boundary Conditions
-    \item Forcing Functions
-    \item Evolution
+    \item Establishing the Mesh: Section \ref{sec:establishing the mesh}
+    \item Initialising the Domain: Section \ref{sec:initialising the domain}
+    \item Specifying the Quantities: Section \ref{sec:quantitis}
+    \item Initial Conditions: Section \ref{sec:initial conditions}
+    \item Boundary Conditions: Section \ref{sec:boundary conditions}
+    \item Forcing Terms: Section \ref{sec:forcing terms}
+    \item Evolution: Section \ref{sec:evolution}
 \end{itemize}
 
@@ -1450 +1450 @@
 %\end{center}
 
-\section{Mesh Generation}
-
+\section{Mesh Generation}\index{Mesh!generation}
+\label{sec:establishing the mesh}
 Before discussing the part of the interface relating to mesh
 generation, we begin with a description of a simple example of a
@@ -1722 +1722 @@
 
 %%%%%%
-\section{Initialising the Domain}
+\section{Initialising the Domain}\index{Initialising the Domain}
+\label{sec:initialising the domain}
 
 %Include description of the class Domain and the module domain.
@@ -1943 +1944 @@
 
 %%%%%%
-\section{Initial Conditions}
-\label{sec:Initial Conditions}
+\section{Initial Conditions}\index{Initial Conditions}
+\label{sec:initial conditions}
 In standard usage of partial differential equations, initial conditions
 refers to the values associated to the system variables (the conserved
@@ -2168 +2169 @@
 %%%%%%
 \section{Boundary Conditions}\index{boundary conditions}
+\label{sec:boundary conditions}
 
 \anuga provides a large number of predefined boundary conditions,
@@ -2294 +2296 @@
 
 
-\section{Forcing Terms}
-\label{forcing terms}
+\section{Forcing Terms}\index{Forcing terms}
+\label{sec:forcing terms}
 
 \anuga provides a number of predefined forcing functions to be used with simulations.
@@ -2301 +2303 @@
 \code{domain.forcing\_terms} and have them affect the model. 
  
-Currently, predifiend forcing terms are
+Currently, predefined forcing terms are
 
 \begin{funcdesc}{General\_forcing}{}
@@ -2324 +2326 @@
   Note specifying both center, radius and polygon will cause an exception to be thrown.
 
-    
+  \bigskip  
   Example:
   {\scriptsize \begin{verbatim} 
-        xmom = General_forcing(domain, 'xmomentum', polygon=P)
-        ymom = General_forcing(domain, 'ymomentum', polygon=P)
-
-        xmom.rate = f
-        ymom.rate = g
+    P = [[x0, y0], [x1, y0], [x1, y1], [x0, y1]] # Square polygon
   
-        domain.forcing_terms.append(xmom)
-        domain.forcing_terms.append(ymom)       
+    xmom = General_forcing(domain, 'xmomentum', polygon=P)
+    ymom = General_forcing(domain, 'ymomentum', polygon=P)
+
+    xmom.rate = f
+    ymom.rate = g
+  
+    domain.forcing_terms.append(xmom)
+    domain.forcing_terms.append(ymom)   
   \end{verbatim}}
   Here, \code{f}, \code{g} are assumed to be defined as functions of time providing a time dependent rate of change for xmomentum and ymomentum respectively.
-  P is assumed to be polygon, specified as a list of points, e.g. a square \code{P = [[x0, y0], [x1, y0], [x1, y1], [x0, y1]]}.  
+  P is assumed to be polygon, specified as a list of points. 
   
 \end{funcdesc} 
@@ -2364 +2368 @@
   \end{itemize}
 
-    
+  \bigskip      
   Example:
   {\scriptsize \begin{verbatim} 
@@ -2400 +2404 @@
   \end{itemize}
   
+  \bigskip    
   Example:
   {\scriptsize \begin{verbatim} 
@@ -2439 +2444 @@
   The user can specify different culvert routines. Hower ANUGA currently specifies one, namely the \code{boyd\_generalised\_culvert\_model} as used in the example below.
       
+  \bigskip        
   Example:
   {\scriptsize \begin{verbatim} 
@@ -2476 +2482 @@
 
 \section{Evolution}\index{evolution}
+\label{sec:evolution}
 
   \begin{methoddesc}{evolve}{yieldstep = None, finaltime = None, duration = None, skip_initial_step = False}