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