![]() |
OpenSWMM Engine
6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
|
Global surface pollutant buildup/washoff methods. More...
Functions | |
| void | surfqual_initState (int subcatchIndex) |
| Initializes pollutant buildup, ponded mass, and washoff. | |
| void | surfqual_getWashoff (int subcatchIndex, double runoff, double tStep) |
| Computes new runoff quality for a subcatchment. | |
| void | surfqual_getBuildup (int subcatchIndex, double tStep) |
| Adds to pollutant buildup on subcatchment surface. | |
| void | surfqual_applyAPIBuildup (int subcatchIndex) |
| Applies the buildup of a pollutant over a subcatchment for a given time step. | |
| void | surfqual_sweepBuildup (int subcatchIndex, DateTime aDate) |
| Reduces pollutant buildup over a subcatchment if sweeping occurs. | |
| double | surfqual_getWtdWashoff (int subcatchIndex, int pollutIndex, double wt) |
| Finds wtd. combination of old and new washoff for a pollutant. | |
Global surface pollutant buildup/washoff methods.
| void surfqual_applyAPIBuildup | ( | int | subcatchIndex | ) |
Applies the buildup of a pollutant over a subcatchment for a given time step.
| [in] | subcatchIndex | Subcatchment index |
Applies the buildup of a pollutant over a subcatchment for a given time step. API use is unconstrained by whether its is raining or not and other factors that apply to the inbuilt buildup function. Negative buildup may be applied in which case the function will not allow the buildup to go below zero.
Applies the buildup of a pollutant over a subcatchment for a given time step.
| [in] | subcatchIndex | Subcatchment index |
Applies the buildup of a pollutant over a subcatchment for a given time step. API use is unconstrained by whether its is raining or not and other factors that apply to the inbuilt buildup function. Negative buildup may be applied in which case the function will not allow the buildup to go below zero.
Applies the buildup of a pollutant over a subcatchment for a given time step.
| void surfqual_getBuildup | ( | int | subcatchIndex, |
| double | tStep | ||
| ) |
Adds to pollutant buildup on subcatchment surface.
| [in] | subcatchIndex | Subcatchment index |
| [in] | tStep | Time step (sec) |
Adds to pollutant buildup on subcatchment surface.
| [in] | subcatchIndex | Subcatchment index |
| [in] | tStep | Time step (sec) |
Adds to pollutant buildup on subcatchment surface.
| void surfqual_getWashoff | ( | int | subcatchIndex, |
| double | runoff, | ||
| double | tStep | ||
| ) |
Computes new runoff quality for a subcatchment.
| [in] | subcatchIndex | Subcatchment index |
| [in] | runoff | Total subcatchment runoff before internal re-routing or LID controls (ft/sec) |
| [in] | tStep | Time step (sec) |
Considers three pollutant generating streams that are combined together:
| double surfqual_getWtdWashoff | ( | int | j, |
| int | p, | ||
| double | f | ||
| ) |
Finds wtd. combination of old and new washoff for a pollutant.
| [in] | subcatchIndex | Subcatchment index |
| [in] | pollutIndex | Pollutant index |
| [in] | wt | Weighting factor |
| void surfqual_initState | ( | int | subcatchIndex | ) |
Initializes pollutant buildup, ponded mass, and washoff.
| [in] | subcatchIndex | Subcatchment index |
| void surfqual_sweepBuildup | ( | int | subcatchIndex, |
| DateTime | aDate | ||
| ) |
Reduces pollutant buildup over a subcatchment if sweeping occurs.
| [in] | subcatchIndex | Subcatchment index |
| [in] | aDate | Current date/time |