Package org.djunits.quantity

Class TemperatureDifference

java.lang.Object
java.lang.Number
org.djunits.quantity.def.Quantity<TemperatureDifference>
org.djunits.quantity.TemperatureDifference
All Implemented Interfaces:
Serializable, Comparable<TemperatureDifference>, Additive<TemperatureDifference>, Scalable<TemperatureDifference>, Value<TemperatureDifference>
public class TemperatureDifference extends Quantity<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 Details

  • Constructor Details

    • TemperatureDifference

      public TemperatureDifference(double value, Temperature.Unit displayUnit, boolean useSi)
      Instantiate a TemperatureDifference quantity with an SI or base value and a display unit.
      Parameters:
      value - the quantity value expressed in the SI or base unit
      displayUnit - the display unit to use
      useSi - use SI value when true, use value in unit when false

    • TemperatureDifference

      public TemperatureDifference(double valueInUnit, Temperature.Unit unit)
      Instantiate a TemperatureDifference quantity expressed in the given unit.
      Parameters:
      valueInUnit - the quantity value expressed in the given unit
      unit - the unit of the value, also acts as the display unit

  • Method Details

    • ofSi

      public static TemperatureDifference ofSi(double si)
      Return a TemperatureDifference instance based on an SI value.
      Parameters:
      si - the si value
      Returns:
      the TemperatureDifference instance based on an SI value

    • ofSi

      public static TemperatureDifference ofSi(double siValue, Temperature.Unit displayUnit)
      Instantiate a TemperatureDifference quantity with an SI or base value and a display unit.
      Parameters:
      siValue - the quantity value expressed in the SI or base unit
      displayUnit - the display unit to use
      Returns:
      the TemperatureDifference instance based on an SI value with the given display unit

    • instantiateSi

      public TemperatureDifference instantiateSi(double siValue, UnitInterface<TemperatureDifference> displayUnit)
      Description copied from class: Quantity
      Instantiate a quantity with an SI or base value, and a display unit.
      Specified by:
      instantiateSi in class Quantity<TemperatureDifference>
      Parameters:
      siValue - the value expressed in the base (SI) unit
      displayUnit - the display unit to use for the quantity
      Returns:
      a quantity with the given SI or base value, and the given display unit

    • valueOf

      public static TemperatureDifference valueOf(String text)
      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 TemperatureDifference
      Returns:
      the Scalar representation of the value in its unit
      Throws:
      IllegalArgumentException - when the text cannot be parsed
      NullPointerException - when the text argument is null

    • of

      public static TemperatureDifference of(double valueInUnit, Temperature.Unit unit)
      Returns a TemperatureDifference based on a value expressed in the unit.
      Parameters:
      valueInUnit - the value, expressed in the given unit
      unit - the unit of the value, also acts as the display unit
      Returns:
      ab TemperatureDifference representation of the value in its unit

    • of

      public static TemperatureDifference of(double valueInUnit, String unitString)
      Returns a TemperatureDifference based on a value and the textual representation of the unit, which can be localized.
      Parameters:
      valueInUnit - the value, expressed in the unit as given by unitString
      unitString - 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 incorrect
      NullPointerException - when the unitString argument is null

    • getDisplayUnit

      public Temperature.Unit getDisplayUnit()
      Description copied from interface: Value
      Retrieve the unit of this Value.
      Specified by:
      getDisplayUnit in interface Value<TemperatureDifference>
      Overrides:
      getDisplayUnit in class Quantity<TemperatureDifference>
      Returns:
      the unit of this Value

    • add

      public Temperature add(Temperature absoluteTemperature)
      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

      public Dimensionless divide(TemperatureDifference v)
      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