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

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

@@ -20,33 +20,14 @@ class file(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 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 parametric_project(self):
         """
@@ -2944,24 +2925,10 @@ class materials(Group):
     def copy_database_material_by_name(self, type: str, name: str):
         """
         'copy_database_material_by_name' command.
-        
-        Parameters
-        ----------
-            type : str
-                'type' child.
-            name : str
-                'name' child.
         """
     def copy_database_material_by_formula(self, type: str, formula: str):
         """
         'copy_database_material_by_formula' command.
-        
-        Parameters
-        ----------
-            type : str
-                'type' child.
-            formula : str
-                'formula' child.
         """
     return_type: str
 class material(String, AllowedValuesMixin):
@@ -4600,13 +4567,6 @@ class fluid_1(NamedObject[fluid_1_child]):
     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.
         """
     child_object_type: fluid_1_child
     return_type: str
@@ -4766,13 +4726,6 @@ class solid_1(NamedObject[solid_1_child]):
     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.
         """
     child_object_type: solid_1_child
     return_type: str
@@ -4860,13 +4813,6 @@ class axis(NamedObject[axis_child]):
     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.
         """
     child_object_type: axis_child
     return_type: str
@@ -4892,13 +4838,6 @@ class degassing(NamedObject[degassing_child]):
     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.
         """
     child_object_type: degassing_child
     return_type: str
@@ -6616,13 +6555,6 @@ class exhaust_fan(NamedObject[exhaust_fan_child]):
     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.
         """
     child_object_type: exhaust_fan_child
     return_type: str
@@ -6835,13 +6767,6 @@ class fan(NamedObject[fan_child]):
     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.
         """
     child_object_type: fan_child
     return_type: str
@@ -6867,13 +6792,6 @@ class geometry(NamedObject[geometry_child]):
     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.
         """
     child_object_type: geometry_child
     return_type: str
@@ -7482,13 +7400,6 @@ class inlet_vent(NamedObject[inlet_vent_child]):
     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.
         """
     child_object_type: inlet_vent_child
     return_type: str
@@ -7889,13 +7800,6 @@ class intake_fan(NamedObject[intake_fan_child]):
     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.
         """
     child_object_type: intake_fan_child
     return_type: str
@@ -7947,13 +7851,6 @@ class interface(NamedObject[interface_child]):
     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.
         """
     child_object_type: interface_child
     return_type: str
@@ -7991,13 +7888,6 @@ class interior(NamedObject[interior_child]):
     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.
         """
     child_object_type: interior_child
     return_type: str
@@ -8472,13 +8362,6 @@ class mass_flow_inlet(NamedObject[mass_flow_inlet_child]):
     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.
         """
     child_object_type: mass_flow_inlet_child
     return_type: str
@@ -8669,13 +8552,6 @@ class mass_flow_outlet(NamedObject[mass_flow_outlet_child]):
     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.
         """
     child_object_type: mass_flow_outlet_child
     return_type: str
@@ -8705,13 +8581,6 @@ class network(NamedObject[network_child]):
     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.
         """
     child_object_type: network_child
     return_type: str
@@ -8775,13 +8644,6 @@ class network_end(NamedObject[network_end_child]):
     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.
         """
     child_object_type: network_end_child
     return_type: str
@@ -8893,13 +8755,6 @@ class outflow(NamedObject[outflow_child]):
     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.
         """
     child_object_type: outflow_child
     return_type: str
@@ -9232,13 +9087,6 @@ class outlet_vent(NamedObject[outlet_vent_child]):
     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.
         """
     child_object_type: outlet_vent_child
     return_type: str
@@ -9264,13 +9112,6 @@ class overset(NamedObject[overset_child]):
     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.
         """
     child_object_type: overset_child
     return_type: str
@@ -9329,13 +9170,6 @@ class periodic(NamedObject[periodic_child]):
     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.
         """
     child_object_type: periodic_child
     return_type: str
@@ -9519,13 +9353,6 @@ class porous_jump(NamedObject[porous_jump_child]):
     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.
         """
     child_object_type: porous_jump_child
     return_type: str
@@ -9879,13 +9706,6 @@ class pressure_far_field(NamedObject[pressure_far_field_child]):
     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.
         """
     child_object_type: pressure_far_field_child
     return_type: str
@@ -10256,13 +10076,6 @@ class pressure_inlet(NamedObject[pressure_inlet_child]):
     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.
         """
     child_object_type: pressure_inlet_child
     return_type: str
@@ -10591,13 +10404,6 @@ class pressure_outlet(NamedObject[pressure_outlet_child]):
     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.
         """
     child_object_type: pressure_outlet_child
     return_type: str
@@ -10698,13 +10504,6 @@ class radiator(NamedObject[radiator_child]):
     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.
         """
     child_object_type: radiator_child
     return_type: str
@@ -10767,13 +10566,6 @@ class rans_les_interface(NamedObject[rans_les_interface_child]):
     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.
         """
     child_object_type: rans_les_interface_child
     return_type: str
@@ -10952,13 +10744,6 @@ class recirculation_inlet(NamedObject[recirculation_inlet_child]):
     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.
         """
     child_object_type: recirculation_inlet_child
     return_type: str
@@ -11013,13 +10798,6 @@ class recirculation_outlet(NamedObject[recirculation_outlet_child]):
     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.
         """
     child_object_type: recirculation_outlet_child
     return_type: str
@@ -11045,13 +10823,6 @@ class shadow(NamedObject[shadow_child]):
     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.
         """
     child_object_type: shadow_child
     return_type: str
@@ -11077,13 +10848,6 @@ class symmetry(NamedObject[symmetry_child]):
     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.
         """
     child_object_type: symmetry_child
     return_type: str
@@ -11927,13 +11691,6 @@ class velocity_inlet(NamedObject[velocity_inlet_child]):
     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.
         """
     child_object_type: velocity_inlet_child
     return_type: str
@@ -14294,13 +14051,6 @@ class wall(NamedObject[wall_child]):
     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.
         """
     child_object_type: wall_child
     return_type: str
@@ -17368,11 +17118,6 @@ class report_definitions(Group):
     def compute(self, report_defs: list[str]):
         """
         'compute' command.
-        
-        Parameters
-        ----------
-            report_defs : List
-                'report_defs' child.
         """
     return_type: str
 class fmg_initialize(Boolean):
@@ -17568,13 +17313,6 @@ class initialization(Group):
     def init_acoustics_options(self, set_ramping_length: bool, number_of_timesteps: int):
         """
         'init_acoustics_options' command.
-        
-        Parameters
-        ----------
-            set_ramping_length : bool
-                Enable/Disable ramping length and initialize acoustics.
-            number_of_timesteps : int
-                Set number of timesteps for ramping of sources.
         """
     return_type: str
 class enabled_2(Boolean):
@@ -17754,11 +17492,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):
@@ -18199,11 +17932,6 @@ class mesh_1(NamedObject[mesh_1_child]):
     def display(self, object_name: str):
         """
         'display' command.
-        
-        Parameters
-        ----------
-            object_name : str
-                'object_name' child.
         """
     child_object_type: mesh_1_child
     return_type: str
