Package org.djunits.value.vdouble.scalar

Class Volume

    • Field Detail

      • ZERO

        public static final Volume ZERO
        Constant with value zero.

      • ONE

        public static final Volume ONE
        Constant with value one.

      • NaN

        public static final Volume NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final Volume POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final Volume NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final Volume POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final Volume NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • Volume

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

      • Volume

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • times

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

      • times

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

      • divide

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

      • divide

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

      • times

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

      • divide

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

      • divide

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