Package org.djunits.quantity

Class FlowVolume

java.lang.Object

java.lang.Number

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

org.djunits.quantity.FlowVolume

All Implemented Interfaces:

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

public class FlowVolume
extends Quantity<FlowVolume>

Flow volume is the rate of volume passing through a surface per unit time, measured in cubic meters per second (m3/s).

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	FlowVolume.Unit	FlowVolume.Unit encodes the units of volume flow.

Field Summary

Fields

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

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

si

Constructor Summary

Constructors

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

Method Summary

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

Constant with value zero.

ONE

public static final FlowVolume ONE

Constant with value one.

NaN

public static final FlowVolume NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FlowVolume POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FlowVolume NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FlowVolume POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FlowVolume NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FlowVolume

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

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

FlowVolume

public FlowVolume(double valueInUnit,
 FlowVolume.Unit unit)

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

Return a FlowVolume instance based on an SI value.

Parameters:

si - the si value

Returns:

the FlowVolume instance based on an SI value

ofSi

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

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

instantiateSi

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

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

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

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

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

of

public static FlowVolume of(double valueInUnit,
 String unitString)

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

Description copied from interface: Value

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<FlowVolume>

Overrides:

getDisplayUnit in class Quantity<FlowVolume>

Returns:

the unit of this Value

divide

public Dimensionless divide(FlowVolume v)

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

Parameters:

v - quantity

Returns:

quantity as a division of FlowVolume and FlowVolume

multiply

public Volume multiply(Duration v)

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

Parameters:

v - scalar

Returns:

scalar as a multiplication of FlowVolume and Duration

divide

public Volume divide(Frequency v)

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

Parameters:

v - scalar

Returns:

scalar as a division of FlowVolume and Frequency

divide

public Frequency divide(Volume v)

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

Parameters:

v - scalar

Returns:

scalar as a division of FlowVolume and Volume

divide

public Speed divide(Area v)

Calculate the division of FlowVolume and Area, which results in a Speed scalar.

Parameters:

v - scalar

Returns:

scalar as a division of FlowVolume and Area

divide

public Area divide(Speed v)

Calculate the division of FlowVolume and Speed, which results in a Area scalar.

Parameters:

v - scalar

Returns:

scalar as a division of FlowVolume and Speed

multiply

public FlowMass multiply(Density v)

Calculate the multiplication of FlowVolume and Density, which results in a FlowMass scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of FlowVolume and Density