Package org.djunits.quantity
Class ElectricalConductance
- All Implemented Interfaces:
Serializable,Comparable<ElectricalConductance>,Additive<ElectricalConductance>,Scalable<ElectricalConductance>,Value<ElectricalConductance>
Electrical conductance measures the ease with which an electric current passes, and is expressed in siemens. Its reciprocal
quantity is electrical resistance (expressed in ohm).
Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djunits.org. The DJUNITS project is distributed under a three-clause BSD-style license.
- Author:
- Alexander Verbraeck
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classElectricalConductance.Unit encodes the units of electrical conductance, and is expressed in Siemens. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ElectricalConductanceConstant with value NaN.static final ElectricalConductanceConstant with value -MAX_VALUE.static final ElectricalConductanceConstant with value NEGATIVE_INFINITY.static final ElectricalConductanceConstant with value one.static final ElectricalConductanceConstant with value MAX_VALUE.static final ElectricalConductanceConstant with value POSITIVE_INFINITY.static final ElectricalConductanceConstant with value zero. -
Constructor Summary
ConstructorsConstructorDescriptionElectricalConductance(double valueInUnit, ElectricalConductance.Unit unit) Instantiate a ElectricalConductance quantity expressed in the given unit.ElectricalConductance(double value, ElectricalConductance.Unit displayUnit, boolean useSi) Instantiate a ElectricalConductance quantity with an SI or base value and a display unit. -
Method Summary
Modifier and TypeMethodDescriptionCalculate the division of ElectricalConductance and ElectricalConductance, which results in a Dimensionless quantity.Retrieve the unit of this Value.instantiateSi(double siValue, UnitInterface<ElectricalConductance> displayUnit) Instantiate a quantity with an SI or base value, and a display unit.Calculate the multiplication of ElectricalConductance and Duration, which results in a ElectricalCapacitance scalar.Calculate the multiplication of ElectricalConductance and ElectricalResistance, which results in a Dimensionless scalar.Calculate the multiplication of ElectricalConductance and ElectricPotential, which results in a ElectricCurrent scalar.static ElectricalConductanceReturns a ElectricalConductance based on a value and the textual representation of the unit, which can be localized.static ElectricalConductanceof(double valueInUnit, ElectricalConductance.Unit unit) Returns a ElectricalConductance based on a value expressed in the unit.static ElectricalConductanceofSi(double si) Return a ElectricalConductance instance based on an SI value.static ElectricalConductanceofSi(double siValue, ElectricalConductance.Unit displayUnit) Instantiate a ElectricalConductance quantity with an SI or base value and a display unit.Return the reciprocal of this quantity (1/q).static ElectricalConductanceReturns a ElectricalConductance representation of a textual representation of a value with a unit.Methods inherited from class org.djunits.quantity.def.Quantity
abs, add, as, compareTo, divide, doubleValue, eq, eq0, equals, floatValue, format, format, format, ge, ge0, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, instantiateSi, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, scaleBy, si, siUnit, subtract, sum, toString, valueOfMethods inherited from class java.lang.Number
byteValue, shortValueMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.djunits.value.Value
isAbsolute
-
Field Details
-
ZERO
Constant with value zero. -
ONE
Constant with value one. -
NaN
Constant with value NaN. -
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY. -
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY. -
POS_MAXVALUE
Constant with value MAX_VALUE. -
NEG_MAXVALUE
Constant with value -MAX_VALUE.
-
-
Constructor Details
-
ElectricalConductance
Instantiate a ElectricalConductance quantity with an SI or base value and a display unit.- Parameters:
value- the quantity value expressed in the SI or base unitdisplayUnit- the display unit to useuseSi- use SI value when true, use value in unit when false
-
ElectricalConductance
Instantiate a ElectricalConductance quantity expressed in the given unit.- Parameters:
valueInUnit- the quantity value expressed in the given unitunit- the unit of the value, also acts as the display unit
-
-
Method Details
-
ofSi
Return a ElectricalConductance instance based on an SI value.- Parameters:
si- the si value- Returns:
- the ElectricalConductance instance based on an SI value
-
ofSi
Instantiate a ElectricalConductance quantity with an SI or base value and a display unit.- Parameters:
siValue- the quantity value expressed in the SI or base unitdisplayUnit- the display unit to use- Returns:
- the ElectricalConductance instance based on an SI value with the given display unit
-
instantiateSi
public ElectricalConductance instantiateSi(double siValue, UnitInterface<ElectricalConductance> displayUnit) Description copied from class:QuantityInstantiate a quantity with an SI or base value, and a display unit.- Specified by:
instantiateSiin classQuantity<ElectricalConductance>- Parameters:
siValue- the value expressed in the base (SI) unitdisplayUnit- the display unit to use for the quantity- Returns:
- a quantity with the given SI or base value, and the given display unit
-
valueOf
Returns a ElectricalConductance representation of a textual representation of a value with a unit. The String representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.- Parameters:
text- the textual representation to parse into a ElectricalConductance- Returns:
- the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException- when the text cannot be parsedNullPointerException- when the text argument is null
-
of
Returns a ElectricalConductance based on a value expressed in the unit.- Parameters:
valueInUnit- the value, expressed in the given unitunit- the unit of the value, also acts as the display unit- Returns:
- ab ElectricalConductance representation of the value in its unit
-
of
Returns a ElectricalConductance based on a value and the textual representation of the unit, which can be localized.- Parameters:
valueInUnit- the value, expressed in the unit as given by unitStringunitString- the textual representation of the unit- Returns:
- the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException- when the unit cannot be parsed or is incorrectNullPointerException- when the unitString argument is null
-
getDisplayUnit
Description copied from interface:ValueRetrieve the unit of this Value.- Specified by:
getDisplayUnitin interfaceValue<ElectricalConductance>- Overrides:
getDisplayUnitin classQuantity<ElectricalConductance>- Returns:
- the unit of this Value
-
divide
Calculate the division of ElectricalConductance and ElectricalConductance, which results in a Dimensionless quantity.- Parameters:
v- quantity- Returns:
- quantity as a division of ElectricalConductance and ElectricalConductance
-
multiply
Calculate the multiplication of ElectricalConductance and ElectricalResistance, which results in a Dimensionless scalar.- Parameters:
v- scalar- Returns:
- scalar as a multiplication of ElectricalConductance and ElectricalResistance
-
multiply
Calculate the multiplication of ElectricalConductance and ElectricPotential, which results in a ElectricCurrent scalar.- Parameters:
v- scalar- Returns:
- scalar as a multiplication of ElectricalConductance and ElectricPotential
-
multiply
Calculate the multiplication of ElectricalConductance and Duration, which results in a ElectricalCapacitance scalar.- Parameters:
v- scalar- Returns:
- scalar as a multiplication of ElectricalConductance and Duration
-
reciprocal
Description copied from class:QuantityReturn the reciprocal of this quantity (1/q).- Overrides:
reciprocalin classQuantity<ElectricalConductance>- Returns:
- the reciprocal of this quantity, with the correct SI units
-