diff --git a/doc/geoclaw.rst b/doc/geoclaw.rst index 888e5fd..dcd5865 100644 --- a/doc/geoclaw.rst +++ b/doc/geoclaw.rst @@ -46,6 +46,7 @@ More will eventually appear in the :ref:`apps`. plotting_geoclaw googleearth_plotting quick_tsunami + quick_surge okada sealevel manning @@ -53,6 +54,7 @@ More will eventually appear in the :ref:`apps`. fgmax tsunamidata geoclaw/Okada + surgedata * `Links `_ to relevant papers and sample codes (some are based on the Clawpack 4.x diff --git a/doc/setrun_geoclaw.rst b/doc/setrun_geoclaw.rst index 2cad85d..82337e7 100644 --- a/doc/setrun_geoclaw.rst +++ b/doc/setrun_geoclaw.rst @@ -63,6 +63,16 @@ is done should be specified for GeoClaw applications: been set (see Section :ref:`regions`) and also on several other attributes described below that contain information on minimum and maximum refinement allowed in various regions. + + +.. attribute:: rundata.refinement_data.speed_tolerance : list + + Cells are flagged for refinement at a level if the magnitude of the + velocity is greater than the corresponding value in the list. For + instance if `rundata.refinement_data.speed_tolerance = [1.0, 2.0, 3.0]` + then cells with a speed of 1.0 would refine to level 2, cells with a + speed of 2.0 would refine to level 3, and cells with a speed of 3.0 + would refine to level 4. .. attribute:: rundata.refinement_data.max_level_deep : int @@ -367,3 +377,82 @@ Fixed grid maximum monitoring / arrival times Should take the value 1, 2, or 5 and indicates how many values to monitor. See :ref:`fgmax` for more details. + +.. _setrun_surge: + +Storm Specification Data +------------------------ + +.. attribute:: rundata.surge_data.wind_forcing : bool + + Includes the wind forcing term if `True`. The drag coefficient is specified + by `rundata.surge_data.drag_law`. + +.. attribute:: rundata.surge_data.drag_law : integer + + This specifies how to deterimine the wind drag coefficient. Valid options + include include `0` implying use no wind drag (effectively eliminates the + wind source term but still computes the wind), `1` uses the Garret wind + drag law, and `2` uses the Powell (2006) wind drag law. + +.. attribute:: rundata.surge_data.pressure_forcing : bool + + Includes the pressure forcing term if `True`. + +.. attribute:: rundata.surge_data.wind_index : int + + Specifies at what index into the `aux` array the wind velocities are stored. + Note that this is Python indexed in the setrun but will be corrected in the + FORTRAN code (1 is added to the index). + +.. attribute:: rundata.surge_data.pressure_index : int + + Specifies at what index into the `aux` array the wind velocities are stored. + Note that this is Python indexed in the setrun but will be corrected in the + FORTRAN code (1 is added to the index). + +.. attribute:: rundata.surge_data.display_landfall_time : bool + + Sets whether the console output displays time relative to land fall in days. + In GeoClaw versions past 5.5 this only deterimines whether the time is + displayed in seconds or days. + +.. attribute:: rundata.surge_data.wind_refine : list + + Similar to the `speed_tolerance` data, cells are flagged for refinement at + a level if the magnitude of the wind velocity is greater than the + corresponding value in the list. For + instance if `wind_refine = [20.0, 30.0, 40.0]` + then cells with a wind speed of 2.0 would refine to level 2, cells with a + wind speed of 30.0 would refine to level 3, and cells with a wind speed of + 40.0 would refine to level 4. This can also be set to a boolean which if + `False` disables wind based refinement. + +.. attribute:: rundata.surge_data.R_refine : list + + Similar to the `wind_refine` data, cells are flagged based on the radial + distance to the storm's center. This can also be set to a boolean which if + `False` disables storm radial based refinement. + +.. attribute:: rundata.surge_data.storm_specification_type : int + + Specifies the type of storm being used. Positive options refer to a + parameterized storm model where as negative integers refer to fully + specified storms, for instance from HWRF, to be specified. + + Valid options + + - `-1`: The input data is specified in the HWRF format. + - `0`: No storm specified + - `1`: Parameterized storm requested using the Holland 1980 modeled storm. + - `2`: Parameterized storm requested using the Holland 2010 modeled storm. + - `3`: Parameterized storm requested using the Chava, Lin, Emmanuel modeled + storm. + +.. attribute:: rundata.surge_data.storm_file : string + + Specifies the path to the storm data. IF `storm_specification_type > 0` then + this should point to a GeoClaw formatted storm file (see :ref:`storm_module` for + details). If `storm_specification < 0` then this should either specify a path + to files specifying the storm or a single file depending on the type of input + data. diff --git a/doc/storm_module.rst b/doc/storm_module.rst new file mode 100644 index 0000000..5e5a0ac --- /dev/null +++ b/doc/storm_module.rst @@ -0,0 +1,11 @@ + +.. _storm_module: + +Storm Specification Class and Tools +================================================= + +.. warning :: This describes new tools added in Clawpack 5.5 + +.. automodule:: clawpack.geoclaw.surge.storm + :members: + diff --git a/doc/surgedata.rst b/doc/surgedata.rst new file mode 100644 index 0000000..dc9d273 --- /dev/null +++ b/doc/surgedata.rst @@ -0,0 +1,37 @@ + +.. _surgedata: + +================================== +Sources for Storm Surge Data +================================== + +For storm surge computations the input data is very similar to tsunamis save +for the specification of the forcing storm (as opposed to an earthquake). There +are multiple ways to specify a storm forcing in GeoClaw which include + +1. Storms described by a set of observerd parameters for which the wind and pressure + fields are constructed by a parametric model such as the Holland 1980 model. These + generally require: + - the maximum wind speed, + - the radius at which the maximum winds occurs, + - the central pressure of the storm, + - the location of the center of the storm (the eye), + - and sometimes the maximum radius of the storm is also included. + +2. Storm described by a grided set of data. This includes output from a + modeled storm such as from HWRF, or observed values if dense enough. Here GeoClaw + will interpolate this data to the grid cells as needed rather than assume a particular + profile for the wind and pressure. + +For the parameterized storm data there are a number of sources supported for this data and +there is a listing in :ref:`_storm_module` of available input formats. Valid input files +for this type of input are made available by the particular agency involved: + + - `ATCF `_ + - `HURDAT `_ + - `JMA `_ + - `IMD `_ + - `TCVITALS `_ + +Note that not all these formats are currently fully supported and may require some work +to be readable. \ No newline at end of file