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