ansys-fluent-core 0.29.dev3__py3-none-any.whl → 0.30.dev0__py3-none-any.whl

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

@@ -214,22 +214,10 @@ class import_(Group):
     def read(self, file_type: str, file_name: str):
         """
         'read' command.
-        
-        Parameters
-        ----------
-            file_type : str
-                'file_type' child.
-            file_name : str
-                'file_name' child.
         """
     def chemkin_report_each_line(self, report_each_line: bool):
         """
         'chemkin_report_each_line' command.
-        
-        Parameters
-        ----------
-            report_each_line : bool
-                Enable/disable reporting after reading each line.
         """
     def import_fmu(self, file_name: str):
         """
@@ -331,92 +319,26 @@ class file(Group):
     def read(self, file_type: str, file_name: str, pdf_file_name: str, lightweight_setup: bool):
         """
         'read' command.
-        
-        Parameters
-        ----------
-            file_type : str
-                'file_type' child.
-            file_name : str
-                'file_name' child.
-            pdf_file_name : str
-                'pdf_file_name' child.
-            lightweight_setup : bool
-                'lightweight_setup' child.
         """
     def read_case(self, file_type: str, file_name: str, pdf_file_name: str, lightweight_setup: bool):
         """
         'read_case' command.
-        
-        Parameters
-        ----------
-            file_type : str
-                'file_type' child.
-            file_name : str
-                'file_name' child.
-            pdf_file_name : str
-                'pdf_file_name' child.
-            lightweight_setup : bool
-                'lightweight_setup' child.
         """
     def read_case_data(self, file_type: str, file_name: str, pdf_file_name: str, lightweight_setup: bool):
         """
         'read_case_data' command.
-        
-        Parameters
-        ----------
-            file_type : str
-                'file_type' child.
-            file_name : str
-                'file_name' child.
-            pdf_file_name : str
-                'pdf_file_name' child.
-            lightweight_setup : bool
-                'lightweight_setup' child.
         """
     def read_case_setting(self, file_type: str, file_name: str, pdf_file_name: str, lightweight_setup: bool):
         """
         'read_case_setting' command.
-        
-        Parameters
-        ----------
-            file_type : str
-                'file_type' child.
-            file_name : str
-                'file_name' child.
-            pdf_file_name : str
-                'pdf_file_name' child.
-            lightweight_setup : bool
-                'lightweight_setup' child.
         """
     def read_data(self, file_type: str, file_name: str, pdf_file_name: str, lightweight_setup: bool):
         """
         'read_data' command.
-        
-        Parameters
-        ----------
-            file_type : str
-                'file_type' child.
-            file_name : str
-                'file_name' child.
-            pdf_file_name : str
-                'pdf_file_name' child.
-            lightweight_setup : bool
-                'lightweight_setup' child.
         """
     def read_mesh(self, file_type: str, file_name: str, pdf_file_name: str, lightweight_setup: bool):
         """
         'read_mesh' command.
-        
-        Parameters
-        ----------
-            file_type : str
-                'file_type' child.
-            file_name : str
-                'file_name' child.
-            pdf_file_name : str
-                'pdf_file_name' child.
-            lightweight_setup : bool
-                'lightweight_setup' child.
         """
     def read_journal(self, file_name_list: list[str]):
         """
@@ -443,22 +365,10 @@ class file(Group):
     def replace_mesh(self, file_name: str):
         """
         'replace_mesh' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
         """
     def write(self, file_type: str, file_name: str):
         """
         'write' command.
-        
-        Parameters
-        ----------
-            file_type : str
-                'file_type' child.
-            file_name : str
-                'file_name' child.
         """
     return_type: str
 class refinement_criteria(String):
@@ -839,15 +749,6 @@ class polyhedra(Group):
     def convert_skewed_cells(self, cell_thread_list: list[str], max_cell_skewness: float | str, convert_skewed_cells: bool):
         """
         'convert_skewed_cells' command.
-        
-        Parameters
-        ----------
-            cell_thread_list : List
-                Set zones where cells should be converted.
-            max_cell_skewness : real
-                Set target maximum cell skewness.
-            convert_skewed_cells : bool
-                'convert_skewed_cells' child.
         """
     return_type: str
 class mesh(Group):
