Package org.djunits.quantity

Class Volume

java.lang.Object

java.lang.Number

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

org.djunits.quantity.Volume

All Implemented Interfaces:

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

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

Volume is the amount of three-dimensional space occupied by matter, measured in cubic meters (m3).

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	Volume.Unit	Volume.Unit encodes the volume unit (length x length x length).

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Length	divide(Area v)	Calculate the division of Volume and Area, which results in a Length scalar.
final FlowVolume	divide(Duration v)	Calculate the division of Volume and Duration, which results in a FlowVolume scalar.
final Duration	divide(FlowVolume v)	Calculate the division of Volume and FlowVolume, which results in a Duration scalar.
final Area	divide(Length v)	Calculate the division of Volume and Length, which results in a Area scalar.
final Dimensionless	divide(Volume v)	Calculate the division of Volume and Volume, which results in a Dimensionless scalar.
Volume	instantiate(double si)	Instantiate a quantity with an SI or base value.
final Mass	multiply(Density v)	Calculate the multiplication of Volume and Density, which results in a Mass scalar.
final Area	multiply(LinearObjectDensity v)	Calculate the multiplication of Volume and LinearObjectDensity, which results in a Area scalar.
final Energy	multiply(Pressure v)	Calculate the multiplication of Volume and Pressure, which results in a Energy scalar.
static Volume	of(double value, String unitString)	Returns a Volume based on a value and the textual representation of the unit, which can be localized.
static Volume	ofSi(double si)	Return a Volume instance based on an SI value.
VolumetricObjectDensity	reciprocal()	Return the reciprocal of this quantity (1/q).
SIUnit	siUnit()	Return the SI unit of this quantity.
static Volume	valueOf(String text)	Returns a Volume 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, 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 Volume ZERO

Constant with value zero.

ONE

public static final Volume ONE

Constant with value one.

NaN

public static final Volume NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final Volume POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Volume NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Volume POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Volume NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

Volume

public Volume(double value,
 Volume.Unit unit)

Instantiate a Volume quantity with a unit.

Parameters:

value - the value, expressed in the unit

unit - the unit in which the value is expressed

Volume

public Volume(double value,
 String abbreviation)

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

Volume

public Volume(Volume value)

Construct Volume quantity.

Parameters:

value - Scalar from which to construct this instance

Method Details

ofSi

public static Volume ofSi(double si)

Return a Volume instance based on an SI value.

Parameters:

si - the si value

Returns:

the Volume instance based on an SI value

instantiate

public Volume instantiate(double si)

Description copied from class: Quantity

Instantiate a quantity with an SI or base value.

Specified by:

instantiate in class Quantity<Volume,Volume.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<Volume,Volume.Unit>

Returns:

the SI unit of this quantity

valueOf

public static Volume valueOf(String text)

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

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 Volume of(double value,
 String unitString)

Returns a Volume 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(Volume v)

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

Parameters:

v - scalar

Returns:

scalar as a division of Volume and Volume

multiply

public final Mass multiply(Density v)

Calculate the multiplication of Volume and Density, which results in a Mass scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of Volume and Density

multiply

public final Energy multiply(Pressure v)

Calculate the multiplication of Volume and Pressure, which results in a Energy scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of Volume and Pressure

divide

public final Area divide(Length v)

Calculate the division of Volume and Length, which results in a Area scalar.

Parameters:

v - scalar

Returns:

scalar as a division of Volume and Length

divide

public final Length divide(Area v)

Calculate the division of Volume and Area, which results in a Length scalar.

Parameters:

v - scalar

Returns:

scalar as a division of Volume and Area

multiply

public final Area multiply(LinearObjectDensity v)

Calculate the multiplication of Volume and LinearObjectDensity, which results in a Area scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of Volume and LinearObjectDensity

divide

public final FlowVolume divide(Duration v)

Calculate the division of Volume and Duration, which results in a FlowVolume scalar.

Parameters:

v - scalar

Returns:

scalar as a division of Volume and Duration

divide

public final Duration divide(FlowVolume v)

Calculate the division of Volume and FlowVolume, which results in a Duration scalar.

Parameters:

v - scalar

Returns:

scalar as a division of Volume and FlowVolume

reciprocal

public VolumetricObjectDensity reciprocal()

Description copied from class: Quantity

Return the reciprocal of this quantity (1/q).

Overrides:

reciprocal in class Quantity<Volume,Volume.Unit>

Returns:

the reciprocal of this quantity, with the correct SI units