Package org.djunits.value.vfloat.scalar

Class FloatFlowVolume

    • Field Detail

      • POSITIVE_INFINITY

        public static final FloatFlowVolume POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final FloatFlowVolume NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final FloatFlowVolume POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final FloatFlowVolume NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • FloatFlowVolume

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

      • FloatFlowVolume

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

      • FloatFlowVolume

        public FloatFlowVolume​(double value,
                       FlowVolumeUnit unit)
        Construct FloatFlowVolume scalar using a double value.
        Parameters:
        value - double; the double value
        unit - unit for the resulting float value

    • Method Detail

      • instantiateRel

        public final FloatFlowVolume instantiateRel​(float value,
                                            FlowVolumeUnit unit)
        Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.
        Parameters:
        value - float; the float value
        unit - U; the unit
        Returns:
        R a new relative instance of the FloatScalar of the right type

      • instantiateSI

        public static final FloatFlowVolume instantiateSI​(float value)
        Construct FloatFlowVolume scalar.
        Parameters:
        value - float; the float value in SI units
        Returns:
        the new scalar with the SI value

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • times

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

      • divide

        public final FloatVolume divide​(FloatFrequency v)
        Calculate the division of FloatFlowVolume and FloatFrequency, which results in a FloatVolume scalar.
        Parameters:
        v - FloatFlowVolume; scalar
        Returns:
        FloatVolume; scalar as a division of FloatFlowVolume and FloatFrequency

      • divide

        public final FloatFrequency divide​(FloatVolume v)
        Calculate the division of FloatFlowVolume and FloatVolume, which results in a FloatFrequency scalar.
        Parameters:
        v - FloatFlowVolume; scalar
        Returns:
        FloatFrequency; scalar as a division of FloatFlowVolume and FloatVolume

      • divide

        public final FloatSpeed divide​(FloatArea v)
        Calculate the division of FloatFlowVolume and FloatArea, which results in a FloatSpeed scalar.
        Parameters:
        v - FloatFlowVolume; scalar
        Returns:
        FloatSpeed; scalar as a division of FloatFlowVolume and FloatArea

      • divide

        public final FloatArea divide​(FloatSpeed v)
        Calculate the division of FloatFlowVolume and FloatSpeed, which results in a FloatArea scalar.
        Parameters:
        v - FloatFlowVolume; scalar
        Returns:
        FloatArea; scalar as a division of FloatFlowVolume and FloatSpeed

      • times

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