Package org.djunits.quantity

Class LuminousFlux

java.lang.Object
java.lang.Number
org.djunits.quantity.def.Quantity<LuminousFlux,LuminousFlux.Unit>
org.djunits.quantity.LuminousFlux
All Implemented Interfaces:
Serializable, Comparable<LuminousFlux>, Additive<LuminousFlux>, Scalable<LuminousFlux>, Value<LuminousFlux.Unit,LuminousFlux>
public class LuminousFlux extends Quantity<LuminousFlux,LuminousFlux.Unit>
Luminous flux is the total perceived power of light emitted by a source, measured in lumens (lm).

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 LuminousFlux ZERO
      Constant with value zero.

    • ONE

      public static final LuminousFlux ONE
      Constant with value one.

    • NaN

      public static final LuminousFlux NaN
      Constant with value NaN.

    • POSITIVE_INFINITY

      public static final LuminousFlux POSITIVE_INFINITY
      Constant with value POSITIVE_INFINITY.

    • NEGATIVE_INFINITY

      public static final LuminousFlux NEGATIVE_INFINITY
      Constant with value NEGATIVE_INFINITY.

    • POS_MAXVALUE

      public static final LuminousFlux POS_MAXVALUE
      Constant with value MAX_VALUE.

    • NEG_MAXVALUE

      public static final LuminousFlux NEG_MAXVALUE
      Constant with value -MAX_VALUE.

  • Constructor Details

    • LuminousFlux

      public LuminousFlux(double value, LuminousFlux.Unit unit)
      Instantiate a LuminousFlux quantity with a unit.
      Parameters:
      value - the value, expressed in the unit
      unit - the unit in which the value is expressed

    • LuminousFlux

      public LuminousFlux(double value, String abbreviation)
      Instantiate a LuminousFlux quantity with a unit, expressed as a String.
      Parameters:
      value - the value, expressed in the unit
      abbreviation - the String abbreviation of the unit in which the value is expressed

    • LuminousFlux

      public LuminousFlux(LuminousFlux value)
      Construct LuminousFlux quantity.
      Parameters:
      value - Scalar from which to construct this instance

  • Method Details

    • ofSi

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

    • instantiate

      public LuminousFlux instantiate(double si)
      Description copied from class: Quantity
      Instantiate a quantity with an SI or base value.
      Specified by:
      instantiate in class Quantity<LuminousFlux,LuminousFlux.Unit>
      Parameters:
      si - the value expressed in the base (SI) unit
      Returns:
      a quantity with the given SI-value and base (SI) unit

    • siUnit

      public SIUnit siUnit()
      Description copied from class: Quantity
      Return the SI unit of this quantity.
      Overrides:
      siUnit in class Quantity<LuminousFlux,LuminousFlux.Unit>
      Returns:
      the SI unit of this quantity

    • valueOf

      public static LuminousFlux valueOf(String text)
      Returns a LuminousFlux 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 LuminousFlux
      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 LuminousFlux of(double value, String unitString)
      Returns a LuminousFlux based on a value and the textual representation of the unit, which can be localized.
      Parameters:
      value - the value to use
      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

    • divide

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

    • divide

      public final Illuminance divide(Area v)
      Calculate the division of LuminousFlux and Area, which results in a Illuminance scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of LuminousFlux and Area

    • divide

      public final Area divide(Illuminance v)
      Calculate the division of LuminousFlux and Illuminance, which results in a Area scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of LuminousFlux and Illuminance

    • divide

      public final SolidAngle divide(LuminousIntensity v)
      Calculate the division of LuminousFlux and LuminousIntensity, which results in a SolidAngle scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of LuminousFlux and LuminousIntensity

    • divide

      public final LuminousIntensity divide(SolidAngle v)
      Calculate the division of LuminousFlux and SolidAngle, which results in a LuminousIntensity scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of LuminousFlux and SolidAngle