Changeset 2422 for documentation/user_manual/anuga_user_manual.tex
- Timestamp:
- Feb 16, 2006, 8:29:56 PM (19 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
documentation/user_manual/anuga_user_manual.tex
r2413 r2422 9 9 \input{definitions} 10 10 11 11 12 12 \documentclass{manual} 13 13 … … 23 23 %Draft date 24 24 \date{\today} % update before release! 25 26 27 28 29 30 \release{1.0} 31 32 33 \makeindex 34 %\makemodindex 25 % Use an explicit date so that reformatting 26 % doesn't cause a new date to be used. Setting 27 % the date to \today can be used during draft 28 % stages to make it easier to handle versions. 29 30 \release{1.0} % release version; this is used to define the 31 % \version macro 32 33 \makeindex % tell \index to actually write the .idx file 34 %\makemodindex % If this contains a lot of module sections. 35 35 36 36 … … 63 63 The user must specify a study area represented by a mesh of triangular 64 64 cells, the topography and bathymetry, frictional resistance, initial 65 values for water level (called \emph{stage}\index{stage} within \anuga), 65 values for water level (called \emph{stage}\index{stage} within \anuga), 66 66 boundary 67 67 conditions and forces such as windstress or pressure gradients if … … 194 194 \section{The Code} 195 195 196 %FIXME: we are using the \code function here. 196 %FIXME: we are using the \code function here. 197 197 %This should be used whereever possible 198 198 For reference we include below the complete code listing for … … 229 229 from math import sin, pi 230 230 Br = Reflective_boundary(domain) 231 Bt = Transmissive_boundary(domain) 231 Bt = Transmissive_boundary(domain) 232 232 Bd = Dirichlet_boundary([0.2,0.,0.]) 233 233 … … 257 257 258 258 {\small \begin{verbatim} 259 points, vertices, boundary = rectangular(10, 10) 259 points, vertices, boundary = rectangular(10, 10) 260 260 \end{verbatim}} 261 261 … … 304 304 class of the same name in the module \code{domain}, and inherits 305 305 some methods from the generic class but has others specific to the 306 shallow-water scenarios in which it is used. Specific options for domain 306 shallow-water scenarios in which it is used. Specific options for domain 307 307 are set at this point. One of them are to set the basename for the output file 308 308 … … 350 350 351 351 {\small \begin{verbatim} 352 \begin{verbatim}353 352 domain.set_quantity('elevation', f) 354 353 \end{verbatim}} … … 482 481 483 482 The chief difference is in the method used to create the mesh. Instead of imposing a mesh 484 structure on a rectangular grid, the technique used for this example involves building 485 mesh structures inside polygons. 483 structure on a rectangular grid, the technique used for this example involves building 484 mesh structures inside polygons. 486 485 487 486 In its simplest form, the mesh is created within a single polygon … … 512 511 513 512 514 \begin{itemize} 515 516 \item \indexedcode{create_mesh_from_region}: Create mesh based on a bounding polygon and a number of internal polygons. Each polygon has a maximal area of triangles associated with it - the resolution. The bounding polygon also has symbolic \code{tags} associated with it. 517 Arguments are: 513 \begin{itemize} 514 515 \item \indexedcode{create_mesh_from_region}: Create mesh based on a bounding polygon and a number of internal polygons. Each polygon has a maximal area of triangles associated with it - the resolution. The bounding polygon also has symbolic \code{tags} associated with it. 516 Arguments are: 518 517 \item \indexedcode{pmesh_to_domain_instance}: Convert generated mesh file to domain object. Arguments are: Mesh file name and class specifying which domain class to instantiate. (Simpler) 519 520 \item \indexedcode{file_function} %in util.py "High priority" 521 \item \indexedcode{Interpolation_function} %In least_squares.py ("High priority") 522 523 \item \indexedcode{set_region} ``Low priority. Will be merged into set\_quantity'' 518 519 \item \indexedcode{file_function} %in util.py "High priority" 520 \item \indexedcode{Interpolation_function} %In least_squares.py ("High priority") 521 522 \item \indexedcode{set_region} ``Low priority. Will be merged into set\_quantity'' 524 523 \item \indexedcode{set_quantity} ``Pretty mature'' 525 524 \item \indexedcode{set_boundary} ``Pretty mature'' 526 527 \end{itemize} 525 526 \end{itemize} 528 527 529 528 530 529 Diagnostics 531 \begin{itemize} 530 \begin{itemize} 532 531 \item \indexedcode{write_time} 533 532 \item \indexedcode{write_boundary_statistics} 534 535 536 \end{itemize} 533 534 535 \end{itemize} 537 536 538 537 539 538 \subsection{Boundary conditions} 540 539 541 ANUGA provides a large number of predefined boundary conditions to be used with 540 ANUGA provides a large number of predefined boundary conditions to be used with 542 541 \code{set_boundary} 543 542 … … 545 544 How are they used 546 545 547 \begin{itemize} 546 \begin{itemize} 548 547 \item \indexedcode{Reflective_boundary} 549 548 function, arguments 550 549 551 550 \item \indexedcode{Transmissive_boundary} 552 function, arguments, CAVEATS 553 551 function, arguments, CAVEATS 552 554 553 \item \indexedcode{Dirichlet_boundary} 555 556 \item \indexedcode{Time_boundary} 557 558 \item \indexedcode{File_boundary} 554 555 \item \indexedcode{Time_boundary} 556 557 \item \indexedcode{File_boundary} 559 558 Based on File\_function 560 561 \item \indexedcode{} 562 563 \item \indexedcode{} 564 565 559 560 \item \indexedcode{} 561 562 \item \indexedcode{} 563 564 566 565 \item \indexedcode{User defined boundary conditions.} 567 How to roll your own 568 569 570 571 \end{itemize} 566 How to roll your own 567 568 569 570 \end{itemize} 572 571 573 572 … … 575 574 \subsection{Initial conditions} 576 575 577 ANUGA provides a number of predefined initial conditions to be used with 576 ANUGA provides a number of predefined initial conditions to be used with 578 577 \code{set_quantity}. 579 578 580 \begin{itemize} 579 \begin{itemize} 581 580 582 581 583 582 \item \indexedcode{tsunami_slump} 584 583 function, arguments 585 584 586 585 \item \indexedcode{} 587 586 588 \end{itemize} 587 \end{itemize} 589 588 590 589 … … 593 592 ANUGA provides a number of predefined forcing functions to be used with ..... 594 593 595 \begin{itemize} 594 \begin{itemize} 596 595 597 596 598 597 \item \indexedcode{} 599 598 function, arguments 600 599 601 600 \item \indexedcode{} 602 601 603 \end{itemize} 602 \end{itemize} 604 603 605 604 … … 629 628 630 629 DEMs, meshes and boundary conditions can have different origins within 631 one UTM zone. However, the computation will use that of the mesh for 630 one UTM zone. However, the computation will use that of the mesh for 632 631 numerical stability. 633 632 … … 683 682 \section{utilities/polygons} Could do now. 684 683 685 \begin{itemize} 686 \item \indexedcode{polygon_function} 687 \item \indexedcode{read_polygon} 688 \item \indexedcode{populate_polygon} 689 \item \indexedcode{point_in_polygon} 690 \item \indexedcode{inside_polygon} 691 \item \indexedcode{outside_polygon} 692 \item \indexedcode{point_on_line} 693 \item \indexedcode{separate_points_by_polygon} 694 \end{itemize} 695 684 \begin{itemize} 685 \item \indexedcode{polygon_function} 686 \item \indexedcode{read_polygon} 687 \item \indexedcode{populate_polygon} 688 \item \indexedcode{point_in_polygon} 689 \item \indexedcode{inside_polygon} 690 \item \indexedcode{outside_polygon} 691 \item \indexedcode{point_on_line} 692 \item \indexedcode{separate_points_by_polygon} 693 \end{itemize} 694 696 695 697 696 … … 709 708 \section{utilities/numerical_tools} Could do now. 710 709 711 \begin{itemize} 710 \begin{itemize} 712 711 \item \indexedcode{ensure_numeric} 713 712 \item \indexedcode{mean} 714 \item 715 \end{itemize} 713 \item 714 \end{itemize} 716 715 717 716 \chapter{Glossary} … … 719 718 \begin{itemize} 720 719 \item \indexedbold{ANUGA} name of software (joint development between ANU and GA) 721 722 \item \indexedbold{Conserved quantity} 720 721 \item \indexedbold{Conserved quantity} 723 722 724 723 \item \indexedbold{Default order} is this really needed? … … 741 740 742 741 \item \indexedbold{Manning friction coefficient} 743 742 744 743 \item \indexedbold{Mesh} triangulation of domain 745 744 … … 767 766 768 767 \item \indexedbold{xmomentum} conserved quantity (note, two-dimensional SWW equations say only x and y and NOT z) 769 770 \item \indexedbold{ymomentum} conserved quantity 768 769 \item \indexedbold{ymomentum} conserved quantity 771 770 772 771 \item \indexedbold{resolution} refers to the maximal area of each triangular cell in the mesh 773 772 774 773 \item \indexedbold{polygon} A sequence of points in the plane. (Arbitrary polygons can be created in this way ) 775 ANUGA represents polygons as either a list of 2-tuples, where the latter are either Python tuples or Python lists of length 2. The unit square, for example, would be represented by the polygon [ [0,0], [1,0], [1,1], [0,1] ]. Alternatively, polygons can be represented as $N \times 2$ Numeric arrays, where $N$ is the number of points. 776 774 ANUGA represents polygons as either a list of 2-tuples, where the latter are either Python tuples or Python lists of length 2. The unit square, for example, would be represented by the polygon [ [0,0], [1,0], [1,1], [0,1] ]. Alternatively, polygons can be represented as $N \times 2$ Numeric arrays, where $N$ is the number of points. 775 777 776 NOTE: More can be read in the module utilities/polygon.py .... 778 777 779 \item \indexedbold{easting} 780 781 \item \indexedbold{northing} 782 783 \item \indexedbold{latitude} 784 785 \item \indexedbold{longitude} 786 787 \item \indexedbold{edge} 788 789 \item \indexedbold{vertex} 790 791 \item \indexedbold{finite volume} 792 793 \item \indexedbold{flux} 794 795 \item \indexedbold{Digital Elevation Model (DEM)} 778 \item \indexedbold{easting} 779 780 \item \indexedbold{northing} 781 782 \item \indexedbold{latitude} 783 784 \item \indexedbold{longitude} 785 786 \item \indexedbold{edge} 787 788 \item \indexedbold{vertex} 789 790 \item \indexedbold{finite volume} 791 792 \item \indexedbold{flux} 793 794 \item \indexedbold{Digital Elevation Model (DEM)} 796 795 797 796 … … 814 813 %\renewcommand{\indexname}{Module Index} 815 814 %end{latexonly} 816 %\input{mod\jobname.ind} % Module Index815 %\input{mod\jobname.ind} % Module Index 817 816 818 817 %begin{latexonly} 819 818 \renewcommand{\indexname}{Index} 820 819 %end{latexonly} 821 \input{\jobname.ind} 820 \input{\jobname.ind} % Index 822 821 823 822
Note: See TracChangeset
for help on using the changeset viewer.