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