RCAIDE-GUI 1.0.0__py3-none-any.whl

tabs/solve/plots/thermal_management/plot_air_cooled_conditions.py

@@ -0,0 +1,152 @@
+# RCAIDE/Library/Plots/Thermal_Management/plot_air_cooled_conditions.py
+# 
+# 
+# Created:  Sep 2024, S. Shekar
+
+# ----------------------------------------------------------------------------------------------------------------------
+#  IMPORT
+# ----------------------------------------------------------------------------------------------------------------------  
+
+from RCAIDE.Framework.Core import Units
+from RCAIDE.Library.Plots.Common import set_axes, plot_style
+import matplotlib.pyplot as plt
+import matplotlib.cm as cm
+import numpy as np 
+
+# ----------------------------------------------------------------------------------------------------------------------
+#   plot_air_cooled_conditions
+# ----------------------------------------------------------------------------------------------------------------------   
+def plot_air_cooled_conditions(air_cooled, results, coolant_line, 
+                             save_figure = False,
+                             show_legend = True,
+                             save_filename = "Air_Cooled_Conditions",
+                             file_type = ".png",
+                             width = 11, height = 7):
+    """
+    Creates a multi-panel visualization of air-cooled heat exchanger performance.
+
+    Parameters
+    ----------
+    air_cooled : Component
+        Air-cooled heat exchanger component containing:
+            * tag : str
+                Unique identifier for the heat exchanger
+            
+    results : Results
+        RCAIDE results data structure containing:
+            * segments[i].conditions.frames.inertial.time[:,0]
+                Time history for each segment
+            * segments[i].conditions.energy.coolant_lines[coolant_line.tag][air_cooled.tag]
+                Heat exchanger performance data containing:
+                    * effectiveness[:,0]
+                        Heat exchanger effectiveness
+                    * total_heat_removed[:,0]
+                        Total heat transfer rate
+                    
+    coolant_line : Component
+        Coolant line component containing:
+            * tag : str
+                Unique identifier for the coolant circuit
+            
+    save_figure : bool, optional
+        Flag for saving the figure (default: False)
+        
+    show_legend : bool, optional
+        Flag to display segment legend (default: True)
+        
+    save_filename : str, optional
+        Name of file for saved figure (default: "Air_Cooled_Conditions")
+        
+    file_type : str, optional
+        File extension for saved figure (default: ".png")
+        
+    width : float, optional
+        Figure width in inches (default: 11)
+        
+    height : float, optional
+        Figure height in inches (default: 7)
+
+    Returns
+    -------
+    fig : matplotlib.figure.Figure
+        Handle to the generated figure
+   
+    Notes
+    -----
+    Creates visualization showing:
+        * Heat exchanger performance metrics
+        * Thermal effectiveness evolution
+        * Heat transfer rate history
+        * Time history for each segment
+    
+    **Definitions**
+    
+    'Effectiveness'
+        Ratio of actual to maximum possible heat transfer
+    'Heat Transfer Rate'
+        Rate of thermal energy transfer between fluids
+    'Heat Capacity Rate'
+        Product of mass flow rate and specific heat
+    
+    See Also
+    --------
+    RCAIDE.Library.Plots.Thermal_Management.plot_thermal_management_performance : Overall system performance
+    RCAIDE.Library.Plots.Thermal_Management.plot_cross_flow_heat_exchanger_conditions : Cross-flow heat exchanger analysis
+    """ 
+    
+    # get plotting style 
+    ps      = plot_style()  
+
+    parameters = {'axes.labelsize': ps.axis_font_size,
+                  'xtick.labelsize': ps.axis_font_size,
+                  'ytick.labelsize': ps.axis_font_size,
+                  'axes.titlesize': ps.title_font_size}
+    plt.rcParams.update(parameters)
+     
+    # get line colors for plots 
+    line_colors   = cm.inferno(np.linspace(0,0.9,len(results.segments)))     
+
+    fig = plt.figure(save_filename)
+    fig.set_size_inches(width,height)  
+    axis_1 = plt.subplot(2,1,1)
+    axis_2 = plt.subplot(2,1,2)
+    
+
+ 
+    for network in results.segments[0].analyses.vehicle.networks: 
+        busses  = network.busses 
+        for bus in busses:
+            for b_i, battery in enumerate(bus.battery_modules):
+                if b_i == 0 or bus.identical_battery_modules == False:
+                    for i in range(len(results.segments)): 
+                        time                       = results.segments[i].conditions.frames.inertial.time[:,0] / Units.min    
+                        air_cooled_conditions      = results.segments[i].conditions.energy.coolant_lines[coolant_line.tag][air_cooled.tag]
+                        effectiveness              = air_cooled_conditions.effectiveness[:,0]
+                        total_heat_removed         = air_cooled_conditions.total_heat_removed[:,0] 
+                        
+                        if i == 0: 
+                            axis_1.plot(time, effectiveness, color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width, label = battery.tag)
+                        else:
+                            axis_1.plot(time, effectiveness, color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width)
+                        axis_1.set_ylabel(r'Effectiveness') 
+                        set_axes(axis_1)     
+                         
+                        axis_2.plot(time, total_heat_removed, color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width)
+                        axis_2.set_ylabel(r'Total Heat Removed (W)')
+                        set_axes(axis_2)  
+            
+    if show_legend:    
+        leg =  fig.legend(bbox_to_anchor=(0.5, 0.95), loc='upper center', ncol = 4) 
+        leg.set_title('Flight Segment', prop={'size': ps.legend_font_size, 'weight': 'heavy'})  
+        
+    # Adjusting the sub-plots for legend 
+    fig.tight_layout()
+    fig.subplots_adjust(top=0.8) 
+    
+    # set title of plot 
+    title_text   = 'Air_Cooled_Properties'       
+    fig.suptitle(title_text) 
+    
+    if save_figure:
+        plt.savefig(save_filename + air_cooled.tag + file_type)    
+    return fig     

