1 package org.djunits.quantity;
2
3 import org.djunits.quantity.def.Quantity;
4 import org.djunits.unit.AbstractUnit;
5 import org.djunits.unit.UnitInterface;
6 import org.djunits.unit.UnitRuntimeException;
7 import org.djunits.unit.Unitless;
8 import org.djunits.unit.Units;
9 import org.djunits.unit.scale.IdentityScale;
10 import org.djunits.unit.scale.LinearScale;
11 import org.djunits.unit.scale.Scale;
12 import org.djunits.unit.si.SIPrefix;
13 import org.djunits.unit.si.SIPrefixes;
14 import org.djunits.unit.si.SIUnit;
15 import org.djunits.unit.system.UnitSystem;
16
17 /**
18 * Magnetic flux is the total magnetic field passing through a given area, measured in webers (Wb).
19 * <p>
20 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
21 * for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
22 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
23 * @author Alexander Verbraeck
24 */
25 public class MagneticFlux extends Quantity<MagneticFlux>
26 {
27 /** Constant with value zero. */
28 public static final MagneticFlux ZERO = ofSi(0.0);
29
30 /** Constant with value one. */
31 public static final MagneticFlux ONE = ofSi(1.0);
32
33 /** Constant with value NaN. */
34 @SuppressWarnings("checkstyle:constantname")
35 public static final MagneticFlux NaN = ofSi(Double.NaN);
36
37 /** Constant with value POSITIVE_INFINITY. */
38 public static final MagneticFlux POSITIVE_INFINITY = ofSi(Double.POSITIVE_INFINITY);
39
40 /** Constant with value NEGATIVE_INFINITY. */
41 public static final MagneticFlux NEGATIVE_INFINITY = ofSi(Double.NEGATIVE_INFINITY);
42
43 /** Constant with value MAX_VALUE. */
44 public static final MagneticFlux POS_MAXVALUE = ofSi(Double.MAX_VALUE);
45
46 /** Constant with value -MAX_VALUE. */
47 public static final MagneticFlux NEG_MAXVALUE = ofSi(-Double.MAX_VALUE);
48
49 /** */
50 private static final long serialVersionUID = 600L;
51
52 /**
53 * Instantiate a MagneticFlux quantity with an SI or base value and a display unit.
54 * @param value the quantity value expressed in the SI or base unit
55 * @param displayUnit the display unit to use
56 * @param useSi use SI value when true, use value in unit when false
57 */
58 public MagneticFlux(final double value, final MagneticFlux.Unit displayUnit, final boolean useSi)
59 {
60 super(value, displayUnit, useSi);
61 }
62
63 /**
64 * Instantiate a MagneticFlux quantity expressed in the given unit.
65 * @param valueInUnit the quantity value expressed in the given unit
66 * @param unit the unit of the value, also acts as the display unit
67 */
68 public MagneticFlux(final double valueInUnit, final MagneticFlux.Unit unit)
69 {
70 this(valueInUnit, unit, false);
71 }
72
73 /**
74 * Return a MagneticFlux instance based on an SI value.
75 * @param si the si value
76 * @return the MagneticFlux instance based on an SI value
77 */
78 public static MagneticFlux ofSi(final double si)
79 {
80 return new MagneticFlux(si, MagneticFlux.Unit.SI, true);
81 }
82
83 /**
84 * Instantiate a MagneticFlux quantity with an SI or base value and a display unit.
85 * @param siValue the quantity value expressed in the SI or base unit
86 * @param displayUnit the display unit to use
87 * @return the MagneticFlux instance based on an SI value with the given display unit
88 */
89 public static MagneticFlux ofSi(final double siValue, final MagneticFlux.Unit displayUnit)
90 {
91 return new MagneticFlux(siValue, displayUnit, true);
92 }
93
94 @Override
95 public MagneticFlux instantiateSi(final double siValue, final UnitInterface<MagneticFlux> displayUnit)
96 {
97 return new MagneticFlux(siValue, (MagneticFlux.Unit) displayUnit, true);
98 }
99
100 /**
101 * Returns a MagneticFlux representation of a textual representation of a value with a unit. The String representation that
102 * can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are
103 * allowed, but not required, between the value and the unit.
104 * @param text the textual representation to parse into a MagneticFlux
105 * @return the Scalar representation of the value in its unit
106 * @throws IllegalArgumentException when the text cannot be parsed
107 * @throws NullPointerException when the text argument is null
108 */
109 public static MagneticFlux valueOf(final String text)
110 {
111 return Quantity.valueOf(text, ZERO);
112 }
113
114 /**
115 * Returns a MagneticFlux based on a value expressed in the unit.
116 * @param valueInUnit the value, expressed in the given unit
117 * @param unit the unit of the value, also acts as the display unit
118 * @return ab MagneticFlux representation of the value in its unit
119 */
120 public static MagneticFlux of(final double valueInUnit, final MagneticFlux.Unit unit)
121 {
122 return new MagneticFlux(valueInUnit, unit);
123 }
124
125 /**
126 * Returns a MagneticFlux based on a value and the textual representation of the unit, which can be localized.
127 * @param valueInUnit the value, expressed in the unit as given by unitString
128 * @param unitString the textual representation of the unit
129 * @return the Scalar representation of the value in its unit
130 * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
131 * @throws NullPointerException when the unitString argument is null
132 */
133 public static MagneticFlux of(final double valueInUnit, final String unitString)
134 {
135 return Quantity.of(valueInUnit, unitString, ZERO);
136 }
137
138 @Override
139 public MagneticFlux.Unit getDisplayUnit()
140 {
141 return (MagneticFlux.Unit) super.getDisplayUnit();
142 }
143
144 /**
145 * Calculate the division of MagneticFlux and MagneticFlux, which results in a Dimensionless quantity.
146 * @param v quantity
147 * @return quantity as a division of MagneticFlux and MagneticFlux
148 */
149 public Dimensionless divide(final MagneticFlux v)
150 {
151 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
152 }
153
154 /**
155 * Calculate the division of MagneticFlux and ElectricPotential, which results in a Duration scalar.
156 * @param v scalar
157 * @return scalar as a division of MagneticFlux and ElectricPotential
158 */
159 public Duration divide(final ElectricPotential v)
160 {
161 return new Duration(this.si() / v.si(), Duration.Unit.SI);
162 }
163
164 /**
165 * Calculate the division of MagneticFlux and Duration, which results in a ElectricPotential scalar.
166 * @param v scalar
167 * @return scalar as a division of MagneticFlux and Duration
168 */
169 public ElectricPotential divide(final Duration v)
170 {
171 return new ElectricPotential(this.si() / v.si(), ElectricPotential.Unit.SI);
172 }
173
174 /**
175 * Calculate the division of MagneticFlux and Area, which results in a MagneticFluxDensity scalar.
176 * @param v scalar
177 * @return scalar as a division of MagneticFlux and Area
178 */
179 public MagneticFluxDensity divide(final Area v)
180 {
181 return new MagneticFluxDensity(this.si() / v.si(), MagneticFluxDensity.Unit.SI);
182 }
183
184 /**
185 * Calculate the division of MagneticFlux and MagneticFluxDensity, which results in a Area scalar.
186 * @param v scalar
187 * @return scalar as a division of MagneticFlux and MagneticFluxDensity
188 */
189 public Area divide(final MagneticFluxDensity v)
190 {
191 return new Area(this.si() / v.si(), Area.Unit.SI);
192 }
193
194 /**
195 * Calculate the division of MagneticFlux and ElectricCurrent, which results in a ElectricalInductance scalar.
196 * @param v scalar
197 * @return scalar as a division of MagneticFlux and ElectricCurrent
198 */
199 public ElectricalInductance divide(final ElectricCurrent v)
200 {
201 return new ElectricalInductance(this.si() / v.si(), ElectricalInductance.Unit.SI);
202 }
203
204 /**
205 * Calculate the division of MagneticFlux and ElectricalInductance, which results in a ElectricCurrent scalar.
206 * @param v scalar
207 * @return scalar as a division of MagneticFlux and ElectricalInductance
208 */
209 public ElectricCurrent divide(final ElectricalInductance v)
210 {
211 return new ElectricCurrent(this.si() / v.si(), ElectricCurrent.Unit.SI);
212 }
213
214 /******************************************************************************************************/
215 /********************************************** UNIT CLASS ********************************************/
216 /******************************************************************************************************/
217
218 /**
219 * MagneticFlux.Unit encodes the units of total magnetic field passing through a given area.
220 * <p>
221 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
222 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
223 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
224 * @author Alexander Verbraeck
225 */
226 @SuppressWarnings("checkstyle:constantname")
227 public static class Unit extends AbstractUnit<MagneticFlux>
228 {
229 /** The dimensions of the magnetic flux: kgm2/s2A. */
230 public static final SIUnit SI_UNIT = SIUnit.of("kgm2/s2A");
231
232 /** Weber. */
233 public static final MagneticFlux.Unit Wb = new MagneticFlux.Unit("Wb", "Wb", "weber", IdentityScale.SCALE,
234 UnitSystem.SI_DERIVED, SIPrefixes.getSiPrefix(""));
235
236 /** The SI or BASE unit. */
237 public static final MagneticFlux.Unit SI = (Unit) Wb.generateSiPrefixes(false, false);
238
239 /** mWb. */
240 public static final MagneticFlux.Unit mWb = Units.resolve(MagneticFlux.Unit.class, "mWb");
241
242 /** muWb. */
243 public static final MagneticFlux.Unit muWb = Units.resolve(MagneticFlux.Unit.class, "muWb");
244
245 /** nWb. */
246 public static final MagneticFlux.Unit nWb = Units.resolve(MagneticFlux.Unit.class, "nWb");
247
248 /** Maxwell. */
249 public static final MagneticFlux.Unit Mx = Wb.deriveUnit("Mx", "Mx", "Maxwell", 1.0E-8, UnitSystem.CGS, null);
250
251 /**
252 * Create a new MagneticFlux unit.
253 * @param id the id or main abbreviation of the unit
254 * @param name the full name of the unit
255 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
256 * @param unitSystem the unit system such as SI or IMPERIAL
257 */
258 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
259 {
260 super(id, name, scaleFactorToBaseUnit, unitSystem);
261 }
262
263 /**
264 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
265 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
266 * @param displayAbbreviation the display abbreviation of the unit
267 * @param name the full name of the unit
268 * @param scale the scale to use to convert from this unit to the standard (e.g., SI, BASE) unit
269 * @param unitSystem unit system, e.g. SI or Imperial
270 * @param siPrefix the SI Prefix of this unit
271 */
272 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
273 final UnitSystem unitSystem, final SIPrefix siPrefix)
274 {
275 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem, siPrefix);
276 }
277
278 @Override
279 public SIUnit siUnit()
280 {
281 return SI_UNIT;
282 }
283
284 @Override
285 public Unit getBaseUnit()
286 {
287 return SI;
288 }
289
290 @Override
291 public MagneticFlux ofSi(final double si, final UnitInterface<MagneticFlux> displayUnit)
292 {
293 return new MagneticFlux(si, (Unit) displayUnit, true);
294 }
295
296 @Override
297 public MagneticFlux.Unit deriveUnit(final String abbreviation, final String name, final double scaleFactor,
298 final UnitSystem unitSystem)
299 {
300 return (Unit) super.deriveUnit(abbreviation, name, scaleFactor, unitSystem);
301 }
302
303 @Override
304 public MagneticFlux.Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation,
305 final String name, final double scaleFactor, final UnitSystem unitSystem, final SIPrefix siPrefix)
306 {
307 if (getScale() instanceof LinearScale ls)
308 {
309 return new MagneticFlux.Unit(textualAbbreviation, displayAbbreviation, name,
310 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem, siPrefix);
311 }
312 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
313 }
314
315 }
316
317 }