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