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 * ElectricCurrent is the net rate of flow of electric charge through a surface.
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 ElectricCurrent extends Quantity<ElectricCurrent>
22 {
23 /** Constant with value zero. */
24 public static final ElectricCurrent ZERO = ElectricCurrent.ofSi(0.0);
25
26 /** Constant with value one. */
27 public static final ElectricCurrent ONE = ElectricCurrent.ofSi(1.0);
28
29 /** Constant with value NaN. */
30 @SuppressWarnings("checkstyle:constantname")
31 public static final ElectricCurrent NaN = ElectricCurrent.ofSi(Double.NaN);
32
33 /** Constant with value POSITIVE_INFINITY. */
34 public static final ElectricCurrent POSITIVE_INFINITY = ElectricCurrent.ofSi(Double.POSITIVE_INFINITY);
35
36 /** Constant with value NEGATIVE_INFINITY. */
37 public static final ElectricCurrent NEGATIVE_INFINITY = ElectricCurrent.ofSi(Double.NEGATIVE_INFINITY);
38
39 /** Constant with value MAX_VALUE. */
40 public static final ElectricCurrent POS_MAXVALUE = ElectricCurrent.ofSi(Double.MAX_VALUE);
41
42 /** Constant with value -MAX_VALUE. */
43 public static final ElectricCurrent NEG_MAXVALUE = ElectricCurrent.ofSi(-Double.MAX_VALUE);
44
45 /** */
46 private static final long serialVersionUID = 600L;
47
48 /**
49 * Instantiate a ElectricCurrent 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 ElectricCurrent(final double valueInUnit, final ElectricCurrent.Unit unit)
54 {
55 super(valueInUnit, unit);
56 }
57
58 /**
59 * Instantiate a ElectricCurrent quantity with a unit, expressed as a String.
60 * @param valueInUnit the value, expressed in the unit
61 * @param abbreviation the String abbreviation of the unit in which the value is expressed
62 */
63 public ElectricCurrent(final double valueInUnit, final String abbreviation)
64 {
65 this(valueInUnit, Units.resolve(ElectricCurrent.Unit.class, abbreviation));
66 }
67
68 /**
69 * Construct ElectricCurrent quantity.
70 * @param value Scalar from which to construct this instance
71 */
72 public ElectricCurrent(final ElectricCurrent value)
73 {
74 super(value.si(), ElectricCurrent.Unit.SI);
75 setDisplayUnit(value.getDisplayUnit());
76 }
77
78 /**
79 * Return a ElectricCurrent instance based on an SI value.
80 * @param si the si value
81 * @return the ElectricCurrent instance based on an SI value
82 */
83 public static ElectricCurrent ofSi(final double si)
84 {
85 return new ElectricCurrent(si, ElectricCurrent.Unit.SI);
86 }
87
88 @Override
89 public ElectricCurrent instantiateSi(final double si)
90 {
91 return ofSi(si);
92 }
93
94 @Override
95 public SIUnit siUnit()
96 {
97 return ElectricCurrent.Unit.SI_UNIT;
98 }
99
100 /**
101 * Returns a ElectricCurrent representation of a textual representation of a value with a unit. The String representation
102 * that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces
103 * are allowed, but not required, between the value and the unit.
104 * @param text the textual representation to parse into a ElectricCurrent
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 ElectricCurrent valueOf(final String text)
110 {
111 return Quantity.valueOf(text, ZERO);
112 }
113
114 /**
115 * Returns a ElectricCurrent based on a value and the textual representation of the unit, which can be localized.
116 * @param valueInUnit the value, expressed in the unit as given by unitString
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 ElectricCurrent of(final double valueInUnit, final String unitString)
123 {
124 return Quantity.of(valueInUnit, unitString, ZERO);
125 }
126
127 @Override
128 public ElectricCurrent.Unit getDisplayUnit()
129 {
130 return (ElectricCurrent.Unit) super.getDisplayUnit();
131 }
132
133 /**
134 * Calculate the division of ElectricCurrent and ElectricCurrent, which results in a Dimensionless quantity.
135 * @param v quantity
136 * @return quantity as a division of ElectricCurrent and ElectricCurrent
137 */
138 public final Dimensionless divide(final ElectricCurrent v)
139 {
140 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
141 }
142
143 /**
144 * Calculate the multiplication of ElectricalCurrent and ElectricalPotential, which results in a Power scalar.
145 * @param v scalar
146 * @return scalar as a multiplication of ElectricalCurrent and ElectricalPotential
147 */
148 public final Power multiply(final ElectricPotential v)
149 {
150 return new Power(this.si() * v.si(), Power.Unit.SI);
151 }
152
153 /**
154 * Calculate the multiplication of ElectricalCurrent and Duration, which results in a ElectricalCharge scalar.
155 * @param v scalar
156 * @return scalar as a multiplication of ElectricalCurrent and Duration
157 */
158 public final ElectricCharge multiply(final Duration v)
159 {
160 return new ElectricCharge(this.si() * v.si(), ElectricCharge.Unit.SI);
161 }
162
163 /**
164 * Calculate the multiplication of ElectricalCurrent and ElectricalResistance, which results in a ElectricalPotential
165 * scalar.
166 * @param v scalar
167 * @return scalar as a multiplication of ElectricalCurrent and ElectricalResistance
168 */
169 public final ElectricPotential multiply(final ElectricalResistance v)
170 {
171 return new ElectricPotential(this.si() * v.si(), ElectricPotential.Unit.SI);
172 }
173
174 /**
175 * Calculate the division of ElectricalCurrent and ElectricalPotential, which results in a ElectricalConductance scalar.
176 * @param v scalar
177 * @return scalar as a division of ElectricalCurrent and ElectricalPotential
178 */
179 public final ElectricalConductance divide(final ElectricPotential v)
180 {
181 return new ElectricalConductance(this.si() / v.si(), ElectricalConductance.Unit.SI);
182 }
183
184 /**
185 * Calculate the division of ElectricalCurrent and ElectricalConductance, which results in a ElectricalPotential scalar.
186 * @param v scalar
187 * @return scalar as a division of ElectricalCurrent and ElectricalConductance
188 */
189 public final ElectricPotential divide(final ElectricalConductance v)
190 {
191 return new ElectricPotential(this.si() / v.si(), ElectricPotential.Unit.SI);
192 }
193
194 /******************************************************************************************************/
195 /********************************************** UNIT CLASS ********************************************/
196 /******************************************************************************************************/
197
198 /**
199 * ElectricCurrent.Unit encodes the units of electric current (A).
200 * <p>
201 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
202 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
203 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
204 * @author Alexander Verbraeck
205 */
206 @SuppressWarnings("checkstyle:constantname")
207 public static class Unit extends AbstractUnit<ElectricCurrent.Unit, ElectricCurrent>
208 {
209 /** The dimensions of electric current: A. */
210 public static final SIUnit SI_UNIT = SIUnit.of("A");
211
212 /** ampere. */
213 public static final ElectricCurrent.Unit A = new ElectricCurrent.Unit("A", "ampere", 1.0, UnitSystem.SI_BASE);
214
215 /** The SI or BASE unit. */
216 public static final ElectricCurrent.Unit SI = A.generateSiPrefixes(false, false);
217
218 /** microampere. */
219 public static final ElectricCurrent.Unit muA = Units.resolve(ElectricCurrent.Unit.class, "muA");
220
221 /** milliampere. */
222 public static final ElectricCurrent.Unit mA = Units.resolve(ElectricCurrent.Unit.class, "mA");
223
224 /** kiloampere. */
225 public static final ElectricCurrent.Unit kA = Units.resolve(ElectricCurrent.Unit.class, "kA");
226
227 /** megaampere. */
228 public static final ElectricCurrent.Unit MA = Units.resolve(ElectricCurrent.Unit.class, "MA");
229
230 /** statampere (GCS ESU). */
231 public static final ElectricCurrent.Unit statA = A.deriveUnit("statA", "statampere", 3.335641E-10, UnitSystem.CGS_ESU);
232
233 /** abampere (GCS EMU). */
234 public static final ElectricCurrent.Unit abA = A.deriveUnit("abA", "abampere", 10.0, UnitSystem.CGS_EMU);
235
236 /**
237 * Create a new ElectricCurrent unit.
238 * @param id the id or main abbreviation of the unit
239 * @param name the full name of the unit
240 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
241 * @param unitSystem the unit system such as SI or IMPERIAL
242 */
243 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
244 {
245 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
246 }
247
248 /**
249 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
250 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
251 * @param displayAbbreviation the display abbreviation of the unit
252 * @param name the full name of the unit
253 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
254 * @param unitSystem unit system, e.g. SI or Imperial
255 */
256 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
257 final UnitSystem unitSystem)
258 {
259 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
260 }
261
262 @Override
263 public SIUnit siUnit()
264 {
265 return SI_UNIT;
266 }
267
268 @Override
269 public Unit getBaseUnit()
270 {
271 return SI;
272 }
273
274 @Override
275 public ElectricCurrent ofSi(final double si)
276 {
277 return ElectricCurrent.ofSi(si);
278 }
279
280 @Override
281 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
282 final double scaleFactor, final UnitSystem unitSystem)
283 {
284 if (getScale() instanceof LinearScale ls)
285 {
286 return new ElectricCurrent.Unit(textualAbbreviation, displayAbbreviation, name,
287 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
288 }
289 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
290 }
291
292 }
293 }