| 1 | """ |
|---|
| 2 | ----------------------------------------------------------------- model_run.py |
|---|
| 3 | ANUGA RURAL FLOOD MODELLING TEMPLATE (Domain Construction & Execution) |
|---|
| 4 | Script for building the model domain and setting initial conditions and |
|---|
| 5 | (temporally varying) boundary conditions appropriate to the particular |
|---|
| 6 | scenario-event before running (evolving) the simulation. |
|---|
| 7 | |
|---|
| 8 | Most model data for the run is read in or otherwise referenced in |
|---|
| 9 | model_data.py and imported into model_run.py to create the model mesh and |
|---|
| 10 | domain before running the simulation. |
|---|
| 11 | |
|---|
| 12 | Code Version : 1.00 June 2008 Initial release |
|---|
| 13 | Author : E Rigby (0437 250 500) ted.rigby@rienco.com.au |
|---|
| 14 | |
|---|
| 15 | ------------------------------------------------------------------------------- |
|---|
| 16 | """ |
|---|
| 17 | |
|---|
| 18 | #------------------------------------------------------------------------------ |
|---|
| 19 | # Import necessary modules |
|---|
| 20 | #------------------------------------------------------------------------------ |
|---|
| 21 | |
|---|
| 22 | # Standard python modules |
|---|
| 23 | import os |
|---|
| 24 | import time |
|---|
| 25 | import sys |
|---|
| 26 | from Numeric import zeros, Float |
|---|
| 27 | |
|---|
| 28 | # Related ANUGA modules |
|---|
| 29 | from anuga.shallow_water import Domain |
|---|
| 30 | from anuga.shallow_water import Reflective_boundary |
|---|
| 31 | from anuga.shallow_water import Dirichlet_boundary |
|---|
| 32 | from anuga.shallow_water import Time_boundary |
|---|
| 33 | from anuga.shallow_water import Transmissive_Momentum_Set_Stage_boundary |
|---|
| 34 | from anuga.shallow_water.shallow_water_domain import Inflow |
|---|
| 35 | from anuga.abstract_2d_finite_volumes.util import file_function |
|---|
| 36 | from anuga.abstract_2d_finite_volumes.quantity import Quantity |
|---|
| 37 | from anuga.pmesh.mesh_interface import create_mesh_from_regions |
|---|
| 38 | from anuga.utilities.polygon import read_polygon, plot_polygons, Polygon_function, inside_polygon |
|---|
| 39 | from anuga.alpha_shape.alpha_shape import alpha_shape_via_files |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | # Model specific imports |
|---|
| 43 | import model_data # Defines and provides the scenario-event specific data |
|---|
| 44 | import get_tuflow_data # Provides the routines to read in tuflow specific data |
|---|
| 45 | |
|---|
| 46 | ##################################################################################### |
|---|
| 47 | # # |
|---|
| 48 | # S I M U L A T I O N M A I N L I N E # |
|---|
| 49 | # # |
|---|
| 50 | ##################################################################################### |
|---|
| 51 | |
|---|
| 52 | t0 = time.time() # record start time of this run (secs) |
|---|
| 53 | print model_data.basename+' >>>> Comencing model_run.py code execution at t= %.2f hours' %(float(time.time()-t0)/3600.0) |
|---|
| 54 | |
|---|
| 55 | ##################################################################################### |
|---|
| 56 | # # |
|---|
| 57 | # CREATE THE TRIANGULAR MESH # |
|---|
| 58 | # # |
|---|
| 59 | ##################################################################################### |
|---|
| 60 | |
|---|
| 61 | # Note: The mesh is created based on overall clipping polygon with a tagged |
|---|
| 62 | # boundary and interior regions as defined in model_data.py along with |
|---|
| 63 | # resolutions (maximal area per triangle) for each interior polygon |
|---|
| 64 | |
|---|
| 65 | print model_data.basename+' >>>> Creating variable mesh within bounding_poly reflecting regional resolutions' |
|---|
| 66 | # Create the mesh reflecting the bounding (default) and internal region mesh resolutions set in model_data.py |
|---|
| 67 | # with boundary tags as defined in model_data.py |
|---|
| 68 | |
|---|
| 69 | create_mesh_from_regions(model_data.bounding_polygon, |
|---|
| 70 | boundary_tags = model_data.boundary_strings, |
|---|
| 71 | maximum_triangle_area = model_data.default_res, |
|---|
| 72 | minimum_triangle_angle=30.0, |
|---|
| 73 | interior_regions = model_data.interior_resregions, |
|---|
| 74 | filename = model_data.mesh_filename, |
|---|
| 75 | use_cache=True, |
|---|
| 76 | verbose=model_data.anuga_verbose) |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | print model_data.basename+' >>>> Completed mesh creation at t= %.2f hours ' %(float(time.time()-t0)/3600.0) |
|---|
| 80 | |
|---|
| 81 | ###################################################################################### |
|---|
| 82 | # # |
|---|
| 83 | # CREATE THE COMPUTATIONAL DOMAIN # |
|---|
| 84 | # # |
|---|
| 85 | ###################################################################################### |
|---|
| 86 | |
|---|
| 87 | print model_data.basename+' >>>> Creating domain from mesh and setting domain parameters' |
|---|
| 88 | # create domain from mesh meshname |
|---|
| 89 | domain = Domain(model_data.mesh_filename, use_cache=True, verbose=model_data.anuga_verbose) |
|---|
| 90 | print domain.statistics() # confirm what has been done |
|---|
| 91 | |
|---|
| 92 | # set base domain parameters |
|---|
| 93 | domain.set_name(model_data.basename) # already created in model_data.py |
|---|
| 94 | domain.set_datadir(model_data.results_dir) # already created and/or checked in model_data.py |
|---|
| 95 | domain.set_quantities_to_be_stored(['stage', 'xmomentum', 'ymomentum']) |
|---|
| 96 | domain.set_minimum_storable_height(0.01) # Remove very shallow water depths from sww |
|---|
| 97 | domain.set_maximum_allowed_speed(8.0) # Allow Maximum velocity of 8m/s.... |
|---|
| 98 | |
|---|
| 99 | ###################################################################################### |
|---|
| 100 | # # |
|---|
| 101 | # ASSIGN THE DOMAIN INITIAL CONDITIONS # |
|---|
| 102 | # # |
|---|
| 103 | ###################################################################################### |
|---|
| 104 | |
|---|
| 105 | #------------------------------------------------------------------------------------- |
|---|
| 106 | # This section assigns the initial (t=0) conditions for the domain |
|---|
| 107 | # Domain initial conditions can be fixed, read from a file, or from a function |
|---|
| 108 | # Note also that anuga permits almost all initial conditions to subsequently vary |
|---|
| 109 | # with time, so while the following conditions apply to the whole domain at t=0 |
|---|
| 110 | # all can be modified within the evolve time loop. In this way scour, deposition, |
|---|
| 111 | # blockage, changes in roughness etc with time can be explicitly included in a simulation |
|---|
| 112 | #------------------------------------------------------------------------------------- |
|---|
| 113 | |
|---|
| 114 | print model_data.basename+' >>>> Assigning initial conditions to %s domain' %(model_data.basename) |
|---|
| 115 | |
|---|
| 116 | # Elevation data may be assigned to the domain from a csv or (NetCDF) pts file. |
|---|
| 117 | |
|---|
| 118 | # For a smaller csv that will be read in repeatedly, best to use geospatial_data to readin and |
|---|
| 119 | # export_point_file to save the points permanently in a NetCDF *.pts file. This runs faster |
|---|
| 120 | # than the block read of a csv - but - is limited to about 6 million points. |
|---|
| 121 | # Alternatively - by directly assigning elevation from a csv file can take advantage of the block |
|---|
| 122 | # read in domain.set_quantity so the elevation dataset can be virtually unlimited in size. |
|---|
| 123 | |
|---|
| 124 | # In this simulation the size of the elevation dataset is to large for conversion to a (NetCDF) |
|---|
| 125 | # pts format so data is read in from the raw csv file. |
|---|
| 126 | |
|---|
| 127 | domain.set_quantity('elevation', |
|---|
| 128 | filename = model_data.elev_filename, |
|---|
| 129 | use_cache=True, |
|---|
| 130 | verbose=model_data.anuga_verbose, |
|---|
| 131 | alpha=0.01) |
|---|
| 132 | |
|---|
| 133 | |
|---|
| 134 | # Set the intial water level (stage) across the domain |
|---|
| 135 | InitialWaterLevel = model_data.InitialWaterLevel # At t=0 water surface is in this model at initial lake level (0.3m) |
|---|
| 136 | if domain.get_quantity('elevation') < InitialWaterLevel: # This can create ponds if land is below initial tailwater level |
|---|
| 137 | domain.set_quantity('stage', InitialWaterLevel) # set initial stage at initial tailwater level (wet) |
|---|
| 138 | else: |
|---|
| 139 | domain.set_quantity('stage', expression='elevation') # else set initial stage at land level (dry) |
|---|
| 140 | |
|---|
| 141 | |
|---|
| 142 | # Assign uniform initial friction value to domain mesh centroids as initial condition |
|---|
| 143 | # Note need to re-assess initial friction value based on rough_polys read in from tuflow |
|---|
| 144 | # files and computed depth during evolve time loop!!!! |
|---|
| 145 | domain.set_quantity('friction', model_data.default_n, location = 'centroids') |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | ####################################################################################### |
|---|
| 151 | # # |
|---|
| 152 | # ASSIGN THE (TEMPORAL) SUBAREAL INFLOWS TO THE DOMAIN # |
|---|
| 153 | # # |
|---|
| 154 | ####################################################################################### |
|---|
| 155 | |
|---|
| 156 | #-------------------------------------------------------------------------------------- |
|---|
| 157 | # This section reads the local or total temporal inflows read in in model_data.py from |
|---|
| 158 | # the Tuflow ts1 files and stored as NETCDF tms file in the tms_files subdirectory, |
|---|
| 159 | # into the domain. |
|---|
| 160 | # |
|---|
| 161 | # Note: The current ANUGA inflow function 'pours' flow onto the domain within a circle |
|---|
| 162 | # or polygonal area specified by the user at the specified temporal rate. |
|---|
| 163 | # EHR -- the above inflows should eventually be augmented by inflows at the boundary |
|---|
| 164 | # (total as distinct from local hydrographs) to better correspond with conventional |
|---|
| 165 | # flood modelling. |
|---|
| 166 | #-------------------------------------------------------------------------------------- |
|---|
| 167 | |
|---|
| 168 | print model_data.basename+" >>>> Assigning the inflow hydrographs from the (%s) tms files directory" %(model_data.tms_dir) |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | inflow_fields=[] |
|---|
| 172 | # read in each line of inflow_hydrographs[tms_filename,xcoord,ycoord] and assign as inflow hydrograph to domain |
|---|
| 173 | for i in range(len(model_data.inflow_hydrographs)) : |
|---|
| 174 | |
|---|
| 175 | tms_filename = model_data.inflow_hydrographs[i][0] # extract the inflow hydro tms_filename |
|---|
| 176 | xcoord = model_data.inflow_hydrographs[i][1] # extract the inflow hydro xcoord |
|---|
| 177 | ycoord = model_data.inflow_hydrographs[i][2] # extract the inflow hydro ycoord |
|---|
| 178 | print model_data.basename+' >>>> Reading inflow hydrograph from %s at %7.2f %7.2f and appending to forcing terms ' %(tms_filename,xcoord,ycoord) |
|---|
| 179 | |
|---|
| 180 | # convert time series to temporal function |
|---|
| 181 | flowrate = file_function(tms_filename, quantities='value',boundary_polygon=None) |
|---|
| 182 | hydrograph = Inflow(domain,center=(xcoord,ycoord),radius=10, rate=flowrate ) |
|---|
| 183 | |
|---|
| 184 | # append hydrograph to domain |
|---|
| 185 | domain.forcing_terms.append(hydrograph) |
|---|
| 186 | |
|---|
| 187 | print model_data.basename+' >>>> Completed assignment of %i inflow hydrographs at t= %.2f hours ' %(len(model_data.inflow_hydrographs),float(time.time()-t0)/3600.0) |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | ####################################################################################### |
|---|
| 191 | # # |
|---|
| 192 | # ASSIGN THE (TEMPORAL) DOWNSTREAM BOUNDARY CONDITIONS TO THE DOMAIN # |
|---|
| 193 | # # |
|---|
| 194 | ####################################################################################### |
|---|
| 195 | |
|---|
| 196 | |
|---|
| 197 | print model_data.basename+' >>>> Assigning the DSBC from the (%s) tms files directory ' %(model_data.tms_dir) |
|---|
| 198 | print model_data.basename+' >>>> Available boundary tags are ', domain.get_boundary_tags() |
|---|
| 199 | |
|---|
| 200 | # convert dsbc time series to function of time |
|---|
| 201 | tms_filename=model_data.dsbc_hydrographs[0] |
|---|
| 202 | lake_stage = file_function(tms_filename,quantities='value',boundary_polygon=None) |
|---|
| 203 | # Note: will need to be modified if more than one dsbcis to be applied |
|---|
| 204 | print model_data.basename + ' >>>> Applying dsbc %s to model at the Lake_bdry ' %(tms_filename) |
|---|
| 205 | |
|---|
| 206 | MaMt_bdry = Reflective_boundary(domain) # all reflective except lake as using inflow() |
|---|
| 207 | Mriv_bdry = Reflective_boundary(domain) # Really redundant untill get boundary inflows |
|---|
| 208 | Cbck_bdry = Reflective_boundary(domain) |
|---|
| 209 | WFra_bdry = Reflective_boundary(domain) |
|---|
| 210 | EFra_bdry = Reflective_boundary(domain) |
|---|
| 211 | |
|---|
| 212 | lake_bdry = Transmissive_Momentum_Set_Stage_boundary(domain=domain,function=lake_stage) |
|---|
| 213 | closed_bdry = Reflective_boundary(domain) |
|---|
| 214 | |
|---|
| 215 | # boundary conditions for current scenario |
|---|
| 216 | domain.set_boundary({'Lake': lake_bdry, |
|---|
| 217 | 'MaMt': MaMt_bdry, |
|---|
| 218 | 'Mriv': Mriv_bdry, |
|---|
| 219 | 'Cbck': Cbck_bdry, |
|---|
| 220 | 'WFra': WFra_bdry, |
|---|
| 221 | 'EFra': EFra_bdry, |
|---|
| 222 | 'exterior': closed_bdry }) # this relates to the residue of the bounding poly not explicitly asigned above |
|---|
| 223 | |
|---|
| 224 | print model_data.basename+' >>>> Completed assignment of %i dsbc boundary conditions to domain at t= %.2f hours ' %(len(model_data.dsbc_hydrographs),float(time.time()-t0)/3600.0) |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | ####################################################################################### |
|---|
| 228 | # # |
|---|
| 229 | # READ IN THE (TEMPORALLY DEPTH DEPENDENT) SURFACE ROUGHNESS (FRICTION) PARAMETERS # |
|---|
| 230 | # # |
|---|
| 231 | ####################################################################################### |
|---|
| 232 | |
|---|
| 233 | #--------------------------------------------------------------------------------------- |
|---|
| 234 | # This section creates a new domain quantity mat_RID and assigns surface roughness IDs (RID) |
|---|
| 235 | # values to this quantity for later use in the evolve loop where RID is used with depth to |
|---|
| 236 | # compute a depth dependent friction at each time step. |
|---|
| 237 | # |
|---|
| 238 | # Note that because the polys read in should but may not cover the entire bounding poly area |
|---|
| 239 | # It is necessarry to declare a default material as in Tuflow applying the default to mat_RID |
|---|
| 240 | # across the whole bounding poly area before applying (overwriting) with the actual RID polys |
|---|
| 241 | # and their RID values obtained from the 2d_mat mid/mif files!!!! |
|---|
| 242 | #-------------------------------------------------------------------------------------- |
|---|
| 243 | |
|---|
| 244 | print model_data.basename+' >>>> Creating and assigning surface roughness data for use in evolve' |
|---|
| 245 | |
|---|
| 246 | N = len(domain) |
|---|
| 247 | material_variables = zeros((N, 5), Float) |
|---|
| 248 | |
|---|
| 249 | # Set default material variables n0, d1, n1, d2, n2 |
|---|
| 250 | material_variables[:,0] = 0.035 # n0 |
|---|
| 251 | material_variables[:,1] = 0.3 # d1 |
|---|
| 252 | material_variables[:,2] = 0.050 # n1 |
|---|
| 253 | material_variables[:,3] = 1.5 # d2 |
|---|
| 254 | material_variables[:,4] = 0.030 # n2 |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | # Assign polygonal data to material_variables from model_data.mat_poly_list |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | points = domain.get_centroid_coordinates(absolute=True) |
|---|
| 261 | |
|---|
| 262 | for k, poly in enumerate(model_data.mat_poly_list): |
|---|
| 263 | |
|---|
| 264 | # Get indices of triangles inside polygon k |
|---|
| 265 | indices = inside_polygon(points, poly, closed=True) |
|---|
| 266 | |
|---|
| 267 | # Index into material data for polygon k |
|---|
| 268 | rid = model_data.mat_RID_list[k] |
|---|
| 269 | |
|---|
| 270 | # Material data for polygon |
|---|
| 271 | n0, d1, n1, d2, n2 = model_data.mat_roughness_data[rid] |
|---|
| 272 | |
|---|
| 273 | for i in indices: |
|---|
| 274 | material_variables[i, 0] = n0 |
|---|
| 275 | material_variables[i, 1] = d1 |
|---|
| 276 | material_variables[i, 2] = n1 |
|---|
| 277 | material_variables[i, 3] = d2 |
|---|
| 278 | material_variables[i, 4] = n2 |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | print ' ++++ Upgraded material_variables spatially with the material values set in the mif/mid files ' |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | print model_data.basename+' >>>> Completed assignment of material (surface roughness) and default n to domain at t= %.2f hours ' %(float(time.time()-t0)/3600.0) |
|---|
| 286 | |
|---|
| 287 | print model_data.basename+' >>>> Completed domain construction at t= %.2f hours ' %(float(time.time()-t0)/3600.0) |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | ######################################################################################### |
|---|
| 292 | # # |
|---|
| 293 | # RUN THE SIMULATION # |
|---|
| 294 | # # |
|---|
| 295 | ######################################################################################### |
|---|
| 296 | |
|---|
| 297 | #---------------------------------------------------------------------------------------- |
|---|
| 298 | # This section starts the analysis of flow through the domain up to the specified finaltime |
|---|
| 299 | # All time is in seconds |
|---|
| 300 | # |
|---|
| 301 | # Note: The internal computational timestep is set at each timestep to meet a CFL=1 limit. |
|---|
| 302 | # It is therefore important to examine the mesh statistics to see that there are no |
|---|
| 303 | # unintended small triangles, particularly in areas of deeper water as DT=DX/(g*H)**0.5 |
|---|
| 304 | # Yieldstep is the interval at which results are saved to the output (sww) file |
|---|
| 305 | #---------------------------------------------------------------------------------------- |
|---|
| 306 | |
|---|
| 307 | # Note: 'friction' is recomputed as a function of depth and location at each timestep( now each steptime!!) |
|---|
| 308 | |
|---|
| 309 | # EHR - could reduce recalc of friction to say every steptime??? this would markedly speedup?? Done?? |
|---|
| 310 | # EHR - need to set a startime and use in domain.set_time(starttime) to restrict to area of data of interest |
|---|
| 311 | # not clear how initial conditions etc fit in to a start not at t=0??? |
|---|
| 312 | # EHR - could restrict update of friction to wet cells only as well |
|---|
| 313 | |
|---|
| 314 | print model_data.basename+' >>>> Starting the simulation for ',model_data.catchment,'-',model_data.simclass,'-',model_data.scenario,'-',model_data.event |
|---|
| 315 | starttime = 0 # start simulation at t=0 EHR not yet implemented ??????? |
|---|
| 316 | endtime = 9000 # end at 9000 secs (150min) - Increase to 40hrs when debugged!!!!!!!! |
|---|
| 317 | steptime = 300 # write sww file results out every 300secs = 5min |
|---|
| 318 | lastprintstep = 0 # initialise lastprintstep |
|---|
| 319 | print model_data.basename+' >>>> Simulation is for %.2f hours with output to the sww file at %.0f minute intervals ' %(float(endtime/3600.0),float(steptime/60.0)) |
|---|
| 320 | |
|---|
| 321 | |
|---|
| 322 | for t in domain.evolve(yieldstep = steptime, finaltime = endtime): |
|---|
| 323 | |
|---|
| 324 | domain.write_time() # confirm t each steptime |
|---|
| 325 | domain.write_boundary_statistics(tags='Lake', quantities='stage') # indicate bdry stats each steptime |
|---|
| 326 | depth = domain.create_quantity_from_expression('stage - elevation') # create depth instance for this timestep |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | print ' ++++ Recomputing friction at t= ', t |
|---|
| 330 | |
|---|
| 331 | |
|---|
| 332 | # rebuild the 'friction' values adjusted for depth |
|---|
| 333 | for i in domain.get_wet_elements(): # loop for each wet element in domain |
|---|
| 334 | |
|---|
| 335 | # Get roughness variables |
|---|
| 336 | n0 = material_variables[i,0] |
|---|
| 337 | d1 = material_variables[i,1] |
|---|
| 338 | n1 = material_variables[i,2] |
|---|
| 339 | d2 = material_variables[i,3] |
|---|
| 340 | n2 = material_variables[i,4] |
|---|
| 341 | |
|---|
| 342 | |
|---|
| 343 | # Recompute friction values from depth for this element get_tuflow_data.py |
|---|
| 344 | d = depth.get_values(location='centroids', indices=[i])[0] |
|---|
| 345 | |
|---|
| 346 | if d <= d1: |
|---|
| 347 | depth_dependent_friction = n1 |
|---|
| 348 | elif d >= d2: |
|---|
| 349 | depth_dependent_friction = n2 |
|---|
| 350 | else: |
|---|
| 351 | depth_dependent_friction = n1+(n2-n1)/(d2-d1)*d |
|---|
| 352 | |
|---|
| 353 | |
|---|
| 354 | domain.set_quantity('friction', |
|---|
| 355 | numeric=depth_dependent_friction, |
|---|
| 356 | location='centroids', |
|---|
| 357 | indices=[i], |
|---|
| 358 | verbose=model_data.anuga_verbose) |
|---|
| 359 | |
|---|
| 360 | |
|---|
| 361 | if model_data.model_verbose : |
|---|
| 362 | friction = domain.get_quantity('friction') |
|---|
| 363 | |
|---|
| 364 | # Print something |
|---|
| 365 | |
|---|
| 366 | |
|---|
| 367 | |
|---|
| 368 | print model_data.basename+' >>>> ',model_data.catchment,'-',model_data.simclass,'-',model_data.scenario,'-',model_data.event,' -- Simulation completed succesfully' |
|---|
| 369 | print model_data.basename+' >>>> Completed ', endtime/3600.0, 'hours of model simulation at t= %.2f hours' %(float(time.time()-t0)/3600.0) |
|---|
| 370 | |
|---|
