ansys-fluent-core 0.20.dev8__py3-none-any.whl → 0.20.dev9__py3-none-any.whl

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

@@ -15,7 +15,7 @@ from ansys.fluent.core.solver.flobject import (
 )
 
 from .zone_name_7 import zone_name as zone_name_cls
-from .value_8 import value as value_cls
+from .value_9 import value as value_cls
 class contact_resistance_child(Group):
     """
     'child_object_type' of contact_resistance.

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

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class continuity_order(Integer):
+    """
+    Uniform continuity order.
+    """
+
+    fluent_name = "continuity-order"
+

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

@@ -14,7 +14,7 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .name_5 import name as name_cls
+from .name_7 import name as name_cls
 from .field import field as field_cls
 from .filled import filled as filled_cls
 from .boundary_values import boundary_values as boundary_values_cls

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

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 from .auto_scale_2 import auto_scale as auto_scale_cls
 from .clip_to_range_2 import clip_to_range as clip_to_range_cls
-from .surfaces_7 import surfaces as surfaces_cls
+from .surfaces_10 import surfaces as surfaces_cls
 from .filled_contours import filled_contours as filled_contours_cls
 from .global_range_1 import global_range as global_range_cls
 from .line_contours import line_contours as line_contours_cls

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

@@ -20,7 +20,7 @@ from .condition import condition as condition_cls
 from .check_for import check_for as check_for_cls
 class convergence_conditions(Group):
     """
-    'convergence_conditions' child.
+    Available options that allow you to set convergence conditions on the solution based on the values from report definitions. For example, surface, volume, lift, drag, and so on.
     """
 
     fluent_name = "convergence-conditions"

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

@@ -23,7 +23,7 @@ from .convergence_reports_child import convergence_reports_child
 
 class convergence_reports(NamedObject[convergence_reports_child], _CreatableNamedObjectMixin[convergence_reports_child]):
     """
-    'convergence_reports' child.
+    Available options related to creating convergence reports.
     """
 
     fluent_name = "convergence-reports"

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

@@ -14,12 +14,12 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .name_4 import name as name_cls
+from .name_6 import name as name_cls
 from .previous_values_to_consider import previous_values_to_consider as previous_values_to_consider_cls
 from .initial_values_to_ignore import initial_values_to_ignore as initial_values_to_ignore_cls
 from .iteration_at_creation_or_edit import iteration_at_creation_or_edit as iteration_at_creation_or_edit_cls
 from .stop_criterion import stop_criterion as stop_criterion_cls
-from .report_defs_1 import report_defs as report_defs_cls
+from .report_defs_2 import report_defs as report_defs_cls
 from .print_3 import print as print_cls
 from .plot_3 import plot as plot_cls
 from .cov import cov as cov_cls

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

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class coordinate(String, _HasAllowedValuesMixin):
+    """
+    Select the co-ordinate-system.
+    """
+
+    fluent_name = "coordinate"
+

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

@@ -0,0 +1,35 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+from .origin_3 import origin as origin_cls
+from .axis_4 import axis as axis_cls
+from .radial_2 import radial as radial_cls
+class coordinate_system(Group):
+    """
+    Design tool cylindrical frame of reference menu.
+    """
+
+    fluent_name = "coordinate-system"
+
+    child_names = \
+        ['origin', 'axis', 'radial']
+
+    _child_classes = dict(
+        origin=origin_cls,
+        axis=axis_cls,
+        radial=radial_cls,
+    )
+

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

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class coordinate_value(Real):
     """
-    'coordinate_value' child.
+    Specify the coordinate value.
     """
 
     fluent_name = "coordinate-value"

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

@@ -18,14 +18,14 @@ from .copy_from import copy_from as copy_from_cls
 from .copy_to import copy_to as copy_to_cls
 class copy(Command):
     """
-    'copy' command.
+    Create a copy of a report definition.
     
     Parameters
     ----------
         copy_from : str
-            'copy_from' child.
+            Select the report definition to copy.
         copy_to : str
-            'copy_to' child.
+            Write the new name for the copied report definition.
     
     """
 

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

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class copy_from(String, _HasAllowedValuesMixin):
     """
-    'copy_from' child.
+    Select the report definition to copy.
     """
 
     fluent_name = "copy-from"

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

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class copy_to(String):
     """
