Changeset 2720


Ignore:
Timestamp:
Apr 18, 2006, 8:42:57 AM (19 years ago)
Author:
howard
Message:

Added some material on file formats

File:
1 edited

Legend:

Unmodified
Added
Removed

  • documentation/user_manual/anuga_user_manual.tex

    r2717 r2720  
    370370
    371371{\small \begin{verbatim}
    372     h = 0.05 \# Constant depth
     372    h = 0.05 # Constant depth
    373373    domain.set_quantity('stage', expression = 'elevation + %f' %h)
    374374\end{verbatim}}
    … …  
    895895                             mesh_geo_reference=None,
    896896                             minimum_triangle_angle=28.0}
    897 Module: \code{pmesh.mesh\_interface}
     897Module: \module{pmesh.mesh\_interface}
    898898
    899899
    … …  
    911911
    912912\begin{funcdesc}  {Mesh}{}
    913 Module: \code{pmesh.mesh}
     913Module: \module{pmesh.mesh}
    914914
    915915% Translate following into layman's language
    … …  
    922922\begin{funcdesc}  {add_region_from_polygon}{self, polygon, tags=None,
    923923                                max_triangle_area=None, geo_reference=None}
    924 Module: \code{pmesh.mesh.Mesh}
     924Module: \module{pmesh.mesh.Mesh}
    925925
    926926% Translate following into layman's language
    … …  
    933933\begin{funcdesc}  {add_hole_from_polygon}{self, polygon, tags=None,
    934934    geo_reference=None}
    935 Module: \code{pmesh.mesh.Mesh}
     935Module: \module{pmesh.mesh.Mesh}
    936936
    937937% Translate following into layman's language
    … …  
    947947                      minimum_triangle_angle=28.0,
    948948                      verbose=False}
    949 Module: \code{pmesh.mesh.Mesh}
     949Module: \module{pmesh.mesh.Mesh}
    950950
    951951% Translate following into layman's language
    … …  
    957957
    958958\begin{funcdesc}  {export_mesh_file}{self,ofile}
    959 Module: \code{pmesh.mesh.Mesh}
     959Module: \module{pmesh.mesh.Mesh}
    960960
    961961% Translate following into layman's language
    … …  
    969969
    970970\begin{funcdesc}  {pmesh\_to\_domain\_instance}{file_name, DomainClass, use_cache = False, verbose = False}
    971 Module: \code{pyvolution.pmesh2domain}
     971Module: \module{pyvolution.pmesh2domain}
    972972
    973973Once the initial mesh file has been created, this function is applied
    … …  
    978978\code{file\_name} is the name of the mesh file to be converted,
    979979including the extension. \code{DomainClass} is the class to be
    980 returned, which must be a subclass of \code{Domain} having the same
    981 interface as \code{Domain}---in practice, it can usually be set
    982 simply to \code{Domain}.
     980returned, which must be a subclass of \class{Domain} having the same
     981interface as \class{Domain}---in practice, it can usually be set
     982simply to \class{Domain}.
    983983\end{funcdesc}
    984984
    … …  
    993993
    994994\begin{funcdesc} {get\_name}{}
    995     Module: \code{pyvolution.domain}
     995    Module: \module{pyvolution.domain}
    996996
    997997    Returns the name assigned to the domain by \code{set_name}. If no name has been
    … …  
    10001000
    10011001\begin{funcdesc} {set\_datadir}{name}
    1002     Module: \code{pyvolution.domain}
     1002    Module: \module{pyvolution.domain}
    10031003
    10041004    Specifies the directory used for data, assigning it to the pathname \code{name}. The default value, before
    … …  
    10231023
    10241024\begin{funcdesc} {get_datadir}{}
    1025     Module: \code{pyvolution.domain}
     1025    Module: \module{pyvolution.domain}
    10261026
    10271027    Returns the data directory set by \code{set\_datadir} or, if \code{set\_datadir} has not
    … …  
    10311031
    10321032\begin{funcdesc} {set_time}{time=0.0}
    1033     Module: \code{pyvolution.domain}
     1033    Module: \module{pyvolution.domain}
    10341034
    10351035    Sets the initial time, in seconds, for the simulation. The
    … …  
    10561056    verbose = False,
    10571057    use_cache = False}
    1058   Module: \code{pyvolution.domain}
    1059   (see also \code{pyvolution.quantity.set_values})
     1058  Module: \module{pyvolution.domain}
     1059  (see also \module{pyvolution.quantity.set_values})
    10601060
    10611061This function is used to assign values to individual quantities for a
    … …  
    11361136                  verbose = False,
    11371137                  use_cache = False}
    1138 Module: \code{pyvolution.util}
     1138Module: \module{pyvolution.util}
    11391139
    11401140Reads the time history of spatial data from NetCDF file and returns
    … …  
    11591159                 interpolation_points = None,
    11601160                 verbose = False}
    1161 Module: \code{pyvolution.least\_squares}
     1161Module: \module{pyvolution.least\_squares}
    11621162
    11631163Given a time series, either as a sequence of numbers or
    … …  
    11911191[Low priority. Will be merged into set\_quantity]
    11921192
    1193 Module:\code{pyvolution.domain}
     1193Module:\module{pyvolution.domain}
    11941194\end{funcdesc}
    11951195
    … …  
    12091209
    12101210\begin{funcdesc}{set\_boundary}{boundary_map}
    1211 Module: \code{pyvolution.domain}
     1211Module: \module{pyvolution.domain}
    12121212
    12131213This function allows you to assign a boundary object (corresponding to a
    … …  
    12211221
    12221222\begin{funcdesc} {get_boundary_tags}{}
    1223 Module: \code{pyvolution.mesh}
     1223Module: \module{pyvolution.mesh}
    12241224\end{funcdesc}
    12251225
    … …  
    12281228
    12291229\begin{classdesc}{Reflective_boundary}{Boundary}
    1230 Module: \code{pyvolution.shallow\_water}
     1230Module: \module{pyvolution.shallow\_water}
    12311231
    12321232Reflective boundary returns same conserved quantities as those present in
    … …  
    12391239%%%
    12401240\begin{classdesc}{Transmissive_boundary}{domain = None}
    1241 Module: \code{pyvolution.generic\_boundary\_conditions}
     1241Module: \module{pyvolution.generic\_boundary\_conditions}
    12421242
    12431243A transmissive boundary returns the same conserved quantities as
    … …  
    12491249%%%
    12501250\begin{classdesc}{Dirichlet_boundary}{conserved_quantities=None}
    1251 Module: \code{pyvolution.generic\_boundary\_conditions}
     1251Module: \module{pyvolution.generic\_boundary\_conditions}
    12521252
    12531253A Dirichlet boundary returns constant values for the conserved
    … …  
    12571257%%%
    12581258\begin{classdesc}{Time_boundary}{domain = None, f = None}
    1259 Module: \code{pyvolution.generic\_boundary\_conditions}
     1259Module: \module{pyvolution.generic\_boundary\_conditions}
    12601260
    12611261A time-dependent boundary returns values for the conserved
    … …  
    12661266%%%
    12671267\begin{classdesc}{File_boundary}{Boundary}
    1268 Module: \code{pyvolution.generic\_boundary\_conditions}
     1268Module: \module{pyvolution.generic\_boundary\_conditions}
    12691269
    12701270The boundary values are obtained from a file and interpolated. The
    … …  
    13031303  \begin{funcdesc}{evolve}{yieldstep = None, finaltime = None, duration = None, skip_initial_step = False}
    13041304
    1305   Module: pyvolution.domain
    1306 
    1307   This function (a method of \code{domain}) is invoked once all the
     1305  Module: \module{pyvolution.domain}
     1306
     1307  This function (a method of \class{domain}) is invoked once all the
    13081308  preliminaries have been completed, and causes the model to progress
    13091309  through successive steps in its evolution, storing results and
    … …  
    13161316  results are to be stored and statistics output.
    13171317
    1318   You can include \code{evolve} in a statement of the type:
     1318  You can include \method{evolve} in a statement of the type:
    13191319
    13201320  {\small \begin{verbatim}
    … …  
    13401340
    13411341  \begin{funcdesc}{get_quantity}{???}
    1342   Module: \code{pyvolution.domain}
     1342  Module: \module{pyvolution.domain}
    13431343  Allow access to individual quantities and their methods
    13441344
    … …  
    13471347
    13481348  \begin{funcdesc}{get_values}{???}
    1349   Module: \code{pyvolution.quantity}
     1349  Module: \module{pyvolution.quantity}
    13501350
    13511351  Extract values for quantity as an array
    … …  
    13551355
    13561356  \begin{funcdesc}{get_integral}{???}
    1357   Module: \code{pyvolution.quantity}
     1357  Module: \module{pyvolution.quantity}
    13581358
    13591359  Return computed integral over entire domain for this quantity
    … …  
    13671367
    13681368  Handy for creating derived quantities on-the-fly.
    1369   See \code{Analytical\_solution\_circular\_hydraulic\_jump.py} for an example of use.
     1369  See \file{Analytical\_solution\_circular\_hydraulic\_jump.py} for an example of use.
    13701370  \end{funcdesc}
    13711371 
    13721372 
    13731373  \begin{funcdesc}{Geospatial_data}{???}
    1374     Module: \code{geospatial_data.geo_spatial_data}
     1374    Module: \module{geospatial_data.geo_spatial_data}
    13751375    Creates a georeferenced geospatial data object from either arrays or a file (pts or xya).
    13761376 
    1377     Objects of this class can be used with \code{set\_quantity}.
     1377    Objects of this class can be used with \method{set\_quantity}.
    13781378  \end{funcdesc} 
    13791379
    … …  
    14481448\begin{tabular}{ll}
    14491449ASC, PRJ & Digital elevation models (gridded)\\
    1450 TSH & Triangular
    1451 meshes (e.g. created from \code{pmesh})\\
     1450TSH & Triangular meshes (e.g. created from \code{pmesh})\\
    14521451NC & Model outputs for use as boundary conditions (e.g. from MOST)
    14531452\end{tabular}
    … …  
    14751474
    14761475  \begin{funcdesc}{sww2dem}{???}
    1477   Module: \code{pyvolution.data\_manager}
     1476  Module: \module{pyvolution.data\_manager}
    14781477
    14791478
    … …  
    14821481
    14831482  \begin{funcdesc}{dem2pts}{???}
    1484   Module: \code{pyvolution.data_manager}
     1483  Module: \module{pyvolution.data_manager}
    14851484
    14861485
    14871486  \end{funcdesc}
    14881487
    1489 %\[
    1490 %  \left[
    1491 %  \begin{array}{ccr}
    1492 %  2 & 4 & 4\\
    1493 %  1 & 1 & 1
    1494 %  \end{array}
    1495 %  \right]
    1496 %\]
     1488\bigskip
     1489
     1490\subsection{Samples}
     1491
     1492The following is an excerpt from a CDL representation of the output file \code{bedslope.sww}.
     1493
     1494\verbatiminput{examples/bedslopeexcerpt.cdl}
     1495
    14971496
    14981497%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Note: See TracChangeset for help on using the changeset viewer.