Changeset 2627

Timestamp:

Mar 29, 2006, 1:29:38 PM (17 years ago)

Author:

howard

Message:

Updated description of set_boundary

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -1038 +1038 @@
 \section{Boundary Conditions}
 
-\anuga provides a large number of predefined boundary conditions to
-be used with \code{set\_boundary}.
+\anuga provides a large number of predefined boundary conditions, represented by
+objects such as \code{Reflective\_boundary(domain)} and \code{Dirichlet\_boundary([0.2, 0.0, 0.0])},
+described in the examples in Chapter 2. Alternatively, you may prefer to ``roll
+your own'', following the method explained in \ref{sec:roll_your_own}. 
+
+These boundary objects may be used with the function \code{set\_boundary} described below
+to assign boundary conditions according to the tags used to label boundary segments.
 
 \begin{funcdesc}{set\_boundary}{boundary_map}
 Module: \code{pyvolution.domain}
 
-Associate boundary objects with tagged boundary segments.
-
-The input \code{boundary\_map} is a dictionary of boundary objects
-keyed by symbolic tags.
-
-As result one pointer to a boundary object is stored for each vertex
-in the list self.boundary_objects.
-More entries may point to the same boundary object
-
-Schematically the mapping is from two dictionaries to one list where
-the index is used as pointer to the \code{boundary\_values} arrays
-within each quantity.
+This function allows you to assign a boundary object (corresponding to a
+pre-defined or user-specified boundary condition) to every boundary segment that
+has been assigned a particular tag. 
+
+This is done by specifying a dictionary \code{boundary\_map}, whose values are the boundary objects
+and whose keys are the symbolic tags.
+
 \end{funcdesc}
 
@@ -1113 +1113 @@
 
 \subsection{User-defined boundary conditions}
+\label{sec:roll_your_own}
 [How to roll your own]