Package org.djunits.quantity

Class FlowVolume.Unit

java.lang.Object

org.djunits.unit.AbstractUnit<FlowVolume>

org.djunits.quantity.FlowVolume.Unit

All Implemented Interfaces:

UnitInterface<FlowVolume>

Enclosing class:

FlowVolume

public static class FlowVolume.Unit
extends AbstractUnit<FlowVolume>

FlowVolume.Unit encodes the units of volume flow.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final FlowVolume.Unit	ft3_min	ft^3/min.
static final FlowVolume.Unit	ft3_s	ft^3/s.
static final FlowVolume.Unit	gal_US_day	gallon/day (US).
static final FlowVolume.Unit	gal_US_h	gallon/hour (US).
static final FlowVolume.Unit	gal_US_min	gallon/min (US).
static final FlowVolume.Unit	gal_US_s	gallon/s (US).
static final FlowVolume.Unit	in3_min	in^3/min.
static final FlowVolume.Unit	in3_s	in^3/s.
static final FlowVolume.Unit	L_day	L/day.
static final FlowVolume.Unit	L_h	L/hour.
static final FlowVolume.Unit	L_min	L/min.
static final FlowVolume.Unit	L_s	L/s.
static final FlowVolume.Unit	m3_day	m^3/day.
static final FlowVolume.Unit	m3_h	m^3/hour.
static final FlowVolume.Unit	m3_min	m^3/min.
static final FlowVolume.Unit	m3_s	m3/s.
static final FlowVolume.Unit	SI	The SI or BASE unit.
static final SIUnit	SI_UNIT	The dimensions of the flow volume is m3/s.

Constructor Summary

Constructors

Constructor	Description
Unit(String id, String name, double scaleFactorToBaseUnit, UnitSystem unitSystem)	Create a new FlowVolume unit.
Unit(String textualAbbreviation, String displayAbbreviation, String name, Scale scale, UnitSystem unitSystem, SIPrefix siPrefix)	Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.

Method Summary

Modifier and Type	Method	Description
FlowVolume.Unit	deriveUnit(String abbreviation, String name, double scaleFactor, UnitSystem unitSystem)	Return a linearly scaled derived unit for this unit, with an abbreviation and scale factor.
FlowVolume.Unit	deriveUnit(String textualAbbreviation, String displayAbbreviation, String name, double scaleFactor, UnitSystem unitSystem, SIPrefix siPrefix)	Return a linearly scaled derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
FlowVolume.Unit	getBaseUnit()	Return the base unit for this unit.
FlowVolume	ofSi(double si, UnitInterface<FlowVolume> displayUnit)	Return a quantity for this unit with the SI-value and the provided display unit.
SIUnit	siUnit()	Return the SI unit for this unit.

Methods inherited from class org.djunits.unit.AbstractUnit

equals, generateSiPrefixes, getDisplayAbbreviation, getId, getName, getScale, getSiPrefix, getStoredDisplayAbbreviation, getStoredName, getStoredTextualAbbreviation, getTextualAbbreviation, getUnitSystem, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.unit.UnitInterface

fromBaseValue, ofSi, quantityInUnit, toBaseValue

Field Details

SI_UNIT

public static final SIUnit SI_UNIT

The dimensions of the flow volume is m3/s.

m3_s

public static final FlowVolume.Unit m3_s

m3/s.

SI

public static final FlowVolume.Unit SI

The SI or BASE unit.

m3_min

public static final FlowVolume.Unit m3_min

m^3/min.

m3_h

public static final FlowVolume.Unit m3_h

m^3/hour.

m3_day

public static final FlowVolume.Unit m3_day

m^3/day.

L_s

public static final FlowVolume.Unit L_s

L/s.

L_min

public static final FlowVolume.Unit L_min

L/min.

L_h

public static final FlowVolume.Unit L_h

L/hour.

L_day

public static final FlowVolume.Unit L_day

L/day.

ft3_s

public static final FlowVolume.Unit ft3_s

ft^3/s.

ft3_min

public static final FlowVolume.Unit ft3_min

ft^3/min.

in3_s

public static final FlowVolume.Unit in3_s

in^3/s.

in3_min

public static final FlowVolume.Unit in3_min

in^3/min.

gal_US_s

public static final FlowVolume.Unit gal_US_s

gallon/s (US).

gal_US_min

public static final FlowVolume.Unit gal_US_min

gallon/min (US).

gal_US_h

public static final FlowVolume.Unit gal_US_h

gallon/hour (US).

gal_US_day

public static final FlowVolume.Unit gal_US_day

gallon/day (US).

Constructor Details

Unit

public Unit(String id,
 String name,
 double scaleFactorToBaseUnit,
 UnitSystem unitSystem)

Create a new FlowVolume unit.

Parameters:

id - the id or main abbreviation of the unit

name - the full name of the unit

scaleFactorToBaseUnit - the scale factor of the unit to convert it TO the base (SI) unit

unitSystem - the unit system such as SI or IMPERIAL

Unit

public Unit(String textualAbbreviation,
 String displayAbbreviation,
 String name,
 Scale scale,
 UnitSystem unitSystem,
 SIPrefix siPrefix)

Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.

Parameters:

textualAbbreviation - the textual abbreviation of the unit, which doubles as the id

displayAbbreviation - the display abbreviation of the unit

name - the full name of the unit

scale - the scale to use to convert from this unit to the standard (e.g., SI, BASE) unit

unitSystem - unit system, e.g. SI or Imperial

siPrefix - the SI Prefix of this unit

Method Details

siUnit

public SIUnit siUnit()

Description copied from interface: UnitInterface

Return the SI unit for this unit.

Returns:

the SI unit for this unit

getBaseUnit

public FlowVolume.Unit getBaseUnit()

Description copied from interface: UnitInterface

Return the base unit for this unit.

Returns:

the base unit for this unit

ofSi

public FlowVolume ofSi(double si,
 UnitInterface<FlowVolume> displayUnit)

Description copied from interface: UnitInterface

Return a quantity for this unit with the SI-value and the provided display unit.

Parameters:

si - the value in SI or BASE units

displayUnit - the display unit to use

Returns:

a quantity for this unit with the SI-value and the provided display unit

deriveUnit

public FlowVolume.Unit deriveUnit(String textualAbbreviation,
 String displayAbbreviation,
 String name,
 double scaleFactor,
 UnitSystem unitSystem,
 SIPrefix siPrefix)

Description copied from class: AbstractUnit

Return a linearly scaled derived unit for this unit, with textual abbreviation(s) and a display abbreviation.

Specified by:

deriveUnit in class AbstractUnit<FlowVolume>

Parameters:

textualAbbreviation - the textual abbreviation of the unit, which doubles as the id

displayAbbreviation - the display abbreviation of the unit

name - the full name of the unit

scaleFactor - the (linear) scale factor to multiply with the current (linear) scale factor

unitSystem - unit system, e.g. SI or Imperial

siPrefix - the SI prefix of this unit

Returns:

a derived unit for this unit

deriveUnit

public FlowVolume.Unit deriveUnit(String abbreviation,
 String name,
 double scaleFactor,
 UnitSystem unitSystem)

Description copied from class: AbstractUnit

Return a linearly scaled derived unit for this unit, with an abbreviation and scale factor.

Overrides:

deriveUnit in class AbstractUnit<FlowVolume>

Parameters:

abbreviation - the textual abbreviation of the unit, which doubles as the id

name - the full name of the unit

scaleFactor - the (linear) scale factor to multiply with the current (linear) scale factor

unitSystem - unit system, e.g. SI or Imperial

Returns:

a derived unit for this unit