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 * Amount of substance is the quantity representing the number of entities, measured in moles (mol).
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 AmountOfSubstance extends Quantity<AmountOfSubstance>
22 {
23 /** Constant with value zero. */
24 public static final AmountOfSubstance ZERO = AmountOfSubstance.ofSi(0.0);
25
26 /** Constant with value one. */
27 public static final AmountOfSubstance ONE = AmountOfSubstance.ofSi(1.0);
28
29 /** Constant with value NaN. */
30 @SuppressWarnings("checkstyle:constantname")
31 public static final AmountOfSubstance NaN = AmountOfSubstance.ofSi(Double.NaN);
32
33 /** Constant with value POSITIVE_INFINITY. */
34 public static final AmountOfSubstance POSITIVE_INFINITY = AmountOfSubstance.ofSi(Double.POSITIVE_INFINITY);
35
36 /** Constant with value NEGATIVE_INFINITY. */
37 public static final AmountOfSubstance NEGATIVE_INFINITY = AmountOfSubstance.ofSi(Double.NEGATIVE_INFINITY);
38
39 /** Constant with value MAX_VALUE. */
40 public static final AmountOfSubstance POS_MAXVALUE = AmountOfSubstance.ofSi(Double.MAX_VALUE);
41
42 /** Constant with value -MAX_VALUE. */
43 public static final AmountOfSubstance NEG_MAXVALUE = AmountOfSubstance.ofSi(-Double.MAX_VALUE);
44
45 /** */
46 private static final long serialVersionUID = 600L;
47
48 /**
49 * Instantiate a AmountOfSubstance 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 AmountOfSubstance(final double valueInUnit, final AmountOfSubstance.Unit unit)
54 {
55 super(valueInUnit, unit);
56 }
57
58 /**
59 * Instantiate a AmountOfSubstance 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 AmountOfSubstance(final double valueInUnit, final String abbreviation)
64 {
65 this(valueInUnit, Units.resolve(AmountOfSubstance.Unit.class, abbreviation));
66 }
67
68 /**
69 * Construct AmountOfSubstance quantity.
70 * @param value Scalar from which to construct this instance
71 */
72 public AmountOfSubstance(final AmountOfSubstance value)
73 {
74 super(value.si(), AmountOfSubstance.Unit.SI);
75 setDisplayUnit(value.getDisplayUnit());
76 }
77
78 /**
79 * Return a AmountOfSubstance instance based on an SI value.
80 * @param si the si value
81 * @return the AmountOfSubstance instance based on an SI value
82 */
83 public static AmountOfSubstance ofSi(final double si)
84 {
85 return new AmountOfSubstance(si, AmountOfSubstance.Unit.SI);
86 }
87
88 @Override
89 public AmountOfSubstance instantiateSi(final double si)
90 {
91 return ofSi(si);
92 }
93
94 @Override
95 public SIUnit siUnit()
96 {
97 return AmountOfSubstance.Unit.SI_UNIT;
98 }
99
100 /**
101 * Returns a AmountOfSubstance representation of a textual representation of a value with a unit. The String representation
102 * that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces
103 * are allowed, but not required, between the value and the unit.
104 * @param text the textual representation to parse into a AmountOfSubstance
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 AmountOfSubstance valueOf(final String text)
110 {
111 return Quantity.valueOf(text, ZERO);
112 }
113
114 /**
115 * Returns a AmountOfSubstance 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 AmountOfSubstance of(final double valueInUnit, final String unitString)
123 {
124 return Quantity.of(valueInUnit, unitString, ZERO);
125 }
126
127 @Override
128 public AmountOfSubstance.Unit getDisplayUnit()
129 {
130 return (AmountOfSubstance.Unit) super.getDisplayUnit();
131 }
132
133 /**
134 * Calculate the division of AmountOfSubstance and AmountOfSubstance, which results in a Dimensionless scalar.
135 * @param v scalar
136 * @return scalar as a division of AmountOfSubstance and AmountOfSubstance
137 */
138 public final Dimensionless divide(final AmountOfSubstance v)
139 {
140 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
141 }
142
143 /**
144 * Calculate the division of AmountOfSubstance and CatalyticActivity, which results in a Duration scalar.
145 * @param v scalar
146 * @return scalar as a division of AmountOfSubstance and CatalyticActivity
147 */
148 public final Duration divide(final CatalyticActivity v)
149 {
150 return new Duration(this.si() / v.si(), Duration.Unit.SI);
151 }
152
153 /**
154 * Calculate the division of AmountOfSubstance and Duration, which results in a CatalyticActivity scalar.
155 * @param v scalar
156 * @return scalar as a division of AmountOfSubstance and Duration
157 */
158 public final CatalyticActivity divide(final Duration v)
159 {
160 return new CatalyticActivity(this.si() / v.si(), CatalyticActivity.Unit.SI);
161 }
162
163 /******************************************************************************************************/
164 /********************************************** UNIT CLASS ********************************************/
165 /******************************************************************************************************/
166
167 /**
168 * AmountOfSubstance.Unit encodes the units of amount of substance (base unit is mol).
169 * <p>
170 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
171 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
172 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
173 * @author Alexander Verbraeck
174 */
175 @SuppressWarnings("checkstyle:constantname")
176 public static class Unit extends AbstractUnit<AmountOfSubstance.Unit, AmountOfSubstance>
177 {
178 /** The dimensions of AmountOfSubstance: mol. */
179 public static final SIUnit SI_UNIT = SIUnit.of("mol");
180
181 /** Mole. */
182 public static final AmountOfSubstance.Unit mol = new AmountOfSubstance.Unit("mol", "mole", 1.0, UnitSystem.SI_BASE);
183
184 /** The SI or BASE unit. */
185 public static final AmountOfSubstance.Unit SI = mol.generateSiPrefixes(false, false);
186
187 /** mmol. */
188 public static final AmountOfSubstance.Unit mmol = Units.resolve(AmountOfSubstance.Unit.class, "mmol");
189
190 /** µmol. */
191 public static final AmountOfSubstance.Unit mumol = Units.resolve(AmountOfSubstance.Unit.class, "mumol");
192
193 /** nmol. */
194 public static final AmountOfSubstance.Unit nmol = Units.resolve(AmountOfSubstance.Unit.class, "nmol");
195
196 /**
197 * Create a new AmountOfSubstance unit.
198 * @param id the id or main abbreviation of the unit
199 * @param name the full name of the unit
200 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
201 * @param unitSystem the unit system such as SI or IMPERIAL
202 */
203 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
204 {
205 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
206 }
207
208 /**
209 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
210 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
211 * @param displayAbbreviation the display abbreviation of the unit
212 * @param name the full name of the unit
213 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
214 * @param unitSystem unit system, e.g. SI or Imperial
215 */
216 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
217 final UnitSystem unitSystem)
218 {
219 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
220 }
221
222 @Override
223 public SIUnit siUnit()
224 {
225 return SI_UNIT;
226 }
227
228 @Override
229 public Unit getBaseUnit()
230 {
231 return SI;
232 }
233
234 @Override
235 public AmountOfSubstance ofSi(final double si)
236 {
237 return AmountOfSubstance.ofSi(si);
238 }
239
240 @Override
241 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
242 final double scaleFactor, final UnitSystem unitSystem)
243 {
244 if (getScale() instanceof LinearScale ls)
245 {
246 return new AmountOfSubstance.Unit(textualAbbreviation, displayAbbreviation, name,
247 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
248 }
249 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
250 }
251
252 }
253 }