openswmm::twoD::sigma::ColumnStep Struct Reference

What one column sweep needs and what it reports back. More...

#include <SigmaColumn.hpp>

Collaboration diagram for openswmm::twoD::sigma::ColumnStep:

Public Attributes
double	L_old = 1.0
	column thickness before the table moved (m)
double	L_new = 1.0
	…and after (m). Default L̇ = (L_new − L_old)/dt.
double	dt = 1.0
	the cell's tier step (s)
bool	forward_euler = false
	hold the old-state ALE velocity in an RK stage
double	grid_rate = 0.0
	supplied Ldot for forward_euler; geometry still uses L_new
double	q_in = 0.0
	infiltration offered at the top (m/s, ≥ 0)
double	wilting_suction = 150.0
	SI suction magnitude; one top-boundary stress evaluation.
double	et_stress = 0.0
double	q_et = 0.0
	ET demand at the top (m/s, ≥ 0)
double	handover_theta
	<0: actual bottom layer; otherwise paired table storage coefficient
double	q0_phys = 0.0
	physical Darcy flux across the table (m/s)
bool	capillary = false
	include the diffusive term
const std::vector< double > *	layer_inflow
	accepted internal contact water depths (m)
ColumnTransfers *	transfers = nullptr
	optional accepted-sweep receipt
double	f_top = 0.0
	accepted top flux (m/s) — q_in after rejection
double	rejected = 0.0
	q_in − f_top (m/s, ≥ 0) back to the surface
double	f_bot = 0.0
	total bottom flux incl. handover (m/s)
double	et_taken = 0.0
	ET actually removed (m/s, ≤ q_et)
double	theta_bot = 0.0
	bottom-layer θ after the sweep (specific yield)
double	dt_limit = 1.0e30
double	overflow_to_sat = 0.0
double	deficit_from_sat = 0.0

Detailed Description

What one column sweep needs and what it reports back.

Member Data Documentation

capillary

bool openswmm::twoD::sigma::ColumnStep::capillary = false

include the diffusive term

deficit_from_sat

double openswmm::twoD::sigma::ColumnStep::deficit_from_sat = 0.0

…and the mirror: water (m/s) drawn UP from the table to hold layers at residual when the column stretches faster than the fluxes fill it.

dt

double openswmm::twoD::sigma::ColumnStep::dt = 1.0

the cell's tier step (s)

dt_limit

double openswmm::twoD::sigma::ColumnStep::dt_limit = 1.0e30

the column's own explicit stability bound (s)

et_stress

double openswmm::twoD::sigma::ColumnStep::et_stress = 0.0

et_taken

double openswmm::twoD::sigma::ColumnStep::et_taken = 0.0

ET actually removed (m/s, ≤ q_et)

f_bot

double openswmm::twoD::sigma::ColumnStep::f_bot = 0.0

total bottom flux incl. handover (m/s)

f_top

double openswmm::twoD::sigma::ColumnStep::f_top = 0.0

accepted top flux (m/s) — q_in after rejection

forward_euler

bool openswmm::twoD::sigma::ColumnStep::forward_euler = false

hold the old-state ALE velocity in an RK stage

grid_rate

double openswmm::twoD::sigma::ColumnStep::grid_rate = 0.0

supplied Ldot for forward_euler; geometry still uses L_new

handover_theta

double openswmm::twoD::sigma::ColumnStep::handover_theta

Initial value:

=
        -1.0

<0: actual bottom layer; otherwise paired table storage coefficient

L_new

double openswmm::twoD::sigma::ColumnStep::L_new = 1.0

…and after (m). Default L̇ = (L_new − L_old)/dt.

L_old

double openswmm::twoD::sigma::ColumnStep::L_old = 1.0

column thickness before the table moved (m)

layer_inflow

const std::vector<double>* openswmm::twoD::sigma::ColumnStep::layer_inflow

Initial value:

=
        nullptr

accepted internal contact water depths (m)

overflow_to_sat

double openswmm::twoD::sigma::ColumnStep::overflow_to_sat = 0.0

Water (m/s) the compressed column could not hold, delivered DOWN to the saturated zone in this same firing. A rising table saturates the column from below; clamping this away is the ALE failure plan gate 5 exists to catch, so it is routed and the solver must apply it.

q0_phys

double openswmm::twoD::sigma::ColumnStep::q0_phys = 0.0

physical Darcy flux across the table (m/s)

q_et

double openswmm::twoD::sigma::ColumnStep::q_et = 0.0

ET demand at the top (m/s, ≥ 0)

q_in

double openswmm::twoD::sigma::ColumnStep::q_in = 0.0

infiltration offered at the top (m/s, ≥ 0)

rejected

double openswmm::twoD::sigma::ColumnStep::rejected = 0.0

q_in − f_top (m/s, ≥ 0) back to the surface

theta_bot

double openswmm::twoD::sigma::ColumnStep::theta_bot = 0.0

bottom-layer θ after the sweep (specific yield)

transfers

ColumnTransfers* openswmm::twoD::sigma::ColumnStep::transfers = nullptr

optional accepted-sweep receipt

wilting_suction

double openswmm::twoD::sigma::ColumnStep::wilting_suction = 150.0

SI suction magnitude; one top-boundary stress evaluation.

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/2d/subsurface/SigmaColumn.hpp