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

ansys/fluent/core/generated/solver/settings_251.py

@@ -1930,17 +1930,6 @@ class lightweight_setup(Boolean):
 class read(Command):
     """
     'read' command.
-    
-    Parameters
-    ----------
-        file_type : str
-            'file_type' child.
-        file_name_1 : str
-            'file_name' child.
-        pdf_file_name : str
-            'pdf_file_name' child.
-        lightweight_setup : bool
-            'lightweight_setup' child.
     """
     version = '251'
     fluent_name = 'read'
@@ -1956,13 +1945,6 @@ class read(Command):
 class read_case(Command):
     """
     'read_case' command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            'file_name' child.
-        pdf_file_name : str
-            'pdf_file_name' child.
     """
     version = '251'
     fluent_name = 'read-case'
@@ -1976,13 +1958,6 @@ class read_case(Command):
 class read_case_data(Command):
     """
     'read_case_data' command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            'file_name' child.
-        pdf_file_name : str
-            'pdf_file_name' child.
     """
     version = '251'
     fluent_name = 'read-case-data'
@@ -1996,13 +1971,6 @@ class read_case_data(Command):
 class read_case_setting(Command):
     """
     'read_case_setting' command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            'file_name' child.
-        pdf_file_name : str
-            'pdf_file_name' child.
     """
     version = '251'
     fluent_name = 'read-case-setting'
@@ -2016,11 +1984,6 @@ class read_case_setting(Command):
 class read_data(Command):
     """
     'read_data' command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            'file_name' child.
     """
     version = '251'
     fluent_name = 'read-data'
@@ -2033,11 +1996,6 @@ class read_data(Command):
 class read_mesh(Command):
     """
     'read_mesh' command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            'file_name' child.
     """
     version = '251'
     fluent_name = 'read-mesh'
@@ -2161,11 +2119,6 @@ class stop_journal(Command):
 class replace_mesh(Command):
     """
     'replace_mesh' command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            'file_name' child.
     """
     version = '251'
     fluent_name = 'replace-mesh'
@@ -2178,13 +2131,6 @@ class replace_mesh(Command):
 class write(Command):
     """
     'write' command.
-    
-    Parameters
-    ----------
-        file_type : str
-            'file_type' child.
-        file_name : str
-            'file_name' child.
     """
     version = '251'
     fluent_name = 'write'
@@ -2198,11 +2144,6 @@ class write(Command):
 class write_case(Command):
     """
     'write_case' command.
-    
-    Parameters
-    ----------
-        file_name : str
-            'file_name' child.
     """
     version = '251'
     fluent_name = 'write-case'
@@ -2215,11 +2156,6 @@ class write_case(Command):
 class write_data(Command):
     """
     'write_data' command.
-    
-    Parameters
-    ----------
-        file_name : str
-            'file_name' child.
     """
     version = '251'
     fluent_name = 'write-data'
@@ -2232,11 +2168,6 @@ class write_data(Command):
 class write_case_data(Command):
     """
     'write_case_data' command.
-    
-    Parameters
-    ----------
-        file_name : str
-            'file_name' child.
     """
     version = '251'
     fluent_name = 'write-case-data'
@@ -4801,15 +4732,6 @@ class convert_skewed_cells_1(Boolean):
 class convert_skewed_cells(Command):
     """
     '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.
     """
     version = '251'
     fluent_name = 'convert-skewed-cells'
@@ -4961,15 +4883,6 @@ class z_scale(Real):
 class scale(Command):
     """
     'scale' command.
-    
-    Parameters
-    ----------
-        x_scale : real
-            'x_scale' child.
-        y_scale : real
-            'y_scale' child.
-        z_scale : real
-            'z_scale' child.
     """
     version = '251'
     fluent_name = 'scale'
@@ -14294,12 +14207,10 @@ class root_radius(Real):
 class basic_info(Group):
     """
     Menu to define the rotor basic informations:
-    
      - Number of Blades 
      - Rotor Speed  , 
      - Tip Radius 
      - Root Radius , 
-    
     For more details please consult the help option of the corresponding menu or TUI command.
     """
     version = '251'
