Skip to content

Main model refactoring: move calculation logic out of main model #1286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mgovers wants to merge 13 commits into
base: main
Choose a base branch
from
+188 −142
Open

Main model refactoring: move calculation logic out of main model #1286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
fd7ecde
split calculation typing out of main model impl
mgovers Jan 20, 2026
6908f46
move calculator implementation detail logic out of main model impl (wip)
mgovers Jan 21, 2026
fc1078a
Merge remote-tracking branch 'origin/main' into feature/calculation-o…
mgovers Jan 27, 2026
d6ac715
homogenize
mgovers Jan 27, 2026
4f61d49
more homogenize
mgovers Jan 27, 2026
6ca9d39
cleanup
mgovers Jan 28, 2026
0713681
Merge branch 'main' into feature/calculation-out-of-main-model
mgovers Jan 28, 2026
118fcae
use custom enumerate because views::enumerate not available on all pl…
mgovers Jan 28, 2026
897fa99
use views enumerate overload when not provided
mgovers Jan 28, 2026
5cddc0d
sonar
mgovers Jan 28, 2026
2afbb9c
Merge branch 'main' into feature/calculation-out-of-main-model
mgovers Jan 28, 2026
356b2dd
clang-tidy
mgovers Jan 28, 2026
a431da9
Update power_grid_model_c/power_grid_model/include/power_grid_model/c…
mgovers Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,18 @@ project(power_grid_model VERSION ${PGM_VERSION})

option(PGM_ENABLE_DEV_BUILD "Enable developer build (e.g.: tests)" OFF)

set(CMAKE_CXX_STANDARD 23)
set(PGM_C_STANDARD 11)
set(PGM_CXX_STANDARD 23)

if(NOT CMAKE_CXX_STANDARD OR CMAKE_CXX_STANDARD LESS ${PGM_CXX_STANDARD})
set(CMAKE_CXX_STANDARD ${PGM_CXX_STANDARD})
endif()
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)
set(CMAKE_CXX_VISIBILITY_PRESET hidden)
set(CMAKE_C_STANDARD 11)
if(NOT CMAKE_C_STANDARD OR CMAKE_C_STANDARD LESS ${PGM_C_STANDARD})
set(CMAKE_C_STANDARD ${PGM_C_STANDARD})
endif()
set(CMAKE_C_STANDARD_REQUIRED ON)
set(CMAKE_C_EXTENSIONS OFF)
set(CMAKE_C_VISIBILITY_PRESET hidden)
Expand Down
122 changes: 122 additions & 0 deletions power_grid_model_c/power_grid_model/include/power_grid_model/calculation.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
// SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
//
// SPDX-License-Identifier: MPL-2.0

#pragma once

#include "main_model_fwd.hpp"

#include "common/common.hpp"
#include "common/enum.hpp"

#include "main_core/calculation_input_preparation.hpp"
#include "main_core/main_model_type.hpp"