@@ -881,11 +782,6 @@ class mesh(Group):
     def mesh_info(self, print_level: int):
         """
         'mesh_info' command.
-        
-        Parameters
-        ----------
-            print_level : int
-                Print zone information size.
         """
     def quality(self):
         """
@@ -907,15 +803,6 @@ class mesh(Group):
     def scale(self, x_scale: float | str, y_scale: float | str, z_scale: float | str):
         """
         'scale' command.
-        
-        Parameters
-        ----------
-            x_scale : real
-                'x_scale' child.
-            y_scale : real
-                'y_scale' child.
-            z_scale : real
-                'z_scale' child.
         """
     def size_info(self):
         """
@@ -982,13 +869,6 @@ class web_server(Group):
     def start(self, address: str, port: int):
         """
         'start' command.
-        
-        Parameters
-        ----------
-            address : str
-                'address' child.
-            port : int
-                'port' child.
         """
     def stop(self):
         """
@@ -3503,19 +3383,6 @@ class statistics(Group):
     def statistics_controls(self, method: int, samp_time_period: float | str, samp_time_steps: int, avg_time_period: float | str, avg_time_steps: int):
         """
         'statistics_controls' command.
-        
-        Parameters
-        ----------
-            method : int
-                'method' child.
-            samp_time_period : real
-                'samp_time_period' child.
-            samp_time_steps : int
-                'samp_time_steps' child.
-            avg_time_period : real
-                'avg_time_period' child.
-            avg_time_steps : int
-                'avg_time_steps' child.
         """
     return_type: str
 class sampling_iterations(Integer):
@@ -8573,22 +8440,10 @@ class cell_zone_conditions(Group):
     def change_type(self, zone_list: list[str], new_type: str):
         """
         'change_type' command.
-        
-        Parameters
-        ----------
-            zone_list : List
-                'zone_list' child.
-            new_type : str
-                'new_type' child.
         """
     def activate_cell_zone(self, cell_zone_list: list[str]):
         """
         'activate_cell_zone' command.
-        
-        Parameters
-        ----------
-            cell_zone_list : List
-                'cell_zone_list' child.
         """
     def mrf_to_sliding_mesh(self, zone_id: int):
         """
@@ -17837,13 +17692,6 @@ class boundary_conditions(Group):
     def change_type(self, zone_list: list[str], new_type: str):
         """
         'change_type' command.
-        
-        Parameters
-        ----------
-            zone_list : List
-                'zone_list' child.
-            new_type : str
-                'new_type' child.
         """
     def slit_face_zone(self, zone_id: int):
         """
@@ -17955,15 +17803,6 @@ class reference_values(Group):
     def compute(self, from_zone_type: str, from_zone_name: str, phase: str):
         """
         'compute' command.
-        
-        Parameters
-        ----------
-            from_zone_type : str
-                'from_zone_type' child.
-            from_zone_name : str
-                'from_zone_name' child.
-            phase : str
-                'phase' child.
         """
     def list_val(self):
         """
@@ -21070,22 +20909,10 @@ class report_definitions(Group):
     def compute(self, report_defs: list[str]):
         """
         'compute' command.
-        
-        Parameters
-        ----------
-            report_defs : List
-                'report_defs' child.
         """
     def copy(self, copy_from: str, copy_to: str):
         """
         'copy' command.
-        
-        Parameters
-        ----------
-            copy_from : str
-                'copy_from' child.
-            copy_to : str
-                'copy_to' child.
         """
     def list(self):
         """
@@ -22076,15 +21903,6 @@ class fmg_initialization(Group):
     def customize_fmg_initialization(self, multi_level_grid: int, residual_reduction_level: list[float | str], cycle_count: list[float | str]):
         """
         'customize_fmg_initialization' command.
