digger.analyze.where_landslide_went

Module Contents

Functions

where_landslide_went

Analyze first and last output timestep of a simulation to determine where landslide material went.

API

digger.analyze.where_landslide_went.where_landslide_went(wdir: str = '.', output_type: str = 'fgout', gdir: str = '_output', shpout: str = 'landslide_fate.shp', yamlout: str = 'landslide_fate.yaml', m0: float = 0.6, sea_level: float = 0, epsg: int = None, bing: bool = False, fig_path: str = 'where_landslide_went.png') → dict

Analyze first and last output timestep of a simulation to determine where landslide material went.

The planimetric extent of the simulation area impacted by landslide material is divided into three regions:

• \(A_L\), the area that started and ended as landslide material

• \(A_O\), the area that started as ocean and ended as landslide material

• \(A_D\), the area that started as dry land and ended as landslide material

• \(A_E\), the area that started as landslide material but was fully evacuated at the end of the simulation.

At the start of the simulation, the total area covered by landslide material is:

\[A_0 = A_L + A_E\]

At the end of the simulation, the total area covered by landslide material is:

\[A_t = A_L + A_O + A_D\]

In addition to returning a dictionary of summary information, the same summary information is written to a yaml file at the location specified by yamlout.

The following two shapes are written to a shapefile specified by shpout. This shape has one attribute table column, ‘class’.

• The location of landslide material at the end of the simulation. For this shape the ‘class’ attribute table column is equal to ‘fin_ls.

• The location of water that was displaced. For this shape, the ‘class’ attribute table column is equal to ‘was_disp’.

Inputs:

wdirstr

Working directory within which D-Claw was run. This directory is expected to contain the standard .data files associated with a clawpack run.

output_typestr

Type of gridded output. Options are "fgout", indicating clawpack fgout-style output that will be read using the xarray FGOutBackend. Alternatively, "netcdf4" indicates netcdf files.

If output_type=="fgout", then an installation of the clawpack python modules is necessary as they provide the xarray FGOutBackend. To meet this requirement, install D-Claw as described in the documentation.

netcdfs are expected to have the variables for depth (h), surface elevation (eta), depth times x-directed velocity (hu), depth times y-directed velocity (hv), and depth times solid fraction (hm).

If bing==True then hm is not used and it is assumed that all material is landslide material.

gdirstr

The name of the directory within wdir that contains the gridded output files.

shpoutstr

The name of the summary shapefile to write out. Additional information provided below.

yamloutstr

The name of the summary yaml file to write out. Additional information is provided below.

m0float

Reference sediment concentration

sealevelfloat

The value of sea level used in the simulation.

bingbool

Whether the results are from a Bingclaw simulation (this functionality is preliminary).

epsgint

The EPSG code of the simulation.

fig_pathstr

The path to place a diagnostic figure.

Outputs:

landslide_fate_infodict

A summary dictionary containing the following columns

Table 6 Returned dictionary key value definition.

Key	Description of value	Units
initial_area	Initial area of landslide material	square meters
area_onshore	The quantity \(A_L+A_D\)	square meters
volume_left_onshore	The volume of landslide material at the end of the simulation that is located either (1) within the area initially occupied by landslide material, \(A_L\), or (2) within the area that was dry at the start of the simulation but covered in landslide material at the end of the simulation , \(A_D\),.	cubic meters
area_displaced	The quantity \(A_O\).	square meters
volume_displaced	The volume of ocean water at the start of the simulation within the region covered by \(A_O\).	cubic meters
net_change_in_ocean	The net change in the volume of water in the region covered by \(A_O\). If a landslide material slumped into the ocean, some of the landslide material in the initially open ocean would be above sea level and the sum of net_change_in_ocean would be positive. In contrast, if the landslide pushed all water out of the water displacement area, net_change_in_ocean would be negative.	cubic meters
final_landslide_m	The solid volume fraction of landslide material at the end of the simulation.	unitless