source: anuga_work/production/exmouth_2008/project.py @ 6929

"""Common filenames and locations for elevation, meshes and outputs.
This script is the heart of all scripts in the folder
"""
#------------------------------------------------------------------------------
# Import necessary modules
#------------------------------------------------------------------------------

from os import sep, environ, getenv, getcwd
from os.path import expanduser
import sys
from time import localtime, strftime, gmtime
from anuga.utilities.polygon import read_polygon, plot_polygons, is_inside_polygon, number_mesh_triangles
from anuga.utilities.system_tools import get_user_name, get_host_name
from anuga.shallow_water.data_manager import urs2sts,create_sts_boundary
from anuga.utilities.polygon import read_polygon, plot_polygons, polygon_area, is_inside_polygon

#------------------------------------------------------------------------------
# Directory setup
#------------------------------------------------------------------------------
# Note: INUNDATIONHOME is the inundation directory, not the data directory.

home = getenv('INUNDATIONHOME') + sep +'data'+sep #Sandpit's parent diruser = get_user_name()
muxhome = getenv('MUXHOME')
user = get_user_name()
host = get_host_name()

# determines time for setting up output directories
time = strftime('%Y%m%d_%H%M%S',localtime()) 
gtime = strftime('%Y%m%d_%H%M%S',gmtime()) 
build_time = time+'_build'
run_time = time+'_run'

#------------------------------------------------------------------------------
# Initial Conditions
#------------------------------------------------------------------------------

# this section needs to be updated to reflect the modelled community.
# Note, the user needs to set up the directory system accordingly
state = 'western_australia'
scenario_name = 'exmouth'
scenario = 'exmouth_tsunami_scenario_2008'

# Model specific parameters. One or all can be changed each time the
# run_scenario script is executed
tide = 0                #0.6
#event_number = 27255   # linked to hazard map
event_number = 27283
alpha = 0.1             # smoothing parameter for mesh
friction=0.01           # manning's friction coefficient
starttime=0             
finaltime=80000         # final time for simulation

setup='final'  # Final can be replaced with trial or basic.
               # Either will result in a coarser mesh that will allow a
               # faster, but less accurate, simulation.

if setup =='trial':
    print'trial'
    res_factor=10
    time_thinning=48
    yieldstep=240
if setup =='basic': 
    print'basic'
    res_factor=4
    time_thinning=12
    yieldstep=120
if setup =='final': 
    print'final'
    res_factor=1
    time_thinning=4
    yieldstep=60

#------------------------------------------------------------------------------
# Output Filename
#------------------------------------------------------------------------------
# Important to distinguish each run - ensure str(user) is included!
# Note, the user is free to include as many parameters as desired
dir_comment='_'+setup+'_'+str(tide)+'_'+str(event_number)+'_'+ 'alpha' +str(alpha)+'_'+str(user)

#------------------------------------------------------------------------------
# Input Data
#------------------------------------------------------------------------------

# elevation data used in build_perth.py
# onshore data: format ascii grid with accompanying projection file
onshore_name = 'extract_dli'
onshore_name1 = 'extract_dted'
# island: format ascii grid with accompanying projection file

# coastline: format x,y,elevation (with title)
coast_name = 'coastline.txt'
# bathymetry: format x,y,elevation (with title)
offshore_name = 'Exmouth.txt'

# gauges - used in get_timeseries.py
#gauge_name = 'exmouth.csv'
#gauge_name2 = 'thinned_MGA50.csv'

# BOUNDING POLYGON - used in build_boundary.py and run_perth.py respectively
# NOTE: when files are put together the points must be in sequence - for ease go clockwise!
# Check the run_perth.py for boundary_tags
# thinned ordering file from Hazard Map: format is index,latitude,longitude (with title)
order_filename = 'thinned_boundary_ordering.csv'
#landward bounding points
landward = 'landward_bounding_polygon.csv'

#------------------------------------------------------------------------------
# Output Elevation Data
#------------------------------------------------------------------------------
# Output filename for elevation
# this is a combination of all the data (utilisied in build_boundary)
combined_name ='exmouth_combined_elevation'
combined_smaller_name = 'exmouth_combined_elevation_smaller'

#------------------------------------------------------------------------------
# Directory Structure
#------------------------------------------------------------------------------
anuga_dir = home+state+sep+scenario+sep+'anuga'+sep
topographies_in_dir = home+state+sep+scenario+sep+'elevation_final'+sep+'points'+sep
topographies_dir = anuga_dir+'topographies'+sep
polygons_dir = anuga_dir+'polygons'+sep
tide_dir = anuga_dir+'tide_data'+sep
boundaries_dir = anuga_dir+'boundaries'+ sep 
output_dir = anuga_dir+'outputs'+sep
gauges_dir = anuga_dir+'gauges'+sep
meshes_dir = anuga_dir+'meshes'+sep

