Package org.djunits.value.vfloat.scalar

Class FloatPressure

    • Field Detail

      • ZERO

        public static final FloatPressure ZERO
        Constant with value zero.

      • ONE

        public static final FloatPressure ONE
        Constant with value one.

      • NaN

        public static final FloatPressure NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final FloatPressure POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final FloatPressure NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final FloatPressure POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final FloatPressure NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • FloatPressure

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

      • FloatPressure

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

      • FloatPressure

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • times

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

      • times

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