Package org.djunits.value.vdouble.scalar

Class Energy

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>

org.djunits.value.vdouble.scalar.base.DoubleScalarRel<EnergyUnit,Energy>

org.djunits.value.vdouble.scalar.Energy

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Energy>, Relative<EnergyUnit,Energy>, Value<EnergyUnit,Energy>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class Energy
extends DoubleScalarRel<EnergyUnit,Energy>

Easy access methods for the Energy DoubleScalar, which is relative by definition.

Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

• Serialized Form

Field Summary

Fields

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

Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

si

Constructor Summary

Constructors

Constructor	Description
Energy(double value, EnergyUnit unit)	Construct Energy scalar.
Energy(Energy value)	Construct Energy scalar.

Method Summary

Modifier and Type	Method	Description
final Power	divide(Duration v)	Calculate the division of Energy and Duration, which results in a Power scalar.
final Dimensionless	divide(Energy v)	Calculate the division of Energy and Energy, which results in a Dimensionless scalar.
final Length	divide(Force v)	Calculate the division of Energy and Force, which results in a Length scalar.
final Force	divide(Length v)	Calculate the division of Energy and Length, which results in a Force scalar.
final Speed	divide(Momentum v)	Calculate the division of Energy and Momentum, which results in a Speed scalar.
final Duration	divide(Power v)	Calculate the division of Energy and Power, which results in a Duration scalar.
final Volume	divide(Pressure v)	Calculate the division of Energy and Pressure, which results in a Volume scalar.
final Momentum	divide(Speed v)	Calculate the division of Energy and Speed, which results in a Momentum scalar.
final Pressure	divide(Volume v)	Calculate the division of Energy and Volume, which results in a Pressure scalar.
final Energy	instantiateRel(double value, EnergyUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static final Energy	instantiateSI(double value)	Construct Energy scalar.
static Energy	interpolate(Energy zero, Energy one, double ratio)	Interpolate between two values.
static Energy	max(Energy r1, Energy r2)	Return the maximum value of two relative scalars.
static Energy	max(Energy r1, Energy r2, Energy... rn)	Return the maximum value of more than two relative scalars.
static Energy	min(Energy r1, Energy r2)	Return the minimum value of two relative scalars.
static Energy	min(Energy r1, Energy r2, Energy... rn)	Return the minimum value of more than two relative scalars.
static Energy	of(double value, String unitString)	Returns a Energy based on a value and the textual representation of the unit, which can be localized.
SIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final Power	times(Frequency v)	Calculate the multiplication of Energy and Frequency, which results in a Power scalar.
final Force	times(LinearDensity v)	Calculate the multiplication of Energy and LinearDensity, which results in a Force scalar.
static Energy	valueOf(String text)	Returns a Energy representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalarRel

abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

compareTo, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

Methods inherited from class org.djunits.value.base.Scalar

format, format, getDisplayUnit, setDisplayUnit

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.Value

isAbsolute, isRelative

Field Details

ZERO

public static final Energy ZERO

Constant with value zero.

ONE

public static final Energy ONE

Constant with value one.

NaN

public static final Energy NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final Energy POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Energy NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Energy POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Energy NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

Energy

public Energy(double value,
 EnergyUnit unit)

Construct Energy scalar.

Parameters:

value - double; the double value

unit - EnergyUnit; unit for the double value

Energy

public Energy(Energy value)

Construct Energy scalar.

Parameters:

value - Energy; Scalar from which to construct this instance

Method Details

instantiateRel

public final Energy instantiateRel(double value,
 EnergyUnit unit)

Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateRel in class DoubleScalarRel<EnergyUnit,Energy>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

R a new relative instance of the DoubleScalar of the right type

instantiateSI

public static final Energy instantiateSI(double value)

Construct Energy scalar.

Parameters:

value - double; the double value in SI units

Returns:

Energy; the new scalar with the SI value

interpolate

public static Energy interpolate(Energy zero,
 Energy one,
 double ratio)

Interpolate between two values.

Parameters:

zero - Energy; the low value

one - Energy; the high value

ratio - double; the ratio between 0 and 1, inclusive

Returns:

Energy; a Scalar at the ratio between

max

public static Energy max(Energy r1,
 Energy r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - Energy; the first scalar

r2 - Energy; the second scalar

Returns:

Energy; the maximum value of two relative scalars

max

public static Energy max(Energy r1,
 Energy r2,
 Energy... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - Energy; the first scalar

r2 - Energy; the second scalar

rn - Energy...; the other scalars

Returns:

Energy; the maximum value of more than two relative scalars

min

public static Energy min(Energy r1,
 Energy r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - Energy; the first scalar

r2 - Energy; the second scalar

Returns:

Energy; the minimum value of two relative scalars

min

public static Energy min(Energy r1,
 Energy r2,
 Energy... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - Energy; the first scalar

r2 - Energy; the second scalar

rn - Energy...; the other scalars

Returns:

Energy; the minimum value of more than two relative scalars

valueOf

public static Energy valueOf(String text)

Returns a Energy 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 - String; the textual representation to parse into a Energy

Returns:

Energy; 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 Energy of(double value,
 String unitString)

Returns a Energy based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

Energy; 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

divide

public final Dimensionless divide(Energy v)

Calculate the division of Energy and Energy, which results in a Dimensionless scalar.

Parameters:

v - Energy; scalar

Returns:

Dimensionless; scalar as a division of Energy and Energy

divide

public final Length divide(Force v)

Calculate the division of Energy and Force, which results in a Length scalar.

Parameters:

v - Energy; scalar

Returns:

Length; scalar as a division of Energy and Force

divide

public final Force divide(Length v)

Calculate the division of Energy and Length, which results in a Force scalar.

Parameters:

v - Energy; scalar

Returns:

Force; scalar as a division of Energy and Length

times

public final Force times(LinearDensity v)

Calculate the multiplication of Energy and LinearDensity, which results in a Force scalar.

Parameters:

v - Energy; scalar

Returns:

Force; scalar as a multiplication of Energy and LinearDensity

divide

public final Power divide(Duration v)

Calculate the division of Energy and Duration, which results in a Power scalar.

Parameters:

v - Energy; scalar

Returns:

Power; scalar as a division of Energy and Duration

divide

public final Duration divide(Power v)

Calculate the division of Energy and Power, which results in a Duration scalar.

Parameters:

v - Energy; scalar

Returns:

Duration; scalar as a division of Energy and Power

divide

public final Pressure divide(Volume v)

Calculate the division of Energy and Volume, which results in a Pressure scalar.

Parameters:

v - Energy; scalar

Returns:

Pressure; scalar as a division of Energy and Volume

divide

public final Volume divide(Pressure v)

Calculate the division of Energy and Pressure, which results in a Volume scalar.

Parameters:

v - Energy; scalar

Returns:

Volume; scalar as a division of Energy and Pressure

times

public final Power times(Frequency v)

Calculate the multiplication of Energy and Frequency, which results in a Power scalar.

Parameters:

v - Energy; scalar

Returns:

Power; scalar as a multiplication of Energy and Frequency

divide

public final Momentum divide(Speed v)

Calculate the division of Energy and Speed, which results in a Momentum scalar.

Parameters:

v - Energy; scalar

Returns:

Momentum; scalar as a division of Energy and Speed

divide

public final Speed divide(Momentum v)

Calculate the division of Energy and Momentum, which results in a Speed scalar.

Parameters:

v - Energy; scalar

Returns:

Speed; scalar as a division of Energy and Momentum

reciprocal

public SIScalar reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class DoubleScalarRel<EnergyUnit,Energy>

Returns:

DoubleScalar<?>; a new scalar instance with correct SI dimensions