tabs/solve/plots/thermal_management/plot_cross_flow_heat_exchanger_conditions.py

@@ -0,0 +1,185 @@
+# RCAIDE/Library/Plots/Thermal_Management/plot_cross_flow_heat_exchanger_conditions.py
+# 
+# 
+# Created:  Sep 2024, S. Shekar
+
+# ----------------------------------------------------------------------------------------------------------------------
+#  IMPORT
+# ----------------------------------------------------------------------------------------------------------------------  
+
+from RCAIDE.Framework.Core import Units
+from RCAIDE.Library.Plots.Common import set_axes, plot_style
+import matplotlib.pyplot as plt
+import matplotlib.cm as cm
+import numpy as np 
+
+# ----------------------------------------------------------------------------------------------------------------------
+#   plot_heat_exchanger_system_conditions
+# ----------------------------------------------------------------------------------------------------------------------   
+def plot_cross_flow_heat_exchanger_conditions(cross_flow_hex, results, coolant_line,
+                                            save_figure = False,
+                                            show_legend = True,
+                                            save_filename = "Cross_Flow_HEX_Conditions",
+                                            file_type = ".png",
+                                            width = 11, height = 7):
+    """
+    Creates a multi-panel visualization of cross-flow heat exchanger operating conditions.
+
+    Parameters
+    ----------
+    cross_flow_hex : Component
+        Cross-flow heat exchanger component containing:
+            - tag : str
+                Unique identifier for the heat exchanger
+            
+    results : Results
+        RCAIDE results data structure containing:
+            - segments[i].conditions.energy.coolant_lines[coolant_line.tag][cross_flow_hex.tag]
+                Heat exchanger data containing:
+                    - coolant_mass_flow_rate[:,0]
+                        Coolant flow rate in kg/s
+                    - effectiveness_HEX[:,0]
+                        Heat exchanger effectiveness
+                    - power[:,0]
+                        Heat transfer rate in watts
+                    - air_inlet_pressure[:,0]
+                        Air-side inlet pressure in Pa
+                    - inlet_air_temperature[:,0]
+                        Air inlet temperature in K
+                    - air_mass_flow_rate[:,0]
+                        Air flow rate in kg/s
+                    
+    coolant_line : Component
+        Coolant line component containing:
+            - tag : str
+                Unique identifier for the coolant circuit
+            
+    save_figure : bool, optional
+        Flag for saving the figure (default: False)
+        
+    show_legend : bool, optional
+        Flag to display segment legend (default: True)
+        
+    save_filename : str, optional
+        Name of file for saved figure (default: "Cross_Flow_HEX_Conditions")
+        
+    file_type : str, optional
+        File extension for saved figure (default: ".png")
+        
+    width : float, optional
+        Figure width in inches (default: 11)
+        
+    height : float, optional
+        Figure height in inches (default: 7)
+
+    Returns
+    -------
+    fig : matplotlib.figure.Figure
+        Handle to the generated figure containing six subplots arranged in a 3x2 grid:
+        
+    Notes
+    -----
+    Creates visualization showing:
+        * Thermal performance metrics
+        * Flow conditions for both fluids
+        * Heat transfer characteristics
+        * Operating pressures and temperatures
+
+    **Definitions**
+    
+    'Effectiveness'
+        Ratio of actual to maximum possible heat transfer
+    'NTU'
+        Dimensionless measure of heat exchanger size
+    'Capacity Ratio'
+        Ratio of minimum to maximum heat capacity rates
+    'Mass Flow Rate'
+        Mass of fluid flowing per unit time
+    
+    See Also
+    --------
+    RCAIDE.Library.Plots.Thermal_Management.plot_thermal_management_performance : Overall system performance
+    RCAIDE.Library.Plots.Thermal_Management.plot_air_cooled_conditions : Air-cooled heat exchanger analysis
+    """ 
+    
+    # get plotting style 
+    ps      = plot_style()  
+
+    parameters = {'axes.labelsize': ps.axis_font_size,
+                  'xtick.labelsize': ps.axis_font_size,
+                  'ytick.labelsize': ps.axis_font_size,
+                  'axes.titlesize': ps.title_font_size}
+    plt.rcParams.update(parameters)
+     
+    # get line colors for plots 
+    line_colors   = cm.inferno(np.linspace(0,0.9,len(results.segments)))     
+
+    fig = plt.figure(save_filename)
+    fig.set_size_inches(width,height)  
+    axis_1 = plt.subplot(3,2,1)
+    axis_2 = plt.subplot(3,2,2) 
+    axis_3 = plt.subplot(3,2,3) 
+    axis_4 = plt.subplot(3,2,4)
+    axis_5 = plt.subplot(3,2,5) 
+    axis_6 = plt.subplot(3,2,6) 
+ 
+    for network in results.segments[0].analyses.vehicle.networks: 
+        busses  = network.busses 
+        for bus in busses:
+            for b_i, battery in enumerate(bus.battery_modules):
+                if b_i == 0 or bus.identical_battery_modules == False:
+                    for i in range(len(results.segments)): 
+                        time    = results.segments[i].conditions.frames.inertial.time[:,0] / Units.min    
+                        cross_flow_hex_conditions  = results.segments[i].conditions.energy.coolant_lines[coolant_line.tag][cross_flow_hex.tag]
+                
+                        coolant_mass_flow_rate     = cross_flow_hex_conditions.coolant_mass_flow_rate[:,0]        
+                        effectiveness_HEX          = cross_flow_hex_conditions.effectiveness_HEX[:,0]   
+                        power                      = cross_flow_hex_conditions.power[:,0]                       
+                        inlet_air_pressure         = cross_flow_hex_conditions.air_inlet_pressure[:,0]          
+                        inlet_air_temperature      = cross_flow_hex_conditions.inlet_air_temperature[:,0]          
+                        air_mass_flow_rate         = cross_flow_hex_conditions.air_mass_flow_rate[:,0]     
+                                             
+                        if i == 0: 
+                            axis_1.plot(time, effectiveness_HEX, color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width, label = cross_flow_hex.tag)
+                        else:
+                            axis_1.plot(time, effectiveness_HEX, color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width) 
+                        axis_1.set_ylabel(r'Effectiveness') 
+                        set_axes(axis_1)      
+                
+                        axis_2.plot(time,  inlet_air_temperature, color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width)
+                        axis_2.set_ylabel(r'Air Temp. (K)') 
+                        set_axes(axis_2)    
+                        
+                        axis_3.plot(time, coolant_mass_flow_rate, color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width)
+                        axis_3.set_ylabel(r'Coolant $\dot{m}$ (kg/s)')
+                        set_axes(axis_3) 
+                
+                        axis_4.plot(time, air_mass_flow_rate, color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width)
+                        axis_4.set_ylabel(r'Air $\dot{m}$ (kg/s)')
+                        set_axes(axis_4)                               
+                 
+                        axis_5.plot(time, power/1000, color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width)
+                        axis_5.set_ylabel(r'HEX Power (KW)')
+                        axis_5.set_xlabel(r'Time (mins)')
+                        set_axes(axis_5)    
+                
+                        axis_6.plot(time, inlet_air_pressure/10e6 , color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width)
+                        axis_6.set_ylabel(r'Air Pres. (MPa)')
+                        axis_6.set_xlabel(r'Time (mins)')
+                        set_axes(axis_6)  
+            
+    if show_legend:     
+        leg =  fig.legend(bbox_to_anchor=(0.5, 0.95), loc='upper center', ncol = 4) 
+        leg.set_title('Flight Segment', prop={'size': ps.legend_font_size, 'weight': 'heavy'})  
+    
+    # Adjusting the sub-plots for legend 
+    fig.tight_layout()
+    fig.subplots_adjust(top=0.8) 
+    
+    # set title of plot 
+    title_text   = 'Heat_Exchanger_System'       
+    fig.suptitle(title_text) 
+    
+    if save_figure:
+        plt.savefig(save_filename + cross_flow_hex.tag + file_type)    
+    return fig 

