Package org.djunits.quantity

Class ElectricCurrent

java.lang.Object

java.lang.Number

org.djunits.quantity.def.Quantity<ElectricCurrent>

org.djunits.quantity.ElectricCurrent

All Implemented Interfaces:

Serializable, Comparable<ElectricCurrent>, Additive<ElectricCurrent>, Scalable<ElectricCurrent>, Value<ElectricCurrent>

public class ElectricCurrent
extends Quantity<ElectricCurrent>

ElectricCurrent is the net rate of flow of electric charge through a surface.

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:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElectricCurrent.Unit	ElectricCurrent.Unit encodes the units of electric current (A).

Field Summary

Fields

Modifier and Type	Field	Description
static final ElectricCurrent	NaN	Constant with value NaN.
static final ElectricCurrent	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final ElectricCurrent	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final ElectricCurrent	ONE	Constant with value one.
static final ElectricCurrent	POS_MAXVALUE	Constant with value MAX_VALUE.
static final ElectricCurrent	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final ElectricCurrent	ZERO	Constant with value zero.

Fields inherited from class org.djunits.quantity.def.Quantity

si

Constructor Summary

Constructors

Constructor	Description
ElectricCurrent(double valueInUnit, ElectricCurrent.Unit unit)	Instantiate a ElectricCurrent quantity expressed in the given unit.
ElectricCurrent(double value, ElectricCurrent.Unit displayUnit, boolean useSi)	Instantiate a ElectricCurrent quantity with an SI or base value and a display unit.

Method Summary

Modifier and Type	Method	Description
ElectricPotential	divide(ElectricalConductance v)	Calculate the division of ElectricalCurrent and ElectricalConductance, which results in a ElectricalPotential scalar.
Dimensionless	divide(ElectricCurrent v)	Calculate the division of ElectricCurrent and ElectricCurrent, which results in a Dimensionless quantity.
ElectricalConductance	divide(ElectricPotential v)	Calculate the division of ElectricalCurrent and ElectricalPotential, which results in a ElectricalConductance scalar.
ElectricCurrent.Unit	getDisplayUnit()	Retrieve the unit of this Value.
ElectricCurrent	instantiateSi(double siValue, UnitInterface<ElectricCurrent> displayUnit)	Instantiate a quantity with an SI or base value, and a display unit.
ElectricCharge	multiply(Duration v)	Calculate the multiplication of ElectricalCurrent and Duration, which results in a ElectricalCharge scalar.
ElectricPotential	multiply(ElectricalResistance v)	Calculate the multiplication of ElectricalCurrent and ElectricalResistance, which results in a ElectricalPotential scalar.
Power	multiply(ElectricPotential v)	Calculate the multiplication of ElectricalCurrent and ElectricalPotential, which results in a Power scalar.
static ElectricCurrent	of(double valueInUnit, String unitString)	Returns a ElectricCurrent based on a value and the textual representation of the unit, which can be localized.
static ElectricCurrent	of(double valueInUnit, ElectricCurrent.Unit unit)	Returns a ElectricCurrent based on a value expressed in the unit.
static ElectricCurrent	ofSi(double si)	Return a ElectricCurrent instance based on an SI value.
static ElectricCurrent	ofSi(double siValue, ElectricCurrent.Unit displayUnit)	Instantiate a ElectricCurrent quantity with an SI or base value and a display unit.
static ElectricCurrent	valueOf(String text)	Returns a ElectricCurrent 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, reciprocal, scaleBy, si, siUnit, subtract, sum, toString, valueOf

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.Scalable

divideBy

Methods inherited from interface org.djunits.value.Value

isAbsolute

Field Details

ZERO

public static final ElectricCurrent ZERO

Constant with value zero.

ONE

public static final ElectricCurrent ONE

Constant with value one.

NaN

public static final ElectricCurrent NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final ElectricCurrent POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final ElectricCurrent NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final ElectricCurrent POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final ElectricCurrent NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

ElectricCurrent

