openswmm_massbalance_impl.cpp File Reference

C API implementation — continuity errors and flux totals. More...

#include "openswmm_api_common.hpp"
#include "../../../include/openswmm/engine/openswmm_massbalance.h"

Include dependency graph for openswmm_massbalance_impl.cpp:

Functions
SWMM_ENGINE_API int	swmm_get_runoff_continuity_error (SWMM_Engine engine, double *error)
	Get the runoff continuity error (fraction, e.g. 0.001 = 0.1%).
SWMM_ENGINE_API int	swmm_get_routing_continuity_error (SWMM_Engine engine, double *error)
	Get the routing continuity error (fraction).
SWMM_ENGINE_API int	swmm_get_quality_continuity_error (SWMM_Engine engine, int pollutant_idx, double *error)
	Get the quality continuity error for a pollutant (fraction).
SWMM_ENGINE_API int	swmm_get_runoff_total (SWMM_Engine engine, int component, double *volume)
	Get a runoff mass balance total (cumulative volume).
SWMM_ENGINE_API int	swmm_get_routing_total (SWMM_Engine engine, int component, double *volume)
	Get a routing mass balance total (cumulative volume).

Detailed Description

C API implementation — continuity errors and flux totals.

See also

include/openswmm/engine/openswmm_massbalance.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_get_quality_continuity_error()

SWMM_ENGINE_API int swmm_get_quality_continuity_error	(	SWMM_Engine	engine,
		int	pollutant_idx,
		double *	error
	)

Get the quality continuity error for a pollutant (fraction).

swmm_get_routing_continuity_error()

SWMM_ENGINE_API int swmm_get_routing_continuity_error	(	SWMM_Engine	engine,
		double *	error
	)

Get the routing continuity error (fraction).

swmm_get_routing_total()

SWMM_ENGINE_API int swmm_get_routing_total	(	SWMM_Engine	engine,
		int	component,
		double *	volume
	)

Get a routing mass balance total (cumulative volume).

Parameters

engine	Engine handle.
component	SWMM_RoutingTotal code.
volume	[out] Cumulative volume (project volume units).

Returns

SWMM_OK or error code.

swmm_get_runoff_continuity_error()

SWMM_ENGINE_API int swmm_get_runoff_continuity_error	(	SWMM_Engine	engine,
		double *	error
	)

Get the runoff continuity error (fraction, e.g. 0.001 = 0.1%).

swmm_get_runoff_total()

SWMM_ENGINE_API int swmm_get_runoff_total	(	SWMM_Engine	engine,
		int	component,
		double *	volume
	)

Get a runoff mass balance total (cumulative volume).

Parameters

engine	Engine handle.
component	SWMM_RunoffTotal code.
volume	[out] Cumulative volume (project volume units).

Returns

SWMM_OK or error code.