Package org.djunits.quantity

Class AmountOfSubstance

java.lang.Object

java.lang.Number

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

org.djunits.quantity.AmountOfSubstance

All Implemented Interfaces:

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

public class AmountOfSubstance
extends Quantity<AmountOfSubstance>

Amount of substance is the quantity representing the number of entities, measured in moles (mol).

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	AmountOfSubstance.Unit	AmountOfSubstance.Unit encodes the units of amount of substance (base unit is mol).

Field Summary

Fields

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

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

si

Constructor Summary

Constructors

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

Method Summary

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

Constant with value zero.

ONE

public static final AmountOfSubstance ONE

Constant with value one.

NaN

public static final AmountOfSubstance NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final AmountOfSubstance POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final AmountOfSubstance NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final AmountOfSubstance POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final AmountOfSubstance NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

AmountOfSubstance

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

Instantiate a AmountOfSubstance 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

AmountOfSubstance

public AmountOfSubstance(double valueInUnit,
 AmountOfSubstance.Unit unit)

Instantiate a AmountOfSubstance 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 AmountOfSubstance ofSi(double si)

Return a AmountOfSubstance instance based on an SI value.

Parameters:

si - the si value

Returns:

the AmountOfSubstance instance based on an SI value

ofSi

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

Instantiate a AmountOfSubstance 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 AmountOfSubstance instance based on an SI value with the given display unit

instantiateSi

public AmountOfSubstance instantiateSi(double siValue,
 UnitInterface<AmountOfSubstance> 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<AmountOfSubstance>

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 AmountOfSubstance valueOf(String text)

Returns a AmountOfSubstance 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 AmountOfSubstance

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 AmountOfSubstance of(double valueInUnit,
 AmountOfSubstance.Unit unit)

Returns a AmountOfSubstance 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 AmountOfSubstance representation of the value in its unit

of

public static AmountOfSubstance of(double valueInUnit,
 String unitString)

Returns a AmountOfSubstance 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 AmountOfSubstance.Unit getDisplayUnit()

Description copied from interface: Value

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<AmountOfSubstance>

Overrides:

getDisplayUnit in class Quantity<AmountOfSubstance>

Returns:

the unit of this Value

divide

public Dimensionless divide(AmountOfSubstance v)

Calculate the division of AmountOfSubstance and AmountOfSubstance, which results in a Dimensionless scalar.

Parameters:

v - scalar

Returns:

scalar as a division of AmountOfSubstance and AmountOfSubstance

divide

public Duration divide(CatalyticActivity v)

Calculate the division of AmountOfSubstance and CatalyticActivity, which results in a Duration scalar.

Parameters:

v - scalar

Returns:

scalar as a division of AmountOfSubstance and CatalyticActivity

divide

public CatalyticActivity divide(Duration v)

Calculate the division of AmountOfSubstance and Duration, which results in a CatalyticActivity scalar.

Parameters:

v - scalar

Returns:

scalar as a division of AmountOfSubstance and Duration