OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
Global Conveyance System Routing Methods

Global conveyance system routing methods. More...

Collaboration diagram for Global Conveyance System Routing Methods:

Functions

int routing_open (void)
 Initializes the routing analyzer.
 
double routing_getRoutingStep (int routingModel, double fixedStep)
 Determines time step used for flow routing at current time period.
 
void routing_execute (int routingModel, double routingStep)
 Executes the routing process at the current time period.
 
void routing_close (int routingModel)
 Closes down the routing analyzer.
 

Detailed Description

Global conveyance system routing methods.

Function Documentation

◆ routing_close()

void routing_close ( int routingModel)

Closes down the routing analyzer.

Parameters
[in]routingModelRouting method code
Implementation arguments
  • routingModel (in): Routing method code.
Here is the call graph for this function:

◆ routing_execute()

void routing_execute ( int routingModel,
double routingStep )

Executes the routing process at the current time period.

Parameters
[in]routingModelRouting method code
[in]routingStepRouting time step (sec)
Implementation arguments
  • routingModel (in): Routing method code.
  • routingStep (in): Routing time step (sec).
Here is the call graph for this function:

◆ routing_getRoutingStep()

double routing_getRoutingStep ( int routingModel,
double fixedStep )

Determines time step used for flow routing at current time period.

Parameters
[in]routingModelRouting method code
[in]fixedStepUser-supplied time step (sec)
Returns
Time step used for flow routing (sec)
Implementation arguments
  • routingModel (in): Routing method code
  • fixedStep (in): User-supplied time step (sec)
    Returns
    Time step used for flow routing (sec)
Here is the call graph for this function:

◆ routing_open()

int routing_open ( void )

Initializes the routing analyzer.

Returns
Error code
An error code.
Here is the call graph for this function: