SWMMVis  6.0.0-alpha.4
Qt6/C++ GIS-based graphical user interface for the SWMMVis engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
mesh::MeshEdgeBC Struct Reference

#include <meshedgebc.h>

Collaboration diagram for mesh::MeshEdgeBC:

Public Member Functions

bool operator== (const MeshEdgeBC &o) const noexcept
 
bool operator!= (const MeshEdgeBC &o) const noexcept
 

Public Attributes

MeshBCTypes::Type type = MeshBCTypes::Type::Wall
 
double head = 0.0
 Stage for SpecifiedStageConst (project vert. units)
 
double slope = 0.0
 Bed slope for NormalFlow (dimensionless; must be > 0 — the engine treats 0 as a wall)
 
double flow = 0.0
 Discharge per metre for SpecifiedFlowConst (flow units / m)
 
QString tseries
 TS name for *TS variants.
 
QString curve
 Curve name for RatingCurve.
 
QString group
 
double conveyance = 1.0
 

Member Function Documentation

◆ operator!=()

bool mesh::MeshEdgeBC::operator!= ( const MeshEdgeBC o) const
inlinenoexcept

◆ operator==()

bool mesh::MeshEdgeBC::operator== ( const MeshEdgeBC o) const
inlinenoexcept

Member Data Documentation

◆ conveyance

double mesh::MeshEdgeBC::conveyance = 1.0

Engine §11A — per-edge flux attenuation in [0, 1]. Default 1.0 (unrestricted). Multiplies the flux in SurfaceFluxCalculator. Applies to ALL edges (interior + boundary) — orthogonal to type. Interior edges store the same value in both neighbour slots; the layer's applyMeshEdgeConveyance helper enforces the mirror.

◆ curve

QString mesh::MeshEdgeBC::curve

Curve name for RatingCurve.

◆ flow

double mesh::MeshEdgeBC::flow = 0.0

Discharge per metre for SpecifiedFlowConst (flow units / m)

◆ group

QString mesh::MeshEdgeBC::group

Optional named group ("" = none)

◆ head

double mesh::MeshEdgeBC::head = 0.0

Stage for SpecifiedStageConst (project vert. units)

◆ slope

double mesh::MeshEdgeBC::slope = 0.0

Bed slope for NormalFlow (dimensionless; must be > 0 — the engine treats 0 as a wall)

◆ tseries

QString mesh::MeshEdgeBC::tseries

TS name for *TS variants.

◆ type

MeshBCTypes::Type mesh::MeshEdgeBC::type = MeshBCTypes::Type::Wall

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