How a node the channel burn converts is configured as an outfall (CHANNEL_BURN_IN_PLAN_2026-09-21.md §6). More...

#include <mapundostack.h>

Collaboration diagram for GeneratedOutfallSpec:

Public Attributes
bool	applyOutfall = false
	Master switch; false = retype only.

int	outfallType = kOutfallNormal

bool	flapGate = false
	Must stay false for a coupled outfall.

bool	hasInvert = false

double	invert = 0.0
	The channel bottom at the coupling point.

bool	hasMaxDepth = false

double	maxDepth = 0.0
	Mesh bed elevation at the coupling point − invert.

QString	tag
	e.g. "burn:outfall", so the run is reversible by hand.

Static Public Attributes
static constexpr int	kOutfallNormal = 1
	0=FREE 1=NORMAL 2=FIXED 3=TIDAL 4=TIMESERIES.

Detailed Description

How a node the channel burn converts is configured as an outfall (CHANNEL_BURN_IN_PLAN_2026-09-21.md §6).

Every field is optional so the command stays usable as a plain retype. The defaults are the burn's: a NORMAL, UNGATED outfall — a Gated YES flap gate BLOCKS the 2D tailwater override (2D_INPUT_FORMAT_SPEC §4.4), which would silently disable the very coupling the conversion exists to create.

Member Data Documentation

◆ applyOutfall

bool GeneratedOutfallSpec::applyOutfall = false

Master switch; false = retype only.

◆ flapGate

bool GeneratedOutfallSpec::flapGate = false

Must stay false for a coupled outfall.

◆ hasInvert

bool GeneratedOutfallSpec::hasInvert = false

◆ hasMaxDepth

bool GeneratedOutfallSpec::hasMaxDepth = false

◆ invert

double GeneratedOutfallSpec::invert = 0.0

The channel bottom at the coupling point.

◆ kOutfallNormal

constexpr int GeneratedOutfallSpec::kOutfallNormal = 1

staticconstexpr

0=FREE 1=NORMAL 2=FIXED 3=TIDAL 4=TIMESERIES.

◆ maxDepth

double GeneratedOutfallSpec::maxDepth = 0.0

Mesh bed elevation at the coupling point − invert.

◆ outfallType

int GeneratedOutfallSpec::outfallType = kOutfallNormal

◆ tag

QString GeneratedOutfallSpec::tag

e.g. "burn:outfall", so the run is reversible by hand.

The documentation for this struct was generated from the following file:

/home/runner/work/openswmm.gui/openswmm.gui/include/map/mapundostack.h

Public Attributes

Static Public Attributes