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