ansys-fluent-core 0.14.dev0__py3-none-any.whl → 0.14.dev2__py3-none-any.whl

ansys/fluent/core/solver/flobject.py

@@ -16,6 +16,7 @@ r.setup.models.energy.enabled = True
 r.boundary_conditions.velocity_inlet['inlet'].vmag.constant = 20
 """
 import collections
+import fnmatch
 import hashlib
 import importlib
 import keyword
@@ -534,7 +535,7 @@ class WildcardPath(Group):
     """Class wrapping a wildcard path to perform get_var and set_var on
     flproxy."""
 
-    def __init__(self, flproxy, path: str, state_cls, settings_cls):
+    def __init__(self, flproxy, path: str, state_cls, settings_cls, parent):
         """__init__ of WildcardPath class."""
         self._setattr("_flproxy", flproxy)
         self._setattr("_path", path)
@@ -546,6 +547,7 @@ class WildcardPath(Group):
         # _settings_cls is the settings cls at the wildcard path level. It is used to
         # construct the scheme path for children.
         self._setattr("_settings_cls", settings_cls)
+        self._setattr("_parent", parent)
 
     @property
     def flproxy(self):
@@ -571,6 +573,7 @@ class WildcardPath(Group):
                 self.path + "/" + scheme_name,
                 self._state_cls,
                 child_settings_cls,
+                self,
             )
         raise KeyError(
             allowed_name_error_message(
@@ -578,6 +581,17 @@ class WildcardPath(Group):
             )
         )
 
+    def items(self):
+        """Items."""
+        for key, value in self._parent.items():
+            if fnmatch.fnmatch(key, self._path.rsplit(sep="/", maxsplit=1)[-1]):
+                yield key, value
+
+    def __iter__(self):
+        for item in self._parent:
+            if fnmatch.fnmatch(item, self._path.rsplit(sep="/", maxsplit=1)[-1]):
+                yield item
+
     def to_scheme_keys(self, value):
         """Convert value to have keys with scheme names."""
         return self._state_cls.to_scheme_keys(value)
@@ -597,6 +611,7 @@ class NamedObjectWildcardPath(WildcardPath):
             self.path + "/" + name,
             self._state_cls,
             self._settings_cls.child_object_type,
+            self,
         )
 
     def __setitem__(self, name, value):
@@ -731,7 +746,11 @@ class NamedObject(SettingsBase[DictStateType], Generic[ChildTypeT]):
             if self.flproxy.has_wildcard(name):
                 child_cls = self.__class__.child_object_type
                 return WildcardPath(
-                    self.flproxy, self.path + "/" + name, self.__class__, child_cls
+                    self.flproxy,
+                    self.path + "/" + name,
+                    self.__class__,
+                    child_cls,
+                    self,
                 )
             raise KeyError(
                 allowed_name_error_message(
@@ -1214,3 +1233,41 @@ def get_root(flproxy, version: str = "") -> Group:
     root.set_flproxy(flproxy)
     root._setattr("_static_info", obj_info)
     return root
+
+
+def find_children(obj, identifier="*"):
+    """Returns path of all the child objects matching an identifier.
+
+    Parameters
+    ----------
+    obj: Object
+        Object whose children need to be queried.
+    identifier: str
+        Identifier to find specific children.
+
+    Returns
+    -------
+    List
+    """
+    list_of_children = []
+    _list_children(obj.__class__, identifier, [], list_of_children)
+    return list_of_children
+
+
+def _list_children(cls, identifier, path, list_of_children):
+    if issubclass(cls, (NamedObject, ListObject)):
+        if hasattr(cls.child_object_type, "child_names"):
+            _get_child_path(cls.child_object_type, path, identifier, list_of_children)
+    if issubclass(cls, Group):
+        _get_child_path(cls, path, identifier, list_of_children)
+
+
+def _get_child_path(cls, path, identifier, list_of_children):
+    for name in cls.child_names:
+        path.append(name)
+        if fnmatch.fnmatch(name, identifier):
+            path_to_append = "/".join(path)
+            if path_to_append not in list_of_children:
+                list_of_children.append(path_to_append)
+        _list_children(getattr(cls, name), identifier, path, list_of_children)
+        path.pop()

ansys/fluent/core/solver/settings_222/change_type.py

@@ -18,7 +18,7 @@ class change_type(Command):
     
     Parameters
     ----------
-        zone_list : List
+        zone_list : typing.List[str]
             'zone_list' child.
         new_type : str
             'new_type' child.

ansys/fluent/core/solver/settings_222/clear_generated_data.py

@@ -17,7 +17,7 @@ class clear_generated_data(Command):
     
     Parameters
     ----------
-        design_points : List
+        design_points : typing.List[str]
             'design_points' child.
     
     """

