Loading...
Searching...
No Matches
mesh::MeshEdgeBC Struct Reference

Boundary condition, conveyance factor and wall drag of one cell-edge slot. More...

#include <mesh/meshedgebc.h>

Collaboration diagram for mesh::MeshEdgeBC:

Public Member Functions

bool operator== (const MeshEdgeBC &o) const noexcept
 Compare every stored boundary-condition and conveyance attribute exactly.
 
bool operator!= (const MeshEdgeBC &o) const noexcept
 Negate exact all-field boundary-condition equality.
 

Public Attributes

MeshBCTypes::Type type = MeshBCTypes::Type::Wall
 Variant; Wall (default) when unset.
 
double head = 0.0
 Stage for SpecifiedStageConst (project vert. units)
 
double slope
 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
 Optional named group ("" = none)
 
double conveyance = 1.0
 Engine §11A — per-edge flux attenuation in [0, 1].
 
double wallDrag = 0.0
 WALL tangential Cw; tau/rho=-Cw|ut|ut, zero free-slip.
 

Detailed Description

Boundary condition, conveyance factor and wall drag of one cell-edge slot.

Plain value type; only the fields relevant to type are meaningful, the rest keep their defaults. Units are the authored project units; nothing is converted or validated here.

Member Function Documentation

◆ operator!=()

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

Negate exact all-field boundary-condition equality.

Parameters
[in]oBorrowed other value, unchanged.
Returns
Logical negation of operator==, including its exact floating/string comparisons and NaN behavior. No boundary validation, mutation or engine synchronization.

◆ operator==()

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

Compare every stored boundary-condition and conveyance attribute exactly.

Parameters
[in]oBorrowed other value, unchanged.
Returns
True only if type, head, slope, flow, timeseries, curve, group, conveyance and wallDrag all compare equal. No floating tolerance or normalization is applied; NaN fields compare unequal even to themselves. No allocation, mesh mutation or engine synchronization.

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
Initial value:
=
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

Variant; Wall (default) when unset.

◆ wallDrag

double mesh::MeshEdgeBC::wallDrag = 0.0

WALL tangential Cw; tau/rho=-Cw|ut|ut, zero free-slip.


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