Changeset 2866 for documentation/user_manual

Timestamp:

May 15, 2006, 2:26:21 PM (19 years ago)

Author:

ole

Message:

Implemented Domain(meshfile) variant widely, updated documentation and added more statistics

Location:

documentation/user_manual

Files:

• anuga_user_manual.tex (modified) (3 diffs)
• examples/runsydney.py (modified) (1 diff)

documentation/user_manual/anuga_user_manual.tex

@@ -788 +788 @@
 
 
-\emph{NOTE: Will be replaced by domain=Domain(meshname, use_cache=True, verbose=True)}
-
-
 {\small \begin{verbatim}
-    domain = pmesh_to_domain_instance(meshname,
-    Domain, use_cache = True, verbose = True)
+    domain = Domain(meshname, use_cache=True, verbose=True)
 \end{verbatim}}
 
-The function \function{pmesh\_to\_domain\_instance} converts a meshfile
+Providing a filename instead of the lists used in bedslopephysical 
+above causes Domain to convert a meshfile
 \code{meshname} into an instance of the data structure
 \code{domain}, allowing us to use methods like \method{set\_quantity}
-to set quantities and to apply other operations. (In principle, the
-second argument of \function{pmesh\_to\_domain\_instance} can be any
-subclass of \class{Domain}, but for applications involving the
-shallow-water wave equation, the second argument of
-\function{pmesh\_to\_domain\_instance} can always be set simply to
-\class{Domain}.)
+to set quantities and to apply other operations. 
+
+%(In principle, the
+%second argument of \function{pmesh\_to\_domain\_instance} can be any
+%subclass of \class{Domain}, but for applications involving the
+%shallow-water wave equation, the second argument of
+%\function{pmesh\_to\_domain\_instance} can always be set simply to
+%\class{Domain}.)
 
 The following statements specify a basename and data directory, and
@@ -819 +818 @@
 
 \subsection{Initial Conditions}
-Quantities for \file{run\_sydney\_smf.py} are set
+Quantities for \file{runsydney.py} are set
 using similar methods to those in \file{bedslopephysical.py}. However,
 in this case, many of the values are read from the auxiliary file
@@ -857 +856 @@
 {\small \begin{verbatim}
     domain.set_quantity('elevation',
-                    filename = project.combineddemname + '.pts',
-                    use_cache = True,
-                    verbose = True)
+                        filename = project.combineddemname + '.pts',
+                        use_cache = True,
+                        verbose = True)
 \end{verbatim}}
 

documentation/user_manual/examples/runsydney.py

@@ -76 +76 @@
 
 #Create shallow water domain
-domain = pmesh_to_domain_instance(meshname, Domain,
-                                  use_cache = True,
-                                  verbose = True)
-#domain = Domain(meshname)
+
+domain = Domain(meshname,
+                use_cache = True,
+                verbose = True)