SWMM5 Code MindMaps

SWMM5  MindMap by John Dickinson

Imagemap




swmm swmm_open project_open initPointers setDefaults openFiles swmm_start rain_open initRainFile rdii_openRdii project_init rdii_initUnitHyd snow_initSnowmelt table_init inflow_initDwfPattern output_open output_openOutFile output_saveID runoff_open odesolve_open runoff_initFile climate_openFile routing_open treatmnt_open toposort_sortLinks iface_openRoutingFiles openHotstartFile1 flowrout_init validateGeneralLayout dynwave_init initNodeDepths initLinkDepths validateTreeLayout initNodes initLinks massbal_open subcatch_getStorage snow_getSnowCover gwater_getVolume massbal_getBuildup massbal_getStoredMass massbal_initTimeStepTotals stats_open swmm_step execRouting runoff_execute climate_setState gage_setState runoff_readFromFile runoff_getTimeStep subcatch_setOldState subcatch_getRunon snow_plowSnow subcatch_getBuildup subcatch_sweepBuildup subcatch_getWashoff stats_updateMaxRunoff runoff_saveToFile routing_execute massbal_updateRoutingTotals link_setTargetSetting controls_evaluate clearActionList evaluatePremise updateActionValue updateActionList executeActionList link_setSetting orifice_setSetting weir_setSetting massbal_getStepFlowError massbal_initTimeStepTotals node_setOldQualState link_setOldQualState addExternalInflows inflow_getExtInflow massbal_addInflowFlow inflow_getExtInflow massbal_addInflowQual addDryWeatherInflows inflow_getDwfInflow massbal_addInflowFlow massbal_addInflowQual addWetWeatherInflows subcatch_getWtdOutflow massbal_addInflowFlow massbal_addInflowQual addGroundwaterInflows massbal_addInflowFlow massbal_addInflowQual addRdiiInflows rdii_getNumRdiiFlows massbal_addInflowFlow massbal_addInflowQual addIfaceInflows iface_getNumIfaceNodes massbal_addInflowFlow massbal_addInflowQual systemHasChanged link_setOldHydState node_setOldHydState node_initInflow flowrout_execute dynwave_execute execRoutingStep initNodeState node_getPondedArea node_getSurfArea findConduitFlow getConduitFlow getFlowClass link_getYnorm xsect_getAofS xsect_getYofA link_getYcrit xsect_getYcrit getYcritEnum getQcritical xsect_getAofY xsect_getWofY getYcritRidder getQcritical findroot_Ridder findSurfArea getWidth getArea xsect_getAofY getHydRad xsect_getRofY link_getFroude xsect_isOpen xsect_getAofY xsect_getWofY xsect_isOpen forcemain_getFricSlope forcemain_getReynolds forcemain_getFricFactor findLocalLosses culvert_getInflow checkNormalFlow link_setFlapGate link_getLength conduit_getLength updateNodeFlows findNonConduitFlow link_getInflow conduit_getInflow pump_getInflow orifice_getInflow weir_getInflow outlet_getInflow node_getOutflow divider_getOutflow storage_getOutflow getModPumpFlow node_getMaxOutflow findNonConduitSurfArea updateNodeFlows link_setOutfallDepth link_getYnorm link_getYcrit node_setOutletDepth outfall_setOutletDepth checkCapacity updateStorageState getStorageOutflow node_getLosses node_getPondedDepth node_getDepth getLinkInflow link_getInflow node_getMaxOutflow steadyflow_execute xsect_getAofS kinwave_execute xsect_getAofS link_getLength linsolveContinuityk_getLength solveContinuity findroot_Newton evalContinuity xsect_getSofA xsect_getdSdA xsect_getSofA setNewNodeState node_getDepth setNewLinkState xsect_getYofA updateNodeDepth qualrout_execute findLinkMassFlow treatment_setInflow findStorageQual findNodeQual treatmnt_treat findLinkQual removeStorageLosses removeOutflows massbal_updateRoutingTotals stats_updateFlowStats output_saveResults swmm_end output_end massbal_report massbal_getRunoffError report_writeRunoffError massbal_getLoadingError report_writeLoadingError massbal_getGwaterError report_writeGwaterError massbal_getFlowError report_writeFlowError massbal_getQualError report_writeQualError stats_report stats_findMaxStats report_writeMaxStats report_writeMaxFlowTurns statsrpt_writeReport massbal_close rain_close rdii_closeRdii runoff_close odesolve_close routing_close saveHotstartFile iface_closeRoutingFiles flowrout_close treatmnt_close swmm_report output_checkFileSize report_writeReport report_Subcatchments report_Nodes report_Links swmm_close output_close project_close deleteObjects deleteHashTables

hide
swmm
hide
swmm_open
hide
project_open
leaf
initPointers
leaf
setDefaults
leaf
openFiles
hide
swmm_start
hide
rain_open
leaf
initRainFile
leaf
rdii_openRdii
hide
project_init
leaf
rdii_initUnitHyd
leaf
snow_initSnowmelt
leaf
table_init
leaf
inflow_initDwfPattern
hide
output_open
leaf
output_openOutFile
leaf
output_saveID
hide
runoff_open
leaf
odesolve_open
leaf
runoff_initFile
leaf
climate_openFile
hide
routing_open
leaf
treatmnt_open
leaf
toposort_sortLinks
leaf
iface_openRoutingFiles
leaf
openHotstartFile1
hide
flowrout_init

