freepaths 2.1.2__tar.gz → 2.1.3__tar.gz

{freepaths-2.1.2 → freepaths-2.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: freepaths
-Version: 2.1.2
+Version: 2.1.3
 Summary: Phonon Monte Carlo simulator
 Home-page: https://github.com/anufrievroman/freepaths
 Author: Roman Anufriev

{freepaths-2.1.2 → freepaths-2.1.3}/freepaths/__main__.py

@@ -7,7 +7,7 @@ from colorama import Fore, Style
 import freepaths.main_tracing
 import freepaths.main_mfp_sampling
 
-__version__ = "2.1.2"
+__version__ = "2.1.3"
 
 colorama.init()
 

{freepaths-2.1.2 → freepaths-2.1.3}/freepaths/config.py

@@ -93,6 +93,7 @@ class Config:
         self.hot_side_position_bottom = HOT_SIDE_POSITION_BOTTOM
         self.hot_side_position_right = HOT_SIDE_POSITION_RIGHT
         self.hot_side_position_left = HOT_SIDE_POSITION_LEFT
+        self.rethermalization_on_hot_sides = RETHERMALIZATION_ON_HOT_SIDES
 
         # Sources:
         self.phonon_sources = PHONON_SOURCES

{freepaths-2.1.2 → freepaths-2.1.3}/freepaths/default_config.py

@@ -58,6 +58,7 @@ HOT_SIDE_POSITION_TOP            = False
 HOT_SIDE_POSITION_BOTTOM         = True
 HOT_SIDE_POSITION_RIGHT          = False
 HOT_SIDE_POSITION_LEFT           = False
+RETHERMALIZATION_ON_HOT_SIDES    = True
 
 # Phonon source:
 PHONON_SOURCES = [Source(x=0, y=0, z=0, size_x=0,  size_y=0, size_z=0, angle_distribution="random", angle=0)]

{freepaths-2.1.2 → freepaths-2.1.3}/freepaths/phonon.py

@@ -66,17 +66,36 @@ class Phonon:
         return self.speed / self.f
 
     @property
-    def is_in_system(self):
-        """Checks if the phonon at this timestep did not reach the cold side.
-        Depending on where user set cold sides, we check if phonon crossed that line"""
-        is_inside_top = self.y < cf.length
-        is_inside_bottom = self.y > 0
-        is_inside_right = self.x < cf.width / 2.0
-        is_inside_left = self.x > - cf.width / 2.0
-        return ((not cf.cold_side_position_top or is_inside_top) and
-                (not cf.cold_side_position_bottom or is_inside_bottom) and
-                (not cf.cold_side_position_right or is_inside_right) and
-                (not cf.cold_side_position_left or is_inside_left))
+    def has_crossed_cold_side(self):
+        """
+        Checks if the phonon at this timestep crossed the cold side.
+        Depending on where user set cold sides, we check if phonon crossed that line.
+        Return boolean of wheather any of the cold sides has been crossed.
+        """
+        has_crossed_top = self.y > cf.length
+        has_crossed_bottom = self.y < 0
+        has_crossed_right = self.x > cf.width / 2.0
+        has_crossed_left = self.x < - cf.width / 2.0
+        return ((cf.cold_side_position_top and has_crossed_top) or
+                (cf.cold_side_position_bottom and has_crossed_bottom) or
+                (cf.cold_side_position_right and has_crossed_right) or
+                (cf.cold_side_position_left and has_crossed_left))
+
+    @property
+    def has_crossed_hot_side(self):
+        """
+        Checks if the phonon at this timestep crossed the hot side.
+        Depending on where user set hot sides, we check if phonon crossed that line.
+        Return boolean of wheather any of the hot sides has been crossed.
+        """
+        has_crossed_top = self.y > cf.length
+        has_crossed_bottom = self.y < 0
+        has_crossed_right = self.x > cf.width / 2.0
+        has_crossed_left = self.x < - cf.width / 2.0
+        return ((cf.hot_side_position_top and has_crossed_top) or
+                (cf.hot_side_position_bottom and has_crossed_bottom) or
+                (cf.hot_side_position_right and has_crossed_right) or
+                (cf.hot_side_position_left and has_crossed_left))
 
     def assign_frequency(self, material):
         """Assigning frequency with probability according to Planckian distribution"""

freepaths-2.1.3/freepaths/run_phonon.py

@@ -0,0 +1,78 @@
+"""
+Module that runs one phonon through the structure, from phonon source to a cold side.
+After the run, we record various parameters of this run into flight object.
+"""
+
+from freepaths.config import cf
+from freepaths.scattering import internal_scattering, surface_scattering, reinitialization
+from freepaths.scattering_types import ScatteringTypes, ScatteringPlaces
+
+
+def run_phonon(phonon, flight, scatter_stats, places_stats, segment_stats, thermal_maps, scatter_maps, material):
+    """Run one phonon through the system and record parameters of this run"""
+
+    # Initialize object that will store scattering types:
+    scattering_types = ScatteringTypes()
+    triangle_scattering_places = ScatteringPlaces()
+
+    # Run the phonon step-by-step:
+    for step_number in range(cf.number_of_timesteps):
+
+        # If the phonon reached a cold side, record it and break the loop:
+        if phonon.has_crossed_cold_side:
+            flight.add_point_to_path()
+            flight.save_free_paths()
+            flight.finish(step_number, cf.timestep)
+            break
+
+        # If the phonon reached a hot side, record it and break the loop:
+        if phonon.has_crossed_hot_side and not cf.rethermalization_on_hot_sides:
+            flight.add_point_to_path()
+            flight.save_free_paths()
+            break
+
+        # Check if different scattering events happened during current time step:
+        if cf.include_internal_scattering:
+            internal_scattering(phonon, flight, scattering_types)
+        surface_scattering(phonon, scattering_types, triangle_scattering_places)
+        if cf.rethermalization_on_hot_sides:
+            reinitialization(phonon, scattering_types)
+
+        # If any scattering has occurred, record it:
+        if scattering_types.is_scattered:
+            flight.add_point_to_path()
+            scatter_stats.save_scattering_events(phonon.y, scattering_types)
+            if cf.output_scattering_map:
+                scatter_maps.add_scattering_to_map(phonon, scattering_types)
+
+        # Otherwise, record only if animation is requested:
+        else:
+            if cf.output_path_animation:
+                flight.add_point_to_path()
+
+        # If diffuse scattering has occurred, reset phonon free path:
+        if scattering_types.is_diffuse or scattering_types.is_internal:
+            flight.save_free_paths()
+            flight.restart()
+            phonon.assign_internal_scattering_time(material)
+            if cf.is_two_dimensional_material:
+                phonon.phi = 0.0
+
+        # If hole scattering has occured, record it:
+        if triangle_scattering_places.is_scattered:
+            places_stats.save_scattering_events(phonon.y, triangle_scattering_places)
+        if scattering_types.is_diffuse_on_hole:
+            flight.save_hole_diff_scattering_angle(phonon.theta)
+        if scattering_types.is_specular_on_hole:
+            flight.save_hole_spec_scattering_angle(phonon.theta)
+
+        else:
+            flight.add_step(cf.timestep)
+
+        # Record presence of the phonon at this timestep and move on:
+        thermal_maps.add_energy_to_maps(phonon, step_number, material)
+        segment_stats.record_time_in_segment(phonon.y)
+        scattering_types.reset()
+        triangle_scattering_places.reset()
+        phonon.move()
+

{freepaths-2.1.2 → freepaths-2.1.3}/freepaths.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: freepaths
-Version: 2.1.2
+Version: 2.1.3
 Summary: Phonon Monte Carlo simulator
 Home-page: https://github.com/anufrievroman/freepaths
 Author: Roman Anufriev

freepaths-2.1.2/freepaths/run_phonon.py

@@ -1,71 +0,0 @@
-"""
-Module that runs one phonon through the structure, from phonon source to a cold side.
-After the run, we record various parameters of this run into flight object.
-"""
-
-from freepaths.config import cf
-from freepaths.scattering import internal_scattering, surface_scattering, reinitialization
-from freepaths.scattering_types import ScatteringTypes, ScatteringPlaces
-
-
-def run_phonon(phonon, flight, scatter_stats, places_stats, segment_stats, thermal_maps, scatter_maps, material):
-    """Run one phonon through the system and record parameters of this run"""
-
-    # Initialize object that will store scattering types:
-    scattering_types = ScatteringTypes()
-    triangle_scattering_places = ScatteringPlaces()
-
-    # Run the phonon step-by-step:
-    for step_number in range(cf.number_of_timesteps):
-        if phonon.is_in_system:
-
-            # Check if different scattering events happened during current time step:
-            if cf.include_internal_scattering:
-                internal_scattering(phonon, flight, scattering_types)
-            surface_scattering(phonon, scattering_types, triangle_scattering_places)
-            reinitialization(phonon, scattering_types)
-
-            # If any scattering has occurred, record it:
-            if scattering_types.is_scattered:
-                flight.add_point_to_path()
-                scatter_stats.save_scattering_events(phonon.y, scattering_types)
-                if cf.output_scattering_map:
-                    scatter_maps.add_scattering_to_map(phonon, scattering_types)
-
-            # Otherwise, record only if animation is requested:
-            else:
-                if cf.output_path_animation:
-                    flight.add_point_to_path()
-
-            # If diffuse scattering has occurred, reset phonon free path:
-            if scattering_types.is_diffuse or scattering_types.is_internal:
-                flight.save_free_paths()
-                flight.restart()
-                phonon.assign_internal_scattering_time(material)
-                if cf.is_two_dimensional_material:
-                    phonon.phi = 0.0
-
-            # If hole scattering has occured, record it:
-            if triangle_scattering_places.is_scattered:
-                places_stats.save_scattering_events(phonon.y, triangle_scattering_places)
-            if scattering_types.is_diffuse_on_hole:
-                flight.save_hole_diff_scattering_angle(phonon.theta)
-            if scattering_types.is_specular_on_hole:
-                flight.save_hole_spec_scattering_angle(phonon.theta)
-
-            else:
-                flight.add_step(cf.timestep)
-
-            # Record presence of the phonon at this timestep and move on:
-            thermal_maps.add_energy_to_maps(phonon, step_number, material)
-            segment_stats.record_time_in_segment(phonon.y)
-            scattering_types.reset()
-            triangle_scattering_places.reset()
-            phonon.move()
-
-        # If the phonon reached cold side, record it and break the loop:
-        else:
-            flight.add_point_to_path()
-            flight.save_free_paths()
-            flight.finish(step_number, cf.timestep)
-            break