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).

SWMM_ENGINE_API int	swmm_get_routing_stats (SWMM_Engine engine, double avg_step, double min_step, double max_step, int n_steps, double pct_non_converged, double avg_iterations, double *max_courant)
	Get combined routing statistics in a single call.

SWMM_ENGINE_API int	swmm_get_max_courant (SWMM_Engine engine, double *max_courant)
	Get maximum Courant number observed during simulation.

SWMM_ENGINE_API int	swmm_get_quality_seep_loss (SWMM_Engine engine, int pollutant_idx, double *mass)
	Get quality mass lost to seepage (per pollutant).

SWMM_ENGINE_API int	swmm_get_quality_evap_loss (SWMM_Engine engine, int pollutant_idx, double *mass)
	Get quality mass lost to evaporation (per pollutant).

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 Caleb Buahin. All rights reserved.

License\n MIT License

Function Documentation

◆ swmm_get_max_courant()

SWMM_ENGINE_API int swmm_get_max_courant	(	SWMM_Engine	engine,
		double *	max_courant
	)

Get maximum Courant number observed during simulation.

◆ 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_quality_evap_loss()

SWMM_ENGINE_API int swmm_get_quality_evap_loss	(	SWMM_Engine	engine,
		int	pollutant_idx,
		double *	mass
	)

Get quality mass lost to evaporation (per pollutant).

◆ swmm_get_quality_seep_loss()

SWMM_ENGINE_API int swmm_get_quality_seep_loss	(	SWMM_Engine	engine,
		int	pollutant_idx,
		double *	mass
	)

Get quality mass lost to seepage (per pollutant).

◆ 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_stats()

SWMM_ENGINE_API int swmm_get_routing_stats	(	SWMM_Engine	engine,
		double *	avg_step,
		double *	min_step,
		double *	max_step,
		int *	n_steps,
		double *	pct_non_converged,
		double *	avg_iterations,
		double *	max_courant
	)

Get combined routing statistics in a single call.

◆ 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).