1 package org.djunits.quantity;
2
3 import org.djunits.quantity.def.Quantity;
4 import org.djunits.unit.AbstractUnit;
5 import org.djunits.unit.UnitRuntimeException;
6 import org.djunits.unit.Unitless;
7 import org.djunits.unit.Units;
8 import org.djunits.unit.scale.LinearScale;
9 import org.djunits.unit.scale.Scale;
10 import org.djunits.unit.si.SIUnit;
11 import org.djunits.unit.system.UnitSystem;
12
13 /**
14 * Flow volume is the rate of volume passing through a surface per unit time, measured in cubic meters per second (m3/s).
15 * <p>
16 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
17 * for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
18 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
19 * @author Alexander Verbraeck
20 */
21 public class FlowVolume extends Quantity<FlowVolume>
22 {
23 /** Constant with value zero. */
24 public static final FlowVolume ZERO = FlowVolume.ofSi(0.0);
25
26 /** Constant with value one. */
27 public static final FlowVolume ONE = FlowVolume.ofSi(1.0);
28
29 /** Constant with value NaN. */
30 @SuppressWarnings("checkstyle:constantname")
31 public static final FlowVolume NaN = FlowVolume.ofSi(Double.NaN);
32
33 /** Constant with value POSITIVE_INFINITY. */
34 public static final FlowVolume POSITIVE_INFINITY = FlowVolume.ofSi(Double.POSITIVE_INFINITY);
35
36 /** Constant with value NEGATIVE_INFINITY. */
37 public static final FlowVolume NEGATIVE_INFINITY = FlowVolume.ofSi(Double.NEGATIVE_INFINITY);
38
39 /** Constant with value MAX_VALUE. */
40 public static final FlowVolume POS_MAXVALUE = FlowVolume.ofSi(Double.MAX_VALUE);
41
42 /** Constant with value -MAX_VALUE. */
43 public static final FlowVolume NEG_MAXVALUE = FlowVolume.ofSi(-Double.MAX_VALUE);
44
45 /** */
46 private static final long serialVersionUID = 600L;
47
48 /**
49 * Instantiate a FlowVolume quantity with a unit.
50 * @param valueInUnit the value, expressed in the unit
51 * @param unit the unit in which the value is expressed
52 */
53 public FlowVolume(final double valueInUnit, final FlowVolume.Unit unit)
54 {
55 super(valueInUnit, unit);
56 }
57
58 /**
59 * Instantiate a FlowVolume quantity with a unit, expressed as a String.
60 * @param valueInUnit the value, expressed in the unit
61 * @param abbreviation the String abbreviation of the unit in which the value is expressed
62 */
63 public FlowVolume(final double valueInUnit, final String abbreviation)
64 {
65 this(valueInUnit, Units.resolve(FlowVolume.Unit.class, abbreviation));
66 }
67
68 /**
69 * Construct FlowVolume quantity.
70 * @param value Scalar from which to construct this instance
71 */
72 public FlowVolume(final FlowVolume value)
73 {
74 super(value.si(), FlowVolume.Unit.SI);
75 setDisplayUnit(value.getDisplayUnit());
76 }
77
78 /**
79 * Return a FlowVolume instance based on an SI value.
80 * @param si the si value
81 * @return the FlowVolume instance based on an SI value
82 */
83 public static FlowVolume ofSi(final double si)
84 {
85 return new FlowVolume(si, FlowVolume.Unit.SI);
86 }
87
88 @Override
89 public FlowVolume instantiateSi(final double si)
90 {
91 return ofSi(si);
92 }
93
94 @Override
95 public SIUnit siUnit()
96 {
97 return FlowVolume.Unit.SI_UNIT;
98 }
99
100 /**
101 * Returns a FlowVolume representation of a textual representation of a value with a unit. The String representation that
102 * can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are
103 * allowed, but not required, between the value and the unit.
104 * @param text the textual representation to parse into a FlowVolume
105 * @return the Scalar representation of the value in its unit
106 * @throws IllegalArgumentException when the text cannot be parsed
107 * @throws NullPointerException when the text argument is null
108 */
109 public static FlowVolume valueOf(final String text)
110 {
111 return Quantity.valueOf(text, ZERO);
112 }
113
114 /**
115 * Returns a FlowVolume based on a value and the textual representation of the unit, which can be localized.
116 * @param valueInUnit the value, expressed in the unit as given by unitString
117 * @param unitString the textual representation of the unit
118 * @return the Scalar representation of the value in its unit
119 * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
120 * @throws NullPointerException when the unitString argument is null
121 */
122 public static FlowVolume of(final double valueInUnit, final String unitString)
123 {
124 return Quantity.of(valueInUnit, unitString, ZERO);
125 }
126
127 @Override
128 public FlowVolume.Unit getDisplayUnit()
129 {
130 return (FlowVolume.Unit) super.getDisplayUnit();
131 }
132
133 /**
134 * Calculate the division of FlowVolume and FlowVolume, which results in a Dimensionless quantity.
135 * @param v quantity
136 * @return quantity as a division of FlowVolume and FlowVolume
137 */
138 public final Dimensionless divide(final FlowVolume v)
139 {
140 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
141 }
142
143 /**
144 * Calculate the multiplication of FlowVolume and Duration, which results in a Volume scalar.
145 * @param v scalar
146 * @return scalar as a multiplication of FlowVolume and Duration
147 */
148 public final Volume multiply(final Duration v)
149 {
150 return new Volume(this.si() * v.si(), Volume.Unit.SI);
151 }
152
153 /**
154 * Calculate the division of FlowVolume and Frequency, which results in a Volume scalar.
155 * @param v scalar
156 * @return scalar as a division of FlowVolume and Frequency
157 */
158 public final Volume divide(final Frequency v)
159 {
160 return new Volume(this.si() / v.si(), Volume.Unit.SI);
161 }
162
163 /**
164 * Calculate the division of FlowVolume and Volume, which results in a Frequency scalar.
165 * @param v scalar
166 * @return scalar as a division of FlowVolume and Volume
167 */
168 public final Frequency divide(final Volume v)
169 {
170 return new Frequency(this.si() / v.si(), Frequency.Unit.SI);
171 }
172
173 /**
174 * Calculate the division of FlowVolume and Area, which results in a Speed scalar.
175 * @param v scalar
176 * @return scalar as a division of FlowVolume and Area
177 */
178 public final Speed divide(final Area v)
179 {
180 return new Speed(this.si() / v.si(), Speed.Unit.SI);
181 }
182
183 /**
184 * Calculate the division of FlowVolume and Speed, which results in a Area scalar.
185 * @param v scalar
186 * @return scalar as a division of FlowVolume and Speed
187 */
188 public final Area divide(final Speed v)
189 {
190 return new Area(this.si() / v.si(), Area.Unit.SI);
191 }
192
193 /**
194 * Calculate the multiplication of FlowVolume and Density, which results in a FlowMass scalar.
195 * @param v scalar
196 * @return scalar as a multiplication of FlowVolume and Density
197 */
198 public final FlowMass multiply(final Density v)
199 {
200 return new FlowMass(this.si() * v.si(), FlowMass.Unit.SI);
201 }
202
203 /******************************************************************************************************/
204 /********************************************** UNIT CLASS ********************************************/
205 /******************************************************************************************************/
206
207 /**
208 * FlowVolume.Unit encodes the units of volume flow.
209 * <p>
210 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
211 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
212 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
213 * @author Alexander Verbraeck
214 */
215 @SuppressWarnings("checkstyle:constantname")
216 public static class Unit extends AbstractUnit<FlowVolume.Unit, FlowVolume>
217 {
218 /** The dimensions of the flow volume is m3/s. */
219 public static final SIUnit SI_UNIT = SIUnit.of("m3/s");
220
221 /** m3/s. */
222 public static final FlowVolume.Unit m3_s =
223 new FlowVolume.Unit("m3/s", "cubic meter per second", 1.0, UnitSystem.SI_DERIVED);
224
225 /** The SI or BASE unit. */
226 public static final FlowVolume.Unit SI = m3_s;
227
228 /** m^3/min. */
229 public static final FlowVolume.Unit m3_min =
230 m3_s.deriveUnit("m3/min", "cubic meter per minute", 1.0 / 60.0, UnitSystem.SI_ACCEPTED);
231
232 /** m^3/hour. */
233 public static final FlowVolume.Unit m3_h =
234 m3_s.deriveUnit("m3/h", "cubic meter per hour", 1.0 / 3600.0, UnitSystem.SI_ACCEPTED);
235
236 /** m^3/day. */
237 public static final FlowVolume.Unit m3_day =
238 m3_h.deriveUnit("m3/day", "cubic meter per day", 1.0 / 24.0, UnitSystem.SI_ACCEPTED);
239
240 /** L/s. */
241 public static final FlowVolume.Unit L_s = m3_s.deriveUnit("L/s", "liter per second", 1E-3, UnitSystem.SI_ACCEPTED);
242
243 /** L/min. */
244 public static final FlowVolume.Unit L_min =
245 L_s.deriveUnit("L/min", "liter per minute", 1.0 / 60.0, UnitSystem.SI_ACCEPTED);
246
247 /** L/hour. */
248 public static final FlowVolume.Unit L_h = L_s.deriveUnit("L/h", "liter per hour", 1.0 / 3600.0, UnitSystem.SI_ACCEPTED);
249
250 /** L/day. */
251 public static final FlowVolume.Unit L_day =
252 L_h.deriveUnit("L/day", "liter per day", 1.0 / 24.0, UnitSystem.SI_ACCEPTED);
253
254 /** ft^3/s. */
255 public static final FlowVolume.Unit ft3_s =
256 m3_s.deriveUnit("ft3/s", "cubic foot per second", Volume.Unit.CONST_CUBIC_FOOT, UnitSystem.IMPERIAL);
257
258 /** ft^3/min. */
259 public static final FlowVolume.Unit ft3_min =
260 ft3_s.deriveUnit("ft3/min", "cubic foot per minute", 1.0 / 60.0, UnitSystem.IMPERIAL);
261
262 /** in^3/s. */
263 public static final FlowVolume.Unit in3_s =
264 m3_s.deriveUnit("in3/s", "cubic inch per second", Volume.Unit.CONST_CUBIC_INCH, UnitSystem.IMPERIAL);
265
266 /** in^3/min. */
267 public static final FlowVolume.Unit in3_min =
268 in3_s.deriveUnit("in3/min", "cubic inch per minute", 1.0 / 60.0, UnitSystem.IMPERIAL);
269
270 /** gallon/s (US). */
271 public static final FlowVolume.Unit gal_US_s =
272 m3_s.deriveUnit("gal(US)/s", "US gallon per second", Volume.Unit.CONST_GALLON_US, UnitSystem.US_CUSTOMARY);
273
274 /** gallon/min (US). */
275 public static final FlowVolume.Unit gal_US_min =
276 gal_US_s.deriveUnit("gal(US)/min", "US gallon per minute", 1.0 / 60.0, UnitSystem.US_CUSTOMARY);
277
278 /** gallon/hour (US). */
279 public static final FlowVolume.Unit gal_US_h =
280 gal_US_s.deriveUnit("gal(US)/h", "US gallon per hour", 1.0 / 3600.0, UnitSystem.US_CUSTOMARY);
281
282 /** gallon/day (US). */
283 public static final FlowVolume.Unit gal_US_day =
284 gal_US_h.deriveUnit("gal(US)/day", "US gallon per day", 1.0 / 24.0, UnitSystem.US_CUSTOMARY);
285
286 /**
287 * Create a new FlowVolume unit.
288 * @param id the id or main abbreviation of the unit
289 * @param name the full name of the unit
290 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
291 * @param unitSystem the unit system such as SI or IMPERIAL
292 */
293 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
294 {
295 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
296 }
297
298 /**
299 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
300 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
301 * @param displayAbbreviation the display abbreviation of the unit
302 * @param name the full name of the unit
303 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
304 * @param unitSystem unit system, e.g. SI or Imperial
305 */
306 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
307 final UnitSystem unitSystem)
308 {
309 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
310 }
311
312 @Override
313 public SIUnit siUnit()
314 {
315 return SI_UNIT;
316 }
317
318 @Override
319 public Unit getBaseUnit()
320 {
321 return SI;
322 }
323
324 @Override
325 public FlowVolume ofSi(final double si)
326 {
327 return FlowVolume.ofSi(si);
328 }
329
330 @Override
331 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
332 final double scaleFactor, final UnitSystem unitSystem)
333 {
334 if (getScale() instanceof LinearScale ls)
335 {
336 return new FlowVolume.Unit(textualAbbreviation, displayAbbreviation, name,
337 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
338 }
339 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
340 }
341
342 }
343 }