ansys/fluent/core/solver/settings_222/compute_2.py

@@ -17,7 +17,7 @@ class compute(Command):
     
     Parameters
     ----------
-        report_defs : List
+        report_defs : typing.List[str]
             'report_defs' child.
     
     """

ansys/fluent/core/solver/settings_222/delete_design_points.py

@@ -17,7 +17,7 @@ class delete_design_points(Command):
     
     Parameters
     ----------
-        design_points : List
+        design_points : typing.List[str]
             'design_points' child.
     
     """

ansys/fluent/core/solver/settings_222/position_1.py

@@ -17,7 +17,7 @@ class position(Command):
     
     Parameters
     ----------
-        xyz : List
+        xyz : typing.List[real]
             'xyz' child.
     
     """

ansys/fluent/core/solver/settings_222/setup_unsteady_statistics.py

@@ -17,7 +17,7 @@ class setup_unsteady_statistics(Command):
     
     Parameters
     ----------
-        udf_cf_names : List
+        udf_cf_names : typing.List[str]
             'udf_cf_names' child.
     
     """

ansys/fluent/core/solver/settings_222/target.py

@@ -17,7 +17,7 @@ class target(Command):
     
     Parameters
     ----------
-        xyz : List
+        xyz : typing.List[real]
             'xyz' child.
     
     """

ansys/fluent/core/solver/settings_222/up_vector.py

@@ -17,7 +17,7 @@ class up_vector(Command):
     
     Parameters
     ----------
-        xyz : List
+        xyz : typing.List[real]
             'xyz' child.
     
     """

ansys/fluent/core/solver/settings_222/update_selected.py

@@ -17,7 +17,7 @@ class update_selected(Command):
     
     Parameters
     ----------
-        design_points : List
+        design_points : typing.List[str]
             'design_points' child.
     
     """

ansys/fluent/core/solver/settings_222/write_1.py

@@ -20,7 +20,7 @@ class write(Command):
     ----------
         file_name : str
             'file_name' child.
-        state_name : List
+        state_name : typing.List[str]
             'state_name' child.
     
     """

ansys/fluent/core/solver/settings_222/write_views.py

@@ -20,7 +20,7 @@ class write_views(Command):
     ----------
         file_name : str
             'file_name' child.
-        view_list : List
+        view_list : typing.List[str]
             'view_list' child.
     
     """

ansys/fluent/core/solver/settings_231/abaqus.py

@@ -23,13 +23,13 @@ class abaqus(Command):
     ----------
         name : str
             'name' child.
-        surface_name_list : List
+        surface_name_list : typing.List[str]
             'surface_name_list' child.
         structural_analysis : bool
             'structural_analysis' child.
         write_loads : bool
             'write_loads' child.
-        loads : List
+        loads : typing.List[str]
             'loads' child.
     
     """

ansys/fluent/core/solver/settings_231/activate_cell_zone.py

@@ -17,7 +17,7 @@ class activate_cell_zone(Command):
     
     Parameters
     ----------
