pyedb 0.14.1__py3-none-any.whl → 0.15.0__py3-none-any.whl

pyedb/__init__.py

@@ -44,7 +44,7 @@ deprecation_warning()
 #
 
 pyedb_path = os.path.dirname(__file__)
-__version__ = "0.14.1"
+__version__ = "0.15.0"
 version = __version__
 
 #

pyedb/dotnet/edb.py

@@ -48,6 +48,7 @@ from pyedb.dotnet.edb_core.cell.terminal.padstack_instance_terminal import (
 from pyedb.dotnet.edb_core.cell.terminal.pingroup_terminal import PinGroupTerminal
 from pyedb.dotnet.edb_core.cell.terminal.point_terminal import PointTerminal
 from pyedb.dotnet.edb_core.cell.terminal.terminal import Terminal
+from pyedb.dotnet.edb_core.cell.voltage_regulator import VoltageRegulator
 from pyedb.dotnet.edb_core.components import Components
 from pyedb.dotnet.edb_core.dotnet.database import Database
 from pyedb.dotnet.edb_core.dotnet.layout import LayoutDotNet
@@ -93,10 +94,10 @@ from pyedb.dotnet.edb_core.nets import EdbNets
 from pyedb.dotnet.edb_core.padstack import EdbPadstacks
 from pyedb.dotnet.edb_core.siwave import EdbSiwave
 from pyedb.dotnet.edb_core.stackup import Stackup
-from pyedb.dotnet.edb_core.utilities.simulation_setup import (
-    HfssSimulationSetup,
+from pyedb.dotnet.edb_core.utilities.hfss_simulation_setup import HfssSimulationSetup
+from pyedb.dotnet.edb_core.utilities.siwave_simulation_setup import (
     SiwaveDCSimulationSetup,
-    SiwaveSYZSimulationSetup,
+    SiwaveSimulationSetup,
 )
 from pyedb.generic.constants import AEDT_UNITS, SolverType
 from pyedb.generic.general_methods import (
@@ -510,6 +511,15 @@ class Edb(Database):
         terms = [term for term in self.layout.terminals if int(term.GetBoundaryType()) in [3, 4, 7]]
         return {ter.GetName(): ExcitationSources(self, ter) for ter in terms}
 
+    @property
+    def voltage_regulator_modules(self):
+        """Get all voltage regulator modules"""
+        vrms = [VoltageRegulator(self, edb_object) for edb_object in list(self.active_layout.VoltageRegulators)]
+        _vrms = {}
+        for vrm in vrms:
+            _vrms[vrm.GetName()] = vrm
+        return _vrms
+
     @property
     def probes(self):
         """Get all layout probes."""
@@ -3556,7 +3566,7 @@ class Edb(Database):
             if i.GetType() == self.edb_api.utility.utility.SimulationSetupType.kHFSS:
                 setups[i.GetName()] = HfssSimulationSetup(self, i)
             elif i.GetType() == self.edb_api.utility.utility.SimulationSetupType.kSIWave:
-                setups[i.GetName()] = SiwaveSYZSimulationSetup(self, i)
+                setups[i.GetName()] = SiwaveSimulationSetup(self, i)
             elif i.GetType() == self.edb_api.utility.utility.SimulationSetupType.kSIWaveDCIR:
                 setups[i.GetName()] = SiwaveDCSimulationSetup(self, i)
             elif i.GetType() == self.edb_api.utility.utility.SimulationSetupType.kRaptorX:
@@ -3594,7 +3604,7 @@ class Edb(Database):
         -------
         Dict[str, :class:`legacy.edb_core.edb_data.siwave_simulation_setup_data.SiwaveSYZSimulationSetup`]
         """
-        return {name: i for name, i in self.setups.items() if isinstance(i, SiwaveSYZSimulationSetup)}
+        return {name: i for name, i in self.setups.items() if isinstance(i, SiwaveSimulationSetup)}
 
     def create_hfss_setup(self, name=None):
         """Create an HFSS simulation setup from a template.
@@ -3620,7 +3630,7 @@ class Edb(Database):
             return False
         elif not name:
             name = generate_unique_name("setup")
-        setup = HfssSimulationSetup(self).create(name)
+        setup = HfssSimulationSetup(self, name=name)
         setup.set_solution_single_frequency("1GΗz")
         return setup
 
@@ -3698,7 +3708,7 @@ class Edb(Database):
             name = generate_unique_name("Siwave_SYZ")
         if name in self.setups:
             return False
-        SiwaveSYZSimulationSetup(self).create(name)
+        setup = SiwaveSimulationSetup(self, name=name)
         return self.setups[name]
 
     def create_siwave_dc_setup(self, name=None):
@@ -3725,7 +3735,7 @@ class Edb(Database):
             name = generate_unique_name("Siwave_DC")
         if name in self.setups:
             return False
-        setup = SiwaveDCSimulationSetup(self).create(name)
+        setup = SiwaveDCSimulationSetup(self, name=name)
         return setup
 
     def calculate_initial_extent(self, expansion_factor):

pyedb/dotnet/edb_core/cell/voltage_regulator.py

@@ -0,0 +1,148 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pyedb.dotnet.edb_core.cell.layout_obj import Connectable
+from pyedb.dotnet.edb_core.edb_data.padstacks_data import EDBPadstackInstance
+
+
+class VoltageRegulator(Connectable):
+    """Class managing EDB voltage regulator."""
+
+    def __init__(self, pedb, edb_object=None):
+        super().__init__(pedb, edb_object)
+
+    @property
+    def component(self):
+        """Retrieve voltage regulator component"""
+        if not self._edb_object.GetComponent().IsNull():
+            ref_des = self._edb_object.GetComponent().GetName()
+            if not ref_des:
+                return False
+            return self._pedb.components.instances[ref_des]
+        self._pedb.logger.warning("No voltage regulator component.")
+        return False
+
+    @component.setter
+    def component(self, value):
+        if not isinstance(value, str):
+            self._pedb.logger.error("refdes name must be provided to set vrm component")
+            return
+        if value not in self._pedb.components.instances:
+            self._pedb.logger.error(f"component {value} not found in layout")
+            return
+        self._edb_object.SetGroup(self._pedb.components.instances[value].edbcomponent)
+
+    @property
+    def id(self):
+        """Retrieve voltage regulator ID."""
+        return self._edb_object.GetId()
+
+    @property
+    def load_regulator_current(self):
+        """Retrieve load regulator current value"""
+        return self._edb_object.GetLoadRegulationCurrent().ToDouble()
+
+    @load_regulator_current.setter
+    def load_regulator_current(self, value):
+        _value = self._pedb.edb_value(value)
+        self._edb_object.SetLoadRegulationCurrent(_value)
+
+    @property
+    def load_regulation_percent(self):
+        """Retrieve load regulation percent value."""
+        return self._edb_object.GetLoadRegulationPercent().ToDouble()
+
+    @load_regulation_percent.setter
+    def load_regulation_percent(self, value):
+        _value = self._edb_object.edb_value(value)
+        self._edb_object.SetLoadRegulationPercent(_value)
+
+    @property
+    def name(self):
+        """Retrieve voltage regulator name."""
+        return self._edb_object.GetName()
+
+    @name.setter
+    def name(self, value):
+        if isinstance(value, str):
+            self._edb_object.SetName(value)
+
+    @property
+    def negative_remote_sense_pin(self):
+        """Retrieve negative remote sense pin."""
+        edb_pin = self._edb_object.GetNegRemoteSensePin()
+        return self._pedb.padstacks.instances[edb_pin.GetId()]
+
+    @negative_remote_sense_pin.setter
+    def negative_remote_sense_pin(self, value):
+        if isinstance(value, int):
+            if value in self._pedb.padsatcks.instances:
+                _inst = self._pedb.padsatcks.instances[value]
+                if self._edb_object.SetNegRemoteSensePin(_inst._edb_object):
+                    self._negative_remote_sense_pin = _inst
+        elif isinstance(value, EDBPadstackInstance):
+            if self._edb_object.SetNegRemoteSensePin(value._edb_object):
+                self._negative_remote_sense_pin = value
+
+    @property
+    def positive_remote_sense_pin(self):
+        """Retrieve positive remote sense pin."""
+        edb_pin = self._edb_object.GetPosRemoteSensePin()
+        return self._pedb.padstacks.instances[edb_pin.GetId()]
+
+    @positive_remote_sense_pin.setter
+    def positive_remote_sense_pin(self, value):
+        if isinstance(value, int):
+            if value in self._pedb.padsatcks.instances:
+                _inst = self._pedb.padsatcks.instances[value]
+                if self._edb_object.SetPosRemoteSensePin(_inst._edb_object):
+                    self._positive_remote_sense_pin = _inst
+                if not self.component:
+                    self.component = _inst._edb_object.GetComponent().GetName()
+        elif isinstance(value, EDBPadstackInstance):
+            if self._edb_object.SetPosRemoteSensePin(value._edb_object):
+                self._positive_remote_sense_pin = value
+            if not self.component:
+                self.component = value._edb_object.GetComponent().GetName()
+
+    @property
+    def voltage(self):
+        """Retrieve voltage value."""
+        return self._edb_object.GetVoltage().ToDouble()
+
+    @voltage.setter
+    def voltage(self, value):
+        self._edb_object.SetVoltage(self._pedb.edb_value(value))
+
+    @property
+    def is_active(self):
+        """Check is voltage regulator is active."""
+        return self._edb_object.IsActive()
+
+    @is_active.setter
+    def is_active(self, value):
+        if isinstance(value, bool):
+            self._edb_object.SetIsActive(value)
+
+    @property
+    def is_null(self):
+        return self._edb_object.IsNull()

pyedb/dotnet/edb_core/sim_setup_data/data/settings.py

@@ -45,7 +45,7 @@ class AdaptiveSettings(object):
         -------
         :class:`pyedb.dotnet.edb_core.edb_data.hfss_simulation_setup_data.AdaptiveSettings`
         """
-        return self._parent.get_sim_setup_info.SimulationSettings.AdaptiveSettings
+        return self._parent.sim_setup_info.simulation_settings.AdaptiveSettings
 
     @property
     def adaptive_frequency_data_list(self):

pyedb/dotnet/edb_core/sim_setup_data/data/sim_setup_info.py

@@ -0,0 +1,81 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pyedb.dotnet.edb_core.sim_setup_data.data.sweep_data import SweepData
+
+
+class SimSetupInfo:
+    def __init__(
+        self,
+        pedb,
+        sim_setup,
+        edb_object=None,
+        setup_type: str = None,
+        name: str = None,
+    ):
+        self._pedb = pedb
+        self.sim_setup = sim_setup
+        simulation_setup_type = {
+            "kHFSS": self._pedb.simsetupdata.HFSSSimulationSettings,
+            "kPEM": None,
+            "kSIwave": self._pedb.simsetupdata.SIwave.SIWSimulationSettings,
+            "kLNA": None,
+            "kTransient": None,
+            "kQEye": None,
+            "kVEye": None,
+            "kAMI": None,
+            "kAnalysisOption": None,
+            "kSIwaveDCIR": self._pedb.simsetupdata.SIwave.SIWDCIRSimulationSettings,
+            "kSIwaveEMI": None,
+            "kHFSSPI": None,
+            "kDDRwizard": None,
+            "kQ3D": None,
+            "kNumSetupTypes": None,
+        }
+
+        if edb_object is None:
+            self._edb_object = self._pedb.simsetupdata.SimSetupInfo[simulation_setup_type[setup_type]]()
+            self._edb_object.Name = name
+        else:
+            self._edb_object = edb_object
+
+    @property
+    def position(self):
+        return self._edb_object.Position
+
+    @property
+    def sim_setup_type(self):
+        return self._edb_object.SimSetupType
+
+    @property
+    def simulation_settings(self):
+        return self._edb_object.SimulationSettings
+
+    @property
+    def sweep_data_list(self):
+        return [
+            SweepData(self._pedb, edb_object=i, sim_setup=self.sim_setup) for i in list(self._edb_object.SweepDataList)
+        ]
+
+    def add_sweep_data(self, sweep_data):
+        sweep_data.sim_setup = self.sim_setup
+        self._edb_object.SweepDataList.Add(sweep_data._edb_object)

pyedb/dotnet/edb_core/sim_setup_data/data/simulation_settings.py

@@ -0,0 +1,67 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+class BaseSimulationSettings:
+    def __init__(self, pedb, sim_setup, edb_object):
+        self._pedb = pedb
+        self.sim_setup = sim_setup
+        self._edb_object = edb_object
+        self.t_sim_setup_type = {
+            "kHFSS": self._pedb.simsetupdata.HFSSSimulationSettings,
+            "kPEM": None,
+            "kSIwave": self._pedb.simsetupdata.SIwave.SIWSimulationSettings,
+            "kLNA": None,
+            "kTransient": None,
+            "kQEye": None,
+            "kVEye": None,
+            "kAMI": None,
+            "kAnalysisOption": None,
+            "kSIwaveDCIR": self._pedb.simsetupdata.SIwave.SIWDCIRSimulationSettings,
+            "kSIwaveEMI": None,
+            "kHFSSPI": None,
+            "kDDRwizard": None,
+            "kQ3D": None,
+            "kNumSetupTypes": None,
+        }
+
+    @property
+    def enabled(self):
+        return self._edb_object.Enabled
+
+    @enabled.setter
+    def enabled(self, value):
+        self._edb_object.Enabled = value
+
+
+class SimulationSettings(BaseSimulationSettings):
+    def __init__(self, pedb, sim_setup, edb_object):
+        super().__init__(pedb, sim_setup, edb_object)
+
+
+class HFSSSimulationSettings(SimulationSettings):
+    def __init__(self, pedb, sim_setup, edb_object):
+        super().__init__(pedb, sim_setup, edb_object)
+
+    @property
+    def mesh_operations(self):
+        return self._edb_object.MeshOperations