Package org.djunits.value.vdouble.scalar

Class Momentum

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<MomentumUnit,Momentum>

org.djunits.value.vdouble.scalar.Momentum

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Momentum>, Relative<MomentumUnit,Momentum>, Value<MomentumUnit,Momentum>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2025-09-06T15:16:28.380798Z")
public class Momentum
extends DoubleScalarRel<MomentumUnit,Momentum>

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

Copyright (c) 2013-2025 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 Momentum	NaN	Constant with value NaN.
static final Momentum	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final Momentum	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final Momentum	ONE	Constant with value one.
static final Momentum	POS_MAXVALUE	Constant with value MAX_VALUE.
static final Momentum	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final Momentum	ZERO	Constant with value zero.

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

si

Constructor Summary

Constructors

Constructor	Description
Momentum(double value, MomentumUnit unit)	Construct Momentum scalar with a unit.
Momentum(Momentum value)	Construct Momentum scalar.

Method Summary

Modifier and Type	Method	Description
static Momentum	divide(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)	Divide two scalars that result in a scalar of type Momentum.
final Length	divide(FlowMass v)	Calculate the division of Momentum and FlowMass, which results in a Length scalar.
final FlowMass	divide(Length v)	Calculate the division of Momentum and Length, which results in a FlowMass scalar.
final Speed	divide(Mass v)	Calculate the division of Momentum and Mass, which results in a Speed scalar.
final Dimensionless	divide(Momentum v)	Calculate the division of Momentum and Momentum, which results in a Dimensionless scalar.
final Mass	divide(Speed v)	Calculate the division of Momentum and Speed, which results in a Mass scalar.
final Momentum	instantiateRel(double value, MomentumUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static Momentum	interpolate(Momentum zero, Momentum one, double ratio)	Interpolate between two values.
static Momentum	max(Momentum r1, Momentum r2)	Return the maximum value of two relative scalars.
static Momentum	max(Momentum r1, Momentum r2, Momentum... rn)	Return the maximum value of more than two relative scalars.
static Momentum	min(Momentum r1, Momentum r2)	Return the minimum value of two relative scalars.
static Momentum	min(Momentum r1, Momentum r2, Momentum... rn)	Return the minimum value of more than two relative scalars.
static Momentum	multiply(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)	Multiply two scalars that result in a scalar of type Momentum.
static Momentum	of(double value, String unitString)	Returns a Momentum based on a value and the textual representation of the unit, which can be localized.
static final Momentum	ofSI(double value)	Construct Momentum scalar based on an SI value.
SIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final Power	times(Acceleration v)	Calculate the multiplication of Momentum and Acceleration, which results in a Power scalar.
final Energy	times(Speed v)	Calculate the multiplication of Momentum and Speed, which results in a Energy scalar.
static Momentum	valueOf(String text)	Returns a Momentum 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, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, 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 Momentum ZERO

Constant with value zero.

ONE

public static final Momentum ONE

Constant with value one.

NaN

public static final Momentum NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final Momentum POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Momentum NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Momentum POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Momentum NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

Momentum

public Momentum(double value,
 MomentumUnit unit)

Construct Momentum scalar with a unit.

Parameters:

value - the double value, expressed in the given unit

unit - unit for the double value

Momentum

public Momentum(Momentum value)

Construct Momentum scalar.

Parameters:

value - Scalar from which to construct this instance

Method Details

instantiateRel

public final Momentum instantiateRel(double value,
 MomentumUnit unit)

Description copied from class: DoubleScalarRel

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

Specified by:

instantiateRel in class DoubleScalarRel<MomentumUnit,Momentum>

Parameters:

value - the double value

unit - the unit

Returns:

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

ofSI

public static final Momentum ofSI(double value)

Construct Momentum scalar based on an SI value.

Parameters:

value - the double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

Interpolate between two values. Note that the first value does not have to be smaller than the second.

Parameters:

zero - the value at a ratio of zero

one - the value at a ratio of one

ratio - the ratio between 0 and 1, inclusive

Returns:

a Momentum at the given ratio between 0 and 1

max

public static Momentum max(Momentum r1,
 Momentum r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the maximum value of two relative scalars

max

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

Return the maximum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the maximum value of more than two relative scalars

min

public static Momentum min(Momentum r1,
 Momentum r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the minimum value of two relative scalars

min

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

Return the minimum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two relative scalars

valueOf

public static Momentum valueOf(String text)

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

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

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

Parameters:

value - the value to use

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

divide

public final Dimensionless divide(Momentum v)

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

Parameters:

v - scalar

Returns:

scalar as a division of Momentum and Momentum

divide

public final Mass divide(Speed v)

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

Parameters:

v - scalar

Returns:

scalar as a division of Momentum and Speed

divide

public final Speed divide(Mass v)

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

Parameters:

v - scalar

Returns:

scalar as a division of Momentum and Mass

divide

public final FlowMass divide(Length v)

Calculate the division of Momentum and Length, which results in a FlowMass scalar.

Parameters:

v - scalar

Returns:

scalar as a division of Momentum and Length

divide

public final Length divide(FlowMass v)

Calculate the division of Momentum and FlowMass, which results in a Length scalar.

Parameters:

v - scalar

Returns:

scalar as a division of Momentum and FlowMass

times

public final Energy times(Speed v)

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

Parameters:

v - scalar

Returns:

scalar as a multiplication of Momentum and Speed

times

public final Power times(Acceleration v)

Calculate the multiplication of Momentum and Acceleration, which results in a Power scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of Momentum and Acceleration

reciprocal

public SIScalar reciprocal()

Description copied from class: DoubleScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Overrides:

reciprocal in class DoubleScalarRel<MomentumUnit,Momentum>

Returns:

a new scalar instance with correct SI dimensions

multiply

public static Momentum multiply(DoubleScalarRel<?,?> scalar1,
 DoubleScalarRel<?,?> scalar2)

Multiply two scalars that result in a scalar of type Momentum.

Parameters:

scalar1 - the first scalar

scalar2 - the second scalar

Returns:

the multiplication of both scalars as an instance of Momentum

divide

public static Momentum divide(DoubleScalarRel<?,?> scalar1,
 DoubleScalarRel<?,?> scalar2)

Divide two scalars that result in a scalar of type Momentum.

Parameters:

scalar1 - the first scalar

scalar2 - the second scalar

Returns:

the division of scalar1 by scalar2 as an instance of Momentum