Package org.djunits.value.vdouble.scalar

Class MagneticFlux

    • Field Detail

      • ZERO

        public static final MagneticFlux ZERO
        Constant with value zero.

      • ONE

        public static final MagneticFlux ONE
        Constant with value one.

      • NaN

        public static final MagneticFlux NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final MagneticFlux POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final MagneticFlux NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final MagneticFlux POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final MagneticFlux NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • MagneticFlux

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

      • MagneticFlux

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • divide

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

      • divide

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

      • divide

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

      • divide

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

      • divide

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

      • divide

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