#------------------------------------------------------------------------------
# Location of input and output data
#------------------------------------------------------------------------------
# where the input data sits
onshore_in_dir_name = topographies_in_dir + onshore_name
onshore_in_dir_name1 = topographies_in_dir + onshore_name1
coast_in_dir_name = topographies_in_dir + coast_name
offshore_in_dir_name = topographies_in_dir + offshore_name

# where the output data sits
onshore_dir_name = topographies_dir + onshore_name
onshore_dir_name1 = topographies_dir + onshore_name1
coast_dir_name = topographies_dir + coast_name
offshore_dir_name = topographies_dir + offshore_name

# where the combined elevation file sits
combined_dir_name = topographies_dir + combined_name
combined_smaller_name_dir = topographies_dir + combined_smaller_name

# where the mesh sits (this is created during the run_perth.py)
meshes_dir_name = meshes_dir + scenario_name+'.msh'

# where the boundary ordering files sit (this is used within build_boundary.py)
order_filename_dir = boundaries_dir + order_filename

# where the landward points of boundary extent sit (this is used within run_perth.py)
landward_dir = boundaries_dir + landward

# where the event sts files sits (this is created during the build_boundary.py)
boundaries_dir_event = boundaries_dir + str(event_number) + sep
boundaries_dir_mux = muxhome

# where the directory of the output filename sits
output_build_time_dir = output_dir+build_time+dir_comment+sep   #used for build_perth.py
output_run_time_dir = output_dir+run_time+dir_comment+sep       #used for run_perth.py
output_run_time_dir_name = output_run_time_dir + scenario_name  #Used by post processing

#w here the directory of the gauges sit
#gauges_dir_name = gauges_dir + gauge_name       #used for get_timeseries.py
#gauges_dir_name2 = gauges_dir + gauge_name2     #used for get_timeseries.py

#------------------------------------------------------------------------------
# Interior region definitions
#------------------------------------------------------------------------------

#Land, to set the initial stage/water to be offcoast only
poly_mainland = read_polygon(polygons_dir+'initial_conditions_mainland.csv')

# Initial bounding polygon for data clipping 
poly_all = read_polygon(polygons_dir+'poly_all.csv')
res_poly_all = 100000*res_factor

# Area of Interest 1 (Fremantle)
poly_aoi1 = read_polygon(polygons_dir+'area_of_interest_points.csv')
res_aoi1 = 500*res_factor

# Area of Interest 2 (Rockingham)
#poly_aoi2 = read_polygon(polygons_dir+'rockingham_penguin.csv')
#res_aoi2 = 500*res_factor


# Area of Significance 1 (Garden Island and sand bank infront of Rockingham)
poly_aos1 = read_polygon(polygons_dir+'area_of_sig_points.csv')
res_aos1 = 1000*res_factor


# Refined areas
# Polygon designed to incorporate dredged area from Fremantle to
# Rockingham as the steep incline was making the elevation go to 0
#poly_aos3 = read_polygon(polygons_dir+'DredgeArea.csv')
#res_aos3 = 1000*res_factor

# Shallow water 1
poly_sw1 = read_polygon(polygons_dir+'shallow_water_points.csv')
res_sw1 = 25000*res_factor

# Deep water (land of Rottnest, ANUGA does not do donuts!)
#poly_dw1 = read_polygon(polygons_dir+'rottnest_internal.csv')
#res_dw1 = 100000*res_factor

# Combined all regions, must check that all are included!
interior_regions = [[poly_aoi1,res_aoi1],[poly_aos1,res_aos1],[poly_sw1,res_sw1]]

trigs_min = number_mesh_triangles(interior_regions, poly_all, res_poly_all)
print 'min estimated number of triangles', trigs_min
   
#------------------------------------------------------------------------------
# Clipping regions for export to asc and regions for clipping data
# Final inundation maps should only be created in regions of the finest mesh
#------------------------------------------------------------------------------

#Geordie Bay extract ascii grid
#xminGeordie = 358000
#xmaxGeordie = 362000
#yminGeordie = 6458500
#ymaxGeordie = 6461000

#Sorrento extract ascii grid
#xminSorrento = 379000
#xmaxSorrento = 382500
#yminSorrento = 6477000
#ymaxSorrento = 6480000

#Fremantle extract ascii grid
#xminFremantle = 376000
#xmaxFremantle = 388000
#yminFremantle = 6449000
#ymaxFremantle = 6461000

#Rockingham extract ascii grid
#xminRockingham = 373500
#xmaxRockingham = 385500
#yminRockingham = 6424000
#ymaxRockingham = 6433000