How to create a custom breach growth formula

This section describes a technical aspect, and is mainly for advanced users.

This how-to describes the steps necessary to iteratively update the breach width using a Template Excel Panel. This project assumes you have followed the steps to setup an iterated Flooding Overlay.

How to create a custom breach growth formula:

1. Open a project setup with an iterative Flooding Overlay
2. Add a new Breach Area
3. Disabling default breach growth in Flooding Overlay (Optional)
4. Import a Template Excel Panel for updating the Breach Width
5. Import a Template Excel Panel for storing Breach output variables
6. Import a Template Text Panel for plotting Breach output variables
7. Adjust the Breach Width Excel.

Breach Area

This section describes how to define an area as a Breach Area for the Flooding Overlay.

How to "Add a Breach Area":

1. Select Current Situation in the ribbon bar.
2. Hover over Areas, and select Add Empty Area.
3. Add a new Area.
4. Rename it to Breach.
5. Add new attribute BREACH_HEIGHT using the Add new attribute section in the attributes tab.
6. Draw a selection for the breach.

• 
  Add a new empty area.
• 
  Breach height set for Breach.
• 
  Drawn selection for breach area.

Disabling Breach Growth in Flooding Overlay

This section describes how to disable default breach growth using the Flooding Overlay wizard. This is only required when the value has already been set.

How to "disable Breach Growth in Flooding Overlay":

1. Select Current Situation in the ribbon bar.
2. Click on Overlays
3. Select the Flooding Overlay
4. Click on the Configuration Wizard button in its detail panel.
5. Continue to the Breach Growth Step.
6. Select the Breach named Breach (added in the Breach Area section).
7. Uncheck the option named "Set Value" for the setting named Critical Speed

• 
  Unsetting the Critical speed option, disabling automatic breach growth.

Breach Width Excel Panel

The following how-to contains the steps to apply a Template Excel Panel to an Area identified by the attribute BREACH_HEIGHT as a Breach Area for the Flooding Overlay.

How to Import a Template Excel Panel for updating the Breach Width:

1. Select Current Situation in the ribbon bar.
2. Hover over Panels, and select Find more on Share.
3. Navigate to Panels, Water and select the file named "Breach_width_iteration_before.xlsx"
4. With the Panel selected, select the Template Tab.
5. Adjust the option below Apply Template on to Areas.
6. Click on the Select button and select the attribute named BREACH_HEIGHT.
7. Click on the Apply Template button to create a Panel instance for the Breach Area.

• 
  Clicking on the "Find more on Share" option in the Panel Popup in the ribbon bar.
• 
  Navigating to the "Breach width iteration" before Excel file on the Public Share.
• 
  Inspecting and clicking on the import button of the "Breach width iteration before" Excel file.
• 
  Selecting the option Import Template Excel File
• 
  The Excel file and timing set for the Template Excel Panel.
• 
  Template settings set on Areas with Breach Height attribute.
• 
  Clicking on the Apply Template button.
• 
  Create Excel Panel by Template Excel Panel.

Breach output values

The following how-to contains the steps to add a Template Excel Panel that stores the output values of a breach for each calculated iteration. This is necessary because each iteration overwrites the default output values. By adding this example Excel file, you can see how to obtain and store these values under new attributes in the Breach Area.

Reason: "contain"→"contains", "iterations"→"iteration"; verbose sentences shortened for clarity.

How to Import a Template Excel for storing Breach output values:

1. Select Current Situation in the ribbon bar.
2. Hover over Panels, and select Find more on Share.
3. Navigate to Panels, Water and select the file named "Breach_output_iteration_after.xlsx"
4. With the Panel selected, select the Template Tab.
5. Adjust the option below Apply Template on to Areas.
6. Click on the Select button and select the attribute named BREACH_HEIGHT.
7. Click on the Apply Template button to create a Panel instance for the Breach Area.

• 
  Clicking on the "Find more on Share" option in the Panel Popup in the ribbon bar.
• 
  Navigating to the "Breach output iteration after" Excel file on the Public Share.
• 
  Inspecting and clicking on the import button of an Excel file on the Public Share.
• 
  Selecting the option Import Template Excel File
• 
  Template settings set on Areas with Breach Height attribute.
• 
  Clicking on the Apply Template button.
• 
  Create Excel Panel by Template Excel Panel.

Breach output plot

The following how-to contains the steps to add a Template Text Panel that creates a simple plot of the stored output values for a Breach. The Breach Width, Breach Flow and Breach Cumulative Flow are added to the plot.

How to Import a Template Text Panel for plotting Breach output values:

1. Select Current Situation in the ribbon bar.
2. Hover over Panels, and select "Find more on Share".
3. Navigate to Panels, Water and select the file named "Breach_output_iteration_plots.txt"
4. With the Panel selected, select the Template Tab.
5. Adjust the option below Apply Template on to Areas.
6. Click on the Select button and select the attribute named BREACH_HEIGHT.
7. Click on the Apply Template button to create a Panel instance for the Breach Area.

• 
  Clicking on the "Find more on Share" option in the Panel Popup in the ribbon bar.
• 
  Navigating to the "Breach output iteration plots" Text file on the Public Share.
• 
  Inspecting and clicking on the import button of an Text file on the Public Share.
• 
  Selecting the option Import Template Text Panel
• 
  Adjusting the timing set for the Template Excel Panel.
• 
  Template settings set on Areas with Breach Height attribute and clicking on the Apply Template button.
• 
  Created Text Panel by Template Text Panel.
• 
  The plots of the Breach width and flow after recalculating the project.

Breach Width Excel

The following how-to contains the steps to edit the imported Breach Width Excel from a previous step.

How to create a custom breach growth formula:

1. Edit the Breach Width Excel
2. Select the Template Excel Panel named Breach width iteration before
3. Click on the Select Excelsheet button to open the Select Excelsheet Panel.
4. Click on the Get icon of the accentuated excel named breach_width_iteration_before.xlsx to download it.
5. Open the downloaded excel file using your installed Excel editor.
6. Inspect the formula used in the B column below the text: Calculated breach width.
7. Apply the formula to the cells below as well.
8. Save the excel file
9. Select the Template Excel Panel named Breach width iteration before
10. Click on the Select Excelsheet button to open the Select Excelsheet Panel.
11. Click on the Upload icon of the accentuated excel named breach_width_iteration_before.xlsx to upload a file.
12. Select the saved and adjusted Excelsheet.
13. Confirm with the select button.
14. Click on the Apply Template button to reapply the template.
15. Recalculate the project by clicking on the Calculation Cloud.

• 
  Selected cell with formula to change in opened breach width iteration before Excel file.
• 
  Changed formula to logarithmic growth and applied to cells below.
• 
  Selecting the option Change Template Excel File for Breach Width Iteration Before template panel.
• 
  Logarithmic breach growth formula shown in Breach Width Output panel.

How-to's

• How to setup a flooding overlay with iterations

See also

• Breach width (Water Overlay)
• Flooding Overlay