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