Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add initial inlet control api functions #389

Merged
merged 1 commit into from
Mar 28, 2023
Merged

add initial inlet control api functions #389

merged 1 commit into from
Mar 28, 2023

Conversation

karosc
Copy link
Member

@karosc karosc commented Mar 28, 2023

This PR adds some basic api functionality for inlets of street links in SWMM 5.2.3.

3 new api functions:

  • swmm_getInletParam: get parameters assigned to inlets of a given street link. The parameters are only those assigned to the inlets of a given street, NOT the inlets designs upon which they are based.
  • swmm_setInletParam: set parameters assigned to inlets of a given street link. Currently only clog factor and flow limit are supported and can be set during a simulation to approximate progressive inlet clogging.
  • swmm_getInletResult: result data associated with inlets that are otherwise only internal to the SWMM model. These may or may not be useful for modelers......TBD
    • flow capture: the captured flow rate by the inlet
    • back flow: the back flow rate from the capture node of an inlet
    • back flow ratio: inlet backflow / capture node overflow

@karosc karosc requested a review from bemcdonnell March 28, 2023 13:42
Copy link
Member

@bemcdonnell bemcdonnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These new entry points look really nice.. I think they will be pretty useful!

@karosc karosc merged commit 2e5b21d into develop Mar 28, 2023
@karosc karosc deleted the init_inlet_api branch March 28, 2023 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants