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

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

@@ -617,22 +617,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):
         """
@@ -805,68 +793,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_name: str, pdf_file_name: str):
         """
         'read_case' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
-            pdf_file_name : str
-                'pdf_file_name' child.
         """
     def read_case_data(self, file_name: str, pdf_file_name: str):
         """
         'read_case_data' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
-            pdf_file_name : str
-                'pdf_file_name' child.
         """
     def read_case_setting(self, file_name: str, pdf_file_name: str):
         """
         'read_case_setting' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
-            pdf_file_name : str
-                'pdf_file_name' child.
         """
     def read_data(self, file_name: str):
         """
         'read_data' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
         """
     def read_mesh(self, file_name: str):
         """
         'read_mesh' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
         """
     def read_surface_mesh(self, filename: str, unit: str):
         """
@@ -904,49 +850,22 @@ 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.
         """
     def write_case(self, file_name: str):
         """
         'write_case' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
         """
     def write_data(self, file_name: str):
         """
         'write_data' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
         """
     def write_case_data(self, file_name: str):
         """
         'write_case_data' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
         """
     def read_settings(self, file_name: str):
         """
@@ -1919,15 +1838,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 wall_distance_method(String, AllowedValuesMixin):
@@ -1995,15 +1905,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):
         """
@@ -7872,13 +7773,6 @@ class contact_resis(ListObject[contact_resis_child]):
     def add_zone(self, zone_name: str, value: float | str):
         """
         'add_zone' command.
-        
-        Parameters
-        ----------
-            zone_name : str
-                'zone_name' child.
-            value : real
-                'value' child.
         """
     def list_zone(self):
         """
@@ -7887,11 +7781,6 @@ class contact_resis(ListObject[contact_resis_child]):
     def delete_zone(self, face_name: str):
         """
         'delete_zone' command.
-        
-        Parameters
-        ----------
-            face_name : str
-                Pick ~a zone you want to delete.
         """
     child_object_type: contact_resis_child
     return_type: str
@@ -7970,13 +7859,6 @@ class zone_assignment_1(Group):
     def virtual_connection(self, enabled: bool, file_name: str):
         """
         'virtual_connection' command.
-        
-        Parameters
-        ----------
-            enabled : bool
-                'enabled' child.
-            file_name : str
-                'file_name' child.
         """
     def print_battery_connection(self):
         """
@@ -7991,13 +7873,6 @@ class contact_resistance(Group):
     def add_contact_resistance(self, contact_face: str, resistance_value: float | str):
         """
         'add_contact_resistance' command.
-        
-        Parameters
-        ----------
-            contact_face : str
-                Set contact face.
-            resistance_value : real
-                Set resistance value.
         """
     def list_contact_face(self):
         """
@@ -8006,11 +7881,6 @@ class contact_resistance(Group):
     def delete_contact_face(self, face_name: str):
         """
         'delete_contact_face' command.
-        
-        Parameters
-        ----------
-            face_name : str
-                Pick contact face you want to delete.
         """
     return_type: str
 class initial_dod(Real):
@@ -9707,21 +9577,6 @@ class rom_tool_kit(Group):
     def add_rom_parameter(self, parameter_type: int, entity_list: list[str], individual_or_group: bool, individual_value: bool, group_value: float | str, value_list: list[float | str]):
         """
         'add_rom_parameter' command.
-        
-        Parameters
-        ----------
-            parameter_type : int
-                'parameter_type' child.
-            entity_list : List
-                'entity_list' child.
-            individual_or_group : bool
-                'individual_or_group' child.
-            individual_value : bool
-                'individual_value' child.
-            group_value : real
-                'group_value' child.
-            value_list : List
-                'value_list' child.
         """
     def rom_data_creator(self):
         """
@@ -10231,13 +10086,6 @@ class tortuosity_interface(ListObject[tortuosity_interface_child]):
     def add_zone(self, zone_name: str, value: float | str):
         """
         'add_zone' command.
-        
-        Parameters
-        ----------
-            zone_name : str
-                'zone_name' child.
-            value : real
-                'value' child.
         """
     def list_zone(self):
         """
