Interface SensitivityFactorsProvider

  • All Known Implementing Classes:
    JsonSensitivityFactorsProvider

    public interface SensitivityFactorsProvider
    Sensitivity factors provider

    Used to generate a list of sensitivity factors to be used has inputs for sensitivity analysis.

    Sensitivity factors are defined through the combination of a common factors list, that must be computed on all states (base case and any contingency) and additional ones by state.
    Author:
    Sebastien Murgey <sebastien.murgey at rte-france.com>
    See Also:
    SensitivityFactor
    • Method Detail

      • getCommonFactors

        List<SensitivityFactor> getCommonFactors​(Network network)
        Get the list of factors that are common to base case and all contingencies, generated based on the given network
        Parameters:
        network - Base IIDM network of provision method
        Returns:
        A list of sensitivity factors
      • getAdditionalFactors

        default List<SensitivityFactor> getAdditionalFactors​(Network network)
        Get the list of additional factors specific to base case.
        Parameters:
        network - Base IIDM network of provision method
        Returns:
        A list of sensitivity factors
      • getAdditionalFactors

        default List<SensitivityFactor> getAdditionalFactors​(Network network,
                                                             String contingencyId)
        Get the list of additional factors specific to a given contingency
        Parameters:
        network - Base IIDM network of provision method
        contingencyId - Id of the contingency for which we want the factors.
        Returns:
        A list of sensitivity factors