gernotbelger@8996: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@8996:  * Software engineering by
gernotbelger@8996:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8996:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8996:  *
gernotbelger@8996:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8996:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8996:  * documentation coming with Dive4Elements River for details.
gernotbelger@8996:  */
gernotbelger@8996: package org.dive4elements.river.artifacts.uinfo.salix;
gernotbelger@8996: 
mschaefer@9309: import java.util.ArrayList;
mschaefer@9309: import java.util.List;
mschaefer@9309: import java.util.NavigableMap;
mschaefer@9309: import java.util.TreeMap;
gernotbelger@8996: 
gernotbelger@9321: import org.apache.commons.lang.math.DoubleRange;
gernotbelger@8996: import org.dive4elements.artifacts.CallContext;
mschaefer@9309: import org.dive4elements.river.artifacts.access.RangeAccess;
mschaefer@9361: import org.dive4elements.river.artifacts.common.GeneralResultType;
gernotbelger@8996: import org.dive4elements.river.artifacts.model.Calculation;
gernotbelger@8996: import org.dive4elements.river.artifacts.model.CalculationResult;
gernotbelger@8996: import org.dive4elements.river.artifacts.resources.Resources;
mschaefer@9295: import org.dive4elements.river.artifacts.sinfo.common.RiverInfoProvider;
gernotbelger@8996: import org.dive4elements.river.artifacts.sinfo.util.CalculationUtils;
gernotbelger@8996: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8996: import org.dive4elements.river.artifacts.uinfo.UINFOArtifact;
mschaefer@9309: import org.dive4elements.river.artifacts.uinfo.salix.SalixLineAccess.ScenarioType;
gernotbelger@8996: import org.dive4elements.river.model.River;
gernotbelger@8996: 
gernotbelger@8996: /**
gernotbelger@8996:  * @author Domenico Nardi Tironi
gernotbelger@8996:  *
gernotbelger@8996:  */
gernotbelger@8996: final class SalixLineCalculation {
gernotbelger@8996: 
gernotbelger@8996:     private final CallContext context;
gernotbelger@8996: 
gernotbelger@8996:     public SalixLineCalculation(final CallContext context) {
gernotbelger@8996:         this.context = context;
gernotbelger@8996:     }
gernotbelger@8996: 
gernotbelger@8996:     public CalculationResult calculate(final UINFOArtifact uinfo) {
gernotbelger@8996:         final Calculation problems = new Calculation();
gernotbelger@8996: 
gernotbelger@8996:         final String calcModeLabel = Resources.getMsg(this.context.getMeta(), uinfo.getCalculationMode().name());
gernotbelger@8996:         final String user = CalculationUtils.findArtifactUser(this.context, uinfo);
gernotbelger@8996: 
gernotbelger@9070:         final SalixLineAccess accessSalix = new SalixLineAccess(uinfo);
gernotbelger@9070: 
gernotbelger@9070:         final River river = accessSalix.getRiver();
gernotbelger@8996:         final RiverInfo riverInfo = new RiverInfo(river);
gernotbelger@8996: 
gernotbelger@9321:         final DoubleRange range = accessSalix.getRange();
gernotbelger@9068: 
gernotbelger@9321:         final ScenarioType scenarioType = accessSalix.getScenario();
gernotbelger@9070: 
gernotbelger@9321:         final RiverInfoProvider riverInfoProvider = RiverInfoProvider.forRange(this.context, river, range);
gernotbelger@8996: 
gernotbelger@9321:         final SalixLineCalculationResults results = new SalixLineCalculationResults(calcModeLabel, user, riverInfo, range);
gernotbelger@9321: 
gernotbelger@9321:         final SalixLineCalculator calculator = new SalixLineCalculator(riverInfoProvider);
mschaefer@9309:         final NavigableMap<Double, List<Double>> rangeScenarios = buildRangeScenarios(accessSalix);
mschaefer@9309: 
mschaefer@9361:         calculator.execute(problems, uinfo, rangeScenarios, scenarioType, buildScenarioLabels(accessSalix), buildPartialRangeString(accessSalix),
mschaefer@9361:                 buildAdditionalString(accessSalix), results);
gernotbelger@9243: 
gernotbelger@8996:         return new CalculationResult(results, problems);
gernotbelger@8996:     }
gernotbelger@9243: 
mschaefer@9309:     /**
mschaefer@9361:      * Build a map of delta-Ws by from-km for the selected scenario
mschaefer@9309:      */
mschaefer@9309:     private NavigableMap<Double, List<Double>> buildRangeScenarios(final SalixLineAccess access) {
mschaefer@9309:         final NavigableMap<Double, List<Double>> rangeScenarios = new TreeMap<>();
mschaefer@9309:         if (access.getScenario() == ScenarioType.REGIONAL)
mschaefer@9309:             fillRangeScenarios(rangeScenarios, access, access.getFromPart().doubleValue(), access.getToPart().doubleValue(),
mschaefer@9309:                     access.getRegionalScenarioIntegers());
mschaefer@9309:         else if (access.getScenario() == ScenarioType.SUPRAREGIONAL)
mschaefer@9309:             fillRangeScenarios(rangeScenarios, access.getSupraRegionalString());
mschaefer@9309:         // TODO else if (access.getScenario().equals(ScenarioType.HISTORICAL.getKey()))
mschaefer@9309:         // historisches Szenario aus MSH etc.
mschaefer@9309:         else
mschaefer@9309:             fillRangeScenarios(rangeScenarios, access);
gernotbelger@9321: 
mschaefer@9309:         return rangeScenarios;
mschaefer@9309:     }
mschaefer@9309: 
mschaefer@9309:     /**
mschaefer@9309:      * Fill a map of delta-Ws with only one 0-delta for the whole calc range (no scenario)
mschaefer@9309:      */
mschaefer@9309:     private void fillRangeScenarios(final NavigableMap<Double, List<Double>> rangeScenarios, final RangeAccess calcRange) {
mschaefer@9309:         final List<Double> nulls = new ArrayList<>();
mschaefer@9309:         nulls.add(0.0);
mschaefer@9309:         rangeScenarios.put(Double.valueOf(calcRange.getLowerKm() - 0.0001), nulls);
mschaefer@9309:     }
mschaefer@9309: 
mschaefer@9309:     /**
mschaefer@9309:      * Fill a map of delta-Ws by km-range from the regional scenario input data
mschaefer@9309:      */
mschaefer@9309:     private void fillRangeScenarios(final NavigableMap<Double, List<Double>> rangeScenarios, final RangeAccess calcRange, final double partFrom,
mschaefer@9309:             final double partTo, final int[] deltaWs) {
mschaefer@9309:         final List<Double> nulls = new ArrayList<>();
mschaefer@9309:         final List<Double> dwsm = new ArrayList<>();
mschaefer@9309:         for (int i = 0; i <= deltaWs.length - 1; i++) {
mschaefer@9309:             nulls.add(0.0);
mschaefer@9309:             dwsm.add(deltaWs[i] / 100.0);
mschaefer@9309:         }
mschaefer@9309:         rangeScenarios.put(Double.valueOf(calcRange.getLowerKm() - 0.0001), nulls);
mschaefer@9309:         rangeScenarios.put(Double.valueOf(partFrom - 0.0001), dwsm);
mschaefer@9309:         rangeScenarios.put(Double.valueOf(partTo + 0.0001), nulls);
mschaefer@9309:     }
mschaefer@9309: 
mschaefer@9309:     /**
mschaefer@9309:      * Fill a map of delta-Ws by km-range from the supraregional scenario input data
mschaefer@9309:      * (the zones input by the user cover the calc range completely)
mschaefer@9309:      */
mschaefer@9309:     private void fillRangeScenarios(final NavigableMap<Double, List<Double>> rangeScenarios, final String zones) {
mschaefer@9309:         final List<SalixZone> parts = SalixZone.parse(zones);
mschaefer@9309:         for (final SalixZone part : parts) {
mschaefer@9309:             final List<Double> dwsm = new ArrayList<>();
mschaefer@9309:             dwsm.add(part.getDwsplValue() / 100.0);
mschaefer@9309:             rangeScenarios.put(Double.valueOf(part.getFromKm().doubleValue() - 0.0001), dwsm);
mschaefer@9309:         }
mschaefer@9309:     }
mschaefer@9309: 
mschaefer@9316:     /**
mschaefer@9316:      * Build the list of delta-w labels for the scenario type
mschaefer@9316:      */
mschaefer@9316:     private String[] buildScenarioLabels(final SalixLineAccess access) {
mschaefer@9316:         final List<String> labels = new ArrayList<>();
mschaefer@9316:         if (access.getScenario() == ScenarioType.REGIONAL) {
mschaefer@9316:             final int[] deltaws = access.getRegionalScenarioIntegers();
mschaefer@9316:             for (int i = 0; i <= deltaws.length - 1; i++)
mschaefer@9316:                 if (deltaws[i] != 0)
mschaefer@9316:                     labels.add(Integer.toString(deltaws[i]) + " cm");
gernotbelger@9243:         }
mschaefer@9361:         else if (access.getScenario() == ScenarioType.SUPRAREGIONAL)
mschaefer@9361:             labels.add(Resources.getMsg(this.context.getMeta(), "uinfo_salix_scenario_supraregional"));
mschaefer@9361:         else if (access.getScenario() == ScenarioType.HISTORICAL)
mschaefer@9361:             labels.add(Resources.getMsg(this.context.getMeta(), "uinfo_salix_scenario_historical"));
mschaefer@9316:         return labels.toArray(new String[labels.size()]);
gernotbelger@9243:     }
mschaefer@9361: 
mschaefer@9361:     /**
mschaefer@9361:      * Build the km range string for the scenario type
mschaefer@9361:      */
mschaefer@9361:     private String buildPartialRangeString(final SalixLineAccess access) {
mschaefer@9361:         if ((access.getScenario() == ScenarioType.REGIONAL) || (access.getScenario() == ScenarioType.HISTORICAL)) {
mschaefer@9361:             return String.format("%s - %s", GeneralResultType.station.exportValue(this.context, access.getFromPart().doubleValue()),
mschaefer@9361:                     GeneralResultType.station.exportValue(this.context, access.getToPart().doubleValue()));
mschaefer@9361:         }
mschaefer@9361:         if (access.getScenario() == ScenarioType.SUPRAREGIONAL) {
mschaefer@9361:             String ranges = "";
mschaefer@9361:             String sep = "";
mschaefer@9361:             final List<SalixZone> parts = SalixZone.parse(access.getSupraRegionalString());
mschaefer@9361:             for (final SalixZone part : parts) {
mschaefer@9361:                 if (part.getDwsplValue() != 0) {
mschaefer@9361:                     ranges = ranges + sep + String.format("%s - %s", GeneralResultType.station.exportValue(this.context, part.getFromKm().doubleValue()),
mschaefer@9361:                             GeneralResultType.station.exportValue(this.context, part.getToKm().doubleValue()));
mschaefer@9361:                     sep = ", ";
mschaefer@9361:                 }
mschaefer@9361:             }
mschaefer@9361:             return ranges;
mschaefer@9361:         }
mschaefer@9361:         return "";
mschaefer@9361:     }
mschaefer@9361: 
mschaefer@9361:     /**
mschaefer@9361:      * Build the delta w or time string for the scenario type
mschaefer@9361:      */
mschaefer@9361:     private String buildAdditionalString(final SalixLineAccess access) {
mschaefer@9361:         if (access.getScenario() == ScenarioType.REGIONAL) {
mschaefer@9361:             String deltas = "";
mschaefer@9361:             String sep = "";
mschaefer@9361:             for (final int d : access.getRegionalScenarioIntegers()) {
mschaefer@9361:                 deltas = deltas + sep + Integer.toString(d);
mschaefer@9361:                 sep = ", ";
mschaefer@9361:             }
mschaefer@9361:             return deltas;
mschaefer@9361:         }
mschaefer@9361:         if (access.getScenario() == ScenarioType.HISTORICAL) {
mschaefer@9361:             if (access.getYear() != null)
mschaefer@9361:                 return access.getYear().toString();
mschaefer@9361:             else
mschaefer@9361:                 return access.getEpoch().toString();
mschaefer@9361:         }
mschaefer@9361:         if (access.getScenario() == ScenarioType.SUPRAREGIONAL) {
mschaefer@9361:             String deltas = "";
mschaefer@9361:             String sep = "";
mschaefer@9361:             final List<SalixZone> parts = SalixZone.parse(access.getSupraRegionalString());
mschaefer@9361:             for (final SalixZone part : parts) {
mschaefer@9361:                 if (part.getDwsplValue() != 0) {
mschaefer@9361:                     deltas = deltas + sep + Integer.toString(part.getDwsplValue());
mschaefer@9361:                     sep = ", ";
mschaefer@9361:                 }
mschaefer@9361:             }
mschaefer@9361:             return deltas;
mschaefer@9361:         }
mschaefer@9361:         return "";
mschaefer@9361:     }
gernotbelger@8996: }