-        cell_zone_list : List
+        cell_zone_list : typing.List[str]
             'cell_zone_list' child.
     
     """

ansys/fluent/core/solver/settings_231/calculate_patch.py

@@ -26,9 +26,9 @@ class calculate_patch(Command):
     ----------
         domain : str
             'domain' child.
-        cell_zones : List
+        cell_zones : typing.List[str]
             'cell_zones' child.
-        register_id : List
+        register_id : typing.List[str]
             'register_id' child.
         variable : str
             'variable' child.

ansys/fluent/core/solver/settings_231/change_type.py

@@ -18,7 +18,7 @@ class change_type(Command):
     
     Parameters
     ----------
-        zone_list : List
+        zone_list : typing.List[str]
             'zone_list' child.
         new_type : str
             'new_type' child.

ansys/fluent/core/solver/settings_231/clear_generated_data.py

@@ -17,7 +17,7 @@ class clear_generated_data(Command):
     
     Parameters
     ----------
-        design_points : List
+        design_points : typing.List[str]
             'design_points' child.
     
     """

ansys/fluent/core/solver/settings_231/compute_1.py

@@ -17,7 +17,7 @@ class compute(Command):
     
     Parameters
     ----------
-        report_defs : List
+        report_defs : typing.List[str]
             'report_defs' child.
     
     """

ansys/fluent/core/solver/settings_231/convert_skewed_cells_1.py

@@ -19,7 +19,7 @@ class convert_skewed_cells(Command):
     
     Parameters
     ----------
-        cell_thread_list : List
+        cell_thread_list : typing.List[str]
             Set zones where cells should be converted.
         max_cell_skewness : real
             Set target maximum cell skewness.

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

@@ -23,7 +23,7 @@ class custom_heat_flux(Command):
             'name' child.
         wall_function : bool
             'wall_function' child.
-        surface_name_list : List
+        surface_name_list : typing.List[str]
             'surface_name_list' child.
     
     """

ansys/fluent/core/solver/settings_231/customize_fmg_initialization.py

@@ -21,9 +21,9 @@ class customize_fmg_initialization(Command):
     ----------
         multi_level_grid : int
             'multi_level_grid' child.
-        residual_reduction_level : List
+        residual_reduction_level : typing.List[real]
             'residual_reduction_level' child.
-        cycle_count : List
+        cycle_count : typing.List[real]
             'cycle_count' child.
     
     """

ansys/fluent/core/solver/settings_231/delete_design_points.py

@@ -17,7 +17,7 @@ class delete_design_points(Command):
     
     Parameters
     ----------
-        design_points : List
+        design_points : typing.List[str]
             'design_points' child.
     
     """

ansys/fluent/core/solver/settings_231/export_1.py

@@ -18,7 +18,7 @@ class export(Command):
     
     Parameters
     ----------
-        command_name : List
+        command_name : typing.List[str]
             'command_name' child.
         tsv_file_name : str
             'tsv_file_name' child.

ansys/fluent/core/solver/settings_231/export_modifications.py

@@ -18,7 +18,7 @@ class export_modifications(Command):
     
     Parameters
     ----------
-        command_list : List
+        command_list : typing.List[str]
             'command_list' child.
         filename : str
             'filename' child.

ansys/fluent/core/solver/settings_231/film_heat_transfer.py

@@ -27,7 +27,7 @@ class film_heat_transfer(Command):
             'domain_val' child.
         all_bndry_zones : bool
             Select all the boundary/interior zones.
-        zone_list : List
+        zone_list : typing.List[str]
             'zone_list' child.
         write_to_file : bool
             'write_to_file' child.

ansys/fluent/core/solver/settings_231/film_mass_flow.py

@@ -27,7 +27,7 @@ class film_mass_flow(Command):
             'domain_val' child.
         all_bndry_zones : bool
             Select all the boundary/interior zones.
-        zone_list : List
+        zone_list : typing.List[str]
             'zone_list' child.
         write_to_file : bool
             'write_to_file' child.

ansys/fluent/core/solver/settings_231/forces.py

@@ -35,13 +35,13 @@ class forces(Command):
             'domain_val' child.
         all_wall_zones : bool
             Select all wall zones available.
-        wall_thread_list : List
+        wall_thread_list : typing.List[str]
             'wall_thread_list' child.
-        direction_vector : Tuple
+        direction_vector : typing.Tuple[real, real, real]
             'direction_vector' child.
