openswmm_forcing_impl.cpp File Reference

C API implementation — runtime forcing with mass-balance tracking. More...

#include "openswmm_api_common.hpp"
#include "../../../include/openswmm/engine/openswmm_forcing.h"
#include "../data/ForcingData.hpp"

Include dependency graph for openswmm_forcing_impl.cpp:

Functions
SWMM_ENGINE_API int	swmm_forcing_node_lat_inflow (SWMM_Engine engine, int idx, double value, int mode, int persist)
	Force a lateral inflow at a node.
SWMM_ENGINE_API int	swmm_forcing_node_head_boundary (SWMM_Engine engine, int idx, double value, int mode, int persist)
	Force a head boundary at an outfall node.
SWMM_ENGINE_API int	swmm_forcing_node_quality (SWMM_Engine engine, int node_idx, int pollutant_idx, double mass_rate, int mode, int persist)
	Force a quality mass flux at a node.
SWMM_ENGINE_API int	swmm_forcing_link_flow (SWMM_Engine engine, int idx, double value, int mode, int persist)
	Force a flow in a link.
SWMM_ENGINE_API int	swmm_forcing_link_setting (SWMM_Engine engine, int idx, double value, int mode, int persist)
	Force a control setting on a link (pump, orifice, weir, outlet).
SWMM_ENGINE_API int	swmm_forcing_subcatch_rainfall (SWMM_Engine engine, int idx, double value, int mode, int persist)
	Force rainfall on a subcatchment (bypasses gage lookup).
SWMM_ENGINE_API int	swmm_forcing_subcatch_evap (SWMM_Engine engine, int idx, double value, int mode, int persist)
	Force an evaporation rate on a subcatchment.
SWMM_ENGINE_API int	swmm_forcing_gage_rainfall (SWMM_Engine engine, int idx, double value, int mode, int persist)
	Force rainfall on a rain gage (affects all linked subcatchments).
SWMM_ENGINE_API int	swmm_forcing_clear (SWMM_Engine engine, int type, int idx)
	Clear forcing on a specific element and channel.
SWMM_ENGINE_API int	swmm_forcing_clear_all (SWMM_Engine engine)
	Clear ALL forcings on ALL elements.

Detailed Description

C API implementation — runtime forcing with mass-balance tracking.

See also

include/openswmm/engine/openswmm_forcing.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