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, FlowVolume.Unit>
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 value the value, expressed in the unit
51 * @param unit the unit in which the value is expressed
52 */
53 public FlowVolume(final double value, final FlowVolume.Unit unit)
54 {
55 super(value, unit);
56 }
57
58 /**
59 * Instantiate a FlowVolume quantity with a unit, expressed as a String.
60 * @param value 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 value, final String abbreviation)
64 {
65 this(value, 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 instantiate(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 value the value to use
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 value, final String unitString)
123 {
124 return Quantity.of(value, unitString, ZERO);
125 }
126
127 /**
128 * Calculate the division of FlowVolume and FlowVolume, which results in a Dimensionless quantity.
129 * @param v quantity
130 * @return quantity as a division of FlowVolume and FlowVolume
131 */
132 public final Dimensionless divide(final FlowVolume v)
133 {
134 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
135 }
136
137 /**
138 * Calculate the multiplication of FlowVolume and Duration, which results in a Volume scalar.
139 * @param v scalar
140 * @return scalar as a multiplication of FlowVolume and Duration
141 */
142 public final Volume multiply(final Duration v)
143 {
144 return new Volume(this.si() * v.si(), Volume.Unit.SI);
145 }
146
147 /**
148 * Calculate the division of FlowVolume and Frequency, which results in a Volume scalar.
149 * @param v scalar
150 * @return scalar as a division of FlowVolume and Frequency
151 */
152 public final Volume divide(final Frequency v)
153 {
154 return new Volume(this.si() / v.si(), Volume.Unit.SI);
155 }
156
157 /**
158 * Calculate the division of FlowVolume and Volume, which results in a Frequency scalar.
159 * @param v scalar
160 * @return scalar as a division of FlowVolume and Volume
161 */
162 public final Frequency divide(final Volume v)
163 {
164 return new Frequency(this.si() / v.si(), Frequency.Unit.SI);
165 }
166
167 /**
168 * Calculate the division of FlowVolume and Area, which results in a Speed scalar.
169 * @param v scalar
170 * @return scalar as a division of FlowVolume and Area
171 */
172 public final Speed divide(final Area v)
173 {
174 return new Speed(this.si() / v.si(), Speed.Unit.SI);
175 }
176
177 /**
178 * Calculate the division of FlowVolume and Speed, which results in a Area scalar.
179 * @param v scalar
180 * @return scalar as a division of FlowVolume and Speed
181 */
182 public final Area divide(final Speed v)
183 {
184 return new Area(this.si() / v.si(), Area.Unit.SI);
185 }
186
187 /**
188 * Calculate the multiplication of FlowVolume and Density, which results in a FlowMass scalar.
189 * @param v scalar
190 * @return scalar as a multiplication of FlowVolume and Density
191 */
192 public final FlowMass multiply(final Density v)
193 {
194 return new FlowMass(this.si() * v.si(), FlowMass.Unit.SI);
195 }
196
197 /******************************************************************************************************/
198 /********************************************** UNIT CLASS ********************************************/
199 /******************************************************************************************************/
200
201 /**
202 * FlowVolume.Unit encodes the units of volume flow.
203 * <p>
204 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
205 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
206 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
207 * @author Alexander Verbraeck
208 */
209 @SuppressWarnings("checkstyle:constantname")
210 public static class Unit extends AbstractUnit<FlowVolume.Unit, FlowVolume>
211 {
212 /** The dimensions of the flow volume is m3/s. */
213 public static final SIUnit SI_UNIT = SIUnit.of("m3/s");
214
215 /** m3/s. */
216 public static final FlowVolume.Unit m3_s =
217 new FlowVolume.Unit("m3/s", "cubic meter per second", 1.0, UnitSystem.SI_DERIVED);
218
219 /** The SI or BASE unit. */
220 public static final FlowVolume.Unit SI = m3_s;
221
222 /** m^3/min. */
223 public static final FlowVolume.Unit m3_min =
224 m3_s.deriveUnit("m3/min", "cubic meter per minute", 1.0 / 60.0, UnitSystem.SI_ACCEPTED);
225
226 /** m^3/hour. */
227 public static final FlowVolume.Unit m3_h =
228 m3_s.deriveUnit("m3/h", "cubic meter per hour", 1.0 / 3600.0, UnitSystem.SI_ACCEPTED);
229
230 /** m^3/day. */
231 public static final FlowVolume.Unit m3_day =
232 m3_h.deriveUnit("m3/day", "cubic meter per day", 1.0 / 24.0, UnitSystem.SI_ACCEPTED);
233
234 /** L/s. */
235 public static final FlowVolume.Unit L_s = m3_s.deriveUnit("L/s", "liter per second", 1E-3, UnitSystem.SI_ACCEPTED);
236
237 /** L/min. */
238 public static final FlowVolume.Unit L_min =
239 L_s.deriveUnit("L/min", "liter per minute", 1.0 / 60.0, UnitSystem.SI_ACCEPTED);
240
241 /** L/hour. */
242 public static final FlowVolume.Unit L_h = L_s.deriveUnit("L/h", "liter per hour", 1.0 / 3600.0, UnitSystem.SI_ACCEPTED);
243
244 /** L/day. */
245 public static final FlowVolume.Unit L_day =
246 L_h.deriveUnit("L/day", "liter per day", 1.0 / 24.0, UnitSystem.SI_ACCEPTED);
247
248 /** ft^3/s. */
249 public static final FlowVolume.Unit ft3_s =
250 m3_s.deriveUnit("ft3/s", "cubic foot per second", Volume.Unit.CONST_CUBIC_FOOT, UnitSystem.IMPERIAL);
251
252 /** ft^3/min. */
253 public static final FlowVolume.Unit ft3_min =
254 ft3_s.deriveUnit("ft3/min", "cubic foot per minute", 1.0 / 60.0, UnitSystem.IMPERIAL);
255
256 /** in^3/s. */
257 public static final FlowVolume.Unit in3_s =
258 m3_s.deriveUnit("in3/s", "cubic inch per second", Volume.Unit.CONST_CUBIC_INCH, UnitSystem.IMPERIAL);
259
260 /** in^3/min. */
261 public static final FlowVolume.Unit in3_min =
262 in3_s.deriveUnit("in3/min", "cubic inch per minute", 1.0 / 60.0, UnitSystem.IMPERIAL);
263
264 /** gallon/s (US). */
265 public static final FlowVolume.Unit gal_US_s =
266 m3_s.deriveUnit("gal(US)/s", "US gallon per second", Volume.Unit.CONST_GALLON_US, UnitSystem.US_CUSTOMARY);
267
268 /** gallon/min (US). */
269 public static final FlowVolume.Unit gal_US_min =
270 gal_US_s.deriveUnit("gal(US)/min", "US gallon per minute", 1.0 / 60.0, UnitSystem.US_CUSTOMARY);
271
272 /** gallon/hour (US). */
273 public static final FlowVolume.Unit gal_US_h =
274 gal_US_s.deriveUnit("gal(US)/h", "US gallon per hour", 1.0 / 3600.0, UnitSystem.US_CUSTOMARY);
275
276 /** gallon/day (US). */
277 public static final FlowVolume.Unit gal_US_day =
278 gal_US_h.deriveUnit("gal(US)/day", "US gallon per day", 1.0 / 24.0, UnitSystem.US_CUSTOMARY);
279
280 /**
281 * Create a new FlowVolume unit.
282 * @param id the id or main abbreviation of the unit
283 * @param name the full name of the unit
284 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
285 * @param unitSystem the unit system such as SI or IMPERIAL
286 */
287 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
288 {
289 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
290 }
291
292 /**
293 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
294 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
295 * @param displayAbbreviation the display abbreviation of the unit
296 * @param name the full name of the unit
297 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
298 * @param unitSystem unit system, e.g. SI or Imperial
299 */
300 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
301 final UnitSystem unitSystem)
302 {
303 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
304 }
305
306 @Override
307 public SIUnit siUnit()
308 {
309 return SI_UNIT;
310 }
311
312 @Override
313 public Unit getBaseUnit()
314 {
315 return SI;
316 }
317
318 @Override
319 public FlowVolume ofSi(final double si)
320 {
321 return FlowVolume.ofSi(si);
322 }
323
324 @Override
325 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
326 final double scaleFactor, final UnitSystem unitSystem)
327 {
328 if (getScale() instanceof LinearScale ls)
329 {
330 return new FlowVolume.Unit(textualAbbreviation, displayAbbreviation, name,
331 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
332 }
333 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
334 }
335
336 }
337 }