Changeset 2626
- Timestamp:
- Mar 29, 2006, 12:21:31 PM (19 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
documentation/user_manual/anuga_user_manual.tex
r2600 r2626 1000 1000 1001 1001 %%% 1002 \begin{classdesc}{Interpolation _function}{self,1002 \begin{classdesc}{Interpolation\_function}{self, 1003 1003 time, 1004 1004 quantities, … … 1010 1010 Module: \code{pyvolution.least\_squares} 1011 1011 1012 Creates a callable object \code{f(t, id)} or \code{f(t,x,y)} 1013 interpolated from a time series defined at the vertices of a 1014 triangular mesh (such as those stored in \code{sww} files). 1015 1016 \code{time} is an array of monotonically increasing times and 1017 \code{quantities} is an array---or dictionary of arrays---of values to 1018 be interpolated. The parameter \code{interpolation_points} may be 1019 used to specify at which points interpolated quantities are to be 1020 computed whenever the object is called. If the default value 1021 \code{None} is used, the function returns an average value. 1012 Given a time series defined at the vertices of a 1013 triangular mesh (such as those stored in \code{sww} files), 1014 \code{Interpolation\_function} is used to create a callable object 1015 that assigns a value \code{f(t, x, y)}, interpolated from the given time-series values, 1016 to an arbitrary time \code{t} and point \code{(x, y)} 1017 within the mesh region. Since, in practice, values need to be computed at specified 1018 points, the syntax allows the user to specify, once and for all, a list 1019 \code{interpolation\_points} of points at which values are required. In this case, 1020 the function may be called using the form \code{f(t, id)}, where \code{id} is an 1021 index identifying a member of \code{interpolation\_points}. 1022 1023 The time series is specified by means of an array \code{time} 1024 of monotonically increasing times and an array---or dictionary of arrays---\code{quantities} 1025 containing the values to be interpolated. 1022 1026 \end{classdesc} 1023 1027 … … 1137 1141 Module: pyvolution.domain 1138 1142 1139 This function (a method of \code{domain}) is invoked once all the preliminary steps have been 1140 taken, and causes the model to progress through a successive steps in its evolution, during 1141 which quantities are progressively recalculated and the domain may be modified. The user specifies 1142 the time period over which the evolution is to take place, by specifying values (in seconds) for either 1143 This function (a method of \code{domain}) is invoked once all the preliminaries have been 1144 completed, and causes the model to progress through successive steps in its evolution, storing results and 1145 outputting statistics whenever a user-specified period \code{yieldstep} is completed (generally 1146 during this period the model will evolve through several steps internally). The user specifies 1147 the total time period over which the evolution is to take place, by specifying values (in seconds) for either 1143 1148 \code{duration} or \code{finaltime}, as well as the interval in seconds after which results are to be 1144 1149 stored and statistics output.
Note: See TracChangeset
for help on using the changeset viewer.