Package org.djunits.value.vdouble.scalar

Class Density

java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,​S>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar<U,​R>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel<DensityUnit,​Density>
org.djunits.value.vdouble.scalar.Density
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Density>, Scalar<DensityUnit,​Density>, Scalar.Rel<DensityUnit,​Density>, ValueFunctions<DensityUnit,​Density>, Relative<DensityUnit,​Density>, Value<DensityUnit,​Density>, DoubleScalarInterface<DensityUnit,​Density>, DoubleScalarInterface.Rel<DensityUnit,​Density>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2020-01-19T15:21:24.964166400Z")
public class Density
extends AbstractDoubleScalarRel<DensityUnit,​Density>
Easy access methods for the Density DoubleScalar, which is relative by definition.

Copyright (c) 2013-2020 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 Details

  • Constructor Details

    • Density

      public Density​(double value, DensityUnit unit)
      Construct Density scalar.
      Parameters:
      value - double; the double value
      unit - DensityUnit; unit for the double value

    • Density

      public Density​(Density value)
      Construct Density scalar.
      Parameters:
      value - Density; Scalar from which to construct this instance

  • Method Details

    • instantiateRel

      public final Density instantiateRel​(double value, DensityUnit unit)
      Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
      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 Density instantiateSI​(double value)
      Construct Density scalar.
      Parameters:
      value - double; the double value in SI units
      Returns:
      Density; the new scalar with the SI value

    • interpolate

      public static Density interpolate​(Density zero, Density one, double ratio)
      Interpolate between two values.
      Parameters:
      zero - Density; the low value
      one - Density; the high value
      ratio - double; the ratio between 0 and 1, inclusive
      Returns:
      Density; a Scalar at the ratio between

    • max

      public static Density max​(Density r1, Density r2)
      Return the maximum value of two relative scalars.
      Parameters:
      r1 - Density; the first scalar
      r2 - Density; the second scalar
      Returns:
      Density; the maximum value of two relative scalars

    • max

      public static Density max​(Density r1, Density r2, Density... rn)
      Return the maximum value of more than two relative scalars.
      Parameters:
      r1 - Density; the first scalar
      r2 - Density; the second scalar
      rn - Density...; the other scalars
      Returns:
      Density; the maximum value of more than two relative scalars

    • min

      public static Density min​(Density r1, Density r2)
      Return the minimum value of two relative scalars.
      Parameters:
      r1 - Density; the first scalar
      r2 - Density; the second scalar
      Returns:
      Density; the minimum value of two relative scalars

    • min

      public static Density min​(Density r1, Density r2, Density... rn)
      Return the minimum value of more than two relative scalars.
      Parameters:
      r1 - Density; the first scalar
      r2 - Density; the second scalar
      rn - Density...; the other scalars
      Returns:
      Density; the minimum value of more than two relative scalars

    • valueOf

      public static Density valueOf​(String text)
      Returns a Density 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 required, between the value and the unit.
      Parameters:
      text - String; the textual representation to parse into a Density
      Returns:
      Density; 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 Density of​(double value, String unitString)
      Returns a Density based on a value and the textual representation of the unit.
      Parameters:
      value - double; the value to use
      unitString - String; the textual representation of the unit
      Returns:
      Density; 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​(Density v)
      Calculate the division of Density and Density, which results in a Dimensionless scalar.
      Parameters:
      v - Density scalar
      Returns:
      Dimensionless scalar as a division of Density and Density

    • times

      public final Mass times​(Volume v)
      Calculate the multiplication of Density and Volume, which results in a Mass scalar.
      Parameters:
      v - Density scalar
      Returns:
      Mass scalar as a multiplication of Density and Volume

    • times

      public final FlowMass times​(FlowVolume v)
      Calculate the multiplication of Density and FlowVolume, which results in a FlowMass scalar.
      Parameters:
      v - Density scalar
      Returns:
      FlowMass scalar as a multiplication of Density and FlowVolume