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 * Volumetric object density counts the number of objects per unit of volume, measured in number per cubic meter (/m3).
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 VolumetricObjectDensity extends Quantity<VolumetricObjectDensity>
22 {
23 /** Constant with value zero. */
24 public static final VolumetricObjectDensity ZERO = VolumetricObjectDensity.ofSi(0.0);
25
26 /** Constant with value one. */
27 public static final VolumetricObjectDensity ONE = VolumetricObjectDensity.ofSi(1.0);
28
29 /** Constant with value NaN. */
30 @SuppressWarnings("checkstyle:constantname")
31 public static final VolumetricObjectDensity NaN = VolumetricObjectDensity.ofSi(Double.NaN);
32
33 /** Constant with value POSITIVE_INFINITY. */
34 public static final VolumetricObjectDensity POSITIVE_INFINITY = VolumetricObjectDensity.ofSi(Double.POSITIVE_INFINITY);
35
36 /** Constant with value NEGATIVE_INFINITY. */
37 public static final VolumetricObjectDensity NEGATIVE_INFINITY = VolumetricObjectDensity.ofSi(Double.NEGATIVE_INFINITY);
38
39 /** Constant with value MAX_VALUE. */
40 public static final VolumetricObjectDensity POS_MAXVALUE = VolumetricObjectDensity.ofSi(Double.MAX_VALUE);
41
42 /** Constant with value -MAX_VALUE. */
43 public static final VolumetricObjectDensity NEG_MAXVALUE = VolumetricObjectDensity.ofSi(-Double.MAX_VALUE);
44
45 /** */
46 private static final long serialVersionUID = 600L;
47
48 /**
49 * Instantiate a VolumetricObjectDensity 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 VolumetricObjectDensity(final double valueInUnit, final VolumetricObjectDensity.Unit unit)
54 {
55 super(valueInUnit, unit);
56 }
57
58 /**
59 * Instantiate a VolumetricObjectDensity 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 VolumetricObjectDensity(final double valueInUnit, final String abbreviation)
64 {
65 this(valueInUnit, Units.resolve(VolumetricObjectDensity.Unit.class, abbreviation));
66 }
67
68 /**
69 * Construct VolumetricObjectDensity quantity.
70 * @param value Scalar from which to construct this instance
71 */
72 public VolumetricObjectDensity(final VolumetricObjectDensity value)
73 {
74 super(value.si(), VolumetricObjectDensity.Unit.SI);
75 setDisplayUnit(value.getDisplayUnit());
76 }
77
78 /**
79 * Return a VolumetricObjectDensity instance based on an SI value.
80 * @param si the si value
81 * @return the VolumetricObjectDensity instance based on an SI value
82 */
83 public static VolumetricObjectDensity ofSi(final double si)
84 {
85 return new VolumetricObjectDensity(si, VolumetricObjectDensity.Unit.SI);
86 }
87
88 @Override
89 public VolumetricObjectDensity instantiateSi(final double si)
90 {
91 return ofSi(si);
92 }
93
94 @Override
95 public SIUnit siUnit()
96 {
97 return VolumetricObjectDensity.Unit.SI_UNIT;
98 }
99
100 /**
101 * Returns a VolumetricObjectDensity representation of a textual representation of a value with a unit. The String
102 * representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the
103 * unit. Spaces are allowed, but not required, between the value and the unit.
104 * @param text the textual representation to parse into a VolumetricObjectDensity
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 VolumetricObjectDensity valueOf(final String text)
110 {
111 return Quantity.valueOf(text, ZERO);
112 }
113
114 /**
115 * Returns a VolumetricObjectDensity 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 VolumetricObjectDensity of(final double valueInUnit, final String unitString)
123 {
124 return Quantity.of(valueInUnit, unitString, ZERO);
125 }
126
127 @Override
128 public VolumetricObjectDensity.Unit getDisplayUnit()
129 {
130 return (VolumetricObjectDensity.Unit) super.getDisplayUnit();
131 }
132
133 /**
134 * Multiplies this volumetric object density by a volume to yield a dimensionless count.
135 * <p>
136 * Formula: (1/m³) x m³ = 1.
137 * @param volume the volume multiplier; must not be {@code null}.
138 * @return the resulting dimensionless count in SI (1).
139 * @throws NullPointerException if {@code volume} is {@code null}.
140 */
141 public final Dimensionless multiply(final Volume volume)
142 {
143 return new Dimensionless(this.si() * volume.si(), Unitless.BASE);
144 }
145
146 /**
147 * Multiplies this volumetric object density by an area to yield a linear object density.
148 * <p>
149 * Formula: (1/m³) x m² = 1/m.
150 * @param area the area multiplier; must not be {@code null}.
151 * @return the resulting linear object density in SI (1/m).
152 * @throws NullPointerException if {@code area} is {@code null}.
153 */
154 public final LinearObjectDensity multiply(final Area area)
155 {
156 return new LinearObjectDensity(this.si() * area.si(), LinearObjectDensity.Unit.SI);
157 }
158
159 /**
160 * Multiplies this volumetric object density by a length to yield an areal object density.
161 * <p>
162 * Formula: (1/m³) x m = 1/m².
163 * @param length the length multiplier; must not be {@code null}.
164 * @return the resulting areal object density in SI (1/m²).
165 * @throws NullPointerException if {@code length} is {@code null}.
166 */
167 public final ArealObjectDensity multiply(final Length length)
168 {
169 return new ArealObjectDensity(this.si() * length.si(), ArealObjectDensity.Unit.SI);
170 }
171
172 /**
173 * Divides this volumetric object density by a linear object density to yield an areal object density.
174 * <p>
175 * Formula: (1/m³) / (1/m) = 1/m².
176 * @param lod the linear object density divisor; must not be {@code null}.
177 * @return the resulting areal object density in SI (1/m²).
178 * @throws NullPointerException if {@code lod} is {@code null}.
179 */
180 public final ArealObjectDensity divide(final LinearObjectDensity lod)
181 {
182 return new ArealObjectDensity(this.si() / lod.si(), ArealObjectDensity.Unit.SI);
183 }
184
185 /**
186 * Divides this volumetric object density by an areal object density to yield a linear object density.
187 * <p>
188 * Formula: (1/m³) / (1/m²) = 1/m.
189 * @param aod the areal object density divisor; must not be {@code null}.
190 * @return the resulting linear object density in SI (1/m).
191 * @throws NullPointerException if {@code aod} is {@code null}.
192 */
193 public final LinearObjectDensity divide(final ArealObjectDensity aod)
194 {
195 return new LinearObjectDensity(this.si() / aod.si(), LinearObjectDensity.Unit.SI);
196 }
197
198 /**
199 * Divides this volumetric object density by another volumetric object density to yield a dimensionless ratio.
200 * <p>
201 * Formula: (1/m³) / (1/m³) = 1.
202 * @param other the volumetric object density divisor; must not be {@code null}.
203 * @return the resulting dimensionless ratio in SI (1).
204 * @throws NullPointerException if {@code other} is {@code null}.
205 */
206 public final Dimensionless divide(final VolumetricObjectDensity other)
207 {
208 return new Dimensionless(this.si() / other.si(), Unitless.BASE);
209 }
210
211 @Override
212 public Volume reciprocal()
213 {
214 return Volume.ofSi(1.0 / this.si());
215 }
216
217 /******************************************************************************************************/
218 /********************************************** UNIT CLASS ********************************************/
219 /******************************************************************************************************/
220
221 /**
222 * VolumetricObjectDensity.Unit encodes the unit for number of objects per unit of volume.
223 * <p>
224 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
225 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
226 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
227 * @author Alexander Verbraeck
228 */
229 @SuppressWarnings("checkstyle:constantname")
230 public static class Unit extends AbstractUnit<VolumetricObjectDensity.Unit, VolumetricObjectDensity>
231 {
232 /** The dimensions of the number of objects per unit of volume: per cubic meter (/m3). */
233 public static final SIUnit SI_UNIT = SIUnit.of("/m3");
234
235 /** per cubic meter. */
236 public static final VolumetricObjectDensity.Unit per_m3 =
237 new VolumetricObjectDensity.Unit("/m3", "per cubic meter", 1.0, UnitSystem.SI_DERIVED);
238
239 /** The SI or BASE unit. */
240 public static final VolumetricObjectDensity.Unit SI = per_m3;
241
242 /**
243 * Create a new VolumetricObjectDensity unit.
244 * @param id the id or main abbreviation of the unit
245 * @param name the full name of the unit
246 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
247 * @param unitSystem the unit system such as SI or IMPERIAL
248 */
249 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
250 {
251 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
252 }
253
254 /**
255 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
256 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
257 * @param displayAbbreviation the display abbreviation of the unit
258 * @param name the full name of the unit
259 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
260 * @param unitSystem unit system, e.g. SI or Imperial
261 */
262 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
263 final UnitSystem unitSystem)
264 {
265 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
266 }
267
268 @Override
269 public SIUnit siUnit()
270 {
271 return SI_UNIT;
272 }
273
274 @Override
275 public Unit getBaseUnit()
276 {
277 return SI;
278 }
279
280 @Override
281 public VolumetricObjectDensity ofSi(final double si)
282 {
283 return VolumetricObjectDensity.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 VolumetricObjectDensity.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 }