Package org.djunits.quantity
Class TemperatureDifference
java.lang.Object
java.lang.Number
org.djunits.quantity.def.Quantity<TemperatureDifference,Temperature.Unit>
org.djunits.quantity.TemperatureDifference
- All Implemented Interfaces:
Serializable,Comparable<TemperatureDifference>,Additive<TemperatureDifference>,Scalable<TemperatureDifference>,Value<Temperature.Unit,TemperatureDifference>
TemperatureDifference is a measure of (difference in) thermal state or average kinetic energy of particles, measured in
kelvins (K). Note that the TemperatureDifference quantity is relative (it measures a difference between temperatures),
whereas the Temperature quantity is absolute.
Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djunits.org. The DJUNITS project is distributed under a three-clause BSD-style license.
- Author:
- Alexander Verbraeck
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final TemperatureDifferenceConstant with value NaN.static final TemperatureDifferenceConstant with value -MAX_VALUE.static final TemperatureDifferenceConstant with value NEGATIVE_INFINITY.static final TemperatureDifferenceConstant with value one.static final TemperatureDifferenceConstant with value MAX_VALUE.static final TemperatureDifferenceConstant with value POSITIVE_INFINITY.static final TemperatureDifferenceConstant with value zero. -
Constructor Summary
ConstructorsConstructorDescriptionTemperatureDifference(double value, String abbreviation) Instantiate a TemperatureDifference quantity with a unit, expressed as a String.TemperatureDifference(double value, Temperature.Unit unit) Instantiate a TemperatureDifference quantity with a unit.Construct TemperatureDifference quantity. -
Method Summary
Modifier and TypeMethodDescriptionfinal Temperatureadd(Temperature absoluteTemperature) Add an absolute temperature to this temperature difference, and return a new absolute temperature.final DimensionlessCalculate the division of TemperatureDifference and TemperatureDifference, which results in a Dimensionless quantity.instantiate(double si) Instantiate a quantity with an SI or base value.static TemperatureDifferenceReturns a TemperatureDifference based on a value and the textual representation of the unit, which can be localized.static TemperatureDifferenceofSi(double si) Return a TemperatureDifference instance based on an SI value.siUnit()Return the SI unit of this quantity.static TemperatureDifferenceReturns a TemperatureDifference representation of a textual representation of a value with a unit.Methods inherited from class org.djunits.quantity.def.Quantity
abs, add, as, compareTo, divide, doubleValue, eq, eq0, equals, floatValue, format, format, ge, ge0, getDisplayUnit, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, reciprocal, scaleBy, setDisplayUnit, si, subtract, sum, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString, valueOfMethods inherited from class java.lang.Number
byteValue, shortValueMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.djunits.value.Value
isAbsolute, setDisplayUnit
-
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
-
TemperatureDifference
Instantiate a TemperatureDifference quantity with a unit.- Parameters:
value- the value, expressed in the unitunit- the unit in which the value is expressed
-
TemperatureDifference
Instantiate a TemperatureDifference quantity with a unit, expressed as a String.- Parameters:
value- the value, expressed in the unitabbreviation- the String abbreviation of the unit in which the value is expressed
-
TemperatureDifference
Construct TemperatureDifference quantity.- Parameters:
value- Scalar from which to construct this instance
-
-
Method Details
-
ofSi
Return a TemperatureDifference instance based on an SI value.- Parameters:
si- the si value- Returns:
- the TemperatureDifference instance based on an SI value
-
instantiate
Description copied from class:QuantityInstantiate a quantity with an SI or base value.- Specified by:
instantiatein classQuantity<TemperatureDifference,Temperature.Unit> - Parameters:
si- the value expressed in the base (SI) unit- Returns:
- a quantity with the given SI-value and base (SI) unit
-
siUnit
Description copied from class:QuantityReturn the SI unit of this quantity.- Overrides:
siUnitin classQuantity<TemperatureDifference,Temperature.Unit> - Returns:
- the SI unit of this quantity
-
valueOf
Returns a TemperatureDifference 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- the textual representation to parse into a Temperature- Returns:
- 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 TemperatureDifference based on a value and the textual representation of the unit, which can be localized.- Parameters:
value- the value to useunitString- the textual representation of the unit- Returns:
- 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
-
add
Add an absolute temperature to this temperature difference, and return a new absolute temperature. The unit of the return value will be the unit of this temperature difference, and the reference point of the return value will be the reference point of the given temperature.R.add(A)= unit of R and reference value of A.- Parameters:
absoluteTemperature- the absolute temperature to add- Returns:
- the absolute temperature plus this temperature difference
-
divide
Calculate the division of TemperatureDifference and TemperatureDifference, which results in a Dimensionless quantity.- Parameters:
v- quantity- Returns:
- quantity as a division of TemperatureDifference and Temperature
-