Package org.djunits.value.vdouble.scalar

Class FlowMass

    • Field Detail

      • 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 Detail

      • FlowMass

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

      • FlowMass

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

    • Method Detail

      • instantiateRel

        public final FlowMass instantiateRel​(double value,
                                     FlowMassUnit 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 FlowMass instantiateSI​(double value)
        Construct FlowMass scalar.
        Parameters:
        value - double; the double value in SI units
        Returns:
        FlowMass; the new scalar with the SI value

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • 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 - String; the textual representation to parse into a FlowMass
        Returns:
        FlowMass; 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 - double; the value to use
        unitString - String; the textual representation of the unit
        Returns:
        FlowMass; 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 scalar.
        Parameters:
        v - FlowMass; scalar
        Returns:
        Dimensionless; scalar as a division of FlowMass and FlowMass

      • times

        public final Mass times​(Duration v)
        Calculate the multiplication of FlowMass and Duration, which results in a Mass scalar.
        Parameters:
        v - FlowMass; scalar
        Returns:
        Mass; 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 - FlowMass; scalar
        Returns:
        Mass; 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 - FlowMass; scalar
        Returns:
        Frequency; scalar as a division of FlowMass and Mass

      • times

        public final Force times​(Speed v)
        Calculate the multiplication of FlowMass and Speed, which results in a Force scalar.
        Parameters:
        v - FlowMass; scalar
        Returns:
        Force; 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 - FlowMass; scalar
        Returns:
        Density; 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 - FlowMass; scalar
        Returns:
        FlowVolume; scalar as a division of FlowMass and Density

      • times

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