Package org.djunits.quantity

Class LuminousFlux

java.lang.Object

java.lang.Number

org.djunits.quantity.def.Quantity<LuminousFlux>

org.djunits.quantity.LuminousFlux

All Implemented Interfaces:

Serializable, Comparable<LuminousFlux>, Additive<LuminousFlux>, Scalable<LuminousFlux>, Value<LuminousFlux>

public class LuminousFlux
extends Quantity<LuminousFlux>

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:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LuminousFlux.Unit	LuminousFlux.Unit encodes the units of total perceived power of light emitted by a source.

Field Summary

Fields

Modifier and Type	Field	Description
static final LuminousFlux	NaN	Constant with value NaN.
static final LuminousFlux	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final LuminousFlux	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final LuminousFlux	ONE	Constant with value one.
static final LuminousFlux	POS_MAXVALUE	Constant with value MAX_VALUE.
static final LuminousFlux	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final LuminousFlux	ZERO	Constant with value zero.

Fields inherited from class org.djunits.quantity.def.Quantity

si

Constructor Summary

Constructors

Constructor	Description
LuminousFlux(double valueInUnit, LuminousFlux.Unit unit)	Instantiate a LuminousFlux quantity expressed in the given unit.
LuminousFlux(double value, LuminousFlux.Unit displayUnit, boolean useSi)	Instantiate a LuminousFlux quantity with an SI or base value and a display unit.

Method Summary

Modifier and Type	Method	Description
Illuminance	divide(Area v)	Calculate the division of LuminousFlux and Area, which results in a Illuminance scalar.
Area	divide(Illuminance v)	Calculate the division of LuminousFlux and Illuminance, which results in a Area scalar.
Dimensionless	divide(LuminousFlux v)	Calculate the division of LuminousFlux and LuminousFlux, which results in a Dimensionless quantity.
SolidAngle	divide(LuminousIntensity v)	Calculate the division of LuminousFlux and LuminousIntensity, which results in a SolidAngle scalar.
LuminousIntensity	divide(SolidAngle v)	Calculate the division of LuminousFlux and SolidAngle, which results in a LuminousIntensity scalar.
LuminousFlux.Unit	getDisplayUnit()	Retrieve the unit of this Value.
LuminousFlux	instantiateSi(double siValue, UnitInterface<LuminousFlux> displayUnit)	Instantiate a quantity with an SI or base value, and a display unit.
static LuminousFlux	of(double valueInUnit, String unitString)	Returns a LuminousFlux based on a value and the textual representation of the unit, which can be localized.
static LuminousFlux	of(double valueInUnit, LuminousFlux.Unit unit)	Returns a LuminousFlux based on a value expressed in the unit.
static LuminousFlux	ofSi(double si)	Return a LuminousFlux instance based on an SI value.
static LuminousFlux	ofSi(double siValue, LuminousFlux.Unit displayUnit)	Instantiate a LuminousFlux quantity with an SI or base value and a display unit.
static LuminousFlux	valueOf(String text)	Returns a LuminousFlux 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, format, ge, ge0, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, instantiateSi, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, reciprocal, scaleBy, si, siUnit, subtract, sum, toString, valueOf

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.Scalable

divideBy

Methods inherited from interface org.djunits.value.Value

isAbsolute

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 displayUnit,
 boolean useSi)

Instantiate a LuminousFlux 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

LuminousFlux

public LuminousFlux(double valueInUnit,
 LuminousFlux.Unit unit)

Instantiate a LuminousFlux 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 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

ofSi

public static LuminousFlux ofSi(double siValue,
 LuminousFlux.Unit displayUnit)

Instantiate a LuminousFlux 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 LuminousFlux instance based on an SI value with the given display unit

instantiateSi

public LuminousFlux instantiateSi(double siValue,
 UnitInterface<LuminousFlux> 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<LuminousFlux>

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 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 valueInUnit,
 LuminousFlux.Unit unit)

Returns a LuminousFlux 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 LuminousFlux representation of the value in its unit

of

public static LuminousFlux of(double valueInUnit,
 String unitString)

Returns a LuminousFlux 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 LuminousFlux.Unit getDisplayUnit()

Description copied from interface: Value

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<LuminousFlux>

Overrides:

getDisplayUnit in class Quantity<LuminousFlux>

Returns:

the unit of this Value

divide

public 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 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 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 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 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