@@ -10246,11 +10094,6 @@ class tortuosity_interface(ListObject[tortuosity_interface_child]):
     def delete_zone(self, face_name: str):
         """
         'delete_zone' command.
-        
-        Parameters
-        ----------
-            face_name : str
-                Pick ~a zone you want to delete.
         """
     child_object_type: tortuosity_interface_child
     return_type: str
@@ -10279,13 +10122,6 @@ class pore_size_interface(ListObject[pore_size_interface_child]):
     def add_zone(self, zone_name: str, value: float | str):
         """
         'add_zone' command.
-        
-        Parameters
-        ----------
-            zone_name : str
-                'zone_name' child.
-            value : real
-                'value' child.
         """
     def list_zone(self):
         """
@@ -10294,11 +10130,6 @@ class pore_size_interface(ListObject[pore_size_interface_child]):
     def delete_zone(self, face_name: str):
         """
         'delete_zone' command.
-        
-        Parameters
-        ----------
-            face_name : str
-                Pick ~a zone you want to delete.
         """
     child_object_type: pore_size_interface_child
     return_type: str
@@ -10337,13 +10168,6 @@ class conductive_regions(ListObject[conductive_regions_child]):
     def add_zone(self, zone_name: str, value: float | str):
         """
         'add_zone' command.
-        
-        Parameters
-        ----------
-            zone_name : str
-                'zone_name' child.
-            value : real
-                'value' child.
         """
     def list_zone(self):
         """
@@ -10352,11 +10176,6 @@ class conductive_regions(ListObject[conductive_regions_child]):
     def delete_zone(self, face_name: str):
         """
         'delete_zone' command.
-        
-        Parameters
-        ----------
-            face_name : str
-                Pick ~a zone you want to delete.
         """
     child_object_type: conductive_regions_child
     return_type: str
@@ -10385,13 +10204,6 @@ class contact_resistance_regions(ListObject[contact_resistance_regions_child]):
     def add_zone(self, zone_name: str, value: float | str):
         """
         'add_zone' command.
-        
-        Parameters
-        ----------
-            zone_name : str
-                'zone_name' child.
-            value : real
-                'value' child.
         """
     def list_zone(self):
         """
@@ -10400,11 +10212,6 @@ class contact_resistance_regions(ListObject[contact_resistance_regions_child]):
     def delete_zone(self, face_name: str):
         """
         'delete_zone' command.
-        
-        Parameters
-        ----------
-            face_name : str
-                Pick ~a zone you want to delete.
         """
     child_object_type: contact_resistance_regions_child
     return_type: str
@@ -16029,26 +15836,10 @@ class cell_zone_conditions(Group):
     def copy(self, from_: str, to: list[str], verbosity: bool):
         """
         'copy' command.
-        
-        Parameters
-        ----------
-            from_ : str
-                'from' child.
-            to : List
-                'to' child.
-            verbosity : bool
-                'verbosity' child.
         """
     def set_zone_type(self, zone_list: list[str], new_type: str):
         """
         'set_zone_type' command.
-        
-        Parameters
-        ----------
-            zone_list : List
-                Enter zone name list.
-            new_type : str
-                'new_type' child.
         """
     def activate_cell_zone(self, cell_zone_list: list[str]):
         """
@@ -27531,11 +27322,6 @@ class perforated_wall(Group):
     def read_input_file(self, file_name: str):
         """
         'read_input_file' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
         """
     return_type: str
 class degassing_verbosity(Integer, AllowedValuesMixin):
@@ -27679,26 +27465,10 @@ class boundary_conditions(Group):
     def copy(self, from_: str, to: list[str], verbosity: bool):
         """
         'copy' command.
-        
-        Parameters
-        ----------
-            from_ : str
-                'from' child.
-            to : List
-                'to' child.
-            verbosity : bool
-                'verbosity' child.
         """
     def set_zone_type(self, zone_list: list[str], new_type: str):
         """
         'set_zone_type' command.
-        
-        Parameters
-        ----------
-            zone_list : List
-                Enter zone name list.
-            new_type : str
-                'new_type' child.
         """
     def slit_face_zone(self, zone_name: str):
         """
@@ -28418,15 +28188,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_values(self):
         """
@@ -28742,11 +28503,6 @@ class named_expressions(NamedObject[named_expressions_child]):
     def compute(self, names: list[str]):
         """
         'compute' command.
-        
-        Parameters
-        ----------
-            names : List
-                'names' child.
         """
     child_object_type: named_expressions_child
     return_type: str
