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