org.djunits.value.vdouble.scalar

Class Force

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.AbstractDoubleScalar<U,R>

org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<ForceUnit,Force>

org.djunits.value.vdouble.scalar.Force

All Implemented Interfaces:

Serializable, Comparable<Force>, MathFunctionsAbs<Force>, MathFunctionsRel<Force>, Relative, Value<ForceUnit>, DoubleMathFunctions<Force>, DoubleScalarInterface

public class Force
extends AbstractDoubleScalarRel<ForceUnit,Force>

Easy access methods for the Force DoubleScalar, which is relative by definition. Instead of:

 DoubleScalar.Rel<ForceUnit> value = new DoubleScalar.Rel<ForceUnit>(100.0, ForceUnit.SI);
 

we can now write:

 Force value = new Force(100.0, ForceUnit.SI);
 

The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

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

$LastChangedDate: 2019-03-03 00:53:50 +0100 (Sun, 03 Mar 2019) $, @version $Revision: 349 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Force	NaN constant with value NaN.
static Force	NEG_MAXVALUE constant with value -MAX_VALUE.
static Force	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static Force	POS_MAXVALUE constant with value MAX_VALUE.
static Force	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static Force	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor and Description
Force(double value, ForceUnit unit) Construct Force scalar.
Force(Force value) Construct Force scalar.

Method Summary

Modifier and Type	Method and Description
static Force	createSI(double value) Construct Force scalar.
Mass	divideBy(Acceleration v) Calculate the division of Force and Acceleration, which results in a Mass scalar.
Pressure	divideBy(Area v) Calculate the division of Force and Area, which results in a Pressure scalar.
LinearDensity	divideBy(Energy v) Calculate the division of Force and Energy, which results in a LinearDensity scalar.
Dimensionless	divideBy(Force v) Calculate the division of Force and Force, which results in a Dimensionless scalar.
Energy	divideBy(LinearDensity v) Calculate the division of Force and LinearDensity, which results in a Energy scalar.
Acceleration	divideBy(Mass v) Calculate the division of Force and Mass, which results in a Acceleration scalar.
Area	divideBy(Pressure v) Calculate the division of Force and Pressure, which results in a Area scalar.
Force	instantiateRel(double value, ForceUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Force	interpolate(Force zero, Force one, double ratio) Interpolate between two values.
static Force	max(Force r1, Force r2) Return the maximum value of two relative scalars.
static Force	max(Force r1, Force r2, Force... rn) Return the maximum value of more than two relative scalars.
static Force	min(Force r1, Force r2) Return the minimum value of two relative scalars.
static Force	min(Force r1, Force r2, Force... rn) Return the minimum value of more than two relative scalars.
Energy	multiplyBy(Length v) Calculate the multiplication of Force and Length, which results in a Energy scalar.
Power	multiplyBy(Speed v) Calculate the multiplication of Force and Speed, which results in a Power scalar.
static Force	valueOf(String text) Returns a Force representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel

abs, ceil, divideBy, floor, minus, multiplyBy, neg, plus, rint, round

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

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.vdouble.DoubleMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final Force ZERO

constant with value zero.

NaN

public static final Force NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Force POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Force NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Force POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Force NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Force

public Force(double value,
             ForceUnit unit)

Construct Force scalar.

Parameters:

value - double value

unit - unit for the double value

Force

public Force(Force value)

Construct Force scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Force instantiateRel(double value,
                                  ForceUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<ForceUnit,Force>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

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

createSI

public static final Force createSI(double value)

Construct Force scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

public static Force max(Force r1,
                        Force 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 Force max(Force r1,
                        Force r2,
                        Force... 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 Force min(Force r1,
                        Force 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 Force min(Force r1,
                        Force r2,
                        Force... 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 Force valueOf(String text)
                     throws IllegalArgumentException

Returns a Force 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 the official abbreviation of the unit. Spaces are allowed, but not necessary, between the value and the unit.

Parameters:

text - String; the textual representation to parse into a Force

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

Throws:

IllegalArgumentException - when the text cannot be parsed

divideBy

public final Dimensionless divideBy(Force v)

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

Parameters:

v - Force scalar

Returns:

Dimensionless scalar as a division of Force and Force

multiplyBy

public final Energy multiplyBy(Length v)

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

Parameters:

v - Force scalar

Returns:

Energy scalar as a multiplication of Force and Length

divideBy

public final Energy divideBy(LinearDensity v)

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

Parameters:

v - Force scalar

Returns:

Energy scalar as a division of Force and LinearDensity

divideBy

public final LinearDensity divideBy(Energy v)

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

Parameters:

v - Force scalar

Returns:

LinearDensity scalar as a division of Force and Energy

multiplyBy

public final Power multiplyBy(Speed v)

Calculate the multiplication of Force and Speed, which results in a Power scalar.

Parameters:

v - Force scalar

Returns:

Power scalar as a multiplication of Force and Speed

divideBy

public final Acceleration divideBy(Mass v)

Calculate the division of Force and Mass, which results in a Acceleration scalar.

Parameters:

v - Force scalar

Returns:

Acceleration scalar as a division of Force and Mass

divideBy

public final Mass divideBy(Acceleration v)

Calculate the division of Force and Acceleration, which results in a Mass scalar.

Parameters:

v - Force scalar

Returns:

Mass scalar as a division of Force and Acceleration

divideBy

public final Pressure divideBy(Area v)

Calculate the division of Force and Area, which results in a Pressure scalar.

Parameters:

v - Force scalar

Returns:

Pressure scalar as a division of Force and Area

divideBy

public final Area divideBy(Pressure v)

Calculate the division of Force and Pressure, which results in a Area scalar.

Parameters:

v - Force scalar

Returns:

Area scalar as a division of Force and Pressure