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