Package org.goplanit.supply.fundamentaldiagram

Class NewellFundamentalDiagram

java.lang.Object

org.goplanit.supply.fundamentaldiagram.FundamentalDiagramImpl

org.goplanit.supply.fundamentaldiagram.NewellFundamentalDiagram

All Implemented Interfaces:

FundamentalDiagram

public class NewellFundamentalDiagram
extends FundamentalDiagramImpl

Implementation of a Newell (triangular) fundamental diagram for a road section (link segment)

Author:

markr

Field Summary

Fields inherited from interface org.goplanit.supply.fundamentaldiagram.FundamentalDiagram

NEWELL

Constructor Summary

Constructors

Constructor	Description
NewellFundamentalDiagram(double freeSpeedKmHour)	Constructor using all defaults except for the free speed to apply
NewellFundamentalDiagram(double freeSpeedKmHour, double jamDensityPcuKm)	Constructor using all defaults except for the free speed to apply
NewellFundamentalDiagram(double freeSpeedKmHour, double capacityPcuHour, double jamDensityPcuKm)	Constructor using all defaults except for the free speed to apply
NewellFundamentalDiagram(LinearFundamentalDiagramBranch freeFlowBranch, LinearFundamentalDiagramBranch congestedBranch)	Constructor using all defaults except for the free speed to apply
NewellFundamentalDiagram(NewellFundamentalDiagram other, boolean deepCopy)	Copy constructor

Method Summary

Modifier and Type	Method	Description
protected double	computeBackwardWaveSpeedForCapacity(double capacityPcuHour)	Compute the backward wave speed that goes with a given capacity keeping all other variables the same
NewellFundamentalDiagram	deepClone()	deep clone of fundamental diagram
double	getCapacityFlowPcuHour()	Provide the capacity flow rate per hour
LinearFundamentalDiagramBranch	getCongestedBranch()	Congested branch of the FD
LinearFundamentalDiagramBranch	getFreeFlowBranch()	Free flow branch of the FD
void	setCapacityPcuHour(double capacityPcuHour)	For the Newell FD this means that all remains the same except for the congested wave speed to ensure the FD remains viable since the capacity is derived and not explicitly set.
void	setMaximumDensityPcuKmHour(double maxDensityPcuKm)	Change the maximum density to the new value
void	setMaximumSpeedKmHour(double maxSpeedKmHour)	Change the maximum speed to the new value
NewellFundamentalDiagram	shallowClone()	Shallow copy of the fundamental diagram

Methods inherited from class org.goplanit.supply.fundamentaldiagram.FundamentalDiagramImpl

relaxedHashCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.goplanit.supply.fundamentaldiagram.FundamentalDiagram

getMaximumDensityPcuKm, getMaximumSpeedKmHour

Constructor Detail

NewellFundamentalDiagram

public NewellFundamentalDiagram(double freeSpeedKmHour)

Constructor using all defaults except for the free speed to apply

Parameters:

freeSpeedKmHour - to use

NewellFundamentalDiagram

public NewellFundamentalDiagram(double freeSpeedKmHour,
                                double jamDensityPcuKm)

Constructor using all defaults except for the free speed to apply

Parameters:

freeSpeedKmHour - to use

jamDensityPcuKm - maximum density allowed

NewellFundamentalDiagram

public NewellFundamentalDiagram(double freeSpeedKmHour,
                                double capacityPcuHour,
                                double jamDensityPcuKm)

Constructor using all defaults except for the free speed to apply

Parameters:

freeSpeedKmHour - to use

capacityPcuHour - to allow

jamDensityPcuKm - maximum density allowed

NewellFundamentalDiagram

public NewellFundamentalDiagram(LinearFundamentalDiagramBranch freeFlowBranch,
                                LinearFundamentalDiagramBranch congestedBranch)

Constructor using all defaults except for the free speed to apply

Parameters:

freeFlowBranch - to use

congestedBranch - to use

NewellFundamentalDiagram

public NewellFundamentalDiagram(NewellFundamentalDiagram other,
                                boolean deepCopy)

Copy constructor

Parameters:

other - to copy

deepCopy - when true, create a deep copy, shallow copy otherwise

Method Detail

computeBackwardWaveSpeedForCapacity

protected double computeBackwardWaveSpeedForCapacity(double capacityPcuHour)

Compute the backward wave speed that goes with a given capacity keeping all other variables the same

Parameters:

capacityPcuHour - to compute backward wave speed for ceteris paribus

Returns:

proposed backward wave speed

getFreeFlowBranch

public LinearFundamentalDiagramBranch getFreeFlowBranch()

Free flow branch of the FD

Specified by:

getFreeFlowBranch in interface FundamentalDiagram

Overrides:

getFreeFlowBranch in class FundamentalDiagramImpl

Returns:

free flow branch

getCongestedBranch

public LinearFundamentalDiagramBranch getCongestedBranch()

Congested branch of the FD

Specified by:

getCongestedBranch in interface FundamentalDiagram

Overrides:

getCongestedBranch in class FundamentalDiagramImpl

Returns:

congested branch

getCapacityFlowPcuHour

public double getCapacityFlowPcuHour()

Provide the capacity flow rate per hour

Returns:

capacity flow rate in pcu per hour

shallowClone

public NewellFundamentalDiagram shallowClone()

Shallow copy of the fundamental diagram

Specified by:

shallowClone in interface FundamentalDiagram

Specified by:

shallowClone in class FundamentalDiagramImpl

Returns:

cloned instance

deepClone

public NewellFundamentalDiagram deepClone()

deep clone of fundamental diagram

Specified by:

deepClone in interface FundamentalDiagram

Specified by:

deepClone in class FundamentalDiagramImpl

Returns:

cloned instance

setCapacityPcuHour

public void setCapacityPcuHour(double capacityPcuHour)

For the Newell FD this means that all remains the same except for the congested wave speed to ensure the FD remains viable since the capacity is derived and not explicitly set. By chaning the backward wave speed to the adjusted value we ensure we obtain the desired capacity

Parameters:

capacityPcuHour - to use

setMaximumDensityPcuKmHour

public void setMaximumDensityPcuKmHour(double maxDensityPcuKm)

Change the maximum density to the new value

Parameters:

maxDensityPcuKm - to use

setMaximumSpeedKmHour

public void setMaximumSpeedKmHour(double maxSpeedKmHour)

Change the maximum speed to the new value

Parameters:

maxSpeedKmHour - to use