-    'copy_to' child.
+    Write the new name for the copied report definition.
     """
 
     fluent_name = "copy-to"

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

@@ -14,18 +14,18 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .surfaces_5 import surfaces as surfaces_cls
-from .name_4 import name as name_cls
+from .surfaces_8 import surfaces as surfaces_cls
+from .name_10 import name as name_cls
 class create_group_surfaces(Command):
     """
-    'create_group_surfaces' command.
+    Create a group of surfaces.
     
     Parameters
     ----------
         surfaces : typing.List[str]
             Select list of surfaces.
         name : str
-            'name' child.
+            Specify the name for the group surface.
     
     """
 

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

@@ -15,38 +15,38 @@ from ansys.fluent.core.solver.flobject import (
 )
 
 from .field_1 import field as field_cls
-from .name_4 import name as name_cls
-from .surfaces import surfaces as surfaces_cls
-from .zones_4 import zones as zones_cls
-from .min_4 import min as min_cls
-from .max_4 import max as max_cls
+from .name_9 import name as name_cls
+from .surfaces_5 import surfaces as surfaces_cls
+from .zones_6 import zones as zones_cls
+from .min_5 import min as min_cls
+from .max_5 import max as max_cls
 from .iso_value import iso_value as iso_value_cls
 from .no_of_surfaces import no_of_surfaces as no_of_surfaces_cls
 from .spacing import spacing as spacing_cls
 class create_multiple_iso_surfaces(Command):
     """
-    'create_multiple_iso_surfaces' command.
+    Provides access to creating new and editing multiple iso-surfaces.
     
     Parameters
     ----------
         field : str
-            Specify Field.
+            Select the field variable.
         name : str
-            'name' child.
+            Specify the Iso-surface name.
         surfaces : typing.List[str]
-            Select surface.
+            Select the surface(s) that will be used to define the iso-surface.
         zones : typing.List[str]
-            Enter cell zone name list.
+            Select the zone(s) that will be used to define the iso-surface.
         min : real
             Set min.
         max : real
             Set max.
         iso_value : real
-            'iso_value' child.
+            Specify the iso-value.
         no_of_surfaces : int
-            'no_of_surfaces' child.
+            Specify the number of surfaces to be created.
         spacing : real
-            'spacing' child.
+            Specify the spacing.
     
     """
 

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

@@ -0,0 +1,104 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+from .method_11 import method as method_cls
+from .name_format import name_format as name_format_cls
+from .x_3 import x as x_cls
+from .y_3 import y as y_cls
+from .z_3 import z as z_cls
+from .point_1 import point as point_cls
+from .normal_computation_method import normal_computation_method as normal_computation_method_cls
+from .surface_aligned_normal import surface_aligned_normal as surface_aligned_normal_cls
+from .normal import normal as normal_cls
+from .p0_1 import p0 as p0_cls
+from .p1_1 import p1 as p1_cls
+from .p2 import p2 as p2_cls
+from .bounded import bounded as bounded_cls
+from .sample_points import sample_points as sample_points_cls
+from .edges import edges as edges_cls
+from .surfaces_7 import surfaces as surfaces_cls
+from .spacing import spacing as spacing_cls
+class create_multiple_plane_surfaces(Command):
+    """
+    Specify the attributes of plane surface.
+    
+    Parameters
+    ----------
+        method : str
+            Select the method you want to use to create the plane surface. The required inputs vary by method.
+        name_format : str
+            Specify the Name Format.
+        x : real
+            Specify the location on the X-axis where the YZ plane will be created.
+        y : real
+            Specify the location on the Y-axis where the ZX plane will be created.
+        z : real
+            Specify the location on the Z-axis where the XY plane will be created.
+        point : typing.List[real]
+            Specify the XYZ coordinates of the point.
+        normal_computation_method : str
+            Specify the normal computation method.
+        surface_aligned_normal : str
+            Select the surface you want to compute the normal components.
+        normal : typing.List[real]
+            Specify the XYZ components of the normal.
+        p0 : typing.List[real]
+            Specify the XYZ coordinates of Point 1 for the Three Points plane creation method.
+        p1 : typing.List[real]
+            Specify the XYZ coordinates of Point 2 for the Three Points plane creation method.
+        p2 : typing.List[real]
+            Specify the XYZ coordinates of Point 3 for the Three Points plane creation method.
+        bounded : bool
+            Choose whether or not the plane is bounded by its defining points.
+        sample_points : bool
+            Choose whether or not you want to specify a uniform distribution of points on the plane.
+        edges : typing.List[int]
+            Specify the point density for edges.
+        surfaces : int
+            Specify the number of surfaces.
+        spacing : real
+            Specify the spacing.
+    
+    """
+
+    fluent_name = "create-multiple-plane-surfaces"
+
+    argument_names = \
+        ['method', 'name_format', 'x', 'y', 'z', 'point',
+         'normal_computation_method', 'surface_aligned_normal', 'normal',
+         'p0', 'p1', 'p2', 'bounded', 'sample_points', 'edges', 'surfaces',
+         'spacing']
+
+    _child_classes = dict(
+        method=method_cls,
+        name_format=name_format_cls,
+        x=x_cls,
+        y=y_cls,
+        z=z_cls,
+        point=point_cls,
+        normal_computation_method=normal_computation_method_cls,
+        surface_aligned_normal=surface_aligned_normal_cls,
+        normal=normal_cls,
+        p0=p0_cls,
+        p1=p1_cls,
+        p2=p2_cls,
+        bounded=bounded_cls,
+        sample_points=sample_points_cls,
+        edges=edges_cls,
+        surfaces=surfaces_cls,
+        spacing=spacing_cls,
+    )
+

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

@@ -17,7 +17,7 @@ from ansys.fluent.core.solver.flobject import (
 from .zone_names_4 import zone_names as zone_names_cls
 class create_multiple_zone_surfaces(Command):
     """
