Changeset 8142


Ignore:
Timestamp:
Mar 10, 2011, 9:02:29 PM (14 years ago)
Author:
wilsonr
Message:

Removed '@brief' comments.

Location:
trunk/anuga_core/source/anuga
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/anuga_core/source/anuga/damage_modelling/exposure.py

    r7765 r8142  
    9494        # described by a list of indexes representing the points
    9595
    96     ##
    97     # @brief Create a comparison method.
    98     # @param self This object.
    99     # @param other The other object.
    100     # @return True if objects are 'same'.
    10196    def __cmp__(self, other):
     97        """Compare this and another object.
     98
     99        self   this object
     100        other  the other object
     101
     102        Returns True if objects are the 'same'.
     103        """
     104
    102105        #check that 'other' is an instance of this class
    103106        if isinstance(self, type(other)):
    … …  
    120123            return 1
    121124
    122     ##
    123     # @brief Get a list of column values given a column name.
    124     # @param column_name The name of the column to get values from.
    125     # @param use_refind_polygon Unused??
    126125    def get_column(self, column_name, use_refind_polygon=False):
    127         """
    128         Given a column name return a list of the column values
     126        """Get a list of column values given a column name.
     127
     128        column_name         The name of the column to get values from
     129        use_refind_polygon  if True, only return values in the refined polygon
     130                            (not yet implemented)
    129131
    130132        Note, the type of the values will be String!
    131133        do this to change a list of strings to a list of floats
    132134        time = [float(x) for x in time]
     135        """
     136
     137        if not self._attribute_dic.has_key(column_name):
     138            msg = 'There is no column called %s!' % column_name
     139            raise TitleValueError, msg
     140
     141        return self._attribute_dic[column_name]
     142
     143    def get_value(self, value_column_name, known_column_name,
     144                  known_values, use_refind_polygon=False):
     145        """
     146        Do linear interpolation on the known_colum, using the known_value,
     147        to return a value of the column_value_name.
     148        """
     149
     150        pass
     151
     152    def get_location(self, use_refind_polygon=False):
     153        """
     154        Return a geospatial object which describes the
     155        locations of the location file.
     156
     157        Note, if there is not location info, this returns None.
    133158
    134159        Not implemented:
    … …  
    137162        """
    138163
    139         if not self._attribute_dic.has_key(column_name):
    140             msg = 'There is no column called %s!' % column_name
    141             raise TitleValueError, msg
    142 
    143         return self._attribute_dic[column_name]
    144 
    145     ##
    146     # @brief ??
    147     # @param value_column_name ??
    148     # @param known_column_name ??
    149     # @param known_values ??
    150     # @param use_refind_polygon ??
    151     def get_value(self, value_column_name, known_column_name,
    152                   known_values, use_refind_polygon=False):
    153         """
    154         Do linear interpolation on the known_colum, using the known_value,
    155         to return a value of the column_value_name.
    156         """
    157 
    158         pass
    159 
    160     ##
    161     # @brief Get a geospatial object that describes the locations.
    162     # @param use_refind_polygon Unused??
    163     def get_location(self, use_refind_polygon=False):
    164         """
    165         Return a geospatial object which describes the
    166         locations of the location file.
    167 
    168         Note, if there is not location info, this returns None.
    169 
    170         Not implemented:
    171         if use_refind_polygon is True, only return values in the
    172         refined polygon
    173         """
    174 
    175164        return self._geospatial
    176165
    177     ##
    178     # @brief Add column to 'end' of CSV data.
    179     # @param column_name The new column name.
    180     # @param column_values The new column values.
    181     # @param overwrite If True, overwrites last column, doesn't add at end.
    182166    def set_column(self, column_name, column_values, overwrite=False):
    183167        """
    … …  
    210194        self._attribute_dic[column_name] = column_values
    211195
    212     ##
    213     # @brief Save the exposure CSV  file.
    214     # @param file_name If supplied, use this filename, not original.
    215196    def save(self, file_name=None):
    216         """
    217         Save the exposure csv file
     197        """Save the exposure csv file.
     198
     199        file_name  if supplied write this to filename, not original
    218200        """
    219201

  • trunk/anuga_core/source/anuga/shallow_water_balanced/swb_domain.py

    r8124 r8142  
    1111##############################################################################
    1212
    13 ##
    14 # @brief Class for a shallow water balanced domain.
    1513class Domain(Sww_domain):
    1614
    17     ##
    18     # @brief Instantiate a shallow water balanced domain.
    19     # @param coordinates
    20     # @param vertices
    21     # @param boundary
    22     # @param tagged_elements
    23     # @param geo_reference
    24     # @param use_inscribed_circle
    25     # @param mesh_filename
    26     # @param use_cache
    27     # @param verbose
    28     # @param full_send_dict
    29     # @param ghost_recv_dict
    30     # @param processor
    31     # @param numproc
    32     # @param number_of_full_nodes
    33     # @param number_of_full_triangles
    3415    def __init__(self,
    3516                 coordinates=None,
    … …  
    8768        self.set_beta(1.0)
    8869
    89     ##
    90     # @brief Run integrity checks on shallow water balanced domain.
    9170    def check_integrity(self):
    9271        Sww_domain.check_integrity(self)
    … …  
    11190        assert self.other_quantities[0] == 'friction', msg
    11291
    113     ##
    114     # @brief
    11592    def compute_fluxes(self):
    11693        #Call correct module function (either from this module or C-extension)
    … …  
    136113        #print self.flux_timestep
    137114
    138     ##
    139     # @brief
    140115    def distribute_to_vertices_and_edges(self):
    141116        """Distribution from centroids to edges specific to the SWW eqn.
    … …  
    266241
    267242
    268     ##
    269     # @brief
    270243    def distribute_to_vertices_and_edges_h(self):
    271244        """Distribution from centroids to edges specific to the SWW eqn.
    … …  
    393366
    394367
    395     ##
    396     # @brief Code to let us use old shallow water domain BCs
    397368    def conserved_values_to_evolved_values(self, q_cons, q_evol):
    398369        """Mapping between conserved quantities and the evolved quantities.
Note: See TracChangeset for help on using the changeset viewer.