ansys-fluent-core 0.27.dev1__py3-none-any.whl → 0.28.dev0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of ansys-fluent-core might be problematic. Click here for more details.
- ansys/fluent/core/__init__.py +22 -9
- ansys/fluent/core/_version.py +5 -2
- ansys/fluent/core/codegen/__init__.py +0 -3
- ansys/fluent/core/codegen/allapigen.py +1 -5
- ansys/fluent/core/codegen/builtin_settingsgen.py +44 -10
- ansys/fluent/core/codegen/datamodelgen.py +53 -12
- ansys/fluent/core/codegen/settingsgen.py +21 -12
- ansys/fluent/core/codegen/settingsgen_old.py +2 -2
- ansys/fluent/core/codegen/tuigen.py +1 -1
- ansys/fluent/core/codegen/write_settings_yaml.py +3 -4
- ansys/fluent/core/data_model_cache.py +132 -70
- ansys/fluent/core/docs/README.rst +2 -2
- ansys/fluent/core/examples/downloads.py +3 -5
- ansys/fluent/core/exceptions.py +1 -0
- ansys/fluent/core/file_session.py +59 -131
- ansys/fluent/core/filereader/case_file.py +17 -17
- ansys/fluent/core/filereader/casereader.py +2 -1
- ansys/fluent/core/filereader/data_file.py +7 -7
- ansys/fluent/core/filereader/lispy.py +6 -1
- ansys/fluent/core/fluent_connection.py +35 -7
- ansys/fluent/core/generated/api_tree/api_objects.json +1 -1
- ansys/fluent/core/generated/datamodel_222/PMFileManagement.py +2 -2
- ansys/fluent/core/generated/datamodel_222/PartManagement.py +28 -28
- ansys/fluent/core/generated/datamodel_222/meshing.py +301 -301
- ansys/fluent/core/generated/datamodel_222/workflow.py +9 -9
- ansys/fluent/core/generated/datamodel_231/PMFileManagement.py +2 -2
- ansys/fluent/core/generated/datamodel_231/PartManagement.py +55 -55
- ansys/fluent/core/generated/datamodel_231/flicing.py +51 -51
- ansys/fluent/core/generated/datamodel_231/meshing.py +317 -317
- ansys/fluent/core/generated/datamodel_231/solverworkflow.py +51 -51
- ansys/fluent/core/generated/datamodel_231/workflow.py +9 -9
- ansys/fluent/core/generated/datamodel_232/PMFileManagement.py +2 -2
- ansys/fluent/core/generated/datamodel_232/PartManagement.py +55 -55
- ansys/fluent/core/generated/datamodel_232/flicing.py +51 -51
- ansys/fluent/core/generated/datamodel_232/meshing.py +335 -335
- ansys/fluent/core/generated/datamodel_232/solverworkflow.py +58 -58
- ansys/fluent/core/generated/datamodel_232/workflow.py +9 -9
- ansys/fluent/core/generated/datamodel_241/PMFileManagement.py +2 -2
- ansys/fluent/core/generated/datamodel_241/PartManagement.py +57 -57
- ansys/fluent/core/generated/datamodel_241/flicing.py +51 -51
- ansys/fluent/core/generated/datamodel_241/meshing.py +361 -361
- ansys/fluent/core/generated/datamodel_241/solverworkflow.py +58 -58
- ansys/fluent/core/generated/datamodel_241/workflow.py +9 -9
- ansys/fluent/core/generated/datamodel_242/MeshingUtilities.py +240 -240
- ansys/fluent/core/generated/datamodel_242/PMFileManagement.py +2 -2
- ansys/fluent/core/generated/datamodel_242/PartManagement.py +60 -60
- ansys/fluent/core/generated/datamodel_242/flicing.py +51 -51
- ansys/fluent/core/generated/datamodel_242/meshing.py +371 -371
- ansys/fluent/core/generated/datamodel_242/solverworkflow.py +58 -58
- ansys/fluent/core/generated/datamodel_242/workflow.py +9 -9
- ansys/fluent/core/generated/datamodel_251/MeshingUtilities.py +244 -244
- ansys/fluent/core/generated/datamodel_251/PMFileManagement.py +2 -2
- ansys/fluent/core/generated/datamodel_251/PartManagement.py +60 -60
- ansys/fluent/core/generated/datamodel_251/flicing.py +51 -51
- ansys/fluent/core/generated/datamodel_251/meshing.py +384 -382
- ansys/fluent/core/generated/datamodel_251/preferences.py +7 -0
- ansys/fluent/core/generated/datamodel_251/solverworkflow.py +58 -58
- ansys/fluent/core/generated/datamodel_251/workflow.py +10 -10
- ansys/fluent/core/generated/datamodel_252/MeshingUtilities.py +3664 -0
- ansys/fluent/core/generated/datamodel_252/PMFileManagement.py +288 -0
- ansys/fluent/core/generated/datamodel_252/PartManagement.py +2588 -0
- ansys/fluent/core/generated/datamodel_252/flicing.py +7972 -0
- ansys/fluent/core/generated/datamodel_252/meshing.py +2644 -0
- ansys/fluent/core/generated/datamodel_252/preferences.py +2760 -0
- ansys/fluent/core/generated/datamodel_252/solverworkflow.py +479 -0
- ansys/fluent/core/generated/datamodel_252/workflow.py +466 -0
- ansys/fluent/core/generated/fluent_version_251.py +4 -4
- ansys/fluent/core/generated/fluent_version_252.py +5 -0
- ansys/fluent/core/generated/meshing/tui_251.py +1139 -1179
- ansys/fluent/core/generated/meshing/tui_252.py +10181 -0
- ansys/fluent/core/generated/solver/settings_222.py +3 -3
- ansys/fluent/core/generated/solver/settings_231.py +4 -4
- ansys/fluent/core/generated/solver/settings_232.py +5 -5
- ansys/fluent/core/generated/solver/settings_241.py +5 -5
- ansys/fluent/core/generated/solver/settings_242.py +1185 -1185
- ansys/fluent/core/generated/solver/settings_251.py +1847 -1652
- ansys/fluent/core/generated/solver/settings_251.pyi +237 -211
- ansys/fluent/core/generated/solver/settings_252.py +90369 -0
- ansys/fluent/core/generated/solver/settings_252.pyi +63778 -0
- ansys/fluent/core/generated/solver/settings_builtin.py +612 -1
- ansys/fluent/core/generated/solver/settings_builtin.pyi +235 -0
- ansys/fluent/core/generated/solver/tui_251.py +2283 -2103
- ansys/fluent/core/generated/solver/tui_252.py +37720 -0
- ansys/fluent/core/journaling.py +1 -1
- ansys/fluent/core/launcher/error_handler.py +3 -0
- ansys/fluent/core/launcher/fluent_container.py +5 -0
- ansys/fluent/core/launcher/launcher.py +1 -2
- ansys/fluent/core/launcher/launcher_utils.py +17 -6
- ansys/fluent/core/launcher/process_launch_string.py +3 -3
- ansys/fluent/core/launcher/pyfluent_enums.py +1 -1
- ansys/fluent/core/launcher/slurm_launcher.py +2 -1
- ansys/fluent/core/launcher/standalone_launcher.py +11 -5
- ansys/fluent/core/launcher/watchdog.py +1 -1
- ansys/fluent/core/launcher/watchdog_exec +6 -3
- ansys/fluent/core/logging.py +1 -5
- ansys/fluent/core/parametric.py +6 -3
- ansys/fluent/core/post_objects/meta.py +1 -39
- ansys/fluent/core/post_objects/post_helper.py +4 -3
- ansys/fluent/core/post_objects/post_object_definitions.py +12 -7
- ansys/fluent/core/post_objects/post_objects_container.py +39 -2
- ansys/fluent/core/rpvars.py +2 -1
- ansys/fluent/core/scheduler/machine_list.py +3 -1
- ansys/fluent/core/search.py +109 -262
- ansys/fluent/core/services/__init__.py +3 -0
- ansys/fluent/core/services/api_upgrade.py +1 -0
- ansys/fluent/core/services/batch_ops.py +3 -1
- ansys/fluent/core/services/datamodel_se.py +37 -30
- ansys/fluent/core/services/datamodel_tui.py +8 -3
- ansys/fluent/core/services/deprecated_field_data.py +691 -0
- ansys/fluent/core/services/field_data.py +67 -357
- ansys/fluent/core/services/interceptors.py +6 -4
- ansys/fluent/core/services/reduction.py +1 -2
- ansys/fluent/core/services/scheme_eval.py +2 -3
- ansys/fluent/core/services/solution_variables.py +46 -48
- ansys/fluent/core/session.py +6 -4
- ansys/fluent/core/session_meshing.pyi +5 -0
- ansys/fluent/core/session_pure_meshing.pyi +4 -1
- ansys/fluent/core/session_solver_lite.py +2 -1
- ansys/fluent/core/solver/flobject.py +179 -207
- ansys/fluent/core/solver/flunits.py +65 -56
- ansys/fluent/core/solver/function/reduction.py +9 -29
- ansys/fluent/core/solver/settings_builtin_bases.py +28 -22
- ansys/fluent/core/solver/settings_builtin_data.py +105 -1
- ansys/fluent/core/solver/settings_external.py +0 -28
- ansys/fluent/core/streaming_services/field_data_streaming.py +1 -0
- ansys/fluent/core/streaming_services/monitor_streaming.py +0 -1
- ansys/fluent/core/systemcoupling.py +145 -14
- ansys/fluent/core/utils/__init__.py +18 -2
- ansys/fluent/core/utils/dump_session_data.py +7 -4
- ansys/fluent/core/utils/execution.py +2 -2
- ansys/fluent/core/utils/file_transfer_service.py +37 -42
- ansys/fluent/core/utils/fluent_version.py +20 -2
- ansys/fluent/core/utils/networking.py +39 -1
- ansys/fluent/core/workflow.py +3 -15
- ansys/fluent/tests/conftest.py +89 -7
- ansys/fluent/tests/fluent/test_version/test.py +2 -0
- ansys/fluent/tests/fluent_fixtures.py +195 -0
- ansys/fluent/tests/integration/test_optislang/test_optislang_integration.py +7 -7
- ansys/fluent/tests/parametric/test_parametric_workflow.py +14 -4
- ansys/fluent/tests/test_builtin_settings.py +28 -0
- ansys/fluent/tests/test_cad_to_post_ftm.py +1 -3
- ansys/fluent/tests/test_cad_to_post_wtm.py +1 -1
- ansys/fluent/tests/test_casereader.py +1 -1
- ansys/fluent/tests/test_codegen.py +116 -6
- ansys/fluent/tests/test_data_model_cache.py +1 -1
- ansys/fluent/tests/test_datamodel_service.py +14 -19
- ansys/fluent/tests/test_field_data.py +93 -45
- ansys/fluent/tests/test_file_session.py +32 -29
- ansys/fluent/tests/test_flobject.py +16 -58
- ansys/fluent/tests/test_fluent_fixes.py +5 -5
- ansys/fluent/tests/test_fluent_session.py +11 -8
- ansys/fluent/tests/test_fluent_version.py +1 -1
- ansys/fluent/tests/test_launcher.py +22 -5
- ansys/fluent/tests/test_launcher_remote.py +80 -4
- ansys/fluent/tests/test_meshing_utilities.py +93 -44
- ansys/fluent/tests/test_meshing_workflow.py +6 -6
- ansys/fluent/tests/test_meshingmode/test_meshing_launch.py +1 -1
- ansys/fluent/tests/test_new_meshing_workflow.py +42 -3
- ansys/fluent/tests/test_preferences.py +6 -6
- ansys/fluent/tests/test_reduction.py +61 -30
- ansys/fluent/tests/test_rp_vars.py +1 -1
- ansys/fluent/tests/test_search.py +53 -200
- ansys/fluent/tests/test_session.py +18 -13
- ansys/fluent/tests/test_settings_api.py +93 -29
- ansys/fluent/tests/test_settings_reader.py +1 -1
- ansys/fluent/tests/test_solver_monitors.py +1 -1
- ansys/fluent/tests/test_solvermode/test_calculationactivities.py +4 -4
- ansys/fluent/tests/test_solvermode/test_controls.py +3 -3
- ansys/fluent/tests/test_solvermode/test_methods.py +1 -1
- ansys/fluent/tests/test_solvermode/test_models.py +3 -3
- ansys/fluent/tests/test_systemcoupling.py +33 -5
- ansys/fluent/tests/test_topy.py +2 -2
- ansys/fluent/tests/test_tui_api.py +5 -5
- ansys/fluent/tests/test_utils.py +1 -1
- {ansys_fluent_core-0.27.dev1.dist-info → ansys_fluent_core-0.28.dev0.dist-info}/METADATA +6 -17
- ansys_fluent_core-0.28.dev0.dist-info/RECORD +291 -0
- ansys/fluent/core/generated/api_tree_222.pickle +0 -0
- ansys/fluent/core/generated/api_tree_231.pickle +0 -0
- ansys/fluent/core/generated/api_tree_232.pickle +0 -0
- ansys/fluent/core/generated/api_tree_241.pickle +0 -0
- ansys/fluent/core/generated/api_tree_242.pickle +0 -0
- ansys/fluent/core/generated/api_tree_251.pickle +0 -0
- ansys/fluent/tests/test_tests_util.py +0 -47
- ansys/fluent/tests/util/__init__.py +0 -38
- ansys_fluent_core-0.27.dev1.dist-info/RECORD +0 -283
- {ansys_fluent_core-0.27.dev1.dist-info → ansys_fluent_core-0.28.dev0.dist-info}/AUTHORS +0 -0
- {ansys_fluent_core-0.27.dev1.dist-info → ansys_fluent_core-0.28.dev0.dist-info}/LICENSE +0 -0
- {ansys_fluent_core-0.27.dev1.dist-info → ansys_fluent_core-0.28.dev0.dist-info}/WHEEL +0 -0
|
@@ -0,0 +1,3664 @@
|
|
|
1
|
+
#
|
|
2
|
+
# This is an auto-generated file. DO NOT EDIT!
|
|
3
|
+
#
|
|
4
|
+
# pylint: disable=line-too-long
|
|
5
|
+
|
|
6
|
+
from ansys.fluent.core.services.datamodel_se import (
|
|
7
|
+
PyMenu,
|
|
8
|
+
PyParameter,
|
|
9
|
+
PyTextual,
|
|
10
|
+
PyNumerical,
|
|
11
|
+
PyDictionary,
|
|
12
|
+
PyNamedObjectContainer,
|
|
13
|
+
PyCommand,
|
|
14
|
+
PyQuery
|
|
15
|
+
)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class Root(PyMenu):
|
|
19
|
+
"""
|
|
20
|
+
Singleton Root.
|
|
21
|
+
"""
|
|
22
|
+
def __init__(self, service, rules, path):
|
|
23
|
+
self.add_labels_on_cell_zones = self.__class__.add_labels_on_cell_zones(service, rules, "add_labels_on_cell_zones", path)
|
|
24
|
+
self.add_labels_on_edge_zones = self.__class__.add_labels_on_edge_zones(service, rules, "add_labels_on_edge_zones", path)
|
|
25
|
+
self.add_labels_on_face_zones = self.__class__.add_labels_on_face_zones(service, rules, "add_labels_on_face_zones", path)
|
|
26
|
+
self.clean_face_zone_names = self.__class__.clean_face_zone_names(service, rules, "clean_face_zone_names", path)
|
|
27
|
+
self.delete_all_sub_domains = self.__class__.delete_all_sub_domains(service, rules, "delete_all_sub_domains", path)
|
|
28
|
+
self.delete_empty_cell_zones = self.__class__.delete_empty_cell_zones(service, rules, "delete_empty_cell_zones", path)
|
|
29
|
+
self.delete_empty_edge_zones = self.__class__.delete_empty_edge_zones(service, rules, "delete_empty_edge_zones", path)
|
|
30
|
+
self.delete_empty_face_zones = self.__class__.delete_empty_face_zones(service, rules, "delete_empty_face_zones", path)
|
|
31
|
+
self.delete_empty_zones = self.__class__.delete_empty_zones(service, rules, "delete_empty_zones", path)
|
|
32
|
+
self.delete_marked_faces_in_zones = self.__class__.delete_marked_faces_in_zones(service, rules, "delete_marked_faces_in_zones", path)
|
|
33
|
+
self.merge_cell_zones = self.__class__.merge_cell_zones(service, rules, "merge_cell_zones", path)
|
|
34
|
+
self.merge_cell_zones_with_same_prefix = self.__class__.merge_cell_zones_with_same_prefix(service, rules, "merge_cell_zones_with_same_prefix", path)
|
|
35
|
+
self.merge_cell_zones_with_same_suffix = self.__class__.merge_cell_zones_with_same_suffix(service, rules, "merge_cell_zones_with_same_suffix", path)
|
|
36
|
+
self.merge_face_zones = self.__class__.merge_face_zones(service, rules, "merge_face_zones", path)
|
|
37
|
+
self.merge_face_zones_of_type = self.__class__.merge_face_zones_of_type(service, rules, "merge_face_zones_of_type", path)
|
|
38
|
+
self.merge_face_zones_with_same_prefix = self.__class__.merge_face_zones_with_same_prefix(service, rules, "merge_face_zones_with_same_prefix", path)
|
|
39
|
+
self.remove_id_suffix_from_face_zones = self.__class__.remove_id_suffix_from_face_zones(service, rules, "remove_id_suffix_from_face_zones", path)
|
|
40
|
+
self.remove_ids_from_zone_names = self.__class__.remove_ids_from_zone_names(service, rules, "remove_ids_from_zone_names", path)
|
|
41
|
+
self.remove_labels_on_cell_zones = self.__class__.remove_labels_on_cell_zones(service, rules, "remove_labels_on_cell_zones", path)
|
|
42
|
+
self.remove_labels_on_edge_zones = self.__class__.remove_labels_on_edge_zones(service, rules, "remove_labels_on_edge_zones", path)
|
|
43
|
+
self.remove_labels_on_face_zones = self.__class__.remove_labels_on_face_zones(service, rules, "remove_labels_on_face_zones", path)
|
|
44
|
+
self.rename_edge_zone = self.__class__.rename_edge_zone(service, rules, "rename_edge_zone", path)
|
|
45
|
+
self.rename_face_zone = self.__class__.rename_face_zone(service, rules, "rename_face_zone", path)
|
|
46
|
+
self.rename_face_zone_label = self.__class__.rename_face_zone_label(service, rules, "rename_face_zone_label", path)
|
|
47
|
+
self.rename_object = self.__class__.rename_object(service, rules, "rename_object", path)
|
|
48
|
+
self.renumber_zone_ids = self.__class__.renumber_zone_ids(service, rules, "renumber_zone_ids", path)
|
|
49
|
+
self.replace_cell_zone_suffix = self.__class__.replace_cell_zone_suffix(service, rules, "replace_cell_zone_suffix", path)
|
|
50
|
+
self.replace_edge_zone_suffix = self.__class__.replace_edge_zone_suffix(service, rules, "replace_edge_zone_suffix", path)
|
|
51
|
+
self.replace_face_zone_suffix = self.__class__.replace_face_zone_suffix(service, rules, "replace_face_zone_suffix", path)
|
|
52
|
+
self.replace_label_suffix = self.__class__.replace_label_suffix(service, rules, "replace_label_suffix", path)
|
|
53
|
+
self.replace_object_suffix = self.__class__.replace_object_suffix(service, rules, "replace_object_suffix", path)
|
|
54
|
+
self.set_number_of_parallel_compute_threads = self.__class__.set_number_of_parallel_compute_threads(service, rules, "set_number_of_parallel_compute_threads", path)
|
|
55
|
+
self.set_object_cell_zone_type = self.__class__.set_object_cell_zone_type(service, rules, "set_object_cell_zone_type", path)
|
|
56
|
+
self.set_quality_measure = self.__class__.set_quality_measure(service, rules, "set_quality_measure", path)
|
|
57
|
+
self._cell_zones_labels_fdl = self.__class__._cell_zones_labels_fdl(service, rules, "_cell_zones_labels_fdl", path)
|
|
58
|
+
self._cell_zones_str_fdl = self.__class__._cell_zones_str_fdl(service, rules, "_cell_zones_str_fdl", path)
|
|
59
|
+
self._edge_zones_labels_fdl = self.__class__._edge_zones_labels_fdl(service, rules, "_edge_zones_labels_fdl", path)
|
|
60
|
+
self._edge_zones_str_fdl = self.__class__._edge_zones_str_fdl(service, rules, "_edge_zones_str_fdl", path)
|
|
61
|
+
self._face_zones_labels_fdl = self.__class__._face_zones_labels_fdl(service, rules, "_face_zones_labels_fdl", path)
|
|
62
|
+
self._face_zones_str_fdl = self.__class__._face_zones_str_fdl(service, rules, "_face_zones_str_fdl", path)
|
|
63
|
+
self._node_zones_labels_fdl = self.__class__._node_zones_labels_fdl(service, rules, "_node_zones_labels_fdl", path)
|
|
64
|
+
self._node_zones_str_fdl = self.__class__._node_zones_str_fdl(service, rules, "_node_zones_str_fdl", path)
|
|
65
|
+
self._object_names_str_fdl = self.__class__._object_names_str_fdl(service, rules, "_object_names_str_fdl", path)
|
|
66
|
+
self._prism_cell_zones_labels_fdl = self.__class__._prism_cell_zones_labels_fdl(service, rules, "_prism_cell_zones_labels_fdl", path)
|
|
67
|
+
self._prism_cell_zones_str_fdl = self.__class__._prism_cell_zones_str_fdl(service, rules, "_prism_cell_zones_str_fdl", path)
|
|
68
|
+
self._regions_str_fdl = self.__class__._regions_str_fdl(service, rules, "_regions_str_fdl", path)
|
|
69
|
+
self._zone_types_fdl = self.__class__._zone_types_fdl(service, rules, "_zone_types_fdl", path)
|
|
70
|
+
self.boundary_zone_exists = self.__class__.boundary_zone_exists(service, rules, "boundary_zone_exists", path)
|
|
71
|
+
self.cell_zone_exists = self.__class__.cell_zone_exists(service, rules, "cell_zone_exists", path)
|
|
72
|
+
self.convert_zone_ids_to_name_strings = self.__class__.convert_zone_ids_to_name_strings(service, rules, "convert_zone_ids_to_name_strings", path)
|
|
73
|
+
self.convert_zone_name_strings_to_ids = self.__class__.convert_zone_name_strings_to_ids(service, rules, "convert_zone_name_strings_to_ids", path)
|
|
74
|
+
self.copy_face_zone_labels = self.__class__.copy_face_zone_labels(service, rules, "copy_face_zone_labels", path)
|
|
75
|
+
self.count_marked_faces = self.__class__.count_marked_faces(service, rules, "count_marked_faces", path)
|
|
76
|
+
self.create_boi_and_size_functions_from_refinement_regions = self.__class__.create_boi_and_size_functions_from_refinement_regions(service, rules, "create_boi_and_size_functions_from_refinement_regions", path)
|
|
77
|
+
self.dump_face_zone_orientation_in_region = self.__class__.dump_face_zone_orientation_in_region(service, rules, "dump_face_zone_orientation_in_region", path)
|
|
78
|
+
self.fill_holes_in_face_zone_list = self.__class__.fill_holes_in_face_zone_list(service, rules, "fill_holes_in_face_zone_list", path)
|
|
79
|
+
self.get_adjacent_cell_zones_for_given_face_zones = self.__class__.get_adjacent_cell_zones_for_given_face_zones(service, rules, "get_adjacent_cell_zones_for_given_face_zones", path)
|
|
80
|
+
self.get_adjacent_face_zones_for_given_cell_zones = self.__class__.get_adjacent_face_zones_for_given_cell_zones(service, rules, "get_adjacent_face_zones_for_given_cell_zones", path)
|
|
81
|
+
self.get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones = self.__class__.get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones(service, rules, "get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones", path)
|
|
82
|
+
self.get_adjacent_zones_by_edge_connectivity = self.__class__.get_adjacent_zones_by_edge_connectivity(service, rules, "get_adjacent_zones_by_edge_connectivity", path)
|
|
83
|
+
self.get_adjacent_zones_by_node_connectivity = self.__class__.get_adjacent_zones_by_node_connectivity(service, rules, "get_adjacent_zones_by_node_connectivity", path)
|
|
84
|
+
self.get_all_objects = self.__class__.get_all_objects(service, rules, "get_all_objects", path)
|
|
85
|
+
self.get_average_bounding_box_center = self.__class__.get_average_bounding_box_center(service, rules, "get_average_bounding_box_center", path)
|
|
86
|
+
self.get_baffles_for_face_zones = self.__class__.get_baffles_for_face_zones(service, rules, "get_baffles_for_face_zones", path)
|
|
87
|
+
self.get_bounding_box_of_zone_list = self.__class__.get_bounding_box_of_zone_list(service, rules, "get_bounding_box_of_zone_list", path)
|
|
88
|
+
self.get_cell_mesh_distribution = self.__class__.get_cell_mesh_distribution(service, rules, "get_cell_mesh_distribution", path)
|
|
89
|
+
self.get_cell_quality_limits = self.__class__.get_cell_quality_limits(service, rules, "get_cell_quality_limits", path)
|
|
90
|
+
self.get_cell_zone_count = self.__class__.get_cell_zone_count(service, rules, "get_cell_zone_count", path)
|
|
91
|
+
self.get_cell_zone_id_list_with_labels = self.__class__.get_cell_zone_id_list_with_labels(service, rules, "get_cell_zone_id_list_with_labels", path)
|
|
92
|
+
self.get_cell_zone_shape = self.__class__.get_cell_zone_shape(service, rules, "get_cell_zone_shape", path)
|
|
93
|
+
self.get_cell_zone_volume = self.__class__.get_cell_zone_volume(service, rules, "get_cell_zone_volume", path)
|
|
94
|
+
self.get_cell_zones = self.__class__.get_cell_zones(service, rules, "get_cell_zones", path)
|
|
95
|
+
self.get_edge_size_limits = self.__class__.get_edge_size_limits(service, rules, "get_edge_size_limits", path)
|
|
96
|
+
self.get_edge_zone_id_list_with_labels = self.__class__.get_edge_zone_id_list_with_labels(service, rules, "get_edge_zone_id_list_with_labels", path)
|
|
97
|
+
self.get_edge_zones = self.__class__.get_edge_zones(service, rules, "get_edge_zones", path)
|
|
98
|
+
self.get_edge_zones_list = self.__class__.get_edge_zones_list(service, rules, "get_edge_zones_list", path)
|
|
99
|
+
self.get_edge_zones_of_object = self.__class__.get_edge_zones_of_object(service, rules, "get_edge_zones_of_object", path)
|
|
100
|
+
self.get_embedded_baffles = self.__class__.get_embedded_baffles(service, rules, "get_embedded_baffles", path)
|
|
101
|
+
self.get_face_mesh_distribution = self.__class__.get_face_mesh_distribution(service, rules, "get_face_mesh_distribution", path)
|
|
102
|
+
self.get_face_quality_limits = self.__class__.get_face_quality_limits(service, rules, "get_face_quality_limits", path)
|
|
103
|
+
self.get_face_zone_area = self.__class__.get_face_zone_area(service, rules, "get_face_zone_area", path)
|
|
104
|
+
self.get_face_zone_count = self.__class__.get_face_zone_count(service, rules, "get_face_zone_count", path)
|
|
105
|
+
self.get_face_zone_id_list_with_labels = self.__class__.get_face_zone_id_list_with_labels(service, rules, "get_face_zone_id_list_with_labels", path)
|
|
106
|
+
self.get_face_zone_node_count = self.__class__.get_face_zone_node_count(service, rules, "get_face_zone_node_count", path)
|
|
107
|
+
self.get_face_zones = self.__class__.get_face_zones(service, rules, "get_face_zones", path)
|
|
108
|
+
self.get_face_zones_by_zone_area = self.__class__.get_face_zones_by_zone_area(service, rules, "get_face_zones_by_zone_area", path)
|
|
109
|
+
self.get_face_zones_of_object = self.__class__.get_face_zones_of_object(service, rules, "get_face_zones_of_object", path)
|
|
110
|
+
self.get_face_zones_with_zone_specific_prisms_applied = self.__class__.get_face_zones_with_zone_specific_prisms_applied(service, rules, "get_face_zones_with_zone_specific_prisms_applied", path)
|
|
111
|
+
self.get_free_faces_count = self.__class__.get_free_faces_count(service, rules, "get_free_faces_count", path)
|
|
112
|
+
self.get_interior_face_zones_for_given_cell_zones = self.__class__.get_interior_face_zones_for_given_cell_zones(service, rules, "get_interior_face_zones_for_given_cell_zones", path)
|
|
113
|
+
self.get_labels = self.__class__.get_labels(service, rules, "get_labels", path)
|
|
114
|
+
self.get_labels_on_cell_zones = self.__class__.get_labels_on_cell_zones(service, rules, "get_labels_on_cell_zones", path)
|
|
115
|
+
self.get_labels_on_edge_zones = self.__class__.get_labels_on_edge_zones(service, rules, "get_labels_on_edge_zones", path)
|
|
116
|
+
self.get_labels_on_face_zones = self.__class__.get_labels_on_face_zones(service, rules, "get_labels_on_face_zones", path)
|
|
117
|
+
self.get_labels_on_face_zones_list = self.__class__.get_labels_on_face_zones_list(service, rules, "get_labels_on_face_zones_list", path)
|
|
118
|
+
self.get_maxsize_cell_zone_by_count = self.__class__.get_maxsize_cell_zone_by_count(service, rules, "get_maxsize_cell_zone_by_count", path)
|
|
119
|
+
self.get_maxsize_cell_zone_by_volume = self.__class__.get_maxsize_cell_zone_by_volume(service, rules, "get_maxsize_cell_zone_by_volume", path)
|
|
120
|
+
self.get_minsize_face_zone_by_area = self.__class__.get_minsize_face_zone_by_area(service, rules, "get_minsize_face_zone_by_area", path)
|
|
121
|
+
self.get_minsize_face_zone_by_count = self.__class__.get_minsize_face_zone_by_count(service, rules, "get_minsize_face_zone_by_count", path)
|
|
122
|
+
self.get_multi_faces_count = self.__class__.get_multi_faces_count(service, rules, "get_multi_faces_count", path)
|
|
123
|
+
self.get_node_zones = self.__class__.get_node_zones(service, rules, "get_node_zones", path)
|
|
124
|
+
self.get_objects = self.__class__.get_objects(service, rules, "get_objects", path)
|
|
125
|
+
self.get_overlapping_face_zones = self.__class__.get_overlapping_face_zones(service, rules, "get_overlapping_face_zones", path)
|
|
126
|
+
self.get_pairs_of_overlapping_face_zones = self.__class__.get_pairs_of_overlapping_face_zones(service, rules, "get_pairs_of_overlapping_face_zones", path)
|
|
127
|
+
self.get_prism_cell_zones = self.__class__.get_prism_cell_zones(service, rules, "get_prism_cell_zones", path)
|
|
128
|
+
self.get_region_volume = self.__class__.get_region_volume(service, rules, "get_region_volume", path)
|
|
129
|
+
self.get_regions = self.__class__.get_regions(service, rules, "get_regions", path)
|
|
130
|
+
self.get_regions_of_face_zones = self.__class__.get_regions_of_face_zones(service, rules, "get_regions_of_face_zones", path)
|
|
131
|
+
self.get_shared_boundary_face_zones_for_given_cell_zones = self.__class__.get_shared_boundary_face_zones_for_given_cell_zones(service, rules, "get_shared_boundary_face_zones_for_given_cell_zones", path)
|
|
132
|
+
self.get_tet_cell_zones = self.__class__.get_tet_cell_zones(service, rules, "get_tet_cell_zones", path)
|
|
133
|
+
self.get_unreferenced_cell_zones = self.__class__.get_unreferenced_cell_zones(service, rules, "get_unreferenced_cell_zones", path)
|
|
134
|
+
self.get_unreferenced_edge_zones = self.__class__.get_unreferenced_edge_zones(service, rules, "get_unreferenced_edge_zones", path)
|
|
135
|
+
self.get_unreferenced_face_zones = self.__class__.get_unreferenced_face_zones(service, rules, "get_unreferenced_face_zones", path)
|
|
136
|
+
self.get_wrapped_face_zones = self.__class__.get_wrapped_face_zones(service, rules, "get_wrapped_face_zones", path)
|
|
137
|
+
self.get_zone_type = self.__class__.get_zone_type(service, rules, "get_zone_type", path)
|
|
138
|
+
self.get_zones = self.__class__.get_zones(service, rules, "get_zones", path)
|
|
139
|
+
self.get_zones_with_free_faces_for_given_face_zones = self.__class__.get_zones_with_free_faces_for_given_face_zones(service, rules, "get_zones_with_free_faces_for_given_face_zones", path)
|
|
140
|
+
self.get_zones_with_marked_faces_for_given_face_zones = self.__class__.get_zones_with_marked_faces_for_given_face_zones(service, rules, "get_zones_with_marked_faces_for_given_face_zones", path)
|
|
141
|
+
self.get_zones_with_multi_faces_for_given_face_zones = self.__class__.get_zones_with_multi_faces_for_given_face_zones(service, rules, "get_zones_with_multi_faces_for_given_face_zones", path)
|
|
142
|
+
self.interior_zone_exists = self.__class__.interior_zone_exists(service, rules, "interior_zone_exists", path)
|
|
143
|
+
self.mark_bad_quality_faces = self.__class__.mark_bad_quality_faces(service, rules, "mark_bad_quality_faces", path)
|
|
144
|
+
self.mark_duplicate_faces = self.__class__.mark_duplicate_faces(service, rules, "mark_duplicate_faces", path)
|
|
145
|
+
self.mark_face_strips_by_height_and_quality = self.__class__.mark_face_strips_by_height_and_quality(service, rules, "mark_face_strips_by_height_and_quality", path)
|
|
146
|
+
self.mark_faces_by_quality = self.__class__.mark_faces_by_quality(service, rules, "mark_faces_by_quality", path)
|
|
147
|
+
self.mark_faces_deviating_from_size_field = self.__class__.mark_faces_deviating_from_size_field(service, rules, "mark_faces_deviating_from_size_field", path)
|
|
148
|
+
self.mark_faces_in_self_proximity = self.__class__.mark_faces_in_self_proximity(service, rules, "mark_faces_in_self_proximity", path)
|
|
149
|
+
self.mark_faces_using_node_degree = self.__class__.mark_faces_using_node_degree(service, rules, "mark_faces_using_node_degree", path)
|
|
150
|
+
self.mark_free_faces = self.__class__.mark_free_faces(service, rules, "mark_free_faces", path)
|
|
151
|
+
self.mark_invalid_normals = self.__class__.mark_invalid_normals(service, rules, "mark_invalid_normals", path)
|
|
152
|
+
self.mark_island_faces = self.__class__.mark_island_faces(service, rules, "mark_island_faces", path)
|
|
153
|
+
self.mark_multi_faces = self.__class__.mark_multi_faces(service, rules, "mark_multi_faces", path)
|
|
154
|
+
self.mark_point_contacts = self.__class__.mark_point_contacts(service, rules, "mark_point_contacts", path)
|
|
155
|
+
self.mark_self_intersecting_faces = self.__class__.mark_self_intersecting_faces(service, rules, "mark_self_intersecting_faces", path)
|
|
156
|
+
self.mark_sliver_faces = self.__class__.mark_sliver_faces(service, rules, "mark_sliver_faces", path)
|
|
157
|
+
self.mark_spikes = self.__class__.mark_spikes(service, rules, "mark_spikes", path)
|
|
158
|
+
self.mark_steps = self.__class__.mark_steps(service, rules, "mark_steps", path)
|
|
159
|
+
self.mesh_check = self.__class__.mesh_check(service, rules, "mesh_check", path)
|
|
160
|
+
self.mesh_exists = self.__class__.mesh_exists(service, rules, "mesh_exists", path)
|
|
161
|
+
self.print_worst_quality_cell = self.__class__.print_worst_quality_cell(service, rules, "print_worst_quality_cell", path)
|
|
162
|
+
self.project_zone_on_plane = self.__class__.project_zone_on_plane(service, rules, "project_zone_on_plane", path)
|
|
163
|
+
self.refine_marked_faces_in_zones = self.__class__.refine_marked_faces_in_zones(service, rules, "refine_marked_faces_in_zones", path)
|
|
164
|
+
self.scale_cell_zones_around_pivot = self.__class__.scale_cell_zones_around_pivot(service, rules, "scale_cell_zones_around_pivot", path)
|
|
165
|
+
self.scale_face_zones_around_pivot = self.__class__.scale_face_zones_around_pivot(service, rules, "scale_face_zones_around_pivot", path)
|
|
166
|
+
self.separate_cell_zone_layers_by_face_zone_using_id = self.__class__.separate_cell_zone_layers_by_face_zone_using_id(service, rules, "separate_cell_zone_layers_by_face_zone_using_id", path)
|
|
167
|
+
self.separate_cell_zone_layers_by_face_zone_using_name = self.__class__.separate_cell_zone_layers_by_face_zone_using_name(service, rules, "separate_cell_zone_layers_by_face_zone_using_name", path)
|
|
168
|
+
self.separate_face_zones_by_cell_neighbor = self.__class__.separate_face_zones_by_cell_neighbor(service, rules, "separate_face_zones_by_cell_neighbor", path)
|
|
169
|
+
self.unpreserve_cell_zones = self.__class__.unpreserve_cell_zones(service, rules, "unpreserve_cell_zones", path)
|
|
170
|
+
super().__init__(service, rules, path)
|
|
171
|
+
|
|
172
|
+
class add_labels_on_cell_zones(PyCommand):
|
|
173
|
+
"""
|
|
174
|
+
Add labels on the specified cell zones.
|
|
175
|
+
|
|
176
|
+
Parameters
|
|
177
|
+
----------
|
|
178
|
+
cell_zone_id_list : list[int]
|
|
179
|
+
List containing the cell zone IDs.
|
|
180
|
+
cell_zone_name_list : list[str]
|
|
181
|
+
List containing the cell zone names.
|
|
182
|
+
cell_zone_name_pattern : str
|
|
183
|
+
Cell zone name pattern.
|
|
184
|
+
label_name_list : list[str]
|
|
185
|
+
List containing the label names.
|
|
186
|
+
|
|
187
|
+
Returns
|
|
188
|
+
-------
|
|
189
|
+
list[int]
|
|
190
|
+
|
|
191
|
+
Examples
|
|
192
|
+
--------
|
|
193
|
+
>>> meshing_session.meshing_utilities.add_labels_on_cell_zones(cell_zone_name_list=["elbow-fluid"], label_name_list=["elbow-1"])
|
|
194
|
+
>>> meshing_session.meshing_utilities.add_labels_on_cell_zones(cell_zone_id_list=[87], label_name_list=["87-1"])
|
|
195
|
+
>>> meshing_session.meshing_utilities.add_labels_on_cell_zones(cell_zone_name_pattern="*", label_name_list=["cell-1"])
|
|
196
|
+
"""
|
|
197
|
+
pass
|
|
198
|
+
|
|
199
|
+
class add_labels_on_edge_zones(PyCommand):
|
|
200
|
+
"""
|
|
201
|
+
Add labels on the specified edge zones.
|
|
202
|
+
|
|
203
|
+
Parameters
|
|
204
|
+
----------
|
|
205
|
+
edge_zone_id_list : list[int]
|
|
206
|
+
List containing the edge zone IDs.
|
|
207
|
+
edge_zone_name_list : list[str]
|
|
208
|
+
List containing the edge zone names.
|
|
209
|
+
edge_zone_name_pattern : str
|
|
210
|
+
Edge zone name pattern.
|
|
211
|
+
label_name_list : list[str]
|
|
212
|
+
List containing the label names.
|
|
213
|
+
|
|
214
|
+
Returns
|
|
215
|
+
-------
|
|
216
|
+
list[int]
|
|
217
|
+
|
|
218
|
+
Examples
|
|
219
|
+
--------
|
|
220
|
+
>>> meshing_session.meshing_utilities.add_labels_on_edge_zones(edge_zone_name_list=["symmetry:xyplane:hot-inlet:elbow-fluid:feature.20", "hot-inlet:wall-inlet:elbow-fluid:feature.21"], label_name_list=["20-1", "21-1"])
|
|
221
|
+
>>> meshing_session.meshing_utilities.add_labels_on_edge_zones(edge_zone_id_list=[22, 23], label_name_list=["22-1", "23-1"])
|
|
222
|
+
>>> meshing_session.meshing_utilities.add_labels_on_edge_zones(edge_zone_name_pattern="cold-inlet*", label_name_list=["26-1"])
|
|
223
|
+
"""
|
|
224
|
+
pass
|
|
225
|
+
|
|
226
|
+
class add_labels_on_face_zones(PyCommand):
|
|
227
|
+
"""
|
|
228
|
+
Add labels on the specified face zones.
|
|
229
|
+
|
|
230
|
+
Parameters
|
|
231
|
+
----------
|
|
232
|
+
face_zone_id_list : list[int]
|
|
233
|
+
List containing the face zone IDs.
|
|
234
|
+
face_zone_name_list : list[str]
|
|
235
|
+
List containing the face zone names.
|
|
236
|
+
face_zone_name_pattern : str
|
|
237
|
+
Face zone name pattern.
|
|
238
|
+
label_name_list : list[str]
|
|
239
|
+
List containing the label names.
|
|
240
|
+
|
|
241
|
+
Returns
|
|
242
|
+
-------
|
|
243
|
+
list[int]
|
|
244
|
+
|
|
245
|
+
Examples
|
|
246
|
+
--------
|
|
247
|
+
>>> meshing_session.meshing_utilities.add_labels_on_face_zones(face_zone_name_list=["wall-inlet", "wall-elbow"], label_name_list=["wall-inlet-1", "wall-elbow-1"])
|
|
248
|
+
>>> meshing_session.meshing_utilities.add_labels_on_face_zones(face_zone_id_list=[30, 31], label_name_list=["hot-inlet-1", "cold-inlet-1"])
|
|
249
|
+
>>> meshing_session.meshing_utilities.add_labels_on_face_zones(face_zone_name_pattern="out*", label_name_list=["outlet-1"])
|
|
250
|
+
"""
|
|
251
|
+
pass
|
|
252
|
+
|
|
253
|
+
class clean_face_zone_names(PyCommand):
|
|
254
|
+
"""
|
|
255
|
+
Clean up face zone names by removing IDs wherever possible.
|
|
256
|
+
|
|
257
|
+
Returns
|
|
258
|
+
-------
|
|
259
|
+
None
|
|
260
|
+
|
|
261
|
+
Examples
|
|
262
|
+
--------
|
|
263
|
+
>>> meshing_session.meshing_utilities.clean_face_zone_names()
|
|
264
|
+
"""
|
|
265
|
+
pass
|
|
266
|
+
|
|
267
|
+
class delete_all_sub_domains(PyCommand):
|
|
268
|
+
"""
|
|
269
|
+
Deletes all sub-domains (all domains other than global).
|
|
270
|
+
|
|
271
|
+
Returns
|
|
272
|
+
-------
|
|
273
|
+
None
|
|
274
|
+
|
|
275
|
+
Examples
|
|
276
|
+
--------
|
|
277
|
+
>>> meshing_session.meshing_utilities.delete_all_sub_domains()
|
|
278
|
+
"""
|
|
279
|
+
pass
|
|
280
|
+
|
|
281
|
+
class delete_empty_cell_zones(PyCommand):
|
|
282
|
+
"""
|
|
283
|
+
Delete empty cell zones.
|
|
284
|
+
|
|
285
|
+
Parameters
|
|
286
|
+
----------
|
|
287
|
+
cell_zone_id_list : list[int]
|
|
288
|
+
List containing the cell zone IDs.
|
|
289
|
+
cell_zone_name_list : list[str]
|
|
290
|
+
List containing the cell zone names.
|
|
291
|
+
cell_zone_name_pattern : str
|
|
292
|
+
Cell zone name pattern.
|
|
293
|
+
|
|
294
|
+
Returns
|
|
295
|
+
-------
|
|
296
|
+
list[int]
|
|
297
|
+
|
|
298
|
+
Examples
|
|
299
|
+
--------
|
|
300
|
+
>>> meshing_session.meshing_utilities.delete_empty_cell_zones(cell_zone_id_list=[87])
|
|
301
|
+
>>> meshing_session.meshing_utilities.delete_empty_cell_zones(cell_zone_name_list=["elbow.87"])
|
|
302
|
+
>>> meshing_session.meshing_utilities.delete_empty_cell_zones(cell_zone_name_pattern="*")
|
|
303
|
+
"""
|
|
304
|
+
pass
|
|
305
|
+
|
|
306
|
+
class delete_empty_edge_zones(PyCommand):
|
|
307
|
+
"""
|
|
308
|
+
Delete empty edge zones.
|
|
309
|
+
|
|
310
|
+
Parameters
|
|
311
|
+
----------
|
|
312
|
+
edge_zone_id_list : list[int]
|
|
313
|
+
List containing the edge zone IDs.
|
|
314
|
+
edge_zone_name_list : list[str]
|
|
315
|
+
List containing the edge zone names.
|
|
316
|
+
edge_zone_name_pattern : str
|
|
317
|
+
Edge zone name pattern.
|
|
318
|
+
|
|
319
|
+
Returns
|
|
320
|
+
-------
|
|
321
|
+
list[int]
|
|
322
|
+
|
|
323
|
+
Examples
|
|
324
|
+
--------
|
|
325
|
+
>>> meshing_session.meshing_utilities.delete_empty_edge_zones(edge_zone_id_list=[20, 25, 26])
|
|
326
|
+
>>> meshing_session.meshing_utilities.delete_empty_edge_zones("symmetry:xyplane:hot-inlet:elbow-fluid:feature.20", "hot-inlet:wall-inlet:elbow-fluid:feature.21")
|
|
327
|
+
>>> meshing_session.meshing_utilities.delete_empty_edge_zones(edge_zone_name_pattern="*")
|
|
328
|
+
"""
|
|
329
|
+
pass
|
|
330
|
+
|
|
331
|
+
class delete_empty_face_zones(PyCommand):
|
|
332
|
+
"""
|
|
333
|
+
Delete empty face zones.
|
|
334
|
+
|
|
335
|
+
Parameters
|
|
336
|
+
----------
|
|
337
|
+
face_zone_id_list : list[int]
|
|
338
|
+
List containing the face zone IDs.
|
|
339
|
+
face_zone_name_list : list[str]
|
|
340
|
+
List containing the face zone names.
|
|
341
|
+
face_zone_name_pattern : str
|
|
342
|
+
Face zone name pattern.
|
|
343
|
+
|
|
344
|
+
Returns
|
|
345
|
+
-------
|
|
346
|
+
list[int]
|
|
347
|
+
|
|
348
|
+
Examples
|
|
349
|
+
--------
|
|
350
|
+
>>> meshing_session.meshing_utilities.delete_empty_face_zones(face_zone_id_list=[30, 31, 32])
|
|
351
|
+
>>> meshing_session.meshing_utilities.delete_empty_face_zones(face_zone_name_list=["wall-inlet", "wallfluid-new"])
|
|
352
|
+
>>> meshing_session.meshing_utilities.delete_empty_face_zones(face_zone_name_pattern="*")
|
|
353
|
+
"""
|
|
354
|
+
pass
|
|
355
|
+
|
|
356
|
+
class delete_empty_zones(PyCommand):
|
|
357
|
+
"""
|
|
358
|
+
Delete empty zones based on the zones specified.
|
|
359
|
+
|
|
360
|
+
Parameters
|
|
361
|
+
----------
|
|
362
|
+
zone_id_list : list[int]
|
|
363
|
+
List containing the face or edge or cell or node zone IDs.
|
|
364
|
+
zone_name_list : list[str]
|
|
365
|
+
List containing the face or edge or cell or node zone names.
|
|
366
|
+
zone_name_pattern : str
|
|
367
|
+
Face or edge or cell or node zone name pattern.
|
|
368
|
+
|
|
369
|
+
Returns
|
|
370
|
+
-------
|
|
371
|
+
list[int]
|
|
372
|
+
|
|
373
|
+
Examples
|
|
374
|
+
--------
|
|
375
|
+
>>> meshing_session.meshing_utilities.delete_empty_zones(zone_id_list=[20, 32, 87])
|
|
376
|
+
>>> meshing_session.meshing_utilities.delete_empty_zones(zone_name_list=["hotfluid-new", "elbow.87"])
|
|
377
|
+
>>> meshing_session.meshing_utilities.delete_empty_zones(zone_name_pattern="*")
|
|
378
|
+
"""
|
|
379
|
+
pass
|
|
380
|
+
|
|
381
|
+
class delete_marked_faces_in_zones(PyCommand):
|
|
382
|
+
"""
|
|
383
|
+
Delete marked faces.
|
|
384
|
+
|
|
385
|
+
Parameters
|
|
386
|
+
----------
|
|
387
|
+
face_zone_id_list : list[int]
|
|
388
|
+
List containing the face zone IDs.
|
|
389
|
+
face_zone_name_list : list[str]
|
|
390
|
+
List containing the face zone names.
|
|
391
|
+
face_zone_name_pattern : str
|
|
392
|
+
Face zone name pattern.
|
|
393
|
+
|
|
394
|
+
Returns
|
|
395
|
+
-------
|
|
396
|
+
list[int]
|
|
397
|
+
|
|
398
|
+
Examples
|
|
399
|
+
--------
|
|
400
|
+
>>> meshing_session.meshing_utilities.delete_marked_faces_in_zones(face_zone_id_list=[30, 31, 32])
|
|
401
|
+
>>> meshing_session.meshing_utilities.delete_marked_faces_in_zones(face_zone_name_list=["wall-inlet", "wallfluid-new"])
|
|
402
|
+
>>> meshing_session.meshing_utilities.delete_marked_faces_in_zones(face_zone_name_pattern="*")
|
|
403
|
+
"""
|
|
404
|
+
pass
|
|
405
|
+
|
|
406
|
+
class merge_cell_zones(PyCommand):
|
|
407
|
+
"""
|
|
408
|
+
- Merges the specified cell zones.
|
|
409
|
+
- Specify a list of cell zones or name pattern.
|
|
410
|
+
|
|
411
|
+
Parameters
|
|
412
|
+
----------
|
|
413
|
+
cell_zone_id_list : list[int]
|
|
414
|
+
List containing the cell zone IDs.
|
|
415
|
+
cell_zone_name_list : list[str]
|
|
416
|
+
List containing the cell zone names.
|
|
417
|
+
cell_zone_name_pattern : str
|
|
418
|
+
Cell zone name pattern.
|
|
419
|
+
|
|
420
|
+
Returns
|
|
421
|
+
-------
|
|
422
|
+
None
|
|
423
|
+
|
|
424
|
+
Examples
|
|
425
|
+
--------
|
|
426
|
+
>>> meshing_session.meshing_utilities.merge_cell_zones(cell_zone_id_list=[87])
|
|
427
|
+
>>> meshing_session.meshing_utilities.merge_cell_zones(cell_zone_name_list=["elbow-fluid"])
|
|
428
|
+
>>> meshing_session.meshing_utilities.merge_cell_zones(cell_zone_name_pattern="*")
|
|
429
|
+
"""
|
|
430
|
+
pass
|
|
431
|
+
|
|
432
|
+
class merge_cell_zones_with_same_prefix(PyCommand):
|
|
433
|
+
"""
|
|
434
|
+
Merge cell zones containing the specified prefix.
|
|
435
|
+
|
|
436
|
+
Parameters
|
|
437
|
+
----------
|
|
438
|
+
prefix : str
|
|
439
|
+
Cell zone prefix.
|
|
440
|
+
|
|
441
|
+
Returns
|
|
442
|
+
-------
|
|
443
|
+
None
|
|
444
|
+
|
|
445
|
+
Examples
|
|
446
|
+
--------
|
|
447
|
+
>>> meshing_session.meshing_utilities.merge_cell_zones_with_same_prefix(prefix="elbow")
|
|
448
|
+
"""
|
|
449
|
+
pass
|
|
450
|
+
|
|
451
|
+
class merge_cell_zones_with_same_suffix(PyCommand):
|
|
452
|
+
"""
|
|
453
|
+
Merge cell zones containing the specified suffix.
|
|
454
|
+
|
|
455
|
+
Parameters
|
|
456
|
+
----------
|
|
457
|
+
suffix : str
|
|
458
|
+
Cell zone suffix.
|
|
459
|
+
|
|
460
|
+
Returns
|
|
461
|
+
-------
|
|
462
|
+
None
|
|
463
|
+
|
|
464
|
+
Examples
|
|
465
|
+
--------
|
|
466
|
+
>>> meshing_session.meshing_utilities.merge_cell_zones_with_same_suffix(suffix="fluid")
|
|
467
|
+
"""
|
|
468
|
+
pass
|
|
469
|
+
|
|
470
|
+
class merge_face_zones(PyCommand):
|
|
471
|
+
"""
|
|
472
|
+
- Merges the specified face zones.
|
|
473
|
+
- Specify a list of zone IDs or name pattern.
|
|
474
|
+
|
|
475
|
+
Parameters
|
|
476
|
+
----------
|
|
477
|
+
face_zone_id_list : list[int]
|
|
478
|
+
List containing the face zone IDs.
|
|
479
|
+
face_zone_name_pattern : str
|
|
480
|
+
Face zone name pattern.
|
|
481
|
+
|
|
482
|
+
Returns
|
|
483
|
+
-------
|
|
484
|
+
None
|
|
485
|
+
|
|
486
|
+
Examples
|
|
487
|
+
--------
|
|
488
|
+
>>> meshing_session.meshing_utilities.merge_face_zones(face_zone_id_list=[30, 31, 32])
|
|
489
|
+
>>> meshing_session.meshing_utilities.merge_face_zones(face_zone_name_pattern="wall*")
|
|
490
|
+
"""
|
|
491
|
+
pass
|
|
492
|
+
|
|
493
|
+
class merge_face_zones_of_type(PyCommand):
|
|
494
|
+
"""
|
|
495
|
+
Merges face zones of a given type based on name pattern.
|
|
496
|
+
|
|
497
|
+
Parameters
|
|
498
|
+
----------
|
|
499
|
+
face_zone_type : str
|
|
500
|
+
Face zone type.
|
|
501
|
+
face_zone_name_pattern : str
|
|
502
|
+
Face zone name pattern.
|
|
503
|
+
|
|
504
|
+
Returns
|
|
505
|
+
-------
|
|
506
|
+
None
|
|
507
|
+
|
|
508
|
+
Examples
|
|
509
|
+
--------
|
|
510
|
+
>>> meshing_session.meshing_utilities.merge_face_zones_of_type(face_zone_type="velocity-inlet", face_zone_name_pattern="*")
|
|
511
|
+
"""
|
|
512
|
+
pass
|
|
513
|
+
|
|
514
|
+
class merge_face_zones_with_same_prefix(PyCommand):
|
|
515
|
+
"""
|
|
516
|
+
Merge face zones containing the specified prefix.
|
|
517
|
+
|
|
518
|
+
Parameters
|
|
519
|
+
----------
|
|
520
|
+
prefix : str
|
|
521
|
+
Face zone prefix.
|
|
522
|
+
|
|
523
|
+
Returns
|
|
524
|
+
-------
|
|
525
|
+
None
|
|
526
|
+
|
|
527
|
+
Examples
|
|
528
|
+
--------
|
|
529
|
+
>>> meshing_session.meshing_utilities.merge_face_zones_with_same_prefix(prefix="elbow")
|
|
530
|
+
"""
|
|
531
|
+
pass
|
|
532
|
+
|
|
533
|
+
class remove_id_suffix_from_face_zones(PyCommand):
|
|
534
|
+
"""
|
|
535
|
+
Removes the ID suffix from face zone names.
|
|
536
|
+
|
|
537
|
+
Returns
|
|
538
|
+
-------
|
|
539
|
+
None
|
|
540
|
+
|
|
541
|
+
Examples
|
|
542
|
+
--------
|
|
543
|
+
>>> meshing_session.meshing_utilities.remove_id_suffix_from_face_zones()
|
|
544
|
+
"""
|
|
545
|
+
pass
|
|
546
|
+
|
|
547
|
+
class remove_ids_from_zone_names(PyCommand):
|
|
548
|
+
"""
|
|
549
|
+
Remove the zone ID from zone ID list.
|
|
550
|
+
|
|
551
|
+
Parameters
|
|
552
|
+
----------
|
|
553
|
+
zone_id_list : list[int]
|
|
554
|
+
List containing the face or edge or cell or node zone IDs.
|
|
555
|
+
|
|
556
|
+
Returns
|
|
557
|
+
-------
|
|
558
|
+
bool
|
|
559
|
+
|
|
560
|
+
Examples
|
|
561
|
+
--------
|
|
562
|
+
>>> meshing_session.meshing_utilities.remove_ids_from_zone_names(zone_id_list=[30, 31, 32])
|
|
563
|
+
"""
|
|
564
|
+
pass
|
|
565
|
+
|
|
566
|
+
class remove_labels_on_cell_zones(PyCommand):
|
|
567
|
+
"""
|
|
568
|
+
Removes the specified labels from the cell zones.
|
|
569
|
+
|
|
570
|
+
Parameters
|
|
571
|
+
----------
|
|
572
|
+
cell_zone_id_list : list[int]
|
|
573
|
+
List containing the cell zone IDs.
|
|
574
|
+
cell_zone_name_list : list[str]
|
|
575
|
+
List containing the cell zone names.
|
|
576
|
+
cell_zone_name_pattern : str
|
|
577
|
+
Cell zone name pattern.
|
|
578
|
+
label_name_list : list[str]
|
|
579
|
+
List containing the label names.
|
|
580
|
+
|
|
581
|
+
Returns
|
|
582
|
+
-------
|
|
583
|
+
None
|
|
584
|
+
|
|
585
|
+
Examples
|
|
586
|
+
--------
|
|
587
|
+
>>> meshing_session.meshing_utilities.remove_labels_on_cell_zones(cell_zone_name_list=["elbow-fluid"], label_name_list=["elbow-1"])
|
|
588
|
+
>>> meshing_session.meshing_utilities.remove_labels_on_cell_zones(cell_zone_id_list=[87], label_name_list=["87-1"])
|
|
589
|
+
>>> meshing_session.meshing_utilities.remove_labels_on_cell_zones(cell_zone_name_pattern="*", label_name_list=["cell-1"])
|
|
590
|
+
"""
|
|
591
|
+
pass
|
|
592
|
+
|
|
593
|
+
class remove_labels_on_edge_zones(PyCommand):
|
|
594
|
+
"""
|
|
595
|
+
Removes the specified labels from the edge zones.
|
|
596
|
+
|
|
597
|
+
Parameters
|
|
598
|
+
----------
|
|
599
|
+
edge_zone_id_list : list[int]
|
|
600
|
+
List containing the edge zone IDs.
|
|
601
|
+
edge_zone_name_list : list[str]
|
|
602
|
+
List containing the edge zone names.
|
|
603
|
+
edge_zone_name_pattern : str
|
|
604
|
+
Edge zone name pattern.
|
|
605
|
+
label_name_list : list[str]
|
|
606
|
+
List containing the label names.
|
|
607
|
+
|
|
608
|
+
Returns
|
|
609
|
+
-------
|
|
610
|
+
None
|
|
611
|
+
|
|
612
|
+
Examples
|
|
613
|
+
--------
|
|
614
|
+
>>> meshing_session.meshing_utilities.remove_labels_on_edge_zones(edge_zone_name_list=["symmetry:xyplane:hot-inlet:elbow-fluid:feature.20"], label_name_list=["20-1"])
|
|
615
|
+
>>> meshing_session.meshing_utilities.remove_labels_on_edge_zones(edge_zone_id_list=[22], label_name_list=["22-1"])
|
|
616
|
+
>>> meshing_session.meshing_utilities.remove_labels_on_edge_zones(edge_zone_name_pattern="*", label_name_list=["26-1"])
|
|
617
|
+
"""
|
|
618
|
+
pass
|
|
619
|
+
|
|
620
|
+
class remove_labels_on_face_zones(PyCommand):
|
|
621
|
+
"""
|
|
622
|
+
Removes the specified labels from the face zones.
|
|
623
|
+
|
|
624
|
+
Parameters
|
|
625
|
+
----------
|
|
626
|
+
face_zone_id_list : list[int]
|
|
627
|
+
List containing the face zone IDs.
|
|
628
|
+
face_zone_name_list : list[str]
|
|
629
|
+
List containing the face zone names.
|
|
630
|
+
face_zone_name_pattern : str
|
|
631
|
+
Face zone name pattern.
|
|
632
|
+
label_name_list : list[str]
|
|
633
|
+
List containing the label names.
|
|
634
|
+
|
|
635
|
+
Returns
|
|
636
|
+
-------
|
|
637
|
+
None
|
|
638
|
+
|
|
639
|
+
Examples
|
|
640
|
+
--------
|
|
641
|
+
>>> meshing_session.meshing_utilities.remove_labels_on_face_zones(face_zone_name_list=["wall-inlet"], label_name_list=["wall-inlet-1"])
|
|
642
|
+
>>> meshing_session.meshing_utilities.remove_labels_on_face_zones(face_zone_id_list=[30], label_name_list=["hot-inlet-1"])
|
|
643
|
+
>>> meshing_session.meshing_utilities.remove_labels_on_face_zones(face_zone_name_pattern="*", label_name_list=["wall-elbow-1"])
|
|
644
|
+
"""
|
|
645
|
+
pass
|
|
646
|
+
|
|
647
|
+
class rename_edge_zone(PyCommand):
|
|
648
|
+
"""
|
|
649
|
+
Renames an existing edge zone.
|
|
650
|
+
|
|
651
|
+
Parameters
|
|
652
|
+
----------
|
|
653
|
+
zone_id : int
|
|
654
|
+
Edge zone ID.
|
|
655
|
+
zone_name : str
|
|
656
|
+
Edge zone name.
|
|
657
|
+
new_name : str
|
|
658
|
+
New edge zone name.
|
|
659
|
+
|
|
660
|
+
Returns
|
|
661
|
+
-------
|
|
662
|
+
bool
|
|
663
|
+
|
|
664
|
+
Examples
|
|
665
|
+
--------
|
|
666
|
+
>>> meshing_session.meshing_utilities.rename_edge_zone(zone_id=20, new_name="symmetry:xyplane:hot-inlet:elbow-fluid:feature.20-new")
|
|
667
|
+
"""
|
|
668
|
+
pass
|
|
669
|
+
|
|
670
|
+
class rename_face_zone(PyCommand):
|
|
671
|
+
"""
|
|
672
|
+
Renames an existing face zone.
|
|
673
|
+
|
|
674
|
+
Parameters
|
|
675
|
+
----------
|
|
676
|
+
zone_id : int
|
|
677
|
+
Face zone ID.
|
|
678
|
+
zone_name : str
|
|
679
|
+
Face zone name.
|
|
680
|
+
new_name : str
|
|
681
|
+
New face zone name.
|
|
682
|
+
|
|
683
|
+
Returns
|
|
684
|
+
-------
|
|
685
|
+
bool
|
|
686
|
+
|
|
687
|
+
Examples
|
|
688
|
+
--------
|
|
689
|
+
>>> meshing_session.meshing_utilities.rename_face_zone(zone_name="symmetry:xyplane:hot-inlet:elbow-fluid:feature.20-new", new_name="symmetry:xyplane:hot-inlet:elbow-fluid:feature.20")
|
|
690
|
+
>>> meshing_session.meshing_utilities.rename_face_zone(zone_id=32, new_name="outlet-32")
|
|
691
|
+
>>> meshing_session.meshing_utilities.rename_face_zone(zone_name="outlet-32", new_name="outlet")
|
|
692
|
+
"""
|
|
693
|
+
pass
|
|
694
|
+
|
|
695
|
+
class rename_face_zone_label(PyCommand):
|
|
696
|
+
"""
|
|
697
|
+
Renames the face zone label.
|
|
698
|
+
|
|
699
|
+
Parameters
|
|
700
|
+
----------
|
|
701
|
+
object_name : str
|
|
702
|
+
Mesh object name.
|
|
703
|
+
old_label_name : str
|
|
704
|
+
Old label name.
|
|
705
|
+
new_label_name : str
|
|
706
|
+
New label name.
|
|
707
|
+
|
|
708
|
+
Returns
|
|
709
|
+
-------
|
|
710
|
+
None
|
|
711
|
+
|
|
712
|
+
Examples
|
|
713
|
+
--------
|
|
714
|
+
>>> meshing_session.meshing_utilities.rename_face_zone_label(object_name="elbow-fluid-1", old_label_name="outlet", new_label_name="outlet-new")
|
|
715
|
+
"""
|
|
716
|
+
pass
|
|
717
|
+
|
|
718
|
+
class rename_object(PyCommand):
|
|
719
|
+
"""
|
|
720
|
+
Renames the object.
|
|
721
|
+
|
|
722
|
+
Parameters
|
|
723
|
+
----------
|
|
724
|
+
old_object_name : str
|
|
725
|
+
Old object name.
|
|
726
|
+
new_object_name : str
|
|
727
|
+
New object name.
|
|
728
|
+
|
|
729
|
+
Returns
|
|
730
|
+
-------
|
|
731
|
+
None
|
|
732
|
+
|
|
733
|
+
Examples
|
|
734
|
+
--------
|
|
735
|
+
>>> meshing_session.meshing_utilities.rename_object(old_object_name="elbow-fluid", new_object_name="elbow-fluid-1")
|
|
736
|
+
"""
|
|
737
|
+
pass
|
|
738
|
+
|
|
739
|
+
class renumber_zone_ids(PyCommand):
|
|
740
|
+
"""
|
|
741
|
+
Renumber zone IDs starting from the number specified (start_number).
|
|
742
|
+
|
|
743
|
+
Parameters
|
|
744
|
+
----------
|
|
745
|
+
zone_id_list : list[int]
|
|
746
|
+
List containing the face or edge or cell or node zone IDs.
|
|
747
|
+
start_number : int
|
|
748
|
+
Start number.
|
|
749
|
+
|
|
750
|
+
Returns
|
|
751
|
+
-------
|
|
752
|
+
None
|
|
753
|
+
|
|
754
|
+
Examples
|
|
755
|
+
--------
|
|
756
|
+
>>> meshing_session.meshing_utilities.renumber_zone_ids(zone_id_list=[30, 31, 32], start_number=1)
|
|
757
|
+
"""
|
|
758
|
+
pass
|
|
759
|
+
|
|
760
|
+
class replace_cell_zone_suffix(PyCommand):
|
|
761
|
+
"""
|
|
762
|
+
- Replace the cell zone suffix to rename cell zones.
|
|
763
|
+
- Specify whether to merge the cell zones being renamed (set merge to True or False).
|
|
764
|
+
|
|
765
|
+
Parameters
|
|
766
|
+
----------
|
|
767
|
+
cell_zone_id_list : list[int]
|
|
768
|
+
List containing the cell zone IDs.
|
|
769
|
+
cell_zone_name_list : list[str]
|
|
770
|
+
List containing the cell zone names.
|
|
771
|
+
old_suffix : str
|
|
772
|
+
Old cell zone name suffix.
|
|
773
|
+
new_suffix : str
|
|
774
|
+
New cell zone name suffix.
|
|
775
|
+
merge : bool
|
|
776
|
+
Specify whether to merge the cell zones being renamed.
|
|
777
|
+
|
|
778
|
+
Returns
|
|
779
|
+
-------
|
|
780
|
+
None
|
|
781
|
+
|
|
782
|
+
Examples
|
|
783
|
+
--------
|
|
784
|
+
>>> meshing_session.meshing_utilities.replace_cell_zone_suffix(cell_zone_id_list=[87], old_suffix="fluid", new_suffix="fluid-new", merge=True)
|
|
785
|
+
>>> meshing_session.meshing_utilities.replace_cell_zone_suffix(cell_zone_name_list=["elbow-fluid-new"], old_suffix="fluid", new_suffix="fluid-new", merge=True)
|
|
786
|
+
"""
|
|
787
|
+
pass
|
|
788
|
+
|
|
789
|
+
class replace_edge_zone_suffix(PyCommand):
|
|
790
|
+
"""
|
|
791
|
+
- Replace the edge zone suffix to rename edge zones.
|
|
792
|
+
- Specify whether to merge the edge zones being renamed (set merge to True or False).
|
|
793
|
+
|
|
794
|
+
Parameters
|
|
795
|
+
----------
|
|
796
|
+
edge_zone_id_list : list[int]
|
|
797
|
+
List containing the edge zone IDs.
|
|
798
|
+
edge_zone_name_list : list[str]
|
|
799
|
+
List containing the edge zone names.
|
|
800
|
+
old_suffix : str
|
|
801
|
+
Old edge zone name suffix.
|
|
802
|
+
new_suffix : str
|
|
803
|
+
New edge zone name suffix.
|
|
804
|
+
merge : bool
|
|
805
|
+
Specify whether to merge the edge zones being renamed.
|
|
806
|
+
|
|
807
|
+
Returns
|
|
808
|
+
-------
|
|
809
|
+
None
|
|
810
|
+
|
|
811
|
+
Examples
|
|
812
|
+
--------
|
|
813
|
+
>>> meshing_session.meshing_utilities.replace_edge_zone_suffix(edge_zone_id_list=[20], old_suffix="fluid", new_suffix="fluid-new", merge=True)
|
|
814
|
+
>>> meshing_session.meshing_utilities.replace_edge_zone_suffix(edge_zone_name_list=["hot-inlet:wall-inlet:elbow-fluid:feature.21"], old_suffix="fluid", new_suffix="fluid-new", merge=True)
|
|
815
|
+
"""
|
|
816
|
+
pass
|
|
817
|
+
|
|
818
|
+
class replace_face_zone_suffix(PyCommand):
|
|
819
|
+
"""
|
|
820
|
+
- Replace the face zone suffix to rename face zones.
|
|
821
|
+
- Specify whether to merge the face zones being renamed (set merge to True or False).
|
|
822
|
+
- Note - If an empty string is specified for the separator (' '), the string specified for replace with will be appended to the face zone names.
|
|
823
|
+
|
|
824
|
+
Parameters
|
|
825
|
+
----------
|
|
826
|
+
face_zone_id_list : list[int]
|
|
827
|
+
List containing the face zone IDs.
|
|
828
|
+
face_zone_name_list : list[str]
|
|
829
|
+
List containing the face zone names.
|
|
830
|
+
separator : str
|
|
831
|
+
Face zone name separator.
|
|
832
|
+
replace_with : str
|
|
833
|
+
New face zone name suffix.
|
|
834
|
+
merge : bool
|
|
835
|
+
Specify whether to merge the face zones being renamed.
|
|
836
|
+
|
|
837
|
+
Returns
|
|
838
|
+
-------
|
|
839
|
+
None
|
|
840
|
+
|
|
841
|
+
Examples
|
|
842
|
+
--------
|
|
843
|
+
>>> meshing_session.meshing_utilities.replace_face_zone_suffix(face_zone_id_list=[30, 31, 32], separator="-suffix-", replace_with="-with-", merge=False)
|
|
844
|
+
>>> meshing_session.meshing_utilities.replace_face_zone_suffix(face_zone_name_list=["cold-inlet", "hot-inlet"], separator="-suffix-", replace_with="-with-", merge=False)
|
|
845
|
+
"""
|
|
846
|
+
pass
|
|
847
|
+
|
|
848
|
+
class replace_label_suffix(PyCommand):
|
|
849
|
+
"""
|
|
850
|
+
Rename labels by replacing the label suffix with a new suffix.
|
|
851
|
+
|
|
852
|
+
Parameters
|
|
853
|
+
----------
|
|
854
|
+
object_name_list : list[str]
|
|
855
|
+
List containing the object names.
|
|
856
|
+
separator : str
|
|
857
|
+
Label separator.
|
|
858
|
+
new_suffix : str
|
|
859
|
+
New label suffix.
|
|
860
|
+
|
|
861
|
+
Returns
|
|
862
|
+
-------
|
|
863
|
+
None
|
|
864
|
+
|
|
865
|
+
Examples
|
|
866
|
+
--------
|
|
867
|
+
>>> meshing_session.meshing_utilities.replace_label_suffix(object_name_list=["elbow-fluid-1"], separator="-", new_suffix="fluid-new")
|
|
868
|
+
"""
|
|
869
|
+
pass
|
|
870
|
+
|
|
871
|
+
class replace_object_suffix(PyCommand):
|
|
872
|
+
"""
|
|
873
|
+
Rename objects by replacing the object suffix with a new suffix.
|
|
874
|
+
|
|
875
|
+
Parameters
|
|
876
|
+
----------
|
|
877
|
+
object_name_list : list[str]
|
|
878
|
+
List containing the object names.
|
|
879
|
+
separator : str
|
|
880
|
+
Mesh object name separator.
|
|
881
|
+
new_suffix : str
|
|
882
|
+
New object name suffix.
|
|
883
|
+
|
|
884
|
+
Returns
|
|
885
|
+
-------
|
|
886
|
+
None
|
|
887
|
+
|
|
888
|
+
Examples
|
|
889
|
+
--------
|
|
890
|
+
>>> meshing_session.meshing_utilities.replace_object_suffix(object_name_list=["elbow-fluid"], separator="-", new_suffix="fluid-new")
|
|
891
|
+
"""
|
|
892
|
+
pass
|
|
893
|
+
|
|
894
|
+
class set_number_of_parallel_compute_threads(PyCommand):
|
|
895
|
+
"""
|
|
896
|
+
- Set the number of compute threads to use for algorithms like mesh check and quality computation.
|
|
897
|
+
- You can use a variable number of compute threads for these algorithms depending on the current machine loads.
|
|
898
|
+
- The number of compute threads is between 2 and the value (maximum-cores-available - 1).
|
|
899
|
+
|
|
900
|
+
Parameters
|
|
901
|
+
----------
|
|
902
|
+
nthreads : int
|
|
903
|
+
Number of compute threads.
|
|
904
|
+
|
|
905
|
+
Returns
|
|
906
|
+
-------
|
|
907
|
+
None
|
|
908
|
+
|
|
909
|
+
Examples
|
|
910
|
+
--------
|
|
911
|
+
>>> meshing_session.meshing_utilities.set_number_of_parallel_compute_threads(nthreads=2)
|
|
912
|
+
"""
|
|
913
|
+
pass
|
|
914
|
+
|
|
915
|
+
class set_object_cell_zone_type(PyCommand):
|
|
916
|
+
"""
|
|
917
|
+
Set object cell zone type.
|
|
918
|
+
|
|
919
|
+
Parameters
|
|
920
|
+
----------
|
|
921
|
+
object_name : str
|
|
922
|
+
Mesh object name.
|
|
923
|
+
cell_zone_type : str
|
|
924
|
+
Cell zone type.
|
|
925
|
+
|
|
926
|
+
Returns
|
|
927
|
+
-------
|
|
928
|
+
None
|
|
929
|
+
|
|
930
|
+
Examples
|
|
931
|
+
--------
|
|
932
|
+
>>> meshing_session.meshing_utilities.set_object_cell_zone_type(object_name="elbow-fluid", cell_zone_type="mixed")
|
|
933
|
+
"""
|
|
934
|
+
pass
|
|
935
|
+
|
|
936
|
+
class set_quality_measure(PyCommand):
|
|
937
|
+
"""
|
|
938
|
+
- Set the quality measure.
|
|
939
|
+
- Specify the 'measure' as one of the 'Orthogonal Quality', 'Skewness', 'Equiangle Skewness', 'Size Change', 'Edge Ratio', 'Size', 'Aspect Ratio', 'Squish', 'Warp', 'Dihedral Angle', 'ICEMCFD Quality', 'Ortho Skew', 'FLUENT Aspect Ratio', 'Inverse Orthogonal Quality' value.
|
|
940
|
+
|
|
941
|
+
Parameters
|
|
942
|
+
----------
|
|
943
|
+
measure : str
|
|
944
|
+
Quality measure.
|
|
945
|
+
|
|
946
|
+
Returns
|
|
947
|
+
-------
|
|
948
|
+
None
|
|
949
|
+
|
|
950
|
+
Examples
|
|
951
|
+
--------
|
|
952
|
+
>>> meshing_session.meshing_utilities.set_quality_measure(measure="Aspect Ratio")
|
|
953
|
+
"""
|
|
954
|
+
pass
|
|
955
|
+
|
|
956
|
+
class _cell_zones_labels_fdl(PyQuery):
|
|
957
|
+
"""
|
|
958
|
+
Get a list containing the cell zone labels.
|
|
959
|
+
|
|
960
|
+
Returns
|
|
961
|
+
-------
|
|
962
|
+
None
|
|
963
|
+
|
|
964
|
+
Examples
|
|
965
|
+
--------
|
|
966
|
+
>>> meshing_session.meshing_utilities._cell_zones_labels_fdl()
|
|
967
|
+
"""
|
|
968
|
+
pass
|
|
969
|
+
|
|
970
|
+
class _cell_zones_str_fdl(PyQuery):
|
|
971
|
+
"""
|
|
972
|
+
Get a list containing the cell zone IDs.
|
|
973
|
+
|
|
974
|
+
Returns
|
|
975
|
+
-------
|
|
976
|
+
None
|
|
977
|
+
|
|
978
|
+
Examples
|
|
979
|
+
--------
|
|
980
|
+
>>> meshing_session.meshing_utilities._cell_zones_str_fdl()
|
|
981
|
+
"""
|
|
982
|
+
pass
|
|
983
|
+
|
|
984
|
+
class _edge_zones_labels_fdl(PyQuery):
|
|
985
|
+
"""
|
|
986
|
+
Get a list containing the edge zone labels.
|
|
987
|
+
|
|
988
|
+
Returns
|
|
989
|
+
-------
|
|
990
|
+
None
|
|
991
|
+
|
|
992
|
+
Examples
|
|
993
|
+
--------
|
|
994
|
+
>>> meshing_session.meshing_utilities._edge_zones_labels_fdl()
|
|
995
|
+
"""
|
|
996
|
+
pass
|
|
997
|
+
|
|
998
|
+
class _edge_zones_str_fdl(PyQuery):
|
|
999
|
+
"""
|
|
1000
|
+
Get a list containing the edge zone IDs.
|
|
1001
|
+
|
|
1002
|
+
Returns
|
|
1003
|
+
-------
|
|
1004
|
+
None
|
|
1005
|
+
|
|
1006
|
+
Examples
|
|
1007
|
+
--------
|
|
1008
|
+
>>> meshing_session.meshing_utilities._edge_zones_str_fdl()
|
|
1009
|
+
"""
|
|
1010
|
+
pass
|
|
1011
|
+
|
|
1012
|
+
class _face_zones_labels_fdl(PyQuery):
|
|
1013
|
+
"""
|
|
1014
|
+
Get a list containing the face zone labels.
|
|
1015
|
+
|
|
1016
|
+
Returns
|
|
1017
|
+
-------
|
|
1018
|
+
None
|
|
1019
|
+
|
|
1020
|
+
Examples
|
|
1021
|
+
--------
|
|
1022
|
+
>>> meshing_session.meshing_utilities._face_zones_labels_fdl()
|
|
1023
|
+
"""
|
|
1024
|
+
pass
|
|
1025
|
+
|
|
1026
|
+
class _face_zones_str_fdl(PyQuery):
|
|
1027
|
+
"""
|
|
1028
|
+
Get a list containing the face zone IDs.
|
|
1029
|
+
|
|
1030
|
+
Returns
|
|
1031
|
+
-------
|
|
1032
|
+
None
|
|
1033
|
+
|
|
1034
|
+
Examples
|
|
1035
|
+
--------
|
|
1036
|
+
>>> meshing_session.meshing_utilities._face_zones_str_fdl()
|
|
1037
|
+
"""
|
|
1038
|
+
pass
|
|
1039
|
+
|
|
1040
|
+
class _node_zones_labels_fdl(PyQuery):
|
|
1041
|
+
"""
|
|
1042
|
+
Get a list containing the node zone labels.
|
|
1043
|
+
|
|
1044
|
+
Returns
|
|
1045
|
+
-------
|
|
1046
|
+
None
|
|
1047
|
+
|
|
1048
|
+
Examples
|
|
1049
|
+
--------
|
|
1050
|
+
>>> meshing_session.meshing_utilities._node_zones_labels_fdl()
|
|
1051
|
+
"""
|
|
1052
|
+
pass
|
|
1053
|
+
|
|
1054
|
+
class _node_zones_str_fdl(PyQuery):
|
|
1055
|
+
"""
|
|
1056
|
+
Get a list containing the node zone IDs.
|
|
1057
|
+
|
|
1058
|
+
Returns
|
|
1059
|
+
-------
|
|
1060
|
+
None
|
|
1061
|
+
|
|
1062
|
+
Examples
|
|
1063
|
+
--------
|
|
1064
|
+
>>> meshing_session.meshing_utilities._node_zones_str_fdl()
|
|
1065
|
+
"""
|
|
1066
|
+
pass
|
|
1067
|
+
|
|
1068
|
+
class _object_names_str_fdl(PyQuery):
|
|
1069
|
+
"""
|
|
1070
|
+
Get a list containing the object names.
|
|
1071
|
+
|
|
1072
|
+
Returns
|
|
1073
|
+
-------
|
|
1074
|
+
None
|
|
1075
|
+
|
|
1076
|
+
Examples
|
|
1077
|
+
--------
|
|
1078
|
+
>>> meshing_session.meshing_utilities._object_names_str_fdl()
|
|
1079
|
+
"""
|
|
1080
|
+
pass
|
|
1081
|
+
|
|
1082
|
+
class _prism_cell_zones_labels_fdl(PyQuery):
|
|
1083
|
+
"""
|
|
1084
|
+
Get a list containing the prism cell zone labels.
|
|
1085
|
+
|
|
1086
|
+
Returns
|
|
1087
|
+
-------
|
|
1088
|
+
None
|
|
1089
|
+
|
|
1090
|
+
Examples
|
|
1091
|
+
--------
|
|
1092
|
+
>>> meshing_session.meshing_utilities._prism_cell_zones_labels_fdl()
|
|
1093
|
+
"""
|
|
1094
|
+
pass
|
|
1095
|
+
|
|
1096
|
+
class _prism_cell_zones_str_fdl(PyQuery):
|
|
1097
|
+
"""
|
|
1098
|
+
Get a list containing the prism cell zone IDs.
|
|
1099
|
+
|
|
1100
|
+
Returns
|
|
1101
|
+
-------
|
|
1102
|
+
None
|
|
1103
|
+
|
|
1104
|
+
Examples
|
|
1105
|
+
--------
|
|
1106
|
+
>>> meshing_session.meshing_utilities._prism_cell_zones_str_fdl()
|
|
1107
|
+
"""
|
|
1108
|
+
pass
|
|
1109
|
+
|
|
1110
|
+
class _regions_str_fdl(PyQuery):
|
|
1111
|
+
"""
|
|
1112
|
+
Get a list containing the region names.
|
|
1113
|
+
|
|
1114
|
+
Returns
|
|
1115
|
+
-------
|
|
1116
|
+
None
|
|
1117
|
+
|
|
1118
|
+
Examples
|
|
1119
|
+
--------
|
|
1120
|
+
>>> meshing_session.meshing_utilities._regions_str_fdl()
|
|
1121
|
+
"""
|
|
1122
|
+
pass
|
|
1123
|
+
|
|
1124
|
+
class _zone_types_fdl(PyQuery):
|
|
1125
|
+
"""
|
|
1126
|
+
Get a list containing the zone type names.
|
|
1127
|
+
|
|
1128
|
+
Returns
|
|
1129
|
+
-------
|
|
1130
|
+
None
|
|
1131
|
+
|
|
1132
|
+
Examples
|
|
1133
|
+
--------
|
|
1134
|
+
>>> meshing_session.meshing_utilities._zone_types_fdl()
|
|
1135
|
+
"""
|
|
1136
|
+
pass
|
|
1137
|
+
|
|
1138
|
+
class boundary_zone_exists(PyQuery):
|
|
1139
|
+
"""
|
|
1140
|
+
Report if the boundary face zone exists.
|
|
1141
|
+
|
|
1142
|
+
Parameters
|
|
1143
|
+
----------
|
|
1144
|
+
zone_id : int
|
|
1145
|
+
Zone ID.
|
|
1146
|
+
zone_name : str
|
|
1147
|
+
Zone name.
|
|
1148
|
+
|
|
1149
|
+
Returns
|
|
1150
|
+
-------
|
|
1151
|
+
bool
|
|
1152
|
+
|
|
1153
|
+
Examples
|
|
1154
|
+
--------
|
|
1155
|
+
>>> meshing_session.meshing_utilities.boundary_zone_exists(zone_id=31)
|
|
1156
|
+
>>> meshing_session.meshing_utilities.boundary_zone_exists(zone_name="wall-inlet")
|
|
1157
|
+
"""
|
|
1158
|
+
pass
|
|
1159
|
+
|
|
1160
|
+
class cell_zone_exists(PyQuery):
|
|
1161
|
+
"""
|
|
1162
|
+
Report if the volume mesh exists.
|
|
1163
|
+
|
|
1164
|
+
Parameters
|
|
1165
|
+
----------
|
|
1166
|
+
zone_id : int
|
|
1167
|
+
Cell zone ID.
|
|
1168
|
+
zone_name : str
|
|
1169
|
+
Cell zone name.
|
|
1170
|
+
|
|
1171
|
+
Returns
|
|
1172
|
+
-------
|
|
1173
|
+
bool
|
|
1174
|
+
|
|
1175
|
+
Examples
|
|
1176
|
+
--------
|
|
1177
|
+
>>> meshing_session.meshing_utilities.cell_zone_exists(zone_id=87)
|
|
1178
|
+
>>> meshing_session.meshing_utilities.cell_zone_exists(zone_name="elbow.87")
|
|
1179
|
+
"""
|
|
1180
|
+
pass
|
|
1181
|
+
|
|
1182
|
+
class convert_zone_ids_to_name_strings(PyQuery):
|
|
1183
|
+
"""
|
|
1184
|
+
Convert a list of IDs to a list of names.
|
|
1185
|
+
|
|
1186
|
+
Parameters
|
|
1187
|
+
----------
|
|
1188
|
+
zone_id_list : list[int]
|
|
1189
|
+
List containing the face or edge or cell or node zone IDs.
|
|
1190
|
+
|
|
1191
|
+
Returns
|
|
1192
|
+
-------
|
|
1193
|
+
list[str]
|
|
1194
|
+
|
|
1195
|
+
Examples
|
|
1196
|
+
--------
|
|
1197
|
+
>>> meshing_session.meshing_utilities.convert_zone_ids_to_name_strings(zone_id_list=[32, 31])
|
|
1198
|
+
"""
|
|
1199
|
+
pass
|
|
1200
|
+
|
|
1201
|
+
class convert_zone_name_strings_to_ids(PyQuery):
|
|
1202
|
+
"""
|
|
1203
|
+
Convert a list of zone name strings to a list of IDs.
|
|
1204
|
+
|
|
1205
|
+
Parameters
|
|
1206
|
+
----------
|
|
1207
|
+
zone_name_list : list[str]
|
|
1208
|
+
List containing the face or edge or cell or node zone names.
|
|
1209
|
+
|
|
1210
|
+
Returns
|
|
1211
|
+
-------
|
|
1212
|
+
list[int]
|
|
1213
|
+
|
|
1214
|
+
Examples
|
|
1215
|
+
--------
|
|
1216
|
+
>>> meshing_session.meshing_utilities.convert_zone_name_strings_to_ids(zone_name_list=["outlet", "cold-inlet"])
|
|
1217
|
+
"""
|
|
1218
|
+
pass
|
|
1219
|
+
|
|
1220
|
+
class copy_face_zone_labels(PyQuery):
|
|
1221
|
+
"""
|
|
1222
|
+
- Copy labels from one face zone to another.
|
|
1223
|
+
- Specify either face zone names or IDs.
|
|
1224
|
+
|
|
1225
|
+
Parameters
|
|
1226
|
+
----------
|
|
1227
|
+
from_face_zone_id : int
|
|
1228
|
+
Face zone ID.
|
|
1229
|
+
from_face_zone_name : str
|
|
1230
|
+
Face zone name.
|
|
1231
|
+
to_face_zone_id : int
|
|
1232
|
+
Face zone ID.
|
|
1233
|
+
to_face_zone_name : str
|
|
1234
|
+
Face zone name.
|
|
1235
|
+
|
|
1236
|
+
Returns
|
|
1237
|
+
-------
|
|
1238
|
+
None
|
|
1239
|
+
|
|
1240
|
+
Examples
|
|
1241
|
+
--------
|
|
1242
|
+
>>> meshing_session.meshing_utilities.copy_face_zone_labels(from_face_zone_id=33, to_face_zone_id=34)
|
|
1243
|
+
"""
|
|
1244
|
+
pass
|
|
1245
|
+
|
|
1246
|
+
class count_marked_faces(PyQuery):
|
|
1247
|
+
"""
|
|
1248
|
+
Returns the count of marked faces for the face zones specified.
|
|
1249
|
+
|
|
1250
|
+
Parameters
|
|
1251
|
+
----------
|
|
1252
|
+
face_zone_id_list : list[int]
|
|
1253
|
+
List containing the face zone IDs.
|
|
1254
|
+
face_zone_name_list : list[str]
|
|
1255
|
+
List containing the face zone names.
|
|
1256
|
+
face_zone_name_pattern : str
|
|
1257
|
+
Face zone name pattern.
|
|
1258
|
+
|
|
1259
|
+
Returns
|
|
1260
|
+
-------
|
|
1261
|
+
int
|
|
1262
|
+
|
|
1263
|
+
Examples
|
|
1264
|
+
--------
|
|
1265
|
+
>>> meshing_session.meshing_utilities.count_marked_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
1266
|
+
>>> meshing_session.meshing_utilities.count_marked_faces(face_zone_name_pattern="*")
|
|
1267
|
+
"""
|
|
1268
|
+
pass
|
|
1269
|
+
|
|
1270
|
+
class create_boi_and_size_functions_from_refinement_regions(PyQuery):
|
|
1271
|
+
"""
|
|
1272
|
+
- Create bodies of influence and if required body of influence size functions from the mesh refinement regions.
|
|
1273
|
+
- Specify the refinement region type (set 'region_type' to 'tet' or 'hexcore').
|
|
1274
|
+
- Specify the prefix for the BOI zones ('boi_prefix_string'), and choose whether to create the size functions (set create_size_function to True or False).
|
|
1275
|
+
|
|
1276
|
+
Parameters
|
|
1277
|
+
----------
|
|
1278
|
+
region_type : str
|
|
1279
|
+
Specify the refinement region type.
|
|
1280
|
+
boi_prefix_string : str
|
|
1281
|
+
Specify the prefix for the BOI zones.
|
|
1282
|
+
create_size_function : bool
|
|
1283
|
+
Specify whether to create the size functions.
|
|
1284
|
+
|
|
1285
|
+
Returns
|
|
1286
|
+
-------
|
|
1287
|
+
None
|
|
1288
|
+
|
|
1289
|
+
Examples
|
|
1290
|
+
--------
|
|
1291
|
+
>>> meshing_session.meshing_utilities.create_boi_and_size_functions_from_refinement_regions(region_type="hexcore", boi_prefix_string="wall", create_size_function=True)
|
|
1292
|
+
"""
|
|
1293
|
+
pass
|
|
1294
|
+
|
|
1295
|
+
class dump_face_zone_orientation_in_region(PyQuery):
|
|
1296
|
+
"""
|
|
1297
|
+
Return the face zones and their orientation for the mesh file specified.
|
|
1298
|
+
|
|
1299
|
+
Parameters
|
|
1300
|
+
----------
|
|
1301
|
+
file_name : str
|
|
1302
|
+
Mesh file name.
|
|
1303
|
+
|
|
1304
|
+
Returns
|
|
1305
|
+
-------
|
|
1306
|
+
None
|
|
1307
|
+
|
|
1308
|
+
Examples
|
|
1309
|
+
--------
|
|
1310
|
+
>>> meshing_session.meshing_utilities.dump_face_zone_orientation_in_region(file_name="facezonetest.txt")
|
|
1311
|
+
"""
|
|
1312
|
+
pass
|
|
1313
|
+
|
|
1314
|
+
class fill_holes_in_face_zone_list(PyQuery):
|
|
1315
|
+
"""
|
|
1316
|
+
Fill holes associated with free edges for the face zones specified, based on the number of free edges (max_hole_edges).
|
|
1317
|
+
|
|
1318
|
+
Parameters
|
|
1319
|
+
----------
|
|
1320
|
+
face_zone_id_list : list[int]
|
|
1321
|
+
List containing the face zone IDs.
|
|
1322
|
+
face_zone_name_list : list[str]
|
|
1323
|
+
List containing the face zone names.
|
|
1324
|
+
face_zone_name_pattern : str
|
|
1325
|
+
Face zone name pattern.
|
|
1326
|
+
max_hole_edges : int
|
|
1327
|
+
Number of maximum hole edges.
|
|
1328
|
+
|
|
1329
|
+
Returns
|
|
1330
|
+
-------
|
|
1331
|
+
None
|
|
1332
|
+
|
|
1333
|
+
Examples
|
|
1334
|
+
--------
|
|
1335
|
+
>>> meshing_session.meshing_utilities.fill_holes_in_face_zone_list(face_zone_id_list=[30, 31, 32], max_hole_edges=2)
|
|
1336
|
+
>>> meshing_session.meshing_utilities.fill_holes_in_face_zone_list(face_zone_name_list=["wall-inlet", "wallfluid-new"], max_hole_edges=2)
|
|
1337
|
+
>>> meshing_session.meshing_utilities.fill_holes_in_face_zone_list(face_zone_name_pattern="wall*", max_hole_edges=2)
|
|
1338
|
+
"""
|
|
1339
|
+
pass
|
|
1340
|
+
|
|
1341
|
+
class get_adjacent_cell_zones_for_given_face_zones(PyQuery):
|
|
1342
|
+
"""
|
|
1343
|
+
Return adjacent cell zones for given face zones.
|
|
1344
|
+
|
|
1345
|
+
Parameters
|
|
1346
|
+
----------
|
|
1347
|
+
face_zone_id_list : list[int]
|
|
1348
|
+
List containing the face zone IDs.
|
|
1349
|
+
face_zone_name_list : list[str]
|
|
1350
|
+
List containing the face zone names.
|
|
1351
|
+
face_zone_name_pattern : str
|
|
1352
|
+
Face zone name pattern.
|
|
1353
|
+
|
|
1354
|
+
Returns
|
|
1355
|
+
-------
|
|
1356
|
+
list[int]
|
|
1357
|
+
|
|
1358
|
+
Examples
|
|
1359
|
+
--------
|
|
1360
|
+
>>> meshing_session.meshing_utilities.get_adjacent_cell_zones_for_given_face_zones(face_zone_id_list=[29, 30, 31, 32, 33])
|
|
1361
|
+
>>> meshing_session.meshing_utilities.get_adjacent_cell_zones_for_given_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
1362
|
+
>>> meshing_session.meshing_utilities.get_adjacent_cell_zones_for_given_face_zones(face_zone_name_pattern="*")
|
|
1363
|
+
"""
|
|
1364
|
+
pass
|
|
1365
|
+
|
|
1366
|
+
class get_adjacent_face_zones_for_given_cell_zones(PyQuery):
|
|
1367
|
+
"""
|
|
1368
|
+
Return adjacent boundary face zones for given cell zones.
|
|
1369
|
+
|
|
1370
|
+
Parameters
|
|
1371
|
+
----------
|
|
1372
|
+
cell_zone_id_list : list[int]
|
|
1373
|
+
List containing the cell zone IDs.
|
|
1374
|
+
cell_zone_name_list : list[str]
|
|
1375
|
+
List containing the cell zone names.
|
|
1376
|
+
cell_zone_name_pattern : str
|
|
1377
|
+
Cell zone name pattern.
|
|
1378
|
+
|
|
1379
|
+
Returns
|
|
1380
|
+
-------
|
|
1381
|
+
list[int]
|
|
1382
|
+
|
|
1383
|
+
Examples
|
|
1384
|
+
--------
|
|
1385
|
+
>>> meshing_session.meshing_utilities.get_adjacent_face_zones_for_given_cell_zones(cell_zone_id_list=[87])
|
|
1386
|
+
>>> meshing_session.meshing_utilities.get_adjacent_face_zones_for_given_cell_zones(cell_zone_name_list=["elbow-fluid"])
|
|
1387
|
+
>>> meshing_session.meshing_utilities.get_adjacent_face_zones_for_given_cell_zones(cell_zone_name_pattern="*")
|
|
1388
|
+
"""
|
|
1389
|
+
pass
|
|
1390
|
+
|
|
1391
|
+
class get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones(PyQuery):
|
|
1392
|
+
"""
|
|
1393
|
+
Return adjacent interior and boundary face zones for given cell zones.
|
|
1394
|
+
|
|
1395
|
+
Parameters
|
|
1396
|
+
----------
|
|
1397
|
+
cell_zone_id_list : list[int]
|
|
1398
|
+
List containing the cell zone IDs.
|
|
1399
|
+
cell_zone_name_list : list[str]
|
|
1400
|
+
List containing the cell zone names.
|
|
1401
|
+
cell_zone_name_pattern : str
|
|
1402
|
+
Cell zone name pattern.
|
|
1403
|
+
|
|
1404
|
+
Returns
|
|
1405
|
+
-------
|
|
1406
|
+
list[int]
|
|
1407
|
+
|
|
1408
|
+
Examples
|
|
1409
|
+
--------
|
|
1410
|
+
>>> meshing_session.meshing_utilities.get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones(cell_zone_id_list=[87])
|
|
1411
|
+
>>> meshing_session.meshing_utilities.get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones(cell_zone_name_list=["elbow-fluid"])
|
|
1412
|
+
>>> meshing_session.meshing_utilities.get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones(cell_zone_name_pattern="*")
|
|
1413
|
+
"""
|
|
1414
|
+
pass
|
|
1415
|
+
|
|
1416
|
+
class get_adjacent_zones_by_edge_connectivity(PyQuery):
|
|
1417
|
+
"""
|
|
1418
|
+
Return adjacent zones based on edge connectivity.
|
|
1419
|
+
|
|
1420
|
+
Parameters
|
|
1421
|
+
----------
|
|
1422
|
+
zone_id_list : list[int]
|
|
1423
|
+
List containing the face or edge or cell or node zone IDs.
|
|
1424
|
+
zone_name_list : list[str]
|
|
1425
|
+
List containing the face or edge or cell or node zone names.
|
|
1426
|
+
zone_name_pattern : str
|
|
1427
|
+
Face or edge or cell or node zone name pattern.
|
|
1428
|
+
|
|
1429
|
+
Returns
|
|
1430
|
+
-------
|
|
1431
|
+
list[int]
|
|
1432
|
+
|
|
1433
|
+
Examples
|
|
1434
|
+
--------
|
|
1435
|
+
>>> meshing_session.meshing_utilities.get_adjacent_zones_by_edge_connectivity(zone_id_list=[29, 30, 31, 32, 33])
|
|
1436
|
+
>>> meshing_session.meshing_utilities.get_adjacent_zones_by_edge_connectivity(zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
1437
|
+
>>> meshing_session.meshing_utilities.get_adjacent_zones_by_edge_connectivity(zone_name_pattern="*")
|
|
1438
|
+
"""
|
|
1439
|
+
pass
|
|
1440
|
+
|
|
1441
|
+
class get_adjacent_zones_by_node_connectivity(PyQuery):
|
|
1442
|
+
"""
|
|
1443
|
+
Return adjacent zones based on node connectivity.
|
|
1444
|
+
|
|
1445
|
+
Parameters
|
|
1446
|
+
----------
|
|
1447
|
+
zone_id_list : list[int]
|
|
1448
|
+
List containing the face or edge or cell or node zone IDs.
|
|
1449
|
+
zone_name_list : list[str]
|
|
1450
|
+
List containing the face or edge or cell or node zone names.
|
|
1451
|
+
zone_name_pattern : str
|
|
1452
|
+
Face or edge or cell or node zone name pattern.
|
|
1453
|
+
|
|
1454
|
+
Returns
|
|
1455
|
+
-------
|
|
1456
|
+
list[int]
|
|
1457
|
+
|
|
1458
|
+
Examples
|
|
1459
|
+
--------
|
|
1460
|
+
>>> meshing_session.meshing_utilities.get_adjacent_zones_by_node_connectivity(zone_id_list=[29, 30, 31, 32, 33])
|
|
1461
|
+
>>> meshing_session.meshing_utilities.get_adjacent_zones_by_node_connectivity(zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
1462
|
+
>>> meshing_session.meshing_utilities.get_adjacent_zones_by_node_connectivity(zone_name_pattern="*")
|
|
1463
|
+
"""
|
|
1464
|
+
pass
|
|
1465
|
+
|
|
1466
|
+
class get_all_objects(PyQuery):
|
|
1467
|
+
"""
|
|
1468
|
+
Return a list of all objects.
|
|
1469
|
+
|
|
1470
|
+
Returns
|
|
1471
|
+
-------
|
|
1472
|
+
list[str]
|
|
1473
|
+
|
|
1474
|
+
Examples
|
|
1475
|
+
--------
|
|
1476
|
+
>>> meshing_session.meshing_utilities.get_all_objects()
|
|
1477
|
+
"""
|
|
1478
|
+
pass
|
|
1479
|
+
|
|
1480
|
+
class get_average_bounding_box_center(PyQuery):
|
|
1481
|
+
"""
|
|
1482
|
+
Return a suitable average point based on the zones specified.
|
|
1483
|
+
|
|
1484
|
+
Parameters
|
|
1485
|
+
----------
|
|
1486
|
+
face_zone_id_list : list[int]
|
|
1487
|
+
List containing the face zone IDs.
|
|
1488
|
+
|
|
1489
|
+
Returns
|
|
1490
|
+
-------
|
|
1491
|
+
list[float]
|
|
1492
|
+
|
|
1493
|
+
Examples
|
|
1494
|
+
--------
|
|
1495
|
+
>>> meshing_session.meshing_utilities.get_average_bounding_box_center(face_zone_id_list=[30, 31, 32])
|
|
1496
|
+
"""
|
|
1497
|
+
pass
|
|
1498
|
+
|
|
1499
|
+
class get_baffles_for_face_zones(PyQuery):
|
|
1500
|
+
"""
|
|
1501
|
+
Return the baffle zones based on the face zone list specified.
|
|
1502
|
+
|
|
1503
|
+
Parameters
|
|
1504
|
+
----------
|
|
1505
|
+
face_zone_id_list : list[int]
|
|
1506
|
+
List containing the face zone IDs.
|
|
1507
|
+
|
|
1508
|
+
Returns
|
|
1509
|
+
-------
|
|
1510
|
+
list[int]
|
|
1511
|
+
|
|
1512
|
+
Examples
|
|
1513
|
+
--------
|
|
1514
|
+
>>> meshing_session.meshing_utilities.get_baffles_for_face_zones(face_zone_id_list=[29, 30, 31, 32, 33])
|
|
1515
|
+
"""
|
|
1516
|
+
pass
|
|
1517
|
+
|
|
1518
|
+
class get_bounding_box_of_zone_list(PyQuery):
|
|
1519
|
+
"""
|
|
1520
|
+
Return the bounding box extents for the list of zones.
|
|
1521
|
+
|
|
1522
|
+
Parameters
|
|
1523
|
+
----------
|
|
1524
|
+
zone_id_list : list[int]
|
|
1525
|
+
List containing the face or edge or cell or node zone IDs.
|
|
1526
|
+
|
|
1527
|
+
Returns
|
|
1528
|
+
-------
|
|
1529
|
+
None
|
|
1530
|
+
|
|
1531
|
+
Examples
|
|
1532
|
+
--------
|
|
1533
|
+
>>> meshing_session.meshing_utilities.get_bounding_box_of_zone_list(zone_id_list=[26])
|
|
1534
|
+
"""
|
|
1535
|
+
pass
|
|
1536
|
+
|
|
1537
|
+
class get_cell_mesh_distribution(PyQuery):
|
|
1538
|
+
"""
|
|
1539
|
+
- Report the cell mesh distribution based on the specified measure, partitions, and range.
|
|
1540
|
+
- Specify the 'measure' as one of the 'Orthogonal Quality', 'Skewness', 'Equiangle Skewness', 'Size Change', 'Edge Ratio', 'Size', 'Aspect Ratio', 'Squish', 'Warp', 'Dihedral Angle', 'ICEMCFD Quality', 'Ortho Skew', 'FLUENT Aspect Ratio', 'Inverse Orthogonal Quality' value.
|
|
1541
|
+
|
|
1542
|
+
Parameters
|
|
1543
|
+
----------
|
|
1544
|
+
cell_zone_id_list : list[int]
|
|
1545
|
+
List containing the cell zone IDs.
|
|
1546
|
+
cell_zone_name_list : list[str]
|
|
1547
|
+
List containing the cell zone names.
|
|
1548
|
+
cell_zone_name_pattern : str
|
|
1549
|
+
Cell zone name pattern.
|
|
1550
|
+
measure : str
|
|
1551
|
+
Measure.
|
|
1552
|
+
partitions : int
|
|
1553
|
+
Partitions.
|
|
1554
|
+
range : list[float]
|
|
1555
|
+
Range.
|
|
1556
|
+
|
|
1557
|
+
Returns
|
|
1558
|
+
-------
|
|
1559
|
+
None
|
|
1560
|
+
|
|
1561
|
+
Examples
|
|
1562
|
+
--------
|
|
1563
|
+
>>> meshing_session.meshing_utilities.get_cell_mesh_distribution(cell_zone_id_list=[87], measure="Orthogonal Quality", partitions=2, range=[0.9, 1])
|
|
1564
|
+
>>> meshing_session.meshing_utilities.get_cell_mesh_distribution(cell_zone_name_list=["elbow-fluid"], measure="Orthogonal Quality", partitions=2, range=[0.9, 1])
|
|
1565
|
+
>>> meshing_session.meshing_utilities.get_cell_mesh_distribution(cell_zone_name_pattern="*", measure="Orthogonal Quality", partitions=2, range=[0.9, 1])
|
|
1566
|
+
"""
|
|
1567
|
+
pass
|
|
1568
|
+
|
|
1569
|
+
class get_cell_quality_limits(PyQuery):
|
|
1570
|
+
"""
|
|
1571
|
+
- Report the number of cells and the cell quality limits (minimum, maximum, average quality) for the list of zones based on the measure specified.
|
|
1572
|
+
- You can also report the cell size limits.
|
|
1573
|
+
- Specify the 'measure' as one of the 'Orthogonal Quality', 'Skewness', 'Equiangle Skewness', 'Size Change', 'Edge Ratio', 'Size', 'Aspect Ratio', 'Squish', 'Warp', 'Dihedral Angle', 'ICEMCFD Quality', 'Ortho Skew', 'FLUENT Aspect Ratio', 'Inverse Orthogonal Quality' value.
|
|
1574
|
+
|
|
1575
|
+
Parameters
|
|
1576
|
+
----------
|
|
1577
|
+
cell_zone_id_list : list[int]
|
|
1578
|
+
List containing the cell zone IDs.
|
|
1579
|
+
cell_zone_name_list : list[str]
|
|
1580
|
+
List containing the cell zone names.
|
|
1581
|
+
cell_zone_name_pattern : str
|
|
1582
|
+
Cell zone name pattern.
|
|
1583
|
+
measure : str
|
|
1584
|
+
Measure.
|
|
1585
|
+
|
|
1586
|
+
Returns
|
|
1587
|
+
-------
|
|
1588
|
+
None
|
|
1589
|
+
|
|
1590
|
+
Examples
|
|
1591
|
+
--------
|
|
1592
|
+
>>> meshing_session.meshing_utilities.get_cell_quality_limits(cell_zone_id_list=[87], measure="Orthogonal Quality")
|
|
1593
|
+
>>> meshing_session.meshing_utilities.get_cell_quality_limits(cell_zone_name_list=["elbow-fluid"], measure="Orthogonal Quality")
|
|
1594
|
+
>>> meshing_session.meshing_utilities.get_cell_quality_limits(cell_zone_name_pattern="*", measure="Orthogonal Quality")
|
|
1595
|
+
"""
|
|
1596
|
+
pass
|
|
1597
|
+
|
|
1598
|
+
class get_cell_zone_count(PyQuery):
|
|
1599
|
+
"""
|
|
1600
|
+
Return count of entities for cell zones.
|
|
1601
|
+
|
|
1602
|
+
Parameters
|
|
1603
|
+
----------
|
|
1604
|
+
cell_zone_id_list : list[int]
|
|
1605
|
+
List containing the cell zone IDs.
|
|
1606
|
+
cell_zone_name_list : list[str]
|
|
1607
|
+
List containing the cell zone names.
|
|
1608
|
+
cell_zone_name_pattern : str
|
|
1609
|
+
Cell zone name pattern.
|
|
1610
|
+
|
|
1611
|
+
Returns
|
|
1612
|
+
-------
|
|
1613
|
+
int
|
|
1614
|
+
|
|
1615
|
+
Examples
|
|
1616
|
+
--------
|
|
1617
|
+
>>> meshing_session.meshing_utilities.get_cell_zone_count(cell_zone_id_list=[87])
|
|
1618
|
+
>>> meshing_session.meshing_utilities.get_cell_zone_count(cell_zone_name_list=["elbow-fluid"])
|
|
1619
|
+
>>> meshing_session.meshing_utilities.get_cell_zone_count(cell_zone_name_pattern="*")
|
|
1620
|
+
"""
|
|
1621
|
+
pass
|
|
1622
|
+
|
|
1623
|
+
class get_cell_zone_id_list_with_labels(PyQuery):
|
|
1624
|
+
"""
|
|
1625
|
+
Returns the list of cell zones (by ID) containing the labels specified.
|
|
1626
|
+
|
|
1627
|
+
Parameters
|
|
1628
|
+
----------
|
|
1629
|
+
cell_zone_id_list : list[int]
|
|
1630
|
+
List containing the cell zone IDs.
|
|
1631
|
+
cell_zone_name_list : list[str]
|
|
1632
|
+
List containing the cell zone names.
|
|
1633
|
+
cell_zone_name_pattern : str
|
|
1634
|
+
Cell zone name pattern.
|
|
1635
|
+
label_name_list : list[str]
|
|
1636
|
+
List containing the label names.
|
|
1637
|
+
|
|
1638
|
+
Returns
|
|
1639
|
+
-------
|
|
1640
|
+
list[int]
|
|
1641
|
+
|
|
1642
|
+
Examples
|
|
1643
|
+
--------
|
|
1644
|
+
>>> meshing_session.meshing_utilities.get_cell_zone_id_list_with_labels(cell_zone_id_list=[87], label_name_list=["elbow-1"])
|
|
1645
|
+
>>> meshing_session.meshing_utilities.get_cell_zone_id_list_with_labels(cell_zone_name_list=["elbow-fluid"], label_name_list=["elbow-1"])
|
|
1646
|
+
>>> meshing_session.meshing_utilities.get_cell_zone_id_list_with_labels(cell_zone_name_pattern="*", label_name_list=["elbow-1"])
|
|
1647
|
+
"""
|
|
1648
|
+
pass
|
|
1649
|
+
|
|
1650
|
+
class get_cell_zone_shape(PyQuery):
|
|
1651
|
+
"""
|
|
1652
|
+
Return cell zone shape as string.
|
|
1653
|
+
|
|
1654
|
+
Parameters
|
|
1655
|
+
----------
|
|
1656
|
+
cell_zone_id : int
|
|
1657
|
+
Cell zone ID.
|
|
1658
|
+
|
|
1659
|
+
Returns
|
|
1660
|
+
-------
|
|
1661
|
+
str
|
|
1662
|
+
|
|
1663
|
+
Examples
|
|
1664
|
+
--------
|
|
1665
|
+
>>> meshing_session.meshing_utilities.get_cell_zone_shape(cell_zone_id=87)
|
|
1666
|
+
"""
|
|
1667
|
+
pass
|
|
1668
|
+
|
|
1669
|
+
class get_cell_zone_volume(PyQuery):
|
|
1670
|
+
"""
|
|
1671
|
+
Return cell zone volume for the specified zones.
|
|
1672
|
+
|
|
1673
|
+
Parameters
|
|
1674
|
+
----------
|
|
1675
|
+
cell_zone_id_list : list[int]
|
|
1676
|
+
List containing the cell zone IDs.
|
|
1677
|
+
cell_zone_name_list : list[str]
|
|
1678
|
+
List containing the cell zone names.
|
|
1679
|
+
cell_zone_name_pattern : str
|
|
1680
|
+
Cell zone name pattern.
|
|
1681
|
+
|
|
1682
|
+
Returns
|
|
1683
|
+
-------
|
|
1684
|
+
float
|
|
1685
|
+
|
|
1686
|
+
Examples
|
|
1687
|
+
--------
|
|
1688
|
+
>>> meshing_session.meshing_utilities.get_cell_zone_volume(cell_zone_id_list=[87])
|
|
1689
|
+
>>> meshing_session.meshing_utilities.get_cell_zone_volume(cell_zone_name_list=["elbow-fluid"])
|
|
1690
|
+
>>> meshing_session.meshing_utilities.get_cell_zone_volume(cell_zone_name_pattern="*")
|
|
1691
|
+
"""
|
|
1692
|
+
pass
|
|
1693
|
+
|
|
1694
|
+
class get_cell_zones(PyQuery):
|
|
1695
|
+
"""
|
|
1696
|
+
- Get cell zones using 1 - maximum_entity_count and only_boundary or 2 - xyz_coordinates or 3 - filter.
|
|
1697
|
+
- Return a list of cell zones at or closest to a specified location (xyz_coordinates).
|
|
1698
|
+
- Return a list of cell zones with a count below the maximum entity count (maximum_entity_count) specified.
|
|
1699
|
+
- You can choose to restrict the report to only boundary cell zones, if required (only_boundary set to True or False).
|
|
1700
|
+
- Return a list of zones whose names contain the specified filter string.
|
|
1701
|
+
|
|
1702
|
+
Parameters
|
|
1703
|
+
----------
|
|
1704
|
+
maximum_entity_count : float
|
|
1705
|
+
Maximum entity count.
|
|
1706
|
+
xyz_coordinates : list[float]
|
|
1707
|
+
X-Y-Z coordinates.
|
|
1708
|
+
filter : str
|
|
1709
|
+
Cell zone name filter.
|
|
1710
|
+
|
|
1711
|
+
Returns
|
|
1712
|
+
-------
|
|
1713
|
+
list[int]
|
|
1714
|
+
|
|
1715
|
+
Examples
|
|
1716
|
+
--------
|
|
1717
|
+
>>> meshing_session.meshing_utilities.get_cell_zones(filter="*")
|
|
1718
|
+
>>> meshing_session.meshing_utilities.get_cell_zones(maximum_entity_count=100)
|
|
1719
|
+
>>> meshing_session.meshing_utilities.get_cell_zones(xyz_coordinates=[-7, -6, 0.4])
|
|
1720
|
+
"""
|
|
1721
|
+
pass
|
|
1722
|
+
|
|
1723
|
+
class get_edge_size_limits(PyQuery):
|
|
1724
|
+
"""
|
|
1725
|
+
Report the edge size limits for the list of face zones.
|
|
1726
|
+
|
|
1727
|
+
Parameters
|
|
1728
|
+
----------
|
|
1729
|
+
face_zone_id_list : list[int]
|
|
1730
|
+
List containing the face zone IDs.
|
|
1731
|
+
face_zone_name_list : list[str]
|
|
1732
|
+
List containing the face zone names.
|
|
1733
|
+
face_zone_name_pattern : str
|
|
1734
|
+
Face zone name pattern.
|
|
1735
|
+
|
|
1736
|
+
Returns
|
|
1737
|
+
-------
|
|
1738
|
+
list[float]
|
|
1739
|
+
|
|
1740
|
+
Examples
|
|
1741
|
+
--------
|
|
1742
|
+
>>> meshing_session.meshing_utilities.get_edge_size_limits(face_zone_id_list=[30, 31, 32])
|
|
1743
|
+
>>> meshing_session.meshing_utilities.get_edge_size_limits(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
1744
|
+
>>> meshing_session.meshing_utilities.get_edge_size_limits(face_zone_name_pattern="*")
|
|
1745
|
+
"""
|
|
1746
|
+
pass
|
|
1747
|
+
|
|
1748
|
+
class get_edge_zone_id_list_with_labels(PyQuery):
|
|
1749
|
+
"""
|
|
1750
|
+
Returns the list of edge zones (by ID) containing the labels specified.
|
|
1751
|
+
|
|
1752
|
+
Parameters
|
|
1753
|
+
----------
|
|
1754
|
+
edge_zone_id_list : list[int]
|
|
1755
|
+
List containing the edge zone IDs.
|
|
1756
|
+
edge_zone_name_list : list[str]
|
|
1757
|
+
List containing the edge zone names.
|
|
1758
|
+
edge_zone_name_pattern : str
|
|
1759
|
+
Edge zone name pattern.
|
|
1760
|
+
label_name_list : list[str]
|
|
1761
|
+
List containing the label names.
|
|
1762
|
+
|
|
1763
|
+
Returns
|
|
1764
|
+
-------
|
|
1765
|
+
list[int]
|
|
1766
|
+
|
|
1767
|
+
Examples
|
|
1768
|
+
--------
|
|
1769
|
+
>>> meshing_session.meshing_utilities.get_edge_zone_id_list_with_labels(edge_zone_id_list=[20, 21], label_name_list=["20-1", "21-1"])
|
|
1770
|
+
>>> meshing_session.meshing_utilities.get_edge_zone_id_list_with_labels(edge_zone_name_list=["symmetry:xyplane:hot-inlet:elbow-fluid:feature.20", "hot-inlet:wall-inlet:elbow-fluid:feature.21"], label_name_list=["20-1", "21-1"])
|
|
1771
|
+
>>> meshing_session.meshing_utilities.get_edge_zone_id_list_with_labels(edge_zone_name_pattern="*", label_name_list=["20-1", "21-1"])
|
|
1772
|
+
"""
|
|
1773
|
+
pass
|
|
1774
|
+
|
|
1775
|
+
class get_edge_zones(PyQuery):
|
|
1776
|
+
"""
|
|
1777
|
+
- Get edge zones using 1 - maximum_entity_count and only_boundary or 2 - filter Return a list of edge zones with a count below the maximum entity count (maximum_entity_count) specified.
|
|
1778
|
+
- You can choose to restrict the report to only boundary edge zones, if required (only_boundary set to True or False).
|
|
1779
|
+
- Return a list of zones whose names contain the specified filter string.
|
|
1780
|
+
|
|
1781
|
+
Parameters
|
|
1782
|
+
----------
|
|
1783
|
+
maximum_entity_count : float
|
|
1784
|
+
Maximum entity count.
|
|
1785
|
+
only_boundary : bool
|
|
1786
|
+
Specify whether to restrict the report to only boundary edge zones.
|
|
1787
|
+
filter : str
|
|
1788
|
+
Edge zone name filter.
|
|
1789
|
+
|
|
1790
|
+
Returns
|
|
1791
|
+
-------
|
|
1792
|
+
list[int]
|
|
1793
|
+
|
|
1794
|
+
Examples
|
|
1795
|
+
--------
|
|
1796
|
+
>>> meshing_session.meshing_utilities.get_edge_zones(filter="*")
|
|
1797
|
+
>>> meshing_session.meshing_utilities.get_edge_zones(maximum_entity_count=20, only_boundary=False)
|
|
1798
|
+
"""
|
|
1799
|
+
pass
|
|
1800
|
+
|
|
1801
|
+
class get_edge_zones_list(PyQuery):
|
|
1802
|
+
"""
|
|
1803
|
+
Return a list of edge zones whose names contain the specified filter string.
|
|
1804
|
+
|
|
1805
|
+
Parameters
|
|
1806
|
+
----------
|
|
1807
|
+
filter : list[str]
|
|
1808
|
+
Edge zone name filter.
|
|
1809
|
+
|
|
1810
|
+
Returns
|
|
1811
|
+
-------
|
|
1812
|
+
None
|
|
1813
|
+
|
|
1814
|
+
Examples
|
|
1815
|
+
--------
|
|
1816
|
+
>>> meshing_session.meshing_utilities.get_edge_zones_list(filter="*")
|
|
1817
|
+
"""
|
|
1818
|
+
pass
|
|
1819
|
+
|
|
1820
|
+
class get_edge_zones_of_object(PyQuery):
|
|
1821
|
+
"""
|
|
1822
|
+
Return a list of edge zones in the specified object or objects.
|
|
1823
|
+
|
|
1824
|
+
Parameters
|
|
1825
|
+
----------
|
|
1826
|
+
objects : list[str]
|
|
1827
|
+
List containing the object names list.
|
|
1828
|
+
object_name : str
|
|
1829
|
+
Mesh object name.
|
|
1830
|
+
|
|
1831
|
+
Returns
|
|
1832
|
+
-------
|
|
1833
|
+
list[int]
|
|
1834
|
+
|
|
1835
|
+
Examples
|
|
1836
|
+
--------
|
|
1837
|
+
>>> meshing_session.meshing_utilities.get_edge_zones_of_object(objects=["elbow-fluid"])
|
|
1838
|
+
>>> meshing_session.meshing_utilities.get_edge_zones_of_object(object_name="elbow-fluid")
|
|
1839
|
+
"""
|
|
1840
|
+
pass
|
|
1841
|
+
|
|
1842
|
+
class get_embedded_baffles(PyQuery):
|
|
1843
|
+
"""
|
|
1844
|
+
Return the embedded baffle zones.
|
|
1845
|
+
|
|
1846
|
+
Returns
|
|
1847
|
+
-------
|
|
1848
|
+
list[int]
|
|
1849
|
+
|
|
1850
|
+
Examples
|
|
1851
|
+
--------
|
|
1852
|
+
>>> meshing_session.meshing_utilities.get_embedded_baffles()
|
|
1853
|
+
"""
|
|
1854
|
+
pass
|
|
1855
|
+
|
|
1856
|
+
class get_face_mesh_distribution(PyQuery):
|
|
1857
|
+
"""
|
|
1858
|
+
- Report the face mesh distribution based on the specified measure, partitions, and range.
|
|
1859
|
+
- Specify the 'measure' as one of the 'Orthogonal Quality', 'Skewness', 'Equiangle Skewness', 'Size Change', 'Edge Ratio', 'Size', 'Aspect Ratio', 'Squish', 'Warp', 'Dihedral Angle', 'ICEMCFD Quality', 'Ortho Skew', 'FLUENT Aspect Ratio', 'Inverse Orthogonal Quality' value.
|
|
1860
|
+
|
|
1861
|
+
Parameters
|
|
1862
|
+
----------
|
|
1863
|
+
face_zone_id_list : list[int]
|
|
1864
|
+
List containing the face zone IDs.
|
|
1865
|
+
face_zone_name_list : list[str]
|
|
1866
|
+
List containing the face zone names.
|
|
1867
|
+
face_zone_name_pattern : str
|
|
1868
|
+
Face zone name pattern.
|
|
1869
|
+
measure : str
|
|
1870
|
+
Measure.
|
|
1871
|
+
partitions : int
|
|
1872
|
+
Partitions.
|
|
1873
|
+
range : list[float]
|
|
1874
|
+
Range.
|
|
1875
|
+
|
|
1876
|
+
Returns
|
|
1877
|
+
-------
|
|
1878
|
+
None
|
|
1879
|
+
|
|
1880
|
+
Examples
|
|
1881
|
+
--------
|
|
1882
|
+
>>> meshing_session.meshing_utilities.get_face_mesh_distribution(face_zone_id_list=[30, 31, 32], measure="Orthogonal Quality", partitions=2, range=[0.9, 1])
|
|
1883
|
+
>>> meshing_session.meshing_utilities.get_face_mesh_distribution(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], measure="Orthogonal Quality", partitions=2, range=[0.9, 1])
|
|
1884
|
+
>>> meshing_session.meshing_utilities.get_face_mesh_distribution(face_zone_name_pattern="*", measure="Orthogonal Quality", partitions=2, range=[0.9, 1])
|
|
1885
|
+
"""
|
|
1886
|
+
pass
|
|
1887
|
+
|
|
1888
|
+
class get_face_quality_limits(PyQuery):
|
|
1889
|
+
"""
|
|
1890
|
+
- Report the number of faces and the face quality limits (minimum, maximum, average quality) for the list of zones based on the measure specified.
|
|
1891
|
+
- You can also report the face size limits.
|
|
1892
|
+
- Specify the 'measure' as one of the 'Orthogonal Quality', 'Skewness', 'Equiangle Skewness', 'Size Change', 'Edge Ratio', 'Size', 'Aspect Ratio', 'Squish', 'Warp', 'Dihedral Angle', 'ICEMCFD Quality', 'Ortho Skew', 'FLUENT Aspect Ratio', 'Inverse Orthogonal Quality' value.
|
|
1893
|
+
|
|
1894
|
+
Parameters
|
|
1895
|
+
----------
|
|
1896
|
+
face_zone_id_list : list[int]
|
|
1897
|
+
List containing the face zone IDs.
|
|
1898
|
+
face_zone_name_list : list[str]
|
|
1899
|
+
List containing the face zone names.
|
|
1900
|
+
face_zone_name_pattern : str
|
|
1901
|
+
Face zone name pattern.
|
|
1902
|
+
measure : str
|
|
1903
|
+
Measure.
|
|
1904
|
+
|
|
1905
|
+
Returns
|
|
1906
|
+
-------
|
|
1907
|
+
None
|
|
1908
|
+
|
|
1909
|
+
Examples
|
|
1910
|
+
--------
|
|
1911
|
+
>>> meshing_session.meshing_utilities.get_face_quality_limits(face_zone_id_list=[30, 31, 32], measure="Orthogonal Quality")
|
|
1912
|
+
>>> meshing_session.meshing_utilities.get_face_quality_limits(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], measure="Orthogonal Quality")
|
|
1913
|
+
>>> meshing_session.meshing_utilities.get_face_quality_limits(face_zone_name_pattern="*", measure="Orthogonal Quality")
|
|
1914
|
+
"""
|
|
1915
|
+
pass
|
|
1916
|
+
|
|
1917
|
+
class get_face_zone_area(PyQuery):
|
|
1918
|
+
"""
|
|
1919
|
+
Return face zone area for the specified zones.
|
|
1920
|
+
|
|
1921
|
+
Parameters
|
|
1922
|
+
----------
|
|
1923
|
+
face_zone_id_list : list[int]
|
|
1924
|
+
List containing the face zone IDs.
|
|
1925
|
+
face_zone_name_list : list[str]
|
|
1926
|
+
List containing the face zone names.
|
|
1927
|
+
face_zone_name_pattern : str
|
|
1928
|
+
Face zone name pattern.
|
|
1929
|
+
|
|
1930
|
+
Returns
|
|
1931
|
+
-------
|
|
1932
|
+
float
|
|
1933
|
+
|
|
1934
|
+
Examples
|
|
1935
|
+
--------
|
|
1936
|
+
>>> meshing_session.meshing_utilities.get_face_zone_area(face_zone_id_list=[30, 31, 32])
|
|
1937
|
+
>>> meshing_session.meshing_utilities.get_face_zone_area(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
1938
|
+
>>> meshing_session.meshing_utilities.get_face_zone_area(face_zone_name_pattern="*")
|
|
1939
|
+
"""
|
|
1940
|
+
pass
|
|
1941
|
+
|
|
1942
|
+
class get_face_zone_count(PyQuery):
|
|
1943
|
+
"""
|
|
1944
|
+
Return count of entities for face zones.
|
|
1945
|
+
|
|
1946
|
+
Parameters
|
|
1947
|
+
----------
|
|
1948
|
+
face_zone_id_list : list[int]
|
|
1949
|
+
List containing the face zone IDs.
|
|
1950
|
+
face_zone_name_list : list[str]
|
|
1951
|
+
List containing the face zone names.
|
|
1952
|
+
face_zone_name_pattern : str
|
|
1953
|
+
Face zone name pattern.
|
|
1954
|
+
|
|
1955
|
+
Returns
|
|
1956
|
+
-------
|
|
1957
|
+
int
|
|
1958
|
+
|
|
1959
|
+
Examples
|
|
1960
|
+
--------
|
|
1961
|
+
>>> meshing_session.meshing_utilities.get_face_zone_count(face_zone_id_list=[30, 31, 32])
|
|
1962
|
+
>>> meshing_session.meshing_utilities.get_face_zone_count(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
1963
|
+
>>> meshing_session.meshing_utilities.get_face_zone_count(face_zone_name_pattern="*")
|
|
1964
|
+
"""
|
|
1965
|
+
pass
|
|
1966
|
+
|
|
1967
|
+
class get_face_zone_id_list_with_labels(PyQuery):
|
|
1968
|
+
"""
|
|
1969
|
+
Returns the list of face zones (by ID) containing the labels specified.
|
|
1970
|
+
|
|
1971
|
+
Parameters
|
|
1972
|
+
----------
|
|
1973
|
+
face_zone_id_list : list[int]
|
|
1974
|
+
List containing the face zone IDs.
|
|
1975
|
+
face_zone_name_list : list[str]
|
|
1976
|
+
List containing the face zone names.
|
|
1977
|
+
face_zone_name_pattern : str
|
|
1978
|
+
Face zone name pattern.
|
|
1979
|
+
label_name_list : list[str]
|
|
1980
|
+
List containing the label names.
|
|
1981
|
+
|
|
1982
|
+
Returns
|
|
1983
|
+
-------
|
|
1984
|
+
list[int]
|
|
1985
|
+
|
|
1986
|
+
Examples
|
|
1987
|
+
--------
|
|
1988
|
+
>>> meshing_session.meshing_utilities.get_face_zone_id_list_with_labels(face_zone_id_list=[33, 34], label_name_list=["wall-inlet-1", "wall-elbow-1"])
|
|
1989
|
+
>>> meshing_session.meshing_utilities.get_face_zone_id_list_with_labels(face_zone_name_list=["wall-inlet", "wall-elbow"], label_name_list=["wall-inlet-1", "wall-elbow-1"])
|
|
1990
|
+
>>> meshing_session.meshing_utilities.get_face_zone_id_list_with_labels(face_zone_name_pattern="wall*", label_name_list=["wall-inlet-1", "wall-elbow-1"])
|
|
1991
|
+
"""
|
|
1992
|
+
pass
|
|
1993
|
+
|
|
1994
|
+
class get_face_zone_node_count(PyQuery):
|
|
1995
|
+
"""
|
|
1996
|
+
Returns the node count for the specified face zone.
|
|
1997
|
+
|
|
1998
|
+
Parameters
|
|
1999
|
+
----------
|
|
2000
|
+
face_zone_id : int
|
|
2001
|
+
Face zone ID.
|
|
2002
|
+
face_zone_name : str
|
|
2003
|
+
Face zone name.
|
|
2004
|
+
|
|
2005
|
+
Returns
|
|
2006
|
+
-------
|
|
2007
|
+
int
|
|
2008
|
+
|
|
2009
|
+
Examples
|
|
2010
|
+
--------
|
|
2011
|
+
>>> meshing_session.meshing_utilities.get_face_zone_node_count(face_zone_id=32)
|
|
2012
|
+
>>> meshing_session.meshing_utilities.get_face_zone_node_count(face_zone_name="outlet")
|
|
2013
|
+
"""
|
|
2014
|
+
pass
|
|
2015
|
+
|
|
2016
|
+
class get_face_zones(PyQuery):
|
|
2017
|
+
"""
|
|
2018
|
+
- Get face zones using 1 - maximum_entity_count and only_boundary or 2 - prism_control_name or 3 - xyz_coordinates or 4 - filter.
|
|
2019
|
+
- Return a list of face zones at or closest to a specified location (xyz_coordinates - not applicable to polyhedra mesh).
|
|
2020
|
+
- Return a list of face zones with a count below the maximum entity count (maximum_entity_count) specified.
|
|
2021
|
+
- You can choose to restrict the report to only boundary face zones, if required (only_boundary set to True or False).
|
|
2022
|
+
- Return a list of face zones to which the specified prism controls apply.
|
|
2023
|
+
- Return a list of zones whose names contain the specified filter string.
|
|
2024
|
+
|
|
2025
|
+
Parameters
|
|
2026
|
+
----------
|
|
2027
|
+
maximum_entity_count : float
|
|
2028
|
+
Maximum entity count.
|
|
2029
|
+
only_boundary : bool
|
|
2030
|
+
Specify whether to restrict the report to only boundary face zones.
|
|
2031
|
+
prism_control_name : str
|
|
2032
|
+
Prism control name.
|
|
2033
|
+
xyz_coordinates : list[float]
|
|
2034
|
+
X-Y-Z coordinates.
|
|
2035
|
+
filter : str
|
|
2036
|
+
Face zone name filter.
|
|
2037
|
+
|
|
2038
|
+
Returns
|
|
2039
|
+
-------
|
|
2040
|
+
list[int]
|
|
2041
|
+
|
|
2042
|
+
Examples
|
|
2043
|
+
--------
|
|
2044
|
+
>>> meshing_session.meshing_utilities.get_face_zones(filter="*")
|
|
2045
|
+
>>> meshing_session.meshing_utilities.get_face_zones(prism_control_name="*")
|
|
2046
|
+
>>> meshing_session.meshing_utilities.get_face_zones(xyz_coordinates=[1.4, 1.4, 1.4])
|
|
2047
|
+
>>> meshing_session.meshing_utilities.get_face_zones(maximum_entity_count=20, only_boundary=True)
|
|
2048
|
+
"""
|
|
2049
|
+
pass
|
|
2050
|
+
|
|
2051
|
+
class get_face_zones_by_zone_area(PyQuery):
|
|
2052
|
+
"""
|
|
2053
|
+
- Return a list of face zones with a maximum zone area below the maximum_zone_area specified.
|
|
2054
|
+
- Return a list of face zones with a minimum zone area above the minimum_zone_area specified.
|
|
2055
|
+
|
|
2056
|
+
Parameters
|
|
2057
|
+
----------
|
|
2058
|
+
maximum_zone_area : float
|
|
2059
|
+
Maximum zone area.
|
|
2060
|
+
minimum_zone_area : float
|
|
2061
|
+
Minimum zone area.
|
|
2062
|
+
|
|
2063
|
+
Returns
|
|
2064
|
+
-------
|
|
2065
|
+
list[int]
|
|
2066
|
+
|
|
2067
|
+
Examples
|
|
2068
|
+
--------
|
|
2069
|
+
>>> meshing_session.meshing_utilities.get_face_zones_by_zone_area(maximum_zone_area=100)
|
|
2070
|
+
>>> meshing_session.meshing_utilities.get_face_zones_by_zone_area(minimum_zone_area=10)
|
|
2071
|
+
"""
|
|
2072
|
+
pass
|
|
2073
|
+
|
|
2074
|
+
class get_face_zones_of_object(PyQuery):
|
|
2075
|
+
"""
|
|
2076
|
+
- Return a list of face zones using 1 - object_name and regions or 2 - object_name and labels or 3 - object_name and region_type or 4 - object_name or 5 - objects.
|
|
2077
|
+
- where region_type is one of the 'fluid-fluid', 'solid-solid', or 'fluid-solid' value.
|
|
2078
|
+
|
|
2079
|
+
Parameters
|
|
2080
|
+
----------
|
|
2081
|
+
regions : list[str]
|
|
2082
|
+
List containing the region names.
|
|
2083
|
+
labels : list[str]
|
|
2084
|
+
List containing the face zone labels.
|
|
2085
|
+
region_type : str
|
|
2086
|
+
Region type.
|
|
2087
|
+
objects : list[str]
|
|
2088
|
+
List containing the object names.
|
|
2089
|
+
object_name : str
|
|
2090
|
+
Mesh object name.
|
|
2091
|
+
|
|
2092
|
+
Returns
|
|
2093
|
+
-------
|
|
2094
|
+
list[int]
|
|
2095
|
+
|
|
2096
|
+
Examples
|
|
2097
|
+
--------
|
|
2098
|
+
>>> meshing_session.meshing_utilities.get_face_zones_of_object(object_name="elbow-fluid", regions=["elbow-fluid"])
|
|
2099
|
+
>>> meshing_session.meshing_utilities.get_face_zones_of_object(object_name="elbow-fluid", labels=["outlet"])
|
|
2100
|
+
>>> meshing_session.meshing_utilities.get_face_zones_of_object(object_name="elbow-fluid", region_type="elbow-fluid")
|
|
2101
|
+
>>> meshing_session.meshing_utilities.get_face_zones_of_object(object_name="elbow-fluid")
|
|
2102
|
+
>>> meshing_session.meshing_utilities.get_face_zones_of_object(objects=["elbow-fluid"])
|
|
2103
|
+
"""
|
|
2104
|
+
pass
|
|
2105
|
+
|
|
2106
|
+
class get_face_zones_with_zone_specific_prisms_applied(PyQuery):
|
|
2107
|
+
"""
|
|
2108
|
+
Return a list of face zones with zone-specific prism settings applied.
|
|
2109
|
+
|
|
2110
|
+
Returns
|
|
2111
|
+
-------
|
|
2112
|
+
list[int]
|
|
2113
|
+
|
|
2114
|
+
Examples
|
|
2115
|
+
--------
|
|
2116
|
+
>>> meshing_session.meshing_utilities.get_face_zones_with_zone_specific_prisms_applied()
|
|
2117
|
+
"""
|
|
2118
|
+
pass
|
|
2119
|
+
|
|
2120
|
+
class get_free_faces_count(PyQuery):
|
|
2121
|
+
"""
|
|
2122
|
+
Returns the count of free faces for the face zones specified.
|
|
2123
|
+
|
|
2124
|
+
Parameters
|
|
2125
|
+
----------
|
|
2126
|
+
face_zone_id_list : list[int]
|
|
2127
|
+
List containing the face zone IDs.
|
|
2128
|
+
face_zone_name_list : list[str]
|
|
2129
|
+
List containing the face zone names.
|
|
2130
|
+
face_zone_name_pattern : str
|
|
2131
|
+
Face zone name pattern.
|
|
2132
|
+
|
|
2133
|
+
Returns
|
|
2134
|
+
-------
|
|
2135
|
+
int
|
|
2136
|
+
|
|
2137
|
+
Examples
|
|
2138
|
+
--------
|
|
2139
|
+
>>> meshing_session.meshing_utilities.get_free_faces_count(face_zone_id_list=[30, 31, 32])
|
|
2140
|
+
>>> meshing_session.meshing_utilities.get_free_faces_count(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
2141
|
+
>>> meshing_session.meshing_utilities.get_free_faces_count(face_zone_name_pattern="*")
|
|
2142
|
+
"""
|
|
2143
|
+
pass
|
|
2144
|
+
|
|
2145
|
+
class get_interior_face_zones_for_given_cell_zones(PyQuery):
|
|
2146
|
+
"""
|
|
2147
|
+
Returns interior face zones connected to given cell zones.
|
|
2148
|
+
|
|
2149
|
+
Parameters
|
|
2150
|
+
----------
|
|
2151
|
+
cell_zone_id_list : list[int]
|
|
2152
|
+
List containing the cell zone IDs.
|
|
2153
|
+
cell_zone_name_list : list[str]
|
|
2154
|
+
List containing the cell zone names.
|
|
2155
|
+
cell_zone_name_pattern : str
|
|
2156
|
+
Cell zone name pattern.
|
|
2157
|
+
|
|
2158
|
+
Returns
|
|
2159
|
+
-------
|
|
2160
|
+
list[int]
|
|
2161
|
+
|
|
2162
|
+
Examples
|
|
2163
|
+
--------
|
|
2164
|
+
>>> meshing_session.meshing_utilities.get_interior_face_zones_for_given_cell_zones(cell_zone_id_list=[87])
|
|
2165
|
+
>>> meshing_session.meshing_utilities.get_interior_face_zones_for_given_cell_zones(cell_zone_name_list=["elbow-fluid"])
|
|
2166
|
+
>>> meshing_session.meshing_utilities.get_interior_face_zones_for_given_cell_zones(cell_zone_name_pattern="*")
|
|
2167
|
+
"""
|
|
2168
|
+
pass
|
|
2169
|
+
|
|
2170
|
+
class get_labels(PyQuery):
|
|
2171
|
+
"""
|
|
2172
|
+
Return a list of face zone labels in the specified object, whose names contain the specified filter or pattern string.
|
|
2173
|
+
|
|
2174
|
+
Parameters
|
|
2175
|
+
----------
|
|
2176
|
+
object_name : str
|
|
2177
|
+
Mesh object name.
|
|
2178
|
+
filter : str
|
|
2179
|
+
Label name filter.
|
|
2180
|
+
label_name_pattern : str
|
|
2181
|
+
Label name pattern.
|
|
2182
|
+
|
|
2183
|
+
Returns
|
|
2184
|
+
-------
|
|
2185
|
+
list[str]
|
|
2186
|
+
|
|
2187
|
+
Examples
|
|
2188
|
+
--------
|
|
2189
|
+
>>> meshing_session.meshing_utilities.get_labels(object_name="elbow-fluid")
|
|
2190
|
+
>>> meshing_session.meshing_utilities.get_labels(object_name="elbow-fluid", filter="*")
|
|
2191
|
+
>>> meshing_session.meshing_utilities.get_labels(object_name="elbow-fluid", label_name_pattern="*")
|
|
2192
|
+
"""
|
|
2193
|
+
pass
|
|
2194
|
+
|
|
2195
|
+
class get_labels_on_cell_zones(PyQuery):
|
|
2196
|
+
"""
|
|
2197
|
+
Returns the list of labels for the specified cell zones.
|
|
2198
|
+
|
|
2199
|
+
Parameters
|
|
2200
|
+
----------
|
|
2201
|
+
cell_zone_id_list : list[int]
|
|
2202
|
+
List containing the cell zone IDs.
|
|
2203
|
+
cell_zone_name_list : list[str]
|
|
2204
|
+
List containing the cell zone names.
|
|
2205
|
+
cell_zone_name_pattern : str
|
|
2206
|
+
Cell zone name pattern.
|
|
2207
|
+
|
|
2208
|
+
Returns
|
|
2209
|
+
-------
|
|
2210
|
+
list[str]
|
|
2211
|
+
|
|
2212
|
+
Examples
|
|
2213
|
+
--------
|
|
2214
|
+
>>> meshing_session.meshing_utilities.get_labels_on_cell_zones(cell_zone_id_list=[87])
|
|
2215
|
+
>>> meshing_session.meshing_utilities.get_labels_on_cell_zones(cell_zone_name_list=["elbow-fluid"])
|
|
2216
|
+
>>> meshing_session.meshing_utilities.get_labels_on_cell_zones(cell_zone_name_pattern="*")
|
|
2217
|
+
"""
|
|
2218
|
+
pass
|
|
2219
|
+
|
|
2220
|
+
class get_labels_on_edge_zones(PyQuery):
|
|
2221
|
+
"""
|
|
2222
|
+
Returns the list of labels for the specified edge zones.
|
|
2223
|
+
|
|
2224
|
+
Parameters
|
|
2225
|
+
----------
|
|
2226
|
+
edge_zone_id_list : list[int]
|
|
2227
|
+
List containing the edge zone IDs.
|
|
2228
|
+
edge_zone_name_list : list[str]
|
|
2229
|
+
List containing the edge zone names.
|
|
2230
|
+
edge_zone_name_pattern : str
|
|
2231
|
+
Edge zone name pattern.
|
|
2232
|
+
|
|
2233
|
+
Returns
|
|
2234
|
+
-------
|
|
2235
|
+
list[str]
|
|
2236
|
+
|
|
2237
|
+
Examples
|
|
2238
|
+
--------
|
|
2239
|
+
>>> meshing_session.meshing_utilities.get_labels_on_edge_zones(edge_zone_id_list=[22, 23])
|
|
2240
|
+
>>> meshing_session.meshing_utilities.get_labels_on_edge_zones(edge_zone_name_list=["symmetry:xyplane:hot-inlet:elbow-fluid:feature.20", "hot-inlet:wall-inlet:elbow-fluid:feature.21"])
|
|
2241
|
+
>>> meshing_session.meshing_utilities.get_labels_on_edge_zones(edge_zone_name_pattern="cold-inlet*")
|
|
2242
|
+
"""
|
|
2243
|
+
pass
|
|
2244
|
+
|
|
2245
|
+
class get_labels_on_face_zones(PyQuery):
|
|
2246
|
+
"""
|
|
2247
|
+
Returns the list of labels for the specified face zones.
|
|
2248
|
+
|
|
2249
|
+
Parameters
|
|
2250
|
+
----------
|
|
2251
|
+
face_zone_id_list : list[int]
|
|
2252
|
+
List containing the face zone IDs.
|
|
2253
|
+
face_zone_name_list : list[str]
|
|
2254
|
+
List containing the face zone names.
|
|
2255
|
+
face_zone_name_pattern : str
|
|
2256
|
+
Face zone name pattern.
|
|
2257
|
+
|
|
2258
|
+
Returns
|
|
2259
|
+
-------
|
|
2260
|
+
list[str]
|
|
2261
|
+
|
|
2262
|
+
Examples
|
|
2263
|
+
--------
|
|
2264
|
+
>>> meshing_session.meshing_utilities.get_labels_on_face_zones(face_zone_id_list=[30, 31])
|
|
2265
|
+
>>> meshing_session.meshing_utilities.get_labels_on_face_zones(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
2266
|
+
>>> meshing_session.meshing_utilities.get_labels_on_face_zones(face_zone_name_pattern="out*")
|
|
2267
|
+
"""
|
|
2268
|
+
pass
|
|
2269
|
+
|
|
2270
|
+
class get_labels_on_face_zones_list(PyQuery):
|
|
2271
|
+
"""
|
|
2272
|
+
Returns the list of labels for the specified face zones.
|
|
2273
|
+
|
|
2274
|
+
Parameters
|
|
2275
|
+
----------
|
|
2276
|
+
face_zone_id_list : list[int]
|
|
2277
|
+
List containing the face zone IDs.
|
|
2278
|
+
|
|
2279
|
+
Returns
|
|
2280
|
+
-------
|
|
2281
|
+
None
|
|
2282
|
+
|
|
2283
|
+
Examples
|
|
2284
|
+
--------
|
|
2285
|
+
>>> meshing_session.meshing_utilities.get_labels_on_face_zones_list(face_zone_id_list=[30, 31])
|
|
2286
|
+
"""
|
|
2287
|
+
pass
|
|
2288
|
+
|
|
2289
|
+
class get_maxsize_cell_zone_by_count(PyQuery):
|
|
2290
|
+
"""
|
|
2291
|
+
Return cell zone with maximum count of elements for given list or pattern of cell zones.
|
|
2292
|
+
|
|
2293
|
+
Parameters
|
|
2294
|
+
----------
|
|
2295
|
+
zone_id_list : list[int]
|
|
2296
|
+
List containing the cell zone IDs.
|
|
2297
|
+
zone_name_list : list[str]
|
|
2298
|
+
List containing the cell zone names.
|
|
2299
|
+
zone_name_pattern : str
|
|
2300
|
+
Cell zone name pattern.
|
|
2301
|
+
|
|
2302
|
+
Returns
|
|
2303
|
+
-------
|
|
2304
|
+
float
|
|
2305
|
+
|
|
2306
|
+
Examples
|
|
2307
|
+
--------
|
|
2308
|
+
>>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_count(zone_id_list=[87])
|
|
2309
|
+
>>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_count(zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
2310
|
+
>>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_count(zone_name_pattern="*")
|
|
2311
|
+
"""
|
|
2312
|
+
pass
|
|
2313
|
+
|
|
2314
|
+
class get_maxsize_cell_zone_by_volume(PyQuery):
|
|
2315
|
+
"""
|
|
2316
|
+
Return cell zone with maximum volume for given list or pattern of cell zones.
|
|
2317
|
+
|
|
2318
|
+
Parameters
|
|
2319
|
+
----------
|
|
2320
|
+
zone_id_list : list[int]
|
|
2321
|
+
List containing the cell zone IDs.
|
|
2322
|
+
zone_name_list : list[str]
|
|
2323
|
+
List containing the cell zone names.
|
|
2324
|
+
zone_name_pattern : str
|
|
2325
|
+
Cell zone name pattern.
|
|
2326
|
+
|
|
2327
|
+
Returns
|
|
2328
|
+
-------
|
|
2329
|
+
float
|
|
2330
|
+
|
|
2331
|
+
Examples
|
|
2332
|
+
--------
|
|
2333
|
+
>>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_volume(zone_id_list=[87])
|
|
2334
|
+
>>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_volume(zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
2335
|
+
>>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_volume(zone_name_pattern="*")
|
|
2336
|
+
"""
|
|
2337
|
+
pass
|
|
2338
|
+
|
|
2339
|
+
class get_minsize_face_zone_by_area(PyQuery):
|
|
2340
|
+
"""
|
|
2341
|
+
Return face zone with minimum area for given list or pattern of face zones.
|
|
2342
|
+
|
|
2343
|
+
Parameters
|
|
2344
|
+
----------
|
|
2345
|
+
zone_id_list : list[int]
|
|
2346
|
+
List containing the face zone IDs.
|
|
2347
|
+
zone_name_list : list[str]
|
|
2348
|
+
List containing the face zone names.
|
|
2349
|
+
zone_name_pattern : str
|
|
2350
|
+
Face zone name pattern.
|
|
2351
|
+
|
|
2352
|
+
Returns
|
|
2353
|
+
-------
|
|
2354
|
+
float
|
|
2355
|
+
|
|
2356
|
+
Examples
|
|
2357
|
+
--------
|
|
2358
|
+
>>> meshing_session.meshing_utilities.get_minsize_face_zone_by_area(zone_id_list=[29, 30, 31, 32, 33])
|
|
2359
|
+
>>> meshing_session.meshing_utilities.get_minsize_face_zone_by_area(zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
2360
|
+
>>> meshing_session.meshing_utilities.get_minsize_face_zone_by_area(zone_name_pattern="*")
|
|
2361
|
+
"""
|
|
2362
|
+
pass
|
|
2363
|
+
|
|
2364
|
+
class get_minsize_face_zone_by_count(PyQuery):
|
|
2365
|
+
"""
|
|
2366
|
+
Return face zone with minimum count of elements for given list or pattern of face zones.
|
|
2367
|
+
|
|
2368
|
+
Parameters
|
|
2369
|
+
----------
|
|
2370
|
+
zone_id_list : list[int]
|
|
2371
|
+
List containing the face zone IDs.
|
|
2372
|
+
zone_name_list : list[str]
|
|
2373
|
+
List containing the face zone names.
|
|
2374
|
+
zone_name_pattern : str
|
|
2375
|
+
Face zone name pattern.
|
|
2376
|
+
|
|
2377
|
+
Returns
|
|
2378
|
+
-------
|
|
2379
|
+
float
|
|
2380
|
+
|
|
2381
|
+
Examples
|
|
2382
|
+
--------
|
|
2383
|
+
>>> meshing_session.meshing_utilities.get_minsize_face_zone_by_count(zone_id_list=[29, 30, 31, 32, 33])
|
|
2384
|
+
>>> meshing_session.meshing_utilities.get_minsize_face_zone_by_count(zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
2385
|
+
>>> meshing_session.meshing_utilities.get_minsize_face_zone_by_count(zone_name_pattern="*")
|
|
2386
|
+
"""
|
|
2387
|
+
pass
|
|
2388
|
+
|
|
2389
|
+
class get_multi_faces_count(PyQuery):
|
|
2390
|
+
"""
|
|
2391
|
+
Returns the count of multi-connected faces for the face zones specified.
|
|
2392
|
+
|
|
2393
|
+
Parameters
|
|
2394
|
+
----------
|
|
2395
|
+
face_zone_id_list : list[int]
|
|
2396
|
+
List containing the face zone IDs.
|
|
2397
|
+
face_zone_name_list : list[str]
|
|
2398
|
+
List containing the face zone names.
|
|
2399
|
+
face_zone_name_pattern : str
|
|
2400
|
+
Face zone name pattern.
|
|
2401
|
+
|
|
2402
|
+
Returns
|
|
2403
|
+
-------
|
|
2404
|
+
int
|
|
2405
|
+
|
|
2406
|
+
Examples
|
|
2407
|
+
--------
|
|
2408
|
+
>>> meshing_session.meshing_utilities.get_multi_faces_count(face_zone_id_list=[30, 31, 32])
|
|
2409
|
+
>>> meshing_session.meshing_utilities.get_multi_faces_count(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
2410
|
+
>>> meshing_session.meshing_utilities.get_multi_faces_count(face_zone_name_pattern="*")
|
|
2411
|
+
"""
|
|
2412
|
+
pass
|
|
2413
|
+
|
|
2414
|
+
class get_node_zones(PyQuery):
|
|
2415
|
+
"""
|
|
2416
|
+
Return a list of zones whose names contain the specified filter string.
|
|
2417
|
+
|
|
2418
|
+
Parameters
|
|
2419
|
+
----------
|
|
2420
|
+
filter : str
|
|
2421
|
+
Node zone name filter.
|
|
2422
|
+
|
|
2423
|
+
Returns
|
|
2424
|
+
-------
|
|
2425
|
+
list[int]
|
|
2426
|
+
|
|
2427
|
+
Examples
|
|
2428
|
+
--------
|
|
2429
|
+
>>> meshing_session.meshing_utilities.get_node_zones(filter="*")
|
|
2430
|
+
"""
|
|
2431
|
+
pass
|
|
2432
|
+
|
|
2433
|
+
class get_objects(PyQuery):
|
|
2434
|
+
"""
|
|
2435
|
+
Return a list of objects of the specified type or whose names contain the specified filter string.
|
|
2436
|
+
|
|
2437
|
+
Parameters
|
|
2438
|
+
----------
|
|
2439
|
+
type_name : str
|
|
2440
|
+
Mesh object type name.
|
|
2441
|
+
filter : str
|
|
2442
|
+
Mesh object name filter.
|
|
2443
|
+
|
|
2444
|
+
Returns
|
|
2445
|
+
-------
|
|
2446
|
+
list[str]
|
|
2447
|
+
|
|
2448
|
+
Examples
|
|
2449
|
+
--------
|
|
2450
|
+
>>> meshing_session.meshing_utilities.get_objects(type_name="mesh")
|
|
2451
|
+
>>> meshing_session.meshing_utilities.get_objects(filter="*")
|
|
2452
|
+
"""
|
|
2453
|
+
pass
|
|
2454
|
+
|
|
2455
|
+
class get_overlapping_face_zones(PyQuery):
|
|
2456
|
+
"""
|
|
2457
|
+
Return a list of overlapping face zones based on the area_tolerance and distance_tolerance specified.
|
|
2458
|
+
|
|
2459
|
+
Parameters
|
|
2460
|
+
----------
|
|
2461
|
+
face_zone_name_pattern : str
|
|
2462
|
+
Face zone name pattern.
|
|
2463
|
+
area_tolerance : float
|
|
2464
|
+
Area tolerance.
|
|
2465
|
+
distance_tolerance : float
|
|
2466
|
+
Distance tolerance.
|
|
2467
|
+
|
|
2468
|
+
Returns
|
|
2469
|
+
-------
|
|
2470
|
+
list[int]
|
|
2471
|
+
|
|
2472
|
+
Examples
|
|
2473
|
+
--------
|
|
2474
|
+
>>> meshing_session.meshing_utilities.get_overlapping_face_zones(face_zone_name_pattern="*", area_tolerance=0.01, distance_tolerance=0.01)
|
|
2475
|
+
"""
|
|
2476
|
+
pass
|
|
2477
|
+
|
|
2478
|
+
class get_pairs_of_overlapping_face_zones(PyQuery):
|
|
2479
|
+
"""
|
|
2480
|
+
- Return the pairs of overlapping face zones based on the join tolerance and feature angle.
|
|
2481
|
+
- Specify the tolerance value for locating the overlapping faces (join_tolerance).
|
|
2482
|
+
- Choose to use an absolute tolerance value or relative to face edges (set absolute_tolerance to True or False).
|
|
2483
|
+
- Specify the feature angle to identify features in the overlap region (feature_angle).
|
|
2484
|
+
- The default value is 40.
|
|
2485
|
+
- Each member in the list returned includes the zone IDs for the overlapping zone pair and the join region represented by the bounding box.
|
|
2486
|
+
- The same pair of zones may appear multiple times (with different join region bounding box coordinates) in the returned list.
|
|
2487
|
+
|
|
2488
|
+
Parameters
|
|
2489
|
+
----------
|
|
2490
|
+
face_zone_id_list : list[int]
|
|
2491
|
+
List containing the face zone IDs.
|
|
2492
|
+
face_zone_name_list : list[str]
|
|
2493
|
+
List containing the face zone names.
|
|
2494
|
+
face_zone_name_pattern : str
|
|
2495
|
+
Face zone name pattern.
|
|
2496
|
+
join_tolerance : float
|
|
2497
|
+
Join tolerance.
|
|
2498
|
+
absolute_tolerance : bool
|
|
2499
|
+
Specify whether to use an absolute tolerance value or relative to face edges.
|
|
2500
|
+
join_angle : float
|
|
2501
|
+
Join angle.
|
|
2502
|
+
|
|
2503
|
+
Returns
|
|
2504
|
+
-------
|
|
2505
|
+
list[int]
|
|
2506
|
+
|
|
2507
|
+
Examples
|
|
2508
|
+
--------
|
|
2509
|
+
>>> meshing_session.meshing_utilities.get_pairs_of_overlapping_face_zones(face_zone_id_list=[29, 30, 31, 32, 33], join_tolerance=0.001, absolute_tolerance=True, join_angle=45)
|
|
2510
|
+
>>> meshing_session.meshing_utilities.get_pairs_of_overlapping_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"], join_tolerance=0.001, absolute_tolerance=True, join_angle=45)
|
|
2511
|
+
>>> meshing_session.meshing_utilities.get_pairs_of_overlapping_face_zones(face_zone_name_pattern="*", join_tolerance=0.001, absolute_tolerance=True, join_angle=45)
|
|
2512
|
+
"""
|
|
2513
|
+
pass
|
|
2514
|
+
|
|
2515
|
+
class get_prism_cell_zones(PyQuery):
|
|
2516
|
+
"""
|
|
2517
|
+
Return a list of prism cell zones.
|
|
2518
|
+
|
|
2519
|
+
Parameters
|
|
2520
|
+
----------
|
|
2521
|
+
zone_id_list : list[int]
|
|
2522
|
+
List containing the cell zone IDs.
|
|
2523
|
+
zone_name_list : list[str]
|
|
2524
|
+
List containing the cell zone names.
|
|
2525
|
+
zone_name_pattern : str
|
|
2526
|
+
Cell zone name pattern.
|
|
2527
|
+
|
|
2528
|
+
Returns
|
|
2529
|
+
-------
|
|
2530
|
+
list[int]
|
|
2531
|
+
|
|
2532
|
+
Examples
|
|
2533
|
+
--------
|
|
2534
|
+
>>> meshing_session.meshing_utilities.get_prism_cell_zones(zone_id_list=[87])
|
|
2535
|
+
>>> meshing_session.meshing_utilities.get_prism_cell_zones(zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
2536
|
+
>>> meshing_session.meshing_utilities.get_prism_cell_zones(zone_name_pattern="*")
|
|
2537
|
+
"""
|
|
2538
|
+
pass
|
|
2539
|
+
|
|
2540
|
+
class get_region_volume(PyQuery):
|
|
2541
|
+
"""
|
|
2542
|
+
- Get region volume using 1 - object_name and region_name or 2 - object_name and order.
|
|
2543
|
+
- Return the region volume for the specified region of an object.
|
|
2544
|
+
- Returns a sorted list of volumetric regions by volume for the object specified.
|
|
2545
|
+
- Specify the order 'ascending' or 'descending'.
|
|
2546
|
+
|
|
2547
|
+
Parameters
|
|
2548
|
+
----------
|
|
2549
|
+
object_name : str
|
|
2550
|
+
Mesh object name.
|
|
2551
|
+
region_name : str
|
|
2552
|
+
Region name.
|
|
2553
|
+
sorting_order : str
|
|
2554
|
+
Region volume sorting order.
|
|
2555
|
+
|
|
2556
|
+
Returns
|
|
2557
|
+
-------
|
|
2558
|
+
None
|
|
2559
|
+
|
|
2560
|
+
Examples
|
|
2561
|
+
--------
|
|
2562
|
+
>>> meshing_session.meshing_utilities.get_region_volume(object_name="elbow-fluid", sorting_order="ascending")
|
|
2563
|
+
>>> meshing_session.meshing_utilities.get_region_volume(object_name="elbow-fluid", region_name="elbow-fluid")
|
|
2564
|
+
"""
|
|
2565
|
+
pass
|
|
2566
|
+
|
|
2567
|
+
class get_regions(PyQuery):
|
|
2568
|
+
"""
|
|
2569
|
+
Return a list of regions in the specified object, whose names contain the specified filter string or specified name pattern.
|
|
2570
|
+
|
|
2571
|
+
Parameters
|
|
2572
|
+
----------
|
|
2573
|
+
object_name : str
|
|
2574
|
+
Mesh object name.
|
|
2575
|
+
region_name_pattern : str
|
|
2576
|
+
Region name pattern.
|
|
2577
|
+
filter : str
|
|
2578
|
+
Region name filter.
|
|
2579
|
+
|
|
2580
|
+
Returns
|
|
2581
|
+
-------
|
|
2582
|
+
list[str]
|
|
2583
|
+
|
|
2584
|
+
Examples
|
|
2585
|
+
--------
|
|
2586
|
+
>>> meshing_session.meshing_utilities.get_regions(object_name="elbow-fluid", region_name_pattern="*")
|
|
2587
|
+
>>> meshing_session.meshing_utilities.get_regions(object_name="elbow-fluid", filter="*")
|
|
2588
|
+
>>> meshing_session.meshing_utilities.get_regions(object_name="elbow-fluid")
|
|
2589
|
+
"""
|
|
2590
|
+
pass
|
|
2591
|
+
|
|
2592
|
+
class get_regions_of_face_zones(PyQuery):
|
|
2593
|
+
"""
|
|
2594
|
+
Return a list of regions containing the face zones specified.
|
|
2595
|
+
|
|
2596
|
+
Parameters
|
|
2597
|
+
----------
|
|
2598
|
+
face_zone_id_list : list[int]
|
|
2599
|
+
List containing the face zone IDs.
|
|
2600
|
+
face_zone_name_list : list[str]
|
|
2601
|
+
List containing the face zone names.
|
|
2602
|
+
face_zone_name_pattern : str
|
|
2603
|
+
Face zone name pattern.
|
|
2604
|
+
|
|
2605
|
+
Returns
|
|
2606
|
+
-------
|
|
2607
|
+
list[str]
|
|
2608
|
+
|
|
2609
|
+
Examples
|
|
2610
|
+
--------
|
|
2611
|
+
>>> meshing_session.meshing_utilities.get_regions_of_face_zones(face_zone_id_list=[29, 30, 31, 32, 33])
|
|
2612
|
+
>>> meshing_session.meshing_utilities.get_regions_of_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
2613
|
+
>>> meshing_session.meshing_utilities.get_regions_of_face_zones(face_zone_name_pattern="*")
|
|
2614
|
+
"""
|
|
2615
|
+
pass
|
|
2616
|
+
|
|
2617
|
+
class get_shared_boundary_face_zones_for_given_cell_zones(PyQuery):
|
|
2618
|
+
"""
|
|
2619
|
+
Returns the number of faces and the boundary face zones that are shared with the specified cell zones.
|
|
2620
|
+
|
|
2621
|
+
Parameters
|
|
2622
|
+
----------
|
|
2623
|
+
cell_zone_id_list : list[int]
|
|
2624
|
+
List containing the cell zone IDs.
|
|
2625
|
+
cell_zone_name_list : list[str]
|
|
2626
|
+
List containing the cell zone names.
|
|
2627
|
+
cell_zone_name_pattern : str
|
|
2628
|
+
Cell zone name pattern.
|
|
2629
|
+
|
|
2630
|
+
Returns
|
|
2631
|
+
-------
|
|
2632
|
+
list[int]
|
|
2633
|
+
|
|
2634
|
+
Examples
|
|
2635
|
+
--------
|
|
2636
|
+
>>> meshing_session.meshing_utilities.get_shared_boundary_face_zones_for_given_cell_zones(cell_zone_id_list=[87])
|
|
2637
|
+
>>> meshing_session.meshing_utilities.get_shared_boundary_face_zones_for_given_cell_zones(cell_zone_name_list=["elbow-fluid"])
|
|
2638
|
+
>>> meshing_session.meshing_utilities.get_shared_boundary_face_zones_for_given_cell_zones(cell_zone_name_pattern="*")
|
|
2639
|
+
"""
|
|
2640
|
+
pass
|
|
2641
|
+
|
|
2642
|
+
class get_tet_cell_zones(PyQuery):
|
|
2643
|
+
"""
|
|
2644
|
+
Return a list of tet cell zones.
|
|
2645
|
+
|
|
2646
|
+
Parameters
|
|
2647
|
+
----------
|
|
2648
|
+
zone_id_list : list[int]
|
|
2649
|
+
List containing the cell zone IDs.
|
|
2650
|
+
zone_name_list : list[str]
|
|
2651
|
+
List containing the cell zone names.
|
|
2652
|
+
zone_name_pattern : str
|
|
2653
|
+
Cell zone name pattern.
|
|
2654
|
+
|
|
2655
|
+
Returns
|
|
2656
|
+
-------
|
|
2657
|
+
list[int]
|
|
2658
|
+
|
|
2659
|
+
Examples
|
|
2660
|
+
--------
|
|
2661
|
+
>>> meshing_session.meshing_utilities.get_tet_cell_zones(zone_id_list=[29, 30, 31, 32, 33])
|
|
2662
|
+
>>> meshing_session.meshing_utilities.get_tet_cell_zones(zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
2663
|
+
>>> meshing_session.meshing_utilities.get_tet_cell_zones(zone_name_pattern="*")
|
|
2664
|
+
"""
|
|
2665
|
+
pass
|
|
2666
|
+
|
|
2667
|
+
class get_unreferenced_cell_zones(PyQuery):
|
|
2668
|
+
"""
|
|
2669
|
+
Return a list of unreferenced cell zones by ID, whose names contain the specified pattern or filter.
|
|
2670
|
+
|
|
2671
|
+
Parameters
|
|
2672
|
+
----------
|
|
2673
|
+
filter : str
|
|
2674
|
+
Cell zone name filter.
|
|
2675
|
+
zone_name_pattern : str
|
|
2676
|
+
Cell zone name pattern.
|
|
2677
|
+
|
|
2678
|
+
Returns
|
|
2679
|
+
-------
|
|
2680
|
+
list[int]
|
|
2681
|
+
|
|
2682
|
+
Examples
|
|
2683
|
+
--------
|
|
2684
|
+
>>> meshing_session.meshing_utilities.get_unreferenced_cell_zones()
|
|
2685
|
+
>>> meshing_session.meshing_utilities.get_unreferenced_cell_zones(filter="*")
|
|
2686
|
+
>>> meshing_session.meshing_utilities.get_unreferenced_cell_zones(zone_name_pattern="*")
|
|
2687
|
+
"""
|
|
2688
|
+
pass
|
|
2689
|
+
|
|
2690
|
+
class get_unreferenced_edge_zones(PyQuery):
|
|
2691
|
+
"""
|
|
2692
|
+
Return a list of unreferenced edge zones by ID, whose names contain the specified pattern or filter.
|
|
2693
|
+
|
|
2694
|
+
Parameters
|
|
2695
|
+
----------
|
|
2696
|
+
filter : str
|
|
2697
|
+
Edge zone name filter.
|
|
2698
|
+
zone_name_pattern : str
|
|
2699
|
+
Edge zone name pattern.
|
|
2700
|
+
|
|
2701
|
+
Returns
|
|
2702
|
+
-------
|
|
2703
|
+
list[int]
|
|
2704
|
+
|
|
2705
|
+
Examples
|
|
2706
|
+
--------
|
|
2707
|
+
>>> meshing_session.meshing_utilities.get_unreferenced_edge_zones()
|
|
2708
|
+
>>> meshing_session.meshing_utilities.get_unreferenced_edge_zones(filter="*")
|
|
2709
|
+
>>> meshing_session.meshing_utilities.get_unreferenced_edge_zones(zone_name_pattern="*")
|
|
2710
|
+
"""
|
|
2711
|
+
pass
|
|
2712
|
+
|
|
2713
|
+
class get_unreferenced_face_zones(PyQuery):
|
|
2714
|
+
"""
|
|
2715
|
+
Return a list of unreferenced face zones by ID, whose names contain the specified pattern or filter.
|
|
2716
|
+
|
|
2717
|
+
Parameters
|
|
2718
|
+
----------
|
|
2719
|
+
filter : str
|
|
2720
|
+
Face zone name filter.
|
|
2721
|
+
zone_name_pattern : str
|
|
2722
|
+
Face zone name pattern.
|
|
2723
|
+
|
|
2724
|
+
Returns
|
|
2725
|
+
-------
|
|
2726
|
+
list[int]
|
|
2727
|
+
|
|
2728
|
+
Examples
|
|
2729
|
+
--------
|
|
2730
|
+
>>> meshing_session.meshing_utilities.get_unreferenced_face_zones()
|
|
2731
|
+
>>> meshing_session.meshing_utilities.get_unreferenced_face_zones(filter="*")
|
|
2732
|
+
>>> meshing_session.meshing_utilities.get_unreferenced_face_zones(zone_name_pattern="*")
|
|
2733
|
+
"""
|
|
2734
|
+
pass
|
|
2735
|
+
|
|
2736
|
+
class get_wrapped_face_zones(PyQuery):
|
|
2737
|
+
"""
|
|
2738
|
+
Return a list of wrapped face zones.
|
|
2739
|
+
|
|
2740
|
+
Returns
|
|
2741
|
+
-------
|
|
2742
|
+
list[int]
|
|
2743
|
+
|
|
2744
|
+
Examples
|
|
2745
|
+
--------
|
|
2746
|
+
>>> meshing_session.meshing_utilities.get_wrapped_face_zones()
|
|
2747
|
+
"""
|
|
2748
|
+
pass
|
|
2749
|
+
|
|
2750
|
+
class get_zone_type(PyQuery):
|
|
2751
|
+
"""
|
|
2752
|
+
Return zone type as integer.
|
|
2753
|
+
|
|
2754
|
+
Parameters
|
|
2755
|
+
----------
|
|
2756
|
+
zone_id : int
|
|
2757
|
+
Zone ID.
|
|
2758
|
+
zone_name : str
|
|
2759
|
+
Zone name.
|
|
2760
|
+
|
|
2761
|
+
Returns
|
|
2762
|
+
-------
|
|
2763
|
+
str
|
|
2764
|
+
|
|
2765
|
+
Examples
|
|
2766
|
+
--------
|
|
2767
|
+
>>> meshing_session.meshing_utilities.get_zone_type(zone_id=87)
|
|
2768
|
+
>>> meshing_session.meshing_utilities.get_zone_type(zone_name="elbow-fluid")
|
|
2769
|
+
"""
|
|
2770
|
+
pass
|
|
2771
|
+
|
|
2772
|
+
class get_zones(PyQuery):
|
|
2773
|
+
"""
|
|
2774
|
+
Return a list of zones of the specified default zone type, group or user-defined group.
|
|
2775
|
+
|
|
2776
|
+
Parameters
|
|
2777
|
+
----------
|
|
2778
|
+
type_name : str
|
|
2779
|
+
Zone type name.
|
|
2780
|
+
group_name : str
|
|
2781
|
+
Zone group name.
|
|
2782
|
+
|
|
2783
|
+
Returns
|
|
2784
|
+
-------
|
|
2785
|
+
list[int]
|
|
2786
|
+
|
|
2787
|
+
Examples
|
|
2788
|
+
--------
|
|
2789
|
+
>>> meshing_session.meshing_utilities.get_zones(type_name="velocity-inlet")
|
|
2790
|
+
>>> meshing_session.meshing_utilities.get_zones(group_name="inlet")
|
|
2791
|
+
"""
|
|
2792
|
+
pass
|
|
2793
|
+
|
|
2794
|
+
class get_zones_with_free_faces_for_given_face_zones(PyQuery):
|
|
2795
|
+
"""
|
|
2796
|
+
Return a list of zones with free faces for the face zones specified.
|
|
2797
|
+
|
|
2798
|
+
Parameters
|
|
2799
|
+
----------
|
|
2800
|
+
face_zone_id_list : list[int]
|
|
2801
|
+
List containing the face zone IDs.
|
|
2802
|
+
face_zone_name_list : list[str]
|
|
2803
|
+
List containing the face zone names.
|
|
2804
|
+
face_zone_name_pattern : str
|
|
2805
|
+
Face zone name pattern.
|
|
2806
|
+
|
|
2807
|
+
Returns
|
|
2808
|
+
-------
|
|
2809
|
+
list[int]
|
|
2810
|
+
|
|
2811
|
+
Examples
|
|
2812
|
+
--------
|
|
2813
|
+
>>> meshing_session.meshing_utilities.get_zones_with_free_faces_for_given_face_zones(face_zone_id_list=[29, 30, 31, 32, 33])
|
|
2814
|
+
>>> meshing_session.meshing_utilities.get_zones_with_free_faces_for_given_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
2815
|
+
>>> meshing_session.meshing_utilities.get_zones_with_free_faces_for_given_face_zones(face_zone_id_list=[face_zone_name_pattern="*"])
|
|
2816
|
+
"""
|
|
2817
|
+
pass
|
|
2818
|
+
|
|
2819
|
+
class get_zones_with_marked_faces_for_given_face_zones(PyQuery):
|
|
2820
|
+
"""
|
|
2821
|
+
Return a list of zones with marked faces for the face zones specified.
|
|
2822
|
+
|
|
2823
|
+
Parameters
|
|
2824
|
+
----------
|
|
2825
|
+
face_zone_id_list : list[int]
|
|
2826
|
+
List containing the face zone IDs.
|
|
2827
|
+
face_zone_name_list : list[str]
|
|
2828
|
+
List containing the face zone names.
|
|
2829
|
+
face_zone_name_pattern : str
|
|
2830
|
+
Face zone name pattern.
|
|
2831
|
+
|
|
2832
|
+
Returns
|
|
2833
|
+
-------
|
|
2834
|
+
list[int]
|
|
2835
|
+
|
|
2836
|
+
Examples
|
|
2837
|
+
--------
|
|
2838
|
+
>>> meshing_session.meshing_utilities.get_zones_with_marked_faces_for_given_face_zones(face_zone_id_list=[29, 30, 31, 32, 33])
|
|
2839
|
+
>>> meshing_session.meshing_utilities.get_zones_with_marked_faces_for_given_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
2840
|
+
>>> meshing_session.meshing_utilities.get_zones_with_marked_faces_for_given_face_zones(face_zone_id_list=[face_zone_name_pattern="*"])
|
|
2841
|
+
"""
|
|
2842
|
+
pass
|
|
2843
|
+
|
|
2844
|
+
class get_zones_with_multi_faces_for_given_face_zones(PyQuery):
|
|
2845
|
+
"""
|
|
2846
|
+
Return a list of zones with multi-connected faces for the face zones specified.
|
|
2847
|
+
|
|
2848
|
+
Parameters
|
|
2849
|
+
----------
|
|
2850
|
+
face_zone_id_list : list[int]
|
|
2851
|
+
List containing the face zone IDs.
|
|
2852
|
+
face_zone_name_list : list[str]
|
|
2853
|
+
List containing the face zone names.
|
|
2854
|
+
face_zone_name_pattern : str
|
|
2855
|
+
Face zone name pattern.
|
|
2856
|
+
|
|
2857
|
+
Returns
|
|
2858
|
+
-------
|
|
2859
|
+
list[int]
|
|
2860
|
+
|
|
2861
|
+
Examples
|
|
2862
|
+
--------
|
|
2863
|
+
>>> meshing_session.meshing_utilities.get_zones_with_multi_faces_for_given_face_zones(face_zone_id_list=[29, 30, 31, 32, 33])
|
|
2864
|
+
>>> meshing_session.meshing_utilities.get_zones_with_multi_faces_for_given_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"])
|
|
2865
|
+
>>> meshing_session.meshing_utilities.get_zones_with_multi_faces_for_given_face_zones(face_zone_id_list=[face_zone_name_pattern="*"])
|
|
2866
|
+
"""
|
|
2867
|
+
pass
|
|
2868
|
+
|
|
2869
|
+
class interior_zone_exists(PyQuery):
|
|
2870
|
+
"""
|
|
2871
|
+
Report if the interior face zone exists.
|
|
2872
|
+
|
|
2873
|
+
Parameters
|
|
2874
|
+
----------
|
|
2875
|
+
zone_id : int
|
|
2876
|
+
Zone ID.
|
|
2877
|
+
zone_name : str
|
|
2878
|
+
Zone name.
|
|
2879
|
+
|
|
2880
|
+
Returns
|
|
2881
|
+
-------
|
|
2882
|
+
bool
|
|
2883
|
+
|
|
2884
|
+
Examples
|
|
2885
|
+
--------
|
|
2886
|
+
>>> meshing_session.meshing_utilities.interior_zone_exists(zone_id=31)
|
|
2887
|
+
>>> meshing_session.meshing_utilities.interior_zone_exists(zone_name="wall-inlet")
|
|
2888
|
+
"""
|
|
2889
|
+
pass
|
|
2890
|
+
|
|
2891
|
+
class mark_bad_quality_faces(PyQuery):
|
|
2892
|
+
"""
|
|
2893
|
+
Mark bad quality faces on the boundary face zones specified, based on the quality limit (quality_limit) and number of rings (number_of_rings).
|
|
2894
|
+
|
|
2895
|
+
Parameters
|
|
2896
|
+
----------
|
|
2897
|
+
face_zone_id_list : list[int]
|
|
2898
|
+
List containing the face zone IDs.
|
|
2899
|
+
face_zone_name_list : list[str]
|
|
2900
|
+
List containing the face zone names.
|
|
2901
|
+
face_zone_name_pattern : str
|
|
2902
|
+
Face zone name pattern.
|
|
2903
|
+
quality_limit : float
|
|
2904
|
+
Quality limit.
|
|
2905
|
+
number_of_rings : int
|
|
2906
|
+
Number of rings.
|
|
2907
|
+
|
|
2908
|
+
Returns
|
|
2909
|
+
-------
|
|
2910
|
+
int
|
|
2911
|
+
|
|
2912
|
+
Examples
|
|
2913
|
+
--------
|
|
2914
|
+
>>> meshing_session.meshing_utilities.mark_bad_quality_faces(face_zone_id_list=[30, 31, 32], quality_limit=0.5, number_of_rings=2)
|
|
2915
|
+
>>> meshing_session.meshing_utilities.mark_bad_quality_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], quality_limit=0.5, number_of_rings=2)
|
|
2916
|
+
>>> meshing_session.meshing_utilities.mark_bad_quality_faces(face_zone_name_pattern="*", quality_limit=0.5, number_of_rings=2)
|
|
2917
|
+
"""
|
|
2918
|
+
pass
|
|
2919
|
+
|
|
2920
|
+
class mark_duplicate_faces(PyQuery):
|
|
2921
|
+
"""
|
|
2922
|
+
Mark duplicate faces on the face zones specified.
|
|
2923
|
+
|
|
2924
|
+
Parameters
|
|
2925
|
+
----------
|
|
2926
|
+
face_zone_id_list : list[int]
|
|
2927
|
+
List containing the face zone IDs.
|
|
2928
|
+
face_zone_name_list : list[str]
|
|
2929
|
+
List containing the face zone names.
|
|
2930
|
+
face_zone_name_pattern : str
|
|
2931
|
+
Face zone name pattern.
|
|
2932
|
+
|
|
2933
|
+
Returns
|
|
2934
|
+
-------
|
|
2935
|
+
int
|
|
2936
|
+
|
|
2937
|
+
Examples
|
|
2938
|
+
--------
|
|
2939
|
+
>>> meshing_session.meshing_utilities.mark_duplicate_faces(face_zone_id_list=[30, 31, 32])
|
|
2940
|
+
>>> meshing_session.meshing_utilities.mark_duplicate_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
2941
|
+
>>> meshing_session.meshing_utilities.mark_duplicate_faces(face_zone_name_pattern="*")
|
|
2942
|
+
"""
|
|
2943
|
+
pass
|
|
2944
|
+
|
|
2945
|
+
class mark_face_strips_by_height_and_quality(PyQuery):
|
|
2946
|
+
"""
|
|
2947
|
+
- Mark face strips based on the strip_type, strip_height, quality_measure, quality_limit, and feature_angle specified.
|
|
2948
|
+
- Possible values for strip_type are 1, 2, 3 and 4.
|
|
2949
|
+
- 1 - 'boundary-boundary' strip, multi-connected face edges are also considered as boundary here.
|
|
2950
|
+
- 2 - feature-feature strip between angle based features, feature edges, multi-connected edges, and free edges are angle based features and boundary edges will be considered features if there is an angle.
|
|
2951
|
+
- 3 - 'all-all' strip between all boundaries and features.
|
|
2952
|
+
- 4 - 'pure feature-feature' strip, only pure features, boundary edges and multi edges will not be considered as pure feature edges even if there is an angle based feature.
|
|
2953
|
+
- The recommended value is 2.
|
|
2954
|
+
- Specify the 'quality_measure' as one of the 'Skewness', 'Size Change', 'Edge Ratio', 'Area', 'Aspect Ratio', 'Warp', 'Dihedral Angle', 'Ortho Skew' value.
|
|
2955
|
+
|
|
2956
|
+
Parameters
|
|
2957
|
+
----------
|
|
2958
|
+
face_zone_id_list : list[int]
|
|
2959
|
+
List containing the face zone IDs.
|
|
2960
|
+
face_zone_name_list : list[str]
|
|
2961
|
+
List containing the face zone names.
|
|
2962
|
+
face_zone_name_pattern : str
|
|
2963
|
+
Face zone name pattern.
|
|
2964
|
+
strip_type : int
|
|
2965
|
+
Strip type.
|
|
2966
|
+
strip_height : float
|
|
2967
|
+
Strip height.
|
|
2968
|
+
quality_measure : str
|
|
2969
|
+
Quality measure.
|
|
2970
|
+
quality_limit : float
|
|
2971
|
+
Quality limit.
|
|
2972
|
+
feature_angle : float
|
|
2973
|
+
Feature angle.
|
|
2974
|
+
|
|
2975
|
+
Returns
|
|
2976
|
+
-------
|
|
2977
|
+
int
|
|
2978
|
+
|
|
2979
|
+
Examples
|
|
2980
|
+
--------
|
|
2981
|
+
>>> meshing_session.meshing_utilities.mark_face_strips_by_height_and_quality(face_zone_id_list=[30, 31, 32], strip_type=2, strip_height=2, quality_measure="Size Change", quality_limit=0.5, feature_angle=40)
|
|
2982
|
+
>>> meshing_session.meshing_utilities.mark_face_strips_by_height_and_quality(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], strip_type=2, strip_height=2, quality_measure="Size Change", quality_limit=0.5, feature_angle=40)
|
|
2983
|
+
>>> meshing_session.meshing_utilities.mark_face_strips_by_height_and_quality(face_zone_name_pattern="cold*", strip_type=2, strip_height=2, quality_measure="Size Change", quality_limit=0.5, feature_angle=40)
|
|
2984
|
+
"""
|
|
2985
|
+
pass
|
|
2986
|
+
|
|
2987
|
+
class mark_faces_by_quality(PyQuery):
|
|
2988
|
+
"""
|
|
2989
|
+
- Mark faces based on the 'quality_measure' and 'quality_limit' specified.
|
|
2990
|
+
- Specify whether to append the faces to those previously marked or clear previously marked faces (append_marking set to True or False).
|
|
2991
|
+
- Specify the 'quality_measure' as one of the 'Skewness', 'Size Change', 'Edge Ratio', 'Area', 'Aspect Ratio', 'Warp', 'Dihedral Angle', 'Ortho Skew' value.
|
|
2992
|
+
|
|
2993
|
+
Parameters
|
|
2994
|
+
----------
|
|
2995
|
+
face_zone_id_list : list[int]
|
|
2996
|
+
List containing the face zone IDs.
|
|
2997
|
+
face_zone_name_list : list[str]
|
|
2998
|
+
List containing the face zone names.
|
|
2999
|
+
face_zone_name_pattern : str
|
|
3000
|
+
Face zone name pattern.
|
|
3001
|
+
quality_measure : str
|
|
3002
|
+
Quality measure.
|
|
3003
|
+
quality_limit : float
|
|
3004
|
+
Quality limit.
|
|
3005
|
+
append_marking : bool
|
|
3006
|
+
Specify whether to append the faces to those previously marked or clear previously marked faces.
|
|
3007
|
+
|
|
3008
|
+
Returns
|
|
3009
|
+
-------
|
|
3010
|
+
None
|
|
3011
|
+
|
|
3012
|
+
Examples
|
|
3013
|
+
--------
|
|
3014
|
+
>>> meshing_session.meshing_utilities.mark_faces_by_quality(face_zone_id_list=[30, 31, 32], quality_measure="Skewness", quality_limit=0.9, append_marking=False)
|
|
3015
|
+
>>> meshing_session.meshing_utilities.mark_faces_by_quality(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], quality_measure="Skewness", quality_limit=0.9, append_marking=False)
|
|
3016
|
+
>>> meshing_session.meshing_utilities.mark_faces_by_quality(face_zone_name_pattern="*", quality_measure="Skewness", quality_limit=0.9, append_marking=False)
|
|
3017
|
+
"""
|
|
3018
|
+
pass
|
|
3019
|
+
|
|
3020
|
+
class mark_faces_deviating_from_size_field(PyQuery):
|
|
3021
|
+
"""
|
|
3022
|
+
- Mark all faces at nodes based on deviation from the size field.
|
|
3023
|
+
- Specify the size field type to be used to get size at node.
|
|
3024
|
+
- Set 'size_factor_type_to_compare' to 'volumetric' or 'geodesic'.
|
|
3025
|
+
- Faces will be marked if the minimum edge length at the node is less than min_size_factor × size_factor_type_to_compare or the maximum edge length is greater than max_size_factor × size_factor_type_to_compare.
|
|
3026
|
+
|
|
3027
|
+
Parameters
|
|
3028
|
+
----------
|
|
3029
|
+
face_zone_id_list : list[int]
|
|
3030
|
+
List containing the face zone IDs.
|
|
3031
|
+
face_zone_name_list : list[str]
|
|
3032
|
+
List containing the face zone names.
|
|
3033
|
+
face_zone_name_pattern : str
|
|
3034
|
+
Face zone name pattern.
|
|
3035
|
+
min_size_factor : float
|
|
3036
|
+
Minimum size factor.
|
|
3037
|
+
max_size_factor : float
|
|
3038
|
+
Maximum size factor.
|
|
3039
|
+
size_factor_type_to_compare : str
|
|
3040
|
+
Size field type to be used to get size at node.
|
|
3041
|
+
|
|
3042
|
+
Returns
|
|
3043
|
+
-------
|
|
3044
|
+
int
|
|
3045
|
+
|
|
3046
|
+
Examples
|
|
3047
|
+
--------
|
|
3048
|
+
>>> meshing_session.meshing_utilities.mark_faces_deviating_from_size_field(face_zone_id_list=[30, 31, 32], min_size_factor=0.5, max_size_factor=1.1, size_factor_type_to_compare="geodesic")
|
|
3049
|
+
>>> meshing_session.meshing_utilities.mark_faces_deviating_from_size_field(face_zone_name_list=["cold-inlet", "hot-inlet"] min_size_factor=0.5, max_size_factor=1.1, size_factor_type_to_compare="geodesic")
|
|
3050
|
+
>>> meshing_session.meshing_utilities.mark_faces_deviating_from_size_field(face_zone_name_pattern="*", min_size_factor=0.5, max_size_factor=1.1, size_factor_type_to_compare="geodesic")
|
|
3051
|
+
"""
|
|
3052
|
+
pass
|
|
3053
|
+
|
|
3054
|
+
class mark_faces_in_self_proximity(PyQuery):
|
|
3055
|
+
"""
|
|
3056
|
+
- Mark faces in self-proximity on the face zones specified.
|
|
3057
|
+
- Specify whether to use relative tolerance (relative_tolerance set to True or False), tolerance value, the angle, and whether to ignore orientation (ignore_orientation set to True or False).
|
|
3058
|
+
|
|
3059
|
+
Parameters
|
|
3060
|
+
----------
|
|
3061
|
+
face_zone_id_list : list[int]
|
|
3062
|
+
List containing the face zone IDs.
|
|
3063
|
+
face_zone_name_list : list[str]
|
|
3064
|
+
List containing the face zone names.
|
|
3065
|
+
face_zone_name_pattern : str
|
|
3066
|
+
Face zone name pattern.
|
|
3067
|
+
relative_tolerance : bool
|
|
3068
|
+
Specify whether to use relative tolerance.
|
|
3069
|
+
tolerance : float
|
|
3070
|
+
Tolerance.
|
|
3071
|
+
proximity_angle : float
|
|
3072
|
+
Proximity angle.
|
|
3073
|
+
ignore_orientation : bool
|
|
3074
|
+
Specify whether to ignore orientation.
|
|
3075
|
+
|
|
3076
|
+
Returns
|
|
3077
|
+
-------
|
|
3078
|
+
None
|
|
3079
|
+
|
|
3080
|
+
Examples
|
|
3081
|
+
--------
|
|
3082
|
+
>>> meshing_session.meshing_utilities.mark_faces_in_self_proximity(face_zone_id_list=[30, 31, 32], relative_tolerance=True, tolerance=0.05, proximity_angle=40.5, ignore_orientation=False)
|
|
3083
|
+
>>> meshing_session.meshing_utilities.mark_faces_in_self_proximity(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], relative_tolerance=True, tolerance=0.05, proximity_angle=40.5, ignore_orientation=False)
|
|
3084
|
+
>>> meshing_session.meshing_utilities.mark_faces_in_self_proximity(face_zone_name_pattern="*", relative_tolerance=True, tolerance=0.05, proximity_angle=40.5, ignore_orientation=False)
|
|
3085
|
+
"""
|
|
3086
|
+
pass
|
|
3087
|
+
|
|
3088
|
+
class mark_faces_using_node_degree(PyQuery):
|
|
3089
|
+
"""
|
|
3090
|
+
- Mark all faces with node degree above the specified threshold.
|
|
3091
|
+
- Node degree is defined as the number of edges connected to the node.
|
|
3092
|
+
|
|
3093
|
+
Parameters
|
|
3094
|
+
----------
|
|
3095
|
+
face_zone_id_list : list[int]
|
|
3096
|
+
List containing the face zone IDs.
|
|
3097
|
+
face_zone_name_list : list[str]
|
|
3098
|
+
List containing the face zone names.
|
|
3099
|
+
face_zone_name_pattern : str
|
|
3100
|
+
Face zone name pattern.
|
|
3101
|
+
node_degree_threshold : int
|
|
3102
|
+
Number of edges connected to the node.
|
|
3103
|
+
|
|
3104
|
+
Returns
|
|
3105
|
+
-------
|
|
3106
|
+
None
|
|
3107
|
+
|
|
3108
|
+
Examples
|
|
3109
|
+
--------
|
|
3110
|
+
>>> meshing_session.meshing_utilities.mark_faces_using_node_degree(face_zone_id_list=[30, 31, 32], node_degree_threshold=2)
|
|
3111
|
+
>>> meshing_session.meshing_utilities.mark_faces_using_node_degree(face_zone_name_list=["cold-inlet", "hot-inlet"], node_degree_threshold=2)
|
|
3112
|
+
>>> meshing_session.meshing_utilities.mark_faces_using_node_degree(face_zone_name_pattern="*", node_degree_threshold=2)
|
|
3113
|
+
"""
|
|
3114
|
+
pass
|
|
3115
|
+
|
|
3116
|
+
class mark_free_faces(PyQuery):
|
|
3117
|
+
"""
|
|
3118
|
+
Mark free faces on the face zones specified.
|
|
3119
|
+
|
|
3120
|
+
Parameters
|
|
3121
|
+
----------
|
|
3122
|
+
face_zone_id_list : list[int]
|
|
3123
|
+
List containing the face zone IDs.
|
|
3124
|
+
face_zone_name_list : list[str]
|
|
3125
|
+
List containing the face zone names.
|
|
3126
|
+
face_zone_name_pattern : str
|
|
3127
|
+
Face zone name pattern.
|
|
3128
|
+
|
|
3129
|
+
Returns
|
|
3130
|
+
-------
|
|
3131
|
+
int
|
|
3132
|
+
|
|
3133
|
+
Examples
|
|
3134
|
+
--------
|
|
3135
|
+
>>> meshing_session.meshing_utilities.mark_free_faces(face_zone_id_list=[30, 31, 32])
|
|
3136
|
+
>>> meshing_session.meshing_utilities.mark_free_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
3137
|
+
>>> meshing_session.meshing_utilities.mark_free_faces(face_zone_name_pattern="*")
|
|
3138
|
+
"""
|
|
3139
|
+
pass
|
|
3140
|
+
|
|
3141
|
+
class mark_invalid_normals(PyQuery):
|
|
3142
|
+
"""
|
|
3143
|
+
Mark invalid normal locations on the face zones specified.
|
|
3144
|
+
|
|
3145
|
+
Parameters
|
|
3146
|
+
----------
|
|
3147
|
+
face_zone_id_list : list[int]
|
|
3148
|
+
List containing the face zone IDs.
|
|
3149
|
+
face_zone_name_list : list[str]
|
|
3150
|
+
List containing the face zone names.
|
|
3151
|
+
face_zone_name_pattern : str
|
|
3152
|
+
Face zone name pattern.
|
|
3153
|
+
|
|
3154
|
+
Returns
|
|
3155
|
+
-------
|
|
3156
|
+
int
|
|
3157
|
+
|
|
3158
|
+
Examples
|
|
3159
|
+
--------
|
|
3160
|
+
>>> meshing_session.meshing_utilities.mark_invalid_normals(face_zone_id_list=[30, 31, 32])
|
|
3161
|
+
>>> meshing_session.meshing_utilities.mark_invalid_normals(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
3162
|
+
>>> meshing_session.meshing_utilities.mark_invalid_normals(face_zone_name_pattern="*")
|
|
3163
|
+
"""
|
|
3164
|
+
pass
|
|
3165
|
+
|
|
3166
|
+
class mark_island_faces(PyQuery):
|
|
3167
|
+
"""
|
|
3168
|
+
Mark island faces on the face zones specified, based on the island face count (island_face_count).
|
|
3169
|
+
|
|
3170
|
+
Parameters
|
|
3171
|
+
----------
|
|
3172
|
+
face_zone_id_list : list[int]
|
|
3173
|
+
List containing the face zone IDs.
|
|
3174
|
+
face_zone_name_list : list[str]
|
|
3175
|
+
List containing the face zone names.
|
|
3176
|
+
face_zone_name_pattern : str
|
|
3177
|
+
Face zone name pattern.
|
|
3178
|
+
island_face_count : int
|
|
3179
|
+
Island face count.
|
|
3180
|
+
|
|
3181
|
+
Returns
|
|
3182
|
+
-------
|
|
3183
|
+
None
|
|
3184
|
+
|
|
3185
|
+
Examples
|
|
3186
|
+
--------
|
|
3187
|
+
>>> meshing_session.meshing_utilities.mark_island_faces(face_zone_id_list=[30, 31, 32], island_face_count=5)
|
|
3188
|
+
>>> meshing_session.meshing_utilities.mark_island_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], island_face_count=5)
|
|
3189
|
+
>>> meshing_session.meshing_utilities.mark_island_faces(face_zone_name_pattern="cold*", island_face_count=5)
|
|
3190
|
+
"""
|
|
3191
|
+
pass
|
|
3192
|
+
|
|
3193
|
+
class mark_multi_faces(PyQuery):
|
|
3194
|
+
"""
|
|
3195
|
+
Mark multi-connected faces on the face zones specified based on fringe length (fringe_length).
|
|
3196
|
+
|
|
3197
|
+
Parameters
|
|
3198
|
+
----------
|
|
3199
|
+
face_zone_id_list : list[int]
|
|
3200
|
+
List containing the face zone IDs.
|
|
3201
|
+
face_zone_name_list : list[str]
|
|
3202
|
+
List containing the face zone names.
|
|
3203
|
+
face_zone_name_pattern : str
|
|
3204
|
+
Face zone name pattern.
|
|
3205
|
+
fringe_length : int
|
|
3206
|
+
Fringe length.
|
|
3207
|
+
|
|
3208
|
+
Returns
|
|
3209
|
+
-------
|
|
3210
|
+
int
|
|
3211
|
+
|
|
3212
|
+
Examples
|
|
3213
|
+
--------
|
|
3214
|
+
>>> meshing_session.meshing_utilities.mark_multi_faces(face_zone_id_list=[30, 31, 32], fringe_length=5)
|
|
3215
|
+
>>> meshing_session.meshing_utilities.mark_multi_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], fringe_length=5)
|
|
3216
|
+
>>> meshing_session.meshing_utilities.mark_multi_faces(face_zone_name_pattern="cold*", fringe_length=5)
|
|
3217
|
+
"""
|
|
3218
|
+
pass
|
|
3219
|
+
|
|
3220
|
+
class mark_point_contacts(PyQuery):
|
|
3221
|
+
"""
|
|
3222
|
+
Mark point contact locations on the face zones specified.
|
|
3223
|
+
|
|
3224
|
+
Parameters
|
|
3225
|
+
----------
|
|
3226
|
+
face_zone_id_list : list[int]
|
|
3227
|
+
List containing the face zone IDs.
|
|
3228
|
+
face_zone_name_list : list[str]
|
|
3229
|
+
List containing the face zone names.
|
|
3230
|
+
face_zone_name_pattern : str
|
|
3231
|
+
Face zone name pattern.
|
|
3232
|
+
|
|
3233
|
+
Returns
|
|
3234
|
+
-------
|
|
3235
|
+
None
|
|
3236
|
+
|
|
3237
|
+
Examples
|
|
3238
|
+
--------
|
|
3239
|
+
>>> meshing_session.meshing_utilities.mark_point_contacts(face_zone_id_list=[30, 31, 32])
|
|
3240
|
+
>>> meshing_session.meshing_utilities.mark_point_contacts(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
3241
|
+
>>> meshing_session.meshing_utilities.mark_point_contacts(face_zone_name_pattern="cold*")
|
|
3242
|
+
"""
|
|
3243
|
+
pass
|
|
3244
|
+
|
|
3245
|
+
class mark_self_intersecting_faces(PyQuery):
|
|
3246
|
+
"""
|
|
3247
|
+
- Mark self-intersecting faces on the face zones specified.
|
|
3248
|
+
- Specify whether to mark folded faces or not (mark_folded set to True or False).
|
|
3249
|
+
|
|
3250
|
+
Parameters
|
|
3251
|
+
----------
|
|
3252
|
+
face_zone_id_list : list[int]
|
|
3253
|
+
List containing the face zone IDs.
|
|
3254
|
+
face_zone_name_list : list[str]
|
|
3255
|
+
List containing the face zone names.
|
|
3256
|
+
face_zone_name_pattern : str
|
|
3257
|
+
Face zone name pattern.
|
|
3258
|
+
mark_folded : bool
|
|
3259
|
+
Specify whether to mark folded faces or not.
|
|
3260
|
+
|
|
3261
|
+
Returns
|
|
3262
|
+
-------
|
|
3263
|
+
int
|
|
3264
|
+
|
|
3265
|
+
Examples
|
|
3266
|
+
--------
|
|
3267
|
+
>>> meshing_session.meshing_utilities.mark_self_intersecting_faces(face_zone_id_list=[30, 31, 32], mark_folded=True)
|
|
3268
|
+
>>> meshing_session.meshing_utilities.mark_self_intersecting_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], mark_folded=True)
|
|
3269
|
+
>>> meshing_session.meshing_utilities.mark_self_intersecting_faces(face_zone_name_pattern="cold*", mark_folded=True)
|
|
3270
|
+
"""
|
|
3271
|
+
pass
|
|
3272
|
+
|
|
3273
|
+
class mark_sliver_faces(PyQuery):
|
|
3274
|
+
"""
|
|
3275
|
+
Mark sliver faces on the face zones specified, based on the maximum height (max_height) and skewness limit (skew_limit).
|
|
3276
|
+
|
|
3277
|
+
Parameters
|
|
3278
|
+
----------
|
|
3279
|
+
face_zone_id_list : list[int]
|
|
3280
|
+
List containing the face zone IDs.
|
|
3281
|
+
face_zone_name_list : list[str]
|
|
3282
|
+
List containing the face zone names.
|
|
3283
|
+
face_zone_name_pattern : str
|
|
3284
|
+
Face zone name pattern.
|
|
3285
|
+
max_height : float
|
|
3286
|
+
Maximum height.
|
|
3287
|
+
skew_limit : float
|
|
3288
|
+
Skew limit.
|
|
3289
|
+
|
|
3290
|
+
Returns
|
|
3291
|
+
-------
|
|
3292
|
+
int
|
|
3293
|
+
|
|
3294
|
+
Examples
|
|
3295
|
+
--------
|
|
3296
|
+
>>> meshing_session.meshing_utilities.mark_sliver_faces(face_zone_id_list=[30, 31, 32], max_height=2, skew_limit=0.2)
|
|
3297
|
+
>>> meshing_session.meshing_utilities.mark_sliver_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], max_height=2, skew_limit=0.2)
|
|
3298
|
+
>>> meshing_session.meshing_utilities.mark_sliver_faces(face_zone_name_pattern="cold*", max_height=2, skew_limit=0.2)
|
|
3299
|
+
"""
|
|
3300
|
+
pass
|
|
3301
|
+
|
|
3302
|
+
class mark_spikes(PyQuery):
|
|
3303
|
+
"""
|
|
3304
|
+
Mark spikes on the face zones specified, based on the spike angle (spike_angle).
|
|
3305
|
+
|
|
3306
|
+
Parameters
|
|
3307
|
+
----------
|
|
3308
|
+
face_zone_id_list : list[int]
|
|
3309
|
+
List containing the face zone IDs.
|
|
3310
|
+
face_zone_name_list : list[str]
|
|
3311
|
+
List containing the face zone names.
|
|
3312
|
+
face_zone_name_pattern : str
|
|
3313
|
+
Face zone name pattern.
|
|
3314
|
+
spike_angle : float
|
|
3315
|
+
Spike angle.
|
|
3316
|
+
|
|
3317
|
+
Returns
|
|
3318
|
+
-------
|
|
3319
|
+
int
|
|
3320
|
+
|
|
3321
|
+
Examples
|
|
3322
|
+
--------
|
|
3323
|
+
>>> meshing_session.meshing_utilities.mark_spikes(face_zone_id_list=[30, 31, 32], spike_angle=40.5)
|
|
3324
|
+
>>> meshing_session.meshing_utilities.mark_spikes(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], spike_angle=40.5)
|
|
3325
|
+
>>> meshing_session.meshing_utilities.mark_spikes(face_zone_name_pattern="cold*", spike_angle=40.5)
|
|
3326
|
+
"""
|
|
3327
|
+
pass
|
|
3328
|
+
|
|
3329
|
+
class mark_steps(PyQuery):
|
|
3330
|
+
"""
|
|
3331
|
+
Mark steps on the face zones specified, based on the step angle (step_angle) and step width (step_width).
|
|
3332
|
+
|
|
3333
|
+
Parameters
|
|
3334
|
+
----------
|
|
3335
|
+
face_zone_id_list : list[int]
|
|
3336
|
+
List containing the face zone IDs.
|
|
3337
|
+
face_zone_name_list : list[str]
|
|
3338
|
+
List containing the face zone names.
|
|
3339
|
+
face_zone_name_pattern : str
|
|
3340
|
+
Face zone name pattern.
|
|
3341
|
+
step_angle : float
|
|
3342
|
+
Step angle.
|
|
3343
|
+
step_width : float
|
|
3344
|
+
Step width.
|
|
3345
|
+
|
|
3346
|
+
Returns
|
|
3347
|
+
-------
|
|
3348
|
+
int
|
|
3349
|
+
|
|
3350
|
+
Examples
|
|
3351
|
+
--------
|
|
3352
|
+
>>> meshing_session.meshing_utilities.mark_steps(face_zone_id_list=[30, 31, 32], step_angle=40.5, step_width=3.3)
|
|
3353
|
+
>>> meshing_session.meshing_utilities.mark_steps(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], step_angle=40.5, step_width=3.3)
|
|
3354
|
+
>>> meshing_session.meshing_utilities.mark_steps(face_zone_name_pattern="cold*", step_angle=40.5, step_width=3.3)
|
|
3355
|
+
"""
|
|
3356
|
+
pass
|
|
3357
|
+
|
|
3358
|
+
class mesh_check(PyQuery):
|
|
3359
|
+
"""
|
|
3360
|
+
- Reports the selected mesh check statistics for the zones specified.
|
|
3361
|
+
- Specify the 'type_name' as one of the 'bounding-box-statistics', 'volume-statistics', 'face-area-statistics', 'nodes-per-edge', 'nodes-per-face', 'nodes-per-cell', 'faces-or-neighbors-per-cell', 'cell-faces-or-neighbors', 'isolated-cells', 'face-handedness', 'periodic-face-pairs', 'face-children', 'zone-boundary-conditions', 'invalid-node-coordinates', 'poly-cells', 'parallel-invalid-zones', 'parallel-invalid-neighborhood', 'parallel-invalid-interfaces' value.
|
|
3362
|
+
|
|
3363
|
+
Parameters
|
|
3364
|
+
----------
|
|
3365
|
+
type_name : str
|
|
3366
|
+
Type name.
|
|
3367
|
+
edge_zone_id_list : list[int]
|
|
3368
|
+
List containing the edge zone IDs.
|
|
3369
|
+
edge_zone_name_list : list[str]
|
|
3370
|
+
List containing the edge zone names.
|
|
3371
|
+
edge_zone_name_pattern : str
|
|
3372
|
+
Edge zone name pattern.
|
|
3373
|
+
face_zone_id_list : list[int]
|
|
3374
|
+
List containing the face zone IDs.
|
|
3375
|
+
face_zone_name_list : list[str]
|
|
3376
|
+
List containing the face zone names.
|
|
3377
|
+
face_zone_name_pattern : str
|
|
3378
|
+
Face zone name pattern.
|
|
3379
|
+
cell_zone_id_list : list[int]
|
|
3380
|
+
List containing the cell zone IDs.
|
|
3381
|
+
cell_zone_name_list : list[str]
|
|
3382
|
+
List containing the cell zone names.
|
|
3383
|
+
cell_zone_name_pattern : str
|
|
3384
|
+
Cell zone name pattern.
|
|
3385
|
+
|
|
3386
|
+
Returns
|
|
3387
|
+
-------
|
|
3388
|
+
None
|
|
3389
|
+
|
|
3390
|
+
Examples
|
|
3391
|
+
--------
|
|
3392
|
+
>>> meshing_session.meshing_utilities.mesh_check(type_name="face-children", edge_zone_id_list=[22, 23], face_zone_id_list=[30, 31, 32], cell_zone_id_list=[87])
|
|
3393
|
+
>>> meshing_session.meshing_utilities.mesh_check(type_name="nodes-per-cell", edge_zone_name_pattern="cold-inlet*", face_zone_id_list=[30, 31, 32], cell_zone_id_list=[87])
|
|
3394
|
+
>>> meshing_session.meshing_utilities.mesh_check(type_name="volume-statistics", edge_zone_id_list=[22, 23], face_zone_name_pattern="*", cell_zone_id_list=[87])
|
|
3395
|
+
>>> meshing_session.meshing_utilities.mesh_check(type_name="nodes-per-cell", edge_zone_name_pattern="cold-inlet*", face_zone_name_pattern="*", cell_zone_id_list=[87])
|
|
3396
|
+
>>> meshing_session.meshing_utilities.mesh_check(type_name="face-children", edge_zone_id_list=[22, 23], face_zone_id_list=[30, 31, 32], cell_zone_name_pattern="*")
|
|
3397
|
+
>>> meshing_session.meshing_utilities.mesh_check(type_name="volume-statistics", edge_zone_name_pattern="cold-inlet*", face_zone_name_pattern="*", cell_zone_name_pattern="*")
|
|
3398
|
+
"""
|
|
3399
|
+
pass
|
|
3400
|
+
|
|
3401
|
+
class mesh_exists(PyQuery):
|
|
3402
|
+
"""
|
|
3403
|
+
Report if the volume mesh exists.
|
|
3404
|
+
|
|
3405
|
+
Returns
|
|
3406
|
+
-------
|
|
3407
|
+
None
|
|
3408
|
+
|
|
3409
|
+
Examples
|
|
3410
|
+
--------
|
|
3411
|
+
>>> meshing_session.meshing_utilities.mesh_exists()
|
|
3412
|
+
"""
|
|
3413
|
+
pass
|
|
3414
|
+
|
|
3415
|
+
class print_worst_quality_cell(PyQuery):
|
|
3416
|
+
"""
|
|
3417
|
+
- Report the worst quality cell (ID and location) for the cell zones based on the measure specified.
|
|
3418
|
+
- Specify the 'measure' as one of the 'Orthogonal Quality', 'Skewness', 'Equiangle Skewness', 'Size Change', 'Edge Ratio', 'Size', 'Aspect Ratio', 'Squish', 'Warp', 'Dihedral Angle', 'ICEMCFD Quality', 'Ortho Skew', 'FLUENT Aspect Ratio', 'Inverse Orthogonal Quality' value.
|
|
3419
|
+
|
|
3420
|
+
Parameters
|
|
3421
|
+
----------
|
|
3422
|
+
cell_zone_id_list : list[int]
|
|
3423
|
+
List containing the cell zone IDs.
|
|
3424
|
+
cell_zone_name_list : list[str]
|
|
3425
|
+
List containing the cell zone names.
|
|
3426
|
+
cell_zone_name_pattern : str
|
|
3427
|
+
Cell zone name pattern.
|
|
3428
|
+
measure : str
|
|
3429
|
+
Measure.
|
|
3430
|
+
|
|
3431
|
+
Returns
|
|
3432
|
+
-------
|
|
3433
|
+
None
|
|
3434
|
+
|
|
3435
|
+
Examples
|
|
3436
|
+
--------
|
|
3437
|
+
>>> meshing_session.meshing_utilities.print_worst_quality_cell(cell_zone_id_list=[87], measure="Orthogonal Quality")
|
|
3438
|
+
>>> meshing_session.meshing_utilities.print_worst_quality_cell(cell_zone_name_list=["elbow-fluid"], measure="Orthogonal Quality")
|
|
3439
|
+
>>> meshing_session.meshing_utilities.print_worst_quality_cell(cell_zone_name_pattern="*", measure="Orthogonal Quality")
|
|
3440
|
+
"""
|
|
3441
|
+
pass
|
|
3442
|
+
|
|
3443
|
+
class project_zone_on_plane(PyQuery):
|
|
3444
|
+
"""
|
|
3445
|
+
- Project a zone on the plane specified.
|
|
3446
|
+
- Specify three points for defining the plane.
|
|
3447
|
+
|
|
3448
|
+
Parameters
|
|
3449
|
+
----------
|
|
3450
|
+
zone_id : int
|
|
3451
|
+
Zone ID.
|
|
3452
|
+
plane : dict[str, Any]
|
|
3453
|
+
|
|
3454
|
+
Returns
|
|
3455
|
+
-------
|
|
3456
|
+
None
|
|
3457
|
+
|
|
3458
|
+
Examples
|
|
3459
|
+
--------
|
|
3460
|
+
>>> meshing_session.meshing_utilities.project_zone_on_plane(zone_id=87, plane=[[1, 0, 0], [0, 1, 0], [0, 0, 1]])
|
|
3461
|
+
"""
|
|
3462
|
+
pass
|
|
3463
|
+
|
|
3464
|
+
class refine_marked_faces_in_zones(PyQuery):
|
|
3465
|
+
"""
|
|
3466
|
+
Refine marked faces.
|
|
3467
|
+
|
|
3468
|
+
Parameters
|
|
3469
|
+
----------
|
|
3470
|
+
face_zone_id_list : list[int]
|
|
3471
|
+
List containing the face zone IDs.
|
|
3472
|
+
face_zone_name_list : list[str]
|
|
3473
|
+
List containing the face zone names.
|
|
3474
|
+
face_zone_name_pattern : str
|
|
3475
|
+
Face zone name pattern.
|
|
3476
|
+
|
|
3477
|
+
Returns
|
|
3478
|
+
-------
|
|
3479
|
+
None
|
|
3480
|
+
|
|
3481
|
+
Examples
|
|
3482
|
+
--------
|
|
3483
|
+
>>> meshing_session.meshing_utilities.refine_marked_faces_in_zones(face_zone_id_list=[30, 31, 32])
|
|
3484
|
+
>>> meshing_session.meshing_utilities.refine_marked_faces_in_zones(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
3485
|
+
>>> meshing_session.meshing_utilities.refine_marked_faces_in_zones(face_zone_name_pattern="cold*")
|
|
3486
|
+
"""
|
|
3487
|
+
pass
|
|
3488
|
+
|
|
3489
|
+
class scale_cell_zones_around_pivot(PyQuery):
|
|
3490
|
+
"""
|
|
3491
|
+
- Enables you to scale the cell zones around a pivot point or the bounding box center.
|
|
3492
|
+
- Specify the cell zones, the scale factors in the X, Y, Z directions (scale), the pivot point (pivot), and choose whether to use the bounding box center (use_bbox_center set to True or False).
|
|
3493
|
+
|
|
3494
|
+
Parameters
|
|
3495
|
+
----------
|
|
3496
|
+
cell_zone_id_list : list[int]
|
|
3497
|
+
List containing the cell zone IDs.
|
|
3498
|
+
cell_zone_name_list : list[str]
|
|
3499
|
+
List containing the cell zone names.
|
|
3500
|
+
cell_zone_name_pattern : str
|
|
3501
|
+
Cell zone name pattern.
|
|
3502
|
+
scale : list[float]
|
|
3503
|
+
Scale factors in the X, Y, Z directions.
|
|
3504
|
+
pivot : list[float]
|
|
3505
|
+
Pivot point.
|
|
3506
|
+
use_bbox_center : bool
|
|
3507
|
+
Specify whether to use the bounding box center.
|
|
3508
|
+
|
|
3509
|
+
Returns
|
|
3510
|
+
-------
|
|
3511
|
+
None
|
|
3512
|
+
|
|
3513
|
+
Examples
|
|
3514
|
+
--------
|
|
3515
|
+
>>> meshing_session.meshing_utilities.scale_cell_zones_around_pivot(cell_zone_id_list=[87], scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True)
|
|
3516
|
+
>>> meshing_session.meshing_utilities.scale_cell_zones_around_pivot(cell_zone_name_list=["elbow-fluid"], scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True)
|
|
3517
|
+
>>> meshing_session.meshing_utilities.scale_cell_zones_around_pivot(cell_zone_name_pattern="*", scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True)
|
|
3518
|
+
"""
|
|
3519
|
+
pass
|
|
3520
|
+
|
|
3521
|
+
class scale_face_zones_around_pivot(PyQuery):
|
|
3522
|
+
"""
|
|
3523
|
+
- Enables you to scale the face zones around a pivot point or the bounding box center.
|
|
3524
|
+
- Specify the face zones, the scale factors in the X, Y, Z directions (scale), the pivot point (pivot), and choose whether to use the bounding box center (use_bbox_center set to True or False).
|
|
3525
|
+
|
|
3526
|
+
Parameters
|
|
3527
|
+
----------
|
|
3528
|
+
face_zone_id_list : list[int]
|
|
3529
|
+
List containing the face zone IDs.
|
|
3530
|
+
face_zone_name_list : list[str]
|
|
3531
|
+
List containing the face zone names.
|
|
3532
|
+
face_zone_name_pattern : str
|
|
3533
|
+
Face zone name pattern.
|
|
3534
|
+
scale : list[float]
|
|
3535
|
+
Scale factors in the X, Y, Z directions.
|
|
3536
|
+
pivot : list[float]
|
|
3537
|
+
Pivot point.
|
|
3538
|
+
use_bbox_center : bool
|
|
3539
|
+
Specify whether to use the bounding box center.
|
|
3540
|
+
|
|
3541
|
+
Returns
|
|
3542
|
+
-------
|
|
3543
|
+
None
|
|
3544
|
+
|
|
3545
|
+
Examples
|
|
3546
|
+
--------
|
|
3547
|
+
>>> meshing_session.meshing_utilities.scale_face_zones_around_pivot(face_zone_id_list=[30, 31, 32], scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True)
|
|
3548
|
+
>>> meshing_session.meshing_utilities.scale_face_zones_around_pivot(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True)
|
|
3549
|
+
>>> meshing_session.meshing_utilities.scale_face_zones_around_pivot(face_zone_name_pattern="*", scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True)
|
|
3550
|
+
"""
|
|
3551
|
+
pass
|
|
3552
|
+
|
|
3553
|
+
class separate_cell_zone_layers_by_face_zone_using_id(PyQuery):
|
|
3554
|
+
"""
|
|
3555
|
+
- Separates cells that are connected to specified face zones into another cell zone.
|
|
3556
|
+
- This separation method applies only to prism cells.
|
|
3557
|
+
- Specify the number of layers of cells (nlayers) to be separated.
|
|
3558
|
+
|
|
3559
|
+
Parameters
|
|
3560
|
+
----------
|
|
3561
|
+
cell_zone_id : int
|
|
3562
|
+
Cell zone ID.
|
|
3563
|
+
face_zone_id_list : list[int]
|
|
3564
|
+
List containing the face zone IDs.
|
|
3565
|
+
face_zone_name_list : list[str]
|
|
3566
|
+
List containing the face zone names.
|
|
3567
|
+
face_zone_name_pattern : str
|
|
3568
|
+
Face zone name pattern.
|
|
3569
|
+
nlayers : int
|
|
3570
|
+
Number of layers of cells to be separated.
|
|
3571
|
+
|
|
3572
|
+
Returns
|
|
3573
|
+
-------
|
|
3574
|
+
None
|
|
3575
|
+
|
|
3576
|
+
Examples
|
|
3577
|
+
--------
|
|
3578
|
+
>>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_id(cell_zone_id=87, face_zone_id_list=[30, 31, 32], nlayers=2)
|
|
3579
|
+
>>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_id(cell_zone_id=87, face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], nlayers=2)
|
|
3580
|
+
>>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_id(cell_zone_id=87, face_zone_name_pattern="*", nlayers=2)
|
|
3581
|
+
"""
|
|
3582
|
+
pass
|
|
3583
|
+
|
|
3584
|
+
class separate_cell_zone_layers_by_face_zone_using_name(PyQuery):
|
|
3585
|
+
"""
|
|
3586
|
+
- Separates cells that are connected to specified face zones into another cell zone.
|
|
3587
|
+
- This separation method applies only to prism cells.
|
|
3588
|
+
- Specify the number of layers of cells (nlayers) to be separated.
|
|
3589
|
+
|
|
3590
|
+
Parameters
|
|
3591
|
+
----------
|
|
3592
|
+
cell_zone_name : str
|
|
3593
|
+
Cell zone name.
|
|
3594
|
+
face_zone_id_list : list[int]
|
|
3595
|
+
List containing the face zone IDs.
|
|
3596
|
+
face_zone_name_list : list[str]
|
|
3597
|
+
List containing the face zone names.
|
|
3598
|
+
face_zone_name_pattern : str
|
|
3599
|
+
Face zone name pattern.
|
|
3600
|
+
nlayers : int
|
|
3601
|
+
Number of layers of cells to be separated.
|
|
3602
|
+
|
|
3603
|
+
Returns
|
|
3604
|
+
-------
|
|
3605
|
+
None
|
|
3606
|
+
|
|
3607
|
+
Examples
|
|
3608
|
+
--------
|
|
3609
|
+
>>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_name(cell_zone_name="elbow-fluid", face_zone_id_list=[30, 31, 32], nlayers=2)
|
|
3610
|
+
>>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_name(cell_zone_name="elbow-fluid", face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], nlayers=2)
|
|
3611
|
+
>>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_name(cell_zone_name="elbow-fluid", face_zone_name_pattern="*", nlayers=2)
|
|
3612
|
+
"""
|
|
3613
|
+
pass
|
|
3614
|
+
|
|
3615
|
+
class separate_face_zones_by_cell_neighbor(PyQuery):
|
|
3616
|
+
"""
|
|
3617
|
+
Separate face zones based on the cell neighbors.
|
|
3618
|
+
|
|
3619
|
+
Parameters
|
|
3620
|
+
----------
|
|
3621
|
+
face_zone_id_list : list[int]
|
|
3622
|
+
List containing the face zone IDs.
|
|
3623
|
+
face_zone_name_list : list[str]
|
|
3624
|
+
List containing the face zone names.
|
|
3625
|
+
face_zone_name_pattern : str
|
|
3626
|
+
Face zone name pattern.
|
|
3627
|
+
|
|
3628
|
+
Returns
|
|
3629
|
+
-------
|
|
3630
|
+
None
|
|
3631
|
+
|
|
3632
|
+
Examples
|
|
3633
|
+
--------
|
|
3634
|
+
>>> meshing_session.meshing_utilities.separate_face_zones_by_cell_neighbor(face_zone_id_list=[30, 31, 32])
|
|
3635
|
+
>>> meshing_session.meshing_utilities.separate_face_zones_by_cell_neighbor(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"])
|
|
3636
|
+
>>> meshing_session.meshing_utilities.separate_face_zones_by_cell_neighbor(face_zone_name_pattern="cold*")
|
|
3637
|
+
"""
|
|
3638
|
+
pass
|
|
3639
|
+
|
|
3640
|
+
class unpreserve_cell_zones(PyQuery):
|
|
3641
|
+
"""
|
|
3642
|
+
Enables you to unpreserve some/all preserved cell zones during the meshing process.
|
|
3643
|
+
|
|
3644
|
+
Parameters
|
|
3645
|
+
----------
|
|
3646
|
+
cell_zone_id_list : list[int]
|
|
3647
|
+
List containing the cell zone IDs.
|
|
3648
|
+
cell_zone_name_list : list[str]
|
|
3649
|
+
List containing the cell zone names.
|
|
3650
|
+
cell_zone_name_pattern : str
|
|
3651
|
+
Cell zone name pattern.
|
|
3652
|
+
|
|
3653
|
+
Returns
|
|
3654
|
+
-------
|
|
3655
|
+
None
|
|
3656
|
+
|
|
3657
|
+
Examples
|
|
3658
|
+
--------
|
|
3659
|
+
>>> meshing_session.meshing_utilities.unpreserve_cell_zones(cell_zone_id_list=[87])
|
|
3660
|
+
>>> meshing_session.meshing_utilities.unpreserve_cell_zones(cell_zone_name_list=["elbow-fluid"])
|
|
3661
|
+
>>> meshing_session.meshing_utilities.unpreserve_cell_zones(cell_zone_name_pattern="*")
|
|
3662
|
+
"""
|
|
3663
|
+
pass
|
|
3664
|
+
|