Changeset 3049


Ignore:
Timestamp:
Jun 2, 2006, 11:33:12 AM (18 years ago)
Author:
howard
Message:

Minor corrections and additions in the first 4 chapters

File:
1 edited

Legend:

Unmodified
Added
Removed
  • documentation/user_manual/anuga_user_manual.tex

    r2921 r3049  
    132132\section{Scope}
    133133
    134 This manual covers only what is needed to operate the software
    135 after installation and configuration. It does not includes instructions for
    136 installing the software or detailed API documentation, both of
    137 which will be covered in separate publications and by  documentation in the
    138 source code.
     134This manual covers only what is needed to operate the software after
     135installation and configuration. It does not includes instructions
     136for installing the software or detailed API documentation, both of
     137which will be covered in separate publications and by documentation
     138in the source code.
    139139
    140140\section{Audience}
    141141
    142142Readers are assumed to be familiar with the operating environment
    143 and have a general understanding of the problem background, as
    144 well as enough programming experience to adapt the code to
    145 different requirements, as described in this manual,  and to
    146 understand the basic terminology of object-oriented programming.
     143and have a general understanding of the problem background, as well
     144as enough programming experience to adapt the code to different
     145requirements, as described in this manual, and to understand the
     146basic terminology of object-oriented programming.
    147147
    148148\section{Structure of This Manual}
     
    222222\subsection{Overview}
    223223
    224 What follows is a discussion of the structure and operation of a script which we will call \file{runup.py}, with just enough detail to allow
     224What follows is a discussion of the structure and operation of a script which we will call \file{runup.py},
     225with just enough detail to allow
    225226the reader to appreciate what's involved in setting up a scenario
    226227like the one it depicts.
     
    245246
    246247The conserved quantities involved in the
    247 problem are stage (absolute height of water surface), 
     248problem are stage (absolute height of water surface),
    248249$x$-momentum and $y$-momentum. Other quantities
    249250involved in the computation are the friction and elevation.
     
    337338just 11 points and three triangles. (To avoid confusion, we should
    338339emphasise that this particular mesh is \emph{not} generated by
    339 \code{rectangular}---and is not even rectangular in nature. )
     340\code{rectangular}---it is not even rectangular in nature. )
    340341
    341342
     
    344345    \includegraphics[width=90mm, height=90mm]{triangularmesh.eps}
    345346  \end{center}
    346  
     347
    347348  \caption{A simple mesh}
    348349  \label{fig:simplemesh}
     
    373374    \end{tabular}
    374375  \end{center}
    375  
    376   \caption{Point coordinates for mesh in 
     376
     377  \caption{Point coordinates for mesh in
    377378    Figure \protect \ref{fig:simplemesh}}
    378   \label{tab:points} 
    379 \end{table} 
     379  \label{tab:points}
     380\end{table}
    380381
    381382The list \code{vertices} specifies the triangles that make up the
     
    404405    \end{tabular}
    405406  \end{center}
    406  
    407   \caption{Vertices for mesh in 
     407
     408  \caption{Vertices for mesh in
    408409    Figure \protect \ref{fig:simplemesh}}
    409   \label{tab:vertices}   
    410 \end{table}   
     410  \label{tab:vertices}
     411\end{table}
    411412
    412413Finally, the variable \code{boundary} identifies the boundary
    413 triangles and associates a tag with each. 
     414triangles and associates a tag with each.
    414415
    415416
     
    553554\end{verbatim}}
    554555
    555 The effect of these statements is to set up a selection of different 
     556The effect of these statements is to set up a selection of different
    556557alternative boundary conditions and store them in variables that can be
    557558assigned as needed. Each boundary condition specifies the
     
    560561follows:
    561562
    562 \begin{itemize} 
     563\begin{itemize}
    563564    \item \textbf{Reflective boundary} Returns same \code{stage} as
    564       as present in its neighbour volume but momentum vector 
     565      as present in its neighbour volume but momentum vector
    565566      reversed 180 degrees (reflected).
    566567      Specific to the shallow water equation as it works with the
    567568      momentum quantities assumed to be the second and third conserved
    568       quantities. A reflective boundary condition models a solid wall. 
     569      quantities. A reflective boundary condition models a solid wall.
    569570    \item \textbf{Transmissive boundary} Returns same conserved quantities as
    570       those present in its neighbour volume. This is one way of modelling 
    571       outflow from a domain, but it should be used with caution if flow is 
     571      those present in its neighbour volume. This is one way of modelling
     572      outflow from a domain, but it should be used with caution if flow is
    572573      not steady state as replication of momentum at the boundary
    573       may cause occasional spurious effects. If this occurs, 
    574       consider using e.g. a Dirichlet boundary condition. 
     574      may cause occasional spurious effects. If this occurs,
     575      consider using e.g. a Dirichlet boundary condition.
    575576    \item \textbf{[Dirichlet boundary} Specifies a fixed value at the
    576577      boundary and assigns initial values to the $x$-momentum and $y$-momentum.
    577     \item \textbf {Time boundary} Like a Dirichlet boundary but with behaviour 
     578    \item \textbf {Time boundary} Like a Dirichlet boundary but with behaviour
    578579      varying with time.
    579580\end{itemize}
     
    652653Swollen which is part of ANUGA. Swollen is described in more detail is
    653654Section \ref{sec:swollen}.
    654  
     655
    655656
    656657
     
    861862\end{verbatim}}
    862863
    863 Providing a filename instead of the lists used in bedslopephysical
    864 above causes Domain to convert a meshfile
    865 \code{meshname} into an instance of the data structure
    866 \code{domain}, allowing us to use methods like \method{set\_quantity}
    867 to set quantities and to apply other operations.
     864Providing a filename instead of the lists used in \file{runup.py}
     865above causes Domain to convert a meshfile \code{meshname} into an
     866instance of the data structure \code{domain}, allowing us to use
     867methods like \method{set\_quantity} to set quantities and to apply
     868other operations.
    868869
    869870%(In principle, the
     
    11301131
    11311132% Translate following into layman's language
    1132 This method is used to generate the triangular mesh.  The  maximal area
    1133 of any triangle in the mesh can be specified, along with the minimum
    1134 angle of all triangles.
     1133This method is used to generate the triangular mesh.  The  maximal
     1134area of any triangle in the mesh can be specified, along with the
     1135minimum angle in any triangle.
    11351136\end{funcdesc}
    11361137
     
    11401141
    11411142% Translate following into layman's language
    1142 This method is used to save the mesh to a file. \code{ofile} is the name of the mesh file to be writen,
    1143 including the extension.  Use the extension \code{.msh} for the file to
    1144 be in NetCDF format and \code{.tsh} for the file to be ASCII format.
     1143This method is used to save the mesh to a file. \code{ofile} is the
     1144name of the mesh file to be written, including the extension.  Use
     1145the extension \code{.msh} for the file to be in NetCDF format and
     1146\code{.tsh} for the file to be ASCII format.
    11451147\end{funcdesc}
    11461148
     
    12811283
    12821284
    1283 a number, in which case all vertices in the mesh gets that for
    1284 the quantity in question.
    1285 \item a list of numbers or a Numeric array ordered the same way as the mesh vertices.
    1286 
    1287 
    12881285\end{funcdesc}
    12891286
     
    13341331for points at which values are sought.
    13351332
    1336 To get access to the model time stored within the file funcion use the method \code{f.get_time()}
     1333To get access to the model time stored within the file function use
     1334the method \code{f.get_time()}
    13371335\end{funcdesc}
    13381336
     
    14091407\begin{funcdesc} {get_boundary_tags}{}
    14101408Module: \module{pyvolution.mesh}
     1409
     1410Returns a list of the available boundary tags.
    14111411\end{funcdesc}
    14121412
     
    15621562
    15631563
    1564   \begin{classdesc}{Geospatial_data}{???}
     1564  \begin{classdesc}{Geospatial_data}{data_points = None,
     1565                 attributes = None,
     1566                 geo_reference = None,
     1567                 default_attribute_name = None,
     1568                 file_name = None}
    15651569    Module: \module{geospatial_data.geo_spatial_data}
    1566     Creates a georeferenced geospatial data object from either arrays or 
     1570    Creates a georeferenced geospatial data object from either arrays or
    15671571    a file (pts or xya).
    15681572
    15691573    Objects of this class can be used with \method{set\_quantity}.
    1570    
     1574
    15711575    FIXME (Ole): Describe methods such as get_attributes() etc
    15721576  \end{classdesc}
     
    21082112  Plots each polygon contained in input polygon list, e.g. [poly1, poly2, poly3].
    21092113 Each polygon is closed for plotting purposes and subsequent plot saved to figname.
    2110   Returns list containing the minimum and maximum of $x$ and $y$, 
     2114  Returns list containing the minimum and maximum of $x$ and $y$,
    21112115  i.e. [$x_{min}, x_{max}, y_{min}, y_{max}$].
    21122116  \end{funcdesc}
Note: See TracChangeset for help on using the changeset viewer.