Package org.djunits.quantity

Class MagneticFlux

java.lang.Object

java.lang.Number

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

org.djunits.quantity.MagneticFlux

All Implemented Interfaces:

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

public class MagneticFlux
extends Quantity<MagneticFlux,MagneticFlux.Unit>

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.

Constructor Summary

Constructors

Constructor	Description
MagneticFlux(double value, String abbreviation)	Instantiate a MagneticFlux quantity with a unit, expressed as a String.
MagneticFlux(double value, MagneticFlux.Unit unit)	Instantiate a MagneticFlux quantity with a unit.
MagneticFlux(MagneticFlux value)	Construct MagneticFlux quantity.

Method Summary

Modifier and Type	Method	Description
final MagneticFluxDensity	divide(Area v)	Calculate the division of MagneticFlux and Area, which results in a MagneticFluxDensity scalar.
final ElectricPotential	divide(Duration v)	Calculate the division of MagneticFlux and Duration, which results in a ElectricPotential scalar.
final ElectricCurrent	divide(ElectricalInductance v)	Calculate the division of MagneticFlux and ElectricalInductance, which results in a ElectricCurrent scalar.
final ElectricalInductance	divide(ElectricCurrent v)	Calculate the division of MagneticFlux and ElectricCurrent, which results in a ElectricalInductance scalar.
final Duration	divide(ElectricPotential v)	Calculate the division of MagneticFlux and ElectricPotential, which results in a Duration scalar.
final Dimensionless	divide(MagneticFlux v)	Calculate the division of MagneticFlux and MagneticFlux, which results in a Dimensionless quantity.
final Area	divide(MagneticFluxDensity v)	Calculate the division of MagneticFlux and MagneticFluxDensity, which results in a Area scalar.
MagneticFlux	instantiate(double si)	Instantiate a quantity with an SI or base value.
static MagneticFlux	of(double value, String unitString)	Returns a MagneticFlux based on a value and the textual representation of the unit, which can be localized.
static MagneticFlux	ofSi(double si)	Return a MagneticFlux instance based on an SI value.
SIUnit	siUnit()	Return the SI unit of this quantity.
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, ge, ge0, getDisplayUnit, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, reciprocal, scaleBy, setDisplayUnit, si, subtract, sum, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString, 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, setDisplayUnit

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 unit)

Instantiate a MagneticFlux quantity with a unit.

Parameters:

value - the value, expressed in the unit

unit - the unit in which the value is expressed

MagneticFlux

public MagneticFlux(double value,
 String abbreviation)

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

MagneticFlux

public MagneticFlux(MagneticFlux value)

Construct MagneticFlux quantity.

Parameters:

value - Scalar from which to construct this instance

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

instantiate

public MagneticFlux instantiate(double si)

Description copied from class: Quantity

Instantiate a quantity with an SI or base value.

Specified by:

instantiate in class Quantity<MagneticFlux,MagneticFlux.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<MagneticFlux,MagneticFlux.Unit>

Returns:

the SI unit of this quantity

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 value,
 String unitString)

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