ansys-fluent-core 0.30.dev2__py3-none-any.whl → 0.30.dev4__py3-none-any.whl

ansys/fluent/core/generated/solver/settings_231.pyi

@@ -12,6 +12,8 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
+from typing import Any
+
 class single_precision_coordinates(Boolean):
     version: str
     fluent_name: str
@@ -787,7 +789,7 @@ class mesh(Group):
         """
         Perform analysis of mesh quality.
         """
-    def rotate(self, angle: float | str, origin: tuple[float | str, float | str, float | str, axis_components: tuple[float | str, float | str, float | str):
+    def rotate(self, angle: float | str, origin: tuple[float | str, float | str, float | str], axis_components: tuple[float | str, float | str, float | str]):
         """
         Rotate the mesh.
         
@@ -851,7 +853,7 @@ class mesh(Group):
             zones : bool
                 'zones' child.
         """
-    def translate(self, offset: tuple[float | str, float | str, float | str):
+    def translate(self, offset: tuple[float | str, float | str, float | str]):
         """
         Translate the mesh.
         
@@ -3341,21 +3343,21 @@ class beams(NamedObject[beams_child]):
         Parameters
         ----------
             orig_beam_name : str
-                Choose the name for the optical beam to be copied.
+                The name for the optical beam to be copied.
             beam_name : str
-                Set a unique name for each optical beam.
+                A unique name for each optical beam.
             ap_face_zone : str
-                Set the wall face zones to specify the optical aperture surface.
+                The wall face zones to specify the optical aperture surface.
             beam_length : real
-                Set the length of optical beam propagation.
+                The length of optical beam propagation.
             ray_npoints : int
-                Set the number of grid point in each ray of the optical beam.
+                The number of grid point in each ray of the optical beam.
             x_beam_vector : real
-                Set the x-component of the beam propagation vector.
+                The x-component of the beam propagation vector.
             y_beam_vector : real
-                Set the y-component of the beam propagation vector.
+                The y-component of the beam propagation vector.
             z_beam_vector : real
-                Set the z-component of the beam propagation vector.
+                The z-component of the beam propagation vector.
         """
     def list_beam_parameters(self, beam_name: str):
         """
@@ -3364,7 +3366,7 @@ class beams(NamedObject[beams_child]):
         Parameters
         ----------
             beam_name : str
-                Choose the name for the optical beam to be listed.
+                The name for the optical beam to be listed.
         """
     child_object_type: beams_child
     return_type: str
@@ -22905,21 +22907,21 @@ class run_calculation(Group):
         Parameters
         ----------
             total_period_count : int
-                Set number of total periods.
+                Number of total periods.
             time_step_count : int
-                Set inceremtal number of Time steps.
+                Inceremtal number of Time steps.
             total_time_step_count : int
-                Set total number of Time steps.
+                Total number of Time steps.
             total_time : real
-                Set Total Simulation Time.
+                Total Simulation Time.
             incremental_time : real
-                Set Incremental Time.
+                Incremental Time.
             max_iter_per_step : int
-                Set Maximum Number of iterations per time step.
+                Maximum Number of iterations per time step.
             postprocess : bool
                 Enable/Disable Postprocess pollutant solution?.
             post_iter_per_time_step_count : int
-                Set Number of post-processing iterations per time step.
+                Number of post-processing iterations per time step.
         """
     def iterate(self, iter_count: int):
         """
@@ -22928,7 +22930,7 @@ class run_calculation(Group):
         Parameters
         ----------
             iter_count : int
-                Set incremental number of time steps.
+                Incremental number of time steps.
         """
     def calculate(self):
         """
@@ -24736,7 +24738,7 @@ class by_type(Group):
     use_inherent_material_color: use_inherent_material_color
     def reset(self, reset_color: bool):
         """
-        To reset colors and/or materials to the defaults.
+        Reset colors and/or materials to the defaults.
         
         Parameters
         ----------
@@ -24758,7 +24760,7 @@ class by_surface(Group):
     use_inherent_material_color: use_inherent_material_color_1
     def reset(self, reset_color: bool):
         """
-        To reset colors and/or materials to the defaults.
+        Reset colors and/or materials to the defaults.
         
         Parameters
         ----------
@@ -24767,11 +24769,11 @@ class by_surface(Group):
         """
     def list_surfaces_by_color(self):
         """
-        To list the surfaces by its color.
+        List the surfaces by its color.
         """
     def list_surfaces_by_material(self):
         """
-        To list the surfaces by its material.
+        List the surfaces by its material.
         """
     return_type: str
 class far_field_faces(String):
@@ -24920,11 +24922,11 @@ class lights(Group):
     headlight_setting: headlight_setting
     lights_on: lights_on
     lighting_interpolation: lighting_interpolation
-    def set_ambient_color(self, rgb_vector: tuple[float | str, float | str, float | str):
+    def set_ambient_color(self, rgb_vector: tuple[float | str, float | str, float | str]):
         """
         'set_ambient_color' command.
         """
-    def set_light(self, light_number: int, light_on: bool, rgb_vector: tuple[float | str, float | str, float | str, use_view_factor: bool, change_light_direction: bool, direction_vector: tuple[float | str, float | str, float | str):
+    def set_light(self, light_number: int, light_on: bool, rgb_vector: tuple[float | str, float | str, float | str], use_view_factor: bool, change_light_direction: bool, direction_vector: tuple[float | str, float | str, float | str]):
         """
         'set_light' command.
         """
@@ -26671,7 +26673,7 @@ class histogram(Group):
         Parameters
         ----------
             sample_file : str
-                Enter the name of a sample file to be loaded.
+                The name of a sample file to be loaded.
         """
     return_type: str
 class user_defined_functions_1(String):
@@ -26752,7 +26754,7 @@ class fluxes(Group):
             domain_val : str
                 'domain_val' child.
             all_bndry_zones : bool
-                Select all the boundary/interior zones.
+                All the boundary/interior zones.
             zone_list : List
                 'zone_list' child.
             write_to_file : bool
@@ -26773,7 +26775,7 @@ class fluxes(Group):
             domain_val : str
                 'domain_val' child.
             all_bndry_zones : bool
-                Select all the boundary/interior zones.
+                All the boundary/interior zones.
             zone_list : List
                 'zone_list' child.
             write_to_file : bool
@@ -26794,7 +26796,7 @@ class fluxes(Group):
             domain_val : str
                 'domain_val' child.
             all_bndry_zones : bool
-                Select all the boundary/interior zones.
+                All the boundary/interior zones.
             zone_list : List
                 'zone_list' child.
             write_to_file : bool
@@ -26815,7 +26817,7 @@ class fluxes(Group):
             domain_val : str
                 'domain_val' child.
             all_bndry_zones : bool
-                Select all the boundary/interior zones.
+                All the boundary/interior zones.
             zone_list : List
                 'zone_list' child.
             write_to_file : bool
@@ -26836,7 +26838,7 @@ class fluxes(Group):
             domain_val : str
                 'domain_val' child.
             all_bndry_zones : bool
-                Select all the boundary/interior zones.
+                All the boundary/interior zones.
             zone_list : List
                 'zone_list' child.
             write_to_file : bool
@@ -26857,7 +26859,7 @@ class fluxes(Group):
             domain_val : str
                 'domain_val' child.
             all_bndry_zones : bool
-                Select all the boundary/interior zones.
+                All the boundary/interior zones.
             zone_list : List
                 'zone_list' child.
             write_to_file : bool
@@ -26878,7 +26880,7 @@ class fluxes(Group):
             domain_val : str
                 'domain_val' child.
             all_bndry_zones : bool
-                Select all the boundary/interior zones.
+                All the boundary/interior zones.
             zone_list : List
                 'zone_list' child.
             write_to_file : bool
@@ -26899,7 +26901,7 @@ class fluxes(Group):
             domain_val : str
                 'domain_val' child.
             all_bndry_zones : bool
-                Select all the boundary/interior zones.
+                All the boundary/interior zones.
             zone_list : List
                 'zone_list' child.
             write_to_file : bool
@@ -27106,9 +27108,9 @@ class report(Group):
     print_write_histogram: print_write_histogram
     def aero_optical_distortions(self):
         """
-        Optics report menu.
+        Optics report object.
         """
-    def forces(self, options: str, domain_val: str, all_wall_zones: bool, wall_thread_list: list[str], direction_vector: tuple[float | str, float | str, float | str, momentum_center: tuple[float | str, float | str, float | str, momentum_axis: tuple[float | str, float | str, float | str, pressure_coordinate: str, coord_val: float | str, write_to_file: bool, file_name: str, append_data: bool, overwrite: bool):
+    def forces(self, options: str, domain_val: str, all_wall_zones: bool, wall_thread_list: list[str], direction_vector: tuple[float | str, float | str, float | str], momentum_center: tuple[float | str, float | str, float | str], momentum_axis: tuple[float | str, float | str, float | str], pressure_coordinate: str, coord_val: float | str, write_to_file: bool, file_name: str, append_data: bool, overwrite: bool):
         """
         'forces' command.
         """
@@ -27134,7 +27136,7 @@ class report(Group):
         """
         Print path-line-summary report.
         """
-    def projected_surface_area(self, surface_id_val: list[int], min_feature_size: float | str, proj_plane_norm_comp: tuple[float | str, float | str, float | str):
+    def projected_surface_area(self, surface_id_val: list[int], min_feature_size: float | str, proj_plane_norm_comp: tuple[float | str, float | str, float | str]):
         """
         Print total area of the projection of a group of surfaces to a plane.
         
@@ -27754,7 +27756,7 @@ class partition_1(Group):
         Parameters
         ----------
             smoothing_iteration : int
-                Set maximum number of smoothing iterations.
+                Maximum number of smoothing iterations.
         """
     def use_stored_partitions(self):
         """