org.djunits.value.vdouble.scalar

Class FlowVolume

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.AbstractDoubleScalar<U,R>

org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<FlowVolumeUnit,FlowVolume>

org.djunits.value.vdouble.scalar.FlowVolume

All Implemented Interfaces:

Serializable, Comparable<FlowVolume>, MathFunctionsAbs<FlowVolume>, MathFunctionsRel<FlowVolume>, Relative, Value<FlowVolumeUnit>, DoubleMathFunctions<FlowVolume>, DoubleScalarInterface

public class FlowVolume
extends AbstractDoubleScalarRel<FlowVolumeUnit,FlowVolume>

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

 DoubleScalar.Rel<FlowVolumeUnit> value = new DoubleScalar.Rel<FlowVolumeUnit>(100.0, FlowVolumeUnit.SI);
 

we can now write:

 FlowVolume value = new FlowVolume(100.0, FlowVolumeUnit.SI);
 

The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

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

$LastChangedDate: 2019-03-03 00:53:50 +0100 (Sun, 03 Mar 2019) $, @version $Revision: 349 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FlowVolume	NaN constant with value NaN.
static FlowVolume	NEG_MAXVALUE constant with value -MAX_VALUE.
static FlowVolume	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FlowVolume	POS_MAXVALUE constant with value MAX_VALUE.
static FlowVolume	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FlowVolume	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FlowVolume	createSI(double value) Construct FlowVolume scalar.
Speed	divideBy(Area v) Calculate the division of FlowVolume and Area, which results in a Speed scalar.
Dimensionless	divideBy(FlowVolume v) Calculate the division of FlowVolume and FlowVolume, which results in a Dimensionless scalar.
Volume	divideBy(Frequency v) Calculate the division of FlowVolume and Frequency, which results in a Volume scalar.
Area	divideBy(Speed v) Calculate the division of FlowVolume and Speed, which results in a Area scalar.
Frequency	divideBy(Volume v) Calculate the division of FlowVolume and Volume, which results in a Frequency scalar.
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.
Volume	multiplyBy(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.AbstractDoubleScalarRel

abs, ceil, divideBy, floor, minus, multiplyBy, neg, plus, rint, round

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

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

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

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.vdouble.DoubleMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final FlowVolume ZERO

constant with value zero.

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 Detail

FlowVolume

public FlowVolume(double value,
                  FlowVolumeUnit unit)

Construct FlowVolume scalar.

Parameters:

value - double value

unit - unit for the double value

FlowVolume

public FlowVolume(FlowVolume value)

Construct FlowVolume scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final FlowVolume instantiateRel(double value,
                                       FlowVolumeUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<FlowVolumeUnit,FlowVolume>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

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

createSI

public static final FlowVolume createSI(double value)

Construct FlowVolume scalar.

Parameters:

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

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

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)
                          throws IllegalArgumentException

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 the official abbreviation of the unit. Spaces are allowed, but not necessary, between the value and the unit.

Parameters:

text - String; the textual representation to parse into a FlowVolume

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

Throws:

IllegalArgumentException - when the text cannot be parsed

divideBy

public final Dimensionless divideBy(FlowVolume v)

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

Parameters:

v - FlowVolume scalar

Returns:

Dimensionless scalar as a division of FlowVolume and FlowVolume

multiplyBy

public final Volume multiplyBy(Duration v)

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

Parameters:

v - FlowVolume scalar

Returns:

Volume scalar as a multiplication of FlowVolume and Duration

divideBy

public final Volume divideBy(Frequency v)

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

Parameters:

v - FlowVolume scalar

Returns:

Volume scalar as a division of FlowVolume and Frequency

divideBy

public final Frequency divideBy(Volume v)

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

Parameters:

v - FlowVolume scalar

Returns:

Frequency scalar as a division of FlowVolume and Volume

divideBy

public final Speed divideBy(Area v)

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

Parameters:

v - FlowVolume scalar

Returns:

Speed scalar as a division of FlowVolume and Area

divideBy

public final Area divideBy(Speed v)

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

Parameters:

v - FlowVolume scalar

Returns:

Area scalar as a division of FlowVolume and Speed