Cleanup main model: Clean all includes and make some components to be forward declared

.clang-tidy

@@ -1,6 +1,9 @@
 # SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+
 #
+
 # SPDX-License-Identifier: MPL-2.0
+
 ---
 Checks: '
 -*,
@@ -44,7 +47,6 @@ google-*,
 -google-default-arguments,
 misc-*,
 -misc-confusable-identifiers,
--misc-include-cleaner,
 -misc-no-recursion,
 -misc-non-private-member-variables-in-classes,
 modernize-*,
@@ -68,8 +70,10 @@ readability-*,
 
 WarningsAsErrors: '*'
 
-
 HeaderFilterRegex: '.*'
 
 FormatStyle: file
+
+CheckOptions:
+  misc-include-cleaner.IgnoreHeaders : 'Eigen/.*'  
 ...

power_grid_model_c/power_grid_model/include/power_grid_model/all_components.hpp

@@ -5,7 +5,6 @@
 #pragma once
 
 // define all components
-#include "common/common.hpp"
 #include "common/component_list.hpp"
 // component include
 #include "component/appliance.hpp"

power_grid_model_c/power_grid_model/include/power_grid_model/common/three_phase_tensor.hpp

@@ -9,6 +9,7 @@
 // eigen properties
 #include <Eigen/Dense>
 
+#include <cassert>
 #include <cmath>
 #include <complex>
 #include <utility>

power_grid_model_c/power_grid_model/include/power_grid_model/component/base.hpp

