Package org.djunits.quantity

Class Volume

java.lang.Object

java.lang.Number

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

org.djunits.quantity.Volume

All Implemented Interfaces:

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

public class Volume
extends Quantity<Volume>

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.

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

si

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Length	divide(Area v)	Calculate the division of Volume and Area, which results in a Length scalar.
FlowVolume	divide(Duration v)	Calculate the division of Volume and Duration, which results in a FlowVolume scalar.
Duration	divide(FlowVolume v)	Calculate the division of Volume and FlowVolume, which results in a Duration scalar.
Area	divide(Length v)	Calculate the division of Volume and Length, which results in a Area scalar.
Dimensionless	divide(Volume v)	Calculate the division of Volume and Volume, which results in a Dimensionless scalar.
Volume.Unit	getDisplayUnit()	Retrieve the unit of this Value.
Volume	instantiateSi(double siValue, UnitInterface<Volume> displayUnit)	Instantiate a quantity with an SI or base value, and a display unit.
Mass	multiply(Density v)	Calculate the multiplication of Volume and Density, which results in a Mass scalar.
Area	multiply(LinearObjectDensity v)	Calculate the multiplication of Volume and LinearObjectDensity, which results in a Area scalar.
Energy	multiply(Pressure v)	Calculate the multiplication of Volume and Pressure, which results in a Energy scalar.
static Volume	of(double valueInUnit, String unitString)	Returns a Volume based on a value and the textual representation of the unit, which can be localized.
static Volume	of(double valueInUnit, Volume.Unit unit)	Returns a Volume based on a value expressed in the unit.
static Volume	ofSi(double si)	Return a Volume instance based on an SI value.
static Volume	ofSi(double siValue, Volume.Unit displayUnit)	Instantiate a Volume quantity with an SI or base value and a display unit.
VolumetricObjectDensity	reciprocal()	Return the reciprocal of this quantity (1/q).
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, 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, 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 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 displayUnit,
 boolean useSi)

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

Volume

public Volume(double valueInUnit,
 Volume.Unit unit)

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

ofSi

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

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

instantiateSi

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

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 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 valueInUnit,
 Volume.Unit unit)

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

of

public static Volume of(double valueInUnit,
 String unitString)

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

Description copied from interface: Value

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<Volume>

Overrides:

getDisplayUnit in class Quantity<Volume>

Returns:

the unit of this Value

divide

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

Returns:

the reciprocal of this quantity, with the correct SI units