Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate withHoles options for 'TrafficDynamics'. Also, we have depr… #3573

Merged
merged 2 commits into from
Nov 18, 2024
Merged

Deprecate withHoles options for 'TrafficDynamics'. Also, we have depr… #3573

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1ba807
Deprecate withHoles options for 'TrafficDynamics'. Also, we have depr…
Nov 18, 2024
da19120
Merge branch 'master' into deprecate-traffic-dynamics-options
kainagel Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions matsim/src/main/java/org/matsim/core/config/groups/QSimConfigGroup.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,20 +431,35 @@ public void setInsertingWaitingVehiclesBeforeDrivingVehicles(boolean val) {
this.insertingWaitingVehiclesBeforeDrivingVehicles = val;
}

/**
* This determines the traffic dynamics of a link. The default is 'queue', but the recommended setting is kinematic waves.
*
* DEPRECATION NOTE: 'withHoles' is deprecated, use 'kinematicWaves' instead, as that uses 'withHoles' and adds an inflow capacity on top.
*/
public enum TrafficDynamics {
queue, withHoles,
queue,
@Deprecated
withHoles,
kinematicWaves // MATSim-630; previously, the switch was InflowConstraint.maxflowFromFdiag. Amit Jan 2017.
}

/**
* Defines how the qsim sets the inflow and/or how it reacts to link attributes which are inconsistent with regard to the fundamental diagram. <br>
*
* <li>Note that {@code MAX_CAP_FOR_ONE_LANE} is backwards-compatible but always sets the inflow capacity to the maximum according to the fundamental diagram for one lane,
* so it essentially sets the inflow capacity too low for multiple-lane-links. </li>
* <li>{@code INFLOW_FROM_FDIAG} sets the inflow capacity to maximum flow capacity according to the fundamental diagram, assuming the nr of lanes in the link attributes to be correct.</li>
* <li>{@code NR_OF_LANES_FROM_FDIAG} sets the number of lanes to minimum required according to the fundamental diagram, assuming the flow capacity in the link attributes to be correct.</li>
* so it essentially sets the inflow capacity too low for multiple-lane-links. DEPRECATED: This is only for backwards compatibility. Use
* INFLOW_FROM_FDIAG instead.</li>
* <li>{@code INFLOW_FROM_FDIAG} sets the inflow capacity to maximum flow capacity according to the
* fundamental diagram, assuming the nr of lanes in the link attributes to be correct.</li>
* <li>{@code NR_OF_LANES_FROM_FDIAG} sets the number of lanes to minimum required according to the fundamental
* diagram, assuming the flow capacity in the link attributes to be correct. DEPRECATED: In practice the other setting is used most often! Use\
* INFLOW_FROM_FDIAG instead.</li>
*/
public enum InflowCapacitySetting {INFLOW_FROM_FDIAG, NR_OF_LANES_FROM_FDIAG, MAX_CAP_FOR_ONE_LANE}
public enum InflowCapacitySetting {INFLOW_FROM_FDIAG,
@Deprecated
NR_OF_LANES_FROM_FDIAG,
@Deprecated
MAX_CAP_FOR_ONE_LANE}

@StringSetter(TRAFFIC_DYNAMICS)
public void setTrafficDynamics(final TrafficDynamics str) {
Expand Down
Loading