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 * Equivalent dose is a measure of radiation exposure accounting for biological effect, expressed in sieverts (Sv).
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 EquivalentDose extends Quantity<EquivalentDose>
22 {
23 /** Constant with value zero. */
24 public static final EquivalentDose ZERO = EquivalentDose.ofSi(0.0);
25
26 /** Constant with value one. */
27 public static final EquivalentDose ONE = EquivalentDose.ofSi(1.0);
28
29 /** Constant with value NaN. */
30 @SuppressWarnings("checkstyle:constantname")
31 public static final EquivalentDose NaN = EquivalentDose.ofSi(Double.NaN);
32
33 /** Constant with value POSITIVE_INFINITY. */
34 public static final EquivalentDose POSITIVE_INFINITY = EquivalentDose.ofSi(Double.POSITIVE_INFINITY);
35
36 /** Constant with value NEGATIVE_INFINITY. */
37 public static final EquivalentDose NEGATIVE_INFINITY = EquivalentDose.ofSi(Double.NEGATIVE_INFINITY);
38
39 /** Constant with value MAX_VALUE. */
40 public static final EquivalentDose POS_MAXVALUE = EquivalentDose.ofSi(Double.MAX_VALUE);
41
42 /** Constant with value -MAX_VALUE. */
43 public static final EquivalentDose NEG_MAXVALUE = EquivalentDose.ofSi(-Double.MAX_VALUE);
44
45 /** */
46 private static final long serialVersionUID = 600L;
47
48 /**
49 * Instantiate a EquivalentDose 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 EquivalentDose(final double valueInUnit, final EquivalentDose.Unit unit)
54 {
55 super(valueInUnit, unit);
56 }
57
58 /**
59 * Instantiate a EquivalentDose 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 EquivalentDose(final double valueInUnit, final String abbreviation)
64 {
65 this(valueInUnit, Units.resolve(EquivalentDose.Unit.class, abbreviation));
66 }
67
68 /**
69 * Construct EquivalentDose quantity.
70 * @param value Scalar from which to construct this instance
71 */
72 public EquivalentDose(final EquivalentDose value)
73 {
74 super(value.si(), EquivalentDose.Unit.SI);
75 setDisplayUnit(value.getDisplayUnit());
76 }
77
78 /**
79 * Return a EquivalentDose instance based on an SI value.
80 * @param si the si value
81 * @return the EquivalentDose instance based on an SI value
82 */
83 public static EquivalentDose ofSi(final double si)
84 {
85 return new EquivalentDose(si, EquivalentDose.Unit.SI);
86 }
87
88 @Override
89 public EquivalentDose instantiateSi(final double si)
90 {
91 return ofSi(si);
92 }
93
94 @Override
95 public SIUnit siUnit()
96 {
97 return EquivalentDose.Unit.SI_UNIT;
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 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 EquivalentDose of(final double valueInUnit, final String unitString)
123 {
124 return Quantity.of(valueInUnit, unitString, ZERO);
125 }
126
127 @Override
128 public EquivalentDose.Unit getDisplayUnit()
129 {
130 return (EquivalentDose.Unit) super.getDisplayUnit();
131 }
132
133 /**
134 * Calculate the division of EquivalentDose and EquivalentDose, which results in a Dimensionless quantity.
135 * @param v quantity
136 * @return quantity as a division of EquivalentDose and EquivalentDose
137 */
138 public final Dimensionless divide(final EquivalentDose v)
139 {
140 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
141 }
142
143 /******************************************************************************************************/
144 /********************************************** UNIT CLASS ********************************************/
145 /******************************************************************************************************/
146
147 /**
148 * EquivalentDose.Unit encodes the unit of radiation exposure.
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<EquivalentDose.Unit, EquivalentDose>
157 {
158 /** The dimensions of the equivalent dose: m2/s2. */
159 public static final SIUnit SI_UNIT = SIUnit.of("m2/s2");
160
161 /** Sievert. */
162 public static final EquivalentDose.Unit Sv = new EquivalentDose.Unit("Sv", "sievert", 1.0, UnitSystem.SI_DERIVED);
163
164 /** The SI or BASE unit. */
165 public static final EquivalentDose.Unit SI = Sv.generateSiPrefixes(false, false);
166
167 /** mSv. */
168 public static final EquivalentDose.Unit mSv = Units.resolve(EquivalentDose.Unit.class, "mSv");
169
170 /** µSv. */
171 public static final EquivalentDose.Unit muSv = Units.resolve(EquivalentDose.Unit.class, "muSv");
172
173 /** rem. (stands for röntgen equivalent man). */
174 public static final EquivalentDose.Unit rem = Sv.deriveUnit("rem", "rem", 0.01, UnitSystem.CGS);
175
176 /**
177 * Create a new EquivalentDose unit.
178 * @param id the id or main abbreviation of the unit
179 * @param name the full name of the unit
180 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
181 * @param unitSystem the unit system such as SI or IMPERIAL
182 */
183 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
184 {
185 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
186 }
187
188 /**
189 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
190 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
191 * @param displayAbbreviation the display abbreviation of the unit
192 * @param name the full name of the unit
193 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
194 * @param unitSystem unit system, e.g. SI or Imperial
195 */
196 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
197 final UnitSystem unitSystem)
198 {
199 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
200 }
201
202 @Override
203 public SIUnit siUnit()
204 {
205 return SI_UNIT;
206 }
207
208 @Override
209 public Unit getBaseUnit()
210 {
211 return SI;
212 }
213
214 @Override
215 public EquivalentDose ofSi(final double si)
216 {
217 return EquivalentDose.ofSi(si);
218 }
219
220 @Override
221 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
222 final double scaleFactor, final UnitSystem unitSystem)
223 {
224 if (getScale() instanceof LinearScale ls)
225 {
226 return new EquivalentDose.Unit(textualAbbreviation, displayAbbreviation, name,
227 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
228 }
229 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
230 }
231
232 }
233 }