Arrow Link
leaf
validateGeneralLayout
leaf
dynwave_init
leaf
initNodeDepths
leaf
initLinkDepths
leaf
validateTreeLayout
leaf
initNodes
leaf
initLinks
hide
massbal_open
leaf
subcatch_getStorage
leaf
snow_getSnowCover
leaf
gwater_getVolume
leaf
massbal_getBuildup
leaf
massbal_getStoredMass
leaf
massbal_initTimeStepTotals
leaf
stats_open
hidefull-1
swmm_step
hidefull-1
execRouting
hide
runoff_execute
leaf
climate_setState
leaf
gage_setState
leaf
runoff_readFromFile
leaf
runoff_getTimeStep
leaf
subcatch_setOldState
leaf
subcatch_getRunon
leaf
snow_plowSnow
leaf
subcatch_getBuildup
leaf
subcatch_sweepBuildup
leaf
subcatch_getWashoff
leaf
stats_updateMaxRunoff
leaf
runoff_saveToFile
hidefull-1
routing_execute
leaf
massbal_updateRoutingTotals
leaf
link_setTargetSetting
hide
controls_evaluate
leaf
clearActionList
leaf
evaluatePremise
leaf
updateActionValue
leaf
updateActionList
leaf
executeActionList
hide
link_setSetting
leaf
orifice_setSetting
leaf
weir_setSetting
leaf
massbal_getStepFlowError
leaf
massbal_initTimeStepTotals
leaf
node_setOldQualState
leaf
link_setOldQualState
hide
addExternalInflows
leaf
inflow_getExtInflow
leaf
massbal_addInflowFlow
leaf
inflow_getExtInflow
leaf
massbal_addInflowQual
hide
addDryWeatherInflows
leaf
inflow_getDwfInflow
leaf
massbal_addInflowFlow
leaf
massbal_addInflowQual
hide
addWetWeatherInflows
leaf
subcatch_getWtdOutflow
leaf
massbal_addInflowFlow
leaf
massbal_addInflowQual
hide
addGroundwaterInflows
leaf
massbal_addInflowFlow
leaf
massbal_addInflowQual
hide
addRdiiInflows
leaf
rdii_getNumRdiiFlows
leaf
massbal_addInflowFlow
leaf
massbal_addInflowQual
hide
addIfaceInflows
leaf
iface_getNumIfaceNodes
leaf
massbal_addInflowFlow
leaf
massbal_addInflowQual
leaf
systemHasChanged

checks if the hydraulic state of the system has changed from the previous time step.

leaf
link_setOldHydState

replaces link's old hydraulic state values with current ones.

leaf
node_setOldHydState

replaces a node's old water quality state values with new ones.

leaf
node_initInflow

initializes a node's inflow at start of next time step.

hidefull-1
flowrout_execute
hidefull-1
dynwave_execute
hide
execRoutingStep
hide
initNodeState

initializes node's surface area, inflow & outflow

leaf
node_getPondedArea

computes surface area of water at a node based on depth.

leaf
node_getSurfArea

computes surface area of water stored at a node from water depth.

hide
findConduitFlow

finds new flow in a conduit-type link

hide
getConduitFlow

updates flow in conduit link by solving finite difference form of continuity and momentum equations.

hide
getFlowClass

determines flow class for a conduit based on depths at each end.

hide
link_getYnorm

computes normal depth for given flow rate.

leaf
xsect_getAofS
leaf
xsect_getYofA
hide
link_getYcrit

computes critical depth for given flow rate.

hide
xsect_getYcrit

computes critical depth at a specific flow rate

hide
getYcritEnum

solves a * sqrt(a(y)*g / w(y)) - q for y using interval enumeration with starting guess of y0.

hide
getQcritical

finds difference between critical flow at depth yc and target value Qcritical.

leaf
xsect_getAofY

computes xsection's area at a given depth.

leaf
xsect_getWofY

computes xsection's top width at a given depth.

hide
getYcritRidder

solves a * sqrt(a(y)*g / w(y)) - q for y using Ridder's root finding method with starting guess of y0.

leaf
getQcritical
leaf
findroot_Ridder
hide
findSurfArea

assigns surface area of conduit to its up and downstream nodes.

leaf
getWidth
hide
getArea

computes area of flow cross-section in a conduit

leaf
xsect_getAofY
hide
getHydRad

computes hydraulic radius of flow cross-section in a conduit.

leaf
xsect_getRofY
hide
link_getFroude

computes Froude Number for given velocity and flow depth

leaf
xsect_isOpen
leaf
xsect_getAofY
leaf
xsect_getWofY
leaf
xsect_isOpen
hide
forcemain_getFricSlope

computes the headloss per unit length used in dynamic wave flow routing for a pressurized force main using either the Hazen-Williams or Darcy-Weisbach flow equations.

