basicemergesolverhelperpackage 0.0.6__tar.gz → 0.0.9__tar.gz

{basicemergesolverhelperpackage-0.0.6 → basicemergesolverhelperpackage-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: basicemergesolverhelperpackage
-Version: 0.0.6
+Version: 0.0.9
 Summary: Mesh creation and plot utilities for EMerge solver or other FEM solver.
 Home-page: https://github.com/LubomirJagos42/basic-emerge-solver-helper-package
 Author: Lubomir Jagos

{basicemergesolverhelperpackage-0.0.6 → basicemergesolverhelperpackage-0.0.9}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name="basicemergesolverhelperpackage",
-    version="0.0.6",
+    version="0.0.9",
     author="Lubomir Jagos",
     author_email="lubomir.jagos.42@gmail.com",
     description="Mesh creation and plot utilities for EMerge solver or other FEM solver.",

{basicemergesolverhelperpackage-0.0.6 → basicemergesolverhelperpackage-0.0.9}/src/basicemergesolverhelperpackage/EMergeHelperFunctions.py

@@ -1,7 +1,15 @@
 import emerge as em
 import emerge._emerge.geometry as emergeGeo
-import emerge._emerge.physics.microwave.microwave_bc as emergeMicrowaveBC
-from emerge._emerge.physics.microwave.microwave_data import MWData #this is for simulationResult object literal specification for python
+
+#
+#   Import boundary condition objects, they are used as datatype to describe some methods return types, it's more about to
+#   have better type hints in intelligent python editors.
+#
+try:
+    import emerge._emerge.physics.microwave.bcs.port_bcs as emergeMicrowaveBC   #it's enough to just try import and in error case try older import
+except:
+    # this works for emerge version up to 2.6.x
+    import emerge._emerge.physics.microwave.microwave_bc as emergeMicrowaveBC
 
 from typing import Callable, Literal
 import gmsh
@@ -96,7 +104,32 @@ class EMergeHelperFunctions:
         for obj in objectList:
             self.simulationObj.mw.bc.LumpedElement(face=obj, impedance_function=impedance_function, width=width, height=height)
 
-    def setBoundaryConditionToObject(self, name: str, type: str):
+    def setSurfaceImpedanceBoundaryConditionToObject(self, name: str,
+        material: em.Material | str | None = None,
+        surface_conductance: float | None = None,
+        surface_roughness: float = 0,
+        thickness: float | None = None,
+        sr_model: Literal['Hammerstad-Jensen'] = 'Hammerstad-Jensen',
+        impedance_function: Callable | None = None,
+    ):
+        """Wrapper method specific for surface impedance, it call setBoundaryConditionToObject, this is to have method with proper named parameters."""
+
+        self.setBoundaryConditionToObject(name=name, type="surfaceImpedance", additionalParameters={
+            "material": self.getMaterial(material) if type(material) == str else material,
+            "surface_conductance": surface_conductance,
+            "surface_roughness": surface_roughness,
+            "thickness": thickness,
+            "sr_model": sr_model,
+            "impedance_function": impedance_function,
+        })
+
+    def setBoundaryConditionToObject(self, name: str, type: str, additionalParameters: dict = {}):
+        """Assign boundary condition to object, if some extra params are required for boundary condition to be created they should be passed in additionalParameters
+        dictionary and are unpacked, now used for SurfaceImpedance
+
+        For PEC, PMC there are no params needed for SurfaceImpedance there are needed conductance, roughness, thickness and surface roughness model can be specified.
+        """
+
         objectList = self.getObjectSurface(name)
         for obj in objectList:
             if type.lower() == "absorbing":
@@ -105,6 +138,8 @@ class EMergeHelperFunctions:
                 self.simulationObj.mw.bc.PEC(obj)
             elif type == "PMC":
                 self.simulationObj.mw.bc.PMC(obj)
+            elif type.lower() == "surfaceimpedance":
+                self.simulationObj.mw.bc.SurfaceImpedance(obj, **additionalParameters)
             else:
                 raise Exception(f"ERROR: Unknown type of boundary condition: {type}")
 
@@ -496,7 +531,9 @@ class EMergeHelperFunctions:
 
         return origin, u, v
 
-    def exportCSV_SParam(self, filename: str, simulationResult: MWData, sourcePortNumber: int, targetPortNumber: int, useMagnitude=True, delimiter=','):
+    def exportCSV_SParam(self, filename: str, sourcePortNumber: int, targetPortNumber: int, useMagnitude=True, delimiter=','):
+        simulationResult = self.simulationObj.data.mw
+
         # get frequency axis from result
         freq = simulationResult.scalar.grid.freq
 

{basicemergesolverhelperpackage-0.0.6 → basicemergesolverhelperpackage-0.0.9}/src/basicemergesolverhelperpackage/__init__.py

@@ -5,5 +5,5 @@ BasicMfemMesher - Mesh creation utilities for Palace solver.
 from .EMergeHelperFunctions import EMergeHelperFunctions
 from .EMergeConstants import *
 
-__version__ = "0.0.2"
+__version__ = "0.0.9"
 __all__ = ["EMergeHelperFunctions", "EMergeConstants"]

{basicemergesolverhelperpackage-0.0.6 → basicemergesolverhelperpackage-0.0.9}/src/basicemergesolverhelperpackage.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: basicemergesolverhelperpackage
-Version: 0.0.6
+Version: 0.0.9
 Summary: Mesh creation and plot utilities for EMerge solver or other FEM solver.
 Home-page: https://github.com/LubomirJagos42/basic-emerge-solver-helper-package
 Author: Lubomir Jagos