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

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

@@ -1773,17 +1773,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 = '242'
     fluent_name = 'read'
@@ -1799,13 +1788,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 = '242'
     fluent_name = 'read-case'
@@ -1819,13 +1801,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 = '242'
     fluent_name = 'read-case-data'
@@ -1839,13 +1814,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 = '242'
     fluent_name = 'read-case-setting'
@@ -1859,11 +1827,6 @@ class read_case_setting(Command):
 class read_data(Command):
     """
     'read_data' command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            'file_name' child.
     """
     version = '242'
     fluent_name = 'read-data'
@@ -1876,11 +1839,6 @@ class read_data(Command):
 class read_mesh(Command):
     """
     'read_mesh' command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            'file_name' child.
     """
     version = '242'
     fluent_name = 'read-mesh'
@@ -2004,11 +1962,6 @@ class stop_journal(Command):
 class replace_mesh(Command):
     """
     'replace_mesh' command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            'file_name' child.
     """
     version = '242'
     fluent_name = 'replace-mesh'
@@ -2021,13 +1974,6 @@ class replace_mesh(Command):
 class write(Command):
     """
     'write' command.
-    
-    Parameters
-    ----------
-        file_type : str
-            'file_type' child.
-        file_name : str
-            'file_name' child.
     """
     version = '242'
     fluent_name = 'write'
@@ -2041,11 +1987,6 @@ class write(Command):
 class write_case(Command):
     """
     'write_case' command.
-    
-    Parameters
-    ----------
-        file_name : str
-            'file_name' child.
     """
     version = '242'
     fluent_name = 'write-case'
@@ -2058,11 +1999,6 @@ class write_case(Command):
 class write_data(Command):
     """
     'write_data' command.
-    
-    Parameters
-    ----------
-        file_name : str
-            'file_name' child.
     """
     version = '242'
     fluent_name = 'write-data'
@@ -2075,11 +2011,6 @@ class write_data(Command):
 class write_case_data(Command):
     """
     'write_case_data' command.
-    
-    Parameters
-    ----------
-        file_name : str
-            'file_name' child.
     """
     version = '242'
     fluent_name = 'write-case-data'
@@ -4476,15 +4407,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 = '242'
     fluent_name = 'convert-skewed-cells'
@@ -4636,15 +4558,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 = '242'
     fluent_name = 'scale'
