-
Notifications
You must be signed in to change notification settings - Fork 0
Breach Toolbox v1.1: correct EBL (2005) equation exponents #119
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
6f1d332
Scaffold v1.1 of Breach Toolbox Technical Manual
AdamGohs 62a4242
Correct EBL (2005) equation exponents in Breach Toolbox v1.1
AdamGohs 091f978
Updates made to address comments from technical edit for v1.1 of the …
AdamGohs becdb9b
Updated figure references to point at v1.1 figures for v1.1 of the RM…
AdamGohs File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
28 changes: 28 additions & 0 deletions
28
...olbox-technical-manuals/internal-erosion-suite/breach/v1.1/00-document-info.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| title: Document Info | ||
| reportDate: November 2023 | ||
| reportType: Computer Program Document | ||
| reportTitle: RMC Breach Toolbox | ||
| reportSubTitle: RMC Internal Erosion Suite | ||
| reportAuthors: ['Damon Amlung, Risk Management Center'] | ||
| reportAbstract: The spreadsheet tools contained in this toolbox help assess the likelihood of breach due to gross enlargement of a concentrated leak pipe using the excess shear stress equation, unraveling of the downstream slope due to flows through the rockfill, and sinkhole development, in addition to providing general guidance for assessing slope instability. | ||
| reportSubjectTerms: ['Internal erosion', 'breach', 'gross enlargement', 'unraveling', 'sinkhole development', 'slope instability'] | ||
| responsiblePersonName: Tim O'Leary | ||
| responsiblePersonNumber: (502) 315-6599 | ||
| citationGuide: 'D. Amlung, <i>RMC Breach Toolbox Technical Manual</i>, Lakewood, CO: U.S. Army Corps of Engineers, Risk Management Center, 2023. Accessed on <i>{enter current date here}</i>.' | ||
| --- | ||
|
|
||
| import Link from '@docusaurus/Link'; | ||
| import addBaseUrl from '@docusaurus/useBaseUrl'; | ||
| import DocumentMetadata from '@site/src/components/DocumentMetadata'; | ||
| import NavContainer from '@site/src/components/NavContainer'; | ||
|
|
||
| <NavContainer | ||
| link="/toolboxes/internal-erosion-suite" | ||
| linkTitle="Internal Erosion Suite" | ||
| document="toolbox-technical-manuals/internal-erosion-suite/breach" | ||
| /> | ||
|
|
||
| # Document Information | ||
|
|
||
| <DocumentMetadata metadata={frontMatter} /> |
27 changes: 27 additions & 0 deletions
27
...box-technical-manuals/internal-erosion-suite/breach/v1.1/00-version-history.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| title: Version History | ||
| --- | ||
|
|
||
| import Link from '@docusaurus/Link'; | ||
| import NavContainer from '@site/src/components/NavContainer'; | ||
| import TableVersionHistory from '@site/src/components/TableVersionHistory'; | ||
|
|
||
| <NavContainer | ||
| link="/toolboxes/internal-erosion-suite" | ||
| linkTitle="Internal Erosion Suite" | ||
| document="toolbox-technical-manuals/internal-erosion-suite/breach" | ||
| /> | ||
|
|
||
| # Version History | ||
|
|
||
| <TableVersionHistory | ||
| versions={['1.1', '1.0']} | ||
| dates={['May 2026', 'March 2026']} | ||
| descriptions={[ | ||
| 'Updated the EBL (2005) method equation to correct the exponents for downstream slope and unit discharge for the calculation of the median rock size needed for stability in the Unraveling chapter.', | ||
| 'Initial release as an online document. Source is RMC-CPD-2023-09.', | ||
| ]} | ||
| modifiedBy={['Adam Gohs', '-']} | ||
| reviewedBy={['Casey Cummins', "Tim O'Leary"]} | ||
| approvedBy={['-', 'Nate Snorteland']} | ||
| /> |
36 changes: 36 additions & 0 deletions
36
docs/toolbox-technical-manuals/internal-erosion-suite/breach/v1.1/01-preface.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| title: 'Preface' | ||
| --- | ||
|
|
||
| import Link from '@docusaurus/Link'; | ||
| import addBaseUrl from '@docusaurus/useBaseUrl'; | ||
| import CitationFootnote from '@site/src/components/CitationFootnote'; | ||
| import NavContainer from '@site/src/components/NavContainer'; | ||
| import VersionSelector from '@site/src/components/VersionSelector'; | ||
|
|
||
| <NavContainer | ||
| link="/toolboxes/internal-erosion-suite" | ||
| linkTitle="Internal Erosion Suite" | ||
| document="toolbox-technical-manuals/internal-erosion-suite/breach" | ||
| /> | ||
|
|
||
| # Preface | ||
|
|
||
| The Risk Management Center (RMC) of the U.S. Army Corps of Engineers (USACE) has developed a suite of Microsoft Excel spreadsheets to support risk | ||
| assessments for dam and levee safety. Each analysis suite is composed of multiple toolboxes (Microsoft Excel workbooks), and each toolbox contains | ||
| multiple spreadsheet tools or calculation worksheets (Microsoft Excel worksheets). The RMC Breach Toolbox is part of the RMC Internal Erosion Suite. | ||
|
|
||
| The information from these spreadsheet tools, along with other pertinent information, informs judgment when developing a list of more and less likely | ||
| factors and estimating probabilities. USACE best practice for estimating probabilities is to use the best available and multiple methods, but all | ||
| final probabilities are estimated using team elicitation based on the totality and strength of the evidence. | ||
|
|
||
| The RMC continuously works to improve the performance of RMC software; report possible bugs directly to the RMC at the address listed below. Ideally, | ||
| report suspected errors in written form with a description of the problem and the steps that lead to its occurrence. Suggestions for improvement are | ||
| also welcomed. | ||
|
|
||
| U.S. Army Corps of Engineers | ||
| Institute for Water Resources | ||
| Risk Management Center | ||
| [RMC.software@usace.army.mil](mailto:RMC.software@usace.army.mil) | ||
|
|
||
| <CitationFootnote /> |
67 changes: 67 additions & 0 deletions
67
...-manuals/internal-erosion-suite/breach/v1.1/02-terms-and-conditions-for-use.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: 'Terms and Conditions for Use' | ||
| --- | ||
|
|
||
| import Link from '@docusaurus/Link'; | ||
| import addBaseUrl from '@docusaurus/useBaseUrl'; | ||
| import CitationFootnote from '@site/src/components/CitationFootnote'; | ||
| import NavContainer from '@site/src/components/NavContainer'; | ||
| import VersionSelector from '@site/src/components/VersionSelector'; | ||
|
|
||
| <NavContainer | ||
| link="/toolboxes/internal-erosion-suite" | ||
| linkTitle="Internal Erosion Suite" | ||
| document="toolbox-technical-manuals/internal-erosion-suite/breach" | ||
| /> | ||
|
|
||
| # Terms and Conditions for Use | ||
|
|
||
| By using Institute for Water Resources (IWR) software, users voluntarily accept the following terms and conditions. Users that do not agree to these | ||
| terms and conditions should uninstall the IWR software and return any program materials to IWR and its technical centers. If users downloaded the | ||
| software and do not have disk media, delete all copies and cease using the software. | ||
|
|
||
| ## Terms and Conditions for Use of Institute for Water Resources Software | ||
|
|
||
| The United States Government, U.S. Army Corps of Engineers, Institute for Water Resources (“IWR”), and IWR’s technical centers including the Risk | ||
| Management Center (“RMC”) and Hydrologic Engineering Center (“HEC”) grant to the user the rights to install “IWR Software” (either from a disk copy | ||
| obtained from IWR and IWR’s technical centers, a distributor or another user or by downloading it from a network) and to use, copy and/or distribute | ||
| copies of the IWR Software to other users, subject to the following Terms and Conditions of Use: | ||
|
|
||
| - All copies of the IWR Software received or reproduced by or for user pursuant to the authority of this Terms and Conditions of Use will be and | ||
|
AdamGohs marked this conversation as resolved.
|
||
| remain the property of IWR. | ||
|
|
||
| - User may reproduce and distribute the IWR Software provided that the recipient agrees to the Terms and Conditions for Use noted herein. | ||
|
|
||
| - IWR and IWR’s technical centers are solely responsible for the content of the IWR Software. The IWR Software may not be modified, abridged, | ||
| decompiled, disassembled, unobfuscated or reverse engineered. The user is solely responsible for the content, interactions, and effects of any and all | ||
| amendments, if present, whether they be extension modules, language resource bundles, scripts, or any other amendment. | ||
|
|
||
| - The name of the IWR Software must not be used to endorse or promote products derived from the IWR Software. Products derived from the IWR Software | ||
| may not be called the IWR Software nor may any part of the IWR Software name appear within the name of derived products. | ||
|
|
||
| - No part of this Terms and Conditions for Use may be modified, deleted or obliterated from the IWR Software. | ||
|
|
||
| - No part of the IWR Software may be exported or re-exported in contravention of U.S. export laws or regulations. | ||
|
|
||
| ## Waiver of Warranty | ||
|
|
||
| THE UNITED STATES GOVERNMENT AND ITS AGENCIES, OFFICIALS, REPRESENTATIVES, AND EMPLOYEES, INCLUDING ITS CONTRACTORS AND SUPPLIERS PROVIDE THE IWR | ||
| SOFTWARE “AS IS,” WITHOUT ANY WARRANTY OR CONDITION, EXPRESS, IMPLIED OR STATUTORY, AND SPECIFICALLY DISCLAIM ANY IMPLIED WARRANTIES OF TITLE, | ||
| MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. Depending on state law, the foregoing disclaimer may not apply to you, and you | ||
| may also have other legal rights that vary from state to state. | ||
|
|
||
| ## Limitation of Liability | ||
|
|
||
| IN NO EVENT SHALL THE UNITED STATES GOVERNMENT AND ITS AGENCIES, OFFICIALS, REPRESENTATIVES, AND EMPLOYEES, INCLUDING ITS CONTRACTORS AND SUPPLIERS, | ||
| BE LIABLE FOR LOST PROFITS OR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF OR IN CONNECTION WITH USE OF THE IWR SOFTWARE REGARDLESS | ||
| OF CAUSE, INCLUDING NEGLIGENCE. THE UNITED STATES GOVERNMENT’S LIABILITY, AND THE LIABILITY OF ITS AGENCIES, OFFICIALS, REPRESENTATIVES, AND | ||
| EMPLOYEES, INCLUDING ITS CONTRACTORS AND SUPPLIERS, TO YOU OR ANY THIRD PARTIES IN ANY CIRCUMSTANCE IS LIMITED TO THE REPLACEMENT OF CERTIFIED COPIES | ||
| OF THE IWR SOFTWARE WITH IDENTIFIED ERRORS CORRECTED. Depending on state law, the above limitation or exclusion may not apply to you. | ||
|
|
||
| ## Indemnity | ||
|
|
||
| As a voluntary user of the IWR Software you agree to indemnify and hold the United States Government, and its agencies, officials, representatives, | ||
| and employees, including its contractors and suppliers, harmless from any claim or demand, including reasonable attorneys’ fees, made by any third | ||
| party due to or arising out of your use of the IWR Software or breach of this Agreement or your violation of any law or the rights of a third party. | ||
|
|
||
| <CitationFootnote /> | ||
148 changes: 148 additions & 0 deletions
148
...ox-technical-manuals/internal-erosion-suite/breach/v1.1/03-general-overview.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| --- | ||
| title: 'General Overview' | ||
| --- | ||
|
|
||
| import Link from '@docusaurus/Link'; | ||
| import addBaseUrl from '@docusaurus/useBaseUrl'; | ||
| import CitationFootnote from '@site/src/components/CitationFootnote'; | ||
| import Figure from '@site/src/components/Figure'; | ||
| import FigureInline from '@site/src/components/FigureInline'; | ||
| import FigReference from '@site/src/components/FigureReference'; | ||
| import NavContainer from '@site/src/components/NavContainer'; | ||
| import VersionSelector from '@site/src/components/VersionSelector'; | ||
|
|
||
| <NavContainer | ||
| link="/toolboxes/internal-erosion-suite" | ||
| linkTitle="Internal Erosion Suite" | ||
| document="toolbox-technical-manuals/internal-erosion-suite/breach" | ||
| /> | ||
|
|
||
| # General Overview | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Copy or download the toolbox file to the computer. To open the toolbox file, either: | ||
|
|
||
| - Find the file on the computer and double-click it. This opens the file in Microsoft Excel. | ||
|
|
||
| - Open Microsoft Excel and use the application to open the file: Once Microsoft Excel is open, go to the File menu at the top of the window and select | ||
| Open. | ||
|
|
||
| The toolbox is an Excel binary workbook (.xlsb) that uses macros. You may need to enable the macros, either before opening the file or by clicking | ||
| “Enable Content” in the yellow Security Warning message bar with a shield icon that appears after the file is opened. The actual message in the | ||
| message bar will vary depending on the computer’s settings and installed add-ins. <FigReference figKey="figure-1" /> displays examples of different | ||
| wordings that may appear in the message bar. | ||
|
|
||
| <Figure | ||
| figKey="figure-1" | ||
| src="figures\toolbox-technical-manuals\internal-erosion-suite\breach\v1.1\figures\figure1.png" | ||
| alt="Security warning message bars with the “Enable Content” option to enable macros." | ||
| caption="Security warning message bars with the “Enable Content” option to enable macros." | ||
| background="transparent" | ||
| /> | ||
|
|
||
| ## Organization | ||
|
|
||
| Although the toolbox does not provide a calculation cover sheet, adding one is strongly recommended. A calculation cover sheet captures project | ||
| information, a description and purpose of the calculation, the assumptions for critical input parameters, a summary of the major conclusion and | ||
| results, and a revision history. | ||
|
|
||
| Each toolbox has a similar appearance and organizational structure: | ||
|
|
||
| - The first worksheet, About, summarizes the purpose of the toolbox and gives contact information for the RMC software development team. | ||
|
|
||
| - The second worksheet, Terms and Conditions, contains the terms and conditions for use of the toolbox (IWR software). | ||
|
|
||
| - The third worksheet, Version History, contains the revision history. Semantic versioning is used in the format of MAJOR.MINOR.PATCH: | ||
| - MAJOR – significant worksheet changes not compatible with previous versions. | ||
|
|
||
| - MINOR – additional features or enhancements that do not fundamentally change the calculations. | ||
|
|
||
| - PATCH – backward-compatible bug fixes. | ||
|
|
||
| - The fourth worksheet, References, lists the references cited for each calculation worksheet. | ||
|
|
||
| The workbook and worksheets are not protected to prevent unwanted changes. However, because the toolbox has user-defined functions (UDFs) and | ||
| subroutines in Visual Basic, you cannot directly copy worksheets to another workbook without potentially losing functionality. A note in a bold red | ||
| font at the upper right margin indicates if the selected worksheet includes such features. | ||
|
|
||
| At the top of each calculation worksheet, input information for the preparer and checker for quality control (QC) documentation and the calculation | ||
| title in case multiple copies of the worksheet are created for different analysis scenarios (<FigReference figKey="figure-2" />). The footer of each | ||
| calculation worksheet contains the version number, which can be cross-referenced with the revision history on the third worksheet. | ||
|
|
||
| <Figure | ||
| figKey="figure-2" | ||
| src="figures\toolbox-technical-manuals\internal-erosion-suite\breach\v1.1\figures\figure2.png" | ||
| alt="Calculation worksheet heading." | ||
| caption="Calculation worksheet heading." | ||
| /> | ||
|
|
||
| User-specified input includes values and selections from drop-down lists. User input cells are light yellow, and these cells are unprotected. When | ||
| cells use drop-down lists, a note in blue font in the right margin of the row alerts the user to use the drop-down list. Conditional formatting | ||
| applies a gray background to cells that are not based on a user selection. When a user-specified value or calculated value is outside of acceptable | ||
| ranges, the cell is orange to indicate caution to the user. | ||
|
|
||
| All units for user-specified input values are clearly labeled. Most user-specified input values use English units. However, values may be in metric | ||
| where metric units are more common in practice (e.g., particle size in millimeters or permeability in centimeters per second). The toolbox may convert | ||
| English units to metric units to perform some calculations or if required for a specific formula based on the reference material for the equation. | ||
|
|
||
| If the calculation worksheet is a function of headwater level, up to seven headwater and tailwater levels may be specified at the top of the | ||
| worksheet. Tailwater may be required to calculate the net hydraulic head and hydraulic gradient. Specify the elevation datum by selecting one of three | ||
| options from the drop-down list: ft-NAVD88, ft-NGVD29, and Other. The two datum selections include English units of length (feet). If Other is | ||
| selected, provide a user-specified datum along with feet (e.g., ft-MSL [Mean Sea Level]). <FigReference figKey="figure-3" /> through | ||
| {"\n"}<FigReference figKey="figure-5" /> illustrate the three possible scenarios. | ||
|
|
||
| <Figure | ||
| figKey="figure-3" | ||
| src="figures\toolbox-technical-manuals\internal-erosion-suite\breach\v1.1\figures\figure3.png" | ||
| alt="Headwater and tailwater input: NAVD88." | ||
| caption="Headwater and tailwater input: NAVD88." | ||
| /> | ||
|
|
||
| <Figure | ||
| figKey="figure-4" | ||
| src="figures\toolbox-technical-manuals\internal-erosion-suite\breach\v1.1\figures\figure4.png" | ||
| alt="Headwater and tailwater input: NGVD29." | ||
| caption="Headwater and tailwater input: NGVD29." | ||
| /> | ||
|
|
||
| <Figure | ||
| figKey="figure-5" | ||
| src="figures\toolbox-technical-manuals\internal-erosion-suite\breach\v1.1\figures\figure5.png" | ||
| alt="Headwater and tailwater input: User-specified datum." | ||
| caption="Headwater and tailwater input: User-specified datum." | ||
| /> | ||
|
|
||
| Most calculation worksheets break down complex analysis into computational steps following a logical sequence (<FigReference figKey="figure-6" />). | ||
| Some simpler worksheets do not have steps. Generally, different methodologies are unique worksheets. Some worksheets may include multiple | ||
| methodologies, which are labeled as options (<FigReference figKey="figure-7" />). | ||
|
|
||
| <Figure | ||
| figKey="figure-6" | ||
| src="figures\toolbox-technical-manuals\internal-erosion-suite\breach\v1.1\figures\figure6.png" | ||
| alt="Example of step banner." | ||
| caption="Example of step banner." | ||
| /> | ||
|
|
||
| <Figure | ||
| figKey="figure-7" | ||
| src="figures\toolbox-technical-manuals\internal-erosion-suite\breach\v1.1\figures\figure7.png" | ||
| alt="Example of option banner." | ||
| caption="Example of option banner." | ||
| /> | ||
|
|
||
| Some calculation worksheets can perform either a deterministic or probabilistic analysis. Although not required to perform a probabilistic analysis, | ||
| Palisade @RISK software (standalone version or as part of the Palisade DecisionTools Suite) can customize the probabilistic analysis. A note appears | ||
| in a bold red font at the upper right-hand margin of a calculation worksheet indicating if this feature is included with the toolbox. | ||
|
|
||
| User notes generally appear in the right margin of each calculation worksheet. Some notes are in blue or red font for heightened awareness. These | ||
| notes include references to source materials for equations, figures, tables, pages, etc. If the RMC modified the source material, the reference | ||
| citation says “adapted from” instead of “from.” | ||
|
|
||
| Tabular and/or graphical summaries are generally the primary output of the toolbox. The UDFs in the PlotScale module change the minimum and maximum | ||
| values of the x-axis and y-axis for charts. If the calculation worksheet is a function of headwater level, you can define up to five headwater levels | ||
| of interest and plot them as vertical reference lines. By selecting the chart and then selecting the Filter icon to display the filter pane, you can | ||
| choose which data series to display. This is useful when computing the results from multiple methodologies, but not all are applicable or desired to | ||
| display. | ||
|
|
||
| <CitationFootnote /> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.