✨ Added temperature-aware operational domain simulation.

bindings/mnt/pyfiction/__init__.py

@@ -303,6 +303,7 @@
     write_fqca_layout_params,
     write_operational_domain,
     write_operational_domain_params,
+    write_operational_domain_to_string,
     write_qca_layout,
     write_qca_layout_params,
     write_qca_layout_svg,
@@ -605,6 +606,7 @@
     "write_fqca_layout_params",
     "write_operational_domain",
     "write_operational_domain_params",
+    "write_operational_domain_to_string",
     "write_qca_layout",
     "write_qca_layout_params",
     "write_qca_layout_svg",

bindings/mnt/pyfiction/include/pyfiction/algorithms/simulation/sidb/operational_domain.hpp

@@ -50,7 +50,6 @@ void operational_domain(pybind11::module& m)
 inline void operational_domain(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     py::class_<fiction::parameter_point>(m, "parameter_point", DOC(fiction_parameter_point))
         .def(py::init<>(), DOC(fiction_parameter_point_parameter_point))
@@ -72,28 +71,41 @@ inline void operational_domain(pybind11::module& m)
 
         ;
 
-    py::class_<fiction::operational_domain<fiction::parameter_point, fiction::operational_status>>(
+    py::class_<fiction::operational_domain<fiction::parameter_point, fiction::operational_status, double>>(
         m, "operational_domain", DOC(fiction_operational_domain))
         .def(py::init<>())
         .def_readwrite("dimensions",
                        &fiction::operational_domain<fiction::parameter_point, fiction::operational_status>::dimensions,
                        DOC(fiction_operational_domain_dimensions))
         .def_readwrite(
-            "influence_information",
+            "operational_values",
             &fiction::operational_domain<fiction::parameter_point, fiction::operational_status>::operational_values,
             DOC(fiction_operational_domain_operational_values))
 
+        .def_readwrite(
+            "metric_values",
+            &fiction::operational_domain<fiction::parameter_point, fiction::operational_status, double>::metric_values)
+
         .def("get_value",
              &fiction::operational_domain<fiction::parameter_point, fiction::operational_status>::get_value,
              py::arg("point"), DOC(fiction_operational_domain_get_value))
 
+        .def("get_metric_value",
+             &fiction::operational_domain<fiction::parameter_point, fiction::operational_status>::get_metric_value,
+             py::arg("point"), DOC(fiction_operational_domain_get_metric_value))
+
         .def("add_value",
              &fiction::operational_domain<fiction::parameter_point, fiction::operational_status>::add_value,
              py::arg("key"), py::arg("value"), DOC(fiction_operational_domain_add_value))
 
-        .def("get_domain",
-             &fiction::operational_domain<fiction::parameter_point, fiction::operational_status>::get_domain,
-             DOC(fiction_operational_domain_get_domain))
+        .def("add_metric_value",
+             &fiction::operational_domain<fiction::parameter_point, fiction::operational_status>::add_metric_value,
+             py::arg("key"), py::arg("value"))
+
+        .def(
+            "get_operational_domain",
+            &fiction::operational_domain<fiction::parameter_point, fiction::operational_status>::get_operational_domain,
+            DOC(fiction_operational_domain_get_operational_domain))
 
         ;
 
@@ -113,15 +125,22 @@ inline void operational_domain(pybind11::module& m)
 
         ;
 
+    py::enum_<fiction::operational_domain_params::metric_simulation>(
+        m, "metric_simulation", DOC(fiction_operational_domain_params_metric_simulation))
+        .value("TEMPERATURE_SIMULATION",
+               fiction::operational_domain_params::metric_simulation::CRITICAL_TEMPERATURE_SIM,
+               DOC(fiction_operational_domain_params_metric_simulation_CRITICAL_TEMPERATURE_SIM))
+        .value("DISABLED", fiction::operational_domain_params::metric_simulation::DISABLED,
+               DOC(fiction_operational_domain_params_metric_simulation_DISABLED));
+
     py::class_<fiction::operational_domain_params>(m, "operational_domain_params",
                                                    DOC(fiction_operational_domain_params))
         .def(py::init<>())
         .def_readwrite("operational_params", &fiction::operational_domain_params::operational_params,
                        DOC(fiction_operational_domain_params_operational_params))
         .def_readwrite("sweep_dimensions", &fiction::operational_domain_params::sweep_dimensions,
                        DOC(fiction_operational_domain_params_sweep_dimensions))
-
-        ;
+        .def_readwrite("metric_sim", &fiction::operational_domain_params::metric_sim);
 
     py::class_<fiction::operational_domain_stats>(m, "operational_domain_stats", DOC(fiction_operational_domain_stats))
         .def(py::init<>())

bindings/mnt/pyfiction/include/pyfiction/inout/write_operational_domain.hpp

@@ -8,9 +8,15 @@
 #include "pyfiction/documentation.hpp"
 #include "pyfiction/types.hpp"
 
+#include <fiction/algorithms/simulation/sidb/is_operational.hpp>
+#include <fiction/algorithms/simulation/sidb/operational_domain.hpp>
 #include <fiction/io/write_operational_domain.hpp>
 
 #include <pybind11/pybind11.h>
+#include <pybind11/stl.h>
+
+#include <string>
+#include <string_view>
 
 namespace pyfiction
 {
@@ -36,16 +42,28 @@ inline void write_operational_domain(pybind11::module& m)
         .def_readwrite("non_operational_tag", &fiction::write_operational_domain_params::non_operational_tag,
                        DOC(fiction_write_operational_domain_params_non_operational_tag))
         .def_readwrite("writing_mode", &fiction::write_operational_domain_params::writing_mode,
-                       DOC(fiction_write_operational_domain_params_writing_mode))
-
-        ;
+                       DOC(fiction_write_operational_domain_params_writing_mode));
 
+    // Function pointer for writing to a file
     void (*write_operational_domain_pointer)(
         const fiction::operational_domain<fiction::parameter_point, fiction::operational_status>&,
         const std::string_view&, const fiction::write_operational_domain_params&) = &fiction::write_operational_domain;
 
+    // Define function using function pointer
     m.def("write_operational_domain", write_operational_domain_pointer, py::arg("opdom"), py::arg("filename"),
-          py::arg("params") = fiction::write_operational_domain_params{}, DOC(fiction_write_operational_domain));
+          py::arg("params"), DOC(fiction_write_operational_domain));
+
+    m.def(
+        "write_operational_domain_to_string",
+        [](const fiction::operational_domain<fiction::parameter_point, fiction::operational_status>& opdom,
+           const fiction::write_operational_domain_params& params = {}) -> std::string
+        {
+            std::ostringstream oss;                                 // Create an in-memory output stream
+            fiction::write_operational_domain(opdom, oss, params);  // Write to the stream
+            return oss.str();                                       // Return the string content
+        },
+        py::arg("opdom"), py::arg("params") = fiction::write_operational_domain_params{},
+        "Writes the operational domain to a CSV string.");
 }
 
 }  // namespace pyfiction

bindings/mnt/pyfiction/include/pyfiction/inout/write_svg_layout.hpp

@@ -64,7 +64,6 @@ inline void write_qca_layout_svg_impl(pybind11::module& m)
 void write_svg_layout(pybind11::module& m)
 {
     namespace py = pybind11;
-    namespace py = pybind11;
 
     py::enum_<fiction::write_sidb_layout_svg_params::color_mode>(m, "color_mode",
                                                                  DOC(fiction_write_sidb_layout_svg_params_color_mode))

bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp

@@ -15287,9 +15287,24 @@ Template parameter ``Key``:
     The type representing the key. Defaults to `parameter_point`.
 
 Template parameter ``Value``:
-    The type representing the value. Defaults to `operational_status`.)doc";
+    The type representing the value. Defaults to `operational_status`.
 
-static const char *__doc_fiction_operational_domain_add_value = R"doc()doc";
+Template parameter ``MetricType``:
+    The type representing the metric value. Defaults to `double`.)doc";
+
+static const char *__doc_fiction_operational_domain_add_metric_value =
+R"doc(Adds a value to the metric values.
+
+Parameter ``key``:
+    The key to add the value to.
+
+Parameter ``value``:
+    The value to add.)doc";
+
+static const char *__doc_fiction_operational_domain_add_value =
+R"doc(Adds a value to the operational domain.
+
+@key The key to add the value to. @value The value to add.)doc";
 
 static const char *__doc_fiction_operational_domain_contour_tracing =
 R"doc(Computes the operational domain of the given SiDB cell-level layout.
