Package org.djunits.quantity

Class AmountOfSubstance

java.lang.Object

java.lang.Number

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

org.djunits.quantity.AmountOfSubstance

All Implemented Interfaces:

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

public class AmountOfSubstance
extends Quantity<AmountOfSubstance,AmountOfSubstance.Unit>

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.

Constructor Summary

Constructors

Constructor	Description
AmountOfSubstance(double value, String abbreviation)	Instantiate a AmountOfSubstance quantity with a unit, expressed as a String.
AmountOfSubstance(double value, AmountOfSubstance.Unit unit)	Instantiate a AmountOfSubstance quantity with a unit.
AmountOfSubstance(AmountOfSubstance value)	Construct AmountOfSubstance quantity.

Method Summary

Modifier and Type	Method	Description
final Dimensionless	divide(AmountOfSubstance v)	Calculate the division of AmountOfSubstance and AmountOfSubstance, which results in a Dimensionless scalar.
final Duration	divide(CatalyticActivity v)	Calculate the division of AmountOfSubstance and CatalyticActivity, which results in a Duration scalar.
final CatalyticActivity	divide(Duration v)	Calculate the division of AmountOfSubstance and Duration, which results in a CatalyticActivity scalar.
AmountOfSubstance	instantiate(double si)	Instantiate a quantity with an SI or base value.
static AmountOfSubstance	of(double value, String unitString)	Returns a AmountOfSubstance based on a value and the textual representation of the unit, which can be localized.
static AmountOfSubstance	ofSi(double si)	Return a AmountOfSubstance instance based on an SI value.
SIUnit	siUnit()	Return the SI unit of this quantity.
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, ge, ge0, getDisplayUnit, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, reciprocal, scaleBy, setDisplayUnit, si, subtract, sum, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString, 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, setDisplayUnit

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 unit)

Instantiate a AmountOfSubstance quantity with a unit.

Parameters:

value - the value, expressed in the unit

unit - the unit in which the value is expressed

AmountOfSubstance

public AmountOfSubstance(double value,
 String abbreviation)

Instantiate a AmountOfSubstance quantity with a unit, expressed as a String.

Parameters:

value - the value, expressed in the unit

abbreviation - the String abbreviation of the unit in which the value is expressed

AmountOfSubstance

public AmountOfSubstance(AmountOfSubstance value)

Construct AmountOfSubstance quantity.

Parameters:

value - Scalar from which to construct this instance

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

instantiate

public AmountOfSubstance instantiate(double si)

Description copied from class: Quantity

Instantiate a quantity with an SI or base value.

Specified by:

instantiate in class Quantity<AmountOfSubstance,AmountOfSubstance.Unit>

Parameters:

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

Returns:

a quantity with the given SI-value and base (SI) unit

siUnit

public SIUnit siUnit()

Description copied from class: Quantity

Return the SI unit of this quantity.

Overrides:

siUnit in class Quantity<AmountOfSubstance,AmountOfSubstance.Unit>

Returns:

the SI unit of this quantity

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 value,
 String unitString)

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

Parameters:

value - the value to use

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

divide

public final 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 final 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 final 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