1 package org.djunits.quantity;
2
3 import org.djunits.quantity.def.Quantity;
4 import org.djunits.unit.AbstractUnit;
5 import org.djunits.unit.UnitInterface;
6 import org.djunits.unit.UnitRuntimeException;
7 import org.djunits.unit.Unitless;
8 import org.djunits.unit.Units;
9 import org.djunits.unit.scale.IdentityScale;
10 import org.djunits.unit.scale.LinearScale;
11 import org.djunits.unit.scale.Scale;
12 import org.djunits.unit.si.SIPrefix;
13 import org.djunits.unit.si.SIPrefixes;
14 import org.djunits.unit.si.SIUnit;
15 import org.djunits.unit.system.UnitSystem;
16
17 /**
18 * Equivalent dose is a measure of radiation exposure accounting for biological effect, expressed in sieverts (Sv).
19 * <p>
20 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
21 * for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
22 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
23 * @author Alexander Verbraeck
24 */
25 public class EquivalentDose extends Quantity<EquivalentDose>
26 {
27 /** Constant with value zero. */
28 public static final EquivalentDose ZERO = ofSi(0.0);
29
30 /** Constant with value one. */
31 public static final EquivalentDose ONE = ofSi(1.0);
32
33 /** Constant with value NaN. */
34 @SuppressWarnings("checkstyle:constantname")
35 public static final EquivalentDose NaN = ofSi(Double.NaN);
36
37 /** Constant with value POSITIVE_INFINITY. */
38 public static final EquivalentDose POSITIVE_INFINITY = ofSi(Double.POSITIVE_INFINITY);
39
40 /** Constant with value NEGATIVE_INFINITY. */
41 public static final EquivalentDose NEGATIVE_INFINITY = ofSi(Double.NEGATIVE_INFINITY);
42
43 /** Constant with value MAX_VALUE. */
44 public static final EquivalentDose POS_MAXVALUE = ofSi(Double.MAX_VALUE);
45
46 /** Constant with value -MAX_VALUE. */
47 public static final EquivalentDose NEG_MAXVALUE = ofSi(-Double.MAX_VALUE);
48
49 /** */
50 private static final long serialVersionUID = 600L;
51
52 /**
53 * Instantiate a EquivalentDose quantity with an SI or base value and a display unit.
54 * @param value the quantity value expressed in the SI or base unit
55 * @param displayUnit the display unit to use
56 * @param useSi use SI value when true, use value in unit when false
57 */
58 public EquivalentDose(final double value, final EquivalentDose.Unit displayUnit, final boolean useSi)
59 {
60 super(value, displayUnit, useSi);
61 }
62
63 /**
64 * Instantiate a EquivalentDose quantity expressed in the given unit.
65 * @param valueInUnit the quantity value expressed in the given unit
66 * @param unit the unit of the value, also acts as the display unit
67 */
68 public EquivalentDose(final double valueInUnit, final EquivalentDose.Unit unit)
69 {
70 this(valueInUnit, unit, false);
71 }
72
73 /**
74 * Return a EquivalentDose instance based on an SI value.
75 * @param si the si value
76 * @return the EquivalentDose instance based on an SI value
77 */
78 public static EquivalentDose ofSi(final double si)
79 {
80 return new EquivalentDose(si, EquivalentDose.Unit.SI, true);
81 }
82
83 /**
84 * Instantiate a EquivalentDose quantity with an SI or base value and a display unit.
85 * @param siValue the quantity value expressed in the SI or base unit
86 * @param displayUnit the display unit to use
87 * @return the EquivalentDose instance based on an SI value with the given display unit
88 */
89 public static EquivalentDose ofSi(final double siValue, final EquivalentDose.Unit displayUnit)
90 {
91 return new EquivalentDose(siValue, displayUnit, true);
92 }
93
94 @Override
95 public EquivalentDose instantiateSi(final double siValue, final UnitInterface<EquivalentDose> displayUnit)
96 {
97 return new EquivalentDose(siValue, (EquivalentDose.Unit) displayUnit, true);
98 }
99
100 /**
101 * Returns a EquivalentDose 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 EquivalentDose
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 EquivalentDose valueOf(final String text)
110 {
111 return Quantity.valueOf(text, ZERO);
112 }
113
114 /**
115 * Returns a EquivalentDose based on a value expressed in the unit.
116 * @param valueInUnit the value, expressed in the given unit
117 * @param unit the unit of the value, also acts as the display unit
118 * @return ab EquivalentDose representation of the value in its unit
119 */
120 public static EquivalentDose of(final double valueInUnit, final EquivalentDose.Unit unit)
121 {
122 return new EquivalentDose(valueInUnit, unit);
123 }
124
125 /**
126 * Returns a EquivalentDose based on a value and the textual representation of the unit, which can be localized.
127 * @param valueInUnit the value, expressed in the unit as given by unitString
128 * @param unitString the textual representation of the unit
129 * @return the Scalar representation of the value in its unit
130 * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
131 * @throws NullPointerException when the unitString argument is null
132 */
133 public static EquivalentDose of(final double valueInUnit, final String unitString)
134 {
135 return Quantity.of(valueInUnit, unitString, ZERO);
136 }
137
138 @Override
139 public EquivalentDose.Unit getDisplayUnit()
140 {
141 return (EquivalentDose.Unit) super.getDisplayUnit();
142 }
143
144 /**
145 * Calculate the division of EquivalentDose and EquivalentDose, which results in a Dimensionless quantity.
146 * @param v quantity
147 * @return quantity as a division of EquivalentDose and EquivalentDose
148 */
149 public Dimensionless divide(final EquivalentDose v)
150 {
151 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
152 }
153
154 /******************************************************************************************************/
155 /********************************************** UNIT CLASS ********************************************/
156 /******************************************************************************************************/
157
158 /**
159 * EquivalentDose.Unit encodes the unit of radiation exposure.
160 * <p>
161 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
162 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
163 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
164 * @author Alexander Verbraeck
165 */
166 @SuppressWarnings("checkstyle:constantname")
167 public static class Unit extends AbstractUnit<EquivalentDose>
168 {
169 /** The dimensions of the equivalent dose: m2/s2. */
170 public static final SIUnit SI_UNIT = SIUnit.of("m2/s2");
171
172 /** Sievert. */
173 public static final EquivalentDose.Unit Sv = new EquivalentDose.Unit("Sv", "Sv", "sievert", IdentityScale.SCALE,
174 UnitSystem.SI_DERIVED, SIPrefixes.getSiPrefix(""));
175
176 /** The SI or BASE unit. */
177 public static final EquivalentDose.Unit SI = (Unit) Sv.generateSiPrefixes(false, false);
178
179 /** mSv. */
180 public static final EquivalentDose.Unit mSv = Units.resolve(EquivalentDose.Unit.class, "mSv");
181
182 /** µSv. */
183 public static final EquivalentDose.Unit muSv = Units.resolve(EquivalentDose.Unit.class, "muSv");
184
185 /** rem. (stands for röntgen equivalent man). */
186 public static final EquivalentDose.Unit rem = Sv.deriveUnit("rem", "rem", "rem", 0.01, UnitSystem.CGS, null);
187
188 /**
189 * Create a new EquivalentDose unit.
190 * @param id the id or main abbreviation of the unit
191 * @param name the full name of the unit
192 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
193 * @param unitSystem the unit system such as SI or IMPERIAL
194 */
195 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
196 {
197 super(id, name, scaleFactorToBaseUnit, unitSystem);
198 }
199
200 /**
201 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
202 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
203 * @param displayAbbreviation the display abbreviation of the unit
204 * @param name the full name of the unit
205 * @param scale the scale to use to convert from this unit to the standard (e.g., SI, BASE) unit
206 * @param unitSystem unit system, e.g. SI or Imperial
207 * @param siPrefix the SI Prefix of this unit
208 */
209 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
210 final UnitSystem unitSystem, final SIPrefix siPrefix)
211 {
212 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem, siPrefix);
213 }
214
215 @Override
216 public SIUnit siUnit()
217 {
218 return SI_UNIT;
219 }
220
221 @Override
222 public Unit getBaseUnit()
223 {
224 return SI;
225 }
226
227 @Override
228 public EquivalentDose ofSi(final double si, final UnitInterface<EquivalentDose> displayUnit)
229 {
230 return new EquivalentDose(si, (Unit) displayUnit, true);
231 }
232
233 @Override
234 public EquivalentDose.Unit deriveUnit(final String abbreviation, final String name, final double scaleFactor,
235 final UnitSystem unitSystem)
236 {
237 return (Unit) super.deriveUnit(abbreviation, name, scaleFactor, unitSystem);
238 }
239
240 @Override
241 public EquivalentDose.Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation,
242 final String name, final double scaleFactor, final UnitSystem unitSystem, final SIPrefix siPrefix)
243 {
244 if (getScale() instanceof LinearScale ls)
245 {
246 return new EquivalentDose.Unit(textualAbbreviation, displayAbbreviation, name,
247 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem, siPrefix);
248 }
249 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
250 }
251
252 }
253
254 }