-        momentum_center : Tuple
+        momentum_center : typing.Tuple[real, real, real]
             'momentum_center' child.
-        momentum_axis : Tuple
+        momentum_axis : typing.Tuple[real, real, real]
             'momentum_axis' child.
         pressure_coordinate : str
             'pressure_coordinate' child.

ansys/fluent/core/solver/settings_231/heat_transfer_1.py

@@ -27,7 +27,7 @@ class heat_transfer(Command):
             'domain_val' child.
         all_bndry_zones : bool
             Select all the boundary/interior zones.
-        zone_list : List
+        zone_list : typing.List[str]
             'zone_list' child.
         write_to_file : bool
             'write_to_file' child.

ansys/fluent/core/solver/settings_231/heat_transfer_sensible.py

@@ -27,7 +27,7 @@ class heat_transfer_sensible(Command):
             'domain_val' child.
         all_bndry_zones : bool
             Select all the boundary/interior zones.
-        zone_list : List
+        zone_list : typing.List[str]
             'zone_list' child.
         write_to_file : bool
             'write_to_file' child.

ansys/fluent/core/solver/settings_231/mass_flow_1.py

@@ -27,7 +27,7 @@ class mass_flow(Command):
             'domain_val' child.
         all_bndry_zones : bool
             Select all the boundary/interior zones.
-        zone_list : List
+        zone_list : typing.List[str]
             'zone_list' child.
         write_to_file : bool
             'write_to_file' child.

ansys/fluent/core/solver/settings_231/mechanical_apdl.py

@@ -20,7 +20,7 @@ class mechanical_apdl(Command):
     ----------
         name : str
             'name' child.
-        thread_name_list : List
+        thread_name_list : typing.List[str]
             'thread_name_list' child.
     
     """

ansys/fluent/core/solver/settings_231/mechanical_apdl_input.py

@@ -23,13 +23,13 @@ class mechanical_apdl_input(Command):
     ----------
         name : str
             'name' child.
-        surface_name_list : List
+        surface_name_list : typing.List[str]
             'surface_name_list' child.
         structural_analysis : bool
             'structural_analysis' child.
         write_loads : bool
             'write_loads' child.
-        loads : List
+        loads : typing.List[str]
             'loads' child.
     
     """

ansys/fluent/core/solver/settings_231/modified_setting.py

@@ -17,7 +17,7 @@ class modified_setting(Command):
     
     Parameters
     ----------
-        setting_type : List
+        setting_type : typing.List[str]
             'setting_type' child.
     
     """

ansys/fluent/core/solver/settings_231/moments.py

@@ -22,9 +22,9 @@ class moments(Command):
     
     Parameters
     ----------
-        surface_list : List
+        surface_list : typing.List[str]
             'surface_list' child.
-        volume_list : List
+        volume_list : typing.List[str]
             'volume_list' child.
         num_of_moments : int
             'num_of_moments' child.

ansys/fluent/core/solver/settings_231/number_density.py

@@ -34,9 +34,9 @@ class number_density(Command):
             'qmom_output_type' child.
         smm_output_type : str
             'smm_output_type' child.
-        surface_list : List
+        surface_list : typing.List[str]
             'surface_list' child.
-        volume_list : List
+        volume_list : typing.List[str]
             'volume_list' child.
         num_dens_func : str
             'num_dens_func' child.

ansys/fluent/core/solver/settings_231/particle_summary.py

@@ -17,7 +17,7 @@ class particle_summary(Command):
     
     Parameters
     ----------
-        injection_names : List
+        injection_names : typing.List[str]
             'injection_names' child.
     
     """

ansys/fluent/core/solver/settings_231/position_1.py

@@ -17,7 +17,7 @@ class position(Command):
     
     Parameters
     ----------
