.set_persist_zero_flow(+)

Output configuration method

Description

This .set_persist_zero_flow(+) method allows you to indicate zero flow results should also be persisted. This holds for zero flow link segments, but also shortest paths for zero flow Origin-Destinations (ODs), and zero flow ODs.

This can be useful to quickly generate shortest paths for a large number of ODs even though they have no demand for example. Or you want to extract the free flow travel times for an empty network.

Signature

.set_persist_zero_flow(persist_zero_flow)

with

Parameter Type Unit Compulsory Default Description
persist_zero_flow bool - yes PERSIST_ZERO_FLOW Choice whether or not to persist zero flows

Return type

None

Example

from planit import *

# prep
planit_instance = Planit()
planit_instance.project.set(TrafficAssignment.TRADITIONAL_STATIC )

# choose to persist zero flows across outputs
planit_instance.project.output_configuration.set_persist_zero_flow(True)


# do other stuff 

See also

N/A

Source code

Class OutputConfigurationWrapper in projectwrappers.py