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.DurationUnit;
8 import org.djunits.unit.EnergyUnit;
9 import org.djunits.unit.FlowVolumeUnit;
10 import org.djunits.unit.LengthUnit;
11 import org.djunits.unit.MassUnit;
12 import org.djunits.unit.VolumeUnit;
13 import org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel;
14 import org.djunits.value.vdouble.scalar.base.DoubleScalar;
15 import org.djutils.base.NumberParser;
16 import org.djutils.exceptions.Throw;
17
18 import jakarta.annotation.Generated;
19
20
21
22
23
24
25
26
27
28
29 @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-04-30T13:59:27.633664900Z")
30 public class Volume extends AbstractDoubleScalarRel<VolumeUnit, Volume>
31 {
32
33 private static final long serialVersionUID = 20150905L;
34
35
36 public static final Volume ZERO = new Volume(0.0, VolumeUnit.SI);
37
38
39 public static final Volume ONE = new Volume(1.0, VolumeUnit.SI);
40
41
42 @SuppressWarnings("checkstyle:constantname")
43 public static final Volume NaN = new Volume(Double.NaN, VolumeUnit.SI);
44
45
46 public static final Volume POSITIVE_INFINITY = new Volume(Double.POSITIVE_INFINITY, VolumeUnit.SI);
47
48
49 public static final Volume NEGATIVE_INFINITY = new Volume(Double.NEGATIVE_INFINITY, VolumeUnit.SI);
50
51
52 public static final Volume POS_MAXVALUE = new Volume(Double.MAX_VALUE, VolumeUnit.SI);
53
54
55 public static final Volume NEG_MAXVALUE = new Volume(-Double.MAX_VALUE, VolumeUnit.SI);
56
57
58
59
60
61
62 public Volume(final double value, final VolumeUnit unit)
63 {
64 super(value, unit);
65 }
66
67
68
69
70
71 public Volume(final Volume value)
72 {
73 super(value);
74 }
75
76
77 @Override
78 public final Volume instantiateRel(final double value, final VolumeUnit unit)
79 {
80 return new Volume(value, unit);
81 }
82
83
84
85
86
87
88 public static final Volume instantiateSI(final double value)
89 {
90 return new Volume(value, VolumeUnit.SI);
91 }
92
93
94
95
96
97
98
99
100 public static Volume interpolate(final Volume zero, final Volume one, final double ratio)
101 {
102 return new Volume(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio, zero.getDisplayUnit());
103 }
104
105
106
107
108
109
110
111 public static Volume max(final Volume r1, final Volume r2)
112 {
113 return r1.gt(r2) ? r1 : r2;
114 }
115
116
117
118
119
120
121
122
123 public static Volume max(final Volume r1, final Volume r2, final Volume... rn)
124 {
125 Volume maxr = r1.gt(r2) ? r1 : r2;
126 for (Volume 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 Volume min(final Volume r1, final Volume r2)
143 {
144 return r1.lt(r2) ? r1 : r2;
145 }
146
147
148
149
150
151
152
153
154 public static Volume min(final Volume r1, final Volume r2, final Volume... rn)
155 {
156 Volume minr = r1.lt(r2) ? r1 : r2;
157 for (Volume 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 Volume valueOf(final String text)
177 {
178 Throw.whenNull(text, "Error parsing Volume: text to parse is null");
179 Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing Volume: 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 VolumeUnit unit = VolumeUnit.BASE.getUnitByAbbreviation(unitString);
186 if (unit == null)
187 throw new IllegalArgumentException("Unit " + unitString + " not found");
188 return new Volume(d, unit);
189 }
190 catch (Exception exception)
191 {
192 throw new IllegalArgumentException(
193 "Error parsing Volume 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 Volume of(final double value, final String unitString)
207 {
208 Throw.whenNull(unitString, "Error parsing Volume: unitString is null");
209 Throw.when(unitString.length() == 0, IllegalArgumentException.class, "Error parsing Volume: empty unitString");
210 VolumeUnit unit = VolumeUnit.BASE.getUnitByAbbreviation(unitString);
211 if (unit != null)
212 {
213 return new Volume(value, unit);
214 }
215 throw new IllegalArgumentException("Error parsing Volume with unit " + unitString);
216 }
217
218
219
220
221
222
223 public final Dimensionless divide(final Volume v)
224 {
225 return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
226 }
227
228
229
230
231
232
233 public final Mass times(final Density v)
234 {
235 return new Mass(this.si * v.si, MassUnit.SI);
236 }
237
238
239
240
241
242
243 public final Energy times(final Pressure v)
244 {
245 return new Energy(this.si * v.si, EnergyUnit.SI);
246 }
247
248
249
250
251
252
253 public final Area divide(final Length v)
254 {
255 return new Area(this.si / v.si, AreaUnit.SI);
256 }
257
258
259
260
261
262
263 public final Length divide(final Area v)
264 {
265 return new Length(this.si / v.si, LengthUnit.SI);
266 }
267
268
269
270
271
272
273 public final Area times(final LinearDensity v)
274 {
275 return new Area(this.si * v.si, AreaUnit.SI);
276 }
277
278
279
280
281
282
283 public final FlowVolume divide(final Duration v)
284 {
285 return new FlowVolume(this.si / v.si, FlowVolumeUnit.SI);
286 }
287
288
289
290
291
292
293 public final Duration divide(final FlowVolume v)
294 {
295 return new Duration(this.si / v.si, DurationUnit.SI);
296 }
297
298
299 @Override
300 public SIScalar reciprocal()
301 {
302 return DoubleScalar.divide(Dimensionless.ONE, this);
303 }
304
305 }