-        
-        Parameters
-        ----------
-            multi_level_grid : int
-                'multi_level_grid' child.
-            residual_reduction_level : List
-                'residual_reduction_level' child.
-            cycle_count : List
-                'cycle_count' child.
         """
     return_type: str
 class initialization_type(String, AllowedValuesMixin):
@@ -22119,11 +21937,6 @@ class initialization(Group):
     def initialize(self, init_type: str):
         """
         'initialize' command.
-        
-        Parameters
-        ----------
-            init_type : str
-                'init_type' child.
         """
     def dpm_reset(self):
         """
@@ -22140,13 +21953,6 @@ class initialization(Group):
     def init_acoustics_options(self, set_ramping_length: bool, time_step_count: int):
         """
         'init_acoustics_options' command.
-        
-        Parameters
-        ----------
-            set_ramping_length : bool
-                Enable/Disable ramping length and initialize acoustics.
-            time_step_count : int
-                Set number of timesteps for ramping of sources.
         """
     def list_defaults(self):
         """
@@ -22177,58 +21983,26 @@ class execute_commands(Group):
     def enable(self, command_name: str):
         """
         Enable an execute-command.
-        
-        Parameters
-        ----------
-            command_name : str
-                'command_name' child.
         """
     def disable(self, command_name: str):
         """
         Disable an execute-command.
-        
-        Parameters
-        ----------
-            command_name : str
-                'command_name' child.
         """
     def copy(self, command_name: str):
         """
         Copy an execute-command.
-        
-        Parameters
-        ----------
-            command_name : str
-                'command_name' child.
         """
     def delete(self, command_name: str):
         """
         Delete an execute-command.
-        
-        Parameters
-        ----------
-            command_name : str
-                'command_name' child.
         """
     def export(self, command_name: list[str], tsv_file_name: str):
         """
         Export execute-commands to a TSV file.
-        
-        Parameters
-        ----------
-            command_name : List
-                'command_name' child.
-            tsv_file_name : str
-                'tsv_file_name' child.
         """
     def import_(self, tsv_file_name: str):
         """
         Import execute-commands from a TSV file.
-        
-        Parameters
-        ----------
-            tsv_file_name : str
-                'tsv_file_name' child.
         """
     return_type: str
 class animate_on(String, AllowedValuesMixin):
@@ -22465,13 +22239,6 @@ class calculation_activity(Group):
     def export_modifications(self, command_list: list[str], filename: str):
         """
         Export all case modifications to a tsv file.
-        
-        Parameters
-        ----------
-            command_list : List
-                'command_list' child.
-            filename : str
-                'filename' child.
         """
     def continue_strategy_execution(self):
         """
@@ -22655,11 +22422,6 @@ class data_sampling(Group):
     def setup_unsteady_statistics(self, udf_cf_names: list[str]):
         """
         'setup_unsteady_statistics' command.
-        
-        Parameters
-        ----------
-            udf_cf_names : List
-                'udf_cf_names' child.
         """
     return_type: str
 class specified_time_step(Boolean):
