Package org.djunits.quantity

Class VolumetricObjectDensity

java.lang.Object
java.lang.Number
org.djunits.quantity.def.Quantity<VolumetricObjectDensity,VolumetricObjectDensity.Unit>
org.djunits.quantity.VolumetricObjectDensity
All Implemented Interfaces:
Serializable, Comparable<VolumetricObjectDensity>, Additive<VolumetricObjectDensity>, Scalable<VolumetricObjectDensity>, Value<VolumetricObjectDensity.Unit,VolumetricObjectDensity>
public class VolumetricObjectDensity extends Quantity<VolumetricObjectDensity,VolumetricObjectDensity.Unit>
Volumetric object density counts the number of objects per unit of volume, measured in number per cubic meter (/m3).

Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djunits.org. The DJUNITS project is distributed under a three-clause BSD-style license.

Author:
Alexander Verbraeck
See Also:

  • Field Details

  • Constructor Details

    • VolumetricObjectDensity

      public VolumetricObjectDensity(double value, VolumetricObjectDensity.Unit unit)
      Instantiate a VolumetricObjectDensity quantity with a unit.
      Parameters:
      value - the value, expressed in the unit
      unit - the unit in which the value is expressed

    • VolumetricObjectDensity

      public VolumetricObjectDensity(double value, String abbreviation)
      Instantiate a VolumetricObjectDensity quantity with a unit, expressed as a String.
      Parameters:
      value - the value, expressed in the unit
      abbreviation - the String abbreviation of the unit in which the value is expressed

    • VolumetricObjectDensity

      public VolumetricObjectDensity(VolumetricObjectDensity value)
      Construct VolumetricObjectDensity quantity.
      Parameters:
      value - Scalar from which to construct this instance

  • Method Details

    • ofSi

      public static VolumetricObjectDensity ofSi(double si)
      Return a VolumetricObjectDensity instance based on an SI value.
      Parameters:
      si - the si value
      Returns:
      the VolumetricObjectDensity instance based on an SI value

    • instantiate

      public VolumetricObjectDensity instantiate(double si)
      Description copied from class: Quantity
      Instantiate a quantity with an SI or base value.
      Specified by:
      instantiate in class Quantity<VolumetricObjectDensity,VolumetricObjectDensity.Unit>
      Parameters:
      si - the value expressed in the base (SI) unit
      Returns:
      a quantity with the given SI-value and base (SI) unit

    • siUnit

      public SIUnit siUnit()
      Description copied from class: Quantity
      Return the SI unit of this quantity.
      Overrides:
      siUnit in class Quantity<VolumetricObjectDensity,VolumetricObjectDensity.Unit>
      Returns:
      the SI unit of this quantity

    • valueOf

      public static VolumetricObjectDensity valueOf(String text)
      Returns a VolumetricObjectDensity 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 VolumetricObjectDensity
      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 VolumetricObjectDensity of(double value, String unitString)
      Returns a VolumetricObjectDensity 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

    • multiply

      public final Dimensionless multiply(Volume volume)
      Multiplies this volumetric object density by a volume to yield a dimensionless count.

      Formula: (1/m³) x m³ = 1.

      Parameters:
      volume - the volume multiplier; must not be null.
      Returns:
      the resulting dimensionless count in SI (1).
      Throws:
      NullPointerException - if volume is null.

    • multiply

      public final LinearObjectDensity multiply(Area area)
      Multiplies this volumetric object density by an area to yield a linear object density.

      Formula: (1/m³) x m² = 1/m.

      Parameters:
      area - the area multiplier; must not be null.
      Returns:
      the resulting linear object density in SI (1/m).
      Throws:
      NullPointerException - if area is null.

    • multiply

      public final ArealObjectDensity multiply(Length length)
      Multiplies this volumetric object density by a length to yield an areal object density.

      Formula: (1/m³) x m = 1/m².

      Parameters:
      length - the length multiplier; must not be null.
      Returns:
      the resulting areal object density in SI (1/m²).
      Throws:
      NullPointerException - if length is null.

    • divide

      public final ArealObjectDensity divide(LinearObjectDensity lod)
      Divides this volumetric object density by a linear object density to yield an areal object density.

      Formula: (1/m³) / (1/m) = 1/m².

      Parameters:
      lod - the linear object density divisor; must not be null.
      Returns:
      the resulting areal object density in SI (1/m²).
      Throws:
      NullPointerException - if lod is null.

    • divide

      public final LinearObjectDensity divide(ArealObjectDensity aod)
      Divides this volumetric object density by an areal object density to yield a linear object density.

      Formula: (1/m³) / (1/m²) = 1/m.

      Parameters:
      aod - the areal object density divisor; must not be null.
      Returns:
      the resulting linear object density in SI (1/m).
      Throws:
      NullPointerException - if aod is null.

    • divide

      public final Dimensionless divide(VolumetricObjectDensity other)
      Divides this volumetric object density by another volumetric object density to yield a dimensionless ratio.

      Formula: (1/m³) / (1/m³) = 1.

      Parameters:
      other - the volumetric object density divisor; must not be null.
      Returns:
      the resulting dimensionless ratio in SI (1).
      Throws:
      NullPointerException - if other is null.

    • reciprocal

      public Volume reciprocal()
      Description copied from class: Quantity
      Return the reciprocal of this quantity (1/q).
      Overrides:
      reciprocal in class Quantity<VolumetricObjectDensity,VolumetricObjectDensity.Unit>
      Returns:
      the reciprocal of this quantity, with the correct SI units