@@ -28891,11 +28647,6 @@ class faces(NamedObject[faces_child]):
     def list_face(self, face_name: str):
         """
         'list_face' command.
-        
-        Parameters
-        ----------
-            face_name : str
-                'face_name' child.
         """
     child_object_type: faces_child
     return_type: str
@@ -33412,22 +33163,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.
         """
     return_type: str
 class monitor_1(Boolean):
@@ -35136,58 +34875,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):
@@ -35538,13 +35245,6 @@ class case_modification(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):
         """
@@ -37584,63 +37284,22 @@ class surfaces_5(Group):
     def create_multiple_zone_surfaces(self, zone_names: list[str]):
         """
         'create_multiple_zone_surfaces' command.
-        
-        Parameters
-        ----------
-            zone_names : List
-                Enter zone name list.
         """
     def create_multiple_iso_surfaces(self, field: str, name: str, surfaces: list[str], zones: list[str], iso_value: float | str, no_of_surfaces: int, spacing: float | str):
         """
         'create_multiple_iso_surfaces' command.
-        
-        Parameters
-        ----------
-            field : str
-                Specify Field.
-            name : str
-                'name' child.
-            surfaces : List
-                Select surface.
-            zones : List
-                Enter cell zone name list.
-            iso_value : real
-                'iso_value' child.
-            no_of_surfaces : int
-                'no_of_surfaces' child.
-            spacing : real
-                'spacing' child.
         """
     def create_group_surfaces(self, surfaces: list[str], name: str):
         """
         'create_group_surfaces' command.
-        
-        Parameters
-        ----------
-            surfaces : List
-                Select list of surfaces.
-            name : str
-                'name' child.
         """
     def ungroup_surfaces(self, surface: str):
         """
         'ungroup_surfaces' command.
-        
-        Parameters
-        ----------
-            surface : str
-                'surface' child.
         """
     def set_rendering_priority(self, surface: str, priority: str):
         """
         'set_rendering_priority' command.
-        
-        Parameters
-        ----------
-            surface : str
-                Select surface.
-            priority : str
-                Select surface.
         """
     def reset_zone_surfaces(self):
         """
@@ -40575,11 +40234,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):
         """
@@ -40819,11 +40473,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):
         """
@@ -41574,15 +41223,6 @@ class pulse(Group):
     def write(self, object_name: str, write_format: str, file_name: str):
         """
         'write' command.
-        
-        Parameters
-        ----------
-            object_name : str
-                'object_name' child.
-            write_format : str
-                'write_format' child.
-            file_name : str
-                'file_name' child.
         """
     return_type: str
 class graphics(Group):
@@ -42442,11 +42082,6 @@ class scene_animation(Group):
     def read_animation(self, file_name: str):
         """
         'read_animation' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
         """
     def write_animation(self, format_name: str, file_name: str):
         """
@@ -42725,36 +42360,10 @@ class plot_write_sample(Group):
     def plot_sample(self, sample: str, variable_to_sample: str, weighting_variable: str, correlation_variable: str, file_name: str):
         """
         'plot_sample' command.
-        
-        Parameters
-        ----------
-            sample : str
-                'sample' child.
-            variable_to_sample : str
-                'variable_to_sample' child.
-            weighting_variable : str
-                'weighting_variable' child.
-            correlation_variable : str
-                'correlation_variable' child.
-            file_name : str
-                'file_name' child.
         """
     def write_sample(self, sample: str, variable_to_sample: str, weighting_variable: str, correlation_variable: str, file_name: str):
         """
         'write_sample' command.
-        
-        Parameters
-        ----------
-            sample : str
-                'sample' child.
-            variable_to_sample : str
-                'variable_to_sample' child.
-            weighting_variable : str
-                'weighting_variable' child.
-            correlation_variable : str
-                'correlation_variable' child.
-            file_name : str
-                'file_name' child.
         """
     return_type: str
 class use_weighting(Boolean):
@@ -42811,13 +42420,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):
         """
@@ -42909,11 +42511,6 @@ class histogram_1(Group):
     def delete_sample(self, sample: str):
         """
         'delete_sample' command.
