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 * ElectricPotential is the difference in electric potential energy per unit of electric charge between two points in a static
15 * electric field.
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 ElectricPotential extends Quantity<ElectricPotential, ElectricPotential.Unit>
23 {
24 /** Constant with value zero. */
25 public static final ElectricPotential ZERO = ElectricPotential.ofSi(0.0);
26
27 /** Constant with value one. */
28 public static final ElectricPotential ONE = ElectricPotential.ofSi(1.0);
29
30 /** Constant with value NaN. */
31 @SuppressWarnings("checkstyle:constantname")
32 public static final ElectricPotential NaN = ElectricPotential.ofSi(Double.NaN);
33
34 /** Constant with value POSITIVE_INFINITY. */
35 public static final ElectricPotential POSITIVE_INFINITY = ElectricPotential.ofSi(Double.POSITIVE_INFINITY);
36
37 /** Constant with value NEGATIVE_INFINITY. */
38 public static final ElectricPotential NEGATIVE_INFINITY = ElectricPotential.ofSi(Double.NEGATIVE_INFINITY);
39
40 /** Constant with value MAX_VALUE. */
41 public static final ElectricPotential POS_MAXVALUE = ElectricPotential.ofSi(Double.MAX_VALUE);
42
43 /** Constant with value -MAX_VALUE. */
44 public static final ElectricPotential NEG_MAXVALUE = ElectricPotential.ofSi(-Double.MAX_VALUE);
45
46 /** */
47 private static final long serialVersionUID = 600L;
48
49 /**
50 * Instantiate a ElectricPotential quantity with a unit.
51 * @param value the value, expressed in the unit
52 * @param unit the unit in which the value is expressed
53 */
54 public ElectricPotential(final double value, final ElectricPotential.Unit unit)
55 {
56 super(value, unit);
57 }
58
59 /**
60 * Instantiate a ElectricPotential quantity with a unit, expressed as a String.
61 * @param value the value, expressed in the unit
62 * @param abbreviation the String abbreviation of the unit in which the value is expressed
63 */
64 public ElectricPotential(final double value, final String abbreviation)
65 {
66 this(value, Units.resolve(ElectricPotential.Unit.class, abbreviation));
67 }
68
69 /**
70 * Construct ElectricPotential quantity.
71 * @param value Scalar from which to construct this instance
72 */
73 public ElectricPotential(final ElectricPotential value)
74 {
75 super(value.si(), ElectricPotential.Unit.SI);
76 setDisplayUnit(value.getDisplayUnit());
77 }
78
79 /**
80 * Return a ElectricPotential instance based on an SI value.
81 * @param si the si value
82 * @return the ElectricPotential instance based on an SI value
83 */
84 public static ElectricPotential ofSi(final double si)
85 {
86 return new ElectricPotential(si, ElectricPotential.Unit.SI);
87 }
88
89 @Override
90 public ElectricPotential instantiate(final double si)
91 {
92 return ofSi(si);
93 }
94
95 @Override
96 public SIUnit siUnit()
97 {
98 return ElectricPotential.Unit.SI_UNIT;
99 }
100
101 /**
102 * Returns a ElectricPotential 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 ElectricPotential
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 ElectricPotential valueOf(final String text)
111 {
112 return Quantity.valueOf(text, ZERO);
113 }
114
115 /**
116 * Returns a ElectricPotential based on a value and the textual representation of the unit, which can be localized.
117 * @param value the value to use
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 ElectricPotential of(final double value, final String unitString)
124 {
125 return Quantity.of(value, unitString, ZERO);
126 }
127
128 /**
129 * Calculate the division of ElectricPotential and ElectricPotential, which results in a Dimensionless quantity.
130 * @param v quantity
131 * @return quantity as a division of ElectricPotential and ElectricPotential
132 */
133 public final Dimensionless divide(final ElectricPotential v)
134 {
135 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
136 }
137
138 /**
139 * Calculate the multiplication of ElectricPotential and ElectricCurrent, which results in a Power scalar.
140 * @param v scalar
141 * @return scalar as a multiplication of ElectricPotential and ElectricCurrent
142 */
143 public final Power multiply(final ElectricCurrent v)
144 {
145 return new Power(this.si() * v.si(), Power.Unit.SI);
146 }
147
148 /**
149 * Calculate the division of ElectricPotential and ElectricCurrent, which results in a ElectricalResistance scalar.
150 * @param v scalar
151 * @return scalar as a division of ElectricPotential and ElectricCurrent
152 */
153 public final ElectricalResistance divide(final ElectricCurrent v)
154 {
155 return new ElectricalResistance(this.si() / v.si(), ElectricalResistance.Unit.SI);
156 }
157
158 /**
159 * Calculate the division of ElectricPotential and ElectricalResistance, which results in a ElectricCurrent scalar.
160 * @param v scalar
161 * @return scalar as a division of ElectricPotential and ElectricalResistance
162 */
163 public final ElectricCurrent divide(final ElectricalResistance v)
164 {
165 return new ElectricCurrent(this.si() / v.si(), ElectricCurrent.Unit.SI);
166 }
167
168 /******************************************************************************************************/
169 /********************************************** UNIT CLASS ********************************************/
170 /******************************************************************************************************/
171
172 /**
173 * ElectricPotential.Unit encodes the units of electric potential (difference)
174 * <p>
175 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
176 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
177 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
178 * @author Alexander Verbraeck
179 */
180 @SuppressWarnings("checkstyle:constantname")
181 public static class Unit extends AbstractUnit<ElectricPotential.Unit, ElectricPotential>
182 {
183 /** The dimensions of the electric potential: kgm2/s3A. */
184 public static final SIUnit SI_UNIT = SIUnit.of("kgm2/s3A");
185
186 /** Gray. */
187 public static final ElectricPotential.Unit V = new ElectricPotential.Unit("V", "volt", 1.0, UnitSystem.SI_DERIVED);
188
189 /** The SI or BASE unit. */
190 public static final ElectricPotential.Unit SI = V.generateSiPrefixes(false, false);
191
192 /** microvolt. */
193 public static final ElectricPotential.Unit muV = Units.resolve(ElectricPotential.Unit.class, "muV");
194
195 /** millivolt. */
196 public static final ElectricPotential.Unit mV = Units.resolve(ElectricPotential.Unit.class, "mV");
197
198 /** kilovolt. */
199 public static final ElectricPotential.Unit kV = Units.resolve(ElectricPotential.Unit.class, "kV");
200
201 /** megavolt. */
202 public static final ElectricPotential.Unit MV = Units.resolve(ElectricPotential.Unit.class, "MV");
203
204 /** gigavolt. */
205 public static final ElectricPotential.Unit GV = Units.resolve(ElectricPotential.Unit.class, "GV");
206
207 /** statvolt. */
208 public static final ElectricPotential.Unit statV = V.deriveUnit("statV", "statvolt", 299.792458, UnitSystem.CGS_ESU);
209
210 /** abvolt. */
211 public static final ElectricPotential.Unit abV = V.deriveUnit("abV", "abvolt", 1.0E-8, UnitSystem.CGS_EMU);
212
213 /**
214 * Create a new ElectricPotential unit.
215 * @param id the id or main abbreviation of the unit
216 * @param name the full name of the unit
217 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
218 * @param unitSystem the unit system such as SI or IMPERIAL
219 */
220 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
221 {
222 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
223 }
224
225 /**
226 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
227 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
228 * @param displayAbbreviation the display abbreviation of the unit
229 * @param name the full name of the unit
230 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
231 * @param unitSystem unit system, e.g. SI or Imperial
232 */
233 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
234 final UnitSystem unitSystem)
235 {
236 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
237 }
238
239 @Override
240 public SIUnit siUnit()
241 {
242 return SI_UNIT;
243 }
244
245 @Override
246 public Unit getBaseUnit()
247 {
248 return SI;
249 }
250
251 @Override
252 public ElectricPotential ofSi(final double si)
253 {
254 return ElectricPotential.ofSi(si);
255 }
256
257 @Override
258 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
259 final double scaleFactor, final UnitSystem unitSystem)
260 {
261 if (getScale() instanceof LinearScale ls)
262 {
263 return new ElectricPotential.Unit(textualAbbreviation, displayAbbreviation, name,
264 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
265 }
266 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
267 }
268
269 }
270 }