Package org.djunits.value.vdouble.scalar
Class Volume
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<VolumeUnit,Volume>
org.djunits.value.vdouble.scalar.Volume
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Volume>
,Relative<VolumeUnit,
,Volume> Value<VolumeUnit,
Volume>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class Volume
extends DoubleScalarRel<VolumeUnit,Volume>
Easy access methods for the Volume DoubleScalar, which is relative by definition.
Copyright (c) 2013-2024 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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Volume
Constant with value NaN.static final Volume
Constant with value -MAX_VALUE.static final Volume
Constant with value NEGATIVE_INFINITY.static final Volume
Constant with value one.static final Volume
Constant with value MAX_VALUE.static final Volume
Constant with value POSITIVE_INFINITY.static final Volume
Constant with value zero.Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar
si
-
Constructor Summary
ConstructorDescriptionVolume
(double value, VolumeUnit unit) Construct Volume scalar.Construct Volume scalar. -
Method Summary
Modifier and TypeMethodDescriptionfinal Length
Calculate the division of Volume and Area, which results in a Length scalar.final FlowVolume
Calculate the division of Volume and Duration, which results in a FlowVolume scalar.final Duration
divide
(FlowVolume v) Calculate the division of Volume and FlowVolume, which results in a Duration scalar.final Area
Calculate the division of Volume and Length, which results in a Area scalar.final Dimensionless
Calculate the division of Volume and Volume, which results in a Dimensionless scalar.final Volume
instantiateRel
(double value, VolumeUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.static final Volume
instantiateSI
(double value) Construct Volume scalar.static Volume
interpolate
(Volume zero, Volume one, double ratio) Interpolate between two values.static Volume
Return the maximum value of two relative scalars.static Volume
Return the maximum value of more than two relative scalars.static Volume
Return the minimum value of two relative scalars.static Volume
Return the minimum value of more than two relative scalars.static Volume
Returns a Volume based on a value and the textual representation of the unit, which can be localized.Create the reciprocal of this scalar with the correct dimensions.final Mass
Calculate the multiplication of Volume and Density, which results in a Mass scalar.final Area
Calculate the multiplication of Volume and LinearDensity, which results in a Area scalar.final Energy
Calculate the multiplication of Volume and Pressure, which results in a Energy scalar.static Volume
Returns a Volume 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, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, 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
Constant with value zero. -
ONE
Constant with value one. -
NaN
Constant with value NaN. -
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY. -
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY. -
POS_MAXVALUE
Constant with value MAX_VALUE. -
NEG_MAXVALUE
Constant with value -MAX_VALUE.
-
-
Constructor Details
-
Volume
Construct Volume scalar.- Parameters:
value
- double; the double valueunit
- VolumeUnit; unit for the double value
-
Volume
Construct Volume scalar.- Parameters:
value
- Volume; Scalar from which to construct this instance
-
-
Method Details
-
instantiateRel
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 classDoubleScalarRel<VolumeUnit,
Volume> - Parameters:
value
- double; the double valueunit
- U; the unit- Returns:
- R a new relative instance of the DoubleScalar of the right type
-
instantiateSI
Construct Volume scalar.- Parameters:
value
- double; the double value in SI units- Returns:
- Volume; the new scalar with the SI value
-
interpolate
Interpolate between two values.- Parameters:
zero
- Volume; the low valueone
- Volume; the high valueratio
- double; the ratio between 0 and 1, inclusive- Returns:
- Volume; a Scalar at the ratio between
-
max
Return the maximum value of two relative scalars.- Parameters:
r1
- Volume; the first scalarr2
- Volume; the second scalar- Returns:
- Volume; the maximum value of two relative scalars
-
max
Return the maximum value of more than two relative scalars.- Parameters:
r1
- Volume; the first scalarr2
- Volume; the second scalarrn
- Volume...; the other scalars- Returns:
- Volume; the maximum value of more than two relative scalars
-
min
Return the minimum value of two relative scalars.- Parameters:
r1
- Volume; the first scalarr2
- Volume; the second scalar- Returns:
- Volume; the minimum value of two relative scalars
-
min
Return the minimum value of more than two relative scalars.- Parameters:
r1
- Volume; the first scalarr2
- Volume; the second scalarrn
- Volume...; the other scalars- Returns:
- Volume; the minimum value of more than two relative scalars
-
valueOf
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 a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.- Parameters:
text
- String; the textual representation to parse into a Volume- Returns:
- Volume; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the text cannot be parsedNullPointerException
- when the text argument is null
-
of
Returns a Volume based on a value and the textual representation of the unit, which can be localized.- Parameters:
value
- double; the value to useunitString
- String; the textual representation of the unit- Returns:
- Volume; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the unit cannot be parsed or is incorrectNullPointerException
- when the unitString argument is null
-
divide
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
-
times
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
-
times
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
-
divide
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
-
divide
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
-
times
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
-
divide
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
-
divide
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
-
reciprocal
Description copied from class:DoubleScalarRel
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocal
in classDoubleScalarRel<VolumeUnit,
Volume> - Returns:
- DoubleScalar<?>; a new scalar instance with correct SI dimensions
-