Changeset 8144

Timestamp:

Mar 10, 2011, 9:17:38 PM (14 years ago)

Author:

wilsonr

Message:

Removed '@brief' comments.

Location:

trunk/anuga_core/source/anuga/file

Files:

• mux.py (modified) (1 diff)
• sww.py (modified) (7 diffs)

trunk/anuga_core/source/anuga/file/mux.py

@@ -18 +18 @@
 NORTH_VELOCITY_MUX2_LABEL = '-n-mux2'
 
-##
-# @brief 
-# @param filenames List of mux2 format input filenames.
-# @param weights Weights associated with each source file.
-# @param permutation The gauge numbers for which data is extracted.
-# @param verbose True if this function is to be verbose.
-# @return (times, latitudes, longitudes, elevation, quantity, starttime)
 def read_mux2_py(filenames,
                  weights=None,

trunk/anuga_core/source/anuga/file/sww.py

@@ -27 +27 @@
 import numpy as num
 
-##
-# @brief Generic class for storing output to e.g. visualisation or checkpointing
 class Data_format:
     """Generic interface to data formats
     """
 
-    ##
-    # @brief Instantiate this instance.
-    # @param domain 
-    # @param extension 
-    # @param mode The mode of the underlying file.
     def __init__(self, domain, extension, mode=netcdf_mode_w):
         assert mode[0] in ['r', 'w', 'a'], \
@@ -71 +64 @@
     """
 
-    ##
-    # @brief Instantiate this instance.
-    # @param domain ??
-    # @param mode Mode of the underlying data file.
-    # @param max_size ??
-    # @param recursion ??
-    # @note Prepare the underlying data file if mode starts with 'w'.
     def __init__(self, domain, 
                  mode=netcdf_mode_w, max_size=2000000000, recursion=False):
@@ -167 +153 @@
         fid.close()
 
-    ##
-    # @brief Store connectivity data into the underlying data file.
     def store_connectivity(self):
         """Store information about nodes, triangles and static quantities
@@ -213 +197 @@
         fid.close()
 
-    ##
-    # @brief Store time and time dependent quantities 
-    # to the underlying data file.
     def store_timestep(self):
         """Store time and time dependent quantities
@@ -376 +357 @@
 
 
-##
-# @brief Class to open an sww file so that domain can be populated with quantity values 
 class Read_sww:
 
@@ -809 +788 @@
                     outfile.variables[q + Write_sww.RANGE][1] = q_values_max
 
-    ##
-    # @brief Print the quantities in the underlying file.
-    # @param outfile UNUSED.
     def verbose_quantities(self, outfile):
         log.critical('------------------------------------------------')
@@ -1128 +1104 @@
 
 
-##
-# @brief Interpolate a quantity wrt time.
-# @param saved_quantity The quantity to interpolate.
-# @param time_interp (index, ratio)
-# @return A vector of interpolated values.
 def interpolated_quantity(saved_quantity, time_interp):
-    '''Given an index and ratio, interpolate quantity with respect to time.'''
+    """Interpolate a quantity with respect to time.
+
+    saved_quantity  the quantity to interpolate
+    time_interp     (index, ratio)
+
+    Returns a vector of interpolated values.
+    """
 
     index, ratio = time_interp