ansys-fluent-core 0.30.dev1__py3-none-any.whl → 0.30.dev3__py3-none-any.whl

ansys/fluent/core/generated/solver/settings_232.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
@@ -5822,21 +5824,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.
         """
     child_object_type: beams_child
     return_type: str
@@ -22180,9 +22182,9 @@ class mesh_interfaces(Group):
         Parameters
         ----------
             sb0 : int
-                Enter id/name of zone to convert to phase lag side 1.
+                Id/name of zone to convert to phase lag side 1.
             sb1 : int
-                Enter id/name of zone to convert to phase lag side 2.
+                Id/name of zone to convert to phase lag side 2.
             angle : real
                 'angle' child.
             pl_name : str
@@ -22238,11 +22240,11 @@ class mesh_interfaces(Group):
             one_to_one_pairing : bool
                 'one_to_one_pairing' child.
             new_si_id : List
-                Select unintersected interface zones for pairing.
+                Unintersected interface zones for pairing.
             si_create : bool
                 'si_create' child.
             si_name : str
-                Enter a prefix for mesh interface names.
+                The prefix for mesh interface names.
             apply_mapped : bool
                 Apply Mapped option at solids.
             static_interface : bool
@@ -22277,7 +22279,7 @@ class mesh_interfaces(Group):
         Parameters
         ----------
             zone_name : str
-                Enter zone name.
+                Zone name.
         """
     return_type: str
 class faces_child(Group):
@@ -28334,21 +28336,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):
         """
@@ -28357,7 +28359,7 @@ class run_calculation(Group):
         Parameters
         ----------
             iter_count : int
-                Set incremental number of time steps.
+                Incremental number of time steps.
         """
     def iterating(self):
         """
@@ -30565,7 +30567,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
         ----------
@@ -30587,7 +30589,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
         ----------
@@ -30596,11 +30598,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):
@@ -32534,7 +32536,7 @@ class histogram_1(Group):
         Parameters
         ----------
             sample_file : str
-                Enter the name of a sample file to be loaded.
+                The name of a sample file to be loaded.
         """
     def dpm_sample_contour_plots(self, sample_name: str, interval_size: float | str):
         """
@@ -32626,7 +32628,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
@@ -32647,7 +32649,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
@@ -32668,7 +32670,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
@@ -32689,7 +32691,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
@@ -32710,7 +32712,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
@@ -32731,7 +32733,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
@@ -32752,7 +32754,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
@@ -32773,7 +32775,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
@@ -32794,7 +32796,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
@@ -33001,7 +33003,7 @@ class report(Group):
     histogram: 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: list[float | str], momentum_center: list[float | str], momentum_axis: list[float | str], pressure_coordinate: str, coord_val: float | str, write_to_file: bool, file_name: str, append_data: bool, overwrite: bool):
         """
@@ -33782,7 +33784,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):
         """