Package org.djunits.quantity

Class FlowMass

java.lang.Object

java.lang.Number

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

org.djunits.quantity.FlowMass

All Implemented Interfaces:

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

public class FlowMass
extends Quantity<FlowMass>

Flow mass: The rate of mass passing through a surface per unit time, measured in kilograms per second (kg/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	FlowMass.Unit	FlowMass.Unit encodes the units of mass flow.

Field Summary

Fields

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

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

si

Constructor Summary

Constructors

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

Method Summary

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

Constant with value zero.

ONE

public static final FlowMass ONE

Constant with value one.

NaN

public static final FlowMass NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FlowMass POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FlowMass NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FlowMass POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FlowMass NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FlowMass

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

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

FlowMass

public FlowMass(double valueInUnit,
 FlowMass.Unit unit)

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

Return a FlowMass instance based on an SI value.

Parameters:

si - the si value

Returns:

the FlowMass instance based on an SI value

ofSi

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

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

instantiateSi

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

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

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

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

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

of

public static FlowMass of(double valueInUnit,
 String unitString)

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

Description copied from interface: Value

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<FlowMass>

Overrides:

getDisplayUnit in class Quantity<FlowMass>

Returns:

the unit of this Value

divide

public Dimensionless divide(FlowMass v)

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

Parameters:

v - quantity

Returns:

quantity as a division of FlowMass and FlowMass

multiply

public Mass multiply(Duration v)

Calculate the multiplication of FlowMass and Duration, which results in a Mass scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of FlowMass and Duration

divide

public Mass divide(Frequency v)

Calculate the division of FlowMass and Frequency, which results in a Mass scalar.

Parameters:

v - scalar

Returns:

scalar as a division of FlowMass and Frequency

divide

public Frequency divide(Mass v)

Calculate the division of FlowMass and Mass, which results in a Frequency scalar.

Parameters:

v - scalar

Returns:

scalar as a division of FlowMass and Mass

multiply

public Force multiply(Speed v)

Calculate the multiplication of FlowMass and Speed, which results in a Force scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of FlowMass and Speed

divide

public Density divide(FlowVolume v)

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

Parameters:

v - scalar

Returns:

scalar as a division of FlowMass and FlowVolume

divide

public FlowVolume divide(Density v)

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

Parameters:

v - scalar

Returns:

scalar as a division of FlowMass and Density

multiply

public Momentum multiply(Length v)

Calculate the multiplication of FlowMass and Length, which results in a Momentum scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of FlowMass and Length