Package org.djunits.quantity

Class Energy

java.lang.Object
java.lang.Number
org.djunits.quantity.def.Quantity<Energy>
org.djunits.quantity.Energy
All Implemented Interfaces:
Serializable, Comparable<Energy>, Additive<Energy>, Scalable<Energy>, Value<Energy>
public class Energy extends Quantity<Energy>
Energy is a physical quantity representing the capacity to do work, measured in joules (J).

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

    • ZERO

      public static final Energy ZERO
      Constant with value zero.

    • ONE

      public static final Energy ONE
      Constant with value one.

    • NaN

      public static final Energy NaN
      Constant with value NaN.

    • POSITIVE_INFINITY

      public static final Energy POSITIVE_INFINITY
      Constant with value POSITIVE_INFINITY.

    • NEGATIVE_INFINITY

      public static final Energy NEGATIVE_INFINITY
      Constant with value NEGATIVE_INFINITY.

    • POS_MAXVALUE

      public static final Energy POS_MAXVALUE
      Constant with value MAX_VALUE.

    • NEG_MAXVALUE

      public static final Energy NEG_MAXVALUE
      Constant with value -MAX_VALUE.

  • Constructor Details

    • Energy

      public Energy(double value, Energy.Unit displayUnit, boolean useSi)
      Instantiate a Energy 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

    • Energy

      public Energy(double valueInUnit, Energy.Unit unit)
      Instantiate a Energy 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 Energy ofSi(double si)
      Return a Energy instance based on an SI value.
      Parameters:
      si - the si value
      Returns:
      the Energy instance based on an SI value

    • ofSi

      public static Energy ofSi(double siValue, Energy.Unit displayUnit)
      Instantiate a Energy 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 Energy instance based on an SI value with the given display unit

    • instantiateSi

      public Energy instantiateSi(double siValue, UnitInterface<Energy> 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<Energy>
      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 Energy valueOf(String text)
      Returns a Energy 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 Energy
      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 Energy of(double valueInUnit, Energy.Unit unit)
      Returns a Energy 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 Energy representation of the value in its unit

    • of

      public static Energy of(double valueInUnit, String unitString)
      Returns a Energy 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 Energy.Unit getDisplayUnit()
      Description copied from interface: Value
      Retrieve the unit of this Value.
      Specified by:
      getDisplayUnit in interface Value<Energy>
      Overrides:
      getDisplayUnit in class Quantity<Energy>
      Returns:
      the unit of this Value

    • divide

      public Dimensionless divide(Energy v)
      Calculate the division of Energy and Energy, which results in a Dimensionless quantity.
      Parameters:
      v - quantity
      Returns:
      quantity as a division of Energy and Energy

    • divide

      public Length divide(Force v)
      Calculate the division of Energy and Force, which results in a Length scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Energy and Force

    • divide

      public Force divide(Length v)
      Calculate the division of Energy and Length, which results in a Force scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Energy and Length

    • multiply

      public Force multiply(LinearObjectDensity v)
      Calculate the multiplication of Energy and LinearDensity, which results in a Force scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Energy and LinearDensity

    • divide

      public Power divide(Duration v)
      Calculate the division of Energy and Duration, which results in a Power scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Energy and Duration

    • divide

      public Duration divide(Power v)
      Calculate the division of Energy and Power, which results in a Duration scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Energy and Power

    • divide

      public Pressure divide(Volume v)
      Calculate the division of Energy and Volume, which results in a Pressure scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Energy and Volume

    • divide

      public Volume divide(Pressure v)
      Calculate the division of Energy and Pressure, which results in a Volume scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Energy and Pressure

    • multiply

      public Power multiply(Frequency v)
      Calculate the multiplication of Energy and Frequency, which results in a Power scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Energy and Frequency

    • divide

      public Momentum divide(Speed v)
      Calculate the division of Energy and Speed, which results in a Momentum scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Energy and Speed

    • divide

      public Speed divide(Momentum v)
      Calculate the division of Energy and Momentum, which results in a Speed scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Energy and Momentum