@@ -15418,7 +15433,30 @@ Parameter ``stats``:
 Returns:
     The (partial) operational domain of the layout.)doc";
 
-static const char *__doc_fiction_operational_domain_get_domain = R"doc()doc";
+static const char *__doc_fiction_operational_domain_get_metric_value =
+R"doc(This function retrieves the value associated with the provided key
+from the metric values. If the key is found, its corresponding value
+is returned. Otherwise, `std::nullopt` is returned.
+
+Parameter ``key``:
+    The key to look up in the metric values.
+
+Returns:
+    The value associated with the provided key. If the key is not
+    found, `std::nullopt` is returned.)doc";
+
+static const char *__doc_fiction_operational_domain_get_metric_values =
+R"doc(Returns the metric values. If no metric values are present,
+`std::nullopt` is returned.
+
+Returns:
+    The metric values.)doc";
+
+static const char *__doc_fiction_operational_domain_get_operational_domain =
+R"doc(Returns the operational domain.
+
+Returns:
+    The operational domain.)doc";
 
 static const char *__doc_fiction_operational_domain_get_value =
 R"doc(This function retrieves the value associated with the provided key
@@ -15430,7 +15468,8 @@ Parameter ``key``:
     The key to look up.
 
 Returns:
-    The value associated with the parameter point.)doc";
+    The value associated with the provided key. If the key is not
+    found, `std::nullopt` is returned.)doc";
 
 static const char *__doc_fiction_operational_domain_grid_search =
 R"doc(Computes the operational domain of the given SiDB cell-level layout.
@@ -15477,6 +15516,11 @@ Parameter ``stats``:
 Returns:
     The operational domain of the layout.)doc";
 
+static const char *__doc_fiction_operational_domain_metric_values =
+R"doc(This can store different information depending on the use case. If the
+critical temperature is simulated on top of the operational domain, it
+is stored here.)doc";
+
 static const char *__doc_fiction_operational_domain_operational_values =
 R"doc(This can store different information depending on the use case. If the
 operational domain is simulated for different physical parameters, the
@@ -15486,6 +15530,19 @@ static const char *__doc_fiction_operational_domain_params =
 R"doc(Parameters for the operational domain computation. The parameters are
 used across the different operational domain computation algorithms.)doc";
 
+static const char *__doc_fiction_operational_domain_params_metric_sim = R"doc(The metric to simulate within the operational domain.)doc";
+
+static const char *__doc_fiction_operational_domain_params_metric_simulation =
+R"doc(This enumeration defines whether specific metrics, such as critical
+temperature, are simulated within the operational domain or if
+simulations are disabled.)doc";
+
+static const char *__doc_fiction_operational_domain_params_metric_simulation_CRITICAL_TEMPERATURE_SIM = R"doc(Simulates the critical temperature within the operational domain.)doc";
+
+static const char *__doc_fiction_operational_domain_params_metric_simulation_DISABLED =
+R"doc(Disables metric simulation, meaning no metrics are simulated within
+the operational domain.)doc";
+
 static const char *__doc_fiction_operational_domain_params_operational_params =
 R"doc(The parameters used to determine if a layout is operational or non-
 operational.)doc";
@@ -19950,11 +20007,15 @@ The operational status is a binary value represented by specified tags
 in `params` indicating whether the simulation parameters are within
 the operational domain or not.
 
+Template parameter ``OpDomain``:
+    The type of the operational domain.
+
 Parameter ``opdom``:
     The operational domain to be written. It contains a mapping from
     sets of simulation parameters (represented as a pair of sweep
     parameters for the X and Y dimensions) to their operational
-    status.
+    status, and it can include metric values (e.g., the critical
+    temperature on top of that).
 
 Parameter ``os``:
     The output stream where the CSV representation of the operational
@@ -19981,11 +20042,15 @@ The operational status is a binary value represented by specified tags
 in `params` indicating whether the simulation parameters are within
 the operational domain or not.
 
+Template parameter ``OpDomain``:
+    The type of the operational domain.
+
 Parameter ``opdom``:
     The operational domain to be written. It contains a mapping from
     sets of simulation parameters (represented as a pair of sweep
     parameters for the X and Y dimensions) to their operational
-    status.
+    status, and it can include metric values (e.g., the critical
+    temperature on top of that).
 
 Parameter ``filename``:
     The filename where the CSV representation of the operational