Changeset 7135


Ignore:
Timestamp:
May 30, 2009, 10:19:48 AM (11 years ago)
Author:
ole
Message:

Ensured LaTeX single space escape after e.g. and i.e.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • anuga_core/documentation/user_manual/anuga_user_manual.tex

    r7134 r7135  
    216216regions using symbolic tags.  These tags may then be used to set the
    217217actual boundary conditions and attributes for different regions
    218 (e.g. the Manning friction coefficient) for each simulation.
     218(e.g.\ the Manning friction coefficient) for each simulation.
    219219
    220220Most \anuga components are written in the object-oriented programming
     
    237237  \item The mathematical model is the 2D shallow water wave equation.
    238238  As such it cannot resolve vertical convection and consequently not breaking
    239   waves or 3D turbulence (e.g. vorticity).
    240   %\item The surface is assumed to be open, e.g. \anuga cannot model
     239  waves or 3D turbulence (e.g.\ vorticity).
     240  %\item The surface is assumed to be open, e.g.\ \anuga cannot model
    241241  %flow under ceilings or in pipes
    242242  \item All spatial coordinates are assumed to be UTM (meters). As such,
     
    467467
    468468which specifies that the surface level is set to a height of $-0.4$,
    469 i.e. 0.4 units (metres) below the zero level.
     469i.e.\ 0.4 units (metres) below the zero level.
    470470
    471471Although it is not necessary for this example, it may be useful to
     
    524524          may cause numerical instabilities propagating into the domain and
    525525          eventually causing \anuga to crash. If this occurs,
    526           consider using e.g. a Dirichlet boundary condition with a stage value
     526          consider using e.g.\ a Dirichlet boundary condition with a stage value
    527527          less than the elevation at the boundary.
    528528    \item \textbf{Dirichlet boundary}\label{def:dirichlet boundary} Specifies
     
    10791079\subsubsection{Stage}
    10801080
    1081 The stage is initially set to 0.0 (i.e. Mean Sea Level) by the following statements:
     1081The stage is initially set to 0.0 (i.e.\ Mean Sea Level) by the following statements:
    10821082
    10831083\begin{verbatim}
     
    16601660
    16611661\code{segments} is a list of segments.  Each segment is defined by the start and end
    1662 of the line by its point index, e.g. use \code{segments = [[0,1],[1,2]]} to make a
     1662of the line by its point index, e.g.\ use \code{segments = [[0,1],[1,2]]} to make a
    16631663polyline between points 0, 1 and 2.
    16641664
     
    17261726
    17271727\code{raw_boundary}, if \code{True} instructs the function to return the raw
    1728 boundary, i.e. the regular edges of the alpha shape.
     1728boundary, i.e.\ the regular edges of the alpha shape.
    17291729
    17301730\code{remove_holes}, if \code{True} enables a filter to remove small holes
     
    17351735
    17361736\code{expand_pinch}, if \code{True} tests for pinch-off and corrects
    1737 (i.e. a boundary vertex with more than two edges).
     1737(i.e.\ a boundary vertex with more than two edges).
    17381738\end{methoddesc}
    17391739
     
    18741874
    18751875Default value is $10^{-3}$ metre, but by setting this to a greater value,
    1876 e.g. for large scale simulations, the computation time can be
     1876e.g.\ for large scale simulations, the computation time can be
    18771877significantly reduced.
    18781878\end{methoddesc}
     
    19461946\end{itemize}
    19471947
    1948 Note that when model data in the SWW file are averaged (i.e. not stored uniquely),
     1948Note that when model data in the SWW file are averaged (i.e.\ not stored uniquely),
    19491949then there will most likely be a small discrepancy between values extracted from the SWW
    19501950file and the same data stored in the model domain. This must be borne in mind when comparing
     
    19581958Return x,y coordinates of all nodes in the domain mesh.  The nodes are ordered
    19591959in an \code{Nx2} array where N is the number of nodes.  This is the same format
    1960 they were provided in the constructor i.e. without any duplication.
     1960they were provided in the constructor i.e.\ without any duplication.
    19611961
    19621962\code{absolute} is a boolean which determines whether coordinates
     
    20142014
    20152015This version of the mesh is useful for storing meshes with
    2016 discontinuities at each node and is e.g. used for storing
     2016discontinuities at each node and is e.g.\ used for storing
    20172017data in SWW files.
    20182018
     
    20682068        the quantity in question
    20692069  \item a list of numbers or a numeric array ordered the same way as the mesh vertices
    2070   \item a function (e.g. see the samples introduced in Chapter 2)
     2070  \item a function (e.g.\ see the samples introduced in Chapter 2)
    20712071  \item an expression composed of other quantities and numbers, arrays, lists (for
    20722072        example, a linear combination of quantities, such as
     
    22192219
    22202220The underlying algorithm used is as follows:\\
    2221 Given a time series (i.e. a series of values associated with
     2221Given a time series (i.e.\ a series of values associated with
    22222222different times), whose values are either just numbers, a set of
    22232223numbers defined at the vertices of a triangular mesh (such as those
     
    22572257Module: \module{fit_interpolate.interpolate}
    22582258
    2259 Given a time series (i.e. a series of values associated with
     2259Given a time series (i.e.\ a series of values associated with
    22602260different times) whose values are either just numbers or a set of
    22612261numbers defined at the vertices of a triangular mesh (such as those
     
    24952495
    24962496This is a general class to modify any quantity according to a given rate of change.
    2497 Other specific forcing terms are based on this class but it can be used by itself as well (e.g. to modify momentum).
     2497Other specific forcing terms are based on this class but it can be used by itself as well (e.g.\ to modify momentum).
    24982498
    24992499\code{domain} is the domain being evolved.
     
    25042504function of time. Positive values indicate increases, negative values indicate decreases.
    25052505The parameter \code{rate} can be \code{None} at initialisation but must be specified
    2506 before a forcing term is applied (i.e. simulation has started).
    2507 The default value is 0.0 -- i.e. no forcing.
     2506before a forcing term is applied (i.e.\ simulation has started).
     2507The default value is 0.0 -- i.e.\ no forcing.
    25082508
    25092509\code{center} and \code{ radius} optionally restrict forcing to a circle with given center and radius.
     
    31913191\begin{tabular}{ll}
    31923192ASC, PRJ & Digital elevation models (gridded)\\
    3193 NC & Model outputs for use as boundary conditions (e.g. from MOST)
     3193NC & Model outputs for use as boundary conditions (e.g.\ from MOST)
    31943194\end{tabular}
    31953195
     
    32843284
    32853285A mesh file can also contain a georeference, which describes an
    3286 offset to be applied to $x$ and $y$ values -- e.g. to the vertices.
     3286offset to be applied to $x$ and $y$ values -- e.g.\ to the vertices.
    32873287
    32883288\subsection{Formats for Storing Arbitrary Points and Attributes}
     
    33723372The $easting$ and $northing$ values are used if the user wishes to determine the output
    33733373within a specified rectangular area. The \code{reduction} input refers to a function
    3374 to reduce the quantities over all time step of the SWW file, e.g. maximum.
     3374to reduce the quantities over all time step of the SWW file, e.g.\ maximum.
    33753375\end{funcdesc}
    33763376
     
    33953395  of points to select along with their longitudes and latitudes. This permutation will also be
    33963396  stored in the STS file. If absent, all points are taken and the permutation will be trivial,
    3397   i.e. $0, 1, \ldots, N-1$, where $N$ is the total number of points stored. 
     3397  i.e.\ $0, 1, \ldots, N-1$, where $N$ is the total number of points stored. 
    33983398\end{funcdesc}
    33993399
     
    34233423  Optional parameter \code{floor_height} is the height of each building story.
    34243424
    3425   These can e.g. be converted to a \code{Polygon_function} for use with \code{add_quantity}
     3425  These can e.g.\ be converted to a \code{Polygon_function} for use with \code{add_quantity}
    34263426  as shown on page \pageref{add quantity}.
    34273427\end{funcdesc}
     
    37873787Physical model time cannot be earlier than 1 Jan 1970 00:00:00.
    37883788If one wished to recreate scenarios prior to that date it must be done
    3789 using some relative time (e.g. 0).
     3789using some relative time (e.g.\ 0).
    37903790
    37913791The \anuga domain has an attribute \code{starttime} which is used in cases where the
     
    38173817Throughout the \anuga interface, functions have optional boolean arguments \code{absolute} which controls
    38183818whether spatial data received is using the internal representation (\code{absolute=False}) or the
    3819 user coordinate set (\code{absolute=True}). See e.g. \code{get_vertex_coordinates()} on \pageref{pg:get vertex coordinates}.
     3819user coordinate set (\code{absolute=True}). See e.g.\ \code{get_vertex_coordinates()} on \pageref{pg:get vertex coordinates}.
    38203820
    38213821DEMs, meshes and boundary conditions can have different origins. However, the internal representation in \anuga
     
    42284228
    42294229The function returns a list containing the minimum and maximum of the points in all the
    4230 input polygons, i.e. \code{[$x_{min}$, $x_{max}$, $y_{min}$, $y_{max}$]}.
     4230input polygons, i.e.\ \code{[$x_{min}$, $x_{max}$, $y_{min}$, $y_{max}$]}.
    42314231\end{funcdesc}
    42324232
     
    42854285
    42864286Note that the \code{Geospatial_data} object currently reads entire datasets
    4287 into memory i.e. no memomry blocking takes place.
     4287into memory i.e.\ no memomry blocking takes place.
    42884288For this we refer to the \code{set_quantity()} method which will read PTS and CSV
    42894289files into \anuga using memory blocking allowing large files to be used.
     
    45194519
    45204520NOTE: The function will not work if the \code{data_file} extent is greater than the
    4521 \code{boundary_poly} polygon or any of the boundaries, e.g. \code{north_boundary}, etc.
     4521\code{boundary_poly} polygon or any of the boundaries, e.g.\ \code{north_boundary}, etc.
    45224522\end{methoddesc}
    45234523
     
    46004600
    46014601\code{raw_boundary} sets the type to $raw$ if \code{True},
    4602 i.e. the regular edges of the alpha shape.
     4602i.e.\ the regular edges of the alpha shape.
    46034603
    46044604\code{remove_holes}, if \code{True} removes small holes ('small' is defined by
Note: See TracChangeset for help on using the changeset viewer.