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 * Electric charge denotes the electrostatic attraction or repulsion in the presence of other matter with charge, and is
15 * expressed in coulomb.
16 * <p>
17 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
18 * for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
19 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
20 * @author Alexander Verbraeck
21 */
22 public class ElectricCharge extends Quantity<ElectricCharge>
23 {
24 /** Constant with value zero. */
25 public static final ElectricCharge ZERO = ElectricCharge.ofSi(0.0);
26
27 /** Constant with value one. */
28 public static final ElectricCharge ONE = ElectricCharge.ofSi(1.0);
29
30 /** Constant with value NaN. */
31 @SuppressWarnings("checkstyle:constantname")
32 public static final ElectricCharge NaN = ElectricCharge.ofSi(Double.NaN);
33
34 /** Constant with value POSITIVE_INFINITY. */
35 public static final ElectricCharge POSITIVE_INFINITY = ElectricCharge.ofSi(Double.POSITIVE_INFINITY);
36
37 /** Constant with value NEGATIVE_INFINITY. */
38 public static final ElectricCharge NEGATIVE_INFINITY = ElectricCharge.ofSi(Double.NEGATIVE_INFINITY);
39
40 /** Constant with value MAX_VALUE. */
41 public static final ElectricCharge POS_MAXVALUE = ElectricCharge.ofSi(Double.MAX_VALUE);
42
43 /** Constant with value -MAX_VALUE. */
44 public static final ElectricCharge NEG_MAXVALUE = ElectricCharge.ofSi(-Double.MAX_VALUE);
45
46 /** */
47 private static final long serialVersionUID = 600L;
48
49 /**
50 * Instantiate a ElectricCharge quantity with a unit.
51 * @param valueInUnit the value, expressed in the unit
52 * @param unit the unit in which the value is expressed
53 */
54 public ElectricCharge(final double valueInUnit, final ElectricCharge.Unit unit)
55 {
56 super(valueInUnit, unit);
57 }
58
59 /**
60 * Instantiate a ElectricCharge quantity with a unit, expressed as a String.
61 * @param valueInUnit the value, expressed in the unit
62 * @param abbreviation the String abbreviation of the unit in which the value is expressed
63 */
64 public ElectricCharge(final double valueInUnit, final String abbreviation)
65 {
66 this(valueInUnit, Units.resolve(ElectricCharge.Unit.class, abbreviation));
67 }
68
69 /**
70 * Construct ElectricCharge quantity.
71 * @param value Scalar from which to construct this instance
72 */
73 public ElectricCharge(final ElectricCharge value)
74 {
75 super(value.si(), ElectricCharge.Unit.SI);
76 setDisplayUnit(value.getDisplayUnit());
77 }
78
79 /**
80 * Return a ElectricCharge instance based on an SI value.
81 * @param si the si value
82 * @return the ElectricCharge instance based on an SI value
83 */
84 public static ElectricCharge ofSi(final double si)
85 {
86 return new ElectricCharge(si, ElectricCharge.Unit.SI);
87 }
88
89 @Override
90 public ElectricCharge instantiateSi(final double si)
91 {
92 return ofSi(si);
93 }
94
95 @Override
96 public SIUnit siUnit()
97 {
98 return ElectricCharge.Unit.SI_UNIT;
99 }
100
101 /**
102 * Returns a ElectricCharge representation of a textual representation of a value with a unit. The String representation
103 * that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces
104 * are allowed, but not required, between the value and the unit.
105 * @param text the textual representation to parse into a ElectricCharge
106 * @return the Scalar representation of the value in its unit
107 * @throws IllegalArgumentException when the text cannot be parsed
108 * @throws NullPointerException when the text argument is null
109 */
110 public static ElectricCharge valueOf(final String text)
111 {
112 return Quantity.valueOf(text, ZERO);
113 }
114
115 /**
116 * Returns a ElectricCharge based on a value and the textual representation of the unit, which can be localized.
117 * @param valueInUnit the value, expressed in the unit as given by unitString
118 * @param unitString the textual representation of the unit
119 * @return the Scalar representation of the value in its unit
120 * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
121 * @throws NullPointerException when the unitString argument is null
122 */
123 public static ElectricCharge of(final double valueInUnit, final String unitString)
124 {
125 return Quantity.of(valueInUnit, unitString, ZERO);
126 }
127
128 @Override
129 public ElectricCharge.Unit getDisplayUnit()
130 {
131 return (ElectricCharge.Unit) super.getDisplayUnit();
132 }
133
134 /**
135 * Calculate the division of ElectricCharge and ElectricCharge, which results in a Dimensionless quantity.
136 * @param v quantity
137 * @return quantity as a division of ElectricCharge and ElectricCharge
138 */
139 public final Dimensionless divide(final ElectricCharge v)
140 {
141 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
142 }
143
144 /**
145 * Calculate the division of ElectricCharge and Duration, which results in a ElectricCurrent scalar.
146 * @param v scalar
147 * @return scalar as a division of ElectricCharge and Duration
148 */
149 public final ElectricCurrent divide(final Duration v)
150 {
151 return new ElectricCurrent(this.si() / v.si(), ElectricCurrent.Unit.SI);
152 }
153
154 /**
155 * Calculate the division of ElectricCharge and ElectricCurrent, which results in a Duration scalar.
156 * @param v scalar
157 * @return scalar as a division of ElectricCharge and ElectricCurrent
158 */
159 public final Duration divide(final ElectricCurrent v)
160 {
161 return new Duration(this.si() / v.si(), Duration.Unit.SI);
162 }
163
164 /**
165 * Calculate the division of ElectricCharge and ElectricPotential, which results in a ElectricalCapacitance scalar.
166 * @param v scalar
167 * @return scalar as a division of ElectricCharge and ElectricPotential
168 */
169 public final ElectricalCapacitance divide(final ElectricPotential v)
170 {
171 return new ElectricalCapacitance(this.si() / v.si(), ElectricalCapacitance.Unit.SI);
172 }
173
174 /**
175 * Calculate the division of ElectricCharge and ElectricalCapacitance, which results in a ElectricPotential scalar.
176 * @param v scalar
177 * @return scalar as a division of ElectricCharge and ElectricalCapacitance
178 */
179 public final ElectricPotential divide(final ElectricalCapacitance v)
180 {
181 return new ElectricPotential(this.si() / v.si(), ElectricPotential.Unit.SI);
182 }
183
184 /******************************************************************************************************/
185 /********************************************** UNIT CLASS ********************************************/
186 /******************************************************************************************************/
187
188 /**
189 * ElectricCharge.Unit is a unit of electric charge and is expressed in Coulomb.
190 * <p>
191 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
192 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
193 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
194 * @author Alexander Verbraeck
195 */
196 @SuppressWarnings("checkstyle:constantname")
197 public static class Unit extends AbstractUnit<ElectricCharge.Unit, ElectricCharge>
198 {
199 /** The dimensions of electric charge, the Coulumb, is A.s. */
200 public static final SIUnit SI_UNIT = SIUnit.of("As");
201
202 /** Gray. */
203 public static final ElectricCharge.Unit C = new ElectricCharge.Unit("C", "coulomb", 1.0, UnitSystem.SI_DERIVED);
204
205 /** The SI or BASE unit. */
206 public static final ElectricCharge.Unit SI = C.generateSiPrefixes(false, false);
207
208 /** milliCoulomb = mA.s. */
209 public static final ElectricCharge.Unit mC = Units.resolve(ElectricCharge.Unit.class, "mC");
210
211 /** microCoulomb = muA.s. */
212 public static final ElectricCharge.Unit muC = Units.resolve(ElectricCharge.Unit.class, "muC");
213
214 /** ampere hour. */
215 public static final ElectricCharge.Unit Ah = C.deriveUnit("Ah", "ampere hour", 3600.0, UnitSystem.SI_DERIVED);
216
217 /** milliampere hour. */
218 public static final ElectricCharge.Unit mAh = Ah.deriveUnit("mAh", "milliampere hour", 1E-3, UnitSystem.SI_DERIVED);
219
220 /** milliampere second. */
221 public static final ElectricCharge.Unit mAs =
222 mAh.deriveUnit("mAs", "milliampere second", 1.0 / 3600.0, UnitSystem.SI_DERIVED);
223
224 /** kiloampere hour. */
225 public static final ElectricCharge.Unit kAh = Ah.deriveUnit("kAh", "kiloampere hour", 1E3, UnitSystem.SI_DERIVED);
226
227 /** megaampere hour. */
228 public static final ElectricCharge.Unit MAh = Ah.deriveUnit("MAh", "megaampere hour", 1E6, UnitSystem.SI_DERIVED);
229
230 /** Faraday. */
231 public static final ElectricCharge.Unit F = C.deriveUnit("F", "faraday", 96485.3383, UnitSystem.OTHER);
232
233 /** atomic unit of charge. This value is exact since the 2019 redefinition of the SI base units. */
234 public static final ElectricCharge.Unit e =
235 C.deriveUnit("e", "elementary unit of charge", 1.602176634E-19, UnitSystem.SI_ACCEPTED);
236
237 /** statcoulomb (CGS ESU). */
238 public static final ElectricCharge.Unit statC = C.deriveUnit("statC", "statcoulomb", 3.335641E-10, UnitSystem.CGS_ESU);
239
240 /** franklin (CGS ESU). */
241 public static final ElectricCharge.Unit Fr = statC.deriveUnit("Fr", "franklin", 1.0, UnitSystem.CGS_ESU);
242
243 /** esu (CGS ESU). */
244 public static final ElectricCharge.Unit esu = statC.deriveUnit("esu", "electrostatic unit", 1.0, UnitSystem.CGS_ESU);
245
246 /** abcoulomb (CGS EMU). */
247 public static final ElectricCharge.Unit abC = C.deriveUnit("abC", "abcoulomb", 10.0, UnitSystem.CGS_EMU);
248
249 /** emu (CGS EMU). */
250 public static final ElectricCharge.Unit emu = abC.deriveUnit("emu", "electromagnetic unit", 1.0, UnitSystem.CGS_EMU);
251
252 /**
253 * Create a new ElectricCharge unit.
254 * @param id the id or main abbreviation of the unit
255 * @param name the full name of the unit
256 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
257 * @param unitSystem the unit system such as SI or IMPERIAL
258 */
259 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
260 {
261 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
262 }
263
264 /**
265 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
266 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
267 * @param displayAbbreviation the display abbreviation of the unit
268 * @param name the full name of the unit
269 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
270 * @param unitSystem unit system, e.g. SI or Imperial
271 */
272 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
273 final UnitSystem unitSystem)
274 {
275 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
276 }
277
278 @Override
279 public SIUnit siUnit()
280 {
281 return SI_UNIT;
282 }
283
284 @Override
285 public Unit getBaseUnit()
286 {
287 return SI;
288 }
289
290 @Override
291 public ElectricCharge ofSi(final double si)
292 {
293 return ElectricCharge.ofSi(si);
294 }
295
296 @Override
297 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
298 final double scaleFactor, final UnitSystem unitSystem)
299 {
300 if (getScale() instanceof LinearScale ls)
301 {
302 return new ElectricCharge.Unit(textualAbbreviation, displayAbbreviation, name,
303 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
304 }
305 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
306 }
307
308 }
309 }