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 = ofSi(0.0);
25
26 /** Constant with value one. */
27 public static final EquivalentDose ONE = ofSi(1.0);
28
29 /** Constant with value NaN. */
30 @SuppressWarnings("checkstyle:constantname")
31 public static final EquivalentDose NaN = ofSi(Double.NaN);
32
33 /** Constant with value POSITIVE_INFINITY. */
34 public static final EquivalentDose POSITIVE_INFINITY = ofSi(Double.POSITIVE_INFINITY);
35
36 /** Constant with value NEGATIVE_INFINITY. */
37 public static final EquivalentDose NEGATIVE_INFINITY = ofSi(Double.NEGATIVE_INFINITY);
38
39 /** Constant with value MAX_VALUE. */
40 public static final EquivalentDose POS_MAXVALUE = ofSi(Double.MAX_VALUE);
41
42 /** Constant with value -MAX_VALUE. */
43 public static final EquivalentDose NEG_MAXVALUE = 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 * Return a EquivalentDose instance based on an SI value.
60 * @param si the si value
61 * @return the EquivalentDose instance based on an SI value
62 */
63 public static EquivalentDose ofSi(final double si)
64 {
65 return new EquivalentDose(si, EquivalentDose.Unit.SI);
66 }
67
68 @Override
69 public EquivalentDose instantiateSi(final double si)
70 {
71 return ofSi(si);
72 }
73
74 @Override
75 public SIUnit siUnit()
76 {
77 return EquivalentDose.Unit.SI_UNIT;
78 }
79
80 /**
81 * Returns a EquivalentDose representation of a textual representation of a value with a unit. The String representation
82 * that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces
83 * are allowed, but not required, between the value and the unit.
84 * @param text the textual representation to parse into a EquivalentDose
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 EquivalentDose valueOf(final String text)
90 {
91 return Quantity.valueOf(text, ZERO);
92 }
93
94 /**
95 * Returns a EquivalentDose 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 EquivalentDose of(final double valueInUnit, final String unitString)
103 {
104 return Quantity.of(valueInUnit, unitString, ZERO);
105 }
106
107 @Override
108 public EquivalentDose.Unit getDisplayUnit()
109 {
110 return (EquivalentDose.Unit) super.getDisplayUnit();
111 }
112
113 /**
114 * Calculate the division of EquivalentDose and EquivalentDose, which results in a Dimensionless quantity.
115 * @param v quantity
116 * @return quantity as a division of EquivalentDose and EquivalentDose
117 */
118 public final Dimensionless divide(final EquivalentDose v)
119 {
120 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
121 }
122
123 /******************************************************************************************************/
124 /********************************************** UNIT CLASS ********************************************/
125 /******************************************************************************************************/
126
127 /**
128 * EquivalentDose.Unit encodes the unit of radiation exposure.
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<EquivalentDose.Unit, EquivalentDose>
137 {
138 /** The dimensions of the equivalent dose: m2/s2. */
139 public static final SIUnit SI_UNIT = SIUnit.of("m2/s2");
140
141 /** Sievert. */
142 public static final EquivalentDose.Unit Sv = new EquivalentDose.Unit("Sv", "sievert", 1.0, UnitSystem.SI_DERIVED);
143
144 /** The SI or BASE unit. */
145 public static final EquivalentDose.Unit SI = Sv.generateSiPrefixes(false, false);
146
147 /** mSv. */
148 public static final EquivalentDose.Unit mSv = Units.resolve(EquivalentDose.Unit.class, "mSv");
149
150 /** µSv. */
151 public static final EquivalentDose.Unit muSv = Units.resolve(EquivalentDose.Unit.class, "muSv");
152
153 /** rem. (stands for röntgen equivalent man). */
154 public static final EquivalentDose.Unit rem = Sv.deriveUnit("rem", "rem", 0.01, UnitSystem.CGS);
155
156 /**
157 * Create a new EquivalentDose unit.
158 * @param id the id or main abbreviation of the unit
159 * @param name the full name of the unit
160 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
161 * @param unitSystem the unit system such as SI or IMPERIAL
162 */
163 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
164 {
165 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
166 }
167
168 /**
169 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
170 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
171 * @param displayAbbreviation the display abbreviation of the unit
172 * @param name the full name of the unit
173 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
174 * @param unitSystem unit system, e.g. SI or Imperial
175 */
176 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
177 final UnitSystem unitSystem)
178 {
179 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
180 }
181
182 @Override
183 public SIUnit siUnit()
184 {
185 return SI_UNIT;
186 }
187
188 @Override
189 public Unit getBaseUnit()
190 {
191 return SI;
192 }
193
194 @Override
195 public EquivalentDose ofSi(final double si)
196 {
197 return EquivalentDose.ofSi(si);
198 }
199
200 @Override
201 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
202 final double scaleFactor, final UnitSystem unitSystem)
203 {
204 if (getScale() instanceof LinearScale ls)
205 {
206 return new EquivalentDose.Unit(textualAbbreviation, displayAbbreviation, name,
207 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
208 }
209 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
210 }
211
212 }
213 }