-        
-        Parameters
-        ----------
-            sample : str
-                'sample' child.
         """
     def list_samples(self):
         """
@@ -42961,44 +42558,10 @@ class sample_trajectories(Group):
     def compute(self, injections: list[str], boundaries: list[str], lines: list[str], planes: list[str], op_udf: str, append_sample: bool, accumulate_rates: bool):
         """
         'compute' command.
-        
-        Parameters
-        ----------
-            injections : List
-                'injections' child.
-            boundaries : List
-                'boundaries' child.
-            lines : List
-                Select surface.
-            planes : List
-                Select surface.
-            op_udf : str
-                'op_udf' child.
-            append_sample : bool
-                'append_sample' child.
-            accumulate_rates : bool
-                'accumulate_rates' child.
         """
     def start_file_write(self, injections: list[str], boundaries: list[str], lines: list[str], planes: list[str], op_udf: str, append_sample: bool, accumulate_rates: bool):
         """
         'start_file_write' command.
-        
-        Parameters
-        ----------
-            injections : List
-                'injections' child.
-            boundaries : List
-                'boundaries' child.
-            lines : List
-                Select surface.
-            planes : List
-                Select surface.
-            op_udf : str
-                'op_udf' child.
-            append_sample : bool
-                'append_sample' child.
-            accumulate_rates : bool
-                'accumulate_rates' child.
         """
     def stop_file_write(self):
         """
@@ -43255,29 +42818,14 @@ class flow(Group):
     def species_mass_flow(self, domain: str):
         """
         'species_mass_flow' command.
-        
-        Parameters
-        ----------
-            domain : str
-                'domain' child.
         """
     def element_mass_flow(self, domain: str):
         """
         'element_mass_flow' command.
-        
-        Parameters
-        ----------
-            domain : str
-                'domain' child.
         """
     def uds_flow(self, domain: str):
         """
         'uds_flow' command.
-        
-        Parameters
-        ----------
-            domain : str
-                'domain' child.
         """
     return_type: str
 class modified_setting_options(Group):
@@ -43329,27 +42877,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):
         """
         '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
-                Select surface.
-            volume_list : List
-                Enter cell zone name list.
-            num_dens_func : str
-                'num_dens_func' child.
-            dia_upper_limit : real
-                'dia_upper_limit' child.
-            file_name : str
-                'file_name' child.
         """
     return_type: str
 class heat_exchanger(Group):
@@ -44170,33 +43697,6 @@ class report_1(Group):
     def forces(self, option: str, domain: str, all_wall_zones: bool, wall_zones: list[str], direction_vector: list[float | str], momentum_center: list[float | str], momentum_axis: list[float | str], pressure_coordinate: str, coordinate_value: float | str, write_to_file: bool, file_name: str, append_data: bool):
         """
         'forces' command.
-        
-        Parameters
-        ----------
-            option : str
-                'option' child.
-            domain : str
-                'domain' child.
-            all_wall_zones : bool
-                Select all wall zones available.
-            wall_zones : List
-                Enter wall zone name list.
-            direction_vector : List
-                'direction_vector' child.
-            momentum_center : List
-                'momentum_center' child.
-            momentum_axis : List
-                'momentum_axis' child.
-            pressure_coordinate : str
-                'pressure_coordinate' child.
-            coordinate_value : real
-                'coordinate_value' child.
-            write_to_file : bool
-                'write_to_file' child.
-            file_name : str
-                'file_name' child.
-            append_data : bool
-                'append_data' child.
         """
     def multiphase_summary(self, verbosity_option: str):
         """
@@ -44247,21 +43747,6 @@ class report_1(Group):
     def vbm(self, output_quantity: str, rotor_name: str, scale_output: bool, write_to_file: bool, file_name: str, append: bool):
         """
         'vbm' command.
-        
-        Parameters
-        ----------
-            output_quantity : str
-                'output_quantity' child.
-            rotor_name : str
-                'rotor_name' child.
-            scale_output : bool
-                'scale_output' child.
-            write_to_file : bool
-                'write_to_file' child.
-            file_name : str
-                'file_name' child.
-            append : bool
-                'append' child.
         """
     return_type: str
 class results(Group):
@@ -45545,13 +45030,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):
         """