tabs/solve/plots/thermal_management/plot_reservoir_conditions.py

@@ -0,0 +1,141 @@
+# RCAIDE/Library/Plots/Thermal_Management/plot_reservoir_conditions.py
+# 
+# 
+# Created:  Sep 2024, S. Shekar
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+#  IMPORT
+# ----------------------------------------------------------------------------------------------------------------------  
+
+from RCAIDE.Framework.Core import Units
+from RCAIDE.Library.Plots.Common import set_axes, plot_style
+import matplotlib.pyplot as plt
+import matplotlib.cm as cm
+import numpy as np 
+
+# ----------------------------------------------------------------------------------------------------------------------
+#   plot_heat_exchanger_system_conditions
+# ----------------------------------------------------------------------------------------------------------------------   
+def plot_reservoir_conditions(reservoir, results, coolant_line,
+                            save_figure = False,
+                            show_legend = True,
+                            save_filename = "Reservoir_Conditions", 
+                            file_type = ".png",
+                            width = 11, height = 7):
+    """
+    Creates visualization of thermal reservoir temperature conditions throughout flight.
+
+    Parameters
+    ----------
+    reservoir : Component
+        Thermal reservoir component containing:
+            - tag : str
+                Unique identifier for the reservoir
+            
+    results : Results
+        RCAIDE results data structure containing:
+            - segments[i].conditions.frames.inertial.time[:,0]
+                Time history for each segment
+            - segments[i].conditions.energy.coolant_lines[coolant_line.tag][reservoir.tag]
+                Reservoir data containing:
+                    - coolant_temperature[:,0]
+                        Coolant temperature in K
+                    
+    coolant_line : Component
+        Coolant line component containing:
+            - tag : str
+                Unique identifier for the coolant circuit
+            
+    save_figure : bool, optional
+        Flag for saving the figure (default: False)
+        
+    show_legend : bool, optional
+        Flag to display segment legend (default: True)
+        
+    save_filename : str, optional
+        Name of file for saved figure (default: "Reservoir_Conditions")
+        
+    file_type : str, optional
+        File extension for saved figure (default: ".png")
+        
+    width : float, optional
+        Figure width in inches (default: 11)
+        
+    height : float, optional
+        Figure height in inches (default: 7)
+
+    Returns
+    -------
+    fig : matplotlib.figure.Figure
+        Handle to the generated figure containing single plot:
+        
+    Notes
+    -----
+    Creates visualization showing:
+        * Reservoir thermal state
+        * Temperature evolution
+        * Time history for each segment
+    
+    **Definitions**
+    
+    'Thermal Reservoir'
+        Component storing thermal energy in coolant
+    'Well-Mixed'
+        Uniform temperature throughout volume
+    'Thermal Mass'
+        Product of mass and specific heat
+    
+    See Also
+    --------
+    RCAIDE.Library.Plots.Thermal_Management.plot_thermal_management_performance : Overall system performance
+    RCAIDE.Library.Plots.Thermal_Management.plot_cross_flow_heat_exchanger_conditions : Heat exchanger analysis
+    """ 
+    # get plotting style 
+    ps      = plot_style()  
+
+    parameters = {'axes.labelsize': ps.axis_font_size,
+                  'xtick.labelsize': ps.axis_font_size,
+                  'ytick.labelsize': ps.axis_font_size,
+                  'axes.titlesize': ps.title_font_size}
+    plt.rcParams.update(parameters)
+     
+    # get line colors for plots 
+    line_colors   = cm.inferno(np.linspace(0,0.9,len(results.segments)))     
+
+    fig = plt.figure(save_filename)
+    fig.set_size_inches(width,height)  
+    axis_1 = plt.subplot(1,1,1)
+    set_axes(axis_1)      
+ 
+    for network in results.segments[0].analyses.vehicle.networks: 
+        busses  = network.busses 
+        for bus in busses:
+            for b_i, battery in enumerate(bus.battery_modules):
+                if b_i == 0 or bus.identical_battery_modules == False:
+                    for i in range(len(results.segments)): 
+                        time                  = results.segments[i].conditions.frames.inertial.time[:,0] / Units.min    
+                        reservoir_conditions    = results.segments[i].conditions.energy.coolant_lines[coolant_line.tag][reservoir.tag]
+                        reservoir_temperature =  reservoir_conditions.coolant_temperature[:,0] 
+                        
+                        if i == 0: 
+                            axis_1.plot(time, reservoir_temperature, color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width, label = battery.tag)
+                        else:
+                            axis_1.plot(time, reservoir_temperature, color = line_colors[i], marker = ps.markers[b_i], linewidth = ps.line_width)
+                        axis_1.set_ylabel(r'Coolant Temp. (K)')   
+            
+    if show_legend:        
+        leg =  fig.legend(bbox_to_anchor=(0.5, 0.95), loc='upper center', ncol = 4) 
+        leg.set_title('Flight Segment', prop={'size': ps.legend_font_size, 'weight': 'heavy'})
+                    
+    # Adjusting the sub-plots for legend 
+    fig.tight_layout()
+    fig.subplots_adjust(top=0.8) 
+    
+    # set title of plot 
+    title_text   = 'Reservoir Temperature'       
+    fig.suptitle(title_text) 
+    
+    if save_figure:
+        plt.savefig(save_filename + reservoir.tag + file_type)    
+    return fig 

