Package org.djunits.value.vdouble.scalar

Class FlowVolume

    • Field Detail

      • ZERO

        public static final FlowVolume ZERO
        Constant with value zero.

      • ONE

        public static final FlowVolume ONE
        Constant with value one.

      • NaN

        public static final FlowVolume NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final FlowVolume POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final FlowVolume NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final FlowVolume POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final FlowVolume NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • FlowVolume

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

      • FlowVolume

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • times

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

      • divide

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

      • divide

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

      • divide

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

      • divide

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

      • times

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