gernotbelger@8946: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@8946:  * Software engineering by
gernotbelger@8946:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8946:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8946:  *
gernotbelger@8946:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8946:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8946:  * documentation coming with Dive4Elements River for details.
gernotbelger@8946:  */
gernotbelger@8946: package org.dive4elements.river.artifacts.sinfo.flowdepthminmax;
gernotbelger@8946: 
gernotbelger@8946: import java.util.ArrayList;
gernotbelger@8946: import java.util.Collection;
gernotbelger@8946: 
gernotbelger@8946: import org.apache.commons.lang.math.DoubleRange;
gernotbelger@8946: import org.dive4elements.artifacts.CallContext;
gernotbelger@8946: import org.dive4elements.river.artifacts.model.Calculation;
gernotbelger@8946: import org.dive4elements.river.artifacts.model.CalculationResult;
gernotbelger@8946: import org.dive4elements.river.artifacts.model.WKms;
gernotbelger@8946: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.common.RiverInfoProvider;
gernotbelger@8948: import org.dive4elements.river.artifacts.sinfo.common.SInfoResultRow;
gernotbelger@8948: import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.flowdepth.FlowDepthUtils;
gernotbelger@8993: import org.dive4elements.river.artifacts.sinfo.flowdepth.WstSoundingIdPair;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.tkhcalculation.DischargeValuesFinder;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.tkhcalculation.WaterlevelValuesFinder;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.tkhstate.BedHeightsFinder;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.util.CalculationUtils;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
gernotbelger@8946: import org.dive4elements.river.artifacts.states.WaterlevelData;
gernotbelger@8946: import org.dive4elements.river.artifacts.states.WaterlevelFetcher;
gernotbelger@8946: import org.dive4elements.river.model.River;
gernotbelger@8946: 
gernotbelger@8946: /**
gernotbelger@8946:  * @author Gernot Belger
gernotbelger@8946:  */
gernotbelger@8946: final class FlowDepthMinMaxCalculation {
gernotbelger@8946: 
gernotbelger@8946:     private final CallContext context;
gernotbelger@8946: 
gernotbelger@8946:     public FlowDepthMinMaxCalculation(final CallContext context) {
gernotbelger@8946:         this.context = context;
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8946:     public CalculationResult calculate(final SINFOArtifact sinfo) {
gernotbelger@8946: 
gernotbelger@8946:         final String user = CalculationUtils.findArtifactUser(this.context, sinfo);
gernotbelger@8946: 
gernotbelger@8946:         /* access input data */
gernotbelger@8946:         final FlowDepthMinMaxAccess access = new FlowDepthMinMaxAccess(sinfo);
gernotbelger@8946:         final River river = access.getRiver();
gernotbelger@8946:         final RiverInfo riverInfo = new RiverInfo(river);
gernotbelger@8946: 
gernotbelger@8993:         final Collection<WstSoundingIdPair> minMaxPairs = access.getMinMaxPairs();
gernotbelger@8946: 
gernotbelger@8946:         final DoubleRange calcRange = access.getRange();
gernotbelger@8946: 
gernotbelger@8946:         /* calculate results for each diff pair */
gernotbelger@8946:         final Calculation problems = new Calculation();
gernotbelger@8946: 
gernotbelger@8946:         final RiverInfoProvider infoProvider = RiverInfoProvider.forRange(this.context, river, calcRange);
gernotbelger@8946: 
gernotbelger@8946:         final String calcModeLabel = Resources.getMsg(this.context.getMeta(), sinfo.getCalculationMode().name());
gernotbelger@8946: 
gernotbelger@8946:         final FlowDepthMinMaxCalculationResults results = new FlowDepthMinMaxCalculationResults(calcModeLabel, user, riverInfo, calcRange);
gernotbelger@8946: 
gernotbelger@8993:         for (final WstSoundingIdPair minMaxPair : minMaxPairs) {
gernotbelger@8946:             final FlowDepthMinMaxCalculationResult result = calculateResult(calcRange, minMaxPair, problems, infoProvider);
gernotbelger@8980:             results.addResult(result, problems);
gernotbelger@8946:         }
gernotbelger@8946: 
gernotbelger@8946:         return new CalculationResult(results, problems);
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8946:     /**
gernotbelger@8946:      * Calculates one W-MSH differences pair.
gernotbelger@8946:      *
gernotbelger@8946:      * @param infoProvider
gernotbelger@8946:      */
gernotbelger@8993:     private FlowDepthMinMaxCalculationResult calculateResult(final DoubleRange calcRange, final WstSoundingIdPair minMaxPair, final Calculation problems,
gernotbelger@8946:             final RiverInfoProvider infoProvider) {
gernotbelger@8946: 
gernotbelger@8946:         /* access real input data from database */
gernotbelger@8946:         final String wstId = minMaxPair.getWstId();
gernotbelger@8964: 
gernotbelger@8993:         final String soundingId = minMaxPair.getSoundingId();
gernotbelger@8964: 
gernotbelger@8993:         final BedHeightsFinder bedHeight = BedHeightsFinder.forId(this.context, soundingId, calcRange, problems);
gernotbelger@8993:         if (bedHeight == null)
gernotbelger@8946:             return null;
gernotbelger@8946: 
gernotbelger@8946:         /* REMARK: fetch ALL wst kms, because we want to determine the original reference gauge */
gernotbelger@8964:         final WaterlevelData waterlevel = new WaterlevelFetcher().findWaterlevel(this.context, wstId, calcRange, problems);
gernotbelger@8946:         if (waterlevel == null)
gernotbelger@8946:             return null;
gernotbelger@8946: 
gernotbelger@8993:         final String label = createLabel(waterlevel, bedHeight);
gernotbelger@8946: 
gernotbelger@8946:         final WKms wstKms = waterlevel.getWkms();
gernotbelger@8946: 
gernotbelger@8993:         final BedHeightInfo bedHeightInfo = bedHeight.getInfo();
gernotbelger@8993: 
gernotbelger@8993:         final int soundingYear = bedHeightInfo.getYear();
gernotbelger@8951:         FlowDepthUtils.checkYearDifference(label, waterlevel.getYear(), soundingYear, problems);
gernotbelger@8946: 
gernotbelger@8946:         /* re-determine the reference gauge, in the same way as the WaterlevelArtifact would do it */
gernotbelger@8946:         final RiverInfoProvider riverInfoProvider = infoProvider.forWaterlevel(waterlevel);
gernotbelger@8946: 
gernotbelger@8946:         final int wspYear = waterlevel.getYear();
gernotbelger@8946:         final WstInfo wstInfo = new WstInfo(waterlevel.getName(), wspYear, riverInfoProvider.getReferenceGauge());
gernotbelger@8946: 
gernotbelger@8964:         final WaterlevelValuesFinder waterlevelProvider = WaterlevelValuesFinder.fromKms(problems, wstKms);
gernotbelger@8946:         final DischargeValuesFinder dischargeProvider = DischargeValuesFinder.fromKms(wstKms);
gernotbelger@8946: 
gernotbelger@8946:         final String waterlevelLabel = waterlevel.getName();
gernotbelger@8993:         final String soundingLabel = bedHeightInfo.getDescription();
gernotbelger@8946: 
gernotbelger@8946:         /* real calculation loop */
gernotbelger@8948:         final Collection<SInfoResultRow> rows = new ArrayList<>();
gernotbelger@8946: 
gernotbelger@8993:         final Collection<Double> stations = bedHeight.getStations();
gernotbelger@8964:         for (final double station : stations) {
gernotbelger@8946:             if (calcRange.containsDouble(station)) {
gernotbelger@8946: 
gernotbelger@8946:                 final double wst = waterlevelProvider.getWaterlevel(station);
gernotbelger@8946:                 final double discharge = dischargeProvider.getDischarge(station);
gernotbelger@8946: 
gernotbelger@8993:                 final double minBedHeightValue = bedHeight.getMinBedHeight(station);
gernotbelger@8993:                 final double maxBedHeightValue = bedHeight.getMaxBedHeight(station);
gernotbelger@8993:                 final double meanBedHeight = bedHeight.getMeanBedHeight(station);
gernotbelger@8946: 
gernotbelger@8993:                 final double minFlowDepth = wst - maxBedHeightValue;
gernotbelger@8993:                 final double maxFlowDepth = wst - minBedHeightValue;
gernotbelger@8946: 
gernotbelger@8946:                 // REMARK: access the location once only during calculation
gernotbelger@8946:                 final String location = riverInfoProvider.getLocation(station);
gernotbelger@8946: 
gernotbelger@8946:                 // REMARK: access the gauge once only during calculation
gernotbelger@8946:                 final String gaugeLabel = riverInfoProvider.findGauge(station);
gernotbelger@8946: 
gernotbelger@8978:                 /* ignore invalid lines */
gernotbelger@8978:                 if (Double.isNaN(wst) || Double.isNaN(minBedHeightValue) || Double.isNaN(maxBedHeightValue))
gernotbelger@8978:                     continue;
gernotbelger@8978: 
gernotbelger@8948:                 final SInfoResultRow row = SInfoResultRow.create().//
gernotbelger@8948:                         putValue(SInfoResultType.station, station). //
gernotbelger@8948:                         putValue(SInfoResultType.flowdepthmin, minFlowDepth). //
gernotbelger@8948:                         putValue(SInfoResultType.flowdepthmax, maxFlowDepth). //
gernotbelger@8948:                         putValue(SInfoResultType.waterlevel, wst). //
gernotbelger@8948:                         putValue(SInfoResultType.discharge, discharge). //
gernotbelger@8948:                         putValue(SInfoResultType.waterlevelLabel, waterlevelLabel). //
gernotbelger@8948:                         putValue(SInfoResultType.gaugeLabel, gaugeLabel). //
gernotbelger@8948:                         putValue(SInfoResultType.meanBedHeight, meanBedHeight). //
gernotbelger@8948:                         putValue(SInfoResultType.soundingLabel, soundingLabel). //
gernotbelger@8948:                         putValue(SInfoResultType.location, location);
gernotbelger@8948:                 rows.add(row);
gernotbelger@8946:             }
gernotbelger@8946:         }
gernotbelger@8946: 
gernotbelger@8993:         return new FlowDepthMinMaxCalculationResult(label, wstInfo, bedHeightInfo, rows);
gernotbelger@8946:     }
gernotbelger@8946: 
gernotbelger@8993:     private String createLabel(final WaterlevelData waterlevel, final BedHeightsFinder bedHeight) {
gernotbelger@8946: 
gernotbelger@8993:         return new StringBuilder(waterlevel.getName()). //
gernotbelger@8993:                 append(" - "). //
gernotbelger@8993:                 append(bedHeight.getInfo().getDescription()). //
gernotbelger@8993:                 toString();
gernotbelger@8946:     }
gernotbelger@8946: }