Road Network

Type: object

Description of the vehicles and the road-network graph.

root graph
Type: object

root graph edges
Type: array of array

Edges of the graph, represented as a tuple (s, t, e), where s is the id of the source node, t is the id of the target node and e is the description of the edge.

Must contain a minimum of 1 items

Each item of this array must be:

root graph edges edges items
Type: array

Must contain a minimum of 3 items

Must contain a maximum of 3 items

Tuple Validation

Item at 1 must be:
root graph edges edges items edges items item 0
Type: integerFormat: uint32

Value must be greater or equal to 0.0

Item at 2 must be:
root graph edges edges items edges items item 1
Type: integerFormat: uint32

Value must be greater or equal to 0.0

Item at 3 must be:
root graph edges edges items RoadEdge_for_double
Type: object

An edge of a road network that connects two nodes.
Example:

{
    "base_speed": 13.88888888888889,
    "bottleneck_flow": 0.4,
    "constant_travel_time": 4.0,
    "lanes": 2,
    "length": 100.0,
    "overtaking": true,
    "speed_density": {
        "type": "ThreeRegimes",
        "value": {
            "beta": 2.0,
            "jam_density": 0.8,
            "jam_speed": 2.7777777777777777,
            "min_density": 0.3
        }
    }
}

root graph edges edges items Road Edge base_speed
Type: number

The base speed of the edge.

Value must be greater or equal to 0.0

root graph edges edges items Road Edge length
Type: number

The length of the edge, from source node to target node.

Value must be greater or equal to 0.0

root graph edges edges items Road Edge lanes
Type: integerFormat: uint8 Default: 1

The number of lanes on the edge.

Value must be greater or equal to 1.0

root graph edges edges items Road Edge speed_density
Type: object

Speed-density function for the running part of the edge.

root graph edges edges items Road Edge speed_density oneOf item 0
Type: object

Vehicles always travel at free-flow speed.

root graph edges edges items Road Edge speed_density oneOf item 0 type
Type: enum (of string)

Must be one of:

  • "FreeFlow"
root graph edges edges items Road Edge speed_density oneOf item 1
Type: object

Vehicles travel at free-flow speed when flow is below edge capacity. Then, speed is inversely proportional to flow.

The parameter represents the capacity of each lane of the edge, in length unit per time unit.

root graph edges edges items Road Edge speed_density oneOf item 1 type
Type: enum (of string)

Must be one of:

  • "Bottleneck"

root graph edges edges items Road Edge speed_density oneOf item 1 value
Type: numberFormat: double
root graph edges edges items Road Edge speed_density oneOf item 2
Type: object

A speed-density function with three regimes: free flow, congested and traffic jam.

root graph edges edges items Road Edge speed_density oneOf item 2 type
Type: enum (of string)

Must be one of:

  • "ThreeRegimes"

root graph edges edges items Road Edge speed_density oneOf item 2 value
Type: object

A speed-density function with three regimes.

The three regimes are:

  1. Free-flow regime. If density on the edge is smaller than min_density, travel time is equal to free-flow travel time.

  2. Congested regime. If density on the edge is between min_density and jam_density, speed is equal to v = v0 * (1 - c) + jam_speed * c, where v0 is the free-flow speed and c = ((density - min_density) / (jam_density - min_density))^beta.

  3. Traffic jam. If density on the edge is larger than jam_density, travel time is equal to tt = distance / jam_speed.

root graph edges edges items Road Edge speed_density oneOf item 2 value min_density
Type: numberFormat: double

Density on the edge (between 0.0 and 1.0) below which the speed is equal to free-flow speed.

root graph edges edges items Road Edge speed_density oneOf item 2 value jam_density
Type: numberFormat: double

Density on the edge (between 0.0 and 1.0) above which the speed is equal to jam speed.

root graph edges edges items Road Edge speed_density oneOf item 2 value jam_speed
Type: number

