Changeset 2720 for documentation/user_manual/anuga_user_manual.tex
- Timestamp:
- Apr 18, 2006, 8:42:57 AM (18 years ago)
- File:
-
- 1 edited
-
documentation/user_manual/anuga_user_manual.tex (modified) (33 diffs)
Legend:
- Unmodified
- Added
- Removed
-
documentation/user_manual/anuga_user_manual.tex
r2717 r2720 370 370 371 371 {\small \begin{verbatim} 372 h = 0.05 \# Constant depth372 h = 0.05 # Constant depth 373 373 domain.set_quantity('stage', expression = 'elevation + %f' %h) 374 374 \end{verbatim}} … … 895 895 mesh_geo_reference=None, 896 896 minimum_triangle_angle=28.0} 897 Module: \ code{pmesh.mesh\_interface}897 Module: \module{pmesh.mesh\_interface} 898 898 899 899 … … 911 911 912 912 \begin{funcdesc} {Mesh}{} 913 Module: \ code{pmesh.mesh}913 Module: \module{pmesh.mesh} 914 914 915 915 % Translate following into layman's language … … 922 922 \begin{funcdesc} {add_region_from_polygon}{self, polygon, tags=None, 923 923 max_triangle_area=None, geo_reference=None} 924 Module: \ code{pmesh.mesh.Mesh}924 Module: \module{pmesh.mesh.Mesh} 925 925 926 926 % Translate following into layman's language … … 933 933 \begin{funcdesc} {add_hole_from_polygon}{self, polygon, tags=None, 934 934 geo_reference=None} 935 Module: \ code{pmesh.mesh.Mesh}935 Module: \module{pmesh.mesh.Mesh} 936 936 937 937 % Translate following into layman's language … … 947 947 minimum_triangle_angle=28.0, 948 948 verbose=False} 949 Module: \ code{pmesh.mesh.Mesh}949 Module: \module{pmesh.mesh.Mesh} 950 950 951 951 % Translate following into layman's language … … 957 957 958 958 \begin{funcdesc} {export_mesh_file}{self,ofile} 959 Module: \ code{pmesh.mesh.Mesh}959 Module: \module{pmesh.mesh.Mesh} 960 960 961 961 % Translate following into layman's language … … 969 969 970 970 \begin{funcdesc} {pmesh\_to\_domain\_instance}{file_name, DomainClass, use_cache = False, verbose = False} 971 Module: \ code{pyvolution.pmesh2domain}971 Module: \module{pyvolution.pmesh2domain} 972 972 973 973 Once the initial mesh file has been created, this function is applied … … 978 978 \code{file\_name} is the name of the mesh file to be converted, 979 979 including the extension. \code{DomainClass} is the class to be 980 returned, which must be a subclass of \c ode{Domain} having the same981 interface as \c ode{Domain}---in practice, it can usually be set982 simply to \c ode{Domain}.980 returned, which must be a subclass of \class{Domain} having the same 981 interface as \class{Domain}---in practice, it can usually be set 982 simply to \class{Domain}. 983 983 \end{funcdesc} 984 984 … … 993 993 994 994 \begin{funcdesc} {get\_name}{} 995 Module: \ code{pyvolution.domain}995 Module: \module{pyvolution.domain} 996 996 997 997 Returns the name assigned to the domain by \code{set_name}. If no name has been … … 1000 1000 1001 1001 \begin{funcdesc} {set\_datadir}{name} 1002 Module: \ code{pyvolution.domain}1002 Module: \module{pyvolution.domain} 1003 1003 1004 1004 Specifies the directory used for data, assigning it to the pathname \code{name}. The default value, before … … 1023 1023 1024 1024 \begin{funcdesc} {get_datadir}{} 1025 Module: \ code{pyvolution.domain}1025 Module: \module{pyvolution.domain} 1026 1026 1027 1027 Returns the data directory set by \code{set\_datadir} or, if \code{set\_datadir} has not … … 1031 1031 1032 1032 \begin{funcdesc} {set_time}{time=0.0} 1033 Module: \ code{pyvolution.domain}1033 Module: \module{pyvolution.domain} 1034 1034 1035 1035 Sets the initial time, in seconds, for the simulation. The … … 1056 1056 verbose = False, 1057 1057 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}) 1060 1060 1061 1061 This function is used to assign values to individual quantities for a … … 1136 1136 verbose = False, 1137 1137 use_cache = False} 1138 Module: \ code{pyvolution.util}1138 Module: \module{pyvolution.util} 1139 1139 1140 1140 Reads the time history of spatial data from NetCDF file and returns … … 1159 1159 interpolation_points = None, 1160 1160 verbose = False} 1161 Module: \ code{pyvolution.least\_squares}1161 Module: \module{pyvolution.least\_squares} 1162 1162 1163 1163 Given a time series, either as a sequence of numbers or … … 1191 1191 [Low priority. Will be merged into set\_quantity] 1192 1192 1193 Module:\ code{pyvolution.domain}1193 Module:\module{pyvolution.domain} 1194 1194 \end{funcdesc} 1195 1195 … … 1209 1209 1210 1210 \begin{funcdesc}{set\_boundary}{boundary_map} 1211 Module: \ code{pyvolution.domain}1211 Module: \module{pyvolution.domain} 1212 1212 1213 1213 This function allows you to assign a boundary object (corresponding to a … … 1221 1221 1222 1222 \begin{funcdesc} {get_boundary_tags}{} 1223 Module: \ code{pyvolution.mesh}1223 Module: \module{pyvolution.mesh} 1224 1224 \end{funcdesc} 1225 1225 … … 1228 1228 1229 1229 \begin{classdesc}{Reflective_boundary}{Boundary} 1230 Module: \ code{pyvolution.shallow\_water}1230 Module: \module{pyvolution.shallow\_water} 1231 1231 1232 1232 Reflective boundary returns same conserved quantities as those present in … … 1239 1239 %%% 1240 1240 \begin{classdesc}{Transmissive_boundary}{domain = None} 1241 Module: \ code{pyvolution.generic\_boundary\_conditions}1241 Module: \module{pyvolution.generic\_boundary\_conditions} 1242 1242 1243 1243 A transmissive boundary returns the same conserved quantities as … … 1249 1249 %%% 1250 1250 \begin{classdesc}{Dirichlet_boundary}{conserved_quantities=None} 1251 Module: \ code{pyvolution.generic\_boundary\_conditions}1251 Module: \module{pyvolution.generic\_boundary\_conditions} 1252 1252 1253 1253 A Dirichlet boundary returns constant values for the conserved … … 1257 1257 %%% 1258 1258 \begin{classdesc}{Time_boundary}{domain = None, f = None} 1259 Module: \ code{pyvolution.generic\_boundary\_conditions}1259 Module: \module{pyvolution.generic\_boundary\_conditions} 1260 1260 1261 1261 A time-dependent boundary returns values for the conserved … … 1266 1266 %%% 1267 1267 \begin{classdesc}{File_boundary}{Boundary} 1268 Module: \ code{pyvolution.generic\_boundary\_conditions}1268 Module: \module{pyvolution.generic\_boundary\_conditions} 1269 1269 1270 1270 The boundary values are obtained from a file and interpolated. The … … 1303 1303 \begin{funcdesc}{evolve}{yieldstep = None, finaltime = None, duration = None, skip_initial_step = False} 1304 1304 1305 Module: pyvolution.domain1306 1307 This function (a method of \c ode{domain}) is invoked once all the1305 Module: \module{pyvolution.domain} 1306 1307 This function (a method of \class{domain}) is invoked once all the 1308 1308 preliminaries have been completed, and causes the model to progress 1309 1309 through successive steps in its evolution, storing results and … … 1316 1316 results are to be stored and statistics output. 1317 1317 1318 You can include \ code{evolve} in a statement of the type:1318 You can include \method{evolve} in a statement of the type: 1319 1319 1320 1320 {\small \begin{verbatim} … … 1340 1340 1341 1341 \begin{funcdesc}{get_quantity}{???} 1342 Module: \ code{pyvolution.domain}1342 Module: \module{pyvolution.domain} 1343 1343 Allow access to individual quantities and their methods 1344 1344 … … 1347 1347 1348 1348 \begin{funcdesc}{get_values}{???} 1349 Module: \ code{pyvolution.quantity}1349 Module: \module{pyvolution.quantity} 1350 1350 1351 1351 Extract values for quantity as an array … … 1355 1355 1356 1356 \begin{funcdesc}{get_integral}{???} 1357 Module: \ code{pyvolution.quantity}1357 Module: \module{pyvolution.quantity} 1358 1358 1359 1359 Return computed integral over entire domain for this quantity … … 1367 1367 1368 1368 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. 1370 1370 \end{funcdesc} 1371 1371 1372 1372 1373 1373 \begin{funcdesc}{Geospatial_data}{???} 1374 Module: \ code{geospatial_data.geo_spatial_data}1374 Module: \module{geospatial_data.geo_spatial_data} 1375 1375 Creates a georeferenced geospatial data object from either arrays or a file (pts or xya). 1376 1376 1377 Objects of this class can be used with \ code{set\_quantity}.1377 Objects of this class can be used with \method{set\_quantity}. 1378 1378 \end{funcdesc} 1379 1379 … … 1448 1448 \begin{tabular}{ll} 1449 1449 ASC, PRJ & Digital elevation models (gridded)\\ 1450 TSH & Triangular 1451 meshes (e.g. created from \code{pmesh})\\ 1450 TSH & Triangular meshes (e.g. created from \code{pmesh})\\ 1452 1451 NC & Model outputs for use as boundary conditions (e.g. from MOST) 1453 1452 \end{tabular} … … 1475 1474 1476 1475 \begin{funcdesc}{sww2dem}{???} 1477 Module: \ code{pyvolution.data\_manager}1476 Module: \module{pyvolution.data\_manager} 1478 1477 1479 1478 … … 1482 1481 1483 1482 \begin{funcdesc}{dem2pts}{???} 1484 Module: \ code{pyvolution.data_manager}1483 Module: \module{pyvolution.data_manager} 1485 1484 1486 1485 1487 1486 \end{funcdesc} 1488 1487 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 1492 The following is an excerpt from a CDL representation of the output file \code{bedslope.sww}. 1493 1494 \verbatiminput{examples/bedslopeexcerpt.cdl} 1495 1497 1496 1498 1497 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Note: See TracChangeset
for help on using the changeset viewer.
