org.djunits.value.vdouble.scalar

Class Pressure

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<PressureUnit,Pressure>

org.djunits.value.vdouble.scalar.Pressure

All Implemented Interfaces:

Serializable, Comparable<Pressure>, MathFunctionsAbs<Pressure>, MathFunctionsRel<Pressure>, Relative, Value<PressureUnit>, DoubleMathFunctions<Pressure>, DoubleScalarInterface

public class Pressure
extends AbstractDoubleScalarRel<PressureUnit,Pressure>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final Pressure NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Pressure POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Pressure NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Pressure POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Pressure NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Pressure

public Pressure(double value,
                PressureUnit unit)

Construct Pressure scalar.

Parameters:

value - double value

unit - unit for the double value

Pressure

public Pressure(Pressure value)

Construct Pressure scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Pressure instantiateRel(double value,
                                     PressureUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<PressureUnit,Pressure>

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

Construct Pressure scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - Pressure scalar

Returns:

Dimensionless scalar as a division of Pressure and Pressure

multiplyBy

public final Force multiplyBy(Area v)

Calculate the multiplication of Pressure and Area, which results in a Force scalar.

Parameters:

v - Pressure scalar

Returns:

Force scalar as a multiplication of Pressure and Area

multiplyBy

public final Energy multiplyBy(Volume v)

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

Parameters:

v - Pressure scalar

Returns:

Energy scalar as a multiplication of Pressure and Volume