Changeset 4016 for anuga_core/documentation/user_manual/anuga_user_manual.tex

Timestamp:

Nov 21, 2006, 11:49:27 AM (18 years ago)

Author:

duncan

Message:

update after meeting about public interface

File:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (14 diffs)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -1335 +1335 @@
 triangles and associates a tag with each.
 
-\refmodindex[pmesh.meshinterface]{pmesh.mesh\_interface}\label{sec:meshgeneration}
+%\refmodindex[pmesh.meshinterface]{pmesh.mesh\_interface}\label{sec:meshgeneration}
 
 \begin{funcdesc}  {create\_mesh\_from\_regions}{bounding_polygon,
@@ -1372 +1372 @@
 
 
+\subsection{Advanced mesh generation}
+
+For more control over the creation of the mesh outline, use the
+methods of the class \class{Mesh}.  
+
 
 \begin{classdesc}  {Mesh}{userSegments=None,
                  userVertices=None,
                  holes=None,
-                 regions=None,
-                 geo_reference=None}
+                 regions=None}
 Module: \module{pmesh.mesh}
 
@@ -1389 +1393 @@
 
 
-\subsection{Key Methods of Class Mesh}
-
-
-\begin{methoddesc} {add\_hole}{x,y, geo_reference=None}
+\subsubsection{Key Methods of Class Mesh}
+
+
+\begin{methoddesc} {add\_hole}{x,y}
 Module: \module{pmesh.mesh},  Class: \class{Mesh}
 
@@ -1402 +1406 @@
 
 
-\begin{methoddesc}  {add\_hole\_from\_polygon}{self, polygon, tags=None,
-    geo_reference=None}
+\begin{methoddesc}  {add\_hole\_from\_polygon}{self, polygon, tags=None}
 Module: \module{pmesh.mesh},  Class: \class{Mesh}
 
@@ -1418 +1421 @@
 Module: \module{pmesh.mesh},  Class: \class{Mesh}
 
-This method is used to build the mesh outline. It adds some points and
-segments connecting some points.  A tag for each point can optionally
+This method is used to build the mesh outline. It adds points and
+segments connecting the points.  A tag for each segment can optionally
 be added.
 
 \end{methoddesc}
 
-\begin{methoddesc} {add\_region}{x,y, geo_reference=None}
+\begin{methoddesc} {add\_region}{x,y}
 Module: \module{pmesh.mesh},  Class: \class{Mesh}
 
@@ -1435 +1438 @@
 
 \begin{methoddesc}  {add\_region\_from\_polygon}{self, polygon, tags=None,
-                                max_triangle_area=None, geo_reference=None}
+                                max_triangle_area=None}
 Module: \module{pmesh.mesh},  Class: \class{Mesh}
 
@@ -1443 +1446 @@
 \code{max_triangle_area}.  The
 region boundary is described by the input \code{polygon}.  Additionally, the
-user specifies a list of boundary tags, one for each edge of the
+user specifies a list of segment tags, one for each edge of the
 bounding polygon.
 
@@ -1454 +1457 @@
 \begin{methoddesc} {add\_vertices}{point_data}
 Module: \module{pmesh.mesh},  Class: \class{Mesh}
+
 Add user vertices. The point_data can be a list of (x,y) values, a numeric
 array or a geospatial_data instance.    
@@ -1463 +1467 @@
                     expand_pinch=expand_pinch}
 Module: \module{pmesh.mesh},  Class: \class{Mesh}
-Add segments between the user vertices to give the vertices an
+
+Add segments between some of the user vertices to give the vertices an
 outline.  The outline is an alpha shape. This method is
 useful since a set of user vertices need to be outlined by segments
@@ -1518 +1523 @@
                  other_quantities=None,
                  tagged_elements=None,
-                 geo_reference=None,
                  use_inscribed_circle=False,
                  mesh_filename=None,
@@ -1532 +1536 @@
 store and manipulate data associated with a mesh. The mesh is
 specified either by assigning the name of a mesh file to
-\code{source} or by
-\end{classdesc}
-
-\begin{funcdesc}  {pmesh\_to\_domain\_instance}{file_name, DomainClass, use_cache = False, verbose = False}
-Module: \module{abstract\_2d\_finite\_volumes.pmesh2domain}
-
-Once the initial mesh file has been created, this function is
-applied to convert it to a domain object---that is, to a member of
-the special Python class \class{Domain} (or a subclass of
-\class{Domain}), which provides access to properties and methods
-that allow quantities to be set and other operations to be carried
-out.
-
-\code{file\_name} is the name of the mesh file to be converted,
-including the extension. \code{DomainClass} is the class to be
-returned, which must be a subclass of \class{Domain} having the same
-interface as \class{Domain}---in practice, it can usually be set
-simply to \class{Domain}.
-
-This is now superseded by Domain(mesh_filename).
-\end{funcdesc}
+\code{source} or by specifying the points, triangle and boundary of the
+mesh.
 
 
@@ -1764 +1749 @@
 function will return a tuple of values---one for each quantity.
 
-\code{interpolation\_points} is a list of absolute UTM coordinates
+\code{interpolation\_points} is a list of absolute coordinates or a
+geospatial object
 for points at which values are sought.
 
@@ -1843 +1829 @@
 
 \begin{methoddesc} {get\_boundary\_tags}{}
-Module: \module{abstract\_2d\_finite\_volumes.mesh}
+Module: \module{abstract\_2d\_finite\_volumes.domain}
 
 Returns a list of the available boundary tags.
@@ -2014 +2000 @@
   \begin{funcdesc}{get\_quantity}{name, location='vertices', indices = None}
   Module: \module{abstract\_2d\_finite\_volumes.domain}
+  
   Allow access to individual quantities and their methods