openswmm_statistics.h File Reference

OpenSWMM Engine — Statistics Query C API. More...

#include "openswmm_engine.h"

Include dependency graph for openswmm_statistics.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
SWMM_ENGINE_API int	swmm_stat_node_max_depth (SWMM_Engine engine, int idx, double *val)
	Maximum depth at a node (project length units).
SWMM_ENGINE_API int	swmm_stat_node_max_overflow (SWMM_Engine engine, int idx, double *val)
	Maximum overflow rate at a node (project flow units).
SWMM_ENGINE_API int	swmm_stat_node_vol_flooded (SWMM_Engine engine, int idx, double *val)
	Total volume flooded at a node (project volume units).
SWMM_ENGINE_API int	swmm_stat_node_time_flooded (SWMM_Engine engine, int idx, double *val)
	Total time flooded at a node (hours).
SWMM_ENGINE_API int	swmm_stat_link_max_flow (SWMM_Engine engine, int idx, double *val)
	Maximum flow in a link (project flow units).
SWMM_ENGINE_API int	swmm_stat_link_max_velocity (SWMM_Engine engine, int idx, double *val)
	Maximum velocity in a link (project length/time units).
SWMM_ENGINE_API int	swmm_stat_link_max_filling (SWMM_Engine engine, int idx, double *val)
	Maximum depth/full-depth ratio in a link.
SWMM_ENGINE_API int	swmm_stat_link_vol_flow (SWMM_Engine engine, int idx, double *val)
	Total volume conveyed through a link (project volume units).
SWMM_ENGINE_API int	swmm_stat_link_surcharge_time (SWMM_Engine engine, int idx, double *val)
	Total surcharge time for a link (hours).
SWMM_ENGINE_API int	swmm_stat_subcatch_precip (SWMM_Engine engine, int idx, double *val)
	Total precipitation volume at a subcatchment (project volume units).
SWMM_ENGINE_API int	swmm_stat_subcatch_runoff_vol (SWMM_Engine engine, int idx, double *val)
	Total runoff volume from a subcatchment (project volume units).
SWMM_ENGINE_API int	swmm_stat_subcatch_max_runoff (SWMM_Engine engine, int idx, double *val)
	Maximum runoff rate from a subcatchment (project flow units).
SWMM_ENGINE_API int	swmm_stat_node_max_depth_bulk (SWMM_Engine engine, double *buf, int count)
	Get maximum depth for all nodes into a caller-supplied buffer.
SWMM_ENGINE_API int	swmm_stat_link_max_flow_bulk (SWMM_Engine engine, double *buf, int count)
	Get maximum flow for all links into a caller-supplied buffer.
SWMM_ENGINE_API int	swmm_stat_subcatch_runoff_vol_bulk (SWMM_Engine engine, double *buf, int count)
	Get total runoff volume for all subcatchments into a caller-supplied buffer.

Detailed Description

OpenSWMM Engine — Statistics Query C API.

Provides functions for querying cumulative statistics for nodes, links, and subcatchments after (or during) simulation.

See also

openswmm_engine.h

Author

Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com

Copyright

Copyright (c) 2026 HydroCouple. All rights reserved.

License\n MIT License

Function Documentation

swmm_stat_link_max_filling()

SWMM_ENGINE_API int swmm_stat_link_max_filling	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Maximum depth/full-depth ratio in a link.

swmm_stat_link_max_flow()

SWMM_ENGINE_API int swmm_stat_link_max_flow	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Maximum flow in a link (project flow units).

swmm_stat_link_max_flow_bulk()

SWMM_ENGINE_API int swmm_stat_link_max_flow_bulk	(	SWMM_Engine	engine,
		double *	buf,
		int	count
	)

Get maximum flow for all links into a caller-supplied buffer.

swmm_stat_link_max_velocity()

SWMM_ENGINE_API int swmm_stat_link_max_velocity	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Maximum velocity in a link (project length/time units).

swmm_stat_link_surcharge_time()

SWMM_ENGINE_API int swmm_stat_link_surcharge_time	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Total surcharge time for a link (hours).

swmm_stat_link_vol_flow()

SWMM_ENGINE_API int swmm_stat_link_vol_flow	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Total volume conveyed through a link (project volume units).

swmm_stat_node_max_depth()

SWMM_ENGINE_API int swmm_stat_node_max_depth	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Maximum depth at a node (project length units).

swmm_stat_node_max_depth_bulk()

SWMM_ENGINE_API int swmm_stat_node_max_depth_bulk	(	SWMM_Engine	engine,
		double *	buf,
		int	count
	)

Get maximum depth for all nodes into a caller-supplied buffer.

swmm_stat_node_max_overflow()

SWMM_ENGINE_API int swmm_stat_node_max_overflow	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Maximum overflow rate at a node (project flow units).

swmm_stat_node_time_flooded()

SWMM_ENGINE_API int swmm_stat_node_time_flooded	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Total time flooded at a node (hours).

swmm_stat_node_vol_flooded()

SWMM_ENGINE_API int swmm_stat_node_vol_flooded	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Total volume flooded at a node (project volume units).

swmm_stat_subcatch_max_runoff()

SWMM_ENGINE_API int swmm_stat_subcatch_max_runoff	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Maximum runoff rate from a subcatchment (project flow units).

swmm_stat_subcatch_precip()

SWMM_ENGINE_API int swmm_stat_subcatch_precip	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Total precipitation volume at a subcatchment (project volume units).

swmm_stat_subcatch_runoff_vol()

SWMM_ENGINE_API int swmm_stat_subcatch_runoff_vol	(	SWMM_Engine	engine,
		int	idx,
		double *	val
	)

Total runoff volume from a subcatchment (project volume units).

swmm_stat_subcatch_runoff_vol_bulk()

SWMM_ENGINE_API int swmm_stat_subcatch_runoff_vol_bulk	(	SWMM_Engine	engine,
		double *	buf,
		int	count
	)

Get total runoff volume for all subcatchments into a caller-supplied buffer.