Mercurial > dive4elements > river
view artifacts/src/main/java/org/dive4elements/river/artifacts/uinfo/salix/SalixLineCalculator.java @ 9421:53e26734e4d2
Fixed NaN handling in salix historical scenarion calculation, added problem report
author | mschaefer |
---|---|
date | Fri, 17 Aug 2018 11:13:31 +0200 |
parents | 6e7094368e97 |
children | bd5f5d2220fa |
line wrap: on
line source
/** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde * Software engineering by * Björnsen Beratende Ingenieure GmbH * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt * * This file is Free Software under the GNU AGPL (>=v3) * and comes with ABSOLUTELY NO WARRANTY! Check out the * documentation coming with Dive4Elements River for details. */ package org.dive4elements.river.artifacts.uinfo.salix; import java.math.BigDecimal; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Map.Entry; import java.util.NavigableMap; import org.dive4elements.river.artifacts.WINFOArtifact; import org.dive4elements.river.artifacts.access.ComputationRangeAccess; import org.dive4elements.river.artifacts.common.AbstractResultType; import org.dive4elements.river.artifacts.common.GeneralResultType; import org.dive4elements.river.artifacts.common.ResultRow; import org.dive4elements.river.artifacts.model.Calculation; import org.dive4elements.river.artifacts.model.WstValueTable; import org.dive4elements.river.artifacts.model.WstValueTable.QPosition; import org.dive4elements.river.artifacts.model.WstValueTableFactory; import org.dive4elements.river.artifacts.sinfo.common.RiverInfoProvider; import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType; import org.dive4elements.river.artifacts.sinfo.tkhstate.WinfoArtifactWrapper; import org.dive4elements.river.artifacts.uinfo.UINFOArtifact; import org.dive4elements.river.artifacts.uinfo.common.UInfoResultType; import org.dive4elements.river.artifacts.uinfo.salix.SalixLineAccess.ScenarioType; import org.dive4elements.river.model.Gauge; import org.dive4elements.river.model.MainValue; import org.dive4elements.river.model.MainValueType.MainValueTypeKey; import org.dive4elements.river.utils.Formatter; /** * Calculation of the result rows of the u-info salix line calc mode * * @author Matthias Schäfer */ final class SalixLineCalculator { private static final BigDecimal SALIX_DISTANCE = new BigDecimal("2.31"); private final List<ResultRow> rows = new ArrayList<>(); private final RiverInfoProvider riverInfoProvider; private final Map<Gauge, QPosition> gaugeMwPos; private final Map<Gauge, QPosition> gaugeMnwPos; private final Map<Gauge, QPosition> gaugeMhwPos; private QPosition refGaugeMwPos; private QPosition refGaugeMnwPos; private QPosition refGaugeMhwPos; private Gauge firstGauge; private Calculation problems; private WstValueTable wst; public SalixLineCalculator(final RiverInfoProvider riverInfoProvider) { this.riverInfoProvider = riverInfoProvider; this.gaugeMwPos = new HashMap<>(); this.gaugeMnwPos = new HashMap<>(); this.gaugeMhwPos = new HashMap<>(); } /** * Calculate the salix line result rows */ public void execute(final Calculation problems, final UINFOArtifact uinfo, final NavigableMap<Double, List<Double>> rangeScenarios, final ScenarioType scenarioType, final String[] scenarioLabels, final String rangeString, final String additionalString, final SalixLineCalculationResults results) { this.problems = problems; this.wst = WstValueTableFactory.getTable(this.riverInfoProvider.getRiver()); fetchGaugeMainValuePositions(); final WINFOArtifact winfo = new WinfoArtifactWrapper(uinfo); winfo.addStringData("ld_mode", "distance"); winfo.addStringData("ld_step", "100"); for (final double station : new ComputationRangeAccess(winfo).getKms()) { this.rows.add(createRow(station, rangeScenarios)); } if (scenarioType == ScenarioType.REGIONAL) results.addResult(new SalixLineCalculationRegionalResult("Salix-regional", scenarioLabels, rangeString, additionalString, this.rows), problems); else if (scenarioType == ScenarioType.SUPRAREGIONAL) results.addResult(new SalixLineCalculationSupraRegionalResult("Salix-supra", scenarioLabels, rangeString, additionalString, this.rows), problems); else if (scenarioType == ScenarioType.HISTORICAL) results.addResult(new SalixLineCalculationHistoricalResult("Salix-hist", scenarioLabels, rangeString, additionalString, this.rows), problems); else results.addResult(new SalixLineCalculationResult("Salix-simple", this.rows), problems); } /** * Fetch MQ, MNQ and MHQ of all gauges and determine the wst QPosition for each one */ private void fetchGaugeMainValuePositions() { this.gaugeMwPos.clear(); this.gaugeMnwPos.clear(); this.gaugeMhwPos.clear(); this.firstGauge = null; for (final Gauge gauge : this.riverInfoProvider.getGauges()) { this.gaugeMwPos.put(gauge, null); this.gaugeMnwPos.put(gauge, null); this.gaugeMhwPos.put(gauge, null); final double gaugeKm = gauge.getStation().doubleValue(); for (final MainValue mv : MainValue.getValuesOfGaugeAndType(gauge, MainValueTypeKey.Q)) { if (mv.getMainValue().getName().equalsIgnoreCase("mq")) this.gaugeMwPos.put(gauge, this.wst.getQPosition(gaugeKm, mv.getValue().doubleValue())); else if (mv.getMainValue().getName().equalsIgnoreCase("mnq")) this.gaugeMnwPos.put(gauge, this.wst.getQPosition(gaugeKm, mv.getValue().doubleValue())); else if (mv.getMainValue().getName().equalsIgnoreCase("mhq")) this.gaugeMhwPos.put(gauge, this.wst.getQPosition(gaugeKm, mv.getValue().doubleValue())); } if (this.firstGauge == null) { this.refGaugeMwPos = this.gaugeMwPos.get(gauge); this.refGaugeMnwPos = this.gaugeMnwPos.get(gauge); this.refGaugeMhwPos = this.gaugeMhwPos.get(gauge); this.firstGauge = gauge; } } if (this.refGaugeMwPos == null) this.problems.addProblem("uinfo_salix_calc.warning.missing_mq"); else { if (this.refGaugeMhwPos == null) this.problems.addProblem("uinfo_salix_calc.warning.missing_mhq"); if (this.refGaugeMnwPos == null) this.problems.addProblem("uinfo_salix_calc.warning.missing_mnq"); } } /** * Create a result row for a station and its gauge, and add w-q-values as selected */ private ResultRow createRow(final double station, final NavigableMap<Double, List<Double>> rangeScenarios) { final ResultRow row = ResultRow.create(); row.putValue(GeneralResultType.station, station); // Find station's gauge (obsolete version which calculates gauge-wise) // final Gauge gauge = this.riverInfoProvider.getGauge(station, true); // Interpolate mnw, mw, and mhw // final double mnw = interpolateW(station, this.gaugeMnwPos.get(gauge)); // final double mw = interpolateW(station, this.gaugeMwPos.get(gauge)); // final double mhw = interpolateW(station, this.gaugeMhwPos.get(gauge)); final double mnw = interpolateW(station, this.refGaugeMnwPos); final double mw = interpolateW(station, this.refGaugeMwPos); final double mhw = interpolateW(station, this.refGaugeMhwPos); row.putValue(SInfoResultType.waterlevel, mnw); row.putValue(SInfoResultType.waterlevel1, mw); row.putValue(SInfoResultType.waterlevel2, mhw); // Calc salix-line and mw-mnw row.putValue(UInfoResultType.salixline, calcSalix(mhw, mw)); row.putValue(UInfoResultType.salix_mw_mnw, calcMwmnw(mw, mnw)); // Calc scenario values (always all scenario types set, Result variant extracts the fields needed) final List<SalixScenario> scenarios = new ArrayList<>(); final List<Double> deltaws = getDeltaWs(station, rangeScenarios); for (final Double deltaw : deltaws) { if (deltaw != null) { final double salix = calcSalix(mhw, mw + deltaw); scenarios.add(new SalixScenario((int) (deltaw * 100), salix)); } else { scenarios.add(null); } } row.putValue(UInfoResultType.customMultiRowColSalixScenarios, scenarios); row.putValue(GeneralResultType.gaugeLabel, this.riverInfoProvider.findGauge(station)); return row; } /** * Interpolates the W for a station with a fixed (virtual) wst column position */ private double interpolateW(final double station, final QPosition qPosition) { if (qPosition != null) return this.wst.interpolateW(station, qPosition, this.problems); return Double.NaN; } /** * Calculates the salix value */ private double calcSalix(final double mhw, final double mw) { if (Double.isNaN(mw) || Double.isInfinite(mw) || Double.isNaN(mhw) || Double.isInfinite(mhw)) return mw; // preserving NaN or Infinity return Formatter.roundW(mhw).subtract(SALIX_DISTANCE).subtract(Formatter.roundW(mw)).doubleValue(); } /** * Calculates the inverse MW-MNW difference */ private double calcMwmnw(final double mw, final double mnw) { if (Double.isNaN(mw) || Double.isInfinite(mw) || Double.isNaN(mnw) || Double.isInfinite(mnw)) return mnw - mw; // preserving NaN or Inifinity return Formatter.roundW(mnw).subtract(Formatter.roundW(mw)).doubleValue(); } /** * Gets the station-specific list of delta-ws of the active scenario, at least with one null item in any case */ private List<Double> getDeltaWs(final double station, final NavigableMap<Double, List<Double>> rangeScenarios) { final Entry<Double, List<Double>> stationScenarios = rangeScenarios.floorEntry(station); if (stationScenarios != null) { return stationScenarios.getValue(); } final List<Double> noScen = new ArrayList<>(); noScen.add(null); return noScen; } /** * Find and return a height (iota, w main value) of a station in a previously calculated result */ public double fetchStationHeight(final Calculation problems, final double station, final AbstractResultType resultType, final SalixLineCalculationResult result) { // Search the station in the previously calculated result rows final ResultRow stationRow = searchStation(station, result.getRows()); if (stationRow != null) return stationRow.getDoubleValue(resultType); return Double.NaN; } /** * Searches the row of a station in a result rows collection */ private ResultRow searchStation(final double station, final Collection<ResultRow> rows) { for (final ResultRow row : rows) { if (row.getDoubleValue(GeneralResultType.station) > station + 0.0001) return row; } return null; } }