-    'create_multiple_zone_surfaces' command.
+    Provides access to creating new and editing multiple zone surfaces.
     
     Parameters
     ----------

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

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class create_output_parameter(Command):
     """
-    'create_output_parameter' command.
+    Option to make report definition available as an output parameter.
     """
 
     fluent_name = "create-output-parameter"

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

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class create_zones_from_ccl(Boolean):
     """
-    'create_zones_from_ccl' child.
+    Choose whether or not to create zones from the physics data objects.
     """
 
     fluent_name = "create-zones-from-ccl?"

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

@@ -14,8 +14,8 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option_9 import option as option_cls
-from .value_10 import value as value_cls
+from .option_10 import option as option_cls
+from .value_11 import value as value_cls
 class critical_pressure(Group):
     """
     'critical_pressure' child.

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

@@ -14,8 +14,8 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option_9 import option as option_cls
-from .value_10 import value as value_cls
+from .option_10 import option as option_cls
+from .value_11 import value as value_cls
 class critical_temperature(Group):
     """
     'critical_temperature' child.

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

@@ -14,8 +14,8 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option_9 import option as option_cls
-from .value_10 import value as value_cls
+from .option_10 import option as option_cls
+from .value_11 import value as value_cls
 class critical_volume(Group):
     """
     'critical_volume' child.

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

@@ -14,7 +14,7 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option import option as option_cls
+from .option_1 import option as option_cls
 from .zero_shear_viscosity import zero_shear_viscosity as zero_shear_viscosity_cls
 from .power_law_index import power_law_index as power_law_index_cls
 from .time_constant import time_constant as time_constant_cls

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

@@ -14,8 +14,8 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .name_4 import name as name_cls
-from .option import option as option_cls
+from .name_6 import name as name_cls
+from .option_1 import option as option_cls
 from .zones_2 import zones as zones_cls
 from .split_direction import split_direction as split_direction_cls
 from .number_of_divisions import number_of_divisions as number_of_divisions_cls

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

@@ -14,7 +14,7 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option_10 import option as option_cls
+from .option_11 import option as option_cls
 from .value_12 import value as value_cls
 from .profile_name import profile_name as profile_name_cls
 from .field_name import field_name as field_name_cls

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

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class current_domain(String, _HasAllowedValuesMixin):
     """
