Class FlowMass

All Implemented Interfaces:
Serializable, Comparable<FlowMass>, Additive<FlowMass>, Scalable<FlowMass>, Value<FlowMass.Unit,FlowMass>

public class FlowMass extends Quantity<FlowMass,FlowMass.Unit>
Flow mass: The rate of mass passing through a surface per unit time, measured in kilograms per second (kg/s).

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

    • ZERO

      public static final FlowMass ZERO
      Constant with value zero.
    • ONE

      public static final FlowMass ONE
      Constant with value one.
    • NaN

      public static final FlowMass NaN
      Constant with value NaN.
    • POSITIVE_INFINITY

      public static final FlowMass POSITIVE_INFINITY
      Constant with value POSITIVE_INFINITY.
    • NEGATIVE_INFINITY

      public static final FlowMass NEGATIVE_INFINITY
      Constant with value NEGATIVE_INFINITY.
    • POS_MAXVALUE

      public static final FlowMass POS_MAXVALUE
      Constant with value MAX_VALUE.
    • NEG_MAXVALUE

      public static final FlowMass NEG_MAXVALUE
      Constant with value -MAX_VALUE.
  • Constructor Details

    • FlowMass

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

      public FlowMass(double value, String abbreviation)
      Instantiate a FlowMass 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
    • FlowMass

      public FlowMass(FlowMass value)
      Construct FlowMass quantity.
      Parameters:
      value - Scalar from which to construct this instance
  • Method Details

    • ofSi

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

      public FlowMass instantiate(double si)
      Description copied from class: Quantity
      Instantiate a quantity with an SI or base value.
      Specified by:
      instantiate in class Quantity<FlowMass,FlowMass.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<FlowMass,FlowMass.Unit>
      Returns:
      the SI unit of this quantity
    • valueOf

      public static FlowMass valueOf(String text)
      Returns a FlowMass 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 FlowMass
      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 FlowMass of(double value, String unitString)
      Returns a FlowMass 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(FlowMass v)
      Calculate the division of FlowMass and FlowMass, which results in a Dimensionless quantity.
      Parameters:
      v - quantity
      Returns:
      quantity as a division of FlowMass and FlowMass
    • multiply

      public final Mass multiply(Duration v)
      Calculate the multiplication of FlowMass and Duration, which results in a Mass scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of FlowMass and Duration
    • divide

      public final Mass divide(Frequency v)
      Calculate the division of FlowMass and Frequency, which results in a Mass scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of FlowMass and Frequency
    • divide

      public final Frequency divide(Mass v)
      Calculate the division of FlowMass and Mass, which results in a Frequency scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of FlowMass and Mass
    • multiply

      public final Force multiply(Speed v)
      Calculate the multiplication of FlowMass and Speed, which results in a Force scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of FlowMass and Speed
    • divide

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

      public final FlowVolume divide(Density v)
      Calculate the division of FlowMass and Density, which results in a FlowVolume scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of FlowMass and Density
    • multiply

      public final Momentum multiply(Length v)
      Calculate the multiplication of FlowMass and Length, which results in a Momentum scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of FlowMass and Length