- Timestamp:
- Sep 5, 2007, 5:17:30 PM (16 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
anuga_core/documentation/user_manual/anuga_user_manual.tex
r4691 r4705 2314 2314 \end{funcdesc} 2315 2315 2316 2316 2317 \begin{funcdesc}{set\_quantities\_to\_be\_monitored}{} 2318 Module: \module{abstract\_2d\_finite\_volumes.domain} 2319 2320 Selects quantities and derived quantities for which extrema attained at internal timesteps 2321 will be collected. 2322 2323 Information can be tracked in the evolve loop by printing \code{quantity\_statistics} and 2324 collected data will be stored in the sww file. 2325 2326 Optional parameters \code{polygon} and \code{time\_interval} may be specified to restrict the 2327 extremum computation. 2328 \end{funcdesc} 2329 2330 \begin{funcdesc}{quantity\_statistics}{} 2331 Module: \module{abstract\_2d\_finite\_volumes.domain} 2332 2333 Reports on extrema attained by selected quantities. 2334 2335 Returns a string of the following type for each 2336 timestep: 2337 2338 \begin{verbatim} 2339 Monitored quantities at time 1.0000: 2340 stage-elevation: 2341 values since time = 0.00 in [0.00000000, 0.30000000] 2342 minimum attained at time = 0.00000000, location = (0.16666667, 0.33333333) 2343 maximum attained at time = 0.00000000, location = (0.83333333, 0.16666667) 2344 ymomentum: 2345 values since time = 0.00 in [0.00000000, 0.06241221] 2346 minimum attained at time = 0.00000000, location = (0.33333333, 0.16666667) 2347 maximum attained at time = 0.22472667, location = (0.83333333, 0.66666667) 2348 xmomentum: 2349 values since time = 0.00 in [-0.06062178, 0.47886313] 2350 minimum attained at time = 0.00000000, location = (0.16666667, 0.33333333) 2351 maximum attained at time = 0.35103646, location = (0.83333333, 0.16666667) 2352 \end{verbatim} 2353 2354 The quantities (and derived quantities) listed here must be selected at model 2355 initialisation using the method \code{domain.set_quantities_to_be_monitored}.\\ 2356 2357 The optional keyword argument \code{precision='\%.4f'} will 2358 determine the precision used for floating point values in the output. 2359 This diagnostics helps track extrema attained by the selected quantities 2360 at every internal timestep. 2361 2362 These values are also stored in the sww file for post processing. 2363 2364 \end{funcdesc} 2365 2366 2367 2317 2368 \begin{funcdesc}{get\_values}{location='vertices', indices = None} 2318 2369 Module: \module{abstract\_2d\_finite\_volumes.quantity}
Note: See TracChangeset
for help on using the changeset viewer.