DynawoModelsSupplier.java

/**
 * Copyright (c) 2024, 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.dynawo.suppliers.dynamicmodels;

import com.powsybl.commons.PowsyblException;
import com.powsybl.commons.report.ReportNode;
import com.powsybl.dynamicsimulation.DynamicModel;
import com.powsybl.dynamicsimulation.DynamicModelsSupplier;
import com.powsybl.dynawo.DynawoSimulationProvider;
import com.powsybl.dynawo.builders.ModelBuilder;
import com.powsybl.dynawo.builders.ModelConfigsHandler;
import com.powsybl.dynawo.suppliers.Property;
import com.powsybl.dynawo.suppliers.SupplierJsonDeserializer;
import com.powsybl.iidm.network.Network;

import java.io.InputStream;
import java.lang.reflect.InvocationTargetException;
import java.nio.file.Path;
import java.util.List;
import java.util.Objects;

import static com.powsybl.dynawo.DynawoSimulationReports.createDynawoModelSupplierReportNode;

/**
 * Instantiates an {@link DynamicModelConfig} list from {@link DynamicModelConfig} or JSON input
 * @author Laurent Issertial {@literal <laurent.issertial at rte-france.com>}
 */
public class DynawoModelsSupplier implements DynamicModelsSupplier {

    private static final String PARAMETER_ID_FIELD = "parameterSetId";

    private final List<DynamicModelConfig> dynamicModelConfigs;

    public static DynawoModelsSupplier load(InputStream is) {
        return new DynawoModelsSupplier(new SupplierJsonDeserializer<>(new DynamicModelConfigsJsonDeserializer()).deserialize(is));
    }

    public static DynawoModelsSupplier load(Path path) {
        return new DynawoModelsSupplier(new SupplierJsonDeserializer<>(new DynamicModelConfigsJsonDeserializer()).deserialize(path));
    }

    public DynawoModelsSupplier(List<DynamicModelConfig> dynamicModelConfigs) {
        this.dynamicModelConfigs = dynamicModelConfigs;
    }

    @Override
    public String getName() {
        return DynawoSimulationProvider.NAME;
    }

    @Override
    public List<DynamicModel> get(Network network, ReportNode reportNode) {
        ReportNode supplierReportNode = createDynawoModelSupplierReportNode(reportNode);
        return dynamicModelConfigs.stream()
                .map(dynamicModelConfig -> buildDynamicModel(dynamicModelConfig, network, supplierReportNode))
                .filter(Objects::nonNull)
                .toList();
    }

    private static DynamicModel buildDynamicModel(DynamicModelConfig dynamicModelConfig, Network network, ReportNode reportNode) {
        ModelBuilder<DynamicModel> builder = ModelConfigsHandler.getInstance().getModelBuilder(network, dynamicModelConfig.model(), reportNode);
        if (builder != null) {
            Class<? extends ModelBuilder> builderClass = builder.getClass();
            invokeParameterIdMethod(builderClass, builder, getParameterSetId(dynamicModelConfig));
            dynamicModelConfig.properties().forEach(p -> invokeMethod(builderClass, builder, p));
            return builder.build();
        }
        return null;
    }

    private static void invokeMethod(Class<? extends ModelBuilder> builderClass, ModelBuilder<DynamicModel> builder, Property property) {
        try {
            builderClass.getMethod(property.name(), property.propertyClass()).invoke(builder, property.value());
        } catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
            throw new PowsyblException(String.format("Method %s not found for parameter %s on builder %s", property.name(), property.value(), builderClass.getSimpleName()), e);
        }
    }

    private static void invokeParameterIdMethod(Class<? extends ModelBuilder> builderClass, ModelBuilder<DynamicModel> builder, String parameterSetId) {
        try {
            builderClass.getMethod(DynawoModelsSupplier.PARAMETER_ID_FIELD, String.class).invoke(builder, parameterSetId);
        } catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
            throw new PowsyblException(String.format("Method %s not found for parameter %s on builder %s", DynawoModelsSupplier.PARAMETER_ID_FIELD, parameterSetId, builderClass.getSimpleName()), e);
        }
    }

    private static String getParameterSetId(DynamicModelConfig config) {
        return switch (config.groupType()) {
            case FIXED -> config.group();
            case PREFIX -> config.group() + getDynamicModelIdProperty(config.properties());
            case SUFFIX -> getDynamicModelIdProperty(config.properties()) + config.group();
        };
    }

    private static String getDynamicModelIdProperty(List<Property> properties) {
        return properties.stream()
                .filter(p -> p.name().equalsIgnoreCase("dynamicModelId"))
                .map(p -> (String) p.value())
                .findFirst()
                .orElseGet(() -> getStaticIdProperty(properties));
    }

    private static String getStaticIdProperty(List<Property> properties) {
        return properties.stream()
                .filter(p -> p.name().equalsIgnoreCase("staticId"))
                .map(p -> (String) p.value())
                .findFirst()
                .orElseThrow(() -> new PowsyblException("No ID found for parameter set id"));
    }
}