PyOpenMagnetics 1.7.30__tar.gz → 1.7.31__tar.gz

{pyopenmagnetics-1.7.30 → pyopenmagnetics-1.7.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyOpenMagnetics
-Version: 1.7.30
+Version: 1.7.31
 Summary: Python wrapper for OpenMagnetics
 Author-Email: Alfonso Martinez <Alfonso_VII@hotmail.com>
 Classifier: Development Status :: 4 - Beta

{pyopenmagnetics-1.7.30 → pyopenmagnetics-1.7.31}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "scikit_build_core.build"
 
 [project]
 name = "PyOpenMagnetics"
-version = "1.7.30"
+version = "1.7.31"
 requires-python = ">=3.8"
 authors = [
   { name="Alfonso Martinez", email="Alfonso_VII@hotmail.com" },

{pyopenmagnetics-1.7.30 → pyopenmagnetics-1.7.31}/src/core.cpp

@@ -567,6 +567,21 @@ json calculate_complex_permeability(json materialJson, double frequency) {
     return result;
 }
 
+json calculate_complex_permeability_frequency_range(json material) {
+    OpenMagnetics::ComplexPermeability complexPermeabilityObj;
+    std::pair<double, double> range;
+    if (material.is_string()) {
+        range = complexPermeabilityObj.get_frequency_range(material.get<std::string>());
+    }
+    else {
+        range = complexPermeabilityObj.get_frequency_range(CoreMaterial(material));
+    }
+    json result;
+    result["minimum"] = range.first;
+    result["maximum"] = range.second;
+    return result;
+}
+
 void register_core_bindings(py::module& m) {
     // Core materials
     m.def("get_core_materials", &get_core_materials,
@@ -1344,6 +1359,24 @@ void register_core_bindings(py::module& m) {
         )pbdoc",
         py::arg("material_json"), py::arg("frequency"),
         py::call_guard<py::gil_scoped_release>());
+
+    m.def("calculate_complex_permeability_frequency_range", &calculate_complex_permeability_frequency_range,
+        R"pbdoc(
+        Frequency span in which a core material's complex permeability is defined.
+
+        calculate_complex_permeability (and every impedance sweep that uses it)
+        throws outside this span: it is the span covered by both the material's
+        tabulated mu'(f) and mu''(f), or by the table MKF derives from its
+        frequency-dependent initial permeability.
+
+        Args:
+            material: JSON CoreMaterial object, or the material name.
+
+        Returns:
+            JSON object {"minimum": Hz, "maximum": Hz}.
+        )pbdoc",
+        py::arg("material"),
+        py::call_guard<py::gil_scoped_release>());
 }
 
 } // namespace PyMKF

{pyopenmagnetics-1.7.30 → pyopenmagnetics-1.7.31}/src/core.h

@@ -59,6 +59,7 @@ std::vector<std::string> get_available_core_filters();
 std::vector<double> get_maximum_dimensions(json magneticJson);
 json calculate_core_data_from_shape(json shapeJson);
 json calculate_complex_permeability(json materialJson, double frequency);
+json calculate_complex_permeability_frequency_range(json material);
 
 void register_core_bindings(py::module& m);
 

{pyopenmagnetics-1.7.30 → pyopenmagnetics-1.7.31}/tests/test_core.py

@@ -312,3 +312,23 @@ class TestCoreProcessedDescription:
             if "windingWindows" in processed:
                 assert isinstance(processed["windingWindows"], list)
                 assert len(processed["windingWindows"]) > 0
+
+
+class TestComplexPermeabilityFrequencyRange:
+    """calculate_complex_permeability throws outside the material's tabulated span; the span is exposed so
+    callers (impedance sweeps) can stay inside it instead of catching the throw."""
+
+    def test_a07_span_ends_at_the_top_of_its_tabulated_mu_imaginary(self):
+        span = PyOpenMagnetics.calculate_complex_permeability_frequency_range("A07")
+        assert 0 < span["minimum"] < span["maximum"]
+        # A07's tabulated mu''(f) ends at ~17 MHz (mu' extended to it by Kramers-Kronig in MAS).
+        assert 1e7 < span["maximum"] < 1e8
+
+    def test_inside_the_span_answers_and_outside_it_throws(self):
+        material = PyOpenMagnetics.find_core_material_by_name("A07")
+        span = PyOpenMagnetics.calculate_complex_permeability_frequency_range(material)
+        assert span == PyOpenMagnetics.calculate_complex_permeability_frequency_range("A07")
+        inside = PyOpenMagnetics.calculate_complex_permeability(material, span["maximum"] * 0.99)
+        assert inside["imaginary"] > 0
+        with pytest.raises(Exception):
+            PyOpenMagnetics.calculate_complex_permeability(material, span["maximum"] * 1.01)