Classes
struct	GWContext

struct	GWSoA

class	GWSolver

Enumerations
enum	GWVar : int { GWV_HGW = 0 , GWV_HSW = 1 , GWV_HCB = 2 , GWV_HGS = 3 , GWV_KS = 4 , GWV_K = 5 , GWV_THETA = 6 , GWV_PHI = 7 , GWV_FI = 8 , GWV_FU = 9 , GWV_A = 10 , GWV_MAX = 11 }
	GW expression variable indices (matching legacy GWvariables enum). More...

Functions
int	gwf_validate (const std::string &expr, std::string &msg, int &col)
	Validate a [GWF] flow expression without compiling or storing it.

Variables
constexpr double	GWTOL

constexpr double	XTOL

Enumeration Type Documentation

◆ GWVar

enum openswmm::groundwater::GWVar : int

GW expression variable indices (matching legacy GWvariables enum).

Enumerator
GWV_HGW	Water table height.
GWV_HSW	Surface water head.
GWV_HCB	Channel bottom height (h_star)
GWV_HGS	Ground surface height (total_depth)
GWV_KS	Saturated conductivity.
GWV_K	Unsaturated conductivity.
GWV_THETA	Upper zone moisture content.
GWV_PHI	Porosity.
GWV_FI	Surface infiltration rate.
GWV_FU	Upper zone percolation rate.
GWV_A	Subcatchment area.
GWV_MAX

Function Documentation

◆ gwf_validate()

int openswmm::groundwater::gwf_validate	(	const std::string &	expr,
		std::string &	msg,
		int &	col )

Validate a [GWF] flow expression without compiling or storing it.

Diagnostic peer of mathexpr::parse for editors: a strict scan (unknown characters, malformed numbers and identifiers outside GW_VAR_NAMES / mathexpr::function_names() are errors, all case-insensitive), balanced parentheses, operand/operator sequencing including unary minus, and function arity (min/max take exactly 2 arguments, every other function exactly 1). An empty or whitespace-only expression is invalid.

Parameters

expr	Expression text.
msg	[out] Human-readable diagnostic ("" when valid).
col	[out] 0-based column of the error, or -1 when not attributable.

Returns: 0 when valid, -1 when invalid.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ GWTOL

double openswmm::constants::ode::GWTOL

constexpr

Groundwater ODE tolerance.

See also: Legacy: GWTOL in gwater.c

◆ XTOL

double openswmm::constants::XTOL

constexpr

Tolerance for bounding state variables.

See also: Legacy: XTOL in gwater.c

Classes

Enumerations

Functions