org.djunits.value.vdouble.scalar

Class FlowMass

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<FlowMassUnit,FlowMass>

org.djunits.value.vdouble.scalar.FlowMass

All Implemented Interfaces:

Serializable, Comparable<FlowMass>, MathFunctionsAbs<FlowMass>, MathFunctionsRel<FlowMass>, Relative, Value<FlowMassUnit>, DoubleMathFunctions<FlowMass>, DoubleScalarInterface

public class FlowMass
extends AbstractDoubleScalarRel<FlowMassUnit,FlowMass>

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

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

we can now write:

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

Method Summary

Modifier and Type	Method and Description
static FlowMass	createSI(double value) Construct FlowMass scalar.
Dimensionless	divideBy(FlowMass v) Calculate the division of FlowMass and FlowMass, which results in a Dimensionless scalar.
Mass	divideBy(Frequency v) Calculate the division of FlowMass and Frequency, which results in a Mass scalar.
Frequency	divideBy(Mass v) Calculate the division of FlowMass and Mass, which results in a Frequency scalar.
FlowMass	instantiateRel(double value, FlowMassUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static FlowMass	interpolate(FlowMass zero, FlowMass one, double ratio) Interpolate between two values.
static FlowMass	max(FlowMass r1, FlowMass r2) Return the maximum value of two relative scalars.
static FlowMass	max(FlowMass r1, FlowMass r2, FlowMass... rn) Return the maximum value of more than two relative scalars.
static FlowMass	min(FlowMass r1, FlowMass r2) Return the minimum value of two relative scalars.
static FlowMass	min(FlowMass r1, FlowMass r2, FlowMass... rn) Return the minimum value of more than two relative scalars.
Mass	multiplyBy(Duration v) Calculate the multiplication of FlowMass and Duration, which results in a Mass scalar.
Force	multiplyBy(Speed v) Calculate the multiplication of FlowMass and Speed, which results in a Force scalar.
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.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 FlowMass ZERO

constant with value zero.

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 Detail

FlowMass

public FlowMass(double value,
                FlowMassUnit unit)

Construct FlowMass scalar.

Parameters:

value - double value

unit - unit for the double value

FlowMass

public FlowMass(FlowMass value)

Construct FlowMass scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final FlowMass instantiateRel(double value,
                                     FlowMassUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<FlowMassUnit,FlowMass>

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

Construct FlowMass scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - FlowMass scalar

Returns:

Dimensionless scalar as a division of FlowMass and FlowMass

multiplyBy

public final Mass multiplyBy(Duration v)

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

Parameters:

v - FlowMass scalar

Returns:

Mass scalar as a multiplication of FlowMass and Duration

divideBy

public final Mass divideBy(Frequency v)

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

Parameters:

v - FlowMass scalar

Returns:

Mass scalar as a division of FlowMass and Frequency

divideBy

public final Frequency divideBy(Mass v)

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

Parameters:

v - FlowMass scalar

Returns:

Frequency scalar as a division of FlowMass and Mass

multiplyBy

public final Force multiplyBy(Speed v)

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

Parameters:

v - FlowMass scalar

Returns:

Force scalar as a multiplication of FlowMass and Speed