Changeset 2384

Timestamp:

Feb 13, 2006, 2:37:16 PM (19 years ago)

Author:

ole

Message:

Styles and copyright

Location:

documentation/user_manual

Files:

• anuga_user_manual.tex (modified) (6 diffs)
• copyright.tex (modified) (2 diffs)
• definitions.tex (added)

documentation/user_manual/anuga_user_manual.tex

@@ -7 +7 @@
 
 
-\newcommand{\indexedcode}[1]{\code{#1}\index{#1}}
-\newcommand{\indexedbold}[1]{\textbf{#1}\index{#1}}
+\input{definitions}
+
         
 \documentclass{manual}
 
-\title{AnuGA User Manual}
+\title{\anuga User Manual}
 \author{Howard Silcock, Ole Nielsen, Duncan Gray, Jane Sexton}
 
@@ -56 +56 @@
 
 \noindent
-\textbf{AnuGA}\index{AnuGA} is a hydrodynamic modelling tool that
+\anuga\index{AnuGA} is a hydrodynamic modelling tool that
 allows users to model realistic flow problems in complex
 geometries. Examples include dam breaks or the effects of natural
@@ -63 +63 @@
 The user must specify a study area represented by a mesh of triangular
 cells, the topography and bathymetry, frictional resistance, initial
-values for water level (called \emph{stage}\index{stage} within Anuga), 
+values for water level (called \emph{stage}\index{stage} within \anuga), 
 boundary
 conditions and forces such as windstress or pressure gradients if
 applicable.
 
-Anuga tracks the evolution of water depth and horizontal momentum
+\anuga tracks the evolution of water depth and horizontal momentum
 within each cell over time by solving the shallow water wave equation
 governing equation using a finite-volume method.
 
-Anuga cannot model details of breaking waves, flow under ceilings such
+\anuga cannot model details of breaking waves, flow under ceilings such
 as pipes, turbulence and vortices, vertical convection or viscous
 flows.
 
-Anuga also incorporates a mesh generator, called \code{pmesh}, that
+\anuga also incorporates a mesh generator, called \code{pmesh}, that
 allows the user to set up the geometry of the problem interactively as
 well as tools for interpolation and surface fitting, and a number of
 auxiliary tools for visualising and interrogating the model output.
 
-Most AnuGA components are written in the object-oriented programming
+Most \anuga components are written in the object-oriented programming
 language Python and most users will interact with Anuga by writing
-small Python programs based on the Anuga library
+small Python programs based on the \anuga library
 functions. Computationally intensive components are written for
 efficiency in C routines working directly with the Numerical Python
@@ -123 +123 @@
 
 \begin{itemize}
-  \item Background (What Anuga does)
+  \item Background (What \anuga does)
   \item A \emph{Getting Started} section
   \item Anuga's overall architecture, components and file formats
@@ -134 +134 @@
 
 This section is designed to assist the reader to get started with
-\textbf{AnuGA} by working through a simple example. What follows
+\anuga by working through a simple example. What follows
 is a discussion of the structure and operation of the file
 \code{bedslope.py}, with just enough detail to allow the reader
@@ -261 +261 @@
 
 The function \code{rectangular} is imported from a module
-\code{mesh\_factory} defined elsewhere. (\textbf{AnuGA} also
+\code{mesh\_factory} defined elsewhere. \anuga also
 contains several other schemes that can be used for setting up
 meshes, but we shall not discuss these now.) The above assignment

documentation/user_manual/copyright.tex

@@ -68 +68 @@
 \begin{center}
 
-  \vspace{0.5in}
-   ANUGA Version 1.0
+  %\vspace{0.5in}
+   \anuga
 
-   Manual made with \LaTeX
+   Manual typeset with \LaTeX
 
 \end{center}
@@ -77 +77 @@
   \vspace{0.5in}
   
-Credits:
+\textbf{Credits}:
 \begin{itemize}
-\item ANUGA version 1.$x$ was written by Stephen Roberts, 
+\item \anuga was developed by Stephen Roberts, 
   Ole Nielsen, Duncan Gray, .....
 \end{itemize}
 
-  \vspace{0.5in}
 
-License:
+
+\textbf{License}:
 \begin{itemize}
-\item ANUGA is freely available and distributed under the terms of the GNU General Public Licence.\index{{\GSK}!licence|textit}
+\item \anuga is freely available and distributed under the terms of the GNU General Public Licence.\index{ANUGA!licence|textit}
 \end{itemize}
 
-  \vspace{0.5in}
+
   
-Acknowledgments:
+\textbf{Acknowledgments}:
 \begin{itemize}
 \item Christopher Zoppou, Linda Stals, Matt Hardy, Jack Jakeman, John .. who contributed to this project at various times.