1 package org.djunits.value.vdouble.scalar;
2
3 import java.util.Locale;
4
5 import org.djunits.unit.AreaUnit;
6 import org.djunits.unit.DimensionlessUnit;
7 import org.djunits.unit.FlowMassUnit;
8 import org.djunits.unit.FlowVolumeUnit;
9 import org.djunits.unit.FrequencyUnit;
10 import org.djunits.unit.SpeedUnit;
11 import org.djunits.unit.VolumeUnit;
12 import org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel;
13 import org.djunits.value.vdouble.scalar.base.DoubleScalar;
14 import org.djutils.base.NumberParser;
15 import org.djutils.exceptions.Throw;
16
17 import jakarta.annotation.Generated;
18
19
20
21
22
23
24
25
26
27
28 @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-04-30T13:59:27.633664900Z")
29 public class FlowVolume extends AbstractDoubleScalarRel<FlowVolumeUnit, FlowVolume>
30 {
31
32 private static final long serialVersionUID = 20150905L;
33
34
35 public static final FlowVolume ZERO = new FlowVolume(0.0, FlowVolumeUnit.SI);
36
37
38 public static final FlowVolume ONE = new FlowVolume(1.0, FlowVolumeUnit.SI);
39
40
41 @SuppressWarnings("checkstyle:constantname")
42 public static final FlowVolume NaN = new FlowVolume(Double.NaN, FlowVolumeUnit.SI);
43
44
45 public static final FlowVolume POSITIVE_INFINITY = new FlowVolume(Double.POSITIVE_INFINITY, FlowVolumeUnit.SI);
46
47
48 public static final FlowVolume NEGATIVE_INFINITY = new FlowVolume(Double.NEGATIVE_INFINITY, FlowVolumeUnit.SI);
49
50
51 public static final FlowVolume POS_MAXVALUE = new FlowVolume(Double.MAX_VALUE, FlowVolumeUnit.SI);
52
53
54 public static final FlowVolume NEG_MAXVALUE = new FlowVolume(-Double.MAX_VALUE, FlowVolumeUnit.SI);
55
56
57
58
59
60
61 public FlowVolume(final double value, final FlowVolumeUnit unit)
62 {
63 super(value, unit);
64 }
65
66
67
68
69
70 public FlowVolume(final FlowVolume value)
71 {
72 super(value);
73 }
74
75
76 @Override
77 public final FlowVolume instantiateRel(final double value, final FlowVolumeUnit unit)
78 {
79 return new FlowVolume(value, unit);
80 }
81
82
83
84
85
86
87 public static final FlowVolume instantiateSI(final double value)
88 {
89 return new FlowVolume(value, FlowVolumeUnit.SI);
90 }
91
92
93
94
95
96
97
98
99 public static FlowVolume interpolate(final FlowVolume zero, final FlowVolume one, final double ratio)
100 {
101 return new FlowVolume(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
102 zero.getDisplayUnit());
103 }
104
105
106
107
108
109
110
111 public static FlowVolume max(final FlowVolume r1, final FlowVolume r2)
112 {
113 return r1.gt(r2) ? r1 : r2;
114 }
115
116
117
118
119
120
121
122
123 public static FlowVolume max(final FlowVolume r1, final FlowVolume r2, final FlowVolume... rn)
124 {
125 FlowVolume maxr = r1.gt(r2) ? r1 : r2;
126 for (FlowVolume r : rn)
127 {
128 if (r.gt(maxr))
129 {
130 maxr = r;
131 }
132 }
133 return maxr;
134 }
135
136
137
138
139
140
141
142 public static FlowVolume min(final FlowVolume r1, final FlowVolume r2)
143 {
144 return r1.lt(r2) ? r1 : r2;
145 }
146
147
148
149
150
151
152
153
154 public static FlowVolume min(final FlowVolume r1, final FlowVolume r2, final FlowVolume... rn)
155 {
156 FlowVolume minr = r1.lt(r2) ? r1 : r2;
157 for (FlowVolume r : rn)
158 {
159 if (r.lt(minr))
160 {
161 minr = r;
162 }
163 }
164 return minr;
165 }
166
167
168
169
170
171
172
173
174
175
176 public static FlowVolume valueOf(final String text)
177 {
178 Throw.whenNull(text, "Error parsing FlowVolume: text to parse is null");
179 Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing FlowVolume: empty text to parse");
180 try
181 {
182 NumberParser numberParser = new NumberParser().lenient().trailing();
183 double d = numberParser.parseDouble(text);
184 String unitString = text.substring(numberParser.getTrailingPosition()).trim();
185 FlowVolumeUnit unit = FlowVolumeUnit.BASE.getUnitByAbbreviation(unitString);
186 if (unit == null)
187 throw new IllegalArgumentException("Unit " + unitString + " not found");
188 return new FlowVolume(d, unit);
189 }
190 catch (Exception exception)
191 {
192 throw new IllegalArgumentException(
193 "Error parsing FlowVolume from " + text + " using Locale " + Locale.getDefault(Locale.Category.FORMAT),
194 exception);
195 }
196 }
197
198
199
200
201
202
203
204
205
206 public static FlowVolume of(final double value, final String unitString)
207 {
208 Throw.whenNull(unitString, "Error parsing FlowVolume: unitString is null");
209 Throw.when(unitString.length() == 0, IllegalArgumentException.class, "Error parsing FlowVolume: empty unitString");
210 FlowVolumeUnit unit = FlowVolumeUnit.BASE.getUnitByAbbreviation(unitString);
211 if (unit != null)
212 {
213 return new FlowVolume(value, unit);
214 }
215 throw new IllegalArgumentException("Error parsing FlowVolume with unit " + unitString);
216 }
217
218
219
220
221
222
223 public final Dimensionless divide(final FlowVolume v)
224 {
225 return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
226 }
227
228
229
230
231
232
233 public final Volume times(final Duration v)
234 {
235 return new Volume(this.si * v.si, VolumeUnit.SI);
236 }
237
238
239
240
241
242
243 public final Volume divide(final Frequency v)
244 {
245 return new Volume(this.si / v.si, VolumeUnit.SI);
246 }
247
248
249
250
251
252
253 public final Frequency divide(final Volume v)
254 {
255 return new Frequency(this.si / v.si, FrequencyUnit.SI);
256 }
257
258
259
260
261
262
263 public final Speed divide(final Area v)
264 {
265 return new Speed(this.si / v.si, SpeedUnit.SI);
266 }
267
268
269
270
271
272
273 public final Area divide(final Speed v)
274 {
275 return new Area(this.si / v.si, AreaUnit.SI);
276 }
277
278
279
280
281
282
283 public final FlowMass times(final Density v)
284 {
285 return new FlowMass(this.si * v.si, FlowMassUnit.SI);
286 }
287
288
289 @Override
290 public SIScalar reciprocal()
291 {
292 return DoubleScalar.divide(Dimensionless.ONE, this);
293 }
294
295 }