|
|
# BASEchange
|
|
|
|
|
|
> **Provisional module notice**
|
|
|
> BASEchange is still undergoing development and does not yet have a stable API.
|
|
|
>
|
|
|
> If your work requires a stable module API, please wait for a release version.
|
|
|
|
|
|
The BASEchange module adds support for 1D geometries, as well as reading and writing BASEchain geometry files (.BMG).
|
|
|
|
|
|
It also exposes a command line interface (CLI) to allow the generation and export of channel geometries as either 1D or 2D meshes in `.bmg` or `.2dm` format respectively.
|
|
|
|
|
|
## Command line interface
|
|
|
|
|
|
The BASEchange CLI allows the generation of straight, trapezoidal channel geometries via the command line.
|
|
|
|
|
|
### Basic channel
|
|
|
|
|
|
| Switch | Full name | Default | Description |
|
|
|
|--------------------|-----------------------------|---------|----------------------------------------------------------------------------------------|
|
|
|
| `-LC <length>` | Channel length | 500.0 | Overall length of the channel |
|
|
|
| `-WC <width>` | Bed width | 50.0 | Bed width of the channel |
|
|
|
| `-S <slope>` | Channel slope | 0.0015 | Channel slope |
|
|
|
| `-B <slope>` | Bank slope | 1.0 | Slope of the channel banks |
|
|
|
| `-H <height>` | Channel height | 5.0 | Height of the channel flood plain relative to the channel bed |
|
|
|
| `-KS <strickler>` | Bed Strickler value | 35.0 | Friction of the channel bed |
|
|
|
| `-KSB <strickler>` | Banks Strickler value | 20.0 | Friction of the channel banks |
|
|
|
| `-X <offset>` | Offset along X axis | 0.0 | Moves the channel along its flow axis |
|
|
|
| `-Z <offset>` | Offset along Z axis | 0.0 | Raises the channel off the reference plane |
|
|
|
| `-N <num>` | Number of cross section | 100 | Number of cros sections to generate |
|
|
|
| `-CS <prefix>` | Cross section name prefix | 'CS' | This prefix will be appended with the cros section number to generate the unique names |
|
|
|
| `--R` | Reverse cross section order | (unset) | If set, cross section output order is reversed |
|
|
|
| `-MPS` | Midpoint shift | 0.5 | Relative position of the bank midpoint vertices |
|
|
|
| `--2D` | 2DM creation flag | (unset) | If set, also generate a 2DM mesh via Triangle |
|
|
|
| `--BED` | Add soil definitions | (unset) | If set, define a bottom range with soil index 1 |
|
|
|
| `-BS <node_index>` | Bed start index | 3 | Index of the node where the channel bed starts |
|
|
|
|
|
|
### Channels with widening
|
|
|
|
|
|
These channels support all of the basic channel tags.
|
|
|
|
|
|
In addition, the following tags are used to control the shape and position of the widened section:
|
|
|
|
|
|
| Switch | Full name | Default | Description |
|
|
|
|--------------------|--------------------------|---------|----------------------------------------------------------------------------------|
|
|
|
| `-LW <length>` | Widening length | 100.0 | The length of the straight, widened section |
|
|
|
| `-LT <length>` | Transition length | 20.0 | The length of the transitioning section between the regular and widened sections |
|
|
|
| `-WW <width>` | Widening width | 100.0 | Bed width of the widened section |
|
|
|
| `-KSW <strickler>` | Widening Strickler value | 30.0 | Strickler value for the channel bed in the widened section | |