Package org.djunits.quantity

Class ElectricPotential

java.lang.Object

java.lang.Number

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

org.djunits.quantity.ElectricPotential

All Implemented Interfaces:

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

public class ElectricPotential
extends Quantity<ElectricPotential>

ElectricPotential is the difference in electric potential energy per unit of electric charge between two points in a static electric field.

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	ElectricPotential.Unit	ElectricPotential.Unit encodes the units of electric potential (difference)

Field Summary

Fields

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

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

si

Constructor Summary

Constructors

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

Method Summary

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

Constant with value zero.

ONE

public static final ElectricPotential ONE

Constant with value one.

NaN

public static final ElectricPotential NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final ElectricPotential POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final ElectricPotential NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final ElectricPotential POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final ElectricPotential NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

ElectricPotential

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

Instantiate a ElectricPotential 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

ElectricPotential

public ElectricPotential(double valueInUnit,
 ElectricPotential.Unit unit)

Instantiate a ElectricPotential 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 ElectricPotential ofSi(double si)

Return a ElectricPotential instance based on an SI value.

Parameters:

si - the si value

Returns:

the ElectricPotential instance based on an SI value

ofSi

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

Instantiate a ElectricPotential 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 ElectricPotential instance based on an SI value with the given display unit

instantiateSi

public ElectricPotential instantiateSi(double siValue,
 UnitInterface<ElectricPotential> 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<ElectricPotential>

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 ElectricPotential valueOf(String text)

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

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 ElectricPotential of(double valueInUnit,
 ElectricPotential.Unit unit)

Returns a ElectricPotential 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 ElectricPotential representation of the value in its unit

of

public static ElectricPotential of(double valueInUnit,
 String unitString)

Returns a ElectricPotential 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 ElectricPotential.Unit getDisplayUnit()

Description copied from interface: Value

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<ElectricPotential>

Overrides:

getDisplayUnit in class Quantity<ElectricPotential>

Returns:

the unit of this Value

divide

public Dimensionless divide(ElectricPotential v)

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

Parameters:

v - quantity

Returns:

quantity as a division of ElectricPotential and ElectricPotential

multiply

public Power multiply(ElectricCurrent v)

Calculate the multiplication of ElectricPotential and ElectricCurrent, which results in a Power scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of ElectricPotential and ElectricCurrent

divide

public ElectricalResistance divide(ElectricCurrent v)

Calculate the division of ElectricPotential and ElectricCurrent, which results in a ElectricalResistance scalar.

Parameters:

v - scalar

Returns:

scalar as a division of ElectricPotential and ElectricCurrent

divide

public ElectricCurrent divide(ElectricalResistance v)

Calculate the division of ElectricPotential and ElectricalResistance, which results in a ElectricCurrent scalar.

Parameters:

v - scalar

Returns:

scalar as a division of ElectricPotential and ElectricalResistance