Speed at which the vehicle travel in case of traffic jam.

root graph edges edges items Road Edge speed_density oneOf item 2 value beta
Type: numberFormat: double

Parameter to compute the speed in the congested regime.

root graph edges edges items Road Edge bottleneck_flow
Type: number Default: "Infinity"

Maximum flow of vehicle entering the edge (in PCE per second).

root graph edges edges items Road Edge constant_travel_time
Type: number Default: "0"

Constant travel time penalty for the runnning part of the edge.

root graph edges edges items Road Edge overtaking
Type: boolean Default: true

If true, vehicles can overtaking each other at the exit bottleneck (if they have a different outgoing edge).

root vehicles
Type: array

Must contain a minimum of 1 items

Each item of this array must be:

root vehicles Vehicle_for_double
Type: object

A road vehicle with a given (headway) length, passenger car equivalent and speed function.
Examples:

{
    "allowed_edges": [],
    "headway": 8.0,
    "pce": 1.0,
    "restricted_edges": [],
    "speed_function": {
        "type": "Multiplicator",
        "value": 0.8
    }
}

{
    "allowed_edges": [],
    "headway": 20.0,
    "pce": 3.0,
    "restricted_edges": [
        1,
        0
    ],
    "speed_function": {
        "type": "Piecewise",
        "value": [
            [
                0.0,
                0.0
            ],
            [
                90.0,
                90.0
            ],
            [
                130.0,
                90.0
            ]
        ]
    }
}

root vehicles Vehicle headway
Type: number

Headway length of the vehicle, used to compute vehicle density on the edges.
Alias: length

root vehicles Vehicle pce
Type: number

Passenger car equivalent of the vehicle, used to compute bottleneck flow.

root vehicles Vehicle speed_function
Type: object

Speed function that gives the vehicle speed as a function of the edge base speed.

root vehicles Vehicle speed_function oneOf item 0
Type: object

The identity function.

root vehicles Vehicle speed_function oneOf item 0 type
Type: enum (of string)

Must be one of:

  • "Base"
root vehicles Vehicle speed_function oneOf item 1
Type: object

A linear function: f(s) = a * s.

root vehicles Vehicle speed_function oneOf item 1 type
Type: enum (of string)

Must be one of:

  • "Multiplicator"

root vehicles Vehicle speed_function oneOf item 1 value
Type: numberFormat: double
root vehicles Vehicle speed_function oneOf item 2
Type: object

A piecewise-linear function, represented by a vector of breakpoints (x, y), where x is the base speed on the edge and y is the effective speed.

The breakpoints (x, y) must be ordered by increasing x.

If the edge's base speed is out of bound (i.e., smaller than the smaller x value or larger than the largest x value), the base speed is used as the effective speed.

root vehicles Vehicle speed_function oneOf item 2 type
Type: enum (of string)

Must be one of:

  • "Piecewise"

root vehicles Vehicle speed_function oneOf item 2 value
Type: array of array

Each item of this array must be:

root vehicles Vehicle speed_function oneOf item 2 value value items
Type: array

Must contain a minimum of 2 items

Must contain a maximum of 2 items

Each item of this array must be:

root vehicles Vehicle speed_function oneOf item 2 value value items Speed_for_double
Type: number

Representation of a speed, expressed in meters per second.

root vehicles Vehicle allowed_edges
Type: array Default: []

Set of edge indices that the vehicle is allowed to take (by default, all edges are allowed, unlesse specified in restricted_edges).

Each item of this array must be:

root vehicles Vehicle allowed_edges EdgeIndex
Type: integer

Value must be greater or equal to 0.0

root vehicles Vehicle restricted_edges
Type: array Default: []

Set of edge indices that the vehicle cannot take. Note that restricted_edges is ignored if allowed_edges is specified.

Each item of this array must be:

root vehicles Vehicle restricted_edges EdgeIndex
Type: integer

Value must be greater or equal to 0.0