openswmm_subcatchments.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_SUBCATCHMENTS_H
#define OPENSWMM_SUBCATCHMENTS_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =========================================================================
 * Identity
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_count(SWMM_Engine engine);
 
SWMM_ENGINE_API int swmm_subcatch_index(SWMM_Engine engine, const char* id);
 
SWMM_ENGINE_API const char* swmm_subcatch_id(SWMM_Engine engine, int idx);
 
/* =========================================================================
 * Creation (BUILDING or OPENED — "editable" states)
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_add(SWMM_Engine engine, const char* id);
 
/* =========================================================================
 * Property setters (BUILDING or OPENED)
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_set_outlet(SWMM_Engine engine, int idx, int node_idx);
 
SWMM_ENGINE_API int swmm_subcatch_set_area(SWMM_Engine engine, int idx, double area);
 
SWMM_ENGINE_API int swmm_subcatch_set_width(SWMM_Engine engine, int idx, double width);
 
SWMM_ENGINE_API int swmm_subcatch_set_slope(SWMM_Engine engine, int idx, double slope);
 
SWMM_ENGINE_API int swmm_subcatch_set_imperv_pct(SWMM_Engine engine, int idx, double pct);
 
SWMM_ENGINE_API int swmm_subcatch_set_n_imperv(SWMM_Engine engine, int idx, double n);
 
SWMM_ENGINE_API int swmm_subcatch_set_n_perv(SWMM_Engine engine, int idx, double n);
 
SWMM_ENGINE_API int swmm_subcatch_set_ds_imperv(SWMM_Engine engine, int idx, double ds);
 
SWMM_ENGINE_API int swmm_subcatch_set_ds_perv(SWMM_Engine engine, int idx, double ds);
 
SWMM_ENGINE_API int swmm_subcatch_set_gage(SWMM_Engine engine, int idx, int gage_idx);
 
/* --- Infiltration parameters (BUILDING or OPENED) --- */
 
SWMM_ENGINE_API int swmm_subcatch_set_infil_horton(SWMM_Engine engine, int idx,
                                                     double f0, double fmin,
                                                     double decay, double dry_time);
 
SWMM_ENGINE_API int swmm_subcatch_set_infil_green_ampt(SWMM_Engine engine, int idx,
                                                         double suction, double conductivity,
                                                         double initial_deficit);
 
SWMM_ENGINE_API int swmm_subcatch_set_infil_curve_number(SWMM_Engine engine, int idx,
                                                           double cn);
 
/* =========================================================================
 * Property getters
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_get_area(SWMM_Engine engine, int idx, double* area);
 
SWMM_ENGINE_API int swmm_subcatch_get_imperv_pct(SWMM_Engine engine, int idx, double* pct);
 
SWMM_ENGINE_API int swmm_subcatch_get_outlet(SWMM_Engine engine, int idx, int* node_idx);
 
SWMM_ENGINE_API int swmm_subcatch_get_width(SWMM_Engine engine, int idx, double* w);
 
SWMM_ENGINE_API int swmm_subcatch_get_slope(SWMM_Engine engine, int idx, double* s);
 
SWMM_ENGINE_API int swmm_subcatch_get_n_imperv(SWMM_Engine engine, int idx, double* n);
 
SWMM_ENGINE_API int swmm_subcatch_get_n_perv(SWMM_Engine engine, int idx, double* n);
 
SWMM_ENGINE_API int swmm_subcatch_get_ds_imperv(SWMM_Engine engine, int idx, double* ds);
 
SWMM_ENGINE_API int swmm_subcatch_get_ds_perv(SWMM_Engine engine, int idx, double* ds);
 
SWMM_ENGINE_API int swmm_subcatch_get_gage(SWMM_Engine engine, int idx, int* gage_idx);
 
SWMM_ENGINE_API int swmm_subcatch_set_outlet_subcatch(SWMM_Engine engine, int idx, int sc_idx);
 
SWMM_ENGINE_API int swmm_subcatch_get_outlet_subcatch(SWMM_Engine engine, int idx, int* sc_idx);
 
/* =========================================================================
 * Infiltration getters
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_get_infil_model(SWMM_Engine engine, int idx, int* model);
 
SWMM_ENGINE_API int swmm_subcatch_get_infil_horton(SWMM_Engine engine, int idx,
                                                          double* f0, double* fmin,
                                                          double* decay, double* dry_time);
 
SWMM_ENGINE_API int swmm_subcatch_get_infil_green_ampt(SWMM_Engine engine, int idx,
                                                          double* suction, double* conductivity,
                                                          double* deficit);
 
SWMM_ENGINE_API int swmm_subcatch_get_infil_curve_number(SWMM_Engine engine, int idx, double* cn);
 
/* =========================================================================
 * Subcatchment statistics
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_get_stat_precip(SWMM_Engine engine, int idx, double* vol);
 
SWMM_ENGINE_API int swmm_subcatch_get_stat_runoff_vol(SWMM_Engine engine, int idx, double* vol);
 
SWMM_ENGINE_API int swmm_subcatch_get_stat_max_runoff(SWMM_Engine engine, int idx, double* rate);
 
/* =========================================================================
 * Subcatchment landuse coverage
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_set_coverage(SWMM_Engine engine, int sc_idx, int lu_idx, double fraction);
 
SWMM_ENGINE_API int swmm_subcatch_get_coverage(SWMM_Engine engine, int sc_idx, int lu_idx, double* fraction);
 
/* =========================================================================
 * Hydraulic state getters
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_get_runoff(SWMM_Engine engine, int idx, double* runoff);
 
SWMM_ENGINE_API int swmm_subcatch_get_groundwater(SWMM_Engine engine, int idx, double* gw_flow);
 
SWMM_ENGINE_API int swmm_subcatch_get_rainfall(SWMM_Engine engine, int idx, double* rainfall);
 
SWMM_ENGINE_API int swmm_subcatch_get_snow_depth(SWMM_Engine engine, int idx, double* depth);
 
SWMM_ENGINE_API int swmm_subcatch_get_evap(SWMM_Engine engine, int idx, double* evap);
 
SWMM_ENGINE_API int swmm_subcatch_get_infil(SWMM_Engine engine, int idx, double* infil);
 
/* --- Runtime forcing (RUNNING state only) --- */
 