@@ -14355,10 +14266,8 @@ class disk_origin(Group):
 class terminology(Integer):
     """
     Select Rotor Disk Orientation Terminology:
-    
      - Enter 0 if using Rotor Disk Angles 
      - Enter 1 if using Rotor Disk Normal 
-    
     For more details please consult the help option of the corresponding menu or TUI command.
     """
     version = '251'
@@ -14408,12 +14317,10 @@ class disk_normal_z(Real):
 class disk_orientation(Group):
     """
     Menu to define the rotor disk orientation.
-    
      - terminology      : the terminology to specify the rotor disk orientation: rotor-disk-angles / rotor-disk-normal, 
      - disk-normal-x/y/z : rotor-disk-normal components, 
      - disk-pitch-angle : , 
      - disk-bank-angle : , 
-    
     For more details please consult the help option of the corresponding menu or TUI command.
     """
     version = '251'
@@ -14448,11 +14355,9 @@ class floating_surface_name(String, AllowedValuesMixin):
 class disk_id(Group):
     """
     Menu to define the disk face/surface name:
-    
      - embedded-face-zone    : select embedded-face-zone name, 
      - floating-surface-name : select floating-surface-name, 
      - create-floating-disk  : create a floating-disk for the current rotor, 
-    
     For more details please consult the help option of the corresponding menu or TUI command.
     """
     version = '251'
@@ -14491,11 +14396,9 @@ class blade_pitch_cyclic_cos(Real):
 class blade_pitch_angles(Group):
     """
     Menu to define the rotor pitch angles: 
-    
      - blade-pitch-collective    
      - blade-pitch-cyclic-sin    
      - blade-pitch-cyclic-cos    
-    
     For more details please consult the help option of the corresponding menu or TUI command.
     """
     version = '251'
@@ -14535,11 +14438,9 @@ class blade_flapping_cyclic_cos(Real):
 class blade_flap_angles(Group):
     """
     Menu to define the rotor flapping angles:
-    
      - blade-flapping-cone         
      - blade-flapping-cyclic-sin   
      - blade-flapping-cyclic-cos   
-    
     For more details please consult the help option of the corresponding menu or TUI command.
     """
     version = '251'
@@ -14555,10 +14456,8 @@ class blade_flap_angles(Group):
 class model_tip_loss(Integer):
     """
     Select Tip Loss Model:
-    
      - Enter 1 if using Quadratic model 
      - Enter 2 if using modified Prandtl model 
-    
     For more details please consult the help option of the corresponding menu or TUI command.
     """
     version = '251'
@@ -14584,11 +14483,9 @@ class prandtl_tuning_coefficient(Real):
 class tip_loss(Group):
     """
     Menu to define the rotor tip loss model: 
-    
      - model-tip-loss : define the method to model rotor tip loss, quadratic-tip-loss, prandtl-tip-loss
      - tip-loss-limit : tip-loss-limit 
      - prandtl-tuning-coefficient: prandtl-tuning-coefficient, 
-    
     For more details please consult the help option of the corresponding menu or TUI command.
     """
     version = '251'
@@ -14713,12 +14610,10 @@ class geometry_2_child(Group):
 class geometry_2(NamedObject[geometry_2_child], CreatableNamedObjectMixin[geometry_2_child]):
     """
     Main menu to define a blade section in the current rotor:  
-    
      - delete : delete a section      
      - edit   : edit/setup a section  
      - add    : create a new section  
      - rename : rename a section	   
-    
     For more details please consult the help option of the corresponding menu or TUI command.
     """
     version = '251'
