|
8946
|
1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde |
|
|
2 * Software engineering by |
|
|
3 * Björnsen Beratende Ingenieure GmbH |
|
|
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt |
|
|
5 * |
|
|
6 * This file is Free Software under the GNU AGPL (>=v3) |
|
|
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the |
|
|
8 * documentation coming with Dive4Elements River for details. |
|
|
9 */ |
|
|
10 package org.dive4elements.river.artifacts.sinfo.flowdepthminmax; |
|
|
11 |
|
|
12 import java.util.ArrayList; |
|
|
13 import java.util.Collection; |
|
|
14 |
|
|
15 import org.apache.commons.lang.math.DoubleRange; |
|
|
16 import org.dive4elements.artifacts.CallContext; |
|
|
17 import org.dive4elements.river.artifacts.model.Calculation; |
|
|
18 import org.dive4elements.river.artifacts.model.CalculationResult; |
|
|
19 import org.dive4elements.river.artifacts.model.WKms; |
|
|
20 import org.dive4elements.river.artifacts.resources.Resources; |
|
|
21 import org.dive4elements.river.artifacts.sinfo.SINFOArtifact; |
|
|
22 import org.dive4elements.river.artifacts.sinfo.common.RiverInfoProvider; |
|
8948
|
23 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultRow; |
|
|
24 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType; |
|
8946
|
25 import org.dive4elements.river.artifacts.sinfo.flowdepth.FlowDepthUtils; |
|
|
26 import org.dive4elements.river.artifacts.sinfo.flowdepthminmax.FlowDepthMinMaxAccess.MinMaxIdPair; |
|
|
27 import org.dive4elements.river.artifacts.sinfo.tkhcalculation.DischargeValuesFinder; |
|
|
28 import org.dive4elements.river.artifacts.sinfo.tkhcalculation.WaterlevelValuesFinder; |
|
|
29 import org.dive4elements.river.artifacts.sinfo.tkhstate.BedHeightsFinder; |
|
|
30 import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo; |
|
|
31 import org.dive4elements.river.artifacts.sinfo.util.CalculationUtils; |
|
|
32 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo; |
|
|
33 import org.dive4elements.river.artifacts.sinfo.util.WstInfo; |
|
|
34 import org.dive4elements.river.artifacts.states.WaterlevelData; |
|
|
35 import org.dive4elements.river.artifacts.states.WaterlevelFetcher; |
|
|
36 import org.dive4elements.river.model.River; |
|
|
37 |
|
|
38 /** |
|
|
39 * @author Gernot Belger |
|
|
40 */ |
|
|
41 final class FlowDepthMinMaxCalculation { |
|
|
42 |
|
|
43 private final CallContext context; |
|
|
44 |
|
|
45 public FlowDepthMinMaxCalculation(final CallContext context) { |
|
|
46 this.context = context; |
|
|
47 } |
|
|
48 |
|
|
49 public CalculationResult calculate(final SINFOArtifact sinfo) { |
|
|
50 |
|
|
51 final String user = CalculationUtils.findArtifactUser(this.context, sinfo); |
|
|
52 |
|
|
53 /* access input data */ |
|
|
54 final FlowDepthMinMaxAccess access = new FlowDepthMinMaxAccess(sinfo); |
|
|
55 final River river = access.getRiver(); |
|
|
56 final RiverInfo riverInfo = new RiverInfo(river); |
|
|
57 |
|
|
58 final Collection<MinMaxIdPair> minMaxPairs = access.getMinMaxPairs(); |
|
|
59 |
|
|
60 final DoubleRange calcRange = access.getRange(); |
|
|
61 |
|
|
62 /* calculate results for each diff pair */ |
|
|
63 final Calculation problems = new Calculation(); |
|
|
64 |
|
|
65 final RiverInfoProvider infoProvider = RiverInfoProvider.forRange(this.context, river, calcRange); |
|
|
66 |
|
|
67 final String calcModeLabel = Resources.getMsg(this.context.getMeta(), sinfo.getCalculationMode().name()); |
|
|
68 |
|
|
69 final FlowDepthMinMaxCalculationResults results = new FlowDepthMinMaxCalculationResults(calcModeLabel, user, riverInfo, calcRange); |
|
|
70 |
|
|
71 for (final MinMaxIdPair minMaxPair : minMaxPairs) { |
|
|
72 final FlowDepthMinMaxCalculationResult result = calculateResult(calcRange, minMaxPair, problems, infoProvider); |
|
|
73 if (result != null) |
|
|
74 results.addResult(result); |
|
|
75 } |
|
|
76 |
|
|
77 return new CalculationResult(results, problems); |
|
|
78 } |
|
|
79 |
|
|
80 /** |
|
|
81 * Calculates one W-MSH differences pair. |
|
|
82 * |
|
|
83 * @param infoProvider |
|
|
84 */ |
|
|
85 private FlowDepthMinMaxCalculationResult calculateResult(final DoubleRange calcRange, final MinMaxIdPair minMaxPair, final Calculation problems, |
|
|
86 final RiverInfoProvider infoProvider) { |
|
|
87 |
|
|
88 /* access real input data from database */ |
|
|
89 final String wstId = minMaxPair.getWstId(); |
|
|
90 final String minSoundingId = minMaxPair.getMinSoundingId(); |
|
8948
|
91 final String maxSoundingId = minMaxPair.getMaxSoundingId(); |
|
8946
|
92 |
|
|
93 final BedHeightsFinder minBedHeight = minSoundingId == null ? null : BedHeightsFinder.forId(this.context, minSoundingId, calcRange, problems); |
|
|
94 final BedHeightsFinder maxBedHeight = maxSoundingId == null ? null : BedHeightsFinder.forId(this.context, maxSoundingId, calcRange, problems); |
|
|
95 if (minBedHeight == null && maxBedHeight == null) |
|
|
96 return null; |
|
|
97 |
|
|
98 /* REMARK: fetch ALL wst kms, because we want to determine the original reference gauge */ |
|
|
99 final WaterlevelData waterlevel = new WaterlevelFetcher().findWaterlevel(this.context, wstId, Double.NaN, Double.NaN, problems); |
|
|
100 if (waterlevel == null) |
|
|
101 return null; |
|
|
102 |
|
|
103 final String label = createLabel(waterlevel, minBedHeight, maxBedHeight); |
|
|
104 |
|
|
105 final WKms wstKms = waterlevel.getWkms(); |
|
|
106 |
|
|
107 final int soundingYear = checkSoundingYear(minBedHeight, maxBedHeight, problems); |
|
|
108 FlowDepthUtils.checkYearDifference(label, waterlevel, soundingYear, problems); |
|
|
109 // FIXME |
|
|
110 // checkWaterlevelDiscretisation(wstKms, calcRange, problems); |
|
|
111 // TODO: prüfen, ob sohlhöhen die calcRange abdecken/überschneiden |
|
|
112 |
|
|
113 /* re-determine the reference gauge, in the same way as the WaterlevelArtifact would do it */ |
|
|
114 final RiverInfoProvider riverInfoProvider = infoProvider.forWaterlevel(waterlevel); |
|
|
115 |
|
|
116 final int wspYear = waterlevel.getYear(); |
|
|
117 final WstInfo wstInfo = new WstInfo(waterlevel.getName(), wspYear, riverInfoProvider.getReferenceGauge()); |
|
|
118 |
|
|
119 final WaterlevelValuesFinder waterlevelProvider = WaterlevelValuesFinder.fromKms(wstKms); |
|
|
120 final DischargeValuesFinder dischargeProvider = DischargeValuesFinder.fromKms(wstKms); |
|
|
121 |
|
|
122 final String waterlevelLabel = waterlevel.getName(); |
|
|
123 final String soundingLabel = buildSoundingLabel(minBedHeight, maxBedHeight); |
|
|
124 |
|
|
125 /* real calculation loop */ |
|
8948
|
126 final Collection<SInfoResultRow> rows = new ArrayList<>(); |
|
8946
|
127 |
|
|
128 // FIXME: determine what is the spatial discretisation that we will use... |
|
|
129 final double[] allKms = wstKms.allKms().toNativeArray(); |
|
|
130 for (final double station : allKms) { |
|
|
131 if (calcRange.containsDouble(station)) { |
|
|
132 |
|
|
133 final double wst = waterlevelProvider.getWaterlevel(station); |
|
|
134 final double discharge = dischargeProvider.getDischarge(station); |
|
|
135 |
|
|
136 final double minBedHeightValue = minBedHeight == null ? Double.NaN : minBedHeight.getMeanBedHeight(station); |
|
|
137 final double maxBedHeightValue = maxBedHeight == null ? Double.NaN : maxBedHeight.getMeanBedHeight(station); |
|
|
138 |
|
|
139 final double minFlowDepth = wst - minBedHeightValue; |
|
|
140 final double maxFlowDepth = wst - maxBedHeightValue; |
|
|
141 |
|
|
142 // FIXME: unclear what is meant here... |
|
|
143 final double meanBedHeight = Double.NaN; |
|
|
144 |
|
|
145 // REMARK: access the location once only during calculation |
|
|
146 final String location = riverInfoProvider.getLocation(station); |
|
|
147 |
|
|
148 // REMARK: access the gauge once only during calculation |
|
|
149 final String gaugeLabel = riverInfoProvider.findGauge(station); |
|
|
150 |
|
8948
|
151 final SInfoResultRow row = SInfoResultRow.create().// |
|
|
152 putValue(SInfoResultType.station, station). // |
|
|
153 putValue(SInfoResultType.flowdepthmin, minFlowDepth). // |
|
|
154 putValue(SInfoResultType.flowdepthmax, maxFlowDepth). // |
|
|
155 putValue(SInfoResultType.waterlevel, wst). // |
|
|
156 putValue(SInfoResultType.discharge, discharge). // |
|
|
157 putValue(SInfoResultType.waterlevelLabel, waterlevelLabel). // |
|
|
158 putValue(SInfoResultType.gaugeLabel, gaugeLabel). // |
|
|
159 putValue(SInfoResultType.meanBedHeight, meanBedHeight). // |
|
|
160 putValue(SInfoResultType.soundingLabel, soundingLabel). // |
|
|
161 putValue(SInfoResultType.location, location); |
|
|
162 rows.add(row); |
|
8946
|
163 } |
|
|
164 } |
|
|
165 |
|
|
166 final BedHeightInfo minBedHeightInfo = minBedHeight == null ? null : minBedHeight.getInfo(); |
|
|
167 final BedHeightInfo maxBedHeightInfo = maxBedHeight == null ? null : maxBedHeight.getInfo(); |
|
8948
|
168 |
|
8946
|
169 return new FlowDepthMinMaxCalculationResult(label, wstInfo, minBedHeightInfo, maxBedHeightInfo, rows); |
|
|
170 } |
|
|
171 |
|
|
172 private String buildSoundingLabel(final BedHeightsFinder minBedHeight, final BedHeightsFinder maxBedHeight) { |
|
|
173 |
|
|
174 if (minBedHeight == null) |
|
|
175 return maxBedHeight.getInfo().getDescription(); |
|
|
176 |
|
|
177 if (maxBedHeight == null) |
|
|
178 return minBedHeight.getInfo().getDescription(); |
|
|
179 |
|
|
180 return String.format("%s / %s", minBedHeight.getInfo().getDescription(), maxBedHeight.getInfo().getDescription()); |
|
|
181 } |
|
|
182 |
|
|
183 private String createLabel(final WaterlevelData waterlevel, final BedHeightsFinder minBedHeight, final BedHeightsFinder maxBedHeight) { |
|
|
184 |
|
|
185 final StringBuilder buffer = new StringBuilder(waterlevel.getName()); |
|
|
186 |
|
|
187 if (minBedHeight != null) |
|
|
188 buffer.append(" - "). // |
|
|
189 append(minBedHeight.getInfo().getDescription()); |
|
|
190 |
|
|
191 if (maxBedHeight != null) |
|
|
192 buffer.append(" - "). // |
|
|
193 append(maxBedHeight.getInfo().getDescription()); |
|
|
194 |
|
|
195 return buffer.toString(); |
|
|
196 } |
|
|
197 |
|
|
198 private int checkSoundingYear(final BedHeightsFinder minBedHeight, final BedHeightsFinder maxBedHeight, final Calculation problems) { |
|
|
199 |
|
|
200 if (maxBedHeight == null) |
|
|
201 return minBedHeight.getInfo().getYear(); |
|
|
202 |
|
|
203 if (minBedHeight == null) |
|
|
204 return maxBedHeight.getInfo().getYear(); |
|
|
205 |
|
|
206 final int minYear = minBedHeight.getInfo().getYear(); |
|
|
207 final int maxYear = minBedHeight.getInfo().getYear(); |
|
|
208 |
|
|
209 if (minYear != maxYear) |
|
|
210 problems.addProblem("sinfo.flowdepthminmaxcalculation.soundingyear.different"); |
|
|
211 |
|
|
212 return minYear; |
|
|
213 } |
|
|
214 } |
