Class 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 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.
      Parameters:
      value - double; the double value
      unit - ForceUnit; unit for the double value
    • Force

      public Force(Force value)
      Construct Force scalar.
      Parameters:
      value - Force; 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 - 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 Force instantiateSI(double value)
      Construct Force scalar.
      Parameters:
      value - double; the double value in SI units
      Returns:
      Force; the new scalar with the SI value
    • interpolate

      public static Force interpolate(Force zero, Force one, double ratio)
      Interpolate between two values.
      Parameters:
      zero - Force; the low value
      one - Force; the high value
      ratio - double; the ratio between 0 and 1, inclusive
      Returns:
      Force; 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 - Force; the first scalar
      r2 - Force; the second scalar
      Returns:
      Force; 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 - Force; the first scalar
      r2 - Force; the second scalar
      rn - Force...; the other scalars
      Returns:
      Force; 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 - Force; the first scalar
      r2 - Force; the second scalar
      Returns:
      Force; 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 - Force; the first scalar
      r2 - Force; the second scalar
      rn - Force...; the other scalars
      Returns:
      Force; 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 - 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 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 - double; the value to use
      unitString - 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 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 - Force; scalar
      Returns:
      Dimensionless; 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 - Force; scalar
      Returns:
      Energy; 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 - Force; scalar
      Returns:
      Energy; 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 - Force; scalar
      Returns:
      LinearDensity; 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 - Force; scalar
      Returns:
      Power; 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 - Force; scalar
      Returns:
      Acceleration; 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 - Force; scalar
      Returns:
      Mass; 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 - Force; scalar
      Returns:
      Pressure; 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 - Force; scalar
      Returns:
      Area; 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.
      Specified by:
      reciprocal in class DoubleScalarRel<ForceUnit,Force>
      Returns:
      DoubleScalar<?>; a new scalar instance with correct SI dimensions