-
Notifications
You must be signed in to change notification settings - Fork 5
/
ThermalUnitValidationUtils.java
241 lines (212 loc) · 8.56 KB
/
ThermalUnitValidationUtils.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/*
* © 2021. TU Dortmund University,
* Institute of Energy Systems, Energy Efficiency and Energy Economics,
* Research group Distribution grid planning and operation
*/
package edu.ie3.datamodel.utils.validation;
import edu.ie3.datamodel.exceptions.InvalidEntityException;
import edu.ie3.datamodel.exceptions.ValidationException;
import edu.ie3.datamodel.models.input.thermal.*;
import edu.ie3.datamodel.utils.Try;
import edu.ie3.datamodel.utils.Try.Failure;
import java.util.ArrayList;
import java.util.List;
import javax.measure.Quantity;
public class ThermalUnitValidationUtils extends ValidationUtils {
/** Private Constructor as this class is not meant to be instantiated */
private ThermalUnitValidationUtils() {
throw new IllegalStateException("Don't try and instantiate a Utility class.");
}
/**
* Validates a thermal unit if:
*
* <ul>
* <li>it is not null
* </ul>
*
* A "distribution" method, that forwards the check request to specific implementations to fulfill
* the checking task, based on the class of the given object.
*
* @param thermalUnitInput ThermalUnitInput to validate
* @return a list of try objects either containing an {@link ValidationException} or an empty
* Success
*/
protected static List<Try<Void, ? extends ValidationException>> check(
ThermalUnitInput thermalUnitInput) {
Try<Void, InvalidEntityException> isNull = checkNonNull(thermalUnitInput, "a thermal unit");
if (isNull.isFailure()) {
return List.of(isNull);
}
List<Try<Void, ? extends ValidationException>> exceptions = new ArrayList<>();
// Further checks for subclasses
if (ThermalSinkInput.class.isAssignableFrom(thermalUnitInput.getClass())) {
exceptions.addAll(checkThermalSink((ThermalSinkInput) thermalUnitInput));
} else if (ThermalStorageInput.class.isAssignableFrom(thermalUnitInput.getClass())) {
exceptions.addAll(checkThermalStorage((ThermalStorageInput) thermalUnitInput));
} else {
logNotImplemented(thermalUnitInput);
}
return exceptions;
}
/**
* Validates a thermalSinkInput if:
*
* <ul>
* <li>it is not null
* </ul>
*
* A "distribution" method, that forwards the check request to specific implementations to fulfill
* the checking task, based on the class of the given object.
*
* @param thermalSinkInput ThermalSinkInput to validate
* @return a list of try objects either containing an {@link ValidationException} or an empty
* Success
*/
private static List<Try<Void, ? extends ValidationException>> checkThermalSink(
ThermalSinkInput thermalSinkInput) {
Try<Void, InvalidEntityException> isNull = checkNonNull(thermalSinkInput, "a thermal sink");
if (isNull.isFailure()) {
return List.of(isNull);
}
List<Try<Void, ? extends ValidationException>> exceptions = new ArrayList<>();
// Further checks for subclasses
if (ThermalHouseInput.class.isAssignableFrom(thermalSinkInput.getClass())) {
exceptions.addAll(checkThermalHouse((ThermalHouseInput) thermalSinkInput));
} else {
logNotImplemented(thermalSinkInput);
}
return exceptions;
}
/**
* Validates a thermalStorageInput if:
*
* <ul>
* <li>it is not null
* </ul>
*
* A "distribution" method, that forwards the check request to specific implementations to fulfill
* the checking task, based on the class of the given object.
*
* @param thermalStorageInput ThermalStorageInput to validate
* @return a list of try objects either containing an {@link ValidationException} or an empty
* Success
*/
private static List<Try<Void, ? extends ValidationException>> checkThermalStorage(
ThermalStorageInput thermalStorageInput) {
Try<Void, InvalidEntityException> isNull =
checkNonNull(thermalStorageInput, "a thermal storage");
if (isNull.isFailure()) {
return List.of(isNull);
}
List<Try<Void, ? extends ValidationException>> exceptions = new ArrayList<>();
// Further checks for subclasses
if (CylindricalStorageInput.class.isAssignableFrom(thermalStorageInput.getClass())) {
exceptions.addAll(checkCylindricalStorage((CylindricalStorageInput) thermalStorageInput));
} else {
logNotImplemented(thermalStorageInput);
}
return exceptions;
}
/**
* Validates a thermalHouseInput if:
*
* <ul>
* <li>it is not null
* <li>its thermal losses are not negative
* <li>its thermal capacity is positive
* <li>its upper temperature limit is higher than the lower temperature limit
* <li>its target temperature lies between the upper und lower limit temperatures
* </ul>
*
* @param thermalHouseInput ThermalHouseInput to validate
* @return a list of try objects either containing an {@link InvalidEntityException} or an empty
* Success
*/
private static List<Try<Void, InvalidEntityException>> checkThermalHouse(
ThermalHouseInput thermalHouseInput) {
Try<Void, InvalidEntityException> isNull = checkNonNull(thermalHouseInput, "a thermal house");
if (isNull.isFailure()) {
return List.of(isNull);
}
List<Try<Void, InvalidEntityException>> exceptions =
new ArrayList<>(
Try.ofVoid(
InvalidEntityException.class,
() ->
detectNegativeQuantities(
new Quantity<?>[] {thermalHouseInput.getEthLosses()}, thermalHouseInput),
() ->
detectZeroOrNegativeQuantities(
new Quantity<?>[] {thermalHouseInput.getEthCapa()}, thermalHouseInput)));
if (thermalHouseInput
.getLowerTemperatureLimit()
.isGreaterThan(thermalHouseInput.getTargetTemperature())
|| thermalHouseInput
.getUpperTemperatureLimit()
.isLessThan(thermalHouseInput.getTargetTemperature())) {
exceptions.add(
new Failure<>(
new InvalidEntityException(
"Target temperature must be higher than lower temperature limit and lower than upper temperature limit",
thermalHouseInput)));
}
return exceptions;
}
/**
* Validates a cylindricalStorageInput if:
*
* <ul>
* <li>it is not null
* <li>its available storage volume is positive
* <li>its minimum permissible storage volume is positive and not greater than the available
* storage volume
* <li>its inlet temperature is equal/greater than the outlet temperature
* <li>its specific heat capacity is positive
* </ul>
*
* @param cylindricalStorageInput CylindricalStorageInput to validate
* @return a list of try objects either containing an {@link InvalidEntityException} or an empty
* Success
*/
private static List<Try<Void, InvalidEntityException>> checkCylindricalStorage(
CylindricalStorageInput cylindricalStorageInput) {
Try<Void, InvalidEntityException> isNull =
checkNonNull(cylindricalStorageInput, "a cylindrical storage");
if (isNull.isFailure()) {
return List.of(isNull);
}
List<Try<Void, InvalidEntityException>> exceptions = new ArrayList<>();
// Check if inlet temperature is higher/equal to outlet temperature
exceptions.add(
Try.ofVoid(
cylindricalStorageInput
.getInletTemp()
.isLessThan(cylindricalStorageInput.getReturnTemp()),
() ->
new InvalidEntityException(
"Inlet temperature of the cylindrical storage cannot be lower than outlet temperature",
cylindricalStorageInput)));
// Check if minimum permissible storage volume is lower than overall available storage volume
exceptions.add(
Try.ofVoid(
cylindricalStorageInput
.getStorageVolumeLvlMin()
.isGreaterThan(cylindricalStorageInput.getStorageVolumeLvl()),
() ->
new InvalidEntityException(
"Minimum permissible storage volume of the cylindrical storage cannot be higher than overall available storage volume",
cylindricalStorageInput)));
exceptions.add(
Try.ofVoid(
() ->
detectZeroOrNegativeQuantities(
new Quantity<?>[] {
cylindricalStorageInput.getStorageVolumeLvl(),
cylindricalStorageInput.getStorageVolumeLvlMin(),
cylindricalStorageInput.getC()
},
cylindricalStorageInput),
InvalidEntityException.class));
return exceptions;
}
}