leaf
forcemain_getReynolds
leaf
forcemain_getFricFactor
leaf
findLocalLosses

computes local losses term of momentum equation.

leaf
culvert_getInflow
leaf
checkNormalFlow

checks if flow in link should be replaced by normal flow.

leaf
link_setFlapGate

based on the sign of the flow, determines if a flap gate associated with the link should close or not.

hide
link_getLength
leaf
conduit_getLength

finds true length of a conduit

leaf
updateNodeFlows

updates cumulative inflow & outflow at link's end nodes.

hide
findNonConduitFlow

finds new flow in a non-conduit-type link

hide
link_getInflow

finds total flow entering a link during current time step.

leaf
conduit_getInflow
leaf
pump_getInflow
leaf
orifice_getInflow
leaf
weir_getInflow
leaf
outlet_getInflow
hide
node_getOutflow

computes outflow from node available for inflow into a link.

leaf
divider_getOutflow
leaf
storage_getOutflow
hide
getModPumpFlow

modifies pump curve pumping rate depending on amount of water available at pump's inlet node.

leaf
node_getMaxOutflow

limits outflow rate from a node with storage volume.

leaf
findNonConduitSurfArea

finds the surface area contributed by a non-conduit link to its upstream and downstream nodes.

leaf
updateNodeFlows

updates cumulative inflow & outflow at link's end nodes.

hide
link_setOutfallDepth

sets depth at outfall node connected to link j.

leaf
link_getYnorm
leaf
link_getYcrit
hide
node_setOutletDepth

sets water depth at a node that serves as an outlet point.

leaf
outfall_setOutletDepth
leaf
checkCapacity

determines if a conduit link is capacity limited.

hide
updateStorageState

updates depth and volume of a storage node using successive approximation with under-relaxation for Steady or Kin. Wave routing.

leaf
getStorageOutflow
leaf
node_getLosses
leaf
node_getPondedDepth
leaf
node_getDepth
hide
getLinkInflow

finds flow into upstream end of link at current time step under Steady or Kin. Wave routing.

leaf
link_getInflow
leaf
node_getMaxOutflow
hide
steadyflow_execute

performs steady flow routing through a single link.

leaf
xsect_getAofS
hide
kinwave_execute

finds outflow over time step t Step given flow entering a conduit using Kinematic Wave flow routing.

leaf
xsect_getAofS
leaf
link_getLength
leaf
linsolveContinuityk_getLength
hide
solveContinuity

solves continuity equation  f(a) = Beta1*S(a) + C1*a + C2 = 0 for 'a' using the Newton-Raphson root finder function.

Return code has the following meanings: 

>= 0 number of function evaluations used

-1   Newton function failed

-2   flow always above max. flow

-3   flow always below zero

leaf
findroot_Newton
hide
evalContinuity

computes value of continuity equation (f) and its derivative (df) w.r.t. normalized area for link with normalized outlet area 'a'.

leaf
xsect_getSofA
leaf
xsect_getdSdA
leaf
xsect_getSofA
hide
setNewNodeState

updates state of node after current time step for Steady Flow or Kinematic Wave flow routing.

leaf
node_getDepth
hide
setNewLinkState

updates state of link after current time step under Steady Flow or Kinematic Wave flow routing

leaf
xsect_getYofA
leaf
updateNodeDepth
hide
qualrout_execute
leaf
findLinkMassFlow
leaf
treatment_setInflow
leaf
findStorageQual
leaf
findNodeQual
leaf
treatmnt_treat
leaf
findLinkQual
leaf
removeStorageLosses
leaf
removeOutflows
leaf
massbal_updateRoutingTotals
leaf
stats_updateFlowStats
leaf
output_saveResults
hide
swmm_end
leaf
output_end
hide
massbal_report
leaf
massbal_getRunoffError
leaf
report_writeRunoffError
leaf
massbal_getLoadingError
leaf
report_writeLoadingError
leaf
massbal_getGwaterError
leaf
report_writeGwaterError
leaf
massbal_getFlowError
leaf
report_writeFlowError
leaf
massbal_getQualError
leaf
report_writeQualError
hide
stats_report
leaf
stats_findMaxStats
leaf
report_writeMaxStats
leaf
report_writeMaxFlowTurns
leaf
statsrpt_writeReport
leaf
massbal_close
hide
rain_close
leaf
rdii_closeRdii
hide
runoff_close
leaf
odesolve_close
hide
routing_close
leaf
saveHotstartFile
leaf
iface_closeRoutingFiles
leaf
flowrout_close
leaf
treatmnt_close
hide
swmm_report
leaf
output_checkFileSize
hide
report_writeReport
leaf
report_Subcatchments
leaf
report_Nodes
leaf
report_Links
hide
swmm_close
leaf
output_close
hide
project_close
leaf
deleteObjects
leaf
deleteHashTables

You need to be a member of SWMM 5 or SWMM or EPASWMM - (not formally associated with EPA) to add comments!

Join SWMM 5 or SWMM or EPASWMM - (not formally associated with EPA)