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>
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 valueInUnit the value, expressed in the unit
52 * @param unit the unit in which the value is expressed
53 */
54 public ElectricPotential(final double valueInUnit, final ElectricPotential.Unit unit)
55 {
56 super(valueInUnit, unit);
57 }
58
59 /**
60 * Instantiate a ElectricPotential 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 ElectricPotential(final double valueInUnit, final String abbreviation)
65 {
66 this(valueInUnit, 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 instantiateSi(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 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 ElectricPotential of(final double valueInUnit, final String unitString)
124 {
125 return Quantity.of(valueInUnit, unitString, ZERO);
126 }
127
128 @Override
129 public ElectricPotential.Unit getDisplayUnit()
130 {
131 return (ElectricPotential.Unit) super.getDisplayUnit();
132 }
133
134 /**
135 * Calculate the division of ElectricPotential and ElectricPotential, which results in a Dimensionless quantity.
136 * @param v quantity
137 * @return quantity as a division of ElectricPotential and ElectricPotential
138 */
139 public final Dimensionless divide(final ElectricPotential v)
140 {
141 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
142 }
143
144 /**
145 * Calculate the multiplication of ElectricPotential and ElectricCurrent, which results in a Power scalar.
146 * @param v scalar
147 * @return scalar as a multiplication of ElectricPotential and ElectricCurrent
148 */
149 public final Power multiply(final ElectricCurrent v)
150 {
151 return new Power(this.si() * v.si(), Power.Unit.SI);
152 }
153
154 /**
155 * Calculate the division of ElectricPotential and ElectricCurrent, which results in a ElectricalResistance scalar.
156 * @param v scalar
157 * @return scalar as a division of ElectricPotential and ElectricCurrent
158 */
159 public final ElectricalResistance divide(final ElectricCurrent v)
160 {
161 return new ElectricalResistance(this.si() / v.si(), ElectricalResistance.Unit.SI);
162 }
163
164 /**
165 * Calculate the division of ElectricPotential and ElectricalResistance, which results in a ElectricCurrent scalar.
166 * @param v scalar
167 * @return scalar as a division of ElectricPotential and ElectricalResistance
168 */
169 public final ElectricCurrent divide(final ElectricalResistance v)
170 {
171 return new ElectricCurrent(this.si() / v.si(), ElectricCurrent.Unit.SI);
172 }
173
174 /******************************************************************************************************/
175 /********************************************** UNIT CLASS ********************************************/
176 /******************************************************************************************************/
177
178 /**
179 * ElectricPotential.Unit encodes the units of electric potential (difference)
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<ElectricPotential.Unit, ElectricPotential>
188 {
189 /** The dimensions of the electric potential: kgm2/s3A. */
190 public static final SIUnit SI_UNIT = SIUnit.of("kgm2/s3A");
191
192 /** Gray. */
193 public static final ElectricPotential.Unit V = new ElectricPotential.Unit("V", "volt", 1.0, UnitSystem.SI_DERIVED);
194
195 /** The SI or BASE unit. */
196 public static final ElectricPotential.Unit SI = V.generateSiPrefixes(false, false);
197
198 /** microvolt. */
199 public static final ElectricPotential.Unit muV = Units.resolve(ElectricPotential.Unit.class, "muV");
200
201 /** millivolt. */
202 public static final ElectricPotential.Unit mV = Units.resolve(ElectricPotential.Unit.class, "mV");
203
204 /** kilovolt. */
205 public static final ElectricPotential.Unit kV = Units.resolve(ElectricPotential.Unit.class, "kV");
206
207 /** megavolt. */
208 public static final ElectricPotential.Unit MV = Units.resolve(ElectricPotential.Unit.class, "MV");
209
210 /** gigavolt. */
211 public static final ElectricPotential.Unit GV = Units.resolve(ElectricPotential.Unit.class, "GV");
212
213 /** statvolt. */
214 public static final ElectricPotential.Unit statV = V.deriveUnit("statV", "statvolt", 299.792458, UnitSystem.CGS_ESU);
215
216 /** abvolt. */
217 public static final ElectricPotential.Unit abV = V.deriveUnit("abV", "abvolt", 1.0E-8, UnitSystem.CGS_EMU);
218
219 /**
220 * Create a new ElectricPotential unit.
221 * @param id the id or main abbreviation of the unit
222 * @param name the full name of the unit
223 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
224 * @param unitSystem the unit system such as SI or IMPERIAL
225 */
226 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
227 {
228 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
229 }
230
231 /**
232 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
233 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
234 * @param displayAbbreviation the display abbreviation of the unit
235 * @param name the full name of the unit
236 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
237 * @param unitSystem unit system, e.g. SI or Imperial
238 */
239 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
240 final UnitSystem unitSystem)
241 {
242 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
243 }
244
245 @Override
246 public SIUnit siUnit()
247 {
248 return SI_UNIT;
249 }
250
251 @Override
252 public Unit getBaseUnit()
253 {
254 return SI;
255 }
256
257 @Override
258 public ElectricPotential ofSi(final double si)
259 {
260 return ElectricPotential.ofSi(si);
261 }
262
263 @Override
264 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
265 final double scaleFactor, final UnitSystem unitSystem)
266 {
267 if (getScale() instanceof LinearScale ls)
268 {
269 return new ElectricPotential.Unit(textualAbbreviation, displayAbbreviation, name,
270 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
271 }
272 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
273 }
274
275 }
276 }