""" Module to set up run time parameters for Clawpack. The values set in the function setrun are then written out to data files that will be read in by the Fortran code. """ import os import numpy as np #------------------------------ def setrun(claw_pkg='geoclaw'): #------------------------------ """ Define the parameters used for running Clawpack. INPUT: claw_pkg expected to be "geoclaw" for this setrun. OUTPUT: rundata - object of class ClawRunData """ from clawpack.clawutil import data assert claw_pkg.lower() == 'geoclaw', "Expected claw_pkg = 'geoclaw'" num_dim = 2 rundata = data.ClawRunData(claw_pkg, num_dim) #------------------------------------------------------------------ # Problem-specific parameters to be written to setprob.data: #------------------------------------------------------------------ #probdata = rundata.new_UserData(name='probdata',fname='setprob.data') #------------------------------------------------------------------ # GeoClaw specific parameters: #------------------------------------------------------------------ rundata = setgeo(rundata) #------------------------------------------------------------------ # Standard Clawpack parameters to be written to claw.data: # (or to amr2ez.data for AMR) #------------------------------------------------------------------ clawdata = rundata.clawdata # initialized when rundata instantiated # Set single grid parameters first. # See below for AMR parameters. # --------------- # Spatial domain: # --------------- # Number of space dimensions: clawdata.num_dim = num_dim # Lower and upper edge of computational domain: ############## Whole Region of WAcoast, same for all communities ##### # note that x1,y1,x2,y2 are used in setting regions # Set "Computational Domain" (RED borders in GE): clawdata.lower[0] = x1 = -127.25 # SET west longitude boundary clawdata.upper[0] = x2 = -123.25 # SET east longitude boundary clawdata.lower[1] = y1 = 45.0 # SET south latitude boundary clawdata.upper[1] = y2 = 49.0 # SET north latitude boundary ###################################################################### # Number of grid cells: Coarsest grid clawdata.num_cells[0] = 24 # SET Longitude resolution clawdata.num_cells[1] = 24 # SET Latitude resolution # --------------- # Size of system: # --------------- # Number of equations in the system: clawdata.num_eqn = 3 # Number of auxiliary variables in the aux array (initialized in setaux) clawdata.num_aux = 4 # Index of aux array corresponding to capacity function, if there is one: clawdata.capa_index = 2 # ------------- # Initial time: # ------------- clawdata.t0 = 0.0 # SET start time # Restart from checkpoint file of a previous run? # Note: If restarting, you must also change the Makefile to set: # RESTART = True # If restarting, t0 above should be from original run, and the # restart_file 'fort.chkNNNNN' specified below should be in # the OUTDIR indicated in Makefile. clawdata.restart = False # True to restart from prior results clawdata.restart_file = 'fort.chk00036' # File to use for restart data # ------------- # Output times: #-------------- # Specify at what times the results should be written to fort.q files. # Note that the time integration stops after the final output time. # The solution at initial time t0 is always written in addition. clawdata.output_style = 1 if clawdata.output_style==1: # Output nout frames at equally spaced times up to tfinal: t_minutes = 20 # clawdata.num_output_times = t_minutes # SET number of output frames clawdata.num_output_times = t_minutes # SET number of output frames clawdata.tfinal = t_minutes*60.0 # SET end time clawdata.output_t0 = True # output at initial (or restart) time? elif clawdata.output_style == 2: # Specify a list of output times. clawdata.output_times = [0.0,0.5,1.0,2.0,3,4,5,6,7,8,9,10] elif clawdata.output_style == 3: # Output every iout timesteps with a total of ntot time steps: clawdata.output_step_interval = 1 clawdata.total_steps = 3 clawdata.output_t0 = True clawdata.output_format = 'binary' # 'ascii' or 'binary' clawdata.output_q_components = 'all' # need all clawdata.output_aux_components = 'none' # eta=h+B is in q clawdata.output_aux_onlyonce = False # output aux arrays each frame # --------------------------------------------------- # Verbosity of messages to screen during integration: # --------------------------------------------------- # The current t, dt, and cfl will be printed every time step # at AMR levels <= verbosity. Set verbosity = 0 for no printing. # (E.g. verbosity == 2 means print only on levels 1 and 2.) clawdata.verbosity = 2 # -------------- # Time stepping: # -------------- # if dt_variable==1: variable time steps used based on cfl_desired, # if dt_variable==0: fixed time steps dt = dt_initial will always be used. clawdata.dt_variable = True # Initial time step for variable dt. # If dt_variable==0 then dt=dt_initial for all steps: clawdata.dt_initial = 1.0 # Max time step to be allowed if variable dt used: clawdata.dt_max = 1e+99 # Desired Courant number if variable dt used, and max to allow without # retaking step with a smaller dt: clawdata.cfl_desired = 0.75 clawdata.cfl_max = 1.0 # Maximum number of time steps to allow between output times: clawdata.steps_max = 5000 # ------------------ # Method to be used: # ------------------ # Order of accuracy: 1 => Godunov, 2 => Lax-Wendroff plus limiters clawdata.order = 2 # Use dimensional splitting? (not yet available for AMR) clawdata.dimensional_split = 'unsplit' # For unsplit method, transverse_waves can be # 0 or 'none' ==> donor cell (only normal solver used) # 1 or 'increment' ==> corner transport of waves # 2 or 'all' ==> corner transport of 2nd order corrections too clawdata.transverse_waves = 2 # Number of waves in the Riemann solution: clawdata.num_waves = 3 # List of limiters to use for each wave family: # Required: len(limiter) == num_waves # Some options: # 0 or 'none' ==> no limiter (Lax-Wendroff) # 1 or 'minmod' ==> minmod # 2 or 'superbee' ==> superbee # 3 or 'mc' ==> MC limiter # 4 or 'vanleer' ==> van Leer clawdata.limiter = ['mc', 'mc', 'mc'] clawdata.use_fwaves = True # True ==> use f-wave version of algorithms # Source terms splitting: # src_split == 0 or 'none' ==> no source term (src routine never called) # src_split == 1 or 'godunov' ==> Godunov (1st order) splitting used, # src_split == 2 or 'strang' ==> Strang (2nd order) splitting used, not recommended. clawdata.source_split = 'godunov' # -------------------- # Boundary conditions: # -------------------- # Number of ghost cells (usually 2) clawdata.num_ghost = 2 # Choice of BCs at xlower and xupper: # 0 => user specified (must modify bcN.f to use this option) # 1 => extrapolation (non-reflecting outflow) # 2 => periodic (must specify this at both boundaries) # 3 => solid wall for systems where q(2) is normal velocity clawdata.bc_lower[0] = 'extrap' # Longitude boundary clawdata.bc_upper[0] = 'extrap' # Longitude boundary clawdata.bc_lower[1] = 'extrap' # Latitude boundary clawdata.bc_upper[1] = 'extrap' # Latitude boundary # -------------- # Checkpointing: # -------------- # Specify when checkpoint files should be created that can be # used to restart a computation. clawdata.checkpt_style = 0 if clawdata.checkpt_style == 0: # Do not checkpoint at all pass elif clawdata.checkpt_style == 1: # Checkpoint only at tfinal. pass elif clawdata.checkpt_style == 2: # Specify a list of checkpoint times. clawdata.checkpt_times = [0.1,0.15] elif clawdata.checkpt_style == 3: # Checkpoint every checkpt_interval timesteps (on Level 1) # and at the final time. clawdata.checkpt_interval = 5 # --------------- # AMR parameters: # --------------- amrdata = rundata.amrdata ##################################### CHECK the following ########### # max number of refinement levels: # initial run use less levels to start amrdata.amr_levels_max = 4 # SET Maximum number of refinement levels # List of refinement ratios at each level (length at least mxnest-1) # Level 1 is 1 degree = 111.1 Km # Note: If use only 4 levels, the last two refinement ratios in the # lists below are ignored # Randy's ratios amrdata.refinement_ratios_x = [10,6,16] # SET x Refinement ratios amrdata.refinement_ratios_y = [10,6,16] # SET y Refinement ratios amrdata.refinement_ratios_t = [10,6,16] # SET t Refinement ratios ###################################################################### # Specify type of each aux variable in amrdata.auxtype. # This must be a list of length maux, each element of which is one of: # 'center', 'capacity', 'xleft', or 'yleft' (see documentation). amrdata.aux_type = ['center','capacity','yleft','center'] # Flag using refinement routine flag2refine rather than richardson error amrdata.flag_richardson = False # use Richardson? amrdata.flag2refine = True # steps to take on each level L between regriddings of level L+1: amrdata.regrid_interval = 3 # width of buffer zone around flagged points: # (typically the same as regrid_interval so waves don't escape): amrdata.regrid_buffer_width = 3 # clustering alg. cutoff for (# flagged pts) / (total # of cells refined) # (closer to 1.0 => more small grids may be needed to cover flagged cells) amrdata.clustering_cutoff = 0.700000 # print info about each regridding up to this level: amrdata.verbosity_regrid = 0 # ----- For developers ----- # Toggle debugging print statements: amrdata.dprint = False # print domain flags amrdata.eprint = False # print err est flags amrdata.edebug = False # even more err est flags amrdata.gprint = False # grid bisection/clustering amrdata.nprint = False # proper nesting output amrdata.pprint = False # proj. of tagged points amrdata.rprint = False # print regridding summary amrdata.sprint = False # space/memory output amrdata.tprint = False # time step reporting each level amrdata.uprint = False # update/upbnd reporting # More AMR parameters can be set -- see the defaults in pyclaw/data.py ############################## CHECK the following regions always #################################### # # --------------- # Regions: # --------------- # See clawpack-5.2.2/WAcoast/python_tools/plotregions.py regions = rundata.regiondata.regions # to specify regions of refinement append lines of the form # [minlevel,maxlevel,t1,t2,x1,x2,y1,y2], the t1, t2 in seconds # Region 0 = Computational Domain + Extra Cells regions.append([1, 1, -1.e10, 1.e10, x1-1,x2+1,y1-1,y2+1]) # Neah-Makah # Region 1 = Source regions.append([2, 2, -1.e10, 1e10, -127,-123.5,39.5,49.5]) # CSZ_L1_m.tt3 # Region 2 = Medium Grids that encompass the fine grids regions.append([2, 3, 0*60., 1e10, -124.77,-124.52,48.2365,48.45]) #Neah-Makah # Region 3 = Finest (Rectangular) Computational Grids. These must encompass # the fixed grid areas, i.e., the FGmax grids, that may be more general # quadrilateral shapes that are defined in script make_fgmax_grid.py regions.append([4,4,-1.e10,1e10,-124.692,-124.576,48.2710,48.3965]) # Neah-Makah # --------------- # Gauges: # --------------- gauges = rundata.gaugedata.gauges # Coastal Gauges gauges.append([11, -124.615278, 48.395224, 0., 1.e10]) # SET Neah Bay gauges gauges.append([12, -124.613835, 48.384007, 0., 1.e10]) # SET Neah Bay gauges gauges.append([13, -124.612413, 48.372755, 0., 1.e10]) # SET Neah Bay gauges gauges.append([14, -124.619854, 48.368562, 0., 1.e10]) # SET Neah Bay gauges gauges.append([15, -124.623466, 48.366611, 0., 1.e10]) # SET Neah Bay gauges gauges.append([16, -124.627172, 48.364549, 0., 1.e10]) # SET Neah Bay gauges gauges.append([17, -124.630284, 48.362787, 0., 1.e10]) # SET Neah Bay gauges gauges.append([21, -124.764589, 48.292740, 0., 1.e10]) # SET Makah Bay gauges gauges.append([22, -124.707816, 48.316390, 0., 1.e10]) # SET Makah Bay gauges gauges.append([23, -124.687785, 48.326207, 0., 1.e10]) # SET Makah Bay gauges gauges.append([24, -124.667888, 48.336235, 0., 1.e10]) # SET Makah Bay gauges gauges.append([25, -124.664292, 48.343650, 0., 1.e10]) # SET Makah Bay gauges gauges.append([26, -124.660918, 48.350790, 0., 1.e10]) # SET Makah Bay gauges gauges.append([27, -124.663602, 48.353236, 0., 1.e10]) # SET Makah Bay gauges # Assembly Areas and Critical Facilities gauges.append([500,-124.5832,48.3576, 0.0, 1.e10]) # Neah-Makah Assembly Area 1 gauges.append([501,-124.6242,48.3658, 0.0, 1.e10]) # Neah-Makah Fire Department gauges.append([502,-124.6276,48.3664, 0.0, 1.e10]) # Neah-Makah Hospital gauges.append([503,-124.6245,48.3669, 0.0, 1.e10]) # Neah-Makah Law Enforcement gauges.append([504,-124.6292,48.3683, 0.0, 1.e10]) # Neah-Makah Assembly Area 2 gauges.append([505,-124.7183,48.3866, 0.0, 1.e10]) # Neah-Makah Assembly Area 3 gauges.append([506,-124.7183,48.3866, 0.0, 1.e10]) # Neah-Makah Assembly Area 4 gauges.append([507,-124.6607,48.3534, 0.0, 1.e10]) # Neah-Makah Assembly Area 5 gauges.append([508,-124.6531,48.3313, 0.0, 1.e10]) # Neah-Makah Assembly Area 6 gauges.append([509,-124.6621,48.2942, 0.0, 1.e10]) # Neah-Makah Assembly Area 7 ####################################################################################################### return rundata # end of function setrun # ---------------------- #------------------- def setgeo(rundata): #------------------- """ Set GeoClaw specific runtime parameters. For documentation see .... """ try: geo_data = rundata.geo_data except: print "*** Error, this rundata has no geo_data attribute" raise AttributeError("Missing geo_data attribute") # == Physics == geo_data.gravity = 9.81 geo_data.coordinate_system = 2 geo_data.earth_radius = 6367.5e3 # == Forcing Options geo_data.coriolis_forcing = False # == Algorithm and Initial Conditions == geo_data.sea_level = 0.0 geo_data.dry_tolerance = 1.e-3 geo_data.friction_forcing = True geo_data.manning_coefficient =.025 geo_data.friction_depth = 1e6 # Refinement settings refinement_data = rundata.refinement_data refinement_data.variable_dt_refinement_ratios = True refinement_data.wave_tolerance = 1.e-1 refinement_data.deep_depth = 1e2 refinement_data.max_level_deep = 3 import os try: WAcoast = os.environ['WAcoast'] except: raise Exception("Need to set WAcoast environment variable") ##############################Probably all WAcoast communities have some topo below ######## # == settopo.data values == topo_data = rundata.topo_data # for topography, append lines of the form # [topotype, minlevel, maxlevel, t1, t2, fname] topo_data.topofiles.append([-3, 1, 1, 0., 1.e10, \ WAcoast+'/topo/etopo1-230250035050.asc']) topo_data.topofiles.append([3, 1, 1, 0., 1.e10, \ WAcoast+'/topo/la_push_wa.asc']) # This grid covers all four communities on WA Coast ############################################################################################ ########################### ALWAYS doing L1 Source, don't change ########################### # == setdtopo.data values == dtopo_data = rundata.dtopo_data # for moving topography, append lines of the form : (<= 1 allowed for now!) # [topotype, minlevel,maxlevel,fname] dtopo_data.dtopofiles.append([3,3,3,WAcoast+'/dtopo/CSZ_L1.tt3']) #rundata.dtopo_data.dt_max_dtopo = 1.0 # max time step while topo moving ############################################################################################ # == setqinit.data values == rundata.qinit_data.qinit_type = 0 rundata.qinit_data.qinitfiles = [] # for qinit perturbations, append lines of the form: (<= 1 allowed for now!) # [minlev, maxlev, fname] # == setfixedgrids.data values == fixed_grids = rundata.fixed_grid_data # for fixed grids append lines of the form # [t1,t2,noutput,x1,x2,y1,y2,xpoints,ypoints,\ # ioutarrivaltimes,ioutsurfacemax] # == fgmax.data values == fgmax_files = rundata.fgmax_data.fgmax_files # for fixed grids append to this list names of any fgmax input files fgmax_files.append('fgmax1.txt') # NeahMakah # rundata.fgmax_data.num_fgmax_val = 1 # Save depth only # rundata.fgmax_data.num_fgmax_val = 2 # Save depth and speed rundata.fgmax_data.num_fgmax_val = 5 # Save depth, speed, momentum, mom flux and min depth return rundata # end of function setgeo # ---------------------- if __name__ == '__main__': # Set up run-time parameters and write all data files. import sys execfile('make_fgmax_grid.py') rundata = setrun(*sys.argv[1:]) rundata.write() from clawpack.geoclaw import kmltools kmltools.regions2kml() kmltools.gauges2kml()