@@ -13,6 +13,7 @@
 #include "../common/enum.hpp"
 
 namespace power_grid_model {
+
 constexpr IntS status_to_int(bool status) { return status ? IntS{1} : IntS{0}; }
 
 class Base {

power_grid_model_c/power_grid_model/include/power_grid_model/component/component.hpp

@@ -36,4 +36,16 @@ concept component_c = requires(T t, T const& ct, typename T::UpdateType u, typen
     { ct.inverse(u) } -> std::same_as<typename T::UpdateType>;
 };
 
+struct load_appliance_t {};
+struct gen_appliance_t {};
+
+template <typename T>
+concept appliance_type_tag = std::same_as<T, load_appliance_t> || std::same_as<T, gen_appliance_t>;
+template <appliance_type_tag T> constexpr bool is_generator_v = std::same_as<T, gen_appliance_t>;
+
+static_assert(appliance_type_tag<load_appliance_t>);
+static_assert(appliance_type_tag<gen_appliance_t>);
+static_assert(!is_generator_v<load_appliance_t>);
+static_assert(is_generator_v<gen_appliance_t>);
+
 } // namespace power_grid_model

power_grid_model_c/power_grid_model/include/power_grid_model/component/load_gen.hpp

@@ -5,7 +5,6 @@
 #pragma once
 
 #include "appliance.hpp"
-#include "base.hpp"
 
 #include "../auxiliary/input.hpp"
 #include "../auxiliary/output.hpp"
@@ -17,18 +16,6 @@
 
 namespace power_grid_model {
 
-struct load_appliance_t {};
-struct gen_appliance_t {};
-
-template <typename T>
-concept appliance_type_tag = std::same_as<T, load_appliance_t> || std::same_as<T, gen_appliance_t>;
-template <appliance_type_tag T> constexpr bool is_generator_v = std::same_as<T, gen_appliance_t>;
-
-static_assert(appliance_type_tag<load_appliance_t>);
-static_assert(appliance_type_tag<gen_appliance_t>);
-static_assert(!is_generator_v<load_appliance_t>);
-static_assert(is_generator_v<gen_appliance_t>);
-
 class GenericLoadGen : public Appliance {
   public:
     using InputType = GenericLoadGenInput;

power_grid_model_c/power_grid_model/include/power_grid_model/component/shunt.hpp

@@ -5,7 +5,6 @@
 #pragma once
 
 #include "appliance.hpp"
-#include "base.hpp"
 
 #include "../auxiliary/input.hpp"
 #include "../auxiliary/output.hpp"

power_grid_model_c/power_grid_model/include/power_grid_model/component/transformer_tap_regulator.hpp

@@ -4,7 +4,6 @@
 
 #pragma once
 
-#include "base.hpp"
 #include "regulator.hpp"
 
 #include "../auxiliary/input.hpp"

power_grid_model_c/power_grid_model/include/power_grid_model/main_core/calculation_input_preparation.hpp

@@ -7,6 +7,14 @@
 #include "state_queries.hpp"
 
 #include "../calculation_parameters.hpp"
+#include "../component/current_sensor.hpp"
+#include "../component/fault.hpp"
+#include "../component/load_gen.hpp"
+#include "../component/node.hpp"
+#include "../component/power_sensor.hpp"
+#include "../component/shunt.hpp"
+#include "../component/source.hpp"
+#include "../component/voltage_sensor.hpp"
 
 #include <concepts>
 #include <vector>

power_grid_model_c/power_grid_model/include/power_grid_model/main_core/container_queries.hpp

@@ -4,7 +4,10 @@
 
 #pragma once
 
-#include "../all_components.hpp"
+#include "../component/base.hpp"
+#include "../component/branch.hpp"
+#include "../component/branch3.hpp"
+#include "../component/regulator.hpp"
 #include "../container.hpp"
 
 namespace power_grid_model::main_core {

power_grid_model_c/power_grid_model/include/power_grid_model/main_core/input.hpp

@@ -4,8 +4,23 @@
 
 #pragma once
 
-#include "../all_components.hpp"
+#include "state.hpp"
+#include "state_queries.hpp"
+
+#include "../component/appliance.hpp"
+#include "../component/base.hpp"
+#include "../component/branch.hpp"
+#include "../component/branch3.hpp"
+#include "../component/current_sensor.hpp"
+#include "../component/fault.hpp"
+#include "../component/node.hpp"
+#include "../component/power_sensor.hpp"
+#include "../component/regulator.hpp"
+#include "../component/transformer_tap_regulator.hpp"
+#include "../component/voltage_sensor.hpp"
+
 #include "../common/iterator_facade.hpp"
+#include "../component/component.hpp"
 
 #include <unordered_set>
 

power_grid_model_c/power_grid_model/include/power_grid_model/main_core/main_model_type.hpp

@@ -4,14 +4,57 @@
 
 #pragma once
 
-#include "../all_components.hpp"
+#include "../component/component.hpp"
 #include "../container.hpp"
 #include "state.hpp"
 #include "update.hpp"
 
 #include <array>
 #include <vector>
-namespace power_grid_model::main_core {
+namespace power_grid_model {
+
+class Base;
+class Node;
+class Branch;
+class Branch3;
+class Appliance;
+class GenericLoadGen;
+class GenericLoad;
+class GenericGenerator;
+class GenericPowerSensor;
+class GenericVoltageSensor;
+class GenericCurrentSensor;
+class Regulator;
+class Line;
+class AsymLine;
+class Link;
+class GenericBranch;
+class Transformer;
+class ThreeWindingTransformer;
+class Shunt;
+class Source;
+
+template <symmetry_tag loadgen_symmetry_, appliance_type_tag appliance_type_> class LoadGen;
+using SymGenerator = LoadGen<symmetric_t, gen_appliance_t>;
+using AsymGenerator = LoadGen<asymmetric_t, gen_appliance_t>;
+using SymLoad = LoadGen<symmetric_t, load_appliance_t>;
+using AsymLoad = LoadGen<asymmetric_t, load_appliance_t>;
+
+template <symmetry_tag power_sensor_symmetry_> class PowerSensor;
+using SymPowerSensor = PowerSensor<symmetric_t>;
+using AsymPowerSensor = PowerSensor<asymmetric_t>;
+
+template <symmetry_tag sym> class VoltageSensor;
+using SymVoltageSensor = VoltageSensor<symmetric_t>;
+using AsymVoltageSensor = VoltageSensor<asymmetric_t>;
+template <symmetry_tag sym> class CurrentSensor;
+using SymCurrentSensor = CurrentSensor<symmetric_t>;
+using AsymCurrentSensor = CurrentSensor<asymmetric_t>;
+
+class Fault;
+class TransformerTapRegulator;
+
+namespace main_core {
 
 namespace detail {
 
@@ -125,4 +168,5 @@ struct is_main_model_type<MainModelType<ExtraRetrievableTypes<ETs...>, Component
 
 template <typename T> inline constexpr bool is_main_model_type_v = is_main_model_type<T>::value;
 
-} // namespace power_grid_model::main_core
+} // namespace main_core
+} // namespace power_grid_model

power_grid_model_c/power_grid_model/include/power_grid_model/main_core/output.hpp

@@ -4,11 +4,23 @@
 
 #pragma once
 
+#include "../component/base.hpp"
+#include "../component/branch.hpp"
+#include "../component/branch3.hpp"
+#include "../component/current_sensor.hpp"
+#include "../component/fault.hpp"
+#include "../component/load_gen.hpp"
+#include "../component/node.hpp"
+#include "../component/power_sensor.hpp"
+#include "../component/shunt.hpp"
+#include "../component/source.hpp"
+#include "../component/transformer_tap_regulator.hpp"
+#include "../component/voltage_sensor.hpp"
 #include "container_queries.hpp"
 #include "state.hpp"
 #include "state_queries.hpp"
 
-#include "../all_components.hpp"
+#include "../component/component.hpp"
 
 #include <concepts>
 
@@ -115,14 +127,14 @@ constexpr void produce_output(MainModelState<ComponentContainer> const& state, C
 
 // output node
 template <std::derived_from<Node> Component, steady_state_solver_output_type SolverOutputType>
-constexpr auto output_result(Node const& node, std::vector<SolverOutputType> const& solver_output, Idx2D math_id) {
+constexpr auto output_result(Component const& node, std::vector<SolverOutputType> const& solver_output, Idx2D math_id) {
     using sym = typename SolverOutputType::sym;
 
     if (math_id.group == -1) {
-        return node.get_null_output<sym>();
+        return node.template get_null_output<sym>();
     }
-    return node.get_output<sym>(solver_output[math_id.group].u[math_id.pos],
-                                solver_output[math_id.group].bus_injection[math_id.pos]);
+    return node.template get_output<sym>(solver_output[math_id.group].u[math_id.pos],
+                                         solver_output[math_id.group].bus_injection[math_id.pos]);
 }
 template <std::derived_from<Node> Component, short_circuit_solver_output_type SolverOutputType>
 inline auto output_result(Component const& node, std::vector<SolverOutputType> const& solver_output, Idx2D math_id) {

power_grid_model_c/power_grid_model/include/power_grid_model/main_core/state_queries.hpp

@@ -6,7 +6,11 @@
 
 #include "state.hpp"
 
-#include "../all_components.hpp"
+#include "../component/branch.hpp"
+#include "../component/branch3.hpp"
+#include "../component/node.hpp"
+#include "../component/regulator.hpp"
+#include "../component/transformer.hpp"
 
 namespace power_grid_model::main_core {
 

power_grid_model_c/power_grid_model/include/power_grid_model/main_core/topology.hpp

@@ -6,7 +6,17 @@
 
 #include "container_queries.hpp"
 
-#include "../all_components.hpp"
+#include "../component/branch.hpp"
+#include "../component/branch3.hpp"
+#include "../component/current_sensor.hpp"
+#include "../component/fault.hpp"
+#include "../component/load_gen.hpp"
+#include "../component/node.hpp"
+#include "../component/power_sensor.hpp"
+#include "../component/regulator.hpp"
+#include "../component/shunt.hpp"
+#include "../component/source.hpp"
+#include "../component/voltage_sensor.hpp"
 
 namespace power_grid_model::main_core {
 

power_grid_model_c/power_grid_model/include/power_grid_model/main_core/update.hpp

@@ -7,10 +7,9 @@
 #include "container_queries.hpp"
 #include "core_utils.hpp"
 
-#include "../all_components.hpp"
 #include "../auxiliary/dataset.hpp"
 #include "../common/iterator_facade.hpp"
-#include "../container.hpp"
+#include "../component/component.hpp"
 
 #include <map>
 

power_grid_model_c/power_grid_model/include/power_grid_model/main_model.hpp

@@ -4,6 +4,7 @@
 
 #pragma once
 
+#include "all_components.hpp"
 #include "job_adapter.hpp"
 #include "job_dispatch.hpp"
 #include "main_model_impl.hpp"

power_grid_model_c/power_grid_model/include/power_grid_model/main_model_impl.hpp

@@ -20,10 +20,10 @@
 #include "common/timer.hpp"
 
 // component include
-#include "all_components.hpp"
 #include "auxiliary/dataset.hpp"
 #include "auxiliary/input.hpp"
 #include "auxiliary/output.hpp"
+#include "component/component.hpp"
 
 // math model include
 #include "math_solver/math_solver_dispatch.hpp"

power_grid_model_c/power_grid_model/include/power_grid_model/math_solver/iterative_current_pf_solver.hpp

@@ -62,7 +62,6 @@ Iterative Power Flow
 #include "../common/common.hpp"
 #include "../common/exception.hpp"
 #include "../common/three_phase_tensor.hpp"
-#include "../common/timer.hpp"
 
 namespace power_grid_model::math_solver {
 

power_grid_model_c/power_grid_model/include/power_grid_model/math_solver/linear_pf_solver.hpp

@@ -35,7 +35,6 @@ if there are sources
 #include "../calculation_parameters.hpp"
 #include "../common/common.hpp"
 #include "../common/enum.hpp"
-#include "../common/exception.hpp"
 #include "../common/three_phase_tensor.hpp"
 #include "../common/timer.hpp"
 

power_grid_model_c/power_grid_model/include/power_grid_model/math_solver/math_solver_dispatch.hpp

@@ -9,9 +9,8 @@
 
 #include "../calculation_parameters.hpp"
 #include "../common/common.hpp"
-#include "../common/exception.hpp"
+#include "../common/logging.hpp"
 #include "../common/three_phase_tensor.hpp"
-#include "../common/timer.hpp"
 
 #include <memory>
 

power_grid_model_c/power_grid_model/include/power_grid_model/math_solver/newton_raphson_pf_solver.hpp

@@ -153,7 +153,6 @@ J.L -= -dQ_cal_m/dV
 #include "../common/common.hpp"
 #include "../common/exception.hpp"
 #include "../common/three_phase_tensor.hpp"
-#include "../common/timer.hpp"
 
 namespace power_grid_model::math_solver {
 

tests/cpp_unit_tests/test_all_components.cpp

@@ -2,9 +2,12 @@
 //
 // SPDX-License-Identifier: MPL-2.0
 
+#include "power_grid_model/auxiliary/input.hpp"
 #include <power_grid_model/component/appliance.hpp>
+#include <power_grid_model/component/base.hpp>
 #include <power_grid_model/component/branch.hpp>
 #include <power_grid_model/component/branch3.hpp>
+#include <power_grid_model/component/component.hpp>
 #include <power_grid_model/component/fault.hpp>
 #include <power_grid_model/component/generic_branch.hpp>
 #include <power_grid_model/component/line.hpp>
@@ -22,6 +25,9 @@
 
 #include <doctest/doctest.h>
 
+#include <concepts>
+#include <type_traits>
+
 namespace power_grid_model {
 
 static_assert(component_c<Node>);