Package org.djunits.value.vdouble.scalar

Class FlowVolume

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>

org.djunits.value.vdouble.scalar.base.DoubleScalarRel<FlowVolumeUnit,FlowVolume>

org.djunits.value.vdouble.scalar.FlowVolume

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FlowVolume>, Relative<FlowVolumeUnit,FlowVolume>, Value<FlowVolumeUnit,FlowVolume>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2025-09-06T15:16:28.380798Z")
public class FlowVolume
extends DoubleScalarRel<FlowVolumeUnit,FlowVolume>

Easy access methods for the FlowVolume DoubleScalar, which is relative by definition.

Copyright (c) 2013-2025 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

• Serialized Form

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.value.vdouble.scalar.base.DoubleScalar

si

Constructor Summary

Constructors

Constructor	Description
FlowVolume(double value, FlowVolumeUnit unit)	Construct FlowVolume scalar with a unit.
FlowVolume(FlowVolume value)	Construct FlowVolume scalar.

Method Summary

Modifier and Type	Method	Description
final Speed	divide(Area v)	Calculate the division of FlowVolume and Area, which results in a Speed scalar.
static FlowVolume	divide(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)	Divide two scalars that result in a scalar of type FlowVolume.
final Dimensionless	divide(FlowVolume v)	Calculate the division of FlowVolume and FlowVolume, which results in a Dimensionless scalar.
final Volume	divide(Frequency v)	Calculate the division of FlowVolume and Frequency, which results in a Volume scalar.
final Area	divide(Speed v)	Calculate the division of FlowVolume and Speed, which results in a Area scalar.
final Frequency	divide(Volume v)	Calculate the division of FlowVolume and Volume, which results in a Frequency scalar.
final FlowVolume	instantiateRel(double value, FlowVolumeUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static FlowVolume	interpolate(FlowVolume zero, FlowVolume one, double ratio)	Interpolate between two values.
static FlowVolume	max(FlowVolume r1, FlowVolume r2)	Return the maximum value of two relative scalars.
static FlowVolume	max(FlowVolume r1, FlowVolume r2, FlowVolume... rn)	Return the maximum value of more than two relative scalars.
static FlowVolume	min(FlowVolume r1, FlowVolume r2)	Return the minimum value of two relative scalars.
static FlowVolume	min(FlowVolume r1, FlowVolume r2, FlowVolume... rn)	Return the minimum value of more than two relative scalars.
static FlowVolume	multiply(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)	Multiply two scalars that result in a scalar of type FlowVolume.
static FlowVolume	of(double value, String unitString)	Returns a FlowVolume based on a value and the textual representation of the unit, which can be localized.
static final FlowVolume	ofSI(double value)	Construct FlowVolume scalar based on an SI value.
SIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final FlowMass	times(Density v)	Calculate the multiplication of FlowVolume and Density, which results in a FlowMass scalar.
final Volume	times(Duration v)	Calculate the multiplication of FlowVolume and Duration, which results in a Volume scalar.
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.value.vdouble.scalar.base.DoubleScalarRel

abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

Methods inherited from class org.djunits.value.base.Scalar

format, format, getDisplayUnit, setDisplayUnit

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.Value

isAbsolute, isRelative

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,
 FlowVolumeUnit unit)

Construct FlowVolume scalar with a unit.

Parameters:

value - the double value, expressed in the given unit

unit - unit for the double value

FlowVolume

public FlowVolume(FlowVolume value)

Construct FlowVolume scalar.

Parameters:

value - Scalar from which to construct this instance

Method Details

instantiateRel

public final FlowVolume instantiateRel(double value,
 FlowVolumeUnit unit)

Description copied from class: DoubleScalarRel

Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateRel in class DoubleScalarRel<FlowVolumeUnit,FlowVolume>

Parameters:

value - the double value

unit - the unit

Returns:

R a new relative instance of the DoubleScalar of the right type

ofSI

public static final FlowVolume ofSI(double value)

Construct FlowVolume scalar based on an SI value.

Parameters:

value - the double value in SI units

Returns:

the new scalar with the SI value

interpolate

public static FlowVolume interpolate(FlowVolume zero,
 FlowVolume one,
 double ratio)

Interpolate between two values. Note that the first value does not have to be smaller than the second.

Parameters:

zero - the value at a ratio of zero

one - the value at a ratio of one

ratio - the ratio between 0 and 1, inclusive

Returns:

a FlowVolume at the given ratio between 0 and 1

max

public static FlowVolume max(FlowVolume r1,
 FlowVolume r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the maximum value of two relative scalars

max

public static FlowVolume max(FlowVolume r1,
 FlowVolume r2,
 FlowVolume... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the maximum value of more than two relative scalars

min

public static FlowVolume min(FlowVolume r1,
 FlowVolume r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the minimum value of two relative scalars

min

public static FlowVolume min(FlowVolume r1,
 FlowVolume r2,
 FlowVolume... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two relative scalars

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 value,
 String unitString)

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

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

Parameters:

v - scalar

Returns:

scalar as a division of FlowVolume and FlowVolume

times

public final Volume times(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 final 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 final 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 final 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 final 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

times

public final FlowMass times(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

reciprocal

public SIScalar reciprocal()

Description copied from class: DoubleScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Overrides:

reciprocal in class DoubleScalarRel<FlowVolumeUnit,FlowVolume>

Returns:

a new scalar instance with correct SI dimensions

multiply

public static FlowVolume multiply(DoubleScalarRel<?,?> scalar1,
 DoubleScalarRel<?,?> scalar2)

Multiply two scalars that result in a scalar of type FlowVolume.

Parameters:

scalar1 - the first scalar

scalar2 - the second scalar

Returns:

the multiplication of both scalars as an instance of FlowVolume

divide

public static FlowVolume divide(DoubleScalarRel<?,?> scalar1,
 DoubleScalarRel<?,?> scalar2)

Divide two scalars that result in a scalar of type FlowVolume.

Parameters:

scalar1 - the first scalar

scalar2 - the second scalar

Returns:

the division of scalar1 by scalar2 as an instance of FlowVolume