Package org.djunits.value.vdouble.scalar
Class Force
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<ForceUnit,Force>
org.djunits.value.vdouble.scalar.Force
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Force>
,Relative<ForceUnit,
,Force> Value<ForceUnit,
Force>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class Force
extends DoubleScalarRel<ForceUnit,Force>
Easy access methods for the Force 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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Force
Constant with value NaN.static final Force
Constant with value -MAX_VALUE.static final Force
Constant with value NEGATIVE_INFINITY.static final Force
Constant with value one.static final Force
Constant with value MAX_VALUE.static final Force
Constant with value POSITIVE_INFINITY.static final Force
Constant with value zero.Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar
si
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Mass
Calculate the division of Force and Acceleration, which results in a Mass scalar.final Pressure
Calculate the division of Force and Area, which results in a Pressure scalar.final LinearDensity
Calculate the division of Force and Energy, which results in a LinearDensity scalar.final Dimensionless
Calculate the division of Force and Force, which results in a Dimensionless scalar.final Energy
Calculate the division of Force and LinearDensity, which results in a Energy scalar.final Acceleration
Calculate the division of Force and Mass, which results in a Acceleration scalar.final Area
Calculate the division of Force and Pressure, which results in a Area scalar.final Force
instantiateRel
(double value, ForceUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.static final Force
instantiateSI
(double value) Construct Force scalar.static Force
interpolate
(Force zero, Force one, double ratio) Interpolate between two values.static Force
Return the maximum value of two relative scalars.static Force
Return the maximum value of more than two relative scalars.static Force
Return the minimum value of two relative scalars.static Force
Return the minimum value of more than two relative scalars.static Force
Returns a Force based on a value and the textual representation of the unit, which can be localized.Create the reciprocal of this scalar with the correct dimensions.final Energy
Calculate the multiplication of Force and Length, which results in a Energy scalar.final Power
Calculate the multiplication of Force and Speed, which results in a Power scalar.static Force
Returns a Force 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
Constant with value zero. -
ONE
Constant with value one. -
NaN
Constant with value NaN. -
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY. -
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY. -
POS_MAXVALUE
Constant with value MAX_VALUE. -
NEG_MAXVALUE
Constant with value -MAX_VALUE.
-
-
Constructor Details
-
Force
Construct Force scalar.- Parameters:
value
- double; the double valueunit
- ForceUnit; unit for the double value
-
Force
Construct Force scalar.- Parameters:
value
- Force; Scalar from which to construct this instance
-
-
Method Details
-
instantiateRel
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 classDoubleScalarRel<ForceUnit,
Force> - Parameters:
value
- double; the double valueunit
- U; the unit- Returns:
- R a new relative instance of the DoubleScalar of the right type
-
instantiateSI
Construct Force scalar.- Parameters:
value
- double; the double value in SI units- Returns:
- Force; the new scalar with the SI value
-
interpolate
Interpolate between two values.- Parameters:
zero
- Force; the low valueone
- Force; the high valueratio
- double; the ratio between 0 and 1, inclusive- Returns:
- Force; a Scalar at the ratio between
-
max
Return the maximum value of two relative scalars.- Parameters:
r1
- Force; the first scalarr2
- Force; the second scalar- Returns:
- Force; the maximum value of two relative scalars
-
max
Return the maximum value of more than two relative scalars.- Parameters:
r1
- Force; the first scalarr2
- Force; the second scalarrn
- Force...; the other scalars- Returns:
- Force; the maximum value of more than two relative scalars
-
min
Return the minimum value of two relative scalars.- Parameters:
r1
- Force; the first scalarr2
- Force; the second scalar- Returns:
- Force; the minimum value of two relative scalars
-
min
Return the minimum value of more than two relative scalars.- Parameters:
r1
- Force; the first scalarr2
- Force; the second scalarrn
- Force...; the other scalars- Returns:
- Force; the minimum value of more than two relative scalars
-
valueOf
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 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 Force- Returns:
- Force; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the text cannot be parsedNullPointerException
- when the text argument is null
-
of
Returns a Force based on a value and the textual representation of the unit, which can be localized.- Parameters:
value
- double; the value to useunitString
- String; the textual representation of the unit- Returns:
- Force; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the unit cannot be parsed or is incorrectNullPointerException
- when the unitString argument is null
-
divide
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
-
times
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
-
divide
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
-
divide
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
-
times
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
-
divide
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
-
divide
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
-
divide
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
-
divide
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
-
reciprocal
Description copied from class:DoubleScalarRel
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocal
in classDoubleScalarRel<ForceUnit,
Force> - Returns:
- DoubleScalar<?>; a new scalar instance with correct SI dimensions
-