tabs/solve/plots/thermal_management/plot_thermal_management_performance.py

@@ -0,0 +1,105 @@
+# RCAIDE/Library/Plots/Thermal_Management/plot_thermal_management_performance.py
+# 
+# 
+# Created:  Sep 2024, S. Shekar
+# ----------------------------------------------------------------------------------------------------------------------
+#   plot_thermal_management_performance
+# ----------------------------------------------------------------------------------------------------------------------   
+def plot_thermal_management_performance(results,
+                        save_figure   = False,
+                        show_legend   = True,
+                        file_type     =".png",
+                        width         = 12,
+                        height        = 7):
+    """
+    Checks and plots all components of a thermal management system.
+
+    Parameters
+    ----------
+    results : Results
+        RCAIDE results data structure containing:
+            - segments[i].analyses.vehicle.networks
+                Network data containing:
+                    - coolant_lines
+                        List of coolant circuits with:
+                            - battery_modules
+                                List of battery thermal management systems
+                            - heat_exchangers
+                                List of heat exchanger components
+                            - reservoirs
+                                List of thermal reservoir components
+                            - identical_battery_modules : bool
+                                Flag indicating if batteries are identical
+                            
+    save_figure : bool, optional
+        Flag for saving the figure (default: False)
+        
+    show_legend : bool, optional
+        Flag to display component legends (default: True)
+        
+    file_type : str, optional
+        File extension for saved figures (default: ".png")
+        
+    width : float, optional
+        Figure width in inches (default: 12)
+        
+    height : float, optional
+        Figure height in inches (default: 7)
+
+    Returns
+    -------
+    None
+        Function generates and displays/saves plots for each component
+
+    Notes
+    -----
+    Creates visualizations showing:
+        * Battery thermal management system performance
+        * Heat exchanger operating conditions
+        * Reservoir thermal states
+        * Overall system behavior
+    
+    For each component type:
+        * Calls appropriate plotting function
+        * Passes component-specific data
+        * Maintains consistent formatting
+        * Handles identical/unique components
+    
+    **Definitions**
+    
+    'Thermal Management System'
+        Network of components managing heat transfer
+    'Battery Module'
+        Battery with thermal management system
+    'Heat Exchanger'
+        Component transferring heat between fluids
+    'Reservoir'
+        Component storing thermal energy
+    
+    See Also
+    --------
+    RCAIDE.Library.Plots.Thermal_Management.plot_air_cooled_conditions : Air-cooled system analysis
+    RCAIDE.Library.Plots.Thermal_Management.plot_cross_flow_heat_exchanger_conditions : Heat exchanger analysis
+    RCAIDE.Library.Plots.Thermal_Management.plot_reservoir_conditions : Reservoir analysis
+    """     
+    
+    for network in  results.segments[0].analyses.vehicle.networks:
+        for coolant_line in  network.coolant_lines:
+            for tag, item in  coolant_line.items():
+                if coolant_line.identical_battery_modules:
+                    if tag == 'battery_modules':
+                            for i, battery in enumerate(item):
+                                for btms in  (battery):
+                                    if i ==  0:
+                                        btms.plot_operating_conditions(results,coolant_line,save_figure,show_legend,btms.tag,file_type,width, height)
+                else:
+                    for _, battery in enumerate(item):
+                            for btms in  (battery):
+                                btms.plot_operating_conditions(results,coolant_line,save_figure,show_legend,btms.tag,file_type,width, height)
+                if tag == 'heat_exchangers':
+                    for heat_exchanger in  item:
+                        heat_exchanger.plot_operating_conditions(results,coolant_line,save_figure,show_legend,heat_exchanger.tag,file_type,width, height)
+                if tag == 'reservoirs':
+                    for reservoir in  item:
+                        reservoir.plot_operating_conditions(results,coolant_line,save_figure,show_legend,reservoir.tag,file_type,width, height)             
+    return