Changeset 3449 for documentation/user_manual/anuga_user_manual.tex

Timestamp:

Aug 4, 2006, 11:49:36 AM (18 years ago)

Author:

duncan

Message:

adding documentation

File:

• documentation/user_manual/anuga_user_manual.tex (modified) (2 diffs)

documentation/user_manual/anuga_user_manual.tex

@@ -13 +13 @@
 %Figures \label{fig: }
 
+% Is latex failing with;
+% `modanuga_user_manual.ind' not found?
+% try this command-line
+%   makeindex modanuga_user_manual.idx
+% To produce the modanuga_user_manual.ind file.
 
 
@@ -1463 +1468 @@
 \begin{itemize}
 \item \code{indices} which is a list of ids of triangles to which set\_quantity should apply its assignment of values.
-\item \code{location} determines which part of the triangles to assign to. Options are 'vertices' (default), 'edges', and 'centroids'.
+\item \code{location} determines which part of the triangles to assign
+  to. Options are 'vertices' (default), 'edges', 'unique vertices', and 'centroids'.
 \end{itemize}
-
-
-\end{methoddesc}
-
-
-
-
-
-
 
 %%%
 \anuga provides a number of predefined initial conditions to be used
 with \code{set\_quantity}.
+
+\end{methoddesc}
+
+
+
+
+\begin{funcdesc}{set_region}{tag, quantity, X, location='vertices'}
+  Module: \module{pyvolution.domain}
+  (see also \module{pyvolution.region.Set\_region})
+  (see also \module{pyvolution.quantity.set\_values})
+  
+This function is used to assign values to individual quantities given
+a regional tag.   It is similar to set\_quantity. 
+For example, if in pmesh a regional tag of 'ditch' was
+used, set\_region can be used to set elevation of this region to
+-10m. X is the constant or function to be applied to the quantity,
+over the tagged region.  Location describes how the values will be
+applied.  Options are 'vertices' (default), 'edges', 'unique
+vertices', and 'centroids'.
+
+This method can also be called with a list of region objects.  This is
+useful for adding quantities in regions, and having one quantity
+value based on another quantity. See  \module{pyvolution.region} for
+more details.
+\end{funcdesc}
+
+
+
 
 \begin{funcdesc}{slump_tsunami}{length, depth, slope, width=None, thickness=None,