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