Changeset 2497


Ignore:
Timestamp:
Mar 8, 2006, 4:38:03 PM (19 years ago)
Author:
ole
Message:

Updates from Wednesday meeting (Howard and Ole)

Location:
documentation/user_manual
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • documentation/user_manual/anuga_user_manual.tex

    r2491 r2497  
    404404The final statement \nopagebreak[3]
    405405{\small \begin{verbatim}
    406     for t in domain.evolve(yieldstep = 0.1, finaltime = 4.0):
    407         domain.write_time()
     406    for t in domain.evolve(yieldstep = 0.1, duration = 4.0):
     407        print domain.timestepping_statistics()
    408408\end{verbatim}}
    409409
     
    411411`evolve' in accordance with the model embodied in the code, over a
    412412series of steps indicated by the values of \code{yieldstep} and
    413 \code{finaltime}, which can be altered as required.
     413\code{duration}, which can be altered as required.
    414414The value of \code{yieldstep} controls the time interval between successive model outputs.
    415415Behind the scenes more time steps are generally taken.
     
    497497
    498498In its simplest form, \code{pmesh} creates the mesh within a single
    499 polygon whose vertices are at geographical locations specified by
    500 the user. The user specifies the \emph{resolution}---that is, the
    501 maximal area of a triangle used for triangulation---and mesh points
    502 are created inside the polygon through a random process. Figure XXX
    503 shows a simple example of this, in which the triangulation is
    504 carried out within a pentagon.
     499polygon whose vertices are at geographical locations specified by the
     500user. The user specifies the \emph{resolution}---that is, the maximal
     501area of a triangle used for triangulation---and mesh points are
     502created inside the polygon through a random process. Figure
     503\ref{fig:pentagon} shows a simple example of this, in which
     504the triangulation is carried out within a pentagon.
     505
     506
     507\begin{figure}[hbt]
     508
     509
     510 
     511  \caption{Mesh points are created inside the polygon.}
     512  \label{fig:pentagon} 
     513\end{figure}
    505514
    506515Boundary tags are not restricted to \code{`left'}, \code{`right'},
     
    517526the user to specify a number of \emph{interior polygons}, which are
    518527triangulated separately, each according to a separately specified
    519 resolution. See Figure XXX.
     528resolution. See Figure \ref{fig:interior meshes}.
     529
     530\begin{figure}[hbt]
     531
     532
     533 
     534  \caption{Interior meshes with individual resolution.}
     535  \label{fig:interior meshes} 
     536\end{figure}
    520537
    521538In its general form, \code{pmesh} takes for its input a bounding
     
    692709import time t0 = time.time()
    693710
    694 for t in domain.evolve(yieldstep = 120, finaltime = 18000):
    695     domain.write_time()
    696     domain.write_boundary_statistics(tags = 'bottom')
     711for t in domain.evolve(yieldstep = 120, duration = 18000):
     712    print domain.timestepping_statistics()
     713    print domain.boundary_statistics(tags = 'bottom')
    697714
    698715print 'That took %.2f seconds' %(time.time()-t0)
     
    715732    \item Boundary Conditions
    716733    \item Forcing Functions
    717     \item Diagnostics
     734    \item Evolution
    718735\end{itemize}
    719736
     
    790807\end{funcdesc}
    791808
     809
     810\subsection{Setters and getters of class Domain}
     811
     812\begin{funcdesc} {set_name}{??}
     813\end{funcdesc}
     814
     815\begin{funcdesc} {get_name}{??}
     816\end{funcdesc}
     817
     818\begin{funcdesc} {set_datadir}{??}
     819\end{funcdesc}
     820
     821\begin{funcdesc} {get_datadir}{??}
     822\end{funcdesc}
     823
     824\begin{funcdesc} {set_time}{??}
     825\end{funcdesc}
     826
     827\begin{funcdesc} {set_default_order}{??}
     828\end{funcdesc}
     829
     830
    792831%%%%%%
    793832\section{Setting Quantities}
     
    9781017
    9791018
     1019
     1020\begin{funcdesc} {get_boundary_tags}{??}
     1021\end{funcdesc}
     1022
    9801023%%%
    9811024\subsection{Predefined boundary conditions}
     
    10521095
    10531096
    1054 \section{Diagnostics}
    1055 
    1056   \begin{funcdesc}{write\_time}{???}
     1097\section{Evolution}
     1098
     1099  \begin{funcdesc}{evolve}{???}
    10571100
    10581101  \end{funcdesc}
    10591102
    10601103
    1061   \begin{funcdesc}{write\_boundary\_statistics}{???}
     1104
     1105\subsection{Diagnostics}
     1106
     1107  \begin{funcdesc}{timestepping_statistics}{???}
    10621108
    10631109  \end{funcdesc}
     1110
     1111
     1112  \begin{funcdesc}{boundary\_statistics}{???}
     1113
     1114  \end{funcdesc}
     1115 
     1116 
     1117  \begin{funcdesc}{get_quantity}{???}
     1118  Module: \code{pyvolution.domain} 
     1119  Allow access to individual quantities and their methods
     1120 
     1121  \end{funcdesc} 
     1122 
     1123 
     1124  \begin{funcdesc}{get_values}{???}
     1125  Module: \code{pyvolution.quantity}   
     1126 
     1127  Extract values for quantity as an array
     1128 
     1129  \end{funcdesc}   
     1130 
     1131 
     1132  \begin{funcdesc}{get_integral}{???}
     1133  Module: \code{pyvolution.quantity}   
     1134 
     1135  Return computed integral over entire domain for this quantity
     1136 
     1137  \end{funcdesc}     
     1138 
     1139 
     1140 
     1141 
     1142 
     1143 
    10641144
    10651145%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
     
    11511231\code{pyvolution}
    11521232\end{tabular}
     1233
     1234
     1235\subsection{Basic file conversions}
     1236
     1237  \begin{funcdesc}{sww2dem}{???}
     1238  Module: \code{pyvolution.data\_manager}   
     1239 
     1240 
     1241  \end{funcdesc}     
     1242
     1243 
     1244  \begin{funcdesc}{dem2pts}{???}
     1245  Module: \code{pyvolution.data_manager}   
     1246 
     1247 
     1248  \end{funcdesc}       
    11531249
    11541250%\[
     
    13851481\section{geo_spatial_data}
    13861482
     1483This describes a class that represents arbitrary point data in UTM
     1484coordinates along with named attribute values.
     1485
     1486TBA
     1487
    13871488\section{pmesh GUI}
    13881489
     
    13901491
    13911492
    1392 \section{utilities/numerical_tools} Could do now.
     1493\section{utilities/numerical_tools} Do now.
    13931494
    13941495\begin{itemize}
  • documentation/user_manual/examples/runsydney.py

    r2481 r2497  
    135135t0 = time.time()
    136136
    137 for t in domain.evolve(yieldstep = 120, finaltime = 18000):
    138     domain.write_time()
    139     domain.write_boundary_statistics(tags = 'bottom')    
     137for t in domain.evolve(yieldstep = 120, duration = 18000):
     138    print domain.timestepping_statistics()
     139    print domain.boundary_statistics(tags = 'bottom')   
    140140   
    141141print 'That took %.2f seconds' %(time.time()-t0)
Note: See TracChangeset for help on using the changeset viewer.