@@ -25161,30 +24923,10 @@ class lights(Group):
     def set_ambient_color(self, rgb_vector: tuple[float | str, float | str, float | str):
         """
         'set_ambient_color' command.
-        
-        Parameters
-        ----------
-            rgb_vector : Tuple
-                'rgb_vector' child.
         """
     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.
-        
-        Parameters
-        ----------
-            light_number : int
-                'light_number' child.
-            light_on : bool
-                'light_on' child.
-            rgb_vector : Tuple
-                'rgb_vector' child.
-            use_view_factor : bool
-                'use_view_factor' child.
-            change_light_direction : bool
-                'change_light_direction' child.
-            direction_vector : Tuple
-                'direction_vector' child.
         """
     return_type: str
 class color_mode(String, AllowedValuesMixin):
@@ -25290,11 +25032,6 @@ class picture(Group):
     def save_picture(self, file_name: str):
         """
         'save_picture' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
         """
     def list_color_mode(self):
         """
@@ -25504,11 +25241,6 @@ class display_states(NamedObject[display_states_child]):
     def use_active(self, state_name: str):
         """
         'use_active' command.
-        
-        Parameters
-        ----------
-            state_name : str
-                'state_name' child.
         """
     def restore_state(self, state_name: str):
         """
@@ -26647,11 +26379,6 @@ class simulation_reports(Group):
     def write_simulation_report_template_file(self, file_name_path: str):
         """
         'write_simulation_report_template_file' command.
-        
-        Parameters
-        ----------
-            file_name_path : str
-                'file_name_path' child.
         """
     def read_simulation_report_template_file(self, file_name_path: str):
         """
@@ -26755,40 +26482,10 @@ class plot_write_sample(Group):
     def plot_sample(self, loaded_samples: str, variable_to_sampled: str, weighting_var: str, correlation_var: str, read_fn: str, overwrite: bool):
         """
         'plot_sample' command.
-        
-        Parameters
-        ----------
-            loaded_samples : str
-                'loaded_samples' child.
-            variable_to_sampled : str
-                'variable_to_sampled' child.
-            weighting_var : str
-                'weighting_var' child.
-            correlation_var : str
-                'correlation_var' child.
-            read_fn : str
-                'read_fn' child.
-            overwrite : bool
-                'overwrite' child.
         """
     def write_sample(self, loaded_samples: str, variable_to_sampled: str, weighting_var: str, correlation_var: str, read_fn: str, overwrite: bool):
         """
         'write_sample' command.
-        
-        Parameters
-        ----------
-            loaded_samples : str
-                'loaded_samples' child.
-            variable_to_sampled : str
-                'variable_to_sampled' child.
-            weighting_var : str
-                'weighting_var' child.
-            correlation_var : str
-                'correlation_var' child.
-            read_fn : str
-                'read_fn' child.
-            overwrite : bool
-                'overwrite' child.
         """
     return_type: str
 class use_weighting(Boolean):
@@ -26845,13 +26542,6 @@ class setup_reduction(Group):
     def set_maximum(self, sample_var: str, max_val: float | str):
         """
         'set_maximum' command.
-        
-        Parameters
-        ----------
-            sample_var : str
-                'sample_var' child.
-            max_val : real
-                'max_val' child.
         """
     def use_logarithmic(self, sample_var: str, enable_log: bool):
         """
@@ -26969,11 +26659,6 @@ class histogram(Group):
     def delete_sample(self, sample: str):
         """
         'delete_sample' command.
-        
-        Parameters
-        ----------
-            sample : str
-                'sample' child.
         """
     def list_samples(self):
         """
@@ -27010,23 +26695,6 @@ class sample_trajectories(Group):
     def sample(self, injections: list[str], boundaries: list[str], lines: list[str], planes: list[str], op_udf: str, append_sample: bool, accumulate_rates: bool):
         """
         'sample' command.
-        
-        Parameters
-        ----------
-            injections : List
-                'injections' child.
-            boundaries : List
-                'boundaries' child.
-            lines : List
-                'lines' child.
-            planes : List
-                'planes' child.
-            op_udf : str
-                'op_udf' child.
-            append_sample : bool
-                'append_sample' child.
-            accumulate_rates : bool
-                'accumulate_rates' child.
         """
     return_type: str
 class discrete_phase_1(Group):
@@ -27252,29 +26920,14 @@ class flow(Group):
     def species_mass_flow(self, domain_val: str):
         """
         'species_mass_flow' command.
-        
-        Parameters
-        ----------
-            domain_val : str
-                'domain_val' child.
         """
     def element_mass_flow(self, domain_val: str):
         """
         'element_mass_flow' command.
-        
-        Parameters
-        ----------
-            domain_val : str
-                'domain_val' child.
         """
     def uds_flow(self, domain_val: str):
         """
         'uds_flow' command.
-        
-        Parameters
-        ----------
-            domain_val : str
-                'domain_val' child.
         """
     return_type: str
 class modified_setting_options(Group):
@@ -27330,29 +26983,6 @@ class population_balance(Group):
     def number_density(self, report_type: str, disc_output_type: str, qmom_output_type: str, smm_output_type: str, surface_list: list[str], volume_list: list[str], num_dens_func: str, dia_upper_limit: float | str, file_name: str, overwrite: bool):
         """
         'number_density' command.
-        
-        Parameters
-        ----------
-            report_type : str
-                'report_type' child.
-            disc_output_type : str
-                'disc_output_type' child.
-            qmom_output_type : str
-                'qmom_output_type' child.
-            smm_output_type : str
-                'smm_output_type' child.
-            surface_list : List
-                'surface_list' child.
-            volume_list : List
-                'volume_list' child.
-            num_dens_func : str
-                'num_dens_func' child.
-            dia_upper_limit : real
-                'dia_upper_limit' child.
-            file_name : str
-                'file_name' child.
-            overwrite : bool
-                'overwrite' child.
         """
     return_type: str
 class heat_exchange(Group):
@@ -27363,117 +26993,22 @@ class heat_exchange(Group):
     def computed_heat_rejection(self, heat_exchanger: str, fluid_zone: str, boundary_zone: str, report_type: str, write_to_file: bool, file_name: str, append_file: bool, overwrite: bool):
         """
         'computed_heat_rejection' command.
-        
-        Parameters
-        ----------
-            heat_exchanger : str
-                'heat_exchanger' child.
-            fluid_zone : str
-                'fluid_zone' child.
-            boundary_zone : str
-                'boundary_zone' child.
-            report_type : str
-                'report_type' child.
-            write_to_file : bool
-                'write_to_file' child.
-            file_name : str
-                'file_name' child.
-            append_file : bool
-                'append_file' child.
-            overwrite : bool
-                'overwrite' child.
         """
     def inlet_temperature(self, heat_exchanger: str, fluid_zone: str, boundary_zone: str, report_type: str, write_to_file: bool, file_name: str, append_file: bool, overwrite: bool):
         """
         'inlet_temperature' command.
-        
-        Parameters
-        ----------
-            heat_exchanger : str
-                'heat_exchanger' child.
-            fluid_zone : str
-                'fluid_zone' child.
-            boundary_zone : str
-                'boundary_zone' child.
-            report_type : str
-                'report_type' child.
-            write_to_file : bool
-                'write_to_file' child.
-            file_name : str
-                'file_name' child.
-            append_file : bool
-                'append_file' child.
-            overwrite : bool
-                'overwrite' child.
         """
     def outlet_temperature(self, heat_exchanger: str, fluid_zone: str, boundary_zone: str, report_type: str, write_to_file: bool, file_name: str, append_file: bool, overwrite: bool):
         """
         'outlet_temperature' command.
-        
-        Parameters
-        ----------
-            heat_exchanger : str
-                'heat_exchanger' child.
-            fluid_zone : str
-                'fluid_zone' child.
-            boundary_zone : str
-                'boundary_zone' child.
-            report_type : str
-                'report_type' child.
-            write_to_file : bool
-                'write_to_file' child.
-            file_name : str
-                'file_name' child.
-            append_file : bool
-                'append_file' child.
-            overwrite : bool
-                'overwrite' child.
         """
     def mass_flow_rate(self, heat_exchanger: str, fluid_zone: str, boundary_zone: str, report_type: str, write_to_file: bool, file_name: str, append_file: bool, overwrite: bool):
         """
         'mass_flow_rate' command.
-        
-        Parameters
-        ----------
-            heat_exchanger : str
-                'heat_exchanger' child.
-            fluid_zone : str
-                'fluid_zone' child.
-            boundary_zone : str
-                'boundary_zone' child.
-            report_type : str
-                'report_type' child.
-            write_to_file : bool
-                'write_to_file' child.
-            file_name : str
-                'file_name' child.
-            append_file : bool
-                'append_file' child.
-            overwrite : bool
-                'overwrite' child.
         """
     def specific_heat(self, heat_exchanger: str, fluid_zone: str, boundary_zone: str, report_type: str, write_to_file: bool, file_name: str, append_file: bool, overwrite: bool):
         """
         'specific_heat' command.
-        
-        Parameters
-        ----------
-            heat_exchanger : str
-                'heat_exchanger' child.
-            fluid_zone : str
-                'fluid_zone' child.
-            boundary_zone : str
-                'boundary_zone' child.
-            report_type : str
-                'report_type' child.
-            write_to_file : bool
-                'write_to_file' child.
-            file_name : str
-                'file_name' child.
-            append_file : bool
-                'append_file' child.
-            overwrite : bool
-                'overwrite' child.
         """
     return_type: str
 class system(Group):
@@ -27576,35 +27111,6 @@ class report(Group):
     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.
-        
-        Parameters
-        ----------
-            options : str
-                'options' child.
-            domain_val : str
-                'domain_val' child.
-            all_wall_zones : bool
-                Select all wall zones available.
-            wall_thread_list : List
-                'wall_thread_list' child.
-            direction_vector : Tuple
-                'direction_vector' child.
-            momentum_center : Tuple
-                'momentum_center' child.
-            momentum_axis : Tuple
-                'momentum_axis' child.
-            pressure_coordinate : str
-                'pressure_coordinate' child.
-            coord_val : real
-                'coord_val' child.
-            write_to_file : bool
-                'write_to_file' child.
-            file_name : str
-                'file_name' child.
-            append_data : bool
-                'append_data' child.
-            overwrite : bool
-                'overwrite' child.
         """
     def mphase_summary(self, verbosity_option: str):
         """
@@ -27657,70 +27163,10 @@ class report(Group):
     def surface_integrals(self, report_type: str, surface_id: list[str], add_custome_vector: bool, cust_vec_name: str, domain_cx: str, cell_cx: str, domain_cy: str, cell_cy: str, domain_cz: str, cell_cz: str, cust_vec_func: str, domain_report: str, cell_report: str, current_domain: str, write_to_file: bool, file_name: str, append_data: bool, overwrite: bool):
         """
         'surface_integrals' command.
-        
-        Parameters
-        ----------
-            report_type : str
-                'report_type' child.
-            surface_id : List
-                'surface_id' child.
-            add_custome_vector : bool
-                'add_custome_vector' child.
-            cust_vec_name : str
-                'cust_vec_name' child.
-            domain_cx : str
-                'domain_cx' child.
-            cell_cx : str
-                'cell_cx' child.
-            domain_cy : str
-                'domain_cy' child.
-            cell_cy : str
-                'cell_cy' child.
-            domain_cz : str
-                'domain_cz' child.
-            cell_cz : str
-                'cell_cz' child.
-            cust_vec_func : str
-                'cust_vec_func' child.
-            domain_report : str
-                'domain_report' child.
-            cell_report : str
-                'cell_report' child.
-            current_domain : str
-                'current_domain' child.
-            write_to_file : bool
-                'write_to_file' child.
-            file_name : str
-                'file_name' child.
-            append_data : bool
-                'append_data' child.
-            overwrite : bool
-                'overwrite' child.
         """
     def volume_integrals(self, report_type: str, thread_id_list: list[str], domain: str, cell_function: str, current_domain: str, write_to_file: bool, file_name: str, append_data: bool, overwrite: bool):
         """
         'volume_integrals' command.
-        
-        Parameters
-        ----------
-            report_type : str
-                'report_type' child.
-            thread_id_list : List
-                'thread_id_list' child.
-            domain : str
-                'domain' child.
-            cell_function : str
-                'cell_function' child.
-            current_domain : str
-                'current_domain' child.
-            write_to_file : bool
-                'write_to_file' child.
-            file_name : str
-                'file_name' child.
-            append_data : bool
-                'append_data' child.
-            overwrite : bool
-                'overwrite' child.
         """
     return_type: str
 class results(Group):
@@ -28549,13 +27995,6 @@ class network_1(Group):
     def kill_node(self, compute_node: int, invalidate_case: bool):
         """
         'kill_node' command.
-        
-        Parameters
-        ----------
-            compute_node : int
-                'compute_node' child.
-            invalidate_case : bool
-                'invalidate_case' child.
         """
     def spawn_node(self, hostname: str, username: str):
         """