Package org.djunits.quantity

Class MagneticFlux

java.lang.Object

java.lang.Number

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

org.djunits.quantity.MagneticFlux

All Implemented Interfaces:

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

public class MagneticFlux
extends Quantity<MagneticFlux>

Magnetic flux is the total magnetic field passing through a given area, measured in webers (Wb).

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	MagneticFlux.Unit	MagneticFlux.Unit encodes the units of total magnetic field passing through a given area.

Field Summary

Fields

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

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

si

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MagneticFluxDensity	divide(Area v)	Calculate the division of MagneticFlux and Area, which results in a MagneticFluxDensity scalar.
ElectricPotential	divide(Duration v)	Calculate the division of MagneticFlux and Duration, which results in a ElectricPotential scalar.
ElectricCurrent	divide(ElectricalInductance v)	Calculate the division of MagneticFlux and ElectricalInductance, which results in a ElectricCurrent scalar.
ElectricalInductance	divide(ElectricCurrent v)	Calculate the division of MagneticFlux and ElectricCurrent, which results in a ElectricalInductance scalar.
Duration	divide(ElectricPotential v)	Calculate the division of MagneticFlux and ElectricPotential, which results in a Duration scalar.
Dimensionless	divide(MagneticFlux v)	Calculate the division of MagneticFlux and MagneticFlux, which results in a Dimensionless quantity.
Area	divide(MagneticFluxDensity v)	Calculate the division of MagneticFlux and MagneticFluxDensity, which results in a Area scalar.
MagneticFlux.Unit	getDisplayUnit()	Retrieve the unit of this Value.
MagneticFlux	instantiateSi(double siValue, UnitInterface<MagneticFlux> displayUnit)	Instantiate a quantity with an SI or base value, and a display unit.
static MagneticFlux	of(double valueInUnit, String unitString)	Returns a MagneticFlux based on a value and the textual representation of the unit, which can be localized.
static MagneticFlux	of(double valueInUnit, MagneticFlux.Unit unit)	Returns a MagneticFlux based on a value expressed in the unit.
static MagneticFlux	ofSi(double si)	Return a MagneticFlux instance based on an SI value.
static MagneticFlux	ofSi(double siValue, MagneticFlux.Unit displayUnit)	Instantiate a MagneticFlux quantity with an SI or base value and a display unit.
static MagneticFlux	valueOf(String text)	Returns a MagneticFlux 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 MagneticFlux ZERO

Constant with value zero.

ONE

public static final MagneticFlux ONE

Constant with value one.

NaN

public static final MagneticFlux NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final MagneticFlux POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final MagneticFlux NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final MagneticFlux POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final MagneticFlux NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

MagneticFlux

public MagneticFlux(double value,
 MagneticFlux.Unit displayUnit,
 boolean useSi)

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

MagneticFlux

public MagneticFlux(double valueInUnit,
 MagneticFlux.Unit unit)

Instantiate a MagneticFlux 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 MagneticFlux ofSi(double si)

Return a MagneticFlux instance based on an SI value.

Parameters:

si - the si value

Returns:

the MagneticFlux instance based on an SI value

ofSi

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

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

instantiateSi

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

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 MagneticFlux valueOf(String text)

Returns a MagneticFlux 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 MagneticFlux

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 MagneticFlux of(double valueInUnit,
 MagneticFlux.Unit unit)

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

of

public static MagneticFlux of(double valueInUnit,
 String unitString)

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

Description copied from interface: Value

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<MagneticFlux>

Overrides:

getDisplayUnit in class Quantity<MagneticFlux>

Returns:

the unit of this Value

divide

public Dimensionless divide(MagneticFlux v)

Calculate the division of MagneticFlux and MagneticFlux, which results in a Dimensionless quantity.

Parameters:

v - quantity

Returns:

quantity as a division of MagneticFlux and MagneticFlux

divide

public Duration divide(ElectricPotential v)

Calculate the division of MagneticFlux and ElectricPotential, which results in a Duration scalar.

Parameters:

v - scalar

Returns:

scalar as a division of MagneticFlux and ElectricPotential

divide

public ElectricPotential divide(Duration v)

Calculate the division of MagneticFlux and Duration, which results in a ElectricPotential scalar.

Parameters:

v - scalar

Returns:

scalar as a division of MagneticFlux and Duration

divide

public MagneticFluxDensity divide(Area v)

Calculate the division of MagneticFlux and Area, which results in a MagneticFluxDensity scalar.

Parameters:

v - scalar

Returns:

scalar as a division of MagneticFlux and Area

divide

public Area divide(MagneticFluxDensity v)

Calculate the division of MagneticFlux and MagneticFluxDensity, which results in a Area scalar.

Parameters:

v - scalar

Returns:

scalar as a division of MagneticFlux and MagneticFluxDensity

divide

public ElectricalInductance divide(ElectricCurrent v)

Calculate the division of MagneticFlux and ElectricCurrent, which results in a ElectricalInductance scalar.

Parameters:

v - scalar

Returns:

scalar as a division of MagneticFlux and ElectricCurrent

divide

public ElectricCurrent divide(ElectricalInductance v)

Calculate the division of MagneticFlux and ElectricalInductance, which results in a ElectricCurrent scalar.

Parameters:

v - scalar

Returns:

scalar as a division of MagneticFlux and ElectricalInductance