Changeset 3643
- Timestamp:
- Sep 21, 2006, 12:25:58 PM (17 years ago)
- Location:
- anuga_core/documentation/user_manual
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
anuga_core/documentation/user_manual/anuga_user_manual.tex
r3642 r3643 164 164 called \anuga to help simulate the impact of these hazards. 165 165 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 water168 wave equation. The study area is represented by a mesh of triangular166 The core of \anuga is the fluid dynamics module, called \code{shallow\_water}, 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 169 169 cells. By solving the governing equation within each cell, water 170 170 depth and horizontal momentum are tracked over time. 171 171 172 A major capability of pyvolutionis that it can model the process of172 A major capability of \anuga is that it can model the process of 173 173 wetting and drying as water enters and leaves an area. This means 174 174 that it is suitable for simulating water flow onto a beach or dry land 175 and around structures such as buildings. Pyvolutionis also capable175 and around structures such as buildings. \anuga is also capable 176 176 of modelling hydraulic jumps due to the ability of the finite-volume 177 177 method to accommodate discontinuities in the solution. … … 1308 1308 1309 1309 %FIXME (Ole): This is also defined in a later chapter 1310 %\declaremodule{standard}{ pyvolution.domain}1310 %\declaremodule{standard}{...domain} 1311 1311 1312 1312 \begin{classdesc} {Domain} {source=None, … … 1325 1325 processor=0, 1326 1326 numproc=1} 1327 Module: \refmodule{ pyvolution.domain}1327 Module: \refmodule{abstract_2d_finite_volumes.domain} 1328 1328 1329 1329 This class is used to create an instance of a data structure used to … … 1334 1334 1335 1335 \begin{funcdesc} {pmesh\_to\_domain\_instance}{file_name, DomainClass, use_cache = False, verbose = False} 1336 Module: \module{ pyvolution.pmesh2domain}1336 Module: \module{abstract\_2d\_finite\_volumes.pmesh2domain} 1337 1337 1338 1338 Once the initial mesh file has been created, this function is … … 1356 1356 1357 1357 \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} 1359 1360 1360 1361 Assigns the name \code{name} to the domain. … … 1362 1363 1363 1364 \begin{methoddesc} {get\_name}{} 1364 Module: \module{ pyvolution.domain}1365 Module: \module{abstract\_2d\_finite\_volumes.domain} 1365 1366 1366 1367 Returns the name assigned to the domain by \code{set\_name}. If no name has been … … 1369 1370 1370 1371 \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 1374 1376 \code{set\_datadir} has been run, is the value \code{default\_datadir} 1375 1377 specified in \code{config.py}. … … 1392 1394 1393 1395 \begin{methoddesc} {get\_datadir}{} 1394 Module: \module{ pyvolution.domain}1396 Module: \module{abstract\_2d\_finite\_volumes.domain} 1395 1397 1396 1398 Returns the data directory set by \code{set\_datadir} or, … … 1401 1403 1402 1404 \begin{methoddesc} {set\_minimum_storable_height}{time=0.0} 1403 Module: \module{ pyvolution.domain}1405 Module: \module{shallow\_water.shallow\_water\_domain} 1404 1406 1405 1407 Sets the minimum depth that will be recognised when writing … … 1409 1411 1410 1412 \begin{methoddesc} {set\_time}{time=0.0} 1411 Module: \module{ pyvolution.domain}1413 Module: \module{abstract\_2d\_finite\_volumes.domain} 1412 1414 1413 1415 Sets the initial time, in seconds, for the simulation. The … … 1448 1450 verbose = False, 1449 1451 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}) 1452 1454 1453 1455 This function is used to assign values to individual quantities for a … … 1500 1502 1501 1503 \begin{funcdesc}{set_region}{tag, quantity, X, location='vertices'} 1502 Module: \module{ pyvolution.domain}1504 Module: \module{abstract\_2d\_finite\_volumes.domain} 1503 1505 1504 (see also \module{ pyvolution.quantity.set\_values})1506 (see also \module{abstract\_2d\_finite\_volumes.quantity.set\_values}) 1505 1507 1506 1508 This function is used to assign values to individual quantities given … … 1515 1517 This method can also be called with a list of region objects. This is 1516 1518 useful for adding quantities in regions, and having one quantity 1517 value based on another quantity. See \module{ pyvolution.region} for1519 value based on another quantity. See \module{abstract\_2d\_finite\_volumes.region} for 1518 1520 more details. 1519 1521 \end{funcdesc} … … 1529 1531 domain=None, 1530 1532 verbose=False} 1531 Module: \module{ pyvolution.smf}1533 Module: \module{shallow\_water.smf} 1532 1534 1533 1535 This function returns a callable object representing an initial water … … 1547 1549 verbose = False, 1548 1550 use_cache = False} 1549 Module: \module{ pyvolution.util}1551 Module: \module{abstract\_2d\_finite\_volumes.util} 1550 1552 1551 1553 Reads the time history of spatial data for … … 1576 1578 interpolation_points = None, 1577 1579 verbose = False} 1578 Module: \module{ pyvolution.least\_squares}1580 Module: \module{abstract\_2d\_finite\_volumes.least\_squares} 1579 1581 1580 1582 Given a time series (i.e. a series of values associated with … … 1609 1611 %[Low priority. Will be merged into set\_quantity] 1610 1612 1611 %Module:\module{ pyvolution.domain}1613 %Module:\module{abstract\_2d\_finite\_volumes.domain} 1612 1614 %\end{funcdesc} 1613 1615 … … 1627 1629 1628 1630 \begin{methoddesc}{set\_boundary}{boundary_map} 1629 Module: \module{ pyvolution.domain}1631 Module: \module{abstract\_2d\_finite\_volumes.domain} 1630 1632 1631 1633 This function allows you to assign a boundary object (corresponding to a … … 1639 1641 1640 1642 \begin{methoddesc} {get\_boundary\_tags}{} 1641 Module: \module{ pyvolution.mesh}1643 Module: \module{abstract\_2d\_finite\_volumes.mesh} 1642 1644 1643 1645 Returns a list of the available boundary tags. … … 1659 1661 %%% 1660 1662 \begin{classdesc}{Transmissive\_boundary}{domain = None} 1661 Module: \module{ pyvolution.generic\_boundary\_conditions}1663 Module: \module{abstract\_2d\_finite\_volumes.generic\_boundary\_conditions} 1662 1664 1663 1665 A transmissive boundary returns the same conserved quantities as … … 1669 1671 %%% 1670 1672 \begin{classdesc}{Dirichlet\_boundary}{conserved_quantities=None} 1671 Module: \module{ pyvolution.generic\_boundary\_conditions}1673 Module: \module{abstract\_2d\_finite\_volumes.generic\_boundary\_conditions} 1672 1674 1673 1675 A Dirichlet boundary returns constant values for each of conserved … … 1680 1682 %%% 1681 1683 \begin{classdesc}{Time\_boundary}{domain = None, f = None} 1682 Module: \module{ pyvolution.generic\_boundary\_conditions}1684 Module: \module{abstract\_2d\_finite\_volumes.generic\_boundary\_conditions} 1683 1685 1684 1686 A time-dependent boundary returns values for the conserved … … 1689 1691 %%% 1690 1692 \begin{classdesc}{File\_boundary}{Boundary} 1691 Module: \module{ pyvolution.generic\_boundary\_conditions}1693 Module: \module{abstract\_2d\_finite\_volumes.generic\_boundary\_conditions} 1692 1694 1693 1695 This method may be used if the user wishes to apply a SWW file or … … 1701 1703 %%% 1702 1704 \begin{classdesc}{Transmissive\_Momentum\_Set\_Stage\_boundary}{Boundary} 1703 Module: \module{ pyvolution.shallow\_water}1705 Module: \module{shallow\_water} 1704 1706 1705 1707 This boundary returns same momentum conserved quantities as … … 1744 1746 \begin{methoddesc}{evolve}{yieldstep = None, finaltime = None, duration = None, skip_initial_step = False} 1745 1747 1746 Module: \module{ pyvolution.domain}1748 Module: \module{abstract\_2d\_finite\_volumes.domain} 1747 1749 1748 1750 This function (a method of \class{domain}) is invoked once all the … … 1774 1776 1775 1777 \begin{funcdesc}{statistics}{} 1776 Module: \module{ pyvolution.domain}1778 Module: \module{abstract\_2d\_finite\_volumes.domain} 1777 1779 1778 1780 \end{funcdesc} 1779 1781 1780 1782 \begin{funcdesc}{timestepping\_statistics}{} 1781 Module: \module{ pyvolution.domain}1783 Module: \module{abstract\_2d\_finite\_volumes.domain} 1782 1784 1783 1785 Returns a string of the following type for each … … 1793 1795 1794 1796 \begin{funcdesc}{boundary\_statistics}{quantities = None, tags = None} 1795 Module: \module{ pyvolution.domain}1797 Module: \module{abstract\_2d\_finite\_volumes.domain} 1796 1798 1797 1799 Returns a string of the following type when \code{quantities = 'stage'} and \code{tags = ['top', 'bottom']}: … … 1809 1811 1810 1812 \begin{funcdesc}{get\_quantity}{name, location='vertices', indices = None} 1811 Module: \module{ pyvolution.domain}1813 Module: \module{abstract\_2d\_finite\_volumes.domain} 1812 1814 Allow access to individual quantities and their methods 1813 1815 … … 1816 1818 1817 1819 \begin{funcdesc}{get\_values}{location='vertices', indices = None} 1818 Module: \module{ pyvolution.quantity}1820 Module: \module{abstract\_2d\_finite\_volumes.quantity} 1819 1821 1820 1822 Extract values for quantity as an array … … 1824 1826 1825 1827 \begin{funcdesc}{get\_integral}{} 1826 Module: \module{ pyvolution.quantity}1828 Module: \module{abstract\_2d\_finite\_volumes.quantity} 1827 1829 1828 1830 Return computed integral over entire domain for this quantity … … 1848 1850 \chapter{\anuga System Architecture} 1849 1851 1850 From pyvolution/documentation1851 1852 1852 1853 \section{File Formats} … … 1932 1933 1933 1934 TSH + Boundary SWW $\rightarrow$ SWW & Simulation using 1934 \code{ pyvolution}\\1935 \code{\anuga}\\ 1935 1936 1936 1937 Polygonal mesh outline $\rightarrow$ & TSH or MSH … … 2102 2103 datum = 'WGS84', 2103 2104 format = 'ers'} 2104 Module: \module{ pyvolution.data\_manager}2105 Module: \module{shallow\_water.data\_manager} 2105 2106 2106 2107 Takes data from an SWW file \code{basename_in} and converts it to DEM format (ASC or … … 2116 2117 northing_min=None, northing_max=None, 2117 2118 use_cache=False, verbose=False} 2118 Module: \module{ pyvolution.data\_manager}2119 Module: \module{shallow\_water.data\_manager} 2119 2120 2120 2121 Takes DEM data (a NetCDF file representation of data from a regular Digital … … 2128 2129 2129 2130 \chapter{Basic \anuga Assumptions} 2130 2131 (From pyvolution/documentation)2132 2131 2133 2132 … … 2698 2697 2699 2698 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} 2716 2715 2717 2716 … … 2733 2732 2734 2733 2735 \section{\module{ pyvolution.shallow\_water} --- 2D triangular domains for finite-volume2734 \section{\module{shallow\_water} --- 2D triangular domains for finite-volume 2736 2735 computations of the shallow water wave equation. This module contains a specialisation 2737 2736 of class Domain from module domain.py consisting of methods specific to the Shallow Water 2738 2737 Wave Equation 2739 2738 } 2740 \declaremodule[ pyvolution.shallowwater]{}{pyvolution.shallow\_water}2741 \label{mod: pyvolution.shallowwater}2739 \declaremodule[shallowwater]{}{shallow\_water} 2740 \label{mod:shallowwater} 2742 2741 2743 2742 -
anuga_core/documentation/user_manual/examples/file_function_example.py
r3563 r3643 6 6 from anuga.abstract_2d_finite_volumes.util import file_function 7 7 8 f = file_function(' bedslope.sww',8 f = file_function('runup.sww', 9 9 quantities = ['stage', #Quantities we want to interpolate 10 10 'elevation',
Note: See TracChangeset
for help on using the changeset viewer.