Changeset 3092

Timestamp:

Jun 6, 2006, 11:21:02 AM (19 years ago)

Author:

sexton

Message:

few more updates

Location:

documentation/user_manual

Files:

• anuga_user_manual.tex (modified) (6 diffs)
• examples/runsydney.py (modified) (1 diff)

documentation/user_manual/anuga_user_manual.tex

@@ -206 +206 @@
 
 \section{A Simple Example}
+\label{sec:simpleexample}
 
 \subsection{Overview}
@@ -472 +473 @@
 \subsubsection{Friction}
 
-The assignment of the friction quantity demonstrates another way we
+The assignment of the friction quantity (a forcing term) demonstrates another way we
 can use \method{set\_quantity} to set quantities---namely, assign
 them to a constant numerical value:
@@ -672 +673 @@
 
 \section{An Example with Real Data}
-
+\label{sec:realdataexample}
 The following discussion builds on the concepts introduced through
 the \file{runup.py} example and introduces a second
@@ -1270 +1271 @@
 \section{Initial Conditions}
 
+In standard usage of partial differential equations, initial conditions
+refers to the values associated to the system variables (the conserved
+quantities here) for \code{time = 0}. In setting up a scenario script
+as described in Sections \ref{sec:simpleexample} and \ref{sec:realdataexample},
+\code{set_quantity} is used to define the initial conditions of variables
+other than the conserved quantities, such as friction. Here, we use the terminology
+of initial conditions to refer to initial values for variables which need
+prescription to solve the shallow water wave equation. Further, it must be noted
+that \code{set_quantity} does not necessarily have to be used in the initial
+condition setting; it can be used at any time throughout the simulation.
+
 \begin{funcdesc}{set\_quantity}{name,
     numeric = None,
@@ -1484 +1496 @@
 Module: \module{pyvolution.generic\_boundary\_conditions}
 
-A Dirichlet boundary returns constant values for the conserved
+A Dirichlet boundary returns constant values for each of conserved
 quantities. In the example of \code{Dirichlet\_boundary([0.2, 0.0, 0.0])}, 
 the \code{stage} value at the boundary is 0.2 and the \code{xmomentum} and 
@@ -1504 +1516 @@
 Module: \module{pyvolution.generic\_boundary\_conditions}
 
-The boundary values are obtained from a file and interpolated. The
-file is assumed to contain a time series and possibly also spatial
-information. The conserved quantities are given as a function of
-time.
+This method may be used if the user wishes to apply a SWW file or
+a time series file to a boundary segment or segments. 
+The boundary values are obtained from a file and interpolated to the
+appropriate segments for each conserved quantity.
 \end{classdesc}
 

documentation/user_manual/examples/runsydney.py

@@ -8 +8 @@
 the elevation data and a simulated submarine landslide.
 
-Ole Nielsen and Duncan Gray, GA - 2005 and
-Adrian Hitchman and Jane Sexton, GA - 2006
 """