Changeset 3053
 Timestamp:
 Jun 2, 2006, 1:55:15 PM (18 years ago)
 File:

 1 edited
Legend:
 Unmodified
 Added
 Removed

documentation/user_manual/anuga_user_manual.tex
r3049 r3053 44 44 \settimeformat{oclock} % Verbose 45 45 \date{\today, \ \currenttime} 46 \hyphenation{set\_datadir} 46 47 47 48 \ifhtml … … 253 254 254 255 \begin{tabular}{rcrcl} 255 \code{depth} &=& \code{stage} & & \code{elevation}256 \code{depth} &=& \code{stage} &$$& \code{elevation} 256 257 \end{tabular} 257 258 … … 450 451 expressions involving other quantities, arbitrary data points with 451 452 associated values, all of which can be passed as arguments. All 452 quantities can be initialised using \method{set\_quantity}. For 453 conserved quantit ies (\code{stage, xmomentum, ymomentum}) thisis454 called the \emph{initial condition}, for other quantities that 455 aren't updated by the equation, the same interface is used to assign 456 the ir values. The code in the present example demonstrates a number457 of forms in which we can invoke \method{set\_quantity}.453 quantities can be initialised using \method{set\_quantity}. For a 454 conserved quantity (such as \code{stage, xmomentum, ymomentum}) this 455 is called an \emph{initial condition}. However, other quantities 456 that aren't updated by the equation are also assigned values using 457 the same interface. The code in the present example demonstrates a 458 number of forms in which we can invoke \method{set\_quantity}. 458 459 459 460 … … 644 645 645 646 646 \section{Exploring the model output}647 \section{Exploring the Model Output} 647 648 648 649 Figure \ref{fig:runupstart} shows the domain with water surface as 649 specified by the initial condition, $t=0$. Figure \ref{fig:bedslope2}650 shows later snapshots for $t=2.3$ and $t=4$ where the system has been 651 evolved and the wave encroaching on the previously dry bed. All 652 figures are screenshots from an interactive animation tool called 653 Swollen which is part of ANUGA. Swollen is described in more detailis654 Section \ref{sec:swollen}.650 specified by the initial condition, $t=0$. Figure 651 \ref{fig:bedslope2} shows later snapshots for $t=2.3$ and $t=4$ 652 where the system has been evolved and the wave is encroaching on the 653 previously dry bed. All figures are screenshots from an interactive 654 animation tool called Swollen which is part of \anuga. Swollen is 655 described in more detail is Section \ref{sec:swollen}. 655 656 656 657 … … 863 864 864 865 Providing a filename instead of the lists used in \file{runup.py} 865 above causes Domain to convert a meshfile \code{meshname} into an866 in stance of the data structure \code{domain}, allowing us to use867 methods like \method{set\_quantity} to set quantities and to apply 868 other operations.866 above causes \code{Domain} to convert a meshfile \code{meshname} 867 into an instance of the data structure \code{domain}, allowing us to 868 use methods like \method{set\_quantity} to set quantities and to 869 apply other operations. 869 870 870 871 %(In principle, the … … 1063 1064 1064 1065 \section{Mesh Generation} 1065 \refmodindex[pmesh.meshinterface]{pmesh.mesh\_interface} 1066 \refmodindex[pmesh.meshinterface]{pmesh.mesh\_interface}\label{sec:meshgeneration} 1066 1067 \begin{funcdesc} {create\_mesh\_from\_regions}{bounding_polygon, 1067 1068 boundary_tags, … … 1223 1224 \end{funcdesc} 1224 1225 1225 \begin{funcdesc} {set_default_order}{??} 1226 \begin{funcdesc} {set_default_order}{n} 1227 Sets the default (spatial) order to the value specified by \code{n), which must be either 1 or 1228 2. (Assigning any other value to \code{n} will cause an error.) 1226 1229 \end{funcdesc} 1227 1230 … … 1346 1349 Module: \module{pyvolution.least\_squares} 1347 1350 1348 Given a time series, either as a sequence of numbers or 1349 defined at the vertices of a triangular mesh (such 1350 as those stored in \code{sww} files), \code{Interpolation\_function} 1351 is used to create a callable object that interpolates a value for 1352 an arbitrary time \code{t} within the model limits and possiblya1353 point \code{(x, y)} within amesh region.1351 Given a time series, either as a sequence of numbers or defined at 1352 the vertices of a triangular mesh (such as those stored in SWW 1353 files), \code{Interpolation\_function} is used to create a callable 1354 object that interpolates a value for an arbitrary time \code{t} 1355 within the model limits and possibly a point \code{(x, y)} within a 1356 mesh region. 1354 1357 1355 1358 The actual time series at which data is available is specified by … … 1728 1731 be either a TSH file, which is an ASCII file, or an MSH file, which 1729 1732 is a NetCDF file. A meshfile can be generated from the function 1730 \function{create_mesh_from_regions} (see ) and used to initialise a1731 domain.1733 \function{create_mesh_from_regions} (see Section 1734 \ref{sec:meshgeneration}) and used to initialise a domain. 1732 1735 1733 1736 A meshfile describes the outline of the meshthe vertices and line … … 2044 2047 Module: \code{utilities.polygon} 2045 2048 2046 2049 Creates a callable object that returns one of a specified list of values when 2050 evaluated at a point, depending on which polygon, from a specified list of polygons, the 2051 point belongs to. The parameter \code{regions} is a list of pairs 2052 \code{(P, v)}, where each \code{P} is a polygon and each \code{v} 2053 is either a constant value or a function of coordinates \code{x} 2054 and \code{y}, specifying the return value for a point inside \code{P}. The 2055 optional parameter \code{default} may be used to specify a value 2056 for a point not lying inside any of the specified polygons. When a 2057 point lies in more than one polygon, the return value is taken to 2058 be the value for whichever of these polygon appears later in the 2059 list. 2060 [ CAN WE ALSO CALL IT AT A VECTOR x, y (WHERE x, y ARE LISTS)? ] 2047 2061 \end{classdesc} 2048 2062 … … 2325 2339 Prime Meridian (located in Greenwich, England) expressed in degrees or time. 2326 2340 2327 \item \indexedbold{edge}  A triangular ecell within the computational mesh can be depicted as a set of vertices joined by lines (the edges).2341 \item \indexedbold{edge}  A triangular cell within the computational mesh can be depicted as a set of vertices joined by lines (the edges). 2328 2342 2329 2343 \item \indexedbold{vertex}  A point at which edges meet. 2330 2344 2331 \item \indexedbold{finite volume}  The method evaluates the terms in the shallow water wave equation as fluxes at the surfaces of each2345 \item \indexedbold{finite volume}  The method evaluates the terms in the shallow water wave equation as fluxes at the surfaces of each 2332 2346 finite volume. Because the flux entering a given volume is identical to that leaving the adjacent volume, these methods are conservative. 2333 2347 Another advantage of the finite volume method is that it is easily formulated to allow for unstructured meshes. … … 2343 2357 \end{itemize} 2344 2358 2345 The \code{\e appendix} markup need not be repeated for additional2346 appendices.2359 %The \code{\e appendix} markup need not be repeated for additional 2360 %appendices. 2347 2361 2348 2362
Note: See TracChangeset
for help on using the changeset viewer.