Changeset 4004

Timestamp:

Nov 17, 2006, 4:04:01 PM (18 years ago)

Author:

ole

Message:

Added discoverability keywords into docstring

File:

• anuga_core/source/anuga/shallow_water/shallow_water_domain.py (modified) (3 diffs)

anuga_core/source/anuga/shallow_water/shallow_water_domain.py

@@ -1 @@
-"""Class Domain -
-2D triangular domains for finite-volume computations of
+"""Finite-volume computations of the shallow water wave equation.
+
+Title: ANGUA shallow_water_domain - 2D triangular domains for finite-volume computations of
 the shallow water wave equation.
 
 
-$Description:
+Author: Ole Nielsen (Ole.Nielsen@ga.gov.au),
+        Stephen Roberts (Stephen.Roberts@anu.edu.au),
+        Duncan Gray (Duncan.Gray@ga.gov.au), etc
+
+
+CreationDate: 2004
+
+Description:
+
 This module contains a specialisation of class Domain from module domain.py
 consisting of methods specific to the Shallow Water Wave Equation
@@ -39 +48 @@
 The conserved quantities are w, uh, vh
 
-$References
+Reference:
 Catastrophic Collapse of Water Supply Reservoirs in Urban Areas,
 Christopher Zoppou and Stephen Roberts,
@@ -52 +61 @@
 
 
-Ole Nielsen, Stephen Roberts, Duncan Gray, Christopher Zoppou
-Geoscience Australia, 2004
-
-
+SeeAlso: TRAC administration of ANUGA (User Manuals etc) at https://datamining.anu.edu.au/anuga and 
+Revision control
+$HeadURL$
+
+Constraints: See GPL license in the user guide
+
+Version: 1.0 ($Revision$)
+ModifiedBy:
 $Author$
-$Revision$
 $Date$
+
+$LastChangedBy$
 $LastChangedDate$
 $LastChangedRevision$
-$LastChangedBy$
-$HeadURL$
+
+
 """