Changeset 3053


Ignore:
Timestamp:
Jun 2, 2006, 1:55:15 PM (18 years ago)
Author:
howard
Message:

Various minor corrections. Added material in Appendix A on Polygon_function.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • documentation/user_manual/anuga_user_manual.tex

    r3049 r3053  
    4444\settimeformat{oclock} % Verbose
    4545\date{\today, \ \currenttime}
     46\hyphenation{set\_datadir}
    4647
    4748\ifhtml
    … …  
    253254
    254255\begin{tabular}{rcrcl}
    255   \code{depth} &=& \code{stage} &-& \code{elevation}
     256  \code{depth} &=& \code{stage} &$-$& \code{elevation}
    256257\end{tabular}
    257258
    … …  
    450451expressions involving other quantities, arbitrary data points with
    451452associated values, all of which can be passed as arguments. All
    452 quantities can be initialised using \method{set\_quantity}. For
    453 conserved quantities (\code{stage, xmomentum, ymomentum}) this is
    454 called the \emph{initial condition}, for other quantities that
    455 aren't updated by the equation, the same interface is used to assign
    456 their values. The code in the present example demonstrates a number
    457 of forms in which we can invoke \method{set\_quantity}.
     453quantities can be initialised using \method{set\_quantity}. For a
     454conserved quantity (such as \code{stage, xmomentum, ymomentum}) this
     455is called an \emph{initial condition}. However, other quantities
     456that aren't updated by the equation are also assigned values using
     457the same interface. The code in the present example demonstrates a
     458number of forms in which we can invoke \method{set\_quantity}.
    458459
    459460
    … …  
    644645
    645646
    646 \section{Exploring the model output}
     647\section{Exploring the Model Output}
    647648
    648649Figure \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 detail is
    654 Section \ref{sec:swollen}.
     650specified by the initial condition, $t=0$. Figure
     651\ref{fig:bedslope2} shows later snapshots for $t=2.3$ and $t=4$
     652where the system has been evolved and the wave is encroaching on the
     653previously dry bed.  All figures are screenshots from an interactive
     654animation tool called Swollen which is part of \anuga. Swollen is
     655described in more detail is Section \ref{sec:swollen}.
    655656
    656657
    … …  
    863864
    864865Providing a filename instead of the lists used in \file{runup.py}
    865 above causes Domain to convert a meshfile \code{meshname} into an
    866 instance of the data structure \code{domain}, allowing us to use
    867 methods like \method{set\_quantity} to set quantities and to apply
    868 other operations.
     866above causes \code{Domain} to convert a meshfile \code{meshname}
     867into an instance of the data structure \code{domain}, allowing us to
     868use methods like \method{set\_quantity} to set quantities and to
     869apply other operations.
    869870
    870871%(In principle, the
    … …  
    10631064
    10641065\section{Mesh Generation}
    1065 \refmodindex[pmesh.meshinterface]{pmesh.mesh\_interface}
     1066\refmodindex[pmesh.meshinterface]{pmesh.mesh\_interface}\label{sec:meshgeneration}
    10661067\begin{funcdesc}  {create\_mesh\_from\_regions}{bounding_polygon,
    10671068                             boundary_tags,
    … …  
    12231224\end{funcdesc}
    12241225
    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.)
    12261229\end{funcdesc}
    12271230
    … …  
    13461349Module: \module{pyvolution.least\_squares}
    13471350
    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 possibly a
    1353 point \code{(x, y)} within a mesh region.
     1351Given a time series, either as a sequence of numbers or defined at
     1352the vertices of a triangular mesh (such as those stored in SWW
     1353files), \code{Interpolation\_function} is used to create a callable
     1354object that interpolates a value for an arbitrary time \code{t}
     1355within the model limits and possibly a point \code{(x, y)} within a
     1356mesh region.
    13541357
    13551358The actual time series at which data is available is specified by
    … …  
    17281731be either a TSH file, which is an ASCII file, or an MSH file, which
    17291732is a NetCDF file. A meshfile can be generated from the function
    1730 \function{create_mesh_from_regions} (see ) and used to initialise a
    1731 domain.
     1733\function{create_mesh_from_regions} (see Section
     1734\ref{sec:meshgeneration}) and used to initialise a domain.
    17321735
    17331736A meshfile describes the outline of the mesh---the vertices and line
    … …  
    20442047  Module: \code{utilities.polygon}
    20452048
    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)? ]
    20472061  \end{classdesc}
    20482062
    … …  
    23252339Prime Meridian (located in Greenwich, England) expressed in degrees or time.
    23262340
    2327     \item \indexedbold{edge} - A triangulare cell 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).
    23282342
    23292343    \item \indexedbold{vertex} - A point at which edges meet.
    23302344
    2331     \item \indexedbold{finite volume} - The method evaluates the terms in the shallow water wave equationas fluxes at the surfaces of each
     2345    \item \indexedbold{finite volume} - The method evaluates the terms in the shallow water wave equation as fluxes at the surfaces of each
    23322346finite volume. Because the flux entering a given volume is identical to that leaving the adjacent volume, these methods are conservative.
    23332347Another advantage of the finite volume method is that it is easily formulated to allow for unstructured meshes.
    … …  
    23432357\end{itemize}
    23442358
    2345 The \code{\e appendix} markup need not be repeated for additional
    2346 appendices.
     2359%The \code{\e appendix} markup need not be repeated for additional
     2360%appendices.
    23472361
    23482362
Note: See TracChangeset for help on using the changeset viewer.