# Changeset 7135

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

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

File:
1 edited

### Legend:

Unmodified
 r7134 regions using symbolic tags.  These tags may then be used to set the actual boundary conditions and attributes for different regions (e.g. the Manning friction coefficient) for each simulation. (e.g.\ the Manning friction coefficient) for each simulation. Most \anuga components are written in the object-oriented programming \item The mathematical model is the 2D shallow water wave equation. As such it cannot resolve vertical convection and consequently not breaking waves or 3D turbulence (e.g. vorticity). %\item The surface is assumed to be open, e.g. \anuga cannot model waves or 3D turbulence (e.g.\ vorticity). %\item The surface is assumed to be open, e.g.\ \anuga cannot model %flow under ceilings or in pipes \item All spatial coordinates are assumed to be UTM (meters). As such, which specifies that the surface level is set to a height of $-0.4$, i.e. 0.4 units (metres) below the zero level. i.e.\ 0.4 units (metres) below the zero level. Although it is not necessary for this example, it may be useful to may cause numerical instabilities propagating into the domain and eventually causing \anuga to crash. If this occurs, consider using e.g. a Dirichlet boundary condition with a stage value consider using e.g.\ a Dirichlet boundary condition with a stage value less than the elevation at the boundary. \item \textbf{Dirichlet boundary}\label{def:dirichlet boundary} Specifies \subsubsection{Stage} The stage is initially set to 0.0 (i.e. Mean Sea Level) by the following statements: The stage is initially set to 0.0 (i.e.\ Mean Sea Level) by the following statements: \begin{verbatim} \code{segments} is a list of segments.  Each segment is defined by the start and end of the line by its point index, e.g. use \code{segments = [[0,1],[1,2]]} to make a of the line by its point index, e.g.\ use \code{segments = [[0,1],[1,2]]} to make a polyline between points 0, 1 and 2. \code{raw_boundary}, if \code{True} instructs the function to return the raw boundary, i.e. the regular edges of the alpha shape. boundary, i.e.\ the regular edges of the alpha shape. \code{remove_holes}, if \code{True} enables a filter to remove small holes \code{expand_pinch}, if \code{True} tests for pinch-off and corrects (i.e. a boundary vertex with more than two edges). (i.e.\ a boundary vertex with more than two edges). \end{methoddesc} Default value is $10^{-3}$ metre, but by setting this to a greater value, e.g. for large scale simulations, the computation time can be e.g.\ for large scale simulations, the computation time can be significantly reduced. \end{methoddesc} \end{itemize} Note that when model data in the SWW file are averaged (i.e. not stored uniquely), Note that when model data in the SWW file are averaged (i.e.\ not stored uniquely), then there will most likely be a small discrepancy between values extracted from the SWW file and the same data stored in the model domain. This must be borne in mind when comparing Return x,y coordinates of all nodes in the domain mesh.  The nodes are ordered in an \code{Nx2} array where N is the number of nodes.  This is the same format they were provided in the constructor i.e. without any duplication. they were provided in the constructor i.e.\ without any duplication. \code{absolute} is a boolean which determines whether coordinates This version of the mesh is useful for storing meshes with discontinuities at each node and is e.g. used for storing discontinuities at each node and is e.g.\ used for storing data in SWW files. the quantity in question \item a list of numbers or a numeric array ordered the same way as the mesh vertices \item a function (e.g. see the samples introduced in Chapter 2) \item a function (e.g.\ see the samples introduced in Chapter 2) \item an expression composed of other quantities and numbers, arrays, lists (for example, a linear combination of quantities, such as The underlying algorithm used is as follows:\\ Given a time series (i.e. a series of values associated with Given a time series (i.e.\ a series of values associated with different times), whose values are either just numbers, a set of numbers defined at the vertices of a triangular mesh (such as those Module: \module{fit_interpolate.interpolate} Given a time series (i.e. a series of values associated with Given a time series (i.e.\ a series of values associated with different times) whose values are either just numbers or a set of numbers defined at the vertices of a triangular mesh (such as those This is a general class to modify any quantity according to a given rate of change. Other specific forcing terms are based on this class but it can be used by itself as well (e.g. to modify momentum). Other specific forcing terms are based on this class but it can be used by itself as well (e.g.\ to modify momentum). \code{domain} is the domain being evolved. function of time. Positive values indicate increases, negative values indicate decreases. The parameter \code{rate} can be \code{None} at initialisation but must be specified before a forcing term is applied (i.e. simulation has started). The default value is 0.0 -- i.e. no forcing. before a forcing term is applied (i.e.\ simulation has started). The default value is 0.0 -- i.e.\ no forcing. \code{center} and \code{ radius} optionally restrict forcing to a circle with given center and radius. \begin{tabular}{ll} ASC, PRJ & Digital elevation models (gridded)\\ NC & Model outputs for use as boundary conditions (e.g. from MOST) NC & Model outputs for use as boundary conditions (e.g.\ from MOST) \end{tabular} A mesh file can also contain a georeference, which describes an offset to be applied to $x$ and $y$ values -- e.g. to the vertices. offset to be applied to $x$ and $y$ values -- e.g.\ to the vertices. \subsection{Formats for Storing Arbitrary Points and Attributes} The $easting$ and $northing$ values are used if the user wishes to determine the output within a specified rectangular area. The \code{reduction} input refers to a function to reduce the quantities over all time step of the SWW file, e.g. maximum. to reduce the quantities over all time step of the SWW file, e.g.\ maximum. \end{funcdesc} of points to select along with their longitudes and latitudes. This permutation will also be stored in the STS file. If absent, all points are taken and the permutation will be trivial, i.e. $0, 1, \ldots, N-1$, where $N$ is the total number of points stored. i.e.\ $0, 1, \ldots, N-1$, where $N$ is the total number of points stored. \end{funcdesc} Optional parameter \code{floor_height} is the height of each building story. These can e.g. be converted to a \code{Polygon_function} for use with \code{add_quantity} These can e.g.\ be converted to a \code{Polygon_function} for use with \code{add_quantity} as shown on page \pageref{add quantity}. \end{funcdesc} Physical model time cannot be earlier than 1 Jan 1970 00:00:00. If one wished to recreate scenarios prior to that date it must be done using some relative time (e.g. 0). using some relative time (e.g.\ 0). The \anuga domain has an attribute \code{starttime} which is used in cases where the Throughout the \anuga interface, functions have optional boolean arguments \code{absolute} which controls whether spatial data received is using the internal representation (\code{absolute=False}) or the user coordinate set (\code{absolute=True}). See e.g. \code{get_vertex_coordinates()} on \pageref{pg:get vertex coordinates}. user coordinate set (\code{absolute=True}). See e.g.\ \code{get_vertex_coordinates()} on \pageref{pg:get vertex coordinates}. DEMs, meshes and boundary conditions can have different origins. However, the internal representation in \anuga The function returns a list containing the minimum and maximum of the points in all the input polygons, i.e. \code{[$x_{min}$, $x_{max}$, $y_{min}$, $y_{max}$]}. input polygons, i.e.\ \code{[$x_{min}$, $x_{max}$, $y_{min}$, $y_{max}$]}. \end{funcdesc} Note that the \code{Geospatial_data} object currently reads entire datasets into memory i.e. no memomry blocking takes place. into memory i.e.\ no memomry blocking takes place. For this we refer to the \code{set_quantity()} method which will read PTS and CSV files into \anuga using memory blocking allowing large files to be used. NOTE: The function will not work if the \code{data_file} extent is greater than the \code{boundary_poly} polygon or any of the boundaries, e.g. \code{north_boundary}, etc. \code{boundary_poly} polygon or any of the boundaries, e.g.\ \code{north_boundary}, etc. \end{methoddesc} \code{raw_boundary} sets the type to $raw$ if \code{True}, i.e. the regular edges of the alpha shape. i.e.\ the regular edges of the alpha shape. \code{remove_holes}, if \code{True} removes small holes ('small' is defined by