Package com.powsybl.iidm.modification.scalable

Interface Scalable

  • All Known Implementing Classes:
    DanglingLineScalable
    public interface Scalable
    Author:
    Geoffroy Jamgotchian , Ameni Walha

    • Method Detail

      • initialValue

        double initialValue​(Network n)
        Get the constant active power in MW injected at the network.

      • reset

        void reset​(Network n)
        Set the constant active power to zero.

      • maximumValue

        double maximumValue​(Network n)
        Get the maximal active power in MW. Uses Generator convention by default

      • minimumValue

        double minimumValue​(Network n)
        Get the minimal active power in MW. Uses Generator convention by default

      • filterInjections

        void filterInjections​(Network network,
                      List<Injection> injections,
                      List<String> notFound)
        Scans all the expected injections of the scalable. If the injection can be found in given network, it is added the the injections list. Otherwise, its identifier is added to the "notFound" list.
        Parameters:
        network - network
        injections - network injections used in the scalable
        notFound - expected injections not found in the network

      • filterInjections

        List<Injection> filterInjections​(Network network,
                                 List<String> notFound)
        Scans all the expected injections of the scalable. If the injection can be found in given network, it is added the the injections list. Otherwise, its identifier is added to the "notFound" list.
        Parameters:
        network - network
        notFound - expected injections not found in the network
        Returns:
        network injections used in the scalable

      • filterInjections

        List<Injection> filterInjections​(Network network)
        Scans all the expected injections of the scalable. If the injection can be found in given network, it is added the the injections list.
        Parameters:
        network - network
        Returns:
        network injections used in the scalable

      • scale

        double scale​(Network n,
             double asked)
        Scale the given network using Generator convention by default. The actual scaling value may be different to the one asked, if the Scalable limit is reached.
        Parameters:
        n - network
        asked - value asked to adjust the scalable active power
        Returns:
        the actual value of the scalable active power adjustment

      • scale

        double scale​(Network n,
             double asked,
             Scalable.ScalingConvention scalingConvention)
        Scale the given network. The actual scaling value may be different to the one asked, if the Scalable limit is reached.
        Parameters:
        n - network
        asked - value asked to adjust the scalable active power
        scalingConvention - power convention used for scaling
        Returns:
        the actual value of the scalable active power adjustment
        See Also:
        Scalable.ScalingConvention

      • scaleWithConstantPowerFactor

        default double scaleWithConstantPowerFactor​(Network n,
                                            double asked)
        Scale the given network using Generator convention by default. If the object is a load, scaling is done with constant power factor.
        Parameters:
        n - network
        asked - value asked to adjust the scalable active power and reactive power if load
        Returns:
        the actual value of the scalable active power adjustment

      • scaleWithConstantPowerFactor

        default double scaleWithConstantPowerFactor​(Network n,
                                            double asked,
                                            Scalable.ScalingConvention scalingConvention)
        Scale the given network. The actual scaling value may be different to the one asked, if the Scalable limit is reached. If the Scalable is a load, the power factor is kept constant.
        Parameters:
        n - network
        asked - value asked to adjust the scalable active power and reactive power if load
        scalingConvention - power convention used for scaling
        Returns:
        the actual value of the scalable active power adjustment

      • gen

        @Deprecated
static com.powsybl.iidm.modification.scalable.GeneratorScalable gen​(String id)
        Deprecated.
        gen should be replaced by onGenerator

      • onGenerator

        static com.powsybl.iidm.modification.scalable.GeneratorScalable onGenerator​(String id)
        create GeneratorScalable with id

      • onGenerator

        static com.powsybl.iidm.modification.scalable.GeneratorScalable onGenerator​(String id,
                                                                            double minValue,
                                                                            double maxValue)
        create GeneratorScalable with id, min and max power values for scaling

      • onLoad

        static com.powsybl.iidm.modification.scalable.LoadScalable onLoad​(String id)
        create LoadScalable with id

      • onLoad

        static com.powsybl.iidm.modification.scalable.LoadScalable onLoad​(String id,
                                                                  double minValue,
                                                                  double maxValue)
        create LoadScalable with id, min and max power values for scaling

      • onDanglingLine

        static DanglingLineScalable onDanglingLine​(String id)
        create DanglingLineScalable with id. The generator scaling convention is used by default.

      • onDanglingLine

        static DanglingLineScalable onDanglingLine​(String id,
                                           double minValue,
                                           double maxValue)
        create DanglingLineScalable with id, min and max power values for scaling. The generator scaling convention is used by default.

      • onDanglingLine

        static DanglingLineScalable onDanglingLine​(String id,
                                           double minValue,
                                           double maxValue,
                                           Scalable.ScalingConvention scalingConvention)
        create DanglingLineScalable with id, min and max power values for scaling and the scaling convention that will be used.

      • proportional

        static com.powsybl.iidm.modification.scalable.ProportionalScalable proportional​(List<Float> percentages,
                                                                                List<Scalable> scalables)

      • proportional

        static com.powsybl.iidm.modification.scalable.ProportionalScalable proportional​(List<Float> percentages,
                                                                                List<Scalable> scalables,
                                                                                boolean iterative)

      • proportional

        static com.powsybl.iidm.modification.scalable.ProportionalScalable proportional​(float percentage,
                                                                                Scalable scalable)

      • proportional

        static com.powsybl.iidm.modification.scalable.ProportionalScalable proportional​(float percentage1,
                                                                                Scalable scalable1,
                                                                                float percentage2,
                                                                                Scalable scalable2)

      • proportional

        static com.powsybl.iidm.modification.scalable.ProportionalScalable proportional​(float percentage1,
                                                                                Scalable scalable1,
                                                                                float percentage2,
                                                                                Scalable scalable2,
                                                                                float percentage3,
                                                                                Scalable scalable3)

      • proportional

        static com.powsybl.iidm.modification.scalable.ProportionalScalable proportional​(float percentage1,
                                                                                Scalable scalable1,
                                                                                float percentage2,
                                                                                Scalable scalable2,
                                                                                float percentage3,
                                                                                Scalable scalable3,
                                                                                float percentage4,
                                                                                Scalable scalable4)

      • proportional

        static com.powsybl.iidm.modification.scalable.ProportionalScalable proportional​(float percentage1,
                                                                                Scalable scalable1,
                                                                                float percentage2,
                                                                                Scalable scalable2,
                                                                                float percentage3,
                                                                                Scalable scalable3,
                                                                                float percentage4,
                                                                                Scalable scalable4,
                                                                                float percentage5,
                                                                                Scalable scalable5)

      • stack

        static com.powsybl.iidm.modification.scalable.StackScalable stack​(Scalable... scalables)

      • stack

        static com.powsybl.iidm.modification.scalable.StackScalable stack​(String... ids)

      • upDown

        static com.powsybl.iidm.modification.scalable.UpDownScalable upDown​(Scalable upScalable,
                                                                    Scalable downScalable)