Changeset 2675


Ignore:
Timestamp:
Apr 6, 2006, 4:53:43 PM (18 years ago)
Author:
ole
Message:

modules

File:
1 edited

Legend:

Unmodified
Added
Removed
  • documentation/user_manual/anuga_user_manual.tex

    r2672 r2675  
    189189
    190190In outline, \file{bedslopephysical.py} performs the following steps:
    191 
     191                                   
    192192\begin{enumerate}
    193193
     
    270270This uses a Python class \class{Domain}, imported from
    271271\module{shallow\_water}, which is an extension of a more generic
    272 class of the same name in the module \module{domain}, and inherits
     272class of the same name in the module \refmodule{pyvolution.domain}
     273(page \pageref{mod:pyvolution.domain}),
     274and inherits
    273275some methods from the generic class but has others specific to the
    274276shallow-water scenarios in which it is used. Specific options for
     
    634636file, with extension \code{.tsh}. In the present case, the binary
    635637file format \code{.msh} is used. See Section \ref{sec:file formats}
    636 (p. \pageref{sec:file formats}) for more on file formats.)
     638(page \pageref{sec:file formats}) for more on file formats.)
    637639\code{pmesh} assigns a name to the file by appending the extension
    638640\code{.msh} to the name specified in the input file
     
    905907the user specifies a list of boundary tags, one for each edge of the bounding
    906908polygon.
    907 
    908 This function is used to create a triangular mesh within a specified
    909 region, suitable for use with \anuga. The user specifies a polygon
    910 (the \code{bounding polygon}) that serves as the boundary for the
    911 region as well as an upper bound (\code{maximum\_triangle\_area},
    912 also referred to as the \emph{resolution}) for the areas of the
    913 inscribed triangles. The function uses a random process to compute a
    914 mesh within the bounding polygon and returns a meshfile, in the form
    915 of a
    916909\end{funcdesc}
    917910
     
    938931
    939932\begin{funcdesc} {set\_name}{name}
    940     Module: \code{pyvolution.domain}
     933    Module: \refmodule{pyvolution.domain}, page \pageref{mod:pyvolution.domain}  %\code{pyvolution.domain}
    941934
    942935    Assigns the name \code{name} to the domain.
     
    13181311  \end{funcdesc}
    13191312
     1313 
     1314 
     1315 
     1316 
    13201317%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    13211318%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
     
    17091706\end{itemize}
    17101707
     1708
     1709\chapter{Modules available in \anuga}
     1710
     1711
     1712\section{\module{pyvolution.general\_mesh} }
     1713\declaremodule[pyvolution.generalmesh]{}{pyvolution.general\_mesh}
     1714\label{mod:pyvolution.generalmesh}
     1715
     1716\section{\module{pyvolution.mesh} }
     1717\declaremodule{}{pyvolution.mesh}
     1718\label{mod:pyvolution.mesh}
     1719
     1720\section{\module{pyvolution.domain} --- Generic module for 2D triangular domains for finite-volume computations of conservation laws}
     1721\declaremodule{}{pyvolution.domain}
     1722\label{mod:pyvolution.domain}
     1723
     1724
     1725\section{\module{pyvolution.quantity}}
     1726\declaremodule{}{pyvolution.quantity}
     1727\label{mod:pyvolution.quantity}
     1728
     1729
     1730\section{\module{pyvolution.shallow\_water} --- 2D triangular domains for finite-volume computations of the shallow water wave equation. This module contains a specialisation of class Domain from module domain.py consisting of methods specific to the Shallow Water Wave Equation
     1731}
     1732\declaremodule[pyvolution.shallowwater]{}{pyvolution.shallow\_water}
     1733\label{mod:pyvolution.shallowwater}
     1734
     1735
     1736
     1737
    17111738%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    17121739
Note: See TracChangeset for help on using the changeset viewer.