Package org.djunits.value.vdouble.scalar

Class MagneticFluxDensity

    • Constructor Detail

      • MagneticFluxDensity

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

      • MagneticFluxDensity

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • times

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