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="2025-09-06T15:16:28.380798Z") public class Force extends DoubleScalarRel<ForceUnit,Force>

Easy access methods for the Force 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 Force

NaN

Constant with value NaN.

static final Force

NEG_MAXVALUE

Constant with value -MAX_VALUE.

static final Force

NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

static final Force

ONE

Constant with value one.

static final Force

POS_MAXVALUE

Constant with value MAX_VALUE.

static final Force

POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

static final Force

ZERO

Constant with value zero.

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

Constructors

Constructor

Description

Force(double value, ForceUnit unit)

Construct Force scalar with a unit.

Force(Force value)

Construct Force scalar.
Method Summary

Modifier and Type

Method

Description

final Mass

divide(Acceleration v)

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

final Pressure

divide(Area v)

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

static Force

divide(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)

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

final LinearDensity

divide(Energy v)

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

final Dimensionless

divide(Force v)

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

final Energy

divide(LinearDensity v)

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

final Acceleration

divide(Mass v)

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

final Area

divide(Pressure v)

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

static Force

multiply(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)

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

static Force

of(double value, String unitString)

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

static final Force

ofSI(double value)

Construct Force scalar based on an SI value.

SIScalar

reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

final Energy

times(Length v)

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

final Power

times(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.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 Force ZERO
  
  Constant with value zero.
- ONE
  
  public static final Force ONE
  
  Constant with value one.
- 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 Details
- Force
  
  public Force(double value, ForceUnit unit)
  
  Construct Force scalar with a unit.
  
  Parameters:
  
  value - the double value, expressed in the given unit
  
  unit - unit for the double value
- Force
  
  public Force(Force value)
  
  Construct Force scalar.
  
  Parameters:
  
  value - Scalar from which to construct this instance
Method Details
- instantiateRel
  
  public final Force instantiateRel(double value, ForceUnit 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<ForceUnit,Force>
  
  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 Force ofSI(double value)
  
  Construct Force 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 Force interpolate(Force zero, Force 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 Force at the given ratio between 0 and 1
- 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)
  
  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 - the textual representation to parse into a Force
  
  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 Force of(double value, String unitString)
  
  Returns a Force 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(Force v)
  
  Calculate the division of Force and Force, which results in a Dimensionless scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Force and Force
- times
  
  public final Energy times(Length v)
  
  Calculate the multiplication of Force and Length, which results in a Energy scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a multiplication of Force and Length
- divide
  
  public final Energy divide(LinearDensity v)
  
  Calculate the division of Force and LinearDensity, which results in a Energy scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Force and LinearDensity
- divide
  
  public final LinearDensity divide(Energy v)
  
  Calculate the division of Force and Energy, which results in a LinearDensity scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Force and Energy
- times
  
  public final Power times(Speed v)
  
  Calculate the multiplication of Force and Speed, which results in a Power scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a multiplication of Force and Speed
- divide
  
  public final Acceleration divide(Mass v)
  
  Calculate the division of Force and Mass, which results in a Acceleration scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Force and Mass
- divide
  
  public final Mass divide(Acceleration v)
  
  Calculate the division of Force and Acceleration, which results in a Mass scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Force and Acceleration
- divide
  
  public final Pressure divide(Area v)
  
  Calculate the division of Force and Area, which results in a Pressure scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Force and Area
- divide
  
  public final Area divide(Pressure v)
  
  Calculate the division of Force and Pressure, which results in a Area scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Force and Pressure
- reciprocal
  
  public SIScalar reciprocal()
  
  Description copied from class: DoubleScalarRel
  
  Create the reciprocal of this scalar with the correct dimensions.
  
  Overrides:
  
  reciprocal in class DoubleScalarRel<ForceUnit,Force>
  
  Returns:
  
  a new scalar instance with correct SI dimensions
- multiply
  
  public static Force multiply(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)
  
  Multiply two scalars that result in a scalar of type Force.
  
  Parameters:
  
  scalar1 - the first scalar
  
  scalar2 - the second scalar
  
  Returns:
  
  the multiplication of both scalars as an instance of Force
- divide
  
  public static Force divide(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)
  
  Divide two scalars that result in a scalar of type Force.
  
  Parameters:
  
  scalar1 - the first scalar
  
  scalar2 - the second scalar
  
  Returns:
  
  the division of scalar1 by scalar2 as an instance of Force

Class Force

Field Summary

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Methods inherited from interface org.djunits.value.Value

Field Details

ZERO

ONE

NaN

POSITIVE_INFINITY

NEGATIVE_INFINITY

POS_MAXVALUE

NEG_MAXVALUE

Constructor Details

Force

Force

Method Details

instantiateRel

ofSI

interpolate

max

max

min

min

valueOf

of

divide

times

divide

divide

times

divide

divide

divide

divide

reciprocal

multiply

divide