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 density is the strength of the magnetic field per unit area, measured in teslas (T).
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 MagneticFluxDensity extends Quantity<MagneticFluxDensity>
22 {
23 /** Constant with value zero. */
24 public static final MagneticFluxDensity ZERO = ofSi(0.0);
25
26 /** Constant with value one. */
27 public static final MagneticFluxDensity ONE = ofSi(1.0);
28
29 /** Constant with value NaN. */
30 @SuppressWarnings("checkstyle:constantname")
31 public static final MagneticFluxDensity NaN = ofSi(Double.NaN);
32
33 /** Constant with value POSITIVE_INFINITY. */
34 public static final MagneticFluxDensity POSITIVE_INFINITY = ofSi(Double.POSITIVE_INFINITY);
35
36 /** Constant with value NEGATIVE_INFINITY. */
37 public static final MagneticFluxDensity NEGATIVE_INFINITY = ofSi(Double.NEGATIVE_INFINITY);
38
39 /** Constant with value MAX_VALUE. */
40 public static final MagneticFluxDensity POS_MAXVALUE = ofSi(Double.MAX_VALUE);
41
42 /** Constant with value -MAX_VALUE. */
43 public static final MagneticFluxDensity NEG_MAXVALUE = ofSi(-Double.MAX_VALUE);
44
45 /** */
46 private static final long serialVersionUID = 600L;
47
48 /**
49 * Instantiate a MagneticFluxDensity 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 MagneticFluxDensity(final double valueInUnit, final MagneticFluxDensity.Unit unit)
54 {
55 super(valueInUnit, unit);
56 }
57
58 /**
59 * Return a MagneticFluxDensity instance based on an SI value.
60 * @param si the si value
61 * @return the MagneticFluxDensity instance based on an SI value
62 */
63 public static MagneticFluxDensity ofSi(final double si)
64 {
65 return new MagneticFluxDensity(si, MagneticFluxDensity.Unit.SI);
66 }
67
68 @Override
69 public MagneticFluxDensity instantiateSi(final double si)
70 {
71 return ofSi(si);
72 }
73
74 @Override
75 public SIUnit siUnit()
76 {
77 return MagneticFluxDensity.Unit.SI_UNIT;
78 }
79
80 /**
81 * Returns a MagneticFluxDensity representation of a textual representation of a value with a unit. The String
82 * representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the
83 * unit. Spaces are allowed, but not required, between the value and the unit.
84 * @param text the textual representation to parse into a MagneticFluxDensity
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 MagneticFluxDensity valueOf(final String text)
90 {
91 return Quantity.valueOf(text, ZERO);
92 }
93
94 /**
95 * Returns a MagneticFluxDensity 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 MagneticFluxDensity of(final double valueInUnit, final String unitString)
103 {
104 return Quantity.of(valueInUnit, unitString, ZERO);
105 }
106
107 @Override
108 public MagneticFluxDensity.Unit getDisplayUnit()
109 {
110 return (MagneticFluxDensity.Unit) super.getDisplayUnit();
111 }
112
113 /**
114 * Calculate the division of MagneticFluxDensity and MagneticFluxDensity, which results in a Dimensionless quantity.
115 * @param v quantity
116 * @return quantity as a division of MagneticFluxDensity and MagneticFluxDensity
117 */
118 public final Dimensionless divide(final MagneticFluxDensity v)
119 {
120 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
121 }
122
123 /**
124 * Calculate the multiplication of MagneticFluxDensity and Area, which results in a MagneticFlux scalar.
125 * @param v scalar
126 * @return scalar as a multiplication of MagneticFluxDensity and Area
127 */
128 public final MagneticFlux multiply(final Area v)
129 {
130 return new MagneticFlux(this.si() * v.si(), MagneticFlux.Unit.SI);
131 }
132
133 /******************************************************************************************************/
134 /********************************************** UNIT CLASS ********************************************/
135 /******************************************************************************************************/
136
137 /**
138 * MagneticFluxDensity.Unit encodes the units of strength of the magnetic field per unit area.
139 * <p>
140 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
141 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
142 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
143 * @author Alexander Verbraeck
144 */
145 @SuppressWarnings("checkstyle:constantname")
146 public static class Unit extends AbstractUnit<MagneticFluxDensity.Unit, MagneticFluxDensity>
147 {
148 /** The dimensions of the magnetic flux density: kg/s2A. */
149 public static final SIUnit SI_UNIT = SIUnit.of("kg/s2A");
150
151 /** Tesla. */
152 public static final MagneticFluxDensity.Unit T = new MagneticFluxDensity.Unit("T", "tesla", 1.0, UnitSystem.SI_DERIVED);
153
154 /** The SI or BASE unit. */
155 public static final MagneticFluxDensity.Unit SI = T.generateSiPrefixes(false, false);
156
157 /** mT. */
158 public static final MagneticFluxDensity.Unit mT = Units.resolve(MagneticFluxDensity.Unit.class, "mT");
159
160 /** muT. */
161 public static final MagneticFluxDensity.Unit muT = Units.resolve(MagneticFluxDensity.Unit.class, "muT");
162
163 /** nT. */
164 public static final MagneticFluxDensity.Unit nT = Units.resolve(MagneticFluxDensity.Unit.class, "nT");
165
166 /** Gauss. */
167 public static final MagneticFluxDensity.Unit G = T.deriveUnit("G", "gauss", 1.0E-4, UnitSystem.CGS);
168
169 /**
170 * Create a new MagneticFluxDensity unit.
171 * @param id the id or main abbreviation of the unit
172 * @param name the full name of the unit
173 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
174 * @param unitSystem the unit system such as SI or IMPERIAL
175 */
176 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
177 {
178 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
179 }
180
181 /**
182 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
183 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
184 * @param displayAbbreviation the display abbreviation of the unit
185 * @param name the full name of the unit
186 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
187 * @param unitSystem unit system, e.g. SI or Imperial
188 */
189 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
190 final UnitSystem unitSystem)
191 {
192 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
193 }
194
195 @Override
196 public SIUnit siUnit()
197 {
198 return SI_UNIT;
199 }
200
201 @Override
202 public Unit getBaseUnit()
203 {
204 return SI;
205 }
206
207 @Override
208 public MagneticFluxDensity ofSi(final double si)
209 {
210 return MagneticFluxDensity.ofSi(si);
211 }
212
213 @Override
214 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
215 final double scaleFactor, final UnitSystem unitSystem)
216 {
217 if (getScale() instanceof LinearScale ls)
218 {
219 return new MagneticFluxDensity.Unit(textualAbbreviation, displayAbbreviation, name,
220 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
221 }
222 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
223 }
224
225 }
226 }