Introduction

About this manual

This document is the user manual for TUFLOW CATCH.

How to use this manual

Searching

This entire manual’s content can be searched by using the search box at the top of the table of contents pane (i.e. screen top left to the right of the TUFLOW logo). This search box can be toggled on and off by clicking the search icon (magnifying glass) at the top left of any page.

The table of contents is dynamically filtered in response to entering text in the search box, and clicking on any remaining table of contents entry will navigate directly to the searched text. Searched text will be highlighted within a page for easy identification, and multiple instances within one page can be navigated through by using the up and down arrow keys. Clearing the search box will restore the table of contents.

Tables

Where appropriate, tables are searchable via use of the search box, which is located at the top right of any search enabled table. Not all tables are searchable. When text is entered into the search box, table rows are dynamically filtered to only show those that contain the search text. This allows on-the-fly condensing of large tables so that only relevant content is presented.

Tables can be sorted alphabetically (or reverse alphabetically) with respect to any column by clicking (and re-clicking) column headers. Where appropriate, the number of rows displayed is selectable via the Show entries drop down. Undisplayed rows can be accessed by clicking Previous or Next or by using the numbered navigation boxes, all of which are located at the bottom of each table.

Below is an Washoff1 example of a searchable table. Type “erosion” (with or without the inverted commas) into the search box to see the table behaviour, or change the number of rows displayed and use the navigation buttons at the bottom of the table to look through all the data. The right hand “Links” column sometimes has hyperlinked words that allow navigation between related commands, or different versions of the same command, for ease of access if appropriate.

Colour coding is often used for distinguishing different tabulated data types. In the above example, TUFLOW CATCH commands are in highlighted text and the associated argument options for each command are blue and contained in angled parentheses. Clicking on these arguments will navigate to related content. Colour coding applied to other table types is explained throughout this manual when required.

Commands

Where specific commands are described, they typically appear in highlighted text. If they are a clickable link to the corresponding command description in Appendix A they will appear as the standard hyperlink coloured text. That Appendix is a searchable table of all commands, as per the demonstration table presented in this introduction. The below is an example of a TUFLOW CATCH command in highlighted text. \newcommand{\blockindent}{\hspace{0.5cm}}

Catch BC Output Folder ==

Where commands specify parameters (e.g. erosion rates etc.) then for consistency and brevity, these parameters are included directly in the command example using their notation (see following section that describes notation) rather than descriptive words. These notated parameters are also often a clickable link to descriptive explanations in Appendix B. The link below is an example of a TUFLOW CATCH command as a hyperlink (i.e. not as highlighted text) with a parameter presented in notation form.

CSV Write Frequency Day == dT_{csv}

Parameter notation

The primary groups of parameters are listed below, with the letter or symbol used to denote each. Typical generalisations of units are parenthesised.

  • Time steps, dT (seconds or days)
  • Rates, R (mass per unit area per unit time, or rain rate)
  • Limits, L (mass per unit area)
  • Concentrations, C (mass per unit volume)
  • Time constants, T (seconds)
  • Water depths, d (metres)
  • Shear, \tau (Newtons per square metre)
  • Velocities, w (metres per second)
  • Erosion rates, E (grams per metres squared per second)

Portable Document Format

The TUFLOW CATCH manual is available in Portable Document Format (PDF) by clicking on the pdf icon to the right of the search icon in the menu bar of this page. This static pdf format has been provided in response to user request only and it is not the preferred means by which to access TUFLOW CATCH content. This online version is the preferred format and should be used in preference to the pdf version.

Feedback

Constructive suggestions to improve this manual are welcome, and can be emailed to .