Changeset 5672 for anuga_core/documentation/user_manual/anuga_user_manual.tex

Timestamp:

Aug 21, 2008, 4:32:14 PM (16 years ago)

Author:

ole

Message:

Tested for bug where default_boundry was repeatedly added to by Field_boundary.
Fixed bug and updated manual accordingly.

This closes ticket:293

File:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (1 diff)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -2254 +2254 @@
 appropriate segments for each conserved quantity.
 
-Optional argument \code{default_boundary} can be used to specify another boundary object to be used in case model time exceeds the time availabel in the file used by \code{File\_boundary}.
-The default_boundary could be a simple Dirichlet condition or even another File\_boundary 
+Optional argument \code{default\_boundary} can be used to specify another boundary object to be used in case model time exceeds the time availabel in the file used by \code{File\_boundary}.
+The \code{default\_boundary} could be a simple Dirichlet condition or 
+even another \code{File\_boundary} 
 typically using data pertaining to another time interval.  
 \end{classdesc}
 
-
+\begin{classdesc}{Field\_boundary}{Boundary}
+Module: \module{shallow\_water.shallow\_water\_domain}
+
+This method works in the same way as \code{File\_boundary} except that it 
+allows for the value of stage to be offset by a constant specified in the 
+keyword argument \code{mean\_stage}.
+
+This functionality allows for models to be run for a range of tides using
+the same boundary information (from .sts, .sww or .tms files). The tidal value
+for each run would then be specified in the keyword argument 
+\code{mean\_stage}. 
+If \code{mean\_stage} = 0.0, \code{Field\_boundary} and \code{File\_boundary} 
+behave identically. 
+
+
+Note that if the optional argument \code{default\_boundary} is specified
+it's stage value will be adjusted by \code{mean\_stage} just like the values
+obtained from the file. 
+
+See \code{File\_boundary} for further details.
+\end{classdesc}
 
 %%%