Changeset 3643


Ignore:
Timestamp:
Sep 21, 2006, 12:25:58 PM (17 years ago)
Author:
ole
Message:

Manual update

Location:
anuga_core/documentation/user_manual
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • anuga_core/documentation/user_manual/anuga_user_manual.tex

    r3642 r3643  
    164164called \anuga to help simulate the impact of these hazards.
    165165
    166 The core of \anuga is the fluid dynamics module, called pyvolution,
    167 which is based on a finite-volume method for solving the shallow water
    168 wave equation.  The study area is represented by a mesh of triangular
     166The core of \anuga is the fluid dynamics module, called \code{shallow\_water},
     167which is based on a finite-volume method for solving the Shallow Water
     168Wave Equation.  The study area is represented by a mesh of triangular
    169169cells.  By solving the governing equation within each cell, water
    170170depth and horizontal momentum are tracked over time.
    171171
    172 A major capability of pyvolution is that it can model the process of
     172A major capability of \anuga is that it can model the process of
    173173wetting and drying as water enters and leaves an area.  This means
    174174that it is suitable for simulating water flow onto a beach or dry land
    175 and around structures such as buildings.  Pyvolution is also capable
     175and around structures such as buildings.  \anuga is also capable
    176176of modelling hydraulic jumps due to the ability of the finite-volume
    177177method to accommodate discontinuities in the solution.
    … …  
    13081308
    13091309%FIXME (Ole): This is also defined in a later chapter
    1310 %\declaremodule{standard}{pyvolution.domain}
     1310%\declaremodule{standard}{...domain}
    13111311
    13121312\begin{classdesc} {Domain} {source=None,
    … …  
    13251325                 processor=0,
    13261326                 numproc=1}
    1327 Module: \refmodule{pyvolution.domain}
     1327Module: \refmodule{abstract_2d_finite_volumes.domain}
    13281328
    13291329This class is used to create an instance of a data structure used to
    … …  
    13341334
    13351335\begin{funcdesc}  {pmesh\_to\_domain\_instance}{file_name, DomainClass, use_cache = False, verbose = False}
    1336 Module: \module{pyvolution.pmesh2domain}
     1336Module: \module{abstract\_2d\_finite\_volumes.pmesh2domain}
    13371337
    13381338Once the initial mesh file has been created, this function is
    … …  
    13561356
    13571357\begin{methoddesc} {set\_name}{name}
    1358     Module: \refmodule{pyvolution.domain}, page \pageref{mod:pyvolution.domain}  %\code{pyvolution.domain}
     1358    Module: \refmodule{abstract\_2d\_finite\_volumes.domain},
     1359    page \pageref{mod:domain} 
    13591360
    13601361    Assigns the name \code{name} to the domain.
    … …  
    13621363
    13631364\begin{methoddesc} {get\_name}{}
    1364     Module: \module{pyvolution.domain}
     1365    Module: \module{abstract\_2d\_finite\_volumes.domain}
    13651366
    13661367    Returns the name assigned to the domain by \code{set\_name}. If no name has been
    … …  
    13691370
    13701371\begin{methoddesc} {set\_datadir}{name}
    1371     Module: \module{pyvolution.domain}
    1372 
    1373     Specifies the directory used for SWW files, assigning it to the pathname \code{name}. The default value, before
     1372    Module: \module{abstract\_2d\_finite\_volumes.domain}
     1373
     1374    Specifies the directory used for SWW files, assigning it to the
     1375    pathname \code{name}. The default value, before
    13741376    \code{set\_datadir} has been run, is the value \code{default\_datadir}
    13751377    specified in \code{config.py}.
    … …  
    13921394
    13931395\begin{methoddesc} {get\_datadir}{}
    1394     Module: \module{pyvolution.domain}
     1396    Module: \module{abstract\_2d\_finite\_volumes.domain}
    13951397
    13961398    Returns the data directory set by \code{set\_datadir} or,
    … …  
    14011403
    14021404\begin{methoddesc} {set\_minimum_storable_height}{time=0.0}
    1403     Module: \module{pyvolution.domain}
     1405    Module: \module{shallow\_water.shallow\_water\_domain}
    14041406
    14051407    Sets the minimum depth that will be recognised when writing
    … …  
    14091411
    14101412\begin{methoddesc} {set\_time}{time=0.0}
    1411     Module: \module{pyvolution.domain}
     1413    Module: \module{abstract\_2d\_finite\_volumes.domain}
    14121414
    14131415    Sets the initial time, in seconds, for the simulation. The
    … …  
    14481450    verbose = False,
    14491451    use_cache = False}
    1450   Module: \module{pyvolution.domain}
    1451   (see also \module{pyvolution.quantity.set\_values})
     1452  Module: \module{abstract\_2d\_finite\_volumes.domain}
     1453  (see also \module{abstract\_2d\_finite\_volumes.quantity.set\_values})
    14521454
    14531455This function is used to assign values to individual quantities for a
    … …  
    15001502
    15011503\begin{funcdesc}{set_region}{tag, quantity, X, location='vertices'}
    1502   Module: \module{pyvolution.domain}
     1504  Module: \module{abstract\_2d\_finite\_volumes.domain}
    15031505 
    1504   (see also \module{pyvolution.quantity.set\_values})
     1506  (see also \module{abstract\_2d\_finite\_volumes.quantity.set\_values})
    15051507 
    15061508This function is used to assign values to individual quantities given
    … …  
    15151517This method can also be called with a list of region objects.  This is
    15161518useful for adding quantities in regions, and having one quantity
    1517 value based on another quantity. See  \module{pyvolution.region} for
     1519value based on another quantity. See  \module{abstract\_2d\_finite\_volumes.region} for
    15181520more details.
    15191521\end{funcdesc}
    … …  
    15291531                domain=None,
    15301532                verbose=False}
    1531 Module: \module{pyvolution.smf}
     1533Module: \module{shallow\_water.smf}
    15321534
    15331535This function returns a callable object representing an initial water
    … …  
    15471549    verbose = False,
    15481550    use_cache = False}
    1549 Module: \module{pyvolution.util}
     1551Module: \module{abstract\_2d\_finite\_volumes.util}
    15501552
    15511553Reads the time history of spatial data for
    … …  
    15761578    interpolation_points = None,
    15771579    verbose = False}
    1578 Module: \module{pyvolution.least\_squares}
     1580Module: \module{abstract\_2d\_finite\_volumes.least\_squares}
    15791581
    15801582Given a time series (i.e. a series of values associated with
    … …  
    16091611%[Low priority. Will be merged into set\_quantity]
    16101612
    1611 %Module:\module{pyvolution.domain}
     1613%Module:\module{abstract\_2d\_finite\_volumes.domain}
    16121614%\end{funcdesc}
    16131615
    … …  
    16271629
    16281630\begin{methoddesc}{set\_boundary}{boundary_map}
    1629 Module: \module{pyvolution.domain}
     1631Module: \module{abstract\_2d\_finite\_volumes.domain}
    16301632
    16311633This function allows you to assign a boundary object (corresponding to a
    … …  
    16391641
    16401642\begin{methoddesc} {get\_boundary\_tags}{}
    1641 Module: \module{pyvolution.mesh}
     1643Module: \module{abstract\_2d\_finite\_volumes.mesh}
    16421644
    16431645Returns a list of the available boundary tags.
    … …  
    16591661%%%
    16601662\begin{classdesc}{Transmissive\_boundary}{domain = None}
    1661 Module: \module{pyvolution.generic\_boundary\_conditions}
     1663Module: \module{abstract\_2d\_finite\_volumes.generic\_boundary\_conditions}
    16621664
    16631665A transmissive boundary returns the same conserved quantities as
    … …  
    16691671%%%
    16701672\begin{classdesc}{Dirichlet\_boundary}{conserved_quantities=None}
    1671 Module: \module{pyvolution.generic\_boundary\_conditions}
     1673Module: \module{abstract\_2d\_finite\_volumes.generic\_boundary\_conditions}
    16721674
    16731675A Dirichlet boundary returns constant values for each of conserved
    … …  
    16801682%%%
    16811683\begin{classdesc}{Time\_boundary}{domain = None, f = None}
    1682 Module: \module{pyvolution.generic\_boundary\_conditions}
     1684Module: \module{abstract\_2d\_finite\_volumes.generic\_boundary\_conditions}
    16831685
    16841686A time-dependent boundary returns values for the conserved
    … …  
    16891691%%%
    16901692\begin{classdesc}{File\_boundary}{Boundary}
    1691 Module: \module{pyvolution.generic\_boundary\_conditions}
     1693Module: \module{abstract\_2d\_finite\_volumes.generic\_boundary\_conditions}
    16921694
    16931695This method may be used if the user wishes to apply a SWW file or
    … …  
    17011703%%%
    17021704\begin{classdesc}{Transmissive\_Momentum\_Set\_Stage\_boundary}{Boundary}
    1703 Module: \module{pyvolution.shallow\_water}
     1705Module: \module{shallow\_water}
    17041706
    17051707This boundary returns same momentum conserved quantities as
    … …  
    17441746  \begin{methoddesc}{evolve}{yieldstep = None, finaltime = None, duration = None, skip_initial_step = False}
    17451747
    1746   Module: \module{pyvolution.domain}
     1748  Module: \module{abstract\_2d\_finite\_volumes.domain}
    17471749
    17481750  This function (a method of \class{domain}) is invoked once all the
    … …  
    17741776
    17751777  \begin{funcdesc}{statistics}{}
    1776   Module: \module{pyvolution.domain}
     1778  Module: \module{abstract\_2d\_finite\_volumes.domain}
    17771779
    17781780  \end{funcdesc}
    17791781
    17801782  \begin{funcdesc}{timestepping\_statistics}{}
    1781   Module: \module{pyvolution.domain}
     1783  Module: \module{abstract\_2d\_finite\_volumes.domain}
    17821784
    17831785  Returns a string of the following type for each
    … …  
    17931795
    17941796  \begin{funcdesc}{boundary\_statistics}{quantities = None, tags = None}
    1795   Module: \module{pyvolution.domain}
     1797  Module: \module{abstract\_2d\_finite\_volumes.domain}
    17961798
    17971799  Returns a string of the following type when \code{quantities = 'stage'} and \code{tags = ['top', 'bottom']}:
    … …  
    18091811
    18101812  \begin{funcdesc}{get\_quantity}{name, location='vertices', indices = None}
    1811   Module: \module{pyvolution.domain}
     1813  Module: \module{abstract\_2d\_finite\_volumes.domain}
    18121814  Allow access to individual quantities and their methods
    18131815
    … …  
    18161818
    18171819  \begin{funcdesc}{get\_values}{location='vertices', indices = None}
    1818   Module: \module{pyvolution.quantity}
     1820  Module: \module{abstract\_2d\_finite\_volumes.quantity}
    18191821
    18201822  Extract values for quantity as an array
    … …  
    18241826
    18251827  \begin{funcdesc}{get\_integral}{}
    1826   Module: \module{pyvolution.quantity}
     1828  Module: \module{abstract\_2d\_finite\_volumes.quantity}
    18271829
    18281830  Return computed integral over entire domain for this quantity
    … …  
    18481850\chapter{\anuga System Architecture}
    18491851
    1850 From pyvolution/documentation
    18511852
    18521853\section{File Formats}
    … …  
    19321933
    19331934TSH + Boundary SWW $\rightarrow$ SWW & Simulation using
    1934 \code{pyvolution}\\
     1935\code{\anuga}\\
    19351936
    19361937Polygonal mesh outline $\rightarrow$ & TSH or MSH
    … …  
    21022103            datum = 'WGS84',
    21032104            format = 'ers'}
    2104   Module: \module{pyvolution.data\_manager}
     2105  Module: \module{shallow\_water.data\_manager}
    21052106
    21062107  Takes data from an SWW file \code{basename_in} and converts it to DEM format (ASC or
    … …  
    21162117            northing_min=None, northing_max=None,
    21172118            use_cache=False, verbose=False}
    2118   Module: \module{pyvolution.data\_manager}
     2119  Module: \module{shallow\_water.data\_manager}
    21192120
    21202121  Takes DEM data (a NetCDF file representation of data from a regular Digital
    … …  
    21282129
    21292130\chapter{Basic \anuga Assumptions}
    2130 
    2131 (From pyvolution/documentation)
    21322131
    21332132
    … …  
    26982697
    26992698
    2700 \section{\module{pyvolution.general\_mesh} }
    2701 \declaremodule[pyvolution.generalmesh]{}{pyvolution.general\_mesh}
    2702 \label{mod:pyvolution.generalmesh}
    2703 
    2704 \section{\module{pyvolution.neighbour\_mesh} }
    2705 \declaremodule[pyvolution.neighbourmesh]{}{pyvolution.neighbour\_mesh}
    2706 \label{mod:pyvolution.neighbourmesh}
    2707 
    2708 \section{\module{pyvolution.domain} --- Generic module for 2D triangular domains for finite-volume computations of conservation laws}
    2709 \declaremodule{}{pyvolution.domain}
    2710 \label{mod:pyvolution.domain}
    2711 
    2712 
    2713 \section{\module{pyvolution.quantity}}
    2714 \declaremodule{}{pyvolution.quantity}
    2715 \label{mod:pyvolution.quantity}
     2699\section{\module{abstract\_2d\_finite\_volumes.general\_mesh} }
     2700\declaremodule[generalmesh]{}{general\_mesh}
     2701\label{mod:generalmesh}
     2702
     2703\section{\module{abstract\_2d\_finite\_volumes.neighbour\_mesh} }
     2704\declaremodule[neighbourmesh]{}{neighbour\_mesh}
     2705\label{mod:neighbourmesh}
     2706
     2707\section{\module{abstract\_2d\_finite\_volumes.domain} --- Generic module for 2D triangular domains for finite-volume computations of conservation laws}
     2708\declaremodule{}{domain}
     2709\label{mod:domain}
     2710
     2711
     2712\section{\module{abstract\_2d\_finite\_volumes.quantity}}
     2713\declaremodule{}{quantity}
     2714\label{mod:quantity}
    27162715
    27172716
    … …  
    27332732
    27342733
    2735 \section{\module{pyvolution.shallow\_water} --- 2D triangular domains for finite-volume
     2734\section{\module{shallow\_water} --- 2D triangular domains for finite-volume
    27362735computations of the shallow water wave equation. This module contains a specialisation
    27372736of class Domain from module domain.py consisting of methods specific to the Shallow Water
    27382737Wave Equation
    27392738}
    2740 \declaremodule[pyvolution.shallowwater]{}{pyvolution.shallow\_water}
    2741 \label{mod:pyvolution.shallowwater}
     2739\declaremodule[shallowwater]{}{shallow\_water}
     2740\label{mod:shallowwater}
    27422741
    27432742

  • anuga_core/documentation/user_manual/examples/file_function_example.py

    r3563 r3643  
    66from anuga.abstract_2d_finite_volumes.util import file_function
    77 
    8 f = file_function('bedslope.sww',
     8f = file_function('runup.sww',
    99                  quantities = ['stage',  #Quantities we want to interpolate
    1010                                'elevation',
Note: See TracChangeset for help on using the changeset viewer.