@@ -11907,12 +11820,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 = '242'
@@ -11968,10 +11879,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 = '242'
@@ -12021,12 +11930,10 @@ class disk_bank_angle(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/yz : 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 = '242'
@@ -12069,11 +11976,9 @@ class create_floating_disk(Command):
 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 = '242'
@@ -12114,11 +12019,9 @@ class blade_pitch_cyclic_cos(Real):
 class blade_pitch_angles(Group):
     """
     Menu to define the rotor pitch and flapping 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 = '242'
@@ -12158,11 +12061,9 @@ class blade_flapping_cyclic_cos(Real):
 class blade_flap_angles(Group):
     """
     Menu to define the rotor pitch 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 = '242'
@@ -12178,10 +12079,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 = '242'
@@ -12207,11 +12106,9 @@ class prandtl_tuning_coefficient(Real):
 class tip_loss(Group):
     """
     Menu to define the rotor tip loss model.
-    
      - method  : 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 = '242'
@@ -12315,12 +12212,10 @@ class geometry_2(NamedObject[geometry_2_child], CreatableNamedObjectMixinOld[geo
 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 = '242'
@@ -12370,14 +12265,12 @@ class roll_moment_coef(Real):
 class trimming(Group):
     """
     Menu to define rotor trimming set-up.
-    
      - trim-option       : to define collective and cyclic pitches to trim, 
      - update-frequency  : the number of solver iterations that pitch angle will be updated each time, 
      - damping-factor    : relaxation factor for pitch angles, 
      - thrust-coef       : desired thrust coefficient to set pitch for
      - pitch-moment-coef : desired pitch-moment coefficient to set pitch for, 
      - roll-moment-coef  : desired roll-moment coefficient to set pitch for, 
-    
     For more details please consult the help option of the corresponding menu or TUI command.
     """
     version = '242'
@@ -14870,11 +14763,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 = '242'
     fluent_name = 'write-table'
@@ -14895,11 +14783,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 = '242'
     fluent_name = 'read-table'
@@ -14980,11 +14863,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 = '242'
     fluent_name = 'write-table'
@@ -15005,11 +14883,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 = '242'
     fluent_name = 'read-table'
@@ -19652,21 +19525,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 = '242'
     fluent_name = 'add-rom-parameter'
@@ -45526,11 +45384,6 @@ class file_name_13(String):
 class read_input_file(Command):
     """
     'read_input_file' command.
-    
-    Parameters
-    ----------
-        file_name : str
-            'file_name' child.
     """
     version = '242'
     fluent_name = 'read-input-file'
@@ -47377,15 +47230,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 = '242'
     fluent_name = 'compute'
@@ -47814,11 +47658,6 @@ class names(StringList, AllowedValuesMixin):
 class compute_1(Command):
     """
     'compute' command.
-    
-    Parameters
-    ----------
-        names : List
-            'names' child.
     """
     version = '242'
     fluent_name = 'compute'
@@ -48307,11 +48146,6 @@ class face_name_2(String, AllowedValuesMixin):
 class list_face(Command):
     """
     'list_face' command.
-    
-    Parameters
-    ----------
-        face_name : str
-            'face_name' child.
     """
     version = '242'
     fluent_name = 'list-face'
@@ -50651,15 +50485,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 = '242'
     fluent_name = 'display-profile-surface'
@@ -50698,15 +50523,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 = '242'
     fluent_name = 'set-preference-profile-point-cloud-data'
@@ -50813,11 +50629,6 @@ class list_profiles(Command):
 class list_profile_parameters(Command):
     """
     List-profile-parameters-command.
-    
-    Parameters
-    ----------
-        profile_name : str
-            Profile name.
     """
     version = '242'
     fluent_name = 'list-profile-parameters'
@@ -50830,11 +50641,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 = '242'
     fluent_name = 'list-profile-parameters-with-value'
@@ -50847,11 +50653,6 @@ class list_profile_parameters_with_value(Command):
 class list_profile_fields(Command):
     """
     List-profile-fields-command.
-    
-    Parameters
-    ----------
-        profile_name : str
-            Profile name.
     """
     version = '242'
     fluent_name = 'list-profile-fields'
@@ -50864,11 +50665,6 @@ class list_profile_fields(Command):
 class delete_4(CommandWithPositionalArgs):
     """
     Delete-profile-command.
-    
-    Parameters
-    ----------
-        profile_name : str
-            Profile name.
     """
     version = '242'
     fluent_name = 'delete'
@@ -58654,11 +58450,6 @@ class command_name(String):
 class enable_20(Command):
     """
     Enable an execute-command.
-    
-    Parameters
-    ----------
-        command_name : str
-            'command_name' child.
     """
     version = '242'
     fluent_name = 'enable'
@@ -58671,11 +58462,6 @@ class enable_20(Command):
 class disable_1(Command):
     """
     Disable an execute-command.
-    
-    Parameters
-    ----------
-        command_name : str
-            'command_name' child.
     """
     version = '242'
     fluent_name = 'disable'
@@ -58688,11 +58474,6 @@ class disable_1(Command):
 class copy_3(Command):
     """
     Copy an execute-command.
-    
-    Parameters
-    ----------
-        command_name : str
-            'command_name' child.
     """
     version = '242'
     fluent_name = 'copy'
@@ -58705,11 +58486,6 @@ class copy_3(Command):
 class delete_5(CommandWithPositionalArgs):
     """
     Delete an execute-command.
-    
-    Parameters
-    ----------
-        command_name : str
-            'command_name' child.
     """
     version = '242'
     fluent_name = 'delete'
@@ -58738,13 +58514,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 = '242'
     fluent_name = 'export'
@@ -58766,11 +58535,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 = '242'
     fluent_name = 'import_'
@@ -59473,13 +59237,6 @@ class filename_2_2(Filename, _OutputFile):
 class export_modifications(Command):
     """
     Export all case modifications to a tsv file.
-    
-    Parameters
-    ----------
-        command_list : List
-            'command_list' child.
-        filename_2 : str
-            'filename' child.
     """
     version = '242'
     fluent_name = 'export-modifications'
@@ -65984,11 +65741,6 @@ class preview(Command):
 class save_picture(Command):
     """
     'save_picture' command.
-    
-    Parameters
-    ----------
-        file_name : str
-            'file_name' child.
     """
     version = '242'
     fluent_name = 'save-picture'
@@ -66321,11 +66073,6 @@ class state_name(String, AllowedValuesMixin):
 class use_active(Command):
     """
     'use_active' command.
-    
-    Parameters
-    ----------
-        state_name : str
-            'state_name' child.
     """
     version = '242'
     fluent_name = 'use-active'
@@ -67917,15 +67664,6 @@ class write_format(String, AllowedValuesMixin):
 class write_2(Command):
     """
     'write' command.
-    
-    Parameters
-    ----------
-        object_name : str
-            'object_name' child.
-        write_format : str
-            'write_format' child.
-        file_name : str
-            'file_name' child.
     """
     version = '242'
     fluent_name = 'write'
@@ -69367,11 +69105,6 @@ class set_custom_frames_1(Group):
 class read_animation(Command):
     """
     'read_animation' command.
-    
-    Parameters
-    ----------
-        file_name_1 : str
-            'file_name' child.
     """
     version = '242'
     fluent_name = 'read-animation'
@@ -69962,19 +69695,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 = '242'
     fluent_name = 'plot-sample'
@@ -69991,19 +69711,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 = '242'
     fluent_name = 'write-sample'
@@ -70149,13 +69856,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 = '242'
     fluent_name = 'set-maximum'
@@ -70371,11 +70071,6 @@ class compute_sample(Command):
 class delete_sample(Command):
     """
     'delete_sample' command.
-    
-    Parameters
-    ----------
-        sample : str
-            'sample' child.
     """
     version = '242'
     fluent_name = 'delete-sample'
@@ -70542,23 +70237,6 @@ class accumulate_rates(Boolean):
 class compute_3(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 = '242'
     fluent_name = 'compute'
@@ -70577,23 +70255,6 @@ class compute_3(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 = '242'
     fluent_name = 'start-file-write'
@@ -73148,21 +72809,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 = '242'
     fluent_name = 'vbm'
@@ -80025,13 +79671,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 = '242'
     fluent_name = 'kill-node'