Package org.goplanit.algorithms.nodemodel

Class TampereNodeModelInput

java.lang.Object

org.goplanit.algorithms.nodemodel.TampereNodeModelInput

public class TampereNodeModelInput
extends Object

Inner class that allows the user to set all inputs for the TampereNodeModel, it takes fixed inputs and supplements it with the information of the variable inputs, meaning inputs that can vary during the simulation such as turn sending flows (t_ab), and potentially receiving flows (r_b)

Field Summary

Fields

Modifier and Type	Field	Description
protected org.ojalgo.array.Array1D<Double>	capacityScalingFactors	the scaling factor to scale sending flows up to capacity per in link segment
protected TampereNodeModelFixedInput	fixedInput	fixed inputs to use
protected org.ojalgo.array.Array1D<Double>	outgoingLinkSegmentReceivingFlows	store the available receiving flows of each outgoing link segment
protected org.ojalgo.array.Array2D<Double>	turnSendingFlows	the turn sending flows offered to the node model t_ab

Constructor Summary

Constructors

Constructor	Description
TampereNodeModelInput(TampereNodeModelFixedInput fixedInput, org.ojalgo.array.Array2D<Double> turnSendingFlows)	Constructor for a particular node model run
TampereNodeModelInput(TampereNodeModelFixedInput fixedInput, org.ojalgo.array.Array2D<Double> turnSendingFlows, org.ojalgo.array.Array1D<Double> outgoingLinkSegmentReceivingFlows)	Constructor for a particular node model run.

Method Summary

Modifier and Type	Method	Description
org.ojalgo.array.Array1D<Double>	getCapacityScalingFactors()	Collect the computed capacity scaling factors per in-link segment a such that lambda_a = C_a/Sum_b(t_ab)
TampereNodeModelFixedInput	getFixedInput()	Provide access to the fixed input
org.ojalgo.array.Array2D<Double>	getTurnSendingFlows()	Access to the used turn sending flows
org.ojalgo.array.Array1D<Double>	getUsedReceivingFlows()	The receiving flows used

Methods inherited from class java.lang.Object

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

Field Detail

fixedInput

protected final TampereNodeModelFixedInput fixedInput

fixed inputs to use

turnSendingFlows

protected org.ojalgo.array.Array2D<Double> turnSendingFlows

the turn sending flows offered to the node model t_ab

outgoingLinkSegmentReceivingFlows

protected org.ojalgo.array.Array1D<Double> outgoingLinkSegmentReceivingFlows

store the available receiving flows of each outgoing link segment

capacityScalingFactors

protected org.ojalgo.array.Array1D<Double> capacityScalingFactors

the scaling factor to scale sending flows up to capacity per in link segment

Constructor Detail

TampereNodeModelInput

public TampereNodeModelInput(TampereNodeModelFixedInput fixedInput,
                             org.ojalgo.array.Array2D<Double> turnSendingFlows)
                      throws PlanItException

Constructor for a particular node model run

Parameters:

fixedInput - the fixed inputs to use

turnSendingFlows - the turn sending flows

Throws:

PlanItException - thrown if error

TampereNodeModelInput

public TampereNodeModelInput(TampereNodeModelFixedInput fixedInput,
                             org.ojalgo.array.Array2D<Double> turnSendingFlows,
                             org.ojalgo.array.Array1D<Double> outgoingLinkSegmentReceivingFlows)
                      throws PlanItException

Constructor for a particular node model run. Here the receiving flows are provided explicitly, overriding the fixed receiving flows (if any) from the networkMapping

Parameters:

fixedInput - the fixed inputs to use

turnSendingFlows - the turn sending flows

outgoingLinkSegmentReceivingFlows - the receiving flows

Throws:

PlanItException - thrown if error

Method Detail

getCapacityScalingFactors

public org.ojalgo.array.Array1D<Double> getCapacityScalingFactors()

Collect the computed capacity scaling factors per in-link segment a such that lambda_a = C_a/Sum_b(t_ab)

Returns:

capacityScalingFactor

getFixedInput

public TampereNodeModelFixedInput getFixedInput()

Provide access to the fixed input

Returns:

fixed input used

getTurnSendingFlows

public org.ojalgo.array.Array2D<Double> getTurnSendingFlows()

Access to the used turn sending flows

Returns:

turn sending flows

getUsedReceivingFlows

public org.ojalgo.array.Array1D<Double> getUsedReceivingFlows()

The receiving flows used

Returns:

receiving flows used