namespace power_grid_model {

struct calculation_type_t {};
struct power_flow_t : calculation_type_t {};
struct state_estimation_t : calculation_type_t {};
struct short_circuit_t : calculation_type_t {};

template <typename T>
concept calculation_type_tag = std::derived_from<T, calculation_type_t>;

template <class Functor, class... Args>
decltype(auto) calculation_symmetry_func_selector(CalculationSymmetry calculation_symmetry, Functor&& f,
Args&&... args) {
using enum CalculationSymmetry;

switch (calculation_symmetry) {
case symmetric:
return std::forward<Functor>(f).template operator()<symmetric_t>(std::forward<Args>(args)...);
case asymmetric:
return std::forward<Functor>(f).template operator()<asymmetric_t>(std::forward<Args>(args)...);
default:
throw MissingCaseForEnumError{"Calculation symmetry selector", calculation_symmetry};
}
}

template <class Functor, class... Args>
decltype(auto) calculation_type_func_selector(CalculationType calculation_type, Functor&& f, Args&&... args) {
using enum CalculationType;

switch (calculation_type) {
case CalculationType::power_flow:
return std::forward<Functor>(f).template operator()<power_flow_t>(std::forward<Args>(args)...);
case CalculationType::state_estimation:
return std::forward<Functor>(f).template operator()<state_estimation_t>(std::forward<Args>(args)...);
case CalculationType::short_circuit:
return std::forward<Functor>(f).template operator()<short_circuit_t>(std::forward<Args>(args)...);
default:
throw MissingCaseForEnumError{"CalculationType", calculation_type};
}
}

template <class Functor, class... Args>
decltype(auto) calculation_type_symmetry_func_selector(CalculationType calculation_type,
CalculationSymmetry calculation_symmetry, Functor&& f,
Args&&... args) {
calculation_type_func_selector(
calculation_type,
[]<calculation_type_tag calculation_type, typename Functor_, typename... Args_>(
CalculationSymmetry calculation_symmetry_, Functor_&& f_, Args_&&... args_) {
calculation_symmetry_func_selector(
calculation_symmetry_,
[]<symmetry_tag sym, typename SubFunctor, typename... SubArgs>(SubFunctor&& sub_f,
SubArgs&&... sub_args) {
std::forward<SubFunctor>(sub_f).template operator()<calculation_type, sym>(
std::forward<SubArgs>(sub_args)...);
},
std::forward<Functor_>(f_), std::forward<Args_>(args_)...);
},
calculation_symmetry, std::forward<Functor>(f), std::forward<Args>(args)...);
}

template <typename T, typename sym> struct Calculator;
Copy link
Member

@figueroa1395 figueroa1395 Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, I really like these!


template <symmetry_tag sym> struct Calculator<power_flow_t, sym> {
template <typename State>
static auto preparer(State const& state, ComponentToMathCoupling& /*comp_coup*/,
MainModelOptions const& /*options*/) {
return [&state](Idx n_math_solvers) { return main_core::prepare_power_flow_input<sym>(state, n_math_solvers); };
}
static auto solver(CalculationMethod calculation_method, MainModelOptions const& options, Logger& logger) {
return [calculation_method, err_tol = options.err_tol, max_iter = options.max_iter,
&logger](MathSolverProxy<sym>& solver, YBus<sym> const& y_bus, PowerFlowInput<sym> const& input) {
return solver.get().run_power_flow(input, err_tol, max_iter, logger, calculation_method, y_bus);
};
}
};
template <symmetry_tag sym> struct Calculator<state_estimation_t, sym> {
template <typename State>
static auto preparer(State const& state, ComponentToMathCoupling& /*comp_coup*/,
MainModelOptions const& /*options*/) {
return [&state](Idx n_math_solvers) {
return main_core::prepare_state_estimation_input<sym>(state, n_math_solvers);
};
}
static auto solver(CalculationMethod calculation_method, MainModelOptions const& options, Logger& logger) {
return [calculation_method, err_tol = options.err_tol, max_iter = options.max_iter,
&logger](MathSolverProxy<sym>& solver, YBus<sym> const& y_bus, StateEstimationInput<sym> const& input) {
return solver.get().run_state_estimation(input, err_tol, max_iter, logger, calculation_method, y_bus);
};
}
};

template <symmetry_tag sym> struct Calculator<short_circuit_t, sym> {
template <typename State>
static auto preparer(State const& state, ComponentToMathCoupling& comp_coup, MainModelOptions const& options) {
return [&state, &comp_coup, voltage_scaling = options.short_circuit_voltage_scaling](Idx n_math_solvers) {
return main_core::prepare_short_circuit_input<sym>(state, comp_coup, n_math_solvers, voltage_scaling);
};
}
static auto solver(CalculationMethod calculation_method, MainModelOptions const& /*options*/, Logger& logger) {
return [calculation_method, &logger](MathSolverProxy<sym>& solver, YBus<sym> const& y_bus,
ShortCircuitInput const& input) {
return solver.get().run_short_circuit(input, logger, calculation_method, y_bus);
};
}
};

} // namespace power_grid_model
8 changes: 8 additions & 0 deletions power_grid_model_c/power_grid_model/include/power_grid_model/common/counting_iterator.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,12 @@ struct IdxRange : public std::ranges::iota_view<Idx, Idx> {
};
using IdxCount = typename IdxRange::iterator;

