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@8916: import java.util.List;
gernotbelger@8915: 
gernotbelger@8915: import org.apache.commons.lang.math.DoubleRange;
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@8915: import org.dive4elements.river.artifacts.sinfo.tkhcalculation.DischargeValuesFinder;
gernotbelger@8915: import org.dive4elements.river.artifacts.sinfo.tkhcalculation.Tkh;
gernotbelger@8915: import org.dive4elements.river.artifacts.sinfo.tkhcalculation.TkhCalculator;
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@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@8915:         final Collection<BedHeightsFinder> bedHeights = BedHeightsFinder.createTkhBedHeights(river, problems, calcRange);
gernotbelger@8915: 
gernotbelger@8915:         /* calculate waterlevels */
gernotbelger@8915:         final WQKms[] kms = calculateWaterlevels(sinfo, 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@8915:         /* for each waterlevel, do a tkh calculation */
gernotbelger@8915:         final TkhCalculationResults results = new TkhCalculationResults(calcModeLabel, user, riverInfo, calcRange);
gernotbelger@8915: 
gernotbelger@8915:         for (final WQKms wqKms : kms) {
gernotbelger@8915: 
gernotbelger@8915:             final TkhCalculationResult result = calculateResult(calcRange, infoProvider, wqKms, bedHeights, 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@8915:     private WQKms[] calculateWaterlevels(final SINFOArtifact sinfo, final Calculation problems) {
gernotbelger@8915: 
gernotbelger@8915:         /* misuse winfo-artifact to calculate waterlevels in the same way */
gernotbelger@8915:         final WINFOArtifact winfo = new WinfoArtifactWrapper(sinfo);
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@8915:             final Collection<BedHeightsFinder> bedHeights, 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@8915:         final String label = waterlevel.getName();
gernotbelger@8915: 
gernotbelger@8915:         final WstInfo wstInfo = new WstInfo(label, wspYear, riverInfoProvider.getReferenceGauge());
gernotbelger@8915: 
gernotbelger@8915:         final Collection<TkhResultRow> rows = new ArrayList<>();
gernotbelger@8915: 
gernotbelger@8915:         /*
gernotbelger@8915:          * for each separate bed height dataset we do the calculation and put everything into one result, bed heights must not
gernotbelger@8915:          * overlap accordingly
gernotbelger@8915:          */
gernotbelger@8915:         for (final BedHeightsFinder bedHeightsProvider : bedHeights) {
gernotbelger@8915: 
gernotbelger@8915:             final DischargeValuesFinder dischargeProvider = DischargeValuesFinder.fromKms(wkms);
gernotbelger@8915: 
gernotbelger@8915:             /* initialize tkh calculator */
gernotbelger@8915:             final TkhCalculator tkhCalculator = TkhCalculator.buildTkhCalculator(true, this.context, problems, label, riverInfoProvider.getRiver(), calcRange,
gernotbelger@8915:                     dischargeProvider, bedHeightsProvider);
gernotbelger@8915:             if (tkhCalculator == null) {
gernotbelger@8915:                 /* just abort, problems have already been updated by buildTkhCalculator() */
gernotbelger@8915:                 return null;
gernotbelger@8915:             }
gernotbelger@8915: 
gernotbelger@8915:             /* using wst-kms as basis, because we know that they are generated wst's with a fixed km-step */
gernotbelger@8915: 
gernotbelger@8915:             // FIXME: das führt dazu, das aktuell die Sohlhöhen beliebig linear interpolierrt werden. ist das immer richtig? z.b.
gernotbelger@8915:             // bei großen abständen?
gernotbelger@8915: 
gernotbelger@8915:             final int size = wkms.size();
gernotbelger@8915:             for (int i = 0; i < size; i++) {
gernotbelger@8915: 
gernotbelger@8915:                 final double station = wkms.getKm(i);
gernotbelger@8915:                 final double wst = wkms.getW(i);
gernotbelger@8915: 
gernotbelger@8915:                 final Tkh tkh = tkhCalculator.getTkh(station, wst);
gernotbelger@8915: 
gernotbelger@8915:                 final String gaugeLabel = riverInfoProvider.findGauge(station);
gernotbelger@8915:                 final String location = riverInfoProvider.getLocation(station);
gernotbelger@8915: 
gernotbelger@8915:                 rows.add(new TkhResultRow(tkh, label, gaugeLabel, location));
gernotbelger@8915:             }
gernotbelger@8915:         }
gernotbelger@8915: 
gernotbelger@8915:         return new TkhCalculationResult(label, wstInfo, true, rows);
gernotbelger@8915:     }
gernotbelger@8915: }