SWMM_ENGINE_API int swmm_subcatch_set_rainfall(SWMM_Engine engine, int idx, double rainfall);
 
/* =========================================================================
 * Water quality
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_get_quality(SWMM_Engine engine, int subcatch_idx,
                                               int pollutant_idx, double* conc);
 
/* =========================================================================
 * Bulk access
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_get_runoff_bulk(SWMM_Engine engine, double* buf, int count);
 
SWMM_ENGINE_API int swmm_subcatch_get_quality_bulk(SWMM_Engine engine, int pollutant_idx,
                                                    double* buf, int count);
 
/* =========================================================================
 * Phase 3 bulk getters — added in OpenSWMM 6.0.0 to eliminate the N
 * round-trip cost of per-subcatchment scalar accessors. All return a
 * caller-allocated @c double buffer of length @c count (clipped at
 * @c swmm_subcatch_count()); the IDs variant returns a stride-packed
 * UTF-8 buffer following the same format as @ref swmm_node_get_ids_bulk.
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_get_rainfall_bulk(SWMM_Engine engine, double* buf, int count);
 
SWMM_ENGINE_API int swmm_subcatch_get_evap_bulk(SWMM_Engine engine, double* buf, int count);
 
SWMM_ENGINE_API int swmm_subcatch_get_infil_bulk(SWMM_Engine engine, double* buf, int count);
 
SWMM_ENGINE_API int swmm_subcatch_get_snow_depth_bulk(SWMM_Engine engine, double* buf, int count);
 
SWMM_ENGINE_API int swmm_subcatch_get_ids_bulk(SWMM_Engine engine,
                                                char* buf,
                                                int stride,
                                                int count);
 
/* =========================================================================
 * Ponded quality (mass in standing water between events)
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_get_ponded_quality(SWMM_Engine engine,
    int subcatch_idx, int pollutant_idx, double* mass);
 
SWMM_ENGINE_API int swmm_subcatch_set_ponded_quality(SWMM_Engine engine,
    int subcatch_idx, int pollutant_idx, double mass);
 
SWMM_ENGINE_API int swmm_subcatch_rename(SWMM_Engine engine, int idx, const char* newId);
 
/* =========================================================================
 * Aquifer definitions ([AQUIFERS] section) — Slice BM.0 / BP.6.6.4
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_aquifer_count(SWMM_Engine engine);
 
SWMM_ENGINE_API int swmm_aquifer_index(SWMM_Engine engine, const char* id);
 
SWMM_ENGINE_API const char* swmm_aquifer_id(SWMM_Engine engine, int idx);
 
SWMM_ENGINE_API int swmm_aquifer_add(SWMM_Engine engine, const char* id);
 
/* =========================================================================
 * Snowpack definitions ([SNOWPACKS] section) — Slice BM.0 / BP.6.6.5
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_snowpack_count(SWMM_Engine engine);
 
SWMM_ENGINE_API int swmm_snowpack_index(SWMM_Engine engine, const char* id);
 
SWMM_ENGINE_API const char* swmm_snowpack_id(SWMM_Engine engine, int idx);
 
SWMM_ENGINE_API int swmm_snowpack_add(SWMM_Engine engine, const char* id);
 
/* =========================================================================
 * Tag — free-form string label from the INP `[TAGS]` section
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_subcatch_get_tag(SWMM_Engine engine, int idx,
                                            char* buf, int buflen);
 
SWMM_ENGINE_API int swmm_subcatch_set_tag(SWMM_Engine engine, int idx,
                                            const char* tag);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_SUBCATCHMENTS_H */