@@ -14739,12 +14634,10 @@ class geometry_2(NamedObject[geometry_2_child], CreatableNamedObjectMixin[geomet
 class trim_option(Integer):
     """
     Select Trimming Option:
-    
      - Enter 0 if no trimming is required 
      - Enter 1 if trimming of collective pitch is required 
      - Enter 2 if trimming of cyclic pitch angles are required 
      - Enter 3 if trimming of both collective and cyclic pitch angles are required 
-    
     For more details please consult the help option of the corresponding menu or TUI command.
     """
     version = '251'
@@ -17600,11 +17493,6 @@ class file_name_8(Filename, _OutputFile):
 class write_table(Command):
     """
     2D table writting command.
-    
-    Parameters
-    ----------
-        file_name : str
-            File name in 2D table writting.
     """
     version = '251'
     fluent_name = 'write-table'
@@ -17625,11 +17513,6 @@ class file_name_1_5(Filename, _InputFile):
 class read_table(Command):
     """
     2D table reading command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            File name in 2D table reading.
     """
     version = '251'
     fluent_name = 'read-table'
@@ -17706,11 +17589,6 @@ class file_name_9(Filename, _OutputFile):
 class write_table_1(Command):
     """
     Writing 3D table command.
-    
-    Parameters
-    ----------
-        file_name : str
-            Set file name in the 3D table-writing command.
     """
     version = '251'
     fluent_name = 'write-table'
@@ -17731,11 +17609,6 @@ class file_name_1_6(Filename, _InputFile):
 class read_table_1(Command):
     """
     3D Reading table command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            Set file name in the 3D table-reading command.
     """
     version = '251'
     fluent_name = 'read-table'
@@ -22313,21 +22186,6 @@ class value_list(RealList):
 class add_rom_parameter(Command):
     """
     Add parameter command.
-    
-    Parameters
-    ----------
-        parameter_type : str
-            Set parameter type.
-        entity_list : List
-            Entity list name.
-        group_value : real
-            Set group value.
-        individual_or_group : bool
-            Set as-group option.
-        individual_value : bool
-            Set individual value for different entities in the group.
-        value_list : List
-            Set values for the different entities in the group.
     """
     version = '251'
     fluent_name = 'add-rom-parameter'
@@ -49385,11 +49243,6 @@ class file_name_13(String):
 class read_input_file(Command):
     """
     'read_input_file' command.
-    
-    Parameters
-    ----------
-        file_name : str
-            'file_name' child.
     """
     version = '251'
     fluent_name = 'read-input-file'
@@ -52048,15 +51901,6 @@ class phase_26(String, AllowedValuesMixin):
 class compute(Command):
     """
     'compute' command.
-    
-    Parameters
-    ----------
-        from_zone_type : str
-            'from_zone_type' child.
-        from_zone_name : str
-            'from_zone_name' child.
-        phase : str
-            'phase' child.
     """
     version = '251'
     fluent_name = 'compute'
@@ -52495,11 +52339,6 @@ class names(StringList, AllowedValuesMixin):
 class compute_1(Command):
     """
     'compute' command.
-    
-    Parameters
-    ----------
-        names : List
-            'names' child.
     """
     version = '251'
     fluent_name = 'compute'
@@ -53017,11 +52856,6 @@ class face_name_2(String, AllowedValuesMixin):
 class list_face(Command):
     """
     'list_face' command.
-    
-    Parameters
-    ----------
-        face_name : str
-            'face_name' child.
     """
     version = '251'
     fluent_name = 'list-face'
@@ -56225,15 +56059,6 @@ class display_profile_point_cloud_data(Command):
 class display_profile_surface(Command):
     """
     Display Profile Surface/field rendering command.
-    
-    Parameters
-    ----------
-        profile_name : str
-            Profile name.
-        field_contour : bool
-            Field contour?.
-        field_variable : str
-            Field variable.
     """
     version = '251'
     fluent_name = 'display-profile-surface'
@@ -56272,15 +56097,6 @@ class profile_point_marker_color(String, AllowedValuesMixin):
 class set_preference_profile_point_cloud_data(Command):
     """
     Profile Point attributes command.
-    
-    Parameters
-    ----------
-        profile_point_marker : str
-            Profile point marker.
-        profile_point_marker_size : real
-            Profile point marker size.
-        profile_point_marker_color : str
-            Profile point marker color.
     """
     version = '251'
     fluent_name = 'set-preference-profile-point-cloud-data'
@@ -56401,11 +56217,6 @@ class list_profiles(Command):
 class list_profile_parameters(Command):
     """
     List-profile-parameters-command.
-    
-    Parameters
-    ----------
-        profile_name : str
-            Profile name.
     """
     version = '251'
     fluent_name = 'list-profile-parameters'
@@ -56418,11 +56229,6 @@ class list_profile_parameters(Command):
 class list_profile_parameters_with_value(Command):
     """
     List-profile-parameters-with-value-command.
-    
-    Parameters
-    ----------
-        profile_name : str
-            Profile name.
     """
     version = '251'
     fluent_name = 'list-profile-parameters-with-value'
@@ -56435,11 +56241,6 @@ class list_profile_parameters_with_value(Command):
 class list_profile_fields(Command):
     """
     List-profile-fields-command.
-    
-    Parameters
-    ----------
-        profile_name : str
-            Profile name.
     """
     version = '251'
     fluent_name = 'list-profile-fields'
@@ -56452,11 +56253,6 @@ class list_profile_fields(Command):
 class delete_4(CommandWithPositionalArgs):
     """
     Delete-profile-command.
-    
-    Parameters
-    ----------
-        profile_name : str
-            Profile name.
     """
     version = '251'
     fluent_name = 'delete'
@@ -65124,11 +64920,6 @@ class command_name(String):
 class enable_24(Command):
     """
     Enable an execute-command.
-    
-    Parameters
-    ----------
-        command_name : str
-            'command_name' child.
     """
     version = '251'
     fluent_name = 'enable'
@@ -65141,11 +64932,6 @@ class enable_24(Command):
 class disable_1(Command):
     """
     Disable an execute-command.
-    
-    Parameters
-    ----------
-        command_name : str
-            'command_name' child.
     """
     version = '251'
     fluent_name = 'disable'
@@ -65158,11 +64944,6 @@ class disable_1(Command):
 class copy_3(Command):
     """
     Copy an execute-command.
-    
-    Parameters
-    ----------
-        command_name : str
-            'command_name' child.
     """
     version = '251'
     fluent_name = 'copy'
@@ -65175,11 +64956,6 @@ class copy_3(Command):
 class delete_5(CommandWithPositionalArgs):
     """
     Delete an execute-command.
-    
-    Parameters
-    ----------
-        command_name : str
-            'command_name' child.
     """
     version = '251'
     fluent_name = 'delete'
@@ -65208,13 +64984,6 @@ class tsv_file_name(Filename, _OutputFile):
 class export_1(Command):
     """
     Export execute-commands to a TSV file.
-    
-    Parameters
-    ----------
-        command_name : List
-            'command_name' child.
-        tsv_file_name : str
-            'tsv_file_name' child.
     """
     version = '251'
     fluent_name = 'export'
@@ -65236,11 +65005,6 @@ class tsv_file_name_1(Filename, _InputFile):
 class import__1(Command):
     """
     Import execute-commands from a TSV file.
-    
-    Parameters
-    ----------
-        tsv_file_name_1 : str
-            'tsv_file_name' child.
     """
     version = '251'
     fluent_name = 'import_'
@@ -65902,27 +65666,6 @@ class mod_command(String):
 class add_edit_modification(Command):
     """
     Define a single case modification.
-    
-    Parameters
-    ----------
-        mod_name : str
-            Name of Modification.
-        mod_exists : bool
-            Modification Exists?.
-        mod_active : bool
-            Modification is Active?.
-        mod_execution_option : str
-            Execution Option for Transient.
-        mod_iterations : int
-            Modification Iterations.
-        mod_timesteps : int
-            Modification Time Steps.
-        mod_flowtime : real
-            Modification Flow Time.
-        mod_python : bool
-            Modification is Python?.
-        mod_command : str
-            Modification.
     """
     version = '251'
     fluent_name = 'add-edit-modification'
@@ -66052,13 +65795,6 @@ class filename_1_4(Filename, _OutputFile):
 class export_modifications(Command):
     """
     Export all case modifications to a tsv file.
-    
-    Parameters
-    ----------
-        command_list : List
-            'command_list' child.
-        filename_1 : str
-            'filename' child.
     """
     version = '251'
     fluent_name = 'export-modifications'
@@ -73884,11 +73620,6 @@ class preview(Command):
 class save_picture(Command):
     """
     'save_picture' command.
-    
-    Parameters
-    ----------
-        file_name : str
-            'file_name' child.
     """
     version = '251'
     fluent_name = 'save-picture'
@@ -74222,11 +73953,6 @@ class state_name(String, AllowedValuesMixin):
 class use_active(Command):
     """
     'use_active' command.
-    
-    Parameters
-    ----------
-        state_name : str
-            'state_name' child.
     """
     version = '251'
     fluent_name = 'use-active'
@@ -75848,15 +75574,6 @@ class write_format(String, AllowedValuesMixin):
 class write_3(Command):
     """
     'write' command.
-    
-    Parameters
-    ----------
-        object_name : str
-            'object_name' child.
-        write_format : str
-            'write_format' child.
-        file_name : str
-            'file_name' child.
     """
     version = '251'
     fluent_name = 'write'
@@ -77567,11 +77284,6 @@ class set_custom_frames_1(Group):
 class read_animation(Command):
     """
     'read_animation' command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            'file_name' child.
     """
     version = '251'
     fluent_name = 'read-animation'
@@ -78162,19 +77874,6 @@ class correlation_variable(String, AllowedValuesMixin):
 class plot_sample(Command):
     """
     '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.
     """
     version = '251'
     fluent_name = 'plot-sample'
@@ -78191,19 +77890,6 @@ class plot_sample(Command):
 class write_sample(Command):
     """
     '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.
     """
     version = '251'
     fluent_name = 'write-sample'
@@ -78349,13 +78035,6 @@ class max_val(Real):
 class set_maximum(Command):
     """
     'set_maximum' command.
-    
-    Parameters
-    ----------
-        sample_var : str
-            'sample_var' child.
-        max_val : real
-            'max_val' child.
     """
     version = '251'
     fluent_name = 'set-maximum'
@@ -78571,11 +78250,6 @@ class compute_sample(Command):
 class delete_sample(Command):
     """
     'delete_sample' command.
-    
-    Parameters
-    ----------
-        sample : str
-            'sample' child.
     """
     version = '251'
     fluent_name = 'delete-sample'
@@ -78742,23 +78416,6 @@ class accumulate_rates(Boolean):
 class compute_9(Command):
     """
     '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.
     """
     version = '251'
     fluent_name = 'compute'
@@ -78777,23 +78434,6 @@ class compute_9(Command):
 class start_file_write(Command):
     """
     '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.
     """
     version = '251'
     fluent_name = 'start-file-write'
@@ -78983,23 +78623,6 @@ class reset_dpm_summaries(Boolean):
 class set_per_injection_zone_summaries(Command):
     """
     Enable per-injection per-zone DPM summary reports.
-    
-    Parameters
-    ----------
-        enable : bool
-            Specify whether to enable or disable the per-injection per-zone DPM summary reports.
-    Enabling them will mean that more memory will be used to hold the data being collected.
-    For unsteady tracking, if some data for DPM summary reports have already been collected,
-    they will continue to be shown just specific to the zone, not any injection, while
-    data collected in the future will be shown both zone- and injection-specific.
-    Disabling requires that both the current DPM summary report data are reset
-    and all particle parcels currently in the domain are cleared out(!).
-        reset_dpm_summaries : bool
-            Disabling the per-injection per-zone DPM summary reports requires that
-    both the current DPM summary report data are reset and all particle
-    parcels currently in the domain are cleared out(!).
-    Set this command argument / check this checkbox to
-    confirm that you want to proceed as described.
     """
     version = '251'
     fluent_name = 'set-per-injection-zone-summaries'
@@ -82480,21 +82103,6 @@ class append_1(Boolean):
 class vbm_1(Command):
     """
     '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.
     """
     version = '251'
     fluent_name = 'vbm'
@@ -89839,13 +89447,6 @@ class invalidate_case(Boolean):
 class kill_node(Command):
     """
     'kill_node' command.
-    
-    Parameters
-    ----------
-        compute_node : int
-            'compute_node' child.
-        invalidate_case : bool
-            'invalidate_case' child.
     """
     version = '251'
     fluent_name = 'kill-node'