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