Changeset 5508


Ignore:
Timestamp:
Jul 16, 2008, 12:50:05 PM (11 years ago)
Author:
ole
Message:

Minor fixes in the manual

File:
1 edited

Legend:

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

    r5507 r5508  
    494494The reader will probably appreciate that this capability to
    495495incorporate expressions into statements using \method{set\_quantity}
    496 greatly expands its power.) See Section \ref{sec:Initial Conditions} for more
     496greatly expands its power.) See Section \ref{sec:initial conditions} for more
    497497details.
    498498
     
    13831383
    13841384\begin{itemize}
    1385     \item Establishing the Mesh
    1386     \item Initialising the Domain
    1387     \item Specifying the Quantities
    1388     \item Initial Conditions
    1389     \item Boundary Conditions
    1390     \item Forcing Functions
    1391     \item Evolution
     1385    \item Establishing the Mesh: Section \ref{sec:establishing the mesh}
     1386    \item Initialising the Domain: Section \ref{sec:initialising the domain}
     1387    \item Specifying the Quantities: Section \ref{sec:quantitis}
     1388    \item Initial Conditions: Section \ref{sec:initial conditions}
     1389    \item Boundary Conditions: Section \ref{sec:boundary conditions}
     1390    \item Forcing Terms: Section \ref{sec:forcing terms}
     1391    \item Evolution: Section \ref{sec:evolution}
    13921392\end{itemize}
    13931393
     
    14501450%\end{center}
    14511451
    1452 \section{Mesh Generation}
    1453 
     1452\section{Mesh Generation}\index{Mesh!generation}
     1453\label{sec:establishing the mesh}
    14541454Before discussing the part of the interface relating to mesh
    14551455generation, we begin with a description of a simple example of a
     
    17221722
    17231723%%%%%%
    1724 \section{Initialising the Domain}
     1724\section{Initialising the Domain}\index{Initialising the Domain}
     1725\label{sec:initialising the domain}
    17251726
    17261727%Include description of the class Domain and the module domain.
     
    19431944
    19441945%%%%%%
    1945 \section{Initial Conditions}
    1946 \label{sec:Initial Conditions}
     1946\section{Initial Conditions}\index{Initial Conditions}
     1947\label{sec:initial conditions}
    19471948In standard usage of partial differential equations, initial conditions
    19481949refers to the values associated to the system variables (the conserved
     
    21682169%%%%%%
    21692170\section{Boundary Conditions}\index{boundary conditions}
     2171\label{sec:boundary conditions}
    21702172
    21712173\anuga provides a large number of predefined boundary conditions,
     
    22942296
    22952297
    2296 \section{Forcing Terms}
    2297 \label{forcing terms}
     2298\section{Forcing Terms}\index{Forcing terms}
     2299\label{sec:forcing terms}
    22982300
    22992301\anuga provides a number of predefined forcing functions to be used with simulations.
     
    23012303\code{domain.forcing\_terms} and have them affect the model.
    23022304 
    2303 Currently, predifiend forcing terms are
     2305Currently, predefined forcing terms are
    23042306
    23052307\begin{funcdesc}{General\_forcing}{}
     
    23242326  Note specifying both center, radius and polygon will cause an exception to be thrown.
    23252327
    2326    
     2328  \bigskip 
    23272329  Example:
    23282330  {\scriptsize \begin{verbatim}
    2329         xmom = General_forcing(domain, 'xmomentum', polygon=P)
    2330         ymom = General_forcing(domain, 'ymomentum', polygon=P)
    2331 
    2332         xmom.rate = f
    2333         ymom.rate = g
     2331    P = [[x0, y0], [x1, y0], [x1, y1], [x0, y1]] # Square polygon
    23342332 
    2335         domain.forcing_terms.append(xmom)
    2336         domain.forcing_terms.append(ymom)       
     2333    xmom = General_forcing(domain, 'xmomentum', polygon=P)
     2334    ymom = General_forcing(domain, 'ymomentum', polygon=P)
     2335
     2336    xmom.rate = f
     2337    ymom.rate = g
     2338 
     2339    domain.forcing_terms.append(xmom)
     2340    domain.forcing_terms.append(ymom)   
    23372341  \end{verbatim}}
    23382342  Here, \code{f}, \code{g} are assumed to be defined as functions of time providing a time dependent rate of change for xmomentum and ymomentum respectively.
    2339   P is assumed to be polygon, specified as a list of points, e.g. a square \code{P = [[x0, y0], [x1, y0], [x1, y1], [x0, y1]]}.
     2343  P is assumed to be polygon, specified as a list of points.
    23402344 
    23412345\end{funcdesc}
     
    23642368  \end{itemize}
    23652369
    2366    
     2370  \bigskip     
    23672371  Example:
    23682372  {\scriptsize \begin{verbatim}
     
    24002404  \end{itemize}
    24012405 
     2406  \bigskip   
    24022407  Example:
    24032408  {\scriptsize \begin{verbatim}
     
    24392444  The user can specify different culvert routines. Hower ANUGA currently specifies one, namely the \code{boyd\_generalised\_culvert\_model} as used in the example below.
    24402445     
     2446  \bigskip       
    24412447  Example:
    24422448  {\scriptsize \begin{verbatim}
     
    24762482
    24772483\section{Evolution}\index{evolution}
     2484\label{sec:evolution}
    24782485
    24792486  \begin{methoddesc}{evolve}{yieldstep = None, finaltime = None, duration = None, skip_initial_step = False}
Note: See TracChangeset for help on using the changeset viewer.