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