gernotbelger@8915: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@8915:  * Software engineering by
gernotbelger@8915:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8915:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8915:  *
gernotbelger@8915:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8915:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8915:  * documentation coming with Dive4Elements River for details.
gernotbelger@8915:  */
gernotbelger@8915: package org.dive4elements.river.artifacts.sinfo.tkhstate;
gernotbelger@8915: 
gernotbelger@8915: import java.util.ArrayList;
gernotbelger@8915: import java.util.Collection;
gernotbelger@8942: import java.util.HashMap;
gernotbelger@8916: import java.util.List;
gernotbelger@8942: import java.util.Map;
gernotbelger@8942: import java.util.Map.Entry;
gernotbelger@8942: import java.util.Set;
gernotbelger@8915: 
gernotbelger@8915: import org.apache.commons.lang.math.DoubleRange;
gernotbelger@8942: import org.apache.commons.lang.math.NumberRange;
gernotbelger@8915: import org.dive4elements.artifacts.CallContext;
gernotbelger@8915: import org.dive4elements.river.artifacts.WINFOArtifact;
gernotbelger@8915: import org.dive4elements.river.artifacts.model.Calculation;
gernotbelger@8915: import org.dive4elements.river.artifacts.model.Calculation.Problem;
gernotbelger@8915: import org.dive4elements.river.artifacts.model.CalculationResult;
gernotbelger@8915: import org.dive4elements.river.artifacts.model.WQKms;
gernotbelger@8915: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@8915: import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
gernotbelger@8915: 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@8915: import org.dive4elements.river.artifacts.sinfo.tkhcalculation.DischargeValuesFinder;
gernotbelger@8915: import org.dive4elements.river.artifacts.sinfo.tkhcalculation.TkhCalculator;
gernotbelger@8946: import org.dive4elements.river.artifacts.sinfo.tkhcalculation.WaterlevelValuesFinder;
gernotbelger@8942: import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo;
gernotbelger@8915: import org.dive4elements.river.artifacts.sinfo.util.CalculationUtils;
gernotbelger@8915: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8915: import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
gernotbelger@8915: import org.dive4elements.river.artifacts.states.WaterlevelData;
gernotbelger@8938: import org.dive4elements.river.exports.WaterlevelDescriptionBuilder;
gernotbelger@8942: import org.dive4elements.river.model.BedHeight;
gernotbelger@8915: import org.dive4elements.river.model.River;
gernotbelger@8915: 
gernotbelger@8915: /**
gernotbelger@8915:  * @author Gernot Belger
gernotbelger@8915:  */
gernotbelger@8915: final class TkhCalculation {
gernotbelger@8915: 
gernotbelger@8915:     private final CallContext context;
gernotbelger@8915: 
gernotbelger@8915:     public TkhCalculation(final CallContext context) {
gernotbelger@8915:         this.context = context;
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8915:     public CalculationResult calculate(final SINFOArtifact sinfo) {
gernotbelger@8915: 
gernotbelger@8915:         /* access input data */
gernotbelger@8915:         final TkhAccess access = new TkhAccess(sinfo);
gernotbelger@8915:         final River river = access.getRiver();
gernotbelger@8915:         final RiverInfo riverInfo = new RiverInfo(river);
gernotbelger@8915:         final DoubleRange calcRange = access.getRange();
gernotbelger@8915: 
gernotbelger@8915:         final Calculation problems = new Calculation();
gernotbelger@8915: 
gernotbelger@8915:         /* find relevant bed-heights */
gernotbelger@8942:         final List<BedHeight> defaultBedHeights = new DefaultBedHeights(river).getBedHeights(problems);
gernotbelger@8942:         final Collection<BedHeightsFinder> bedHeights = BedHeightsFinder.createTkhBedHeights(calcRange, defaultBedHeights);
gernotbelger@8915: 
gernotbelger@8938:         /* misuse winfo-artifact to calculate waterlevels in the same way */
gernotbelger@8938:         final WINFOArtifact winfo = new WinfoArtifactWrapper(sinfo);
gernotbelger@8938: 
gernotbelger@8915:         /* calculate waterlevels */
gernotbelger@8938:         final WQKms[] kms = calculateWaterlevels(winfo, problems);
gernotbelger@8915: 
gernotbelger@8915:         final RiverInfoProvider infoProvider = RiverInfoProvider.forRange(this.context, river, calcRange);
gernotbelger@8915: 
gernotbelger@8915:         final String user = CalculationUtils.findArtifactUser(this.context, sinfo);
gernotbelger@8915: 
gernotbelger@8915:         final String calcModeLabel = Resources.getMsg(this.context.getMeta(), sinfo.getCalculationMode().name());
gernotbelger@8915: 
gernotbelger@8938:         final WaterlevelDescriptionBuilder descBuilder = new WaterlevelDescriptionBuilder(winfo, this.context);
gernotbelger@8938:         final String descriptionHeader = descBuilder.getColumnHeader();
gernotbelger@8938: 
gernotbelger@8915:         /* for each waterlevel, do a tkh calculation */
gernotbelger@8938:         final TkhCalculationResults results = new TkhCalculationResults(calcModeLabel, user, riverInfo, calcRange, descriptionHeader);
gernotbelger@8915: 
gernotbelger@8915:         for (final WQKms wqKms : kms) {
gernotbelger@8915: 
gernotbelger@8938:             final TkhCalculationResult result = calculateResult(calcRange, infoProvider, wqKms, bedHeights, descBuilder, problems);
gernotbelger@8915:             if (result != null)
gernotbelger@8915:                 // FIXME: must be sorted by station!
gernotbelger@8915:                 results.addResult(result);
gernotbelger@8915:         }
gernotbelger@8915: 
gernotbelger@8915:         return new CalculationResult(results, problems);
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8938:     private WQKms[] calculateWaterlevels(final WINFOArtifact winfo, final Calculation problems) {
gernotbelger@8915: 
gernotbelger@8915:         final CalculationResult waterlevelData = winfo.getWaterlevelData(this.context);
gernotbelger@8915: 
gernotbelger@8915:         /* copy all problems */
gernotbelger@8915:         final Calculation winfoProblems = waterlevelData.getReport();
gernotbelger@8916:         final List<Problem> problems2 = winfoProblems.getProblems();
gernotbelger@8916:         if (problems2 != null) {
gernotbelger@8916:             for (final Problem problem : problems2) {
gernotbelger@8916:                 problems.addProblem(problem);
gernotbelger@8916:             }
gernotbelger@8915:         }
gernotbelger@8915: 
gernotbelger@8915:         return (WQKms[]) waterlevelData.getData();
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8915:     private TkhCalculationResult calculateResult(final DoubleRange calcRange, final RiverInfoProvider riverInfo, final WQKms wkms,
gernotbelger@8938:             final Collection<BedHeightsFinder> bedHeights, final WaterlevelDescriptionBuilder descBuilder, final Calculation problems) {
gernotbelger@8915: 
gernotbelger@8915:         // FIXME: wo kommt das her? via winfo kein jahr vorhanden, oder doch? aber soll in metadaten ausgegeben werden...
gernotbelger@8915:         final int wspYear = -1;
gernotbelger@8915:         // FIXME: richtig? vgl. WInfo?
gernotbelger@8915:         final boolean showAllGauges = false;
gernotbelger@8915:         final WaterlevelData waterlevel = new WaterlevelData(wkms, wspYear, showAllGauges);
gernotbelger@8915: 
gernotbelger@8915:         final RiverInfoProvider riverInfoProvider = riverInfo.forWaterlevel(waterlevel);
gernotbelger@8915: 
gernotbelger@8938:         // FIXME: check with winfo how the name is generated
gernotbelger@8938:         final String wstLabel = waterlevel.getName();
gernotbelger@8915: 
gernotbelger@8938:         final WstInfo wstInfo = new WstInfo(wstLabel, wspYear, riverInfoProvider.getReferenceGauge());
gernotbelger@8915: 
gernotbelger@8942:         /* build tkh calculators per bedheight */
gernotbelger@8942:         final Map<NumberRange, TkhCalculator> calculatorsByRanges = buildCalculators(calcRange, wkms, bedHeights, problems, riverInfoProvider, wstLabel);
gernotbelger@8942:         if (calculatorsByRanges.isEmpty()) {
gernotbelger@8942:             /* there should already be some problems, so just abort */
gernotbelger@8942:             return null;
gernotbelger@8942:         }
gernotbelger@8942: 
gernotbelger@8948:         final Collection<SInfoResultRow> rows = new ArrayList<>();
gernotbelger@8915: 
gernotbelger@8942:         /* using wst-kms as basis, because we know that they are generated wst's with a fixed km-step */
gernotbelger@8942:         // FIXME: das führt dazu, das aktuell die Sohlhöhen beliebig linear interpolierrt werden. ist das immer richtig? z.b.
gernotbelger@8942:         // bei großen abständen?
gernotbelger@8942: 
gernotbelger@8942:         final int size = wkms.size();
gernotbelger@8942:         for (int i = 0; i < size; i++) {
gernotbelger@8942: 
gernotbelger@8942:             final double station = wkms.getKm(i);
gernotbelger@8942: 
gernotbelger@8942:             /* find the right calculator (i.e. bedheigh) depending on station, there should only be one maximal */
gernotbelger@8942:             final TkhCalculator tkhCalculator = findCalculator(calculatorsByRanges, station);
gernotbelger@8942:             if (tkhCalculator == null)
gernotbelger@8942:                 continue;
gernotbelger@8942: 
gernotbelger@8948:             final SInfoResultRow row = SInfoResultRow.create();
gernotbelger@8942: 
gernotbelger@8948:             row.putValue(SInfoResultType.waterlevelLabel, descBuilder.getDesc(wkms));
gernotbelger@8948:             row.putValue(SInfoResultType.gaugeLabel, riverInfoProvider.findGauge(station));
gernotbelger@8948:             row.putValue(SInfoResultType.location, riverInfoProvider.getLocation(station));
gernotbelger@8942: 
gernotbelger@8948:             tkhCalculator.calculateTkh(station, row);
gernotbelger@8948: 
gernotbelger@8948:             rows.add(row);
gernotbelger@8942:         }
gernotbelger@8942: 
gernotbelger@8942:         return new TkhCalculationResult(wstLabel, wstInfo, true, rows);
gernotbelger@8942:     }
gernotbelger@8942: 
gernotbelger@8942:     private TkhCalculator findCalculator(final Map<NumberRange, TkhCalculator> calculators, final double station) {
gernotbelger@8942: 
gernotbelger@8942:         // REMAKR: linear search at this point, put we expect the number of bed heights to be very small (1-2 items)
gernotbelger@8942:         final Set<Entry<NumberRange, TkhCalculator>> x = calculators.entrySet();
gernotbelger@8942:         for (final Entry<NumberRange, TkhCalculator> entry : x) {
gernotbelger@8942:             final NumberRange range = entry.getKey();
gernotbelger@8942:             // FIXME: check if we need comparison with a tolerance
gernotbelger@8942:             if (range.containsDouble(station))
gernotbelger@8942:                 return entry.getValue();
gernotbelger@8942:         }
gernotbelger@8942: 
gernotbelger@8942:         return null;
gernotbelger@8942:     }
gernotbelger@8942: 
gernotbelger@8942:     private Map<NumberRange, TkhCalculator> buildCalculators(final DoubleRange calcRange, final WQKms wkms, final Collection<BedHeightsFinder> bedHeights,
gernotbelger@8942:             final Calculation problems, final RiverInfoProvider riverInfoProvider, final String wstLabel) {
gernotbelger@8942:         final Map<NumberRange, TkhCalculator> calculatorByRanges = new HashMap<>();
gernotbelger@8915:         for (final BedHeightsFinder bedHeightsProvider : bedHeights) {
gernotbelger@8915: 
gernotbelger@8942:             final BedHeightInfo info = bedHeightsProvider.getInfo();
gernotbelger@8942: 
gernotbelger@8942:             final NumberRange range = new NumberRange(info.getFrom(), info.getTo());
gernotbelger@8942: 
gernotbelger@8946:             final WaterlevelValuesFinder waterlevelProvider = WaterlevelValuesFinder.fromKms(wkms);
gernotbelger@8915:             final DischargeValuesFinder dischargeProvider = DischargeValuesFinder.fromKms(wkms);
gernotbelger@8915: 
gernotbelger@8915:             /* initialize tkh calculator */
gernotbelger@8938:             final TkhCalculator tkhCalculator = TkhCalculator.buildTkhCalculator(true, this.context, problems, wstLabel, riverInfoProvider.getRiver(),
gernotbelger@8946:                     calcRange, waterlevelProvider, dischargeProvider, bedHeightsProvider);
gernotbelger@8915: 
gernotbelger@8942:             if (tkhCalculator != null) {
gernotbelger@8942:                 /* just ignore null ones, problems have already been updated by buildTkhCalculator() */
gernotbelger@8942:                 calculatorByRanges.put(range, tkhCalculator);
gernotbelger@8915:             }
gernotbelger@8915:         }
gernotbelger@8915: 
gernotbelger@8942:         return calculatorByRanges;
gernotbelger@8915:     }
gernotbelger@8915: }