@@ -18410,11 +18138,6 @@ class contour(NamedObject[contour_child]):
     def display(self, object_name: str):
         """
         'display' command.
-        
-        Parameters
-        ----------
-            object_name : str
-                'object_name' child.
         """
     child_object_type: contour_child
     return_type: str
@@ -18529,11 +18252,6 @@ class vector(NamedObject[vector_child]):
     def display(self, object_name: str):
         """
         'display' command.
-        
-        Parameters
-        ----------
-            object_name : str
-                'object_name' child.
         """
     child_object_type: vector_child
     return_type: str
@@ -18759,11 +18477,6 @@ class pathlines(NamedObject[pathlines_child]):
     def display(self, object_name: str):
         """
         'display' command.
-        
-        Parameters
-        ----------
-            object_name : str
-                'object_name' child.
         """
     child_object_type: pathlines_child
     return_type: str
@@ -19007,11 +18720,6 @@ class particle_tracks(NamedObject[particle_tracks_child]):
     def display(self, object_name: str):
         """
         'display' command.
-        
-        Parameters
-        ----------
-            object_name : str
-                'object_name' child.
         """
     child_object_type: particle_tracks_child
     return_type: str
@@ -19127,11 +18835,6 @@ class lic(NamedObject[lic_child]):
     def display(self, object_name: str):
         """
         'display' command.
-        
-        Parameters
-        ----------
-            object_name : str
-                'object_name' child.
         """
     child_object_type: lic_child
     return_type: str
@@ -19448,11 +19151,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):
         """
@@ -19506,11 +19204,6 @@ class views(Group):
     def save_picture(self, file_name: str):
         """
         'save_picture' command.
-        
-        Parameters
-        ----------
-            file_name : str
-                'file_name' child.
         """
     def auto_scale(self):
         """