Changeset 2626

Timestamp:

Mar 29, 2006, 12:21:31 PM (17 years ago)

Author:

howard

Message:

Improved the description of Interpolation_function.

File:

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

documentation/user_manual/anuga_user_manual.tex

@@ -1000 +1000 @@
 
 %%%
-\begin{classdesc}{Interpolation_function}{self,
+\begin{classdesc}{Interpolation\_function}{self,
                  time,
                  quantities,
@@ -1010 +1010 @@
 Module: \code{pyvolution.least\_squares}
 
-Creates a callable object \code{f(t, id)} or \code{f(t,x,y)}
-interpolated from a time series defined at the vertices of a
-triangular mesh (such as those stored in \code{sww} files).
-
-\code{time} is an array of monotonically increasing times and
-\code{quantities} is an array---or dictionary of arrays---of values to
-be interpolated. The parameter \code{interpolation_points} may be
-used to specify at which points interpolated quantities are to be
-computed whenever the object is called. If the default value
-\code{None} is used, the function returns an average value.
+Given a time series defined at the vertices of a
+triangular mesh (such as those stored in \code{sww} files), 
+\code{Interpolation\_function} is used to create a callable object
+that assigns a value \code{f(t, x, y)}, interpolated from the given time-series values, 
+to an arbitrary time \code{t} and point \code{(x, y)}
+within the mesh region. Since, in practice, values need to be computed at specified 
+points, the syntax allows the user to specify, once and for all, a list
+\code{interpolation\_points} of points at which values are required. In this case,
+the function may be called using the form \code{f(t, id)}, where \code{id} is an
+index identifying a member of \code{interpolation\_points}.
+
+The time series is specified by means of an array \code{time} 
+of monotonically increasing times and an array---or dictionary of arrays---\code{quantities}
+containing the values to be interpolated. 
 \end{classdesc}
 
@@ -1137 +1141 @@
   Module: pyvolution.domain
   
-  This function (a method of \code{domain}) is invoked once all the preliminary steps have been 
-  taken, and causes the model to progress through a successive steps in its evolution, during
-  which quantities are progressively recalculated and the domain may be modified. The user specifies
-  the time period over which the evolution is to take place, by specifying values (in seconds) for either
+  This function (a method of \code{domain}) is invoked once all the preliminaries have been 
+  completed, and causes the model to progress through successive steps in its evolution, storing results and 
+  outputting statistics whenever a user-specified period \code{yieldstep} is completed (generally
+  during this period the model will evolve through several steps internally). The user specifies
+  the total time period over which the evolution is to take place, by specifying values (in seconds) for either
   \code{duration} or \code{finaltime}, as well as the interval in seconds after which results are to be 
   stored and statistics output.