 |
OpenSWMM Engine
6.0.0-alpha.3
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.3)
|
|
OpenSWMM Engine
6.0.0-alpha.3
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.3)
|
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 "UnitConversion.hpp"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) |
| Prescribe a potential evapotranspiration (PET) rate on a subcatchment. | |
| SWMM_ENGINE_API int | swmm_climate_get_evap_rate (SWMM_Engine engine, double *value) |
| Get the current climate-derived evaporation rate. | |
| SWMM_ENGINE_API int | swmm_forcing_subcatch_snowfall (SWMM_Engine engine, int idx, double value, int mode, int persist) |
| Prescribe snowfall on a subcatchment. | |
| SWMM_ENGINE_API int | swmm_forcing_climate_temperature (SWMM_Engine engine, double value, int mode, int persist) |
| Prescribe the air temperature used for snowmelt and temperature-derived evaporation. | |
| SWMM_ENGINE_API int | swmm_climate_get_temperature (SWMM_Engine engine, double *value) |
| Get the current air temperature (read-only). | |
| SWMM_ENGINE_API int | swmm_forcing_climate_wind (SWMM_Engine engine, double value, int mode, int persist) |
| Prescribe the wind speed used in rain-on-snow melt. | |
| SWMM_ENGINE_API int | swmm_climate_get_wind_speed (SWMM_Engine engine, double *value) |
| Get the current wind speed (read-only). | |
| SWMM_ENGINE_API int | swmm_forcing_climate_evap (SWMM_Engine engine, double value, int mode, int persist) |
| Prescribe the system-wide evaporation rate. | |
| SWMM_ENGINE_API int | swmm_climate_set_dry_only (SWMM_Engine engine, int flag) |
| Set the evaporation DRY_ONLY option at runtime. | |
| SWMM_ENGINE_API int | swmm_climate_get_dry_only (SWMM_Engine engine, int *flag) |
| Get the evaporation DRY_ONLY option. | |
| SWMM_ENGINE_API int | swmm_forcing_link_quality (SWMM_Engine engine, int link_idx, int pollutant_idx, double value, int mode, int persist) |
| Force pollutant quality on a link. | |
| 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. | |
C API implementation — runtime forcing with mass-balance tracking.
1.13.2