com.powsybl.openloadflow.lf.outerloop.OuterLoop Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2019, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 * SPDX-License-Identifier: MPL-2.0
 */
package com.powsybl.openloadflow.lf.outerloop;

import com.powsybl.commons.report.ReportNode;
import com.powsybl.openloadflow.equations.Quantity;
import com.powsybl.openloadflow.lf.AbstractLoadFlowParameters;
import com.powsybl.openloadflow.lf.LoadFlowContext;

/**
 * @author Geoffroy Jamgotchian {@literal }
 */
public interface OuterLoop & Quantity,
                           E extends Enum & Quantity,
                           P extends AbstractLoadFlowParameters,
                           C extends LoadFlowContext,
                           O extends OuterLoopContext> {

    String getName();

    default String getType() {
        return getName();
    }

    default void initialize(O context) {
    }

    OuterLoopResult check(O context, ReportNode reportNode);

    default void cleanup(O context) {
    }
}