public ElectricCurrent(double value,
 ElectricCurrent.Unit displayUnit,
 boolean useSi)

Instantiate a ElectricCurrent quantity with an SI or base value and a display unit.

Parameters:

value - the quantity value expressed in the SI or base unit

displayUnit - the display unit to use

useSi - use SI value when true, use value in unit when false

ElectricCurrent

public ElectricCurrent(double valueInUnit,
 ElectricCurrent.Unit unit)

Instantiate a ElectricCurrent quantity expressed in the given unit.

Parameters:

valueInUnit - the quantity value expressed in the given unit

unit - the unit of the value, also acts as the display unit

Method Details

ofSi

public static ElectricCurrent ofSi(double si)

Return a ElectricCurrent instance based on an SI value.

Parameters:

si - the si value

Returns:

the ElectricCurrent instance based on an SI value

ofSi

public static ElectricCurrent ofSi(double siValue,
 ElectricCurrent.Unit displayUnit)

Instantiate a ElectricCurrent quantity with an SI or base value and a display unit.

Parameters:

siValue - the quantity value expressed in the SI or base unit

displayUnit - the display unit to use

Returns:

the ElectricCurrent instance based on an SI value with the given display unit

instantiateSi

public ElectricCurrent instantiateSi(double siValue,
 UnitInterface<ElectricCurrent> displayUnit)

Description copied from class: Quantity

Instantiate a quantity with an SI or base value, and a display unit.

Specified by:

instantiateSi in class Quantity<ElectricCurrent>

Parameters:

siValue - the value expressed in the base (SI) unit

displayUnit - the display unit to use for the quantity

Returns:

a quantity with the given SI or base value, and the given display unit

valueOf

public static ElectricCurrent valueOf(String text)

Returns a ElectricCurrent 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 ElectricCurrent

Returns:

the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static ElectricCurrent of(double valueInUnit,
 ElectricCurrent.Unit unit)

Returns a ElectricCurrent based on a value expressed in the unit.

Parameters:

valueInUnit - the value, expressed in the given unit

unit - the unit of the value, also acts as the display unit

Returns:

ab ElectricCurrent representation of the value in its unit

of

public static ElectricCurrent of(double valueInUnit,
 String unitString)

Returns a ElectricCurrent 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 unitString

unitString - 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 incorrect

NullPointerException - when the unitString argument is null

getDisplayUnit

public ElectricCurrent.Unit getDisplayUnit()

Description copied from interface: Value

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<ElectricCurrent>

Overrides:

getDisplayUnit in class Quantity<ElectricCurrent>

Returns:

the unit of this Value

divide

public Dimensionless divide(ElectricCurrent v)

Calculate the division of ElectricCurrent and ElectricCurrent, which results in a Dimensionless quantity.

Parameters:

v - quantity

Returns:

quantity as a division of ElectricCurrent and ElectricCurrent

multiply

public Power multiply(ElectricPotential v)

Calculate the multiplication of ElectricalCurrent and ElectricalPotential, which results in a Power scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of ElectricalCurrent and ElectricalPotential

multiply

public ElectricCharge multiply(Duration v)

Calculate the multiplication of ElectricalCurrent and Duration, which results in a ElectricalCharge scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of ElectricalCurrent and Duration

multiply

public ElectricPotential multiply(ElectricalResistance v)

Calculate the multiplication of ElectricalCurrent and ElectricalResistance, which results in a ElectricalPotential scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of ElectricalCurrent and ElectricalResistance

divide

public ElectricalConductance divide(ElectricPotential v)

Calculate the division of ElectricalCurrent and ElectricalPotential, which results in a ElectricalConductance scalar.

Parameters:

v - scalar

Returns:

scalar as a division of ElectricalCurrent and ElectricalPotential

divide

public ElectricPotential divide(ElectricalConductance v)

Calculate the division of ElectricalCurrent and ElectricalConductance, which results in a ElectricalPotential scalar.

Parameters:

v - scalar

Returns:

scalar as a division of ElectricalCurrent and ElectricalConductance