org.djunits.value.vdouble.scalar

Class Volume

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<VolumeUnit,Volume>

org.djunits.value.vdouble.scalar.Volume

All Implemented Interfaces:

Serializable, Comparable<Volume>, MathFunctionsAbs<Volume>, MathFunctionsRel<Volume>, Relative, Value<VolumeUnit>, DoubleMathFunctions<Volume>, DoubleScalarInterface

public class Volume
extends AbstractDoubleScalarRel<VolumeUnit,Volume>

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

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

we can now write:

 Volume value = new Volume(100.0, VolumeUnit.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 Volume	NaN constant with value NaN.
static Volume	NEG_MAXVALUE constant with value -MAX_VALUE.
static Volume	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static Volume	POS_MAXVALUE constant with value MAX_VALUE.
static Volume	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static Volume	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
Volume(double value, VolumeUnit unit) Construct Volume scalar.
Volume(Volume value) Construct Volume scalar.

Method Summary

Modifier and Type	Method and Description
static Volume	createSI(double value) Construct Volume scalar.
Length	divideBy(Area v) Calculate the division of Volume and Area, which results in a Length scalar.
FlowVolume	divideBy(Duration v) Calculate the division of Volume and Duration, which results in a FlowVolume scalar.
Duration	divideBy(FlowVolume v) Calculate the division of Volume and FlowVolume, which results in a Duration scalar.
Area	divideBy(Length v) Calculate the division of Volume and Length, which results in a Area scalar.
Dimensionless	divideBy(Volume v) Calculate the division of Volume and Volume, which results in a Dimensionless scalar.
Volume	instantiateRel(double value, VolumeUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Volume	interpolate(Volume zero, Volume one, double ratio) Interpolate between two values.
static Volume	max(Volume r1, Volume r2) Return the maximum value of two relative scalars.
static Volume	max(Volume r1, Volume r2, Volume... rn) Return the maximum value of more than two relative scalars.
static Volume	min(Volume r1, Volume r2) Return the minimum value of two relative scalars.
static Volume	min(Volume r1, Volume r2, Volume... rn) Return the minimum value of more than two relative scalars.
Mass	multiplyBy(Density v) Calculate the multiplication of Volume and Density, which results in a Mass scalar.
Area	multiplyBy(LinearDensity v) Calculate the multiplication of Volume and LinearDensity, which results in a Area scalar.
Money	multiplyBy(MoneyPerVolume v) Calculate the multiplication of Volume and MoneyPerVolume, which results in a Money scalar.
Energy	multiplyBy(Pressure v) Calculate the multiplication of Volume and Pressure, which results in a Energy scalar.
static Volume	valueOf(String text) Returns a Volume 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 Volume ZERO

constant with value zero.

NaN

public static final Volume NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Volume POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Volume NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Volume POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Volume NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Volume

public Volume(double value,
              VolumeUnit unit)

Construct Volume scalar.

Parameters:

value - double value

unit - unit for the double value

Volume

public Volume(Volume value)

Construct Volume scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Volume instantiateRel(double value,
                                   VolumeUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<VolumeUnit,Volume>

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 Volume createSI(double value)

Construct Volume scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

public static Volume interpolate(Volume zero,
                                 Volume 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 Volume max(Volume r1,
                         Volume 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 Volume max(Volume r1,
                         Volume r2,
                         Volume... 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 Volume min(Volume r1,
                         Volume 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 Volume min(Volume r1,
                         Volume r2,
                         Volume... 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 Volume valueOf(String text)
                      throws IllegalArgumentException

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

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(Volume v)

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

Parameters:

v - Volume scalar

Returns:

Dimensionless scalar as a division of Volume and Volume

multiplyBy

public final Mass multiplyBy(Density v)

Calculate the multiplication of Volume and Density, which results in a Mass scalar.

Parameters:

v - Volume scalar

Returns:

Mass scalar as a multiplication of Volume and Density

multiplyBy

public final Energy multiplyBy(Pressure v)

Calculate the multiplication of Volume and Pressure, which results in a Energy scalar.

Parameters:

v - Volume scalar

Returns:

Energy scalar as a multiplication of Volume and Pressure

divideBy

public final Area divideBy(Length v)

Calculate the division of Volume and Length, which results in a Area scalar.

Parameters:

v - Volume scalar

Returns:

Area scalar as a division of Volume and Length

divideBy

public final Length divideBy(Area v)

Calculate the division of Volume and Area, which results in a Length scalar.

Parameters:

v - Volume scalar

Returns:

Length scalar as a division of Volume and Area

multiplyBy

public final Area multiplyBy(LinearDensity v)

Calculate the multiplication of Volume and LinearDensity, which results in a Area scalar.

Parameters:

v - Volume scalar

Returns:

Area scalar as a multiplication of Volume and LinearDensity

divideBy

public final FlowVolume divideBy(Duration v)

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

Parameters:

v - Volume scalar

Returns:

FlowVolume scalar as a division of Volume and Duration

divideBy

public final Duration divideBy(FlowVolume v)

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

Parameters:

v - Volume scalar

Returns:

Duration scalar as a division of Volume and FlowVolume

multiplyBy

public final Money multiplyBy(MoneyPerVolume v)

Calculate the multiplication of Volume and MoneyPerVolume, which results in a Money scalar.

Parameters:

v - Volume scalar

Returns:

Money scalar as a multiplication of Volume and MoneyPerVolume