add bike on networks

src/main/java/org/matsim/run/RunOpenBerlinScenarioWithBikeOnNetwork.java

@@ -0,0 +1,157 @@
+package org.matsim.run;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.apache.logging.log4j.core.tools.picocli.CommandLine;
+import org.matsim.api.core.v01.Scenario;
+import org.matsim.application.MATSimApplication;
+import org.matsim.core.config.Config;
+import org.matsim.core.config.groups.ReplanningConfigGroup;
+import org.matsim.core.controler.Controler;
+import com.google.common.collect.Sets;
+import org.matsim.api.core.v01.TransportMode;
+import org.matsim.contrib.bicycle.BicycleConfigGroup;
+import org.matsim.core.config.ConfigUtils;
+import org.matsim.core.config.groups.QSimConfigGroup;
+import org.matsim.api.core.v01.Id;
+import org.matsim.api.core.v01.network.Link;
+import org.matsim.api.core.v01.population.Person;
+import org.matsim.contrib.bicycle.BicycleModule;
+import org.matsim.core.population.PopulationUtils;
+import org.matsim.core.replanning.strategies.DefaultPlanStrategiesModule;
+import org.matsim.vehicles.VehicleType;
+import org.matsim.vehicles.VehicleUtils;
+
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Set;
+
+public class RunOpenBerlinScenarioWithBikeOnNetwork extends OpenBerlinScenario {
+
+	private static final Logger log = LogManager.getLogger(RunOpenBerlinScenarioWithBikeOnNetwork.class);
+
+	@picocli.CommandLine.Option(names = "--bike", defaultValue = "bikeTeleportedStandardMatsim"
+	, description = "Define how bicycles are simulated")
+	private BicycleHandling bike;
+
+	public static void main(String[] args) {
+		MATSimApplication.run(RunOpenBerlinScenarioWithBikeOnNetwork.class, args);
+	}
+
+
+	@Override
+	protected Config prepareConfig(Config config) {
+		super.prepareConfig(config);
+
+		// no mode choice if we simulate bikes
+		for (ReplanningConfigGroup.StrategySettings strategySettings: config.replanning().getStrategySettings()) {
+			if (strategySettings.getStrategyName().equals(DefaultPlanStrategiesModule.DefaultStrategy.SubtourModeChoice)) {
+				strategySettings.setWeight(0.0);
+			}
+		}
+
+
+		switch (bike) {
+			case onNetworkWithStandardMatsim -> {
+				log.info("Simulating with bikes on the network");
+				// add bike to network modes in qsim:
+				Set<String> modes = Sets.newHashSet(TransportMode.bike);
+				modes.addAll(config.qsim().getMainModes());
+				config.qsim().setMainModes(modes);
+				config.qsim().setLinkDynamics(QSimConfigGroup.LinkDynamics.PassingQ);
+
+				//add bike as a network mode
+				Collection<String> networkModes = Sets.newHashSet(TransportMode.bike);
+
+				networkModes.addAll(config.routing().getNetworkModes());
+				config.routing().setNetworkModes(networkModes);
+
+				//remove teleported modes params
+				config.routing().removeTeleportedModeParams(TransportMode.bike);
+
+
+
+			}
+			case onNetworkWithBicycleContrib -> {
+				// bike is routed on the network per the xml config.
+
+				log.info("Simulating with bikes on the network and bicycle contrib");
+
+				// add bike to network modes in qsim:
+				Set<String> modes = Sets.newHashSet(TransportMode.bike);
+				modes.addAll(config.qsim().getMainModes());
+				config.qsim().setMainModes(modes);
+
+				config.qsim().setLinkDynamics(QSimConfigGroup.LinkDynamics.PassingQ);
+
+				// this activates the bicycleConfigGroup.  But the module still needs to be loaded for the controler.
+				BicycleConfigGroup bikeConfigGroup = ConfigUtils.addOrGetModule(config, BicycleConfigGroup.class);
+				bikeConfigGroup.setBicycleMode(TransportMode.bike);
+			}
+			case bikeTeleportedStandardMatsim -> {
+				log.info("Simulating assuming bikes are teleported, this is the default in the input config");
+
+			}
+
+			default -> throw new IllegalStateException("Unexpected value: " + bike);
+		}
+
+		return config;
+	}
+
+	@Override
+	protected void prepareScenario(Scenario scenario) {
+		super.prepareScenario(scenario);
+
+		if (bike == BicycleHandling.onNetworkWithStandardMatsim || bike == BicycleHandling.onNetworkWithBicycleContrib) {
+			for (Person person: scenario.getPopulation().getPersons().values()) {
+				PopulationUtils.resetRoutes(person.getSelectedPlan());
+			}
+		}
+
+		// we need to define a vehicle type if we want to route bikes on the network
+		if (bike == BicycleHandling.onNetworkWithStandardMatsim || bike == BicycleHandling.onNetworkWithBicycleContrib) {
+			Id<VehicleType> typeId = Id.create(TransportMode.bike, VehicleType.class);
+			VehicleType bikeVehicle = VehicleUtils.createVehicleType(typeId);
+			// I took these values from: https://svn.vsp.tu-berlin.de/repos/public-svn/matsim/scenarios/countries/de/leipzig/leipzig-v1.3/input/leipzig-v1.3-vehicle-types.xml
+			bikeVehicle.setMaximumVelocity(4.16);
+			bikeVehicle.setLength(2.0);
+			bikeVehicle.setWidth(1.0);
+			bikeVehicle.setNetworkMode(TransportMode.bike);
+			bikeVehicle.setPcuEquivalents(0.2);
+			scenario.getVehicles().addVehicleType(bikeVehicle);
+		}
+
+		if (bike == BicycleHandling.onNetworkWithStandardMatsim || bike == BicycleHandling.onNetworkWithBicycleContrib) {
+			for (Link link: scenario.getNetwork().getLinks().values()) {
+				if (link.getAllowedModes().contains(TransportMode.car)) {
+					if (!link.getAllowedModes().contains(TransportMode.pt) && !link.getAttributes().getAttribute("type").equals("motorway") ||
+						!link.getAttributes().getAttribute("type").equals("trunk") || !link.getAttributes().getAttribute("type").equals("motorway_link") ||
+						!link.getAttributes().getAttribute("type").equals("trunk_link")) {
+						Set<String> allowedModes = Sets.newHashSet(TransportMode.bike);
+						allowedModes.addAll(link.getAllowedModes());
+						link.setAllowedModes(allowedModes);
+					}
+				}
+			}
+		}
+
+
+
+	}
+
+	@Override
+	protected void prepareControler(Controler controler) {
+		super.prepareControler(controler);
+		if (bike == BicycleHandling.onNetworkWithBicycleContrib) {
+			controler.addOverridingModule(new BicycleModule());
+		}
+
+	}
+}
+
+/**
+ * Defines how bicycles are scored.
+ */
+enum BicycleHandling {onNetworkWithStandardMatsim, onNetworkWithBicycleContrib, bikeTeleportedStandardMatsim}