midas-civil 1.4.1__py3-none-any.whl

midas_civil/_temperature.py

@@ -0,0 +1,677 @@
+from ._mapi import MidasAPI
+# from ._node import *
+from ._group import Group
+from ._load import Load_Case
+
+def convList(item):
+    if type(item) != list:
+        return [item]
+    else:
+        return item
+    
+class Temperature:
+
+    @classmethod
+    def create(cls):
+        """Creates Temperature elements in MIDAS Civil NX"""
+        if cls.System.temps: cls.System.create()
+        if cls.Element.temps: cls.Element.create()
+        if cls.Gradient.temps: cls.Gradient.create()
+        if cls.Nodal.temps: cls.Nodal.create()
+        if cls.BeamSection.temps: cls.BeamSection.create()        
+
+    @classmethod
+    def delete(cls):
+        """Deletes Temperature elements from MIDAS Civil NX and Python"""
+        cls.System.delete()
+        cls.Element.delete()
+        cls.Gradient.delete()
+        cls.Nodal.delete()
+        cls.BeamSection.delete()
+        
+    @classmethod
+    def clear(cls):
+        """Deletes Temperature elements from MIDAS Civil NX and Python"""
+        cls.System.clear()
+        cls.Element.clear()
+        cls.Gradient.clear()
+        cls.Nodal.clear()
+        cls.BeamSection.clear()
+
+    @classmethod
+    def sync(cls):
+        """Sync Temperature elements from MIDAS Civil NX to Python"""
+        cls.System.sync()
+        cls.Element.sync()
+        cls.Gradient.sync()
+        cls.Nodal.sync()
+        cls.BeamSection.sync()
+                
+    # --------------------------------------------------------------------------------------------------
+    # System Temperature
+    # --------------------------------------------------------------------------------------------------
+    class System:
+        """
+        Create System Temperature Object in Python
+        
+        Parameters:
+            temperature (float): Temperature value
+            lcname (str): Load case name
+            group (str): Load group name (default "")
+            id (int): System ID (optional)
+        
+        Example:
+            Temperature.System(12.5, "Temp(+)", "LoadGroup1", 1)
+        """
+        temps = []
+        
+        def __init__(self, temperature, lcname, group="", id=None):
+            chk = 0
+            for i in Load_Case.cases:
+                if lcname in i.NAME: chk = 1
+            if chk == 0: Load_Case("T", lcname)
+
+            if group:
+                chk = 0
+                try:
+                    a = [v['NAME'] for v in Group.Load.json()["Assign"].values()]
+                    if group in a:
+                        chk = 1
+                except:
+                    pass
+                if chk == 0:
+                    Group.Load(group)
+            
+            self.TEMPER = temperature
+            self.LCNAME = lcname
+            self.GROUP_NAME = group
+            
+            if id is None:
+                self.ID = len(Temperature.System.temps) + 1
+            else:
+                self.ID = id
+            
+            Temperature.System.temps.append(self)
+
+        @classmethod
+        def json(cls):
+            """Creates JSON from System Temperature objects defined in Python"""
+            json_data = {"Assign": {}}
+            for temp in cls.temps:
+                json_data["Assign"][str(temp.ID)] = {
+                    "TEMPER": temp.TEMPER,
+                    "LCNAME": temp.LCNAME,
+                    "GROUP_NAME": temp.GROUP_NAME
+                }
+            return json_data
+
+        @staticmethod
+        def create():
+            """Creates System Temperatures in MIDAS Civil NX"""
+            MidasAPI("PUT", "/db/stmp", Temperature.System.json())
+
+        @staticmethod
+        def get():
+            """Get the JSON of System Temperatures from MIDAS Civil NX"""
+            return MidasAPI("GET", "/db/stmp")
+
+        @staticmethod
+        def sync():
+            """Sync System Temperatures from MIDAS Civil NX to Python"""
+            Temperature.System.temps = []
+            a = Temperature.System.get()
+            
+            if a and 'STMP' in a:
+                temp_data = a.get('STMP', {})
+                for temp_id, temp_info in temp_data.items():
+                    Temperature.System(
+                        temp_info.get('TEMPER', 0),
+                        temp_info.get('LCNAME', ''),
+                        temp_info.get('GROUP_NAME', ''),
+                        int(temp_id)
+                    )
+
+        @staticmethod
+        def delete():
+            """Delete System Temperatures from MIDAS Civil NX and Python"""
+            Temperature.System.clear()
+            return MidasAPI("DELETE", "/db/stmp")
+
+        @staticmethod
+        def clear():
+            """Delete System Temperatures from Python"""
+            Temperature.System.temps = []
+
+    # --------------------------------------------------------------------------------------------------
+    # Element Temperature
+    # --------------------------------------------------------------------------------------------------
+    class Element:
+        """
+        Create Element Temperature Object in Python
+        
+        Parameters:
+            element (int): Element ID
+            temperature (float): Temperature value
+            lcname (str): Load case name
+            group (str): Load group name (default "")
+            id (int): Temperature ID (optional)
+        
+        Example:
+            Temperature.Element(1, 35, "Temp(+)", "", 1)
+        """
+        temps = []
+        
+        def __init__(self, element, temperature, lcname, group="", id=None):
+
+            chk = 0
+            for i in Load_Case.cases:
+                if lcname in i.NAME: chk = 1
+            if chk == 0: Load_Case("T", lcname)
+
+            if group:
+                chk = 0
+                try:
+                    a = [v['NAME'] for v in Group.Load.json()["Assign"].values()]
+                    if group in a:
+                        chk = 1
+                except:
+                    pass
+                if chk == 0:
+                    Group.Load(group)
+            
+            self.ELEMENT = element
+            self.TEMP = temperature
+            self.LCNAME = lcname
+            self.GROUP_NAME = group
+            
+            if id is None:
+                existing_ids = []
+                for temp in Temperature.Element.temps:
+                    if temp.ELEMENT == element:
+                        existing_ids.extend([item.get('ID', 0) for item in temp.ITEMS if hasattr(temp, 'ITEMS')])
+                self.ID = max(existing_ids, default=0) + 1
+            else:
+                self.ID = id
+            
+            existing_temp = None
+            for temp in Temperature.Element.temps:
+                if temp.ELEMENT == element:
+                    existing_temp = temp
+                    break
+            
+            item_data = {
+                "ID": self.ID, "LCNAME": self.LCNAME,
+                "GROUP_NAME": self.GROUP_NAME, "TEMP": self.TEMP
+            }
+
+            if existing_temp:
+                if not hasattr(existing_temp, 'ITEMS'):
+                    existing_temp.ITEMS = []
+                existing_temp.ITEMS.append(item_data)
+            else:
+                self.ITEMS = [item_data]
+                Temperature.Element.temps.append(self)
+
+        @classmethod
+        def json(cls):
+            """Creates JSON from Element Temperature objects defined in Python"""
+            json_data = {"Assign": {}}
+            for temp in cls.temps:
+                json_data["Assign"][str(temp.ELEMENT)] = {"ITEMS": temp.ITEMS}
+            return json_data
+
+        @staticmethod
+        def create():
+            """Creates Element Temperatures in MIDAS Civil NX"""
+            MidasAPI("PUT", "/db/etmp", Temperature.Element.json())
+
+        @staticmethod
+        def get():
+            """Get the JSON of Element Temperatures from MIDAS Civil NX"""
+            return MidasAPI("GET", "/db/etmp")
+
+        @staticmethod
+        def sync():
+            """Sync Element Temperatures from MIDAS Civil NX to Python"""
+            Temperature.Element.temps = []
+            a = Temperature.Element.get()
+            
+            if a and 'ETMP' in a:
+                temp_data = a.get('ETMP', {})
+                for element_id, element_data in temp_data.items():
+                    element_obj = type('obj', (object,), {
+                        'ELEMENT': int(element_id),
+                        'ITEMS': element_data.get('ITEMS', [])
+                    })()
+                    Temperature.Element.temps.append(element_obj)
+
+        @staticmethod
+        def delete():
+            """Delete Element Temperatures from MIDAS Civil NX and Python"""
+            Temperature.Element.clear()
+            return MidasAPI("DELETE", "/db/etmp")
+        
+        @staticmethod
+        def clear():
+            """Delete Element Temperatures from MIDAS Civil NX and Python"""
+            Temperature.Element.temps = []
+
+    # --------------------------------------------------------------------------------------------------
+    # Temperature Gradient
+    # --------------------------------------------------------------------------------------------------
+    class Gradient:
+        """
+        Create Temperature Gradient Object in Python for Beam and Plate elements.
+        
+        Parameters:
+            element (int): Element ID to apply the gradient.
+            type (str): Element type, either 'Beam' or 'Plate'.
+            lcname (str): Load Case Name (must exist in the model).
+            tz (float): Temperature difference in the local z-direction (T2z - T1z).
+            group (str, optional): Load Group Name. Defaults to "".
+            id (int, optional): Gradient ID. Auto-assigned if not provided.
+            hz (float, optional): Gradient value for local z-dir. If omitted, section default is used.
+            ty (float, optional): Temp. diff. in local y-dir (T2y - T1y). **Required for 'Beam' type.**
+            hy (float, optional): Gradient value for local y-dir. If omitted, section default is used.
+        
+        Example for Beam (providing gradient values):
+            Temperature.Gradient(element=2, type='Beam', lcname='Temp(-)', tz=10, ty=-10, hz=1.2, hy=0.5)
+        
+        Example for Beam (using section defaults):
+            Temperature.Gradient(element=2, type='Beam', lcname='Temp(+)', tz=10, ty=-10)
+        
+        Example for Plate (providing gradient value):
+            Temperature.Gradient(element=21, type='Plate', lcname='Temp(-)', tz=10, hz=0.2)
+        """
+        temps = []
+
+        def __init__(self, element, type, lcname, tz, group="", hz=None, ty=0, hy=None,id=None):
+
+            chk = 0
+            for i in Load_Case.cases:
+                if lcname in i.NAME: chk = 1
+            if chk == 0: Load_Case("T", lcname)
+            
+            if group:
+                chk = 0
+                try:
+                    a = [v['NAME'] for v in Group.Load.json()["Assign"].values()]
+                    if group in a:
+                        chk = 1
+                except:
+                    pass
+                if chk == 0:
+                    Group.Load(group)
+            
+            self.ELEMENT = element
+            
+            if id is None:
+                existing_ids = []
+                for temp in Temperature.Gradient.temps:
+                    if temp.ELEMENT == element:
+                        existing_ids.extend([item.get('ID', 0) for item in temp.ITEMS if hasattr(temp, 'ITEMS')])
+                self.ID = max(existing_ids, default=0) + 1
+            else:
+                self.ID = id
+
+            use_hz = (hz is None)
+            use_hy = (hy is None)
+
+            item_data = {
+                "ID": self.ID,
+                "LCNAME": lcname,
+                "GROUP_NAME": group,
+                "TZ": tz,
+                "USE_HZ": use_hz,
+            }
+
+            if not use_hz:
+                item_data["HZ"] = hz
+
+            if type.lower() == 'beam':
+                item_data["TYPE"] = 1
+                item_data["TY"] = ty
+                item_data["USE_HY"] = use_hy
+                if not use_hy:
+                    item_data["HY"] = hy
+            elif type.lower() == 'plate':
+                item_data["TYPE"] = 2
+            else:
+                raise ValueError("Element type for Gradient must be 'Beam' or 'Plate'.")
+
+            existing_temp = None
+            for temp in Temperature.Gradient.temps:
+                if temp.ELEMENT == element:
+                    existing_temp = temp
+                    break
+
+            if existing_temp:
+                if not hasattr(existing_temp, 'ITEMS'):
+                    existing_temp.ITEMS = []
+                existing_temp.ITEMS.append(item_data)
+            else:
+                self.ITEMS = [item_data]
+                Temperature.Gradient.temps.append(self)
+        
+        @classmethod
+        def json(cls):
+            """Creates JSON from Temperature Gradient objects defined in Python"""
+            json_data = {"Assign": {}}
+            for temp in cls.temps:
+                json_data["Assign"][str(temp.ELEMENT)] = {"ITEMS": temp.ITEMS}
+            return json_data
+
+        @staticmethod
+        def create():
+            """Creates Temperature Gradients in MIDAS Civil NX"""
+            MidasAPI("PUT", "/db/gtmp", Temperature.Gradient.json())
+
+        @staticmethod
+        def get():
+            """Get the JSON of Temperature Gradients from MIDAS Civil NX"""
+            return MidasAPI("GET", "/db/gtmp")
+
+        @staticmethod
+        def sync():
+            """Sync Temperature Gradients from MIDAS Civil NX to Python"""
+            Temperature.Gradient.temps = []
+            a = Temperature.Gradient.get()
+            
+            if a and 'GTMP' in a:
+                temp_data = a.get('GTMP', {})
+                for element_id, element_data in temp_data.items():
+                    element_obj = type('obj', (object,), {
+                        'ELEMENT': int(element_id),
+                        'ITEMS': element_data.get('ITEMS', [])
+                    })()
+                    Temperature.Gradient.temps.append(element_obj)
+
+        @staticmethod
+        def delete():
+            """Delete Temperature Gradients from MIDAS Civil NX and Python"""
+            Temperature.Gradient.clear()
+            return MidasAPI("DELETE", "/db/gtmp")
+        
+        @staticmethod
+        def clear():
+            """Delete Temperature Gradients from MIDAS Civil NX and Python"""
+            Temperature.Gradient.temps = []
+
+    # --------------------------------------------------------------------------------------------------
+    # Nodal Temperature
+    # --------------------------------------------------------------------------------------------------
+    class Nodal:
+        """
+        Create Nodal Temperature  
+        
+        Parameters:
+            node (int): Node ID
+            temperature (float): Temperature value  
+            lcname (str): Load case name **(Must exist in the model)**
+            group (str): Load group name (default "")
+            id (int): Temperature ID (optional)
+        
+        Example:
+            Temperature.Nodal(6, 10, "Test")
+        """
+        temps = []
+        
+        def __init__(self, node, temperature, lcname, group="", id=None):
+
+            chk = 0
+            for i in Load_Case.cases:
+                if lcname in i.NAME: chk = 1
+            if chk == 0: Load_Case("T", lcname)
+
+            if group:
+                chk = 0
+                try:
+                    a = [v['NAME'] for v in Group.Load.json()["Assign"].values()]
+                    if group in a:
+                        chk = 1
+                except:
+                    pass
+                if chk == 0:
+                    Group.Load(group)
+            
+            self.NODE = node
+            self.TEMPER = temperature
+            self.LCNAME = lcname
+            self.GROUP_NAME = group
+            
+            if id is None:
+                existing_ids = []
+                for temp in Temperature.Nodal.temps:
+                    if temp.NODE == node:
+                        existing_ids.extend([item.get('ID', 0) for item in temp.ITEMS if hasattr(temp, 'ITEMS')])
+                self.ID = max(existing_ids, default=0) + 1
+            else:
+                self.ID = id
+            
+            existing_temp = None
+            for temp in Temperature.Nodal.temps:
+                if temp.NODE == node:
+                    existing_temp = temp
+                    break
+            
+            item_data = {
+                "ID": self.ID, "LCNAME": self.LCNAME,
+                "GROUP_NAME": self.GROUP_NAME, "TEMPER": self.TEMPER
+            }
+
+            if existing_temp:
+                if not hasattr(existing_temp, 'ITEMS'):
+                    existing_temp.ITEMS = []
+                existing_temp.ITEMS.append(item_data)
+            else:
+                self.ITEMS = [item_data]
+                Temperature.Nodal.temps.append(self)
+
+        @classmethod
+        def json(cls):
+            """Creates JSON with 'Assign' key from Nodal Temperature objects defined in Python"""
+            json_data = {"Assign": {}}
+            for temp in cls.temps:
+                json_data["Assign"][str(temp.NODE)] = {"ITEMS": temp.ITEMS}
+            return json_data
+
+        @staticmethod
+        def create():
+            """Creates Nodal Temperatures in MIDAS Civil NX"""
+            MidasAPI("PUT", "/db/ntmp", Temperature.Nodal.json())
+
+        @staticmethod
+        def get():
+            """Get the JSON of Nodal Temperatures from MIDAS Civil NX"""
+            return MidasAPI("GET", "/db/ntmp")
+
+        @staticmethod
+        def sync():
+            """Sync Nodal Temperatures from MIDAS Civil NX to Python"""
+            Temperature.Nodal.temps = []
+            a = Temperature.Nodal.get()
+            
+            if a and 'NTMP' in a:
+                temp_data = a.get('NTMP', {})
+                for node_id, node_data in temp_data.items():
+                    node_obj = type('obj', (object,), {
+                        'NODE': int(node_id),
+                        'ITEMS': node_data.get('ITEMS', [])
+                    })()
+                    Temperature.Nodal.temps.append(node_obj)
+
+        @staticmethod
+        def delete():
+            """Delete Nodal Temperatures from MIDAS Civil NX and Python"""
+            Temperature.Nodal.clear()
+            return MidasAPI("DELETE", "/db/ntmp")
+        
+        @staticmethod
+        def clear():
+            """Delete Nodal Temperatures from MIDAS Civil NX and Python"""
+            Temperature.Nodal.temps = []
+
+
+    # --------------------------------------------------------------------------------------------------
+    # Beam Section Temperature
+    # --------------------------------------------------------------------------------------------------
+    class BeamSection:
+        """
+        Create Beam Section Temperature Object in Python.
+        
+        Parameters:
+            element (int): Element ID to apply the load.
+            lcname (str): Load Case Name (must exist in the model).
+            section_type (str, optional): 'General' or 'PSC'. Defaults to 'General'.
+            type (str, optional): 'Element' or 'Input'. Defaults to 'Element'.
+            group (str, optional): Load Group Name.
+            id (int, optional): Load ID.
+            dir (str, optional): Direction, 'LY' or 'LZ'. Defaults to 'LZ'.
+            ref_pos (str, optional): Reference Position, 'Centroid', 'Top', or 'Bot'. Defaults to 'Centroid'.
+            val_b (float, optional): B Value.
+            val_h1 (float, optional): H1 Value.
+            val_h2 (float, optional): H2 Value.
+            val_t1 (float, optional): T1 Value.
+            val_t2 (float, optional): T2 Value.
+            elast (float, optional): Modulus of Elasticity (required for 'Input' type).
+            thermal (float, optional): Thermal Coefficient (required for 'Input' type).
+            psc_ref (int, optional): Reference for PSC, 0 for Top, 1 for Bottom.
+            psc_opt_b (int, optional): B-Type option for PSC. (0 for Section type)
+            psc_opt_h1 (int, optional): H1-Type option for PSC. (0 - Z1 , 1- Z2 ,2 - Z2)
+            psc_opt_h2 (int, optional): H2-Type option for PSC.  (0 - Z1 , 1- Z2 ,2 - Z2)
+        """
+        temps = []
+
+        def __init__(self, element, lcname, section_type='General', type='Element', group="", 
+                    dir='LZ', ref_pos='Centroid', val_b=0, val_h1=0, val_h2=0, val_t1=0, val_t2=0,
+                    elast=None, thermal=None, psc_ref=0, psc_opt_b=1, psc_opt_h1=3, psc_opt_h2=3, id=None):
+
+            # Validate required parameters for Input type
+            if type.upper() == 'INPUT':
+                if elast is None or thermal is None:
+                    raise ValueError("For 'Input' type, both 'elast' and 'thermal' parameters are required.")
+
+            # Handle load group creation
+
+            chk = 0
+            for i in Load_Case.cases:
+                if lcname in i.NAME: chk = 1
+            if chk == 0: Load_Case("T", lcname)
+            
+            if group:
+                chk = 0
+                try:
+                    a = [v['NAME'] for v in Group.Load.json()["Assign"].values()]
+                    if group in a:
+                        chk = 1
+                except:
+                    pass
+                if chk == 0:
+                    Group.Load(group)
+            
+            self.ELEMENT = element
+
+            # Auto-assign ID if not provided
+            if id is None:
+                existing_ids = []
+                for temp in Temperature.BeamSection.temps:
+                    if temp.ELEMENT == element:
+                        existing_ids.extend([item.get('ID', 0) for item in temp.ITEMS if hasattr(temp, 'ITEMS')])
+                self.ID = max(existing_ids, default=0) + 1
+            else:
+                self.ID = id
+            
+            # Construct the nested dictionary for vSECTTMP
+            vsec_item = {
+                "TYPE": type.upper(),
+                "VAL_B": val_b,
+                "VAL_H1": val_h1,
+                "VAL_H2": val_h2,
+                "VAL_T1": val_t1,
+                "VAL_T2": val_t2,
+            }
+
+            is_psc = section_type.lower() == 'psc'
+            
+            # Add material properties for Input type
+            if type.upper() == 'INPUT':
+                vsec_item["ELAST"] = elast
+                vsec_item["THERMAL"] = thermal
+            
+            # Add PSC-specific parameters
+            if is_psc:
+                vsec_item["REF"] = psc_ref
+                vsec_item["OPT_B"] = psc_opt_b
+                vsec_item["OPT_H1"] = psc_opt_h1
+                vsec_item["OPT_H2"] = psc_opt_h2
+
+            # Construct the main item dictionary
+            item_data = {
+                "ID": self.ID,
+                "LCNAME": lcname,
+                "GROUP_NAME": group,
+                "DIR": dir,
+                "REF": ref_pos,
+                "NUM": 1,
+                "bPSC": is_psc,
+                "vSECTTMP": [vsec_item]
+            }
+
+            # Check if an object for this element already exists
+            existing_temp = None
+            for temp in Temperature.BeamSection.temps:
+                if temp.ELEMENT == element:
+                    existing_temp = temp
+                    break
+
+            if existing_temp:
+                if not hasattr(existing_temp, 'ITEMS'):
+                    existing_temp.ITEMS = []
+                existing_temp.ITEMS.append(item_data)
+            else:
+                self.ITEMS = [item_data]
+                Temperature.BeamSection.temps.append(self)
+        
+        @classmethod
+        def json(cls):
+            """Creates JSON from Beam Section Temperature objects defined in Python"""
+            json_data = {"Assign": {}}
+            for temp in cls.temps:
+                json_data["Assign"][str(temp.ELEMENT)] = {"ITEMS": temp.ITEMS}
+            return json_data
+
+        @staticmethod
+        def create():
+            """Creates Beam Section Temperatures in MIDAS Civil NX"""
+            MidasAPI("PUT", "/db/btmp", Temperature.BeamSection.json())
+
+        @staticmethod
+        def get():
+            """Get the JSON of Beam Section Temperatures from MIDAS Civil NX"""
+            return MidasAPI("GET", "/db/btmp")
+
+        @staticmethod
+        def sync():
+            """Sync Beam Section Temperatures from MIDAS Civil NX to Python"""
+            Temperature.BeamSection.temps = []
+            a = Temperature.BeamSection.get()
+            
+            if a and 'BTMP' in a:
+                temp_data = a.get('BTMP', {})
+                for element_id, element_data in temp_data.items():
+                    element_obj = type('obj', (object,), {
+                        'ELEMENT': int(element_id),
+                        'ITEMS': element_data.get('ITEMS', [])
+                    })()
+                    Temperature.BeamSection.temps.append(element_obj)
+
+        @staticmethod
+        def delete():
+            """Delete Beam Section Temperatures from MIDAS Civil NX and Python"""
+            Temperature.BeamSection.clear()
+            return MidasAPI("DELETE", "/db/btmp")
+        
+        @staticmethod
+        def clear():
+            """Delete Beam Section Temperatures from MIDAS Civil NX and Python"""
+            Temperature.BeamSection.temps = []