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