-    'current_domain' child.
+    Select the domain.
     """
 
     fluent_name = "current-domain"

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

@@ -14,7 +14,7 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .origin_1 import origin as origin_cls
+from .origin_2 import origin as origin_cls
 from .x_axis_1 import x_axis as x_axis_cls
 from .y_axis_1 import y_axis as y_axis_cls
 from .z_axis_1 import z_axis as z_axis_cls

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

@@ -14,7 +14,7 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option import option as option_cls
+from .option_1 import option as option_cls
 from .default import default as default_cls
 from .reverse import reverse as reverse_cls
 class curve_length(Group):

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

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class cust_vec_func(String, _HasAllowedValuesMixin):
     """
-    'cust_vec_func' child.
+    Specify the custom vectors.
     """
 
     fluent_name = "cust-vec-func"

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

@@ -23,7 +23,7 @@ from .custom_child import custom_child
 
 class custom(NamedObject[custom_child], _CreatableNamedObjectMixin[custom_child]):
     """
-    'custom' child.
+    Create a new or edit an existing report definition.
     """
 
     fluent_name = "custom"

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

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 from .file_name_1 import file_name as file_name_cls
 from .wall_function import wall_function as wall_function_cls
-from .surface_name_list import surface_name_list as surface_name_list_cls
+from .surface_name_list_2 import surface_name_list as surface_name_list_cls
 class custom_heat_flux(Command):
     """
     Write a generic file for heat transfer.
@@ -24,11 +24,11 @@ class custom_heat_flux(Command):
     Parameters
     ----------
         file_name : str
-            'file_name' child.
+            Enter the desired file name to export.
         wall_function : bool
-            'wall_function' child.
+            Choose whether or not to include the wall function.
         surface_name_list : typing.List[str]
-            Select surface.
+            Select the list of surfaces to export.
     
     """
 

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

@@ -14,11 +14,17 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .row_number import row_number as row_number_cls
+from .interp_method import interp_method as interp_method_cls
+from .z_value import z_value as z_value_cls
 from .column_number import column_number as column_number_cls
-from .row_value import row_value as row_value_cls
+from .row_number import row_number as row_number_cls
 from .column_value import column_value as column_value_cls
+from .row_value import row_value as row_value_cls
 from .table_value import table_value as table_value_cls
+from .z_label import z_label as z_label_cls
+from .column_label import column_label as column_label_cls
+from .row_label import row_label as row_label_cls
+from .table_label import table_label as table_label_cls
 from .write_table import write_table as write_table_cls
 from .read_table import read_table as read_table_cls
 from .print_table import print_table as print_table_cls
@@ -30,18 +36,25 @@ class cycle_life_table(Group):
     fluent_name = "cycle-life-table"
 
     child_names = \
-        ['row_number', 'column_number', 'row_value', 'column_value',
-         'table_value']
+        ['interp_method', 'z_value', 'column_number', 'row_number',
+         'column_value', 'row_value', 'table_value', 'z_label',
+         'column_label', 'row_label', 'table_label']
 
     command_names = \
         ['write_table', 'read_table', 'print_table']
 
     _child_classes = dict(
-        row_number=row_number_cls,
+        interp_method=interp_method_cls,
+        z_value=z_value_cls,
         column_number=column_number_cls,
-        row_value=row_value_cls,
+        row_number=row_number_cls,
         column_value=column_value_cls,
+        row_value=row_value_cls,
         table_value=table_value_cls,
+        z_label=z_label_cls,
+        column_label=column_label_cls,
+        row_label=row_label_cls,
+        table_label=table_label_cls,
         write_table=write_table_cls,
         read_table=read_table_cls,
         print_table=print_table_cls,

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

@@ -0,0 +1,35 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+from .coordinate_system_1 import coordinate_system as coordinate_system_cls
+from .extent_1 import extent as extent_cls
+from .conditions import conditions as conditions_cls
+class cylindrical(Group):
+    """
+    Design tool cartesian region menu.
+    """
+
+    fluent_name = "cylindrical"
+
+    child_names = \
+        ['coordinate_system', 'extent', 'conditions']
+
+    _child_classes = dict(
+        coordinate_system=coordinate_system_cls,
+        extent=extent_cls,
+        conditions=conditions_cls,
+    )
+

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

@@ -14,7 +14,7 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option_10 import option as option_cls
+from .option_11 import option as option_cls
 from .value_12 import value as value_cls
 from .profile_name import profile_name as profile_name_cls
 from .field_name import field_name as field_name_cls