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