Package org.djunits.quantity

Class AbsorbedDose

java.lang.Object

java.lang.Number

org.djunits.quantity.def.Quantity<AbsorbedDose>

org.djunits.quantity.AbsorbedDose

All Implemented Interfaces:

Serializable, Comparable<AbsorbedDose>, Additive<AbsorbedDose>, Scalable<AbsorbedDose>, Value<AbsorbedDose>

public class AbsorbedDose
extends Quantity<AbsorbedDose>

Absorbed dose is the energy deposited by ionizing radiation per unit mass, measured in grays (Gy).

Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djunits.org. The DJUNITS project is distributed under a three-clause BSD-style license.

Author:

Alexander Verbraeck

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbsorbedDose.Unit	AbsorbedDose.Unit encodes the units of absorbed dose (of ionizing radiation).

Field Summary

Fields

Modifier and Type	Field	Description
static final AbsorbedDose	NaN	Constant with value NaN.
static final AbsorbedDose	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final AbsorbedDose	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final AbsorbedDose	ONE	Constant with value one.
static final AbsorbedDose	POS_MAXVALUE	Constant with value MAX_VALUE.
static final AbsorbedDose	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final AbsorbedDose	ZERO	Constant with value zero.

Fields inherited from class org.djunits.quantity.def.Quantity

si

Constructor Summary

Constructors

Constructor	Description
AbsorbedDose(double valueInUnit, AbsorbedDose.Unit unit)	Instantiate a AbsorbedDose quantity expressed in the given unit.
AbsorbedDose(double value, AbsorbedDose.Unit displayUnit, boolean useSi)	Instantiate a AbsorbedDose quantity with an SI or base value and a display unit.

Method Summary

Modifier and Type	Method	Description
Dimensionless	divide(AbsorbedDose v)	Calculate the division of AbsorbedDose and AbsorbedDose, which results in a Dimensionless quantity.
AbsorbedDose.Unit	getDisplayUnit()	Retrieve the unit of this Value.
AbsorbedDose	instantiateSi(double siValue, UnitInterface<AbsorbedDose> displayUnit)	Instantiate a quantity with an SI or base value, and a display unit.
static AbsorbedDose	of(double valueInUnit, String unitString)	Returns a AbsorbedDose based on a value and the textual representation of the unit, which can be localized.
static AbsorbedDose	of(double valueInUnit, AbsorbedDose.Unit unit)	Returns a AbsorbedDose based on a value expressed in the unit.
static AbsorbedDose	ofSi(double si)	Return a AbsorbedDose instance based on an SI value.
static AbsorbedDose	ofSi(double siValue, AbsorbedDose.Unit displayUnit)	Instantiate a AbsorbedDose quantity with an SI or base value and a display unit.
static AbsorbedDose	valueOf(String text)	Returns a AbsorbedDose representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.quantity.def.Quantity

abs, add, as, compareTo, divide, doubleValue, eq, eq0, equals, floatValue, format, format, format, ge, ge0, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, instantiateSi, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, reciprocal, scaleBy, si, siUnit, subtract, sum, toString, valueOf

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.Scalable

divideBy

Methods inherited from interface org.djunits.value.Value

isAbsolute

Field Details

ZERO

public static final AbsorbedDose ZERO

Constant with value zero.

ONE

public static final AbsorbedDose ONE

Constant with value one.

NaN

public static final AbsorbedDose NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final AbsorbedDose POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final AbsorbedDose NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final AbsorbedDose POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final AbsorbedDose NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

AbsorbedDose

public AbsorbedDose(double value,
 AbsorbedDose.Unit displayUnit,
 boolean useSi)

Instantiate a AbsorbedDose quantity with an SI or base value and a display unit.

Parameters:

value - the quantity value expressed in the SI or base unit

displayUnit - the display unit to use

useSi - use SI value when true, use value in unit when false

AbsorbedDose

public AbsorbedDose(double valueInUnit,
 AbsorbedDose.Unit unit)

Instantiate a AbsorbedDose quantity expressed in the given unit.

Parameters:

valueInUnit - the quantity value expressed in the given unit

unit - the unit of the value, also acts as the display unit

Method Details

ofSi

public static AbsorbedDose ofSi(double si)

Return a AbsorbedDose instance based on an SI value.

Parameters:

si - the si value

Returns:

the AbsorbedDose instance based on an SI value

ofSi

public static AbsorbedDose ofSi(double siValue,
 AbsorbedDose.Unit displayUnit)

Instantiate a AbsorbedDose quantity with an SI or base value and a display unit.

Parameters:

siValue - the quantity value expressed in the SI or base unit

displayUnit - the display unit to use

Returns:

the AbsorbedDose instance based on an SI value with the given display unit

instantiateSi

public AbsorbedDose instantiateSi(double siValue,
 UnitInterface<AbsorbedDose> displayUnit)

Description copied from class: Quantity

Instantiate a quantity with an SI or base value, and a display unit.

Specified by:

instantiateSi in class Quantity<AbsorbedDose>

Parameters:

siValue - the value expressed in the base (SI) unit

displayUnit - the display unit to use for the quantity

Returns:

a quantity with the given SI or base value, and the given display unit

valueOf

public static AbsorbedDose valueOf(String text)

Returns a AbsorbedDose representation of a textual representation of a value with a unit. The String representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.

Parameters:

text - the textual representation to parse into a AbsorbedDose

Returns:

the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static AbsorbedDose of(double valueInUnit,
 AbsorbedDose.Unit unit)

Returns a AbsorbedDose based on a value expressed in the unit.

Parameters:

valueInUnit - the value, expressed in the given unit

unit - the unit of the value, also acts as the display unit

Returns:

ab AbsorbedDose representation of the value in its unit

of

public static AbsorbedDose of(double valueInUnit,
 String unitString)

Returns a AbsorbedDose based on a value and the textual representation of the unit, which can be localized.

Parameters:

valueInUnit - the value, expressed in the unit as given by unitString

unitString - the textual representation of the unit

Returns:

the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the unit cannot be parsed or is incorrect

NullPointerException - when the unitString argument is null

getDisplayUnit

public AbsorbedDose.Unit getDisplayUnit()

Description copied from interface: Value

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<AbsorbedDose>

Overrides:

getDisplayUnit in class Quantity<AbsorbedDose>

Returns:

the unit of this Value

divide

public Dimensionless divide(AbsorbedDose v)

Calculate the division of AbsorbedDose and AbsorbedDose, which results in a Dimensionless quantity.

Parameters:

v - quantity

Returns:

quantity as a division of AbsorbedDose and AbsorbedDose