#if __cpp_lib_ranges_enumerate >= 20202L
using std::views::enumerate;
#else
constexpr auto enumerate(std::ranges::viewable_range auto&& rng) {
return std::views::zip(IdxRange{std::ssize(rng)}, rng);
Comment on lines +27 to +28
Copy link
Member

@figueroa1395 figueroa1395 Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rng can be easily miss-interpreted. Can you just use range instead?

Suggested change
constexpr auto enumerate(std::ranges::viewable_range auto&& rng) {
return std::views::zip(IdxRange{std::ssize(rng)}, rng);
constexpr auto enumerate(std::ranges::viewable_range auto&& range) {
return std::views::zip(IdxRange{std::ssize(range)}, range);

Copy link
Member Author

@mgovers mgovers Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

name conflicts 😢

}
#endif

} // namespace power_grid_model
10 changes: 6 additions & 4 deletions ...l_c/power_grid_model/include/power_grid_model/main_core/calculation_input_preparation.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
#pragma once

#include "state_queries.hpp"
#include "y_bus.hpp"

#include "../calculation_parameters.hpp"
#include "../index_mapping.hpp"

#include <concepts>
#include <vector>
Expand Down Expand Up @@ -258,7 +260,7 @@ std::vector<ShortCircuitInput> prepare_short_circuit_input(main_model_state_c au
std::vector<IdxVector> topo_fault_indices(state.math_topology.size());
std::vector<IdxVector> topo_bus_indices(state.math_topology.size());

for (Idx fault_idx{0}; fault_idx < state.components.template size<Fault>(); ++fault_idx) {
for (Idx const fault_idx : IdxRange{state.components.template size<Fault>()}) {
auto const& fault = state.components.template get_item_by_seq<Fault>(fault_idx);
if (fault.status()) {
auto const node_idx = state.components.template get_seq<Node>(fault.get_fault_object());
Expand All @@ -275,11 +277,11 @@ std::vector<ShortCircuitInput> prepare_short_circuit_input(main_model_state_c au
Idx2D{.group = isolated_component, .pos = not_connected});
std::vector<ShortCircuitInput> sc_input(n_math_solvers);

for (Idx i = 0; i != n_math_solvers; ++i) {
for (Idx const i : IdxRange{n_math_solvers}) {
auto map = build_dense_mapping(topo_bus_indices[i], state.math_topology[i]->n_bus());

for (Idx reordered_idx{0}; reordered_idx < static_cast<Idx>(map.reorder.size()); ++reordered_idx) {
fault_coup[topo_fault_indices[i][map.reorder[reordered_idx]]] = Idx2D{.group = i, .pos = reordered_idx};
for (auto&& [reordered_idx, original_idx] : enumerate(map.reorder)) {
fault_coup[topo_fault_indices[i][original_idx]] = Idx2D{.group = i, .pos = reordered_idx};
}

sc_input[i].fault_buses = {from_dense, std::move(map.indvector), state.math_topology[i]->n_bus()};
Expand Down
1 change: 0 additions & 1 deletion power_grid_model_c/power_grid_model/include/power_grid_model/main_core/state_queries.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
#include "../all_components.hpp"

namespace power_grid_model::main_core {

template <std::derived_from<Branch> ComponentType, class ComponentContainer>
requires model_component_state_c<MainModelState, ComponentContainer, ComponentType>
constexpr auto get_branch_nodes(MainModelState<ComponentContainer> const& state, Idx topology_sequence_idx) {
Expand Down
2 changes: 2 additions & 0 deletions power_grid_model_c/power_grid_model/include/power_grid_model/main_core/y_bus.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

#pragma once

#include "math_state.hpp"

#include "../common/common.hpp"

namespace power_grid_model::main_core {
Expand Down
Loading
Loading