ansys-fluent-core 0.28.1__py3-none-any.whl → 0.28.2__py3-none-any.whl

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

@@ -5230,6 +5230,86 @@ class specify_species_in(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
+class default_progress_variable(Boolean):
+    version: str
+    fluent_name: str
+    _python_name: str
+class weight(Real):
+    version: str
+    fluent_name: str
+    _python_name: str
+class definition_of_progress_variable_child(Group):
+    version: str
+    fluent_name: str
+    _python_name: str
+    child_names: list[str]
+    weight: weight
+class definition_of_progress_variable(NamedObject[definition_of_progress_variable_child]):
+    version: str
+    fluent_name: str
+    _python_name: str
+    command_names: list[str]
+    def create(self, name: str):
+        """
+        Create an instance of this.
+        
+        Parameters
+        ----------
+            name : str
+                Set name for an object.
+        """
+    def delete(self, name_list: list[str]):
+        """
+        Delete selected objects.
+        
+        Parameters
+        ----------
+            name_list : List
+                Select objects to be deleted.
+        """
+    def rename(self, new: str, old: str):
+        """
+        Rename the object.
+        
+        Parameters
+        ----------
+            new : str
+                New name for the object.
+            old : str
+                Select object to rename.
+        """
+    def list(self):
+        """
+        List the names of the objects.
+        """
+    def list_properties(self, object_name: str):
+        """
+        List active properties of the object.
+        
+        Parameters
+        ----------
+            object_name : str
+                Select object for which properties are to be listed.
+        """
+    def make_a_copy(self, from_: str, to: str):
+        """
+        Create a copy of the object.
+        
+        Parameters
+        ----------
+            from_ : str
+                Select the object to duplicate.
+            to : str
+                Specify the name of the new object.
+        """
+    child_object_type: definition_of_progress_variable_child
+class progress_variable_definition(Group):
+    version: str
+    fluent_name: str
+    _python_name: str
+    child_names: list[str]
+    default_progress_variable: default_progress_variable
+    definition_of_progress_variable: definition_of_progress_variable
 class boundary(Group):
     version: str
     fluent_name: str
@@ -5239,6 +5319,7 @@ class boundary(Group):
     oxidizer_temperature: oxidizer_temperature
     species_boundary: species_boundary
     specify_species_in: specify_species_in
+    progress_variable_definition: progress_variable_definition
 class initial_fourier_number(Real):
     version: str
     fluent_name: str
@@ -6605,6 +6686,36 @@ class times(Group):
     child_names: list[str]
     start_time: start_time
     stop_time: stop_time
+class unsteady_ca_start(Real, AllowedValuesMixin):
+    version: str
+    fluent_name: str
+    _python_name: str
+class unsteady_ca_stop(Real, AllowedValuesMixin):
+    version: str
+    fluent_name: str
+    _python_name: str
+class crank_angles(Group):
+    version: str
+    fluent_name: str
+    _python_name: str
+    child_names: list[str]
+    unsteady_ca_start: unsteady_ca_start
+    unsteady_ca_stop: unsteady_ca_stop
+class start_at_flow_time_in_unsteady_inj_file(Real, AllowedValuesMixin):
+    version: str
+    fluent_name: str
+    _python_name: str
+class interval_to_repeat_in_unsteady_inj_file(Real, AllowedValuesMixin):
+    version: str
+    fluent_name: str
+    _python_name: str
+class unsteady_inj_file(Group):
+    version: str
+    fluent_name: str
+    _python_name: str
+    child_names: list[str]
+    start_at_flow_time_in_unsteady_inj_file: start_at_flow_time_in_unsteady_inj_file
+    interval_to_repeat_in_unsteady_inj_file: interval_to_repeat_in_unsteady_inj_file
 class injection_surfaces(StringList, AllowedValuesMixin):
     version: str
     fluent_name: str
@@ -6940,6 +7051,8 @@ class initial_values(Group):
     child_names: list[str]
     reference_frame: reference_frame_1
     times: times
+    crank_angles: crank_angles
+    unsteady_inj_file: unsteady_inj_file
     location: location_1
     cone_settings: cone_settings
     mass_flow_rate: mass_flow_rate
@@ -39394,6 +39507,46 @@ class advanced_2(Group):
     child_names: list[str]
     delay_model_change_update: delay_model_change_update
     batch_thread_update: batch_thread_update
+class type_7(String, AllowedValuesMixin):
+    version: str
+    fluent_name: str
+    _python_name: str
+class mass_flow_1(Real):
+    version: str
+    fluent_name: str
+    _python_name: str
+class pressure_gradient(Real):
+    version: str
+    fluent_name: str
+    _python_name: str
+class bulk_temperature(Real):
+    version: str
+    fluent_name: str
+    _python_name: str
+class relax_1(Real):
+    version: str
+    fluent_name: str
+    _python_name: str
+class niter(Integer):
+    version: str
+    fluent_name: str
+    _python_name: str
+class flow_direction_2(RealList):
+    version: str
+    fluent_name: str
+    _python_name: str
+class periodic_conditions(Group):
+    version: str
+    fluent_name: str
+    _python_name: str
+    child_names: list[str]
+    type: type_7
+    mass_flow: mass_flow_1
+    pressure_gradient: pressure_gradient
+    bulk_temperature: bulk_temperature
+    relax: relax_1
+    niter: niter
+    flow_direction: flow_direction_2
 class settings_27(Group):
     version: str
     fluent_name: str
@@ -39407,6 +39560,7 @@ class settings_27(Group):
     physical_velocity_porous_formulation: physical_velocity_porous_formulation
     target_mass_flow_rate_settings: target_mass_flow_rate_settings
     advanced: advanced_2
+    periodic_conditions: periodic_conditions
     def detect_boundary_advection(self):
         """
         Detect and set boundary advection at solid walls.
@@ -41913,7 +42067,7 @@ class select_variables(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
-class type_7(String, AllowedValuesMixin):
+class type_8(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
@@ -41924,7 +42078,7 @@ class options_8(Group):
     child_names: list[str]
     relaxation_factor: relaxation_factor
     select_variables: select_variables
-    type: type_7
+    type: type_8
 class high_order_term_relaxation(Group):
     version: str
     fluent_name: str
@@ -46756,7 +46910,7 @@ class color(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
-class weight(Integer):
+class weight_1(Integer):
     version: str
     fluent_name: str
     _python_name: str
@@ -46766,7 +46920,7 @@ class major_gridlines(Group):
     _python_name: str
     child_names: list[str]
     color: color
-    weight: weight
+    weight: weight_1
 class show_minor_gridlines(Boolean):
     version: str
     fluent_name: str
@@ -46777,7 +46931,7 @@ class minor_gridlines(Group):
     _python_name: str
     child_names: list[str]
     color: color
-    weight: weight
+    weight: weight_1
 class x_1(Group):
     version: str
     fluent_name: str
@@ -46824,7 +46978,7 @@ class pattern(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
-class weight_1(Real):
+class weight_2(Real):
     version: str
     fluent_name: str
     _python_name: str
@@ -46838,7 +46992,7 @@ class line(Group):
     _python_name: str
     child_names: list[str]
     pattern: pattern
-    weight: weight_1
+    weight: weight_2
     color: color_1
 class line_in_file(Group):
     version: str
@@ -46846,7 +47000,7 @@ class line_in_file(Group):
     _python_name: str
     child_names: list[str]
     pattern: pattern
-    weight: weight_1
+    weight: weight_2
     color: color_1
 class symbol(String, AllowedValuesMixin):
     version: str
@@ -47648,7 +47802,7 @@ class yplus_ystar(Group):
     max_allowed: max_allowed
     wall_zones: wall_zones
     phase: phase_53
-class type_8(Group):
+class type_9(Group):
     version: str
     fluent_name: str
     _python_name: str
@@ -47712,7 +47866,7 @@ class cell_registers_child(Group):
     command_names: list[str]
     name: name_21
     python_name_1: python_name_1
-    type: type_8
+    type: type_9
     display_options: display_options
     def create_volume_surface(self):
         """
@@ -49047,7 +49201,7 @@ class time_step_count_1(Real):
     version: str
     fluent_name: str
     _python_name: str
-class type_9(String, AllowedValuesMixin):
+class type_10(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
@@ -49406,7 +49560,7 @@ class transient_controls(Group):
     fluent_name: str
     _python_name: str
     child_names: list[str]
-    type: type_9
+    type: type_10
     method: method_10
     duration_specification_method: duration_specification_method
     specified_time_step: specified_time_step
@@ -51571,7 +51725,7 @@ class option_41(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
-class type_10(Group):
+class type_11(Group):
     version: str
     fluent_name: str
     _python_name: str
@@ -51593,7 +51747,7 @@ class automatic(Group):
     _python_name: str
     child_names: list[str]
     option: option_1
-    type: type_10
+    type: type_11
     id: id
     normal: normal_2
     partition: partition
@@ -52833,7 +52987,7 @@ class pattern_1(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
-class weight_2(Real):
+class weight_3(Real):
     version: str
     fluent_name: str
     _python_name: str
@@ -52843,7 +52997,7 @@ class lines_child(Group):
     _python_name: str
     child_names: list[str]
     pattern: pattern_1
-    weight: weight_2
+    weight: weight_3
     color: color_3
 class lines(ListObject[lines_child]):
     version: str
@@ -53856,7 +54010,7 @@ class data_source(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
-class type_11(String, AllowedValuesMixin):
+class type_12(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
@@ -53865,7 +54019,7 @@ class range_options_3(Group):
     fluent_name: str
     _python_name: str
     child_names: list[str]
-    type: type_11
+    type: type_12
     minimum: minimum_3
     maximum: maximum_3
 class color_density(Real):
@@ -55115,6 +55269,18 @@ class show_colormap(Boolean):
     version: str
     fluent_name: str
     _python_name: str
+class line_weight(Real):
+    version: str
+    fluent_name: str
+    _python_name: str
+class marker_size_4(Real):
+    version: str
+    fluent_name: str
+    _python_name: str
+class marker_symbol_1(String, AllowedValuesMixin):
+    version: str
+    fluent_name: str
+    _python_name: str
 class rendering_options(Group):
     version: str
     fluent_name: str
@@ -55130,6 +55296,9 @@ class rendering_options(Group):
     hidden_surfaces: hidden_surfaces
     front_faces_transparent: front_faces_transparent_1
     show_colormap: show_colormap
+    line_weight: line_weight
+    marker_size: marker_size_4
+    marker_symbol: marker_symbol_1
     def device_info(self):
         """
         List information for the graphics device.
@@ -55141,7 +55310,7 @@ class rendering_options(Group):
         Parameters
         ----------
             driver_name : str
-                'driver_name' child.
+                Select new graphics driver.
         """
     def set_rendering_options(self):
         """
@@ -55981,6 +56150,32 @@ class display_6(Group):
             zone_names : List
                 Enter zone name list.
         """
+    def hsf_file(self, filename: str):
+        """
+        Display hoops stream file data to active graphics window.
+        
+        Parameters
+        ----------
+            filename : str
+                Enter HSF file name.
+        """
+    def re_render(self):
+        """
+        Re-render the last contour, profile, or velocity vector plot with updated surfaces, meshes, lights, colormap, rendering options, etc., without recalculating the contour data.
+        """
+    def re_scale(self):
+        """
+        Re-render the last contour, profile, or velocity vector plot with updated scale, surfaces, meshes, lights, colormap, rendering options, etc., without recalculating the field data.
+        """
+    def surface_cells(self, surface_cell_names_ids: list[str]):
+        """
+        Draw the cells on the specified surfaces.
+        
+        Parameters
+        ----------
+            surface_cell_names_ids : List
+                Enter the list of surface names/ids.
+        """
 class texture_name(String, AllowedValuesMixin):
     version: str
     fluent_name: str
@@ -57703,16 +57898,18 @@ class histogram_1(Group):
             sample_file : str
                 Enter the name of a sample file to be loaded.
         """
-    def dpm_sample_contour_plots(self, sample_name: str, interval_size: float | str):
+    def dpm_sample_contour_plots(self, sample_name: str, interval_size: float | str, writing_radial_profile_files_enabled: bool):
         """
         Prepare named expressions from data in a DPM sample file (collected at a cut plane surface) for contour plotting.
         
         Parameters
         ----------
             sample_name : str
-                'sample_name' child.
+                Pick a sample, for which a .dpm sample file of the same name is available, for creating DPM Sample Contour Plots.
             interval_size : real
-                'interval_size' child.
+                Define the spatial resolution of the DPM Sample Contour Plots. Higher resolution (i.e. a smaller interval size) may cause noisy plots and data points representing too few statistical events in the sample file.
+            writing_radial_profile_files_enabled : bool
+                If the plane is (parallel to) a cartesian coordinate plane, instead of producing the Expressions for DPM Sample Contour Plots, calculate radial profiles and write them into .csv data files.
         """
 class output_udf(String, AllowedValuesMixin):
     version: str
@@ -59732,7 +59929,7 @@ class results(Group):
     scene: scene
     animations: animations
     report: report_2
-class type_12(String, AllowedValuesMixin):
+class type_13(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
@@ -59906,7 +60103,7 @@ class definition_1_child(Group):
     _python_name: str
     child_names: list[str]
     name: name_2
-    type: type_12
+    type: type_13
     walls: walls
     vector: vector_2
     center: center_2
@@ -61531,7 +61728,7 @@ class definition_3_child(Group):
     child_names: list[str]
     command_names: list[str]
     name: name_2
-    type: type_12
+    type: type_13
     surfaces: surfaces_17
     imported_surfaces: imported_surfaces
     fit_imported_surfaces: fit_imported_surfaces
@@ -61769,7 +61966,7 @@ class change_as_percentage(Boolean):
     version: str
     fluent_name: str
     _python_name: str
-class weight_3(Real):
+class weight_4(Real):
     version: str
     fluent_name: str
     _python_name: str
@@ -61783,7 +61980,7 @@ class objectives_1_child(Group):
     step_direction: step_direction
     target_change: target_change
     change_as_percentage: change_as_percentage
-    weight: weight_3
+    weight: weight_4
 class objectives_1(NamedObject[objectives_1_child]):
     version: str
     fluent_name: str
@@ -61983,7 +62180,7 @@ class file_name_20(String):
     version: str
     fluent_name: str
     _python_name: str
-class weight_4(Real):
+class weight_5(Real):
     version: str
     fluent_name: str
     _python_name: str
@@ -61999,7 +62196,7 @@ class results_1_child(Group):
     file_name: file_name_20
     observable: observable_2
     value: value_22
-    weight: weight_4
+    weight: weight_5
     expected_change: expected_change
 class results_1(NamedObject[results_1_child]):
     version: str
@@ -62622,7 +62819,7 @@ class design_variables(Group):
         """
         Initialize the design variables with the current values.
         """
-class type_13(String, AllowedValuesMixin):
+class type_14(String, AllowedValuesMixin):
     version: str
     fluent_name: str
     _python_name: str
@@ -62795,7 +62992,7 @@ class model_6(Group):
     _python_name: str
     child_names: list[str]
     command_names: list[str]
-    type: type_13
+    type: type_14
     settings: settings_34
     offline_training: offline_training
     management: management