Changeset 2574


Ignore:
Timestamp:
Mar 22, 2006, 4:27:29 PM (18 years ago)
Author:
ole
Message:

From meeting with Howard

Location:
documentation/user_manual
Files:
2 edited
1 moved

Legend:

Unmodified
Added
Removed
  • documentation/user_manual/anuga_user_manual.tex

    r2560 r2574  
    179179the depth through the equation
    180180
    181 {\small \begin{verbatim}
    182 \code{stage} = \code{elevation} + \code{depth}
    183 \end{verbatim}}
     181\begin{tabular}{rcrcl}
     182  \code{stage} &=& \code{elevation} &+& \code{depth}
     183\end{tabular}
     184
    184185
    185186%\emph{[More details of the problem background]}
     
    335336
    336337The stage (the height of the water surface) is related to the
    337 elevation and the depth at any time by the equation \[\code{stage} =
    338 \code{elevation} + \code{depth}\]
     338elevation and the depth at any time by the equation
     339
     340
     341{\small \begin{verbatim}
     342    stage = elevation + depth
     343\end{verbatim}} 
     344 
    339345
    340346For this example, we simply assign a constant value to \code{stage},
     
    476482
    477483
    478 %\begin{figure}[hbt]
    479 
    480 %  \centerline{ \includegraphics[width=75mm, height=75mm]{examples/bedslope_start.eps}}
    481  
    482 %  \caption{Bedslope example viewed with Swollen}
    483 %  \label{fig:bedslopestart}
    484 %\end{figure}
    485 
    486 
    487 %\begin{figure}[hbt]
    488 
    489 %  \centerline{
    490 %    \includegraphics[width=75mm, height=75mm]{examples/bedslope_during.eps}
    491 %    \includegraphics[width=75mm, height=75mm]{examples/bedslope_end.eps}
    492 %   }   
    493  
    494 %  \caption{Bedslope example viewed with Swollen}
    495 %  \label{fig:bedslope2}
    496 %\end{figure}
     484\begin{figure}[hbt]
     485
     486  \centerline{ \includegraphics[width=75mm, height=75mm]{examples/bedslopestart.eps}}
     487 
     488  \caption{Bedslope example viewed with Swollen}
     489  \label{fig:bedslopestart}
     490\end{figure}
     491
     492
     493\begin{figure}[hbt]
     494
     495  \centerline{
     496    \includegraphics[width=75mm, height=75mm]{examples/bedslopeduring.eps}
     497    \includegraphics[width=75mm, height=75mm]{examples/bedslopeend.eps}
     498   }   
     499 
     500  \caption{Bedslope example viewed with Swollen}
     501  \label{fig:bedslope2}
     502\end{figure}
    497503
    498504
     
    571577
    572578
    573 %\begin{figure}[hbt]
    574 
    575 
    576  
    577 %  \caption{Mesh points are created inside the polygon}
    578 %  \label{fig:pentagon} 
    579 %\end{figure}
     579\begin{figure}[hbt]
     580
     581
     582 
     583  \caption{Mesh points are created inside the polygon}
     584  \label{fig:pentagon} 
     585\end{figure}
    580586
    581587Boundary tags are not restricted to \code{`left'}, \code{`right'},
     
    594600resolution. See Figure \ref{fig:interior meshes}.
    595601
    596 %\begin{figure}[hbt]
     602\begin{figure}[hbt]
    597603
    598604
    599605 
    600 %  \caption{Interior meshes with individual resolution}
    601 %  \label{fig:interior meshes} 
    602 %\end{figure}
     606  \caption{Interior meshes with individual resolution}
     607  \label{fig:interior meshes} 
     608\end{figure}
    603609
    604610In its general form, \code{pmesh} takes for its input a bounding
     
    931937\code{pyvolution.quantity.set_values})
    932938
    933 This function is used to associate quantities with a domain. It is very flexible and can be
     939This function is used to assign values to individual quantities for a domain. It is very flexible and can be
    934940used with many data types: a statement of the form \code{domain.set\_quantity{name, x}} can
    935941be used to define a quantity having the name \code{name}, where the other argument \code{x} can
     
    937943
    938944\begin{itemize}
    939 \item a number
    940 \item a list of numbers
    941 \item a Numeric array
    942 \item a function (e.g. see the samples introduced in Chapter 2)
     945\item a number in which case all vertices in the mesh gets that for the quantity in question.
     946\item a list of numbers or a Numeric array ordered the same way as the mesh vertices.
     947\item a function (e.g.\ see the samples introduced in Chapter 2)
    943948\item an expression composed of other quantities and numbers, arrays, lists (for
    944949example, a linear combination of quantities)
    945950\item the name of a file from which the data can be read
    946 \item a geospatial dataset
     951\item a geospatial dataset (See ?????)
    947952\end{itemize}
    948953
     
    14121417The output generated by \anuga may be viewed by means of the visualisation tool \code{swollen},
    14131418which takes the \code{sww} file output by \anuga and creates a visual representation of the data.
    1414 Examples may be seen in Figures XX and YY. To view an \code{sww} file with \code{swollen} in the
     1419Examples may be seen in Figures \ref{fig:bedslopestart} and \ref{fig:bedslope2}.
     1420To view an \code{sww} file with \code{swollen} in the
    14151421Windows environment, you can simply drag the icon representing the file over an icon on the desktop
    14161422for the \code{swollen} executable file (or a shortcut to it). Alternatively, you can operate \code{swollen}
     
    14781484\end{tabular}
    14791485
    1480 \section{utilities/polygons} Could do now.
     1486\section{utilities/polygons}
    14811487
    14821488  \begin{classdesc}{Polygon_function}{regions, default = 0.0, geo_reference = None}
     
    14951501 
    14961502  \begin{funcdesc}{populate_polygon}{polygon, number_of_points, seed = None, exclude = None}
    1497   \indexedcode{populate_polygon}
    14981503  Module: \code{utilities.polygon} 
    14991504 
     
    15031508 
    15041509  \begin{funcdesc}{point_in_polygon}{polygon, delta=1e-8}
    1505   \indexedcode{point_in_polygon}
    15061510  Module: \code{utilities.polygon} 
    15071511 
     
    15121516 
    15131517  \begin{funcdesc}{inside_polygon}{points, polygon, closed = True, verbose = False}
    1514   \indexedcode{inside_polygon}
    15151518  Module: \code{utilities.polygon} 
    15161519 
     
    15261529 
    15271530  \begin{funcdesc}{outside_polygon}{points, polygon, closed = True, verbose = False}
    1528   \indexedcode{outside_polygon}
    15291531  Module: \code{utilities.polygon} 
    15301532 
  • documentation/user_manual/definitions.tex

    r2468 r2574  
    88\newcommand{\anuga}{\textbf{ANUGA}$^{\scriptscriptstyle \copyright}$ v1.0\ }
    99%\newcommand{\anugav}[1]{\textbf{ANUGA}$^\copyright$ V#1\ }
     10
     11%Used with \code.
     12%
     13\newenvironment{displayedcode}
     14   {\begin{tabular}{p{0.41cm}l}}
     15   {\end{tabular}} 
Note: See TracChangeset for help on using the changeset viewer.