-        xyz : List
+        xyz : typing.List[real]
             'xyz' child.
     
     """

ansys/fluent/core/solver/settings_231/pressure_work_1.py

@@ -27,7 +27,7 @@ class pressure_work(Command):
             'domain_val' child.
         all_bndry_zones : bool
             Select all the boundary/interior zones.
-        zone_list : List
+        zone_list : typing.List[str]
             'zone_list' child.
         write_to_file : bool
             'write_to_file' child.

ansys/fluent/core/solver/settings_231/print_histogram.py

@@ -37,7 +37,7 @@ class print_histogram(Command):
             'num_division' child.
         set_all_zones : bool
             'set_all_zones' child.
-        threads_list : List
+        threads_list : typing.List[str]
             'threads_list' child.
         file_name : str
             'file_name' child.

ansys/fluent/core/solver/settings_231/projected_surface_area.py

@@ -19,11 +19,11 @@ class projected_surface_area(Command):
     
     Parameters
     ----------
-        surface_id_val : List
+        surface_id_val : typing.List[int]
             'surface_id_val' child.
         min_feature_size : real
             'min_feature_size' child.
-        proj_plane_norm_comp : Tuple
+        proj_plane_norm_comp : typing.Tuple[real, real, real]
             'proj_plane_norm_comp' child.
     
     """

ansys/fluent/core/solver/settings_231/rad_heat_trans.py

@@ -27,7 +27,7 @@ class rad_heat_trans(Command):
             'domain_val' child.
         all_bndry_zones : bool
             Select all the boundary/interior zones.
-        zone_list : List
+        zone_list : typing.List[str]
             'zone_list' child.
         write_to_file : bool
             'write_to_file' child.

ansys/fluent/core/solver/settings_231/read_journal.py

@@ -17,7 +17,7 @@ class read_journal(Command):
     
     Parameters
     ----------
-        file_name_list : List
+        file_name_list : typing.List[str]
             'file_name_list' child.
     
     """

ansys/fluent/core/solver/settings_231/rotate.py

@@ -21,9 +21,9 @@ class rotate(Command):
     ----------
         angle : real
             'angle' child.
-        origin : Tuple
+        origin : typing.Tuple[real, real, real]
             'origin' child.
-        axis_components : Tuple
+        axis_components : typing.Tuple[real, real, real]
             'axis_components' child.
     
     """

ansys/fluent/core/solver/settings_231/sample_1.py

@@ -23,13 +23,13 @@ class sample(Command):
     
     Parameters
     ----------
-        injections : List
+        injections : typing.List[str]
             'injections' child.
-        boundaries : List
+        boundaries : typing.List[str]
             'boundaries' child.
-        lines : List
+        lines : typing.List[str]
             'lines' child.
-        planes : List
+        planes : typing.List[str]
             'planes' child.
         op_udf : str
             'op_udf' child.

ansys/fluent/core/solver/settings_231/set_ambient_color.py

@@ -17,7 +17,7 @@ class set_ambient_color(Command):
     
     Parameters
     ----------
-        rgb_vector : Tuple
+        rgb_vector : typing.Tuple[real, real, real]
             'rgb_vector' child.
     
     """

ansys/fluent/core/solver/settings_231/set_light.py

@@ -26,13 +26,13 @@ class set_light(Command):
             'light_number' child.
         light_on : bool
             'light_on' child.
-        rgb_vector : Tuple
+        rgb_vector : typing.Tuple[real, real, real]
             'rgb_vector' child.
         use_view_factor : bool
             'use_view_factor' child.
         change_light_direction : bool
             'change_light_direction' child.
-        direction_vector : Tuple
+        direction_vector : typing.Tuple[real, real, real]
             'direction_vector' child.
     
     """

ansys/fluent/core/solver/settings_231/setup_unsteady_statistics.py

@@ -17,7 +17,7 @@ class setup_unsteady_statistics(Command):
     
     Parameters
     ----------
-        udf_cf_names : List
+        udf_cf_names : typing.List[str]
             'udf_cf_names' child.
     
     """

ansys/fluent/core/solver/settings_231/surface_integrals.py

@@ -36,7 +36,7 @@ class surface_integrals(Command):
     ----------
         report_type : str
             'report_type' child.
-        surface_id : List
+        surface_id : typing.List[str]
             'surface_id' child.
         add_custome_vector : bool
             'add_custome_vector' child.