View Javadoc
1   package org.opentrafficsim.demo;
2   
3   import java.io.Serializable;
4   import java.util.ArrayList;
5   import java.util.LinkedHashSet;
6   import java.util.List;
7   import java.util.Random;
8   import java.util.Set;
9   
10  import org.djunits.unit.DirectionUnit;
11  import org.djunits.unit.LengthUnit;
12  import org.djunits.unit.util.UNITS;
13  import org.djunits.value.vdouble.scalar.Acceleration;
14  import org.djunits.value.vdouble.scalar.Direction;
15  import org.djunits.value.vdouble.scalar.Length;
16  import org.djunits.value.vdouble.scalar.Speed;
17  import org.opentrafficsim.base.parameters.Parameters;
18  import org.opentrafficsim.core.dsol.AbstractOTSModel;
19  import org.opentrafficsim.core.dsol.OTSSimulatorInterface;
20  import org.opentrafficsim.core.geometry.OTSGeometryException;
21  import org.opentrafficsim.core.geometry.OTSPoint3D;
22  import org.opentrafficsim.core.gtu.GTUDirectionality;
23  import org.opentrafficsim.core.gtu.GTUException;
24  import org.opentrafficsim.core.gtu.GTUType;
25  import org.opentrafficsim.core.network.NetworkException;
26  import org.opentrafficsim.core.network.route.Route;
27  import org.opentrafficsim.road.gtu.lane.LaneBasedIndividualGTU;
28  import org.opentrafficsim.road.gtu.lane.tactical.following.IDMPlusFactory;
29  import org.opentrafficsim.road.gtu.lane.tactical.lmrs.DefaultLMRSPerceptionFactory;
30  import org.opentrafficsim.road.gtu.lane.tactical.lmrs.LMRSFactory;
31  import org.opentrafficsim.road.gtu.strategical.LaneBasedStrategicalPlanner;
32  import org.opentrafficsim.road.gtu.strategical.LaneBasedStrategicalPlannerFactory;
33  import org.opentrafficsim.road.gtu.strategical.route.LaneBasedStrategicalRoutePlannerFactory;
34  import org.opentrafficsim.road.network.OTSRoadNetwork;
35  import org.opentrafficsim.road.network.factory.LaneFactory;
36  import org.opentrafficsim.road.network.lane.DirectedLanePosition;
37  import org.opentrafficsim.road.network.lane.Lane;
38  import org.opentrafficsim.road.network.lane.LaneType;
39  import org.opentrafficsim.road.network.lane.OTSRoadNode;
40  
41  import nl.tudelft.simulation.dsol.SimRuntimeException;
42  import nl.tudelft.simulation.dsol.model.inputparameters.InputParameterDouble;
43  import nl.tudelft.simulation.dsol.model.inputparameters.InputParameterDoubleScalar;
44  import nl.tudelft.simulation.dsol.model.inputparameters.InputParameterException;
45  import nl.tudelft.simulation.dsol.model.inputparameters.InputParameterMap;
46  import nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface;
47  import nl.tudelft.simulation.jstats.streams.MersenneTwister;
48  import nl.tudelft.simulation.jstats.streams.StreamInterface;
49  
50  /**
51   * Simulate traffic on a circular, one-lane road.
52   * <p>
53   * Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
54   * BSD-style license. See <a href="http://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
55   * <p>
56   * $LastChangedDate: 2018-11-18 20:49:04 +0100 (Sun, 18 Nov 2018) $, @version $Revision: 4743 $, by $Author: averbraeck $,
57   * initial version 1 nov. 2014 <br>
58   * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
59   */
60  public class CircularLaneModel extends AbstractOTSModel implements UNITS
61  {
62      /** */
63      private static final long serialVersionUID = 20141121L;
64  
65      /** Number of cars created. */
66      private int carsCreated = 0;
67  
68      /** The probability that the next generated GTU is a passenger car. */
69      private double carProbability;
70  
71      /** Minimum distance. */
72      private Length minimumDistance = new Length(0, METER);
73  
74      /** The speed limit. */
75      private Speed speedLimit = new Speed(100, KM_PER_HOUR);
76  
77      /** The sequence of Lanes that all vehicles will follow. */
78      private List<Lane> path = new ArrayList<>();
79  
80      /** The left Lane that contains simulated Cars. */
81      private Lane lane1;
82  
83      /** The right Lane that contains simulated Cars. */
84      private Lane lane2;
85  
86      /** The random number generator used to decide what kind of GTU to generate etc. */
87      private StreamInterface stream = new MersenneTwister(12345);
88  
89      /** Strategical planner generator for cars. */
90      private LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalPlanner> strategicalPlannerGeneratorCars = null;
91  
92      /** Strategical planner generator for trucks. */
93      private LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalPlanner> strategicalPlannerGeneratorTrucks = null;
94  
95      /** Car parameters. */
96      private Parameters parametersCar;
97  
98      /** Truck parameters. */
99      private Parameters parametersTruck;
100 
101     /** The OTSRoadNetwork. */
102     private final OTSRoadNetwork network = new OTSRoadNetwork("network", true);
103 
104     /**
105      * @param simulator OTSSimulatorInterface; the simulator for this model
106      */
107     public CircularLaneModel(final OTSSimulatorInterface simulator)
108     {
109         super(simulator);
110         makeInputParameterMap();
111     }
112 
113     /**
114      * Make a map of input parameters for this demo.
115      */
116     public void makeInputParameterMap()
117     {
118         try
119         {
120             InputParameterHelper.makeInputParameterMapCarTruck(this.inputParameterMap, 4.0);
121             InputParameterMap genericMap = (InputParameterMap) this.inputParameterMap.get("generic");
122 
123             genericMap.add(new InputParameterDoubleScalar<LengthUnit, Length>("trackLength", "Track length",
124                     "Track length (circumfence of the track)", Length.instantiateSI(1000.0), Length.instantiateSI(500.0),
125                     Length.instantiateSI(2000.0), true, true, "%.0f", 1.0));
126             genericMap.add(new InputParameterDouble("densityMean", "Mean density (veh / km)",
127                     "mean density of the vehicles (vehicles per kilometer)", 30.0, 5.0, 45.0, true, true, "%.0f", 2.0));
128             genericMap.add(new InputParameterDouble("densityVariability", "Density variability",
129                     "Variability of the denisty: variability * (headway - 20) meters", 0.0, 0.0, 1.0, true, true, "%.00f",
130                     3.0));
131         }
132         catch (InputParameterException exception)
133         {
134             exception.printStackTrace();
135         }
136     }
137 
138     /** {@inheritDoc} */
139     @Override
140     public void constructModel() throws SimRuntimeException
141     {
142         try
143         {
144             this.carProbability = (double) getInputParameter("generic.carProbability");
145             double radius = ((Length) getInputParameter("generic.trackLength")).si / 2 / Math.PI;
146             double headway = 1000.0 / (double) getInputParameter("generic.densityMean");
147             double headwayVariability = (double) getInputParameter("generic.densityVariability");
148 
149             this.parametersCar = InputParameterHelper.getParametersCar(getInputParameterMap());
150             this.parametersTruck = InputParameterHelper.getParametersTruck(getInputParameterMap());
151 
152             this.strategicalPlannerGeneratorCars = new LaneBasedStrategicalRoutePlannerFactory(
153                     new LMRSFactory(new IDMPlusFactory(this.stream), new DefaultLMRSPerceptionFactory()));
154             this.strategicalPlannerGeneratorTrucks = new LaneBasedStrategicalRoutePlannerFactory(
155                     new LMRSFactory(new IDMPlusFactory(this.stream), new DefaultLMRSPerceptionFactory()));
156 
157             LaneType laneType = this.network.getLaneType(LaneType.DEFAULTS.TWO_WAY_LANE);
158             OTSRoadNode start = new OTSRoadNode(this.network, "Start", new OTSPoint3D(radius, 0, 0),
159                     new Direction(90, DirectionUnit.EAST_DEGREE));
160             OTSRoadNode halfway = new OTSRoadNode(this.network, "Halfway", new OTSPoint3D(-radius, 0, 0),
161                     new Direction(270, DirectionUnit.EAST_DEGREE));
162 
163             OTSPoint3D[] coordsHalf1 = new OTSPoint3D[127];
164             for (int i = 0; i < coordsHalf1.length; i++)
165             {
166                 double angle = Math.PI * (1 + i) / (1 + coordsHalf1.length);
167                 coordsHalf1[i] = new OTSPoint3D(radius * Math.cos(angle), radius * Math.sin(angle), 0);
168             }
169             this.lane1 = LaneFactory.makeMultiLane(this.network, "Lane1", start, halfway, coordsHalf1, 1, laneType,
170                     this.speedLimit, this.simulator)[0];
171             this.path.add(this.lane1);
172 
173             OTSPoint3D[] coordsHalf2 = new OTSPoint3D[127];
174             for (int i = 0; i < coordsHalf2.length; i++)
175             {
176                 double angle = Math.PI + Math.PI * (1 + i) / (1 + coordsHalf2.length);
177                 coordsHalf2[i] = new OTSPoint3D(radius * Math.cos(angle), radius * Math.sin(angle), 0);
178             }
179             this.lane2 = LaneFactory.makeMultiLane(this.network, "Lane2", halfway, start, coordsHalf2, 1, laneType,
180                     this.speedLimit, this.simulator)[0];
181             this.path.add(this.lane2);
182 
183             // Put the (not very evenly spaced) cars on track1
184             double trackLength = this.lane1.getLength().getSI();
185             double variability = (headway - 20) * headwayVariability;
186             System.out.println("headway is " + headway + " variability limit is " + variability);
187             Random random = new Random(12345);
188             for (double pos = 0; pos <= trackLength - headway - variability;)
189             {
190                 // Actual headway is uniformly distributed around headway
191                 double actualHeadway = headway + (random.nextDouble() * 2 - 1) * variability;
192                 generateCar(this.lane1, new Length(pos, METER));
193                 pos += actualHeadway;
194             }
195             // Put the (not very evenly spaced) cars on track2
196             trackLength = this.lane2.getLength().getSI();
197             variability = (headway - 20) * headwayVariability;
198             System.out.println("headway is " + headway + " variability limit is " + variability);
199             random = new Random(54321);
200             for (double pos = 0; pos <= trackLength - headway - variability;)
201             {
202                 // Actual headway is uniformly distributed around headway
203                 double actualHeadway = headway + (random.nextDouble() * 2 - 1) * variability;
204                 generateCar(this.lane2, new Length(pos, METER));
205                 pos += actualHeadway;
206             }
207 
208         }
209         catch (Exception exception)
210         {
211             exception.printStackTrace();
212         }
213     }
214 
215     /**
216      * Generate one gtu.
217      * @param initialPosition Length; the initial position of the new cars
218      * @param lane Lane; the lane on which the new cars are placed
219      * @throws GTUException when something goes wrong during construction of the car
220      */
221     protected final void generateCar(final Lane lane, final Length initialPosition) throws GTUException
222     {
223         // GTU itself
224         boolean generateTruck = this.stream.nextDouble() > this.carProbability;
225         Length vehicleLength = new Length(generateTruck ? 15 : 4, METER);
226         LaneBasedIndividualGTU gtu = new LaneBasedIndividualGTU("" + (++this.carsCreated),
227                 this.network.getGtuType(GTUType.DEFAULTS.CAR), vehicleLength, new Length(1.8, METER),
228                 new Speed(200, KM_PER_HOUR), vehicleLength.times(0.5), this.simulator, this.network);
229         gtu.setParameters(generateTruck ? this.parametersTruck : this.parametersCar);
230         gtu.setNoLaneChangeDistance(Length.ZERO);
231         gtu.setMaximumAcceleration(Acceleration.instantiateSI(3.0));
232         gtu.setMaximumDeceleration(Acceleration.instantiateSI(-8.0));
233 
234         // strategical planner
235         LaneBasedStrategicalPlanner strategicalPlanner;
236         Route route = null;
237         if (!generateTruck)
238         {
239             strategicalPlanner = this.strategicalPlannerGeneratorCars.create(gtu, route, null, null);
240         }
241         else
242         {
243             strategicalPlanner = this.strategicalPlannerGeneratorTrucks.create(gtu, route, null, null);
244         }
245 
246         // init
247         Set<DirectedLanePosition> initialPositions = new LinkedHashSet<>(1);
248         initialPositions.add(new DirectedLanePosition(lane, initialPosition, GTUDirectionality.DIR_PLUS));
249         Speed initialSpeed = new Speed(0, KM_PER_HOUR);
250         try
251         {
252             gtu.init(strategicalPlanner, initialPositions, initialSpeed);
253         }
254         catch (NetworkException | SimRuntimeException | OTSGeometryException exception)
255         {
256             throw new GTUException(exception);
257         }
258     }
259 
260     /**
261      * @return List&lt;Lane&gt;; the set of lanes for the specified index
262      */
263     public List<Lane> getPath()
264     {
265         return new ArrayList<>(this.path);
266     }
267 
268     /** {@inheritDoc} */
269     @Override
270     public OTSRoadNetwork getNetwork()
271     {
272         return this.network;
273     }
274 
275     /**
276      * @return minimumDistance
277      */
278     public final Length getMinimumDistance()
279     {
280         return this.minimumDistance;
281     }
282 
283     /**
284      * Stop simulation and throw an Error.
285      * @param theSimulator DEVSSimulatorInterface.TimeDoubleUnit; the simulator
286      * @param errorMessage String; the error message
287      */
288     public void stopSimulator(final DEVSSimulatorInterface.TimeDoubleUnit theSimulator, final String errorMessage)
289     {
290         System.out.println("Error: " + errorMessage);
291         try
292         {
293             if (theSimulator.isRunning())
294             {
295                 theSimulator.stop();
296             }
297         }
298         catch (SimRuntimeException exception)
299         {
300             exception.printStackTrace();
301         }
302         throw new Error(errorMessage);
303     }
304 
305     /** {@inheritDoc} */
306     @Override
307     public Serializable getSourceId()
308     {
309         return "CircularLaneModel";
310     }
311 
312 }