refactoring and fixes

Author: restenb

include/cosim/algorithm/ecco_algorithm.hpp

@@ -82,14 +82,30 @@ class ecco_algorithm : public algorithm
 
     /**
      * Retrieves the energies in the power bond for the given simulator index.add_variable_value
-     * \param simulator_index 
-     *      The index of the simulator. 
+     * \param simulator_index
+     *      The index of the simulator.
      */
     std::vector<double> get_powerbond_energies(cosim::simulator_index simulator_index);
 
+    /**
+     * Enables the step-size adjusting controller. By default the controller is enabled, so this function has no effect unless the controller has been
+     * disabled first by calling disable_step_size_controller. This may be useful if the coupling error indicates that adjusting the step size
+     * is necessary.
+     */
+    void enable_step_size_controller();
+
+    /**
+     * Disables the step-size adjusting controller. By default the controller is enabled, so this function should be called before
+     * running the simulation if the intent is to run with it off. Toggling the flag to off in the middle of a simulation run has the effect of maintaining
+     * the last adjusted step size value. This may be useful to improve simulation speeds when the error is sufficiently low with the current adjusted
+     * step size.
+     */
+    void disable_step_size_controller();
+
+
 private:
     class impl;
-    std::unique_ptr<impl> pimpl_;
+    std::unique_ptr<impl> pimpl_;    
 };
 
 } // namespace cosim

src/cosim/algorithm/ecco_algorithm.cpp

@@ -209,7 +209,7 @@ class ecco_algorithm::impl
         }
 
         const auto stepSizeTaken = stepSize_;
-        if (stepCounter_ >= 2) {
+        if (stepCounter_ >= 2 && controllerEnabled_) {
             stepSize_ = adjust_step_size(currentT, stepSize_, params_);
         }
 
@@ -228,7 +228,7 @@ class ecco_algorithm::impl
             transfer_variables(info.outgoingSimConnections);
         }
 
-
+        // Have to return size of the current step, since step is taken before any step size adjustment.
         return {stepSizeTaken, std::move(finished)};
     }
 
@@ -285,6 +285,7 @@ class ecco_algorithm::impl
         double max_power_residual = *std::max_element(power_residuals.begin(), power_residuals.end());
         const auto energy_level = max_power_residual * dt;
         double mean_square{};
+
         for (auto power_residual : power_residuals) {
             const auto energy_residual = power_residual * dt;
             mean_square += std::pow(energy_residual / (params.abs_tolerance + params.rel_tolerance * energy_level), 2);
@@ -303,8 +304,9 @@ class ecco_algorithm::impl
 
         prev_error_estimate_ = error_estimate;
         const auto new_step_size = to_duration(new_step_size_gain * to_double_duration(stepSize, currentTime));
-        const auto actual_new_step_size = std::clamp(new_step_size, params.min_step_size, params.max_step_size);
-        return actual_new_step_size;
+        const auto new_step_size_clamped = std::clamp(new_step_size, params.min_step_size, params.max_step_size);
+
+        return new_step_size_clamped;
     }
 
     void add_power_bond(cosim::variable_id input_a, cosim::variable_id output_a, cosim::variable_id input_b, cosim::variable_id output_b)
@@ -322,6 +324,16 @@ class ecco_algorithm::impl
         return energies_.at(simulator_index);
     }
 
+    void enable_step_size_controller()
+    {
+        controllerEnabled_ = true;
+    }
+
+    void disable_step_size_controller()
+    {
+        controllerEnabled_ = false;
+    }
+
 private:
     std::vector<cosim::variable_id> inputVariables_{};
     std::vector<cosim::variable_id> outputVariables_{};
@@ -483,6 +495,7 @@ class ecco_algorithm::impl
     unsigned int max_threads_ = std::thread::hardware_concurrency() - 1;
     utility::thread_pool pool_;
     double prev_error_estimate_{1.0};
+    bool controllerEnabled_ = true;
 };
 
 
@@ -597,4 +610,14 @@ std::vector<double> ecco_algorithm::get_powerbond_energies(cosim::simulator_inde
     return pimpl_->get_powerbond_energies(simulator_index);
 }
 
+void ecco_algorithm::enable_step_size_controller()
+{
+    pimpl_->enable_step_size_controller();
+}
+
+void ecco_algorithm::disable_step_size_controller()
+{
+    pimpl_->disable_step_size_controller();
+}
+
 } // namespace cosim

src/cosim/osp_config_parser.cpp

