Package org.djunits.value.vdouble.scalar

Class ElectricalInductance

    • Constructor Detail

      • ElectricalInductance

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

      • ElectricalInductance

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • times

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