1 package org.djunits.quantity;
2
3 import org.djunits.quantity.def.Quantity;
4 import org.djunits.unit.AbstractUnit;
5 import org.djunits.unit.UnitInterface;
6 import org.djunits.unit.UnitRuntimeException;
7 import org.djunits.unit.Unitless;
8 import org.djunits.unit.Units;
9 import org.djunits.unit.scale.IdentityScale;
10 import org.djunits.unit.scale.LinearScale;
11 import org.djunits.unit.scale.Scale;
12 import org.djunits.unit.si.SIPrefix;
13 import org.djunits.unit.si.SIPrefixes;
14 import org.djunits.unit.si.SIUnit;
15 import org.djunits.unit.system.UnitSystem;
16
17 /**
18 * ElectricalCapacitance denotes the ability of an object to store electric charge, and is expressed in farad.
19 * <p>
20 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
21 * for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
22 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
23 * @author Alexander Verbraeck
24 */
25 public class ElectricalCapacitance extends Quantity<ElectricalCapacitance>
26 {
27 /** Constant with value zero. */
28 public static final ElectricalCapacitance ZERO = ofSi(0.0);
29
30 /** Constant with value one. */
31 public static final ElectricalCapacitance ONE = ofSi(1.0);
32
33 /** Constant with value NaN. */
34 @SuppressWarnings("checkstyle:constantname")
35 public static final ElectricalCapacitance NaN = ofSi(Double.NaN);
36
37 /** Constant with value POSITIVE_INFINITY. */
38 public static final ElectricalCapacitance POSITIVE_INFINITY = ofSi(Double.POSITIVE_INFINITY);
39
40 /** Constant with value NEGATIVE_INFINITY. */
41 public static final ElectricalCapacitance NEGATIVE_INFINITY = ofSi(Double.NEGATIVE_INFINITY);
42
43 /** Constant with value MAX_VALUE. */
44 public static final ElectricalCapacitance POS_MAXVALUE = ofSi(Double.MAX_VALUE);
45
46 /** Constant with value -MAX_VALUE. */
47 public static final ElectricalCapacitance NEG_MAXVALUE = ofSi(-Double.MAX_VALUE);
48
49 /** */
50 private static final long serialVersionUID = 600L;
51
52 /**
53 * Instantiate a ElectricalCapacitance quantity with an SI or base value and a display unit.
54 * @param value the quantity value expressed in the SI or base unit
55 * @param displayUnit the display unit to use
56 * @param useSi use SI value when true, use value in unit when false
57 */
58 public ElectricalCapacitance(final double value, final ElectricalCapacitance.Unit displayUnit, final boolean useSi)
59 {
60 super(value, displayUnit, useSi);
61 }
62
63 /**
64 * Instantiate a ElectricalCapacitance quantity expressed in the given unit.
65 * @param valueInUnit the quantity value expressed in the given unit
66 * @param unit the unit of the value, also acts as the display unit
67 */
68 public ElectricalCapacitance(final double valueInUnit, final ElectricalCapacitance.Unit unit)
69 {
70 this(valueInUnit, unit, false);
71 }
72
73 /**
74 * Return a ElectricalCapacitance instance based on an SI value.
75 * @param si the si value
76 * @return the ElectricalCapacitance instance based on an SI value
77 */
78 public static ElectricalCapacitance ofSi(final double si)
79 {
80 return new ElectricalCapacitance(si, ElectricalCapacitance.Unit.SI, true);
81 }
82
83 /**
84 * Instantiate a ElectricalCapacitance quantity with an SI or base value and a display unit.
85 * @param siValue the quantity value expressed in the SI or base unit
86 * @param displayUnit the display unit to use
87 * @return the ElectricalCapacitance instance based on an SI value with the given display unit
88 */
89 public static ElectricalCapacitance ofSi(final double siValue, final ElectricalCapacitance.Unit displayUnit)
90 {
91 return new ElectricalCapacitance(siValue, displayUnit, true);
92 }
93
94 @Override
95 public ElectricalCapacitance instantiateSi(final double siValue, final UnitInterface<ElectricalCapacitance> displayUnit)
96 {
97 return new ElectricalCapacitance(siValue, (ElectricalCapacitance.Unit) displayUnit, true);
98 }
99
100 /**
101 * Returns a ElectricalCapacitance representation of a textual representation of a value with a unit. The String
102 * representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the
103 * unit. Spaces are allowed, but not required, between the value and the unit.
104 * @param text the textual representation to parse into a ElectricalCapacitance
105 * @return the Scalar representation of the value in its unit
106 * @throws IllegalArgumentException when the text cannot be parsed
107 * @throws NullPointerException when the text argument is null
108 */
109 public static ElectricalCapacitance valueOf(final String text)
110 {
111 return Quantity.valueOf(text, ZERO);
112 }
113
114 /**
115 * Returns a ElectricalCapacitance based on a value expressed in the unit.
116 * @param valueInUnit the value, expressed in the given unit
117 * @param unit the unit of the value, also acts as the display unit
118 * @return ab ElectricalCapacitance representation of the value in its unit
119 */
120 public static ElectricalCapacitance of(final double valueInUnit, final ElectricalCapacitance.Unit unit)
121 {
122 return new ElectricalCapacitance(valueInUnit, unit);
123 }
124
125 /**
126 * Returns a ElectricalCapacitance based on a value and the textual representation of the unit, which can be localized.
127 * @param valueInUnit the value, expressed in the unit as given by unitString
128 * @param unitString the textual representation of the unit
129 * @return the Scalar representation of the value in its unit
130 * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
131 * @throws NullPointerException when the unitString argument is null
132 */
133 public static ElectricalCapacitance of(final double valueInUnit, final String unitString)
134 {
135 return Quantity.of(valueInUnit, unitString, ZERO);
136 }
137
138 @Override
139 public ElectricalCapacitance.Unit getDisplayUnit()
140 {
141 return (ElectricalCapacitance.Unit) super.getDisplayUnit();
142 }
143
144 /**
145 * Calculate the division of ElectricalCapacitance and ElectricalCapacitance, which results in a Dimensionless quantity.
146 * @param v quantity
147 * @return quantity as a division of ElectricalCapacitance and ElectricalCapacitance
148 */
149 public Dimensionless divide(final ElectricalCapacitance v)
150 {
151 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
152 }
153
154 /**
155 * Calculate the multiplication of ElectricalCapacitance and ElectricPotential, which results in a ElectricCharge scalar.
156 * @param v scalar
157 * @return scalar as a multiplication of ElectricalCapacitance and ElectricPotential
158 */
159 public ElectricCharge multiply(final ElectricPotential v)
160 {
161 return new ElectricCharge(this.si() * v.si(), ElectricCharge.Unit.SI);
162 }
163
164 /**
165 * Calculate the division of ElectricalCapacitance and Duration, which results in a ElectricalConductance scalar.
166 * @param v scalar
167 * @return scalar as a division of ElectricalCapacitance and Duration
168 */
169 public ElectricalConductance divide(final Duration v)
170 {
171 return new ElectricalConductance(this.si() / v.si(), ElectricalConductance.Unit.SI);
172 }
173
174 /**
175 * Calculate the division of ElectricalCapacitance and ElectricalConductance, which results in a Duration scalar.
176 * @param v scalar
177 * @return scalar as a division of ElectricalCapacitance and ElectricalConductance
178 */
179 public Duration divide(final ElectricalConductance v)
180 {
181 return new Duration(this.si() / v.si(), Duration.Unit.SI);
182 }
183
184 /******************************************************************************************************/
185 /********************************************** UNIT CLASS ********************************************/
186 /******************************************************************************************************/
187
188 /**
189 * ElectricalCapacitance.Unit encodes the units of capacitance (in farad).
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<ElectricalCapacitance>
198 {
199 /** The dimensions of electrical capacitance: s^4.A^2/kg.m^2. */
200 public static final SIUnit SI_UNIT = SIUnit.of("s4A2/kgm2");
201
202 /** farad. */
203 public static final ElectricalCapacitance.Unit F = new ElectricalCapacitance.Unit("F", "F", "farad",
204 IdentityScale.SCALE, UnitSystem.SI_DERIVED, SIPrefixes.getSiPrefix(""));
205
206 /** The SI or BASE unit. */
207 public static final ElectricalCapacitance.Unit SI = (Unit) F.generateSiPrefixes(false, false);
208
209 /** mF. */
210 public static final ElectricalCapacitance.Unit mF = Units.resolve(ElectricalCapacitance.Unit.class, "mF");
211
212 /** uF. */
213 public static final ElectricalCapacitance.Unit muF = Units.resolve(ElectricalCapacitance.Unit.class, "muF");
214
215 /** nF. */
216 public static final ElectricalCapacitance.Unit nF = Units.resolve(ElectricalCapacitance.Unit.class, "nF");
217
218 /** pF. */
219 public static final ElectricalCapacitance.Unit pF = Units.resolve(ElectricalCapacitance.Unit.class, "pF");
220
221 /**
222 * Create a new ElectricalCapacitance unit.
223 * @param id the id or main abbreviation of the unit
224 * @param name the full name of the unit
225 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
226 * @param unitSystem the unit system such as SI or IMPERIAL
227 */
228 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
229 {
230 super(id, name, scaleFactorToBaseUnit, unitSystem);
231 }
232
233 /**
234 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
235 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
236 * @param displayAbbreviation the display abbreviation of the unit
237 * @param name the full name of the unit
238 * @param scale the scale to use to convert from this unit to the standard (e.g., SI, BASE) unit
239 * @param unitSystem unit system, e.g. SI or Imperial
240 * @param siPrefix the SI Prefix of this unit
241 */
242 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
243 final UnitSystem unitSystem, final SIPrefix siPrefix)
244 {
245 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem, siPrefix);
246 }
247
248 @Override
249 public SIUnit siUnit()
250 {
251 return SI_UNIT;
252 }
253
254 @Override
255 public Unit getBaseUnit()
256 {
257 return SI;
258 }
259
260 @Override
261 public ElectricalCapacitance ofSi(final double si, final UnitInterface<ElectricalCapacitance> displayUnit)
262 {
263 return new ElectricalCapacitance(si, (Unit) displayUnit, true);
264 }
265
266 @Override
267 public ElectricalCapacitance.Unit deriveUnit(final String abbreviation, final String name, final double scaleFactor,
268 final UnitSystem unitSystem)
269 {
270 return (Unit) super.deriveUnit(abbreviation, name, scaleFactor, unitSystem);
271 }
272
273 @Override
274 public ElectricalCapacitance.Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation,
275 final String name, final double scaleFactor, final UnitSystem unitSystem, final SIPrefix siPrefix)
276 {
277 if (getScale() instanceof LinearScale ls)
278 {
279 return new ElectricalCapacitance.Unit(textualAbbreviation, displayAbbreviation, name,
280 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem, siPrefix);
281 }
282 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
283 }
284
285 }
286 }