@@ -798,13 +798,13 @@ void validate_power_bond(system_structure& systemStructure, std::string name, co
 
         if (source_variable.causality != variable_causality::output) {
             std::ostringstream oss;
-            oss << "Failed validating powerbond: source causality is not output for variable " << source_variable.name;
+            oss << "Failed validating powerbond: causality is not output for source variable " << source_variable.name;
             throw std::runtime_error(oss.str());
         }
 
         if (target_variable.causality != variable_causality::input) {
             std::ostringstream oss;
-            oss << "Failed validating powerbond: source causality is not input for variable " << target_variable.name;
+            oss << "Failed validating powerbond: causality is not input for target variable " << target_variable.name;
             throw std::runtime_error(oss.str());
         }
     }
@@ -816,6 +816,7 @@ void add_power_bonds(const std::vector<osp_config_parser::PowerBondConnection>&
     std::set<std::string> uniquePowerBondNames;
     for (const auto& pbConnection : pbConnections) {
         powerBondNames.emplace_back(pbConnection.name);
+        std::cout << "Inserting powerbond " << pbConnection.name << std::endl;
         uniquePowerBondNames.insert(pbConnection.name);
     }
 
@@ -836,14 +837,6 @@ void add_power_bonds(const std::vector<osp_config_parser::PowerBondConnection>&
 
         assert(connectionA.name == connectionB.name);
 
-        /*
-        auto variableA = cosim::full_variable_name{connectionA.connection.variableA.simulator, connectionA.connection.variableA.name};
-        auto variableB = cosim::full_variable_name{connectionA.connection.variableB.simulator, connectionA.connection.variableB.name};
-        auto variableC = cosim::full_variable_name{connectionB.connection.variableA.simulator, connectionB.connection.variableA.name};
-        auto variableD = cosim::full_variable_name{connectionB.connection.variableB.simulator, connectionB.connection.variableB.name};
-        */
-
-
         auto connection_a_variable_a = cosim::full_variable_name{connectionA.connection.variableA.simulator, connectionA.connection.variableA.name};
         auto connection_a_variable_b = cosim::full_variable_name{connectionA.connection.variableB.simulator, connectionA.connection.variableB.name};
         auto connection_b_variable_a = cosim::full_variable_name{connectionB.connection.variableA.simulator, connectionB.connection.variableA.name};
@@ -854,19 +847,17 @@ void add_power_bonds(const std::vector<osp_config_parser::PowerBondConnection>&
 
         auto powerbond = cosim::system_structure::power_bond{connection_a, connection_b};
 
-        validate_power_bond(systemStructure, pbName, powerbond);
         systemStructure.add_power_bond(pbName, powerbond);
+        validate_power_bond(systemStructure, pbName, powerbond);
+    }
 
-        // Check that the number of unique power bond names is equal to the number of power bonds. Otherwise, it is not possible to correctly connect the bonds.
-        std::sort(powerBondNames.begin(), powerBondNames.end());
-        auto uniqueCount = static_cast<int>(std::unique(powerBondNames.begin(), powerBondNames.end()) - powerBondNames.begin());
-        auto numPowerBonds = static_cast<int>(systemStructure.get_power_bonds().size());
+    auto uniquePowerBonds = static_cast<int>(uniquePowerBondNames.size());
+    auto numPowerBonds = static_cast<int>(systemStructure.get_power_bonds().size());
 
-        if (uniqueCount != numPowerBonds) {
-            std::ostringstream oss;
-            oss << "The number of powerbonds (" << numPowerBonds << ") is not equal to the number of unique power bond names (" << uniqueCount << ") found in the configured system. Power bond names must be unique pr. bond, that is found on only and exactly the two VariableConnections that form the bond.";
-            throw std::runtime_error(oss.str());
-        }
+    if (uniquePowerBonds != numPowerBonds) {
+        std::ostringstream oss;
+        oss << "The number of powerbonds (" << numPowerBonds << ") is not equal to the number of unique power bond names (" << uniquePowerBonds << ") found in the configured system. Power bond names must be unique pr. bond, that is found on only and exactly the two VariableConnections that form the bond.";
+        throw std::runtime_error(oss.str());
     }
 }
 

src/cosim/system_structure.cpp

@@ -13,6 +13,7 @@
 #include <cctype>
 #include <cstddef>
 #include <iomanip>
+#include <iostream>
 #include <sstream>
 #include <unordered_map>
 
@@ -136,7 +137,7 @@ system_structure::power_bond_map system_structure::get_power_bonds() const noexc
 }
 
 void system_structure::add_power_bond(std::string name, system_structure::power_bond pb)
-{
+{    
     powerBonds_.emplace(name, pb);
 }