Changeset 5507 for anuga_core/documentation
- Timestamp:
- Jul 16, 2008, 12:28:52 PM (17 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
anuga_core/documentation/user_manual/anuga_user_manual.tex
r5506 r5507 2299 2299 \anuga provides a number of predefined forcing functions to be used with simulations. 2300 2300 Gravity and friction are always calculated using the elevation and friction quantities, but the user may additionally add forcing terms to the list 2301 \code{domain.forcing _terms} and have them affect the model.2301 \code{domain.forcing\_terms} and have them affect the model. 2302 2302 2303 2303 Currently, predifiend forcing terms are 2304 2304 2305 \begin{funcdesc}{General _forcing}{}2305 \begin{funcdesc}{General\_forcing}{} 2306 2306 Module: \module{shallow\_water.shallow\_water\_domain} 2307 2307 … … 2323 2323 \end{itemize} 2324 2324 Note specifying both center, radius and polygon will cause an exception to be thrown. 2325 2325 2326 2326 2327 Example: 2327 2328 {\scriptsize \begin{verbatim} … … 2334 2335 domain.forcing_terms.append(xmom) 2335 2336 domain.forcing_terms.append(ymom) 2336 \end{ itemize}}2337 \end{verbatim}} 2337 2338 Here, \code{f}, \code{g} are assumed to be defined as functions of time providing a time dependent rate of change for xmomentum and ymomentum respectively. 2338 2339 P is assumed to be polygon, specified as a list of points, e.g. a square \code{P = [[x0, y0], [x1, y0], [x1, y1], [x0, y1]]}. … … 2362 2363 \item \code{polygon}: Optionally restrict forcing to an area enclosed by given polygon. 2363 2364 \end{itemize} 2364 2365 2366 2365 2367 Example: 2366 2368 {\scriptsize \begin{verbatim} … … 2369 2371 2370 2372 domain.forcing_terms.append(hydrograph) 2371 \end{ itemize}}2372 Here, \code{'QPMF_Rot_Sub13.tms' )is assumed to be a NetCDF file in the format \code{tms} defining a timeseries for a hydrograph.2373 \end{verbatim}} 2374 Here, \code{'QPMF_Rot_Sub13.tms'} is assumed to be a NetCDF file in the format \code{tms} defining a timeseries for a hydrograph. 2373 2375 \end{funcdesc} 2374 2376 … … 2404 2406 domain.forcing_terms.append(catchmentrainfall) 2405 2407 2406 \end{ itemize}}2407 Here, \code{'Q100_2hr_Rain.tms' )is assumed to be a NetCDF file in the format \code{tms} defining a timeseries for the rainfall.2408 \end{verbatim}} 2409 Here, \code{'Q100_2hr_Rain.tms'} is assumed to be a NetCDF file in the format \code{tms} defining a timeseries for the rainfall. 2408 2410 \end{funcdesc} 2409 2411 … … 2416 2418 This class modifies the quantities \code{stage, xmomentum, ymomentum} in areas at both ends of the culvert. 2417 2419 2418 The Culvert\_flow forcing term uses \code{Inflow} and {General\_forcing} to update the quantities. The flow d irection is determined on-the-fly so2420 The Culvert\_flow forcing term uses \code{Inflow} and {General\_forcing} to update the quantities. The flow drection is determined on-the-fly so 2419 2421 openings are referenced simple as opening0 and opening1 with either being able to take the role as Inflow and Outflow. 2420 2422 … … 2465 2467 2466 2468 2467 \end{ itemize}}2469 \end{verbatim}} 2468 2470 \end{funcdesc} 2469 2471
Note: See TracChangeset
for help on using the changeset viewer.