ansys-fluent-core 0.34.1__py3-none-any.whl → 0.35.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 +48 -84
- ansys/fluent/core/codegen/allapigen.py +2 -2
- ansys/fluent/core/codegen/builtin_settingsgen.py +50 -28
- ansys/fluent/core/codegen/datamodelgen.py +3 -1
- ansys/fluent/core/codegen/print_fluent_version.py +2 -2
- ansys/fluent/core/codegen/settingsgen.py +1 -1
- ansys/fluent/core/codegen/tuigen.py +4 -4
- ansys/fluent/core/data_model_cache.py +2 -2
- ansys/fluent/core/docker/docker_compose.py +8 -9
- ansys/fluent/core/docker/utils.py +1 -1
- ansys/fluent/core/examples/downloads.py +8 -11
- ansys/fluent/core/fluent_connection.py +23 -15
- ansys/fluent/core/generated/api_tree/api_objects.json +1 -1
- ansys/fluent/core/generated/datamodel_231/flicing.py +55 -55
- ansys/fluent/core/generated/datamodel_231/meshing.py +209 -209
- ansys/fluent/core/generated/datamodel_232/flicing.py +45 -45
- ansys/fluent/core/generated/datamodel_232/meshing.py +205 -205
- ansys/fluent/core/generated/datamodel_241/flicing.py +30 -30
- ansys/fluent/core/generated/datamodel_241/meshing.py +298 -298
- ansys/fluent/core/generated/datamodel_242/flicing.py +35 -35
- ansys/fluent/core/generated/datamodel_242/meshing.py +321 -321
- ansys/fluent/core/generated/datamodel_242/part_management.py +3 -3
- ansys/fluent/core/generated/datamodel_251/flicing.py +40 -40
- ansys/fluent/core/generated/datamodel_251/meshing.py +315 -315
- ansys/fluent/core/generated/datamodel_251/part_management.py +6 -6
- ansys/fluent/core/generated/datamodel_252/flicing.py +45 -45
- ansys/fluent/core/generated/datamodel_252/meshing.py +398 -398
- ansys/fluent/core/generated/datamodel_261/flicing.py +50 -50
- ansys/fluent/core/generated/datamodel_261/meshing.py +406 -406
- ansys/fluent/core/generated/datamodel_261/meshing_utilities.py +616 -296
- ansys/fluent/core/generated/datamodel_261/part_management.py +10 -10
- ansys/fluent/core/generated/fluent_version_252.py +1 -1
- ansys/fluent/core/generated/fluent_version_261.py +3 -3
- ansys/fluent/core/generated/meshing/tui_261.py +1178 -1133
- ansys/fluent/core/generated/solver/settings_261.py +2378 -3023
- ansys/fluent/core/generated/solver/settings_261.pyi +1537 -1456
- ansys/fluent/core/generated/solver/settings_builtin.py +515 -27
- ansys/fluent/core/generated/solver/settings_builtin.pyi +2 -18
- ansys/fluent/core/generated/solver/tui_261.py +2606 -3483
- ansys/fluent/core/launcher/container_launcher.py +19 -4
- ansys/fluent/core/launcher/fluent_container.py +48 -39
- ansys/fluent/core/launcher/launch_options.py +5 -4
- ansys/fluent/core/launcher/launcher.py +16 -3
- ansys/fluent/core/launcher/launcher_utils.py +63 -15
- ansys/fluent/core/launcher/pim_launcher.py +17 -3
- ansys/fluent/core/launcher/process_launch_string.py +3 -2
- ansys/fluent/core/launcher/server_info.py +7 -3
- ansys/fluent/core/launcher/slurm_launcher.py +4 -2
- ansys/fluent/core/launcher/standalone_launcher.py +6 -3
- ansys/fluent/core/launcher/watchdog.py +3 -3
- ansys/fluent/core/launcher/watchdog_exec +1 -1
- ansys/fluent/core/logger.py +3 -1
- ansys/fluent/core/module_config.py +358 -0
- ansys/fluent/core/pyfluent_warnings.py +2 -2
- ansys/fluent/core/report.py +0 -2
- ansys/fluent/core/search.py +31 -18
- ansys/fluent/core/services/api_upgrade.py +3 -2
- ansys/fluent/core/services/datamodel_se.py +4 -2
- ansys/fluent/core/services/health_check.py +3 -1
- ansys/fluent/core/services/interceptors.py +8 -6
- ansys/fluent/core/session.py +31 -3
- ansys/fluent/core/session_pure_meshing.py +1 -1
- ansys/fluent/core/session_shared.py +4 -4
- ansys/fluent/core/session_solver.py +8 -2
- ansys/fluent/core/session_utilities.py +7 -0
- ansys/fluent/core/solver/flobject.py +6 -4
- ansys/fluent/core/solver/settings_builtin_bases.py +3 -3
- ansys/fluent/core/solver/settings_builtin_data.py +2 -14
- ansys/fluent/core/streaming_services/datamodel_event_streaming.py +3 -2
- ansys/fluent/core/streaming_services/datamodel_streaming.py +3 -1
- ansys/fluent/core/streaming_services/events_streaming.py +2 -18
- ansys/fluent/core/system_coupling.py +3 -1
- ansys/fluent/core/utils/__init__.py +0 -7
- ansys/fluent/core/utils/data_transfer.py +3 -3
- ansys/fluent/core/utils/file_transfer_service.py +24 -15
- ansys/fluent/core/utils/fluent_version.py +3 -3
- ansys/fluent/core/utils/networking.py +2 -2
- {ansys_fluent_core-0.34.1.dist-info → ansys_fluent_core-0.35.dev0.dist-info}/METADATA +1 -1
- {ansys_fluent_core-0.34.1.dist-info → ansys_fluent_core-0.35.dev0.dist-info}/RECORD +81 -80
- {ansys_fluent_core-0.34.1.dist-info → ansys_fluent_core-0.35.dev0.dist-info}/LICENSE +0 -0
- {ansys_fluent_core-0.34.1.dist-info → ansys_fluent_core-0.35.dev0.dist-info}/WHEEL +0 -0
|
@@ -178,14 +178,17 @@ class Root(PyMenu):
|
|
|
178
178
|
|
|
179
179
|
class add_labels_on_cell_zones(PyCommand):
|
|
180
180
|
"""
|
|
181
|
-
|
|
182
|
-
|
|
181
|
+
Add labels on the specified cell zones.
|
|
183
182
|
Parameters
|
|
184
183
|
----------
|
|
185
184
|
cell_zone_id_list : list[int]
|
|
185
|
+
List containing the cell zone IDs.
|
|
186
186
|
cell_zone_name_list : list[str]
|
|
187
|
+
List containing the cell zone names.
|
|
187
188
|
cell_zone_name_pattern : str
|
|
189
|
+
Cell zone name pattern.
|
|
188
190
|
label_name_list : list[str]
|
|
191
|
+
List containing the label names.
|
|
189
192
|
|
|
190
193
|
Returns
|
|
191
194
|
-------
|
|
@@ -232,14 +235,17 @@ class Root(PyMenu):
|
|
|
232
235
|
|
|
233
236
|
class add_labels_on_edge_zones(PyCommand):
|
|
234
237
|
"""
|
|
235
|
-
|
|
236
|
-
|
|
238
|
+
Add labels on the specified edge zones.
|
|
237
239
|
Parameters
|
|
238
240
|
----------
|
|
239
241
|
edge_zone_id_list : list[int]
|
|
242
|
+
List containing the edge zone IDs.
|
|
240
243
|
edge_zone_name_list : list[str]
|
|
244
|
+
List containing the edge zone names.
|
|
241
245
|
edge_zone_name_pattern : str
|
|
246
|
+
Edge zone name pattern.
|
|
242
247
|
label_name_list : list[str]
|
|
248
|
+
List containing the label names.
|
|
243
249
|
|
|
244
250
|
Returns
|
|
245
251
|
-------
|
|
@@ -286,14 +292,17 @@ class Root(PyMenu):
|
|
|
286
292
|
|
|
287
293
|
class add_labels_on_face_zones(PyCommand):
|
|
288
294
|
"""
|
|
289
|
-
|
|
290
|
-
|
|
295
|
+
Add labels on the specified face zones.
|
|
291
296
|
Parameters
|
|
292
297
|
----------
|
|
293
298
|
face_zone_id_list : list[int]
|
|
299
|
+
List containing the face zone IDs.
|
|
294
300
|
face_zone_name_list : list[str]
|
|
301
|
+
List containing the face zone names.
|
|
295
302
|
face_zone_name_pattern : str
|
|
303
|
+
Face zone name pattern.
|
|
296
304
|
label_name_list : list[str]
|
|
305
|
+
List containing the label names.
|
|
297
306
|
|
|
298
307
|
Returns
|
|
299
308
|
-------
|
|
@@ -340,8 +349,7 @@ class Root(PyMenu):
|
|
|
340
349
|
|
|
341
350
|
class clean_face_zone_names(PyCommand):
|
|
342
351
|
"""
|
|
343
|
-
|
|
344
|
-
|
|
352
|
+
Clean up face zone names by removing IDs wherever possible.
|
|
345
353
|
|
|
346
354
|
Returns
|
|
347
355
|
-------
|
|
@@ -362,8 +370,7 @@ class Root(PyMenu):
|
|
|
362
370
|
|
|
363
371
|
class delete_all_sub_domains(PyCommand):
|
|
364
372
|
"""
|
|
365
|
-
|
|
366
|
-
|
|
373
|
+
Deletes all sub-domains (all domains other than global).
|
|
367
374
|
|
|
368
375
|
Returns
|
|
369
376
|
-------
|
|
@@ -384,13 +391,15 @@ class Root(PyMenu):
|
|
|
384
391
|
|
|
385
392
|
class delete_empty_cell_zones(PyCommand):
|
|
386
393
|
"""
|
|
387
|
-
|
|
388
|
-
|
|
394
|
+
Delete empty cell zones.
|
|
389
395
|
Parameters
|
|
390
396
|
----------
|
|
391
397
|
cell_zone_id_list : list[int]
|
|
398
|
+
List containing the cell zone IDs.
|
|
392
399
|
cell_zone_name_list : list[str]
|
|
400
|
+
List containing the cell zone names.
|
|
393
401
|
cell_zone_name_pattern : str
|
|
402
|
+
Cell zone name pattern.
|
|
394
403
|
|
|
395
404
|
Returns
|
|
396
405
|
-------
|
|
@@ -431,13 +440,15 @@ class Root(PyMenu):
|
|
|
431
440
|
|
|
432
441
|
class delete_empty_edge_zones(PyCommand):
|
|
433
442
|
"""
|
|
434
|
-
|
|
435
|
-
|
|
443
|
+
Delete empty edge zones.
|
|
436
444
|
Parameters
|
|
437
445
|
----------
|
|
438
446
|
edge_zone_id_list : list[int]
|
|
447
|
+
List containing the edge zone IDs.
|
|
439
448
|
edge_zone_name_list : list[str]
|
|
449
|
+
List containing the edge zone names.
|
|
440
450
|
edge_zone_name_pattern : str
|
|
451
|
+
Edge zone name pattern.
|
|
441
452
|
|
|
442
453
|
Returns
|
|
443
454
|
-------
|
|
@@ -478,13 +489,15 @@ class Root(PyMenu):
|
|
|
478
489
|
|
|
479
490
|
class delete_empty_face_zones(PyCommand):
|
|
480
491
|
"""
|
|
481
|
-
|
|
482
|
-
|
|
492
|
+
Delete empty face zones.
|
|
483
493
|
Parameters
|
|
484
494
|
----------
|
|
485
495
|
face_zone_id_list : list[int]
|
|
496
|
+
List containing the face zone IDs.
|
|
486
497
|
face_zone_name_list : list[str]
|
|
498
|
+
List containing the face zone names.
|
|
487
499
|
face_zone_name_pattern : str
|
|
500
|
+
Face zone name pattern.
|
|
488
501
|
|
|
489
502
|
Returns
|
|
490
503
|
-------
|
|
@@ -525,13 +538,15 @@ class Root(PyMenu):
|
|
|
525
538
|
|
|
526
539
|
class delete_empty_zones(PyCommand):
|
|
527
540
|
"""
|
|
528
|
-
|
|
529
|
-
|
|
541
|
+
Delete empty zones based on the zones specified.
|
|
530
542
|
Parameters
|
|
531
543
|
----------
|
|
532
544
|
zone_id_list : list[int]
|
|
545
|
+
List containing the face or edge or cell or node zone IDs.
|
|
533
546
|
zone_name_list : list[str]
|
|
547
|
+
List containing the face or edge or cell or node zone names.
|
|
534
548
|
zone_name_pattern : str
|
|
549
|
+
Face or edge or cell or node zone name pattern.
|
|
535
550
|
|
|
536
551
|
Returns
|
|
537
552
|
-------
|
|
@@ -572,13 +587,15 @@ class Root(PyMenu):
|
|
|
572
587
|
|
|
573
588
|
class delete_marked_faces_in_zones(PyCommand):
|
|
574
589
|
"""
|
|
575
|
-
|
|
576
|
-
|
|
590
|
+
Delete marked faces.
|
|
577
591
|
Parameters
|
|
578
592
|
----------
|
|
579
593
|
face_zone_id_list : list[int]
|
|
594
|
+
List containing the face zone IDs.
|
|
580
595
|
face_zone_name_list : list[str]
|
|
596
|
+
List containing the face zone names.
|
|
581
597
|
face_zone_name_pattern : str
|
|
598
|
+
Face zone name pattern.
|
|
582
599
|
|
|
583
600
|
Returns
|
|
584
601
|
-------
|
|
@@ -619,13 +636,16 @@ class Root(PyMenu):
|
|
|
619
636
|
|
|
620
637
|
class merge_cell_zones(PyCommand):
|
|
621
638
|
"""
|
|
622
|
-
|
|
623
|
-
|
|
639
|
+
- Merges the specified cell zones.
|
|
640
|
+
- Specify a list of cell zones or name pattern.
|
|
624
641
|
Parameters
|
|
625
642
|
----------
|
|
626
643
|
cell_zone_id_list : list[int]
|
|
644
|
+
List containing the cell zone IDs.
|
|
627
645
|
cell_zone_name_list : list[str]
|
|
646
|
+
List containing the cell zone names.
|
|
628
647
|
cell_zone_name_pattern : str
|
|
648
|
+
Cell zone name pattern.
|
|
629
649
|
|
|
630
650
|
Returns
|
|
631
651
|
-------
|
|
@@ -666,11 +686,11 @@ class Root(PyMenu):
|
|
|
666
686
|
|
|
667
687
|
class merge_cell_zones_with_same_prefix(PyCommand):
|
|
668
688
|
"""
|
|
669
|
-
|
|
670
|
-
|
|
689
|
+
Merge cell zones containing the specified prefix.
|
|
671
690
|
Parameters
|
|
672
691
|
----------
|
|
673
692
|
prefix : str
|
|
693
|
+
Cell zone prefix.
|
|
674
694
|
|
|
675
695
|
Returns
|
|
676
696
|
-------
|
|
@@ -697,11 +717,11 @@ class Root(PyMenu):
|
|
|
697
717
|
|
|
698
718
|
class merge_cell_zones_with_same_suffix(PyCommand):
|
|
699
719
|
"""
|
|
700
|
-
|
|
701
|
-
|
|
720
|
+
Merge cell zones containing the specified suffix.
|
|
702
721
|
Parameters
|
|
703
722
|
----------
|
|
704
723
|
suffix : str
|
|
724
|
+
Cell zone suffix.
|
|
705
725
|
|
|
706
726
|
Returns
|
|
707
727
|
-------
|
|
@@ -728,12 +748,14 @@ class Root(PyMenu):
|
|
|
728
748
|
|
|
729
749
|
class merge_face_zones(PyCommand):
|
|
730
750
|
"""
|
|
731
|
-
|
|
732
|
-
|
|
751
|
+
- Merges the specified face zones.
|
|
752
|
+
- Specify a list of zone IDs or name pattern.
|
|
733
753
|
Parameters
|
|
734
754
|
----------
|
|
735
755
|
face_zone_id_list : list[int]
|
|
756
|
+
List containing the face zone IDs.
|
|
736
757
|
face_zone_name_pattern : str
|
|
758
|
+
Face zone name pattern.
|
|
737
759
|
|
|
738
760
|
Returns
|
|
739
761
|
-------
|
|
@@ -767,12 +789,13 @@ class Root(PyMenu):
|
|
|
767
789
|
|
|
768
790
|
class merge_face_zones_of_type(PyCommand):
|
|
769
791
|
"""
|
|
770
|
-
|
|
771
|
-
|
|
792
|
+
Merges face zones of a given type based on name pattern.
|
|
772
793
|
Parameters
|
|
773
794
|
----------
|
|
774
795
|
face_zone_type : str
|
|
796
|
+
Face zone type.
|
|
775
797
|
face_zone_name_pattern : str
|
|
798
|
+
Face zone name pattern.
|
|
776
799
|
|
|
777
800
|
Returns
|
|
778
801
|
-------
|
|
@@ -805,11 +828,11 @@ class Root(PyMenu):
|
|
|
805
828
|
|
|
806
829
|
class merge_face_zones_with_same_prefix(PyCommand):
|
|
807
830
|
"""
|
|
808
|
-
|
|
809
|
-
|
|
831
|
+
Merge face zones containing the specified prefix.
|
|
810
832
|
Parameters
|
|
811
833
|
----------
|
|
812
834
|
prefix : str
|
|
835
|
+
Face zone prefix.
|
|
813
836
|
|
|
814
837
|
Returns
|
|
815
838
|
-------
|
|
@@ -836,8 +859,7 @@ class Root(PyMenu):
|
|
|
836
859
|
|
|
837
860
|
class remove_id_suffix_from_face_zones(PyCommand):
|
|
838
861
|
"""
|
|
839
|
-
|
|
840
|
-
|
|
862
|
+
Removes the ID suffix from face zone names.
|
|
841
863
|
|
|
842
864
|
Returns
|
|
843
865
|
-------
|
|
@@ -858,11 +880,11 @@ class Root(PyMenu):
|
|
|
858
880
|
|
|
859
881
|
class remove_ids_from_zone_names(PyCommand):
|
|
860
882
|
"""
|
|
861
|
-
|
|
862
|
-
|
|
883
|
+
Remove the zone ID from zone ID list.
|
|
863
884
|
Parameters
|
|
864
885
|
----------
|
|
865
886
|
zone_id_list : list[int]
|
|
887
|
+
List containing the face or edge or cell or node zone IDs.
|
|
866
888
|
|
|
867
889
|
Returns
|
|
868
890
|
-------
|
|
@@ -889,14 +911,17 @@ class Root(PyMenu):
|
|
|
889
911
|
|
|
890
912
|
class remove_labels_on_cell_zones(PyCommand):
|
|
891
913
|
"""
|
|
892
|
-
|
|
893
|
-
|
|
914
|
+
Removes the specified labels from the cell zones.
|
|
894
915
|
Parameters
|
|
895
916
|
----------
|
|
896
917
|
cell_zone_id_list : list[int]
|
|
918
|
+
List containing the cell zone IDs.
|
|
897
919
|
cell_zone_name_list : list[str]
|
|
920
|
+
List containing the cell zone names.
|
|
898
921
|
cell_zone_name_pattern : str
|
|
922
|
+
Cell zone name pattern.
|
|
899
923
|
label_name_list : list[str]
|
|
924
|
+
List containing the label names.
|
|
900
925
|
|
|
901
926
|
Returns
|
|
902
927
|
-------
|
|
@@ -943,14 +968,17 @@ class Root(PyMenu):
|
|
|
943
968
|
|
|
944
969
|
class remove_labels_on_edge_zones(PyCommand):
|
|
945
970
|
"""
|
|
946
|
-
|
|
947
|
-
|
|
971
|
+
Removes the specified labels from the edge zones.
|
|
948
972
|
Parameters
|
|
949
973
|
----------
|
|
950
974
|
edge_zone_id_list : list[int]
|
|
975
|
+
List containing the edge zone IDs.
|
|
951
976
|
edge_zone_name_list : list[str]
|
|
977
|
+
List containing the edge zone names.
|
|
952
978
|
edge_zone_name_pattern : str
|
|
979
|
+
Edge zone name pattern.
|
|
953
980
|
label_name_list : list[str]
|
|
981
|
+
List containing the label names.
|
|
954
982
|
|
|
955
983
|
Returns
|
|
956
984
|
-------
|
|
@@ -997,14 +1025,17 @@ class Root(PyMenu):
|
|
|
997
1025
|
|
|
998
1026
|
class remove_labels_on_face_zones(PyCommand):
|
|
999
1027
|
"""
|
|
1000
|
-
|
|
1001
|
-
|
|
1028
|
+
Removes the specified labels from the face zones.
|
|
1002
1029
|
Parameters
|
|
1003
1030
|
----------
|
|
1004
1031
|
face_zone_id_list : list[int]
|
|
1032
|
+
List containing the face zone IDs.
|
|
1005
1033
|
face_zone_name_list : list[str]
|
|
1034
|
+
List containing the face zone names.
|
|
1006
1035
|
face_zone_name_pattern : str
|
|
1036
|
+
Face zone name pattern.
|
|
1007
1037
|
label_name_list : list[str]
|
|
1038
|
+
List containing the label names.
|
|
1008
1039
|
|
|
1009
1040
|
Returns
|
|
1010
1041
|
-------
|
|
@@ -1051,13 +1082,15 @@ class Root(PyMenu):
|
|
|
1051
1082
|
|
|
1052
1083
|
class rename_edge_zone(PyCommand):
|
|
1053
1084
|
"""
|
|
1054
|
-
|
|
1055
|
-
|
|
1085
|
+
Renames an existing edge zone.
|
|
1056
1086
|
Parameters
|
|
1057
1087
|
----------
|
|
1058
1088
|
zone_id : int
|
|
1089
|
+
Edge zone ID.
|
|
1059
1090
|
zone_name : str
|
|
1091
|
+
Edge zone name.
|
|
1060
1092
|
new_name : str
|
|
1093
|
+
New edge zone name.
|
|
1061
1094
|
|
|
1062
1095
|
Returns
|
|
1063
1096
|
-------
|
|
@@ -1096,13 +1129,15 @@ class Root(PyMenu):
|
|
|
1096
1129
|
|
|
1097
1130
|
class rename_face_zone(PyCommand):
|
|
1098
1131
|
"""
|
|
1099
|
-
|
|
1100
|
-
|
|
1132
|
+
Renames an existing face zone.
|
|
1101
1133
|
Parameters
|
|
1102
1134
|
----------
|
|
1103
1135
|
zone_id : int
|
|
1136
|
+
Face zone ID.
|
|
1104
1137
|
zone_name : str
|
|
1138
|
+
Face zone name.
|
|
1105
1139
|
new_name : str
|
|
1140
|
+
New face zone name.
|
|
1106
1141
|
|
|
1107
1142
|
Returns
|
|
1108
1143
|
-------
|
|
@@ -1143,13 +1178,15 @@ class Root(PyMenu):
|
|
|
1143
1178
|
|
|
1144
1179
|
class rename_face_zone_label(PyCommand):
|
|
1145
1180
|
"""
|
|
1146
|
-
|
|
1147
|
-
|
|
1181
|
+
Renames the face zone label.
|
|
1148
1182
|
Parameters
|
|
1149
1183
|
----------
|
|
1150
1184
|
object_name : str
|
|
1185
|
+
Mesh object name.
|
|
1151
1186
|
old_label_name : str
|
|
1187
|
+
Old label name.
|
|
1152
1188
|
new_label_name : str
|
|
1189
|
+
New label name.
|
|
1153
1190
|
|
|
1154
1191
|
Returns
|
|
1155
1192
|
-------
|
|
@@ -1188,12 +1225,13 @@ class Root(PyMenu):
|
|
|
1188
1225
|
|
|
1189
1226
|
class rename_object(PyCommand):
|
|
1190
1227
|
"""
|
|
1191
|
-
|
|
1192
|
-
|
|
1228
|
+
Renames the object.
|
|
1193
1229
|
Parameters
|
|
1194
1230
|
----------
|
|
1195
1231
|
old_object_name : str
|
|
1232
|
+
Old object name.
|
|
1196
1233
|
new_object_name : str
|
|
1234
|
+
New object name.
|
|
1197
1235
|
|
|
1198
1236
|
Returns
|
|
1199
1237
|
-------
|
|
@@ -1226,12 +1264,13 @@ class Root(PyMenu):
|
|
|
1226
1264
|
|
|
1227
1265
|
class renumber_zone_ids(PyCommand):
|
|
1228
1266
|
"""
|
|
1229
|
-
|
|
1230
|
-
|
|
1267
|
+
Renumber zone IDs starting from the number specified (start_number).
|
|
1231
1268
|
Parameters
|
|
1232
1269
|
----------
|
|
1233
1270
|
zone_id_list : list[int]
|
|
1271
|
+
List containing the face or edge or cell or node zone IDs.
|
|
1234
1272
|
start_number : int
|
|
1273
|
+
Start number.
|
|
1235
1274
|
|
|
1236
1275
|
Returns
|
|
1237
1276
|
-------
|
|
@@ -1264,15 +1303,20 @@ class Root(PyMenu):
|
|
|
1264
1303
|
|
|
1265
1304
|
class replace_cell_zone_suffix(PyCommand):
|
|
1266
1305
|
"""
|
|
1267
|
-
|
|
1268
|
-
|
|
1306
|
+
- Replace the cell zone suffix to rename cell zones.
|
|
1307
|
+
- Specify whether to merge the cell zones being renamed (set merge to True or False).
|
|
1269
1308
|
Parameters
|
|
1270
1309
|
----------
|
|
1271
1310
|
cell_zone_id_list : list[int]
|
|
1311
|
+
List containing the cell zone IDs.
|
|
1272
1312
|
cell_zone_name_list : list[str]
|
|
1313
|
+
List containing the cell zone names.
|
|
1273
1314
|
old_suffix : str
|
|
1315
|
+
Old cell zone name suffix.
|
|
1274
1316
|
new_suffix : str
|
|
1317
|
+
New cell zone name suffix.
|
|
1275
1318
|
merge : bool
|
|
1319
|
+
Specify whether to merge the cell zones being renamed.
|
|
1276
1320
|
|
|
1277
1321
|
Returns
|
|
1278
1322
|
-------
|
|
@@ -1324,15 +1368,20 @@ class Root(PyMenu):
|
|
|
1324
1368
|
|
|
1325
1369
|
class replace_edge_zone_suffix(PyCommand):
|
|
1326
1370
|
"""
|
|
1327
|
-
|
|
1328
|
-
|
|
1371
|
+
- Replace the edge zone suffix to rename edge zones.
|
|
1372
|
+
- Specify whether to merge the edge zones being renamed (set merge to True or False).
|
|
1329
1373
|
Parameters
|
|
1330
1374
|
----------
|
|
1331
1375
|
edge_zone_id_list : list[int]
|
|
1376
|
+
List containing the edge zone IDs.
|
|
1332
1377
|
edge_zone_name_list : list[str]
|
|
1378
|
+
List containing the edge zone names.
|
|
1333
1379
|
old_suffix : str
|
|
1380
|
+
Old edge zone name suffix.
|
|
1334
1381
|
new_suffix : str
|
|
1382
|
+
New edge zone name suffix.
|
|
1335
1383
|
merge : bool
|
|
1384
|
+
Specify whether to merge the edge zones being renamed.
|
|
1336
1385
|
|
|
1337
1386
|
Returns
|
|
1338
1387
|
-------
|
|
@@ -1384,15 +1433,21 @@ class Root(PyMenu):
|
|
|
1384
1433
|
|
|
1385
1434
|
class replace_face_zone_suffix(PyCommand):
|
|
1386
1435
|
"""
|
|
1387
|
-
|
|
1388
|
-
|
|
1436
|
+
- Replace the face zone suffix to rename face zones.
|
|
1437
|
+
- Specify whether to merge the face zones being renamed (set merge to True or False).
|
|
1438
|
+
- Note - If an empty string is specified for the separator (' '), the string specified for replace with will be appended to the face zone names.
|
|
1389
1439
|
Parameters
|
|
1390
1440
|
----------
|
|
1391
1441
|
face_zone_id_list : list[int]
|
|
1442
|
+
List containing the face zone IDs.
|
|
1392
1443
|
face_zone_name_list : list[str]
|
|
1444
|
+
List containing the face zone names.
|
|
1393
1445
|
separator : str
|
|
1446
|
+
Face zone name separator.
|
|
1394
1447
|
replace_with : str
|
|
1448
|
+
New face zone name suffix.
|
|
1395
1449
|
merge : bool
|
|
1450
|
+
Specify whether to merge the face zones being renamed.
|
|
1396
1451
|
|
|
1397
1452
|
Returns
|
|
1398
1453
|
-------
|
|
@@ -1444,13 +1499,15 @@ class Root(PyMenu):
|
|
|
1444
1499
|
|
|
1445
1500
|
class replace_label_suffix(PyCommand):
|
|
1446
1501
|
"""
|
|
1447
|
-
|
|
1448
|
-
|
|
1502
|
+
Rename labels by replacing the label suffix with a new suffix.
|
|
1449
1503
|
Parameters
|
|
1450
1504
|
----------
|
|
1451
1505
|
object_name_list : list[str]
|
|
1506
|
+
List containing the object names.
|
|
1452
1507
|
separator : str
|
|
1508
|
+
Label separator.
|
|
1453
1509
|
new_suffix : str
|
|
1510
|
+
New label suffix.
|
|
1454
1511
|
|
|
1455
1512
|
Returns
|
|
1456
1513
|
-------
|
|
@@ -1489,13 +1546,15 @@ class Root(PyMenu):
|
|
|
1489
1546
|
|
|
1490
1547
|
class replace_object_suffix(PyCommand):
|
|
1491
1548
|
"""
|
|
1492
|
-
|
|
1493
|
-
|
|
1549
|
+
Rename objects by replacing the object suffix with a new suffix.
|
|
1494
1550
|
Parameters
|
|
1495
1551
|
----------
|
|
1496
1552
|
object_name_list : list[str]
|
|
1553
|
+
List containing the object names.
|
|
1497
1554
|
separator : str
|
|
1555
|
+
Mesh object name separator.
|
|
1498
1556
|
new_suffix : str
|
|
1557
|
+
New object name suffix.
|
|
1499
1558
|
|
|
1500
1559
|
Returns
|
|
1501
1560
|
-------
|
|
@@ -1534,11 +1593,13 @@ class Root(PyMenu):
|
|
|
1534
1593
|
|
|
1535
1594
|
class set_number_of_parallel_compute_threads(PyCommand):
|
|
1536
1595
|
"""
|
|
1537
|
-
|
|
1538
|
-
|
|
1596
|
+
- Set the number of compute threads to use for algorithms like mesh check and quality computation.
|
|
1597
|
+
- You can use a variable number of compute threads for these algorithms depending on the current machine loads.
|
|
1598
|
+
- The number of compute threads is between 2 and the value (maximum-cores-available - 1).
|
|
1539
1599
|
Parameters
|
|
1540
1600
|
----------
|
|
1541
1601
|
nthreads : int
|
|
1602
|
+
Number of compute threads.
|
|
1542
1603
|
|
|
1543
1604
|
Returns
|
|
1544
1605
|
-------
|
|
@@ -1565,12 +1626,13 @@ class Root(PyMenu):
|
|
|
1565
1626
|
|
|
1566
1627
|
class set_object_cell_zone_type(PyCommand):
|
|
1567
1628
|
"""
|
|
1568
|
-
|
|
1569
|
-
|
|
1629
|
+
Set object cell zone type.
|
|
1570
1630
|
Parameters
|
|
1571
1631
|
----------
|
|
1572
1632
|
object_name : str
|
|
1633
|
+
Mesh object name.
|
|
1573
1634
|
cell_zone_type : str
|
|
1635
|
+
Cell zone type.
|
|
1574
1636
|
|
|
1575
1637
|
Returns
|
|
1576
1638
|
-------
|
|
@@ -1603,11 +1665,12 @@ class Root(PyMenu):
|
|
|
1603
1665
|
|
|
1604
1666
|
class set_quality_measure(PyCommand):
|
|
1605
1667
|
"""
|
|
1606
|
-
|
|
1607
|
-
|
|
1668
|
+
- Set the quality measure.
|
|
1669
|
+
- 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.
|
|
1608
1670
|
Parameters
|
|
1609
1671
|
----------
|
|
1610
1672
|
measure : str
|
|
1673
|
+
Quality measure.
|
|
1611
1674
|
|
|
1612
1675
|
Returns
|
|
1613
1676
|
-------
|
|
@@ -1634,8 +1697,7 @@ class Root(PyMenu):
|
|
|
1634
1697
|
|
|
1635
1698
|
class _cell_zones_labels_fdl(PyQuery):
|
|
1636
1699
|
"""
|
|
1637
|
-
|
|
1638
|
-
|
|
1700
|
+
Get a list containing the cell zone labels.
|
|
1639
1701
|
|
|
1640
1702
|
Returns
|
|
1641
1703
|
-------
|
|
@@ -1649,8 +1711,7 @@ class Root(PyMenu):
|
|
|
1649
1711
|
|
|
1650
1712
|
class _cell_zones_str_fdl(PyQuery):
|
|
1651
1713
|
"""
|
|
1652
|
-
|
|
1653
|
-
|
|
1714
|
+
Get a list containing the cell zone IDs.
|
|
1654
1715
|
|
|
1655
1716
|
Returns
|
|
1656
1717
|
-------
|
|
@@ -1664,8 +1725,7 @@ class Root(PyMenu):
|
|
|
1664
1725
|
|
|
1665
1726
|
class _edge_zones_labels_fdl(PyQuery):
|
|
1666
1727
|
"""
|
|
1667
|
-
|
|
1668
|
-
|
|
1728
|
+
Get a list containing the edge zone labels.
|
|
1669
1729
|
|
|
1670
1730
|
Returns
|
|
1671
1731
|
-------
|
|
@@ -1679,8 +1739,7 @@ class Root(PyMenu):
|
|
|
1679
1739
|
|
|
1680
1740
|
class _edge_zones_str_fdl(PyQuery):
|
|
1681
1741
|
"""
|
|
1682
|
-
|
|
1683
|
-
|
|
1742
|
+
Get a list containing the edge zone IDs.
|
|
1684
1743
|
|
|
1685
1744
|
Returns
|
|
1686
1745
|
-------
|
|
@@ -1694,8 +1753,7 @@ class Root(PyMenu):
|
|
|
1694
1753
|
|
|
1695
1754
|
class _face_zones_labels_fdl(PyQuery):
|
|
1696
1755
|
"""
|
|
1697
|
-
|
|
1698
|
-
|
|
1756
|
+
Get a list containing the face zone labels.
|
|
1699
1757
|
|
|
1700
1758
|
Returns
|
|
1701
1759
|
-------
|
|
@@ -1709,8 +1767,7 @@ class Root(PyMenu):
|
|
|
1709
1767
|
|
|
1710
1768
|
class _face_zones_str_fdl(PyQuery):
|
|
1711
1769
|
"""
|
|
1712
|
-
|
|
1713
|
-
|
|
1770
|
+
Get a list containing the face zone IDs.
|
|
1714
1771
|
|
|
1715
1772
|
Returns
|
|
1716
1773
|
-------
|
|
@@ -1724,8 +1781,7 @@ class Root(PyMenu):
|
|
|
1724
1781
|
|
|
1725
1782
|
class _node_zones_labels_fdl(PyQuery):
|
|
1726
1783
|
"""
|
|
1727
|
-
|
|
1728
|
-
|
|
1784
|
+
Get a list containing the node zone labels.
|
|
1729
1785
|
|
|
1730
1786
|
Returns
|
|
1731
1787
|
-------
|
|
@@ -1739,8 +1795,7 @@ class Root(PyMenu):
|
|
|
1739
1795
|
|
|
1740
1796
|
class _node_zones_str_fdl(PyQuery):
|
|
1741
1797
|
"""
|
|
1742
|
-
|
|
1743
|
-
|
|
1798
|
+
Get a list containing the node zone IDs.
|
|
1744
1799
|
|
|
1745
1800
|
Returns
|
|
1746
1801
|
-------
|
|
@@ -1754,8 +1809,7 @@ class Root(PyMenu):
|
|
|
1754
1809
|
|
|
1755
1810
|
class _object_names_str_fdl(PyQuery):
|
|
1756
1811
|
"""
|
|
1757
|
-
|
|
1758
|
-
|
|
1812
|
+
Get a list containing the object names.
|
|
1759
1813
|
|
|
1760
1814
|
Returns
|
|
1761
1815
|
-------
|
|
@@ -1769,8 +1823,7 @@ class Root(PyMenu):
|
|
|
1769
1823
|
|
|
1770
1824
|
class _prism_cell_zones_labels_fdl(PyQuery):
|
|
1771
1825
|
"""
|
|
1772
|
-
|
|
1773
|
-
|
|
1826
|
+
Get a list containing the prism cell zone labels.
|
|
1774
1827
|
|
|
1775
1828
|
Returns
|
|
1776
1829
|
-------
|
|
@@ -1784,8 +1837,7 @@ class Root(PyMenu):
|
|
|
1784
1837
|
|
|
1785
1838
|
class _prism_cell_zones_str_fdl(PyQuery):
|
|
1786
1839
|
"""
|
|
1787
|
-
|
|
1788
|
-
|
|
1840
|
+
Get a list containing the prism cell zone IDs.
|
|
1789
1841
|
|
|
1790
1842
|
Returns
|
|
1791
1843
|
-------
|
|
@@ -1799,8 +1851,7 @@ class Root(PyMenu):
|
|
|
1799
1851
|
|
|
1800
1852
|
class _regions_str_fdl(PyQuery):
|
|
1801
1853
|
"""
|
|
1802
|
-
|
|
1803
|
-
|
|
1854
|
+
Get a list containing the region names.
|
|
1804
1855
|
|
|
1805
1856
|
Returns
|
|
1806
1857
|
-------
|
|
@@ -1814,8 +1865,7 @@ class Root(PyMenu):
|
|
|
1814
1865
|
|
|
1815
1866
|
class _zone_types_fdl(PyQuery):
|
|
1816
1867
|
"""
|
|
1817
|
-
|
|
1818
|
-
|
|
1868
|
+
Get a list containing the zone type names.
|
|
1819
1869
|
|
|
1820
1870
|
Returns
|
|
1821
1871
|
-------
|
|
@@ -1829,12 +1879,13 @@ class Root(PyMenu):
|
|
|
1829
1879
|
|
|
1830
1880
|
class boundary_zone_exists(PyQuery):
|
|
1831
1881
|
"""
|
|
1832
|
-
|
|
1833
|
-
|
|
1882
|
+
Report if the boundary face zone exists.
|
|
1834
1883
|
Parameters
|
|
1835
1884
|
----------
|
|
1836
1885
|
zone_id : int
|
|
1886
|
+
Zone ID.
|
|
1837
1887
|
zone_name : str
|
|
1888
|
+
Zone name.
|
|
1838
1889
|
|
|
1839
1890
|
Returns
|
|
1840
1891
|
-------
|
|
@@ -1849,12 +1900,13 @@ class Root(PyMenu):
|
|
|
1849
1900
|
|
|
1850
1901
|
class cell_zone_exists(PyQuery):
|
|
1851
1902
|
"""
|
|
1852
|
-
|
|
1853
|
-
|
|
1903
|
+
Report if the volume mesh exists.
|
|
1854
1904
|
Parameters
|
|
1855
1905
|
----------
|
|
1856
1906
|
zone_id : int
|
|
1907
|
+
Cell zone ID.
|
|
1857
1908
|
zone_name : str
|
|
1909
|
+
Cell zone name.
|
|
1858
1910
|
|
|
1859
1911
|
Returns
|
|
1860
1912
|
-------
|
|
@@ -1869,11 +1921,11 @@ class Root(PyMenu):
|
|
|
1869
1921
|
|
|
1870
1922
|
class convert_zone_ids_to_name_strings(PyQuery):
|
|
1871
1923
|
"""
|
|
1872
|
-
|
|
1873
|
-
|
|
1924
|
+
Convert a list of IDs to a list of names.
|
|
1874
1925
|
Parameters
|
|
1875
1926
|
----------
|
|
1876
1927
|
zone_id_list : list[int]
|
|
1928
|
+
List containing the face or edge or cell or node zone IDs.
|
|
1877
1929
|
|
|
1878
1930
|
Returns
|
|
1879
1931
|
-------
|
|
@@ -1887,11 +1939,11 @@ class Root(PyMenu):
|
|
|
1887
1939
|
|
|
1888
1940
|
class convert_zone_name_strings_to_ids(PyQuery):
|
|
1889
1941
|
"""
|
|
1890
|
-
|
|
1891
|
-
|
|
1942
|
+
Convert a list of zone name strings to a list of IDs.
|
|
1892
1943
|
Parameters
|
|
1893
1944
|
----------
|
|
1894
1945
|
zone_name_list : list[str]
|
|
1946
|
+
List containing the face or edge or cell or node zone names.
|
|
1895
1947
|
|
|
1896
1948
|
Returns
|
|
1897
1949
|
-------
|
|
@@ -1905,14 +1957,18 @@ class Root(PyMenu):
|
|
|
1905
1957
|
|
|
1906
1958
|
class copy_face_zone_labels(PyQuery):
|
|
1907
1959
|
"""
|
|
1908
|
-
|
|
1909
|
-
|
|
1960
|
+
- Copy labels from one face zone to another.
|
|
1961
|
+
- Specify either face zone names or IDs.
|
|
1910
1962
|
Parameters
|
|
1911
1963
|
----------
|
|
1912
1964
|
from_face_zone_id : int
|
|
1965
|
+
Face zone ID.
|
|
1913
1966
|
from_face_zone_name : str
|
|
1967
|
+
Face zone name.
|
|
1914
1968
|
to_face_zone_id : int
|
|
1969
|
+
Face zone ID.
|
|
1915
1970
|
to_face_zone_name : str
|
|
1971
|
+
Face zone name.
|
|
1916
1972
|
|
|
1917
1973
|
Returns
|
|
1918
1974
|
-------
|
|
@@ -1926,13 +1982,15 @@ class Root(PyMenu):
|
|
|
1926
1982
|
|
|
1927
1983
|
class count_marked_faces(PyQuery):
|
|
1928
1984
|
"""
|
|
1929
|
-
|
|
1930
|
-
|
|
1985
|
+
Returns the count of marked faces for the face zones specified.
|
|
1931
1986
|
Parameters
|
|
1932
1987
|
----------
|
|
1933
1988
|
face_zone_id_list : list[int]
|
|
1989
|
+
List containing the face zone IDs.
|
|
1934
1990
|
face_zone_name_list : list[str]
|
|
1991
|
+
List containing the face zone names.
|
|
1935
1992
|
face_zone_name_pattern : str
|
|
1993
|
+
Face zone name pattern.
|
|
1936
1994
|
|
|
1937
1995
|
Returns
|
|
1938
1996
|
-------
|
|
@@ -1947,13 +2005,17 @@ class Root(PyMenu):
|
|
|
1947
2005
|
|
|
1948
2006
|
class create_boi_and_size_functions_from_refinement_regions(PyQuery):
|
|
1949
2007
|
"""
|
|
1950
|
-
|
|
1951
|
-
|
|
2008
|
+
- Create bodies of influence and if required body of influence size functions from the mesh refinement regions.
|
|
2009
|
+
- Specify the refinement region type (set 'region_type' to 'tet' or 'hexcore').
|
|
2010
|
+
- 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).
|
|
1952
2011
|
Parameters
|
|
1953
2012
|
----------
|
|
1954
2013
|
region_type : str
|
|
2014
|
+
Specify the refinement region type.
|
|
1955
2015
|
boi_prefix_string : str
|
|
2016
|
+
Specify the prefix for the BOI zones.
|
|
1956
2017
|
create_size_function : bool
|
|
2018
|
+
Specify whether to create the size functions.
|
|
1957
2019
|
|
|
1958
2020
|
Returns
|
|
1959
2021
|
-------
|
|
@@ -1967,11 +2029,11 @@ class Root(PyMenu):
|
|
|
1967
2029
|
|
|
1968
2030
|
class dump_face_zone_orientation_in_region(PyQuery):
|
|
1969
2031
|
"""
|
|
1970
|
-
|
|
1971
|
-
|
|
2032
|
+
Return the face zones and their orientation for the mesh file specified.
|
|
1972
2033
|
Parameters
|
|
1973
2034
|
----------
|
|
1974
2035
|
file_name : str
|
|
2036
|
+
Mesh file name.
|
|
1975
2037
|
|
|
1976
2038
|
Returns
|
|
1977
2039
|
-------
|
|
@@ -1985,14 +2047,17 @@ class Root(PyMenu):
|
|
|
1985
2047
|
|
|
1986
2048
|
class fill_holes_in_face_zone_list(PyQuery):
|
|
1987
2049
|
"""
|
|
1988
|
-
|
|
1989
|
-
|
|
2050
|
+
Fill holes associated with free edges for the face zones specified, based on the number of free edges (max_hole_edges).
|
|
1990
2051
|
Parameters
|
|
1991
2052
|
----------
|
|
1992
2053
|
face_zone_id_list : list[int]
|
|
2054
|
+
List containing the face zone IDs.
|
|
1993
2055
|
face_zone_name_list : list[str]
|
|
2056
|
+
List containing the face zone names.
|
|
1994
2057
|
face_zone_name_pattern : str
|
|
2058
|
+
Face zone name pattern.
|
|
1995
2059
|
max_hole_edges : int
|
|
2060
|
+
Number of maximum hole edges.
|
|
1996
2061
|
|
|
1997
2062
|
Returns
|
|
1998
2063
|
-------
|
|
@@ -2008,13 +2073,15 @@ class Root(PyMenu):
|
|
|
2008
2073
|
|
|
2009
2074
|
class get_adjacent_cell_zones_for_given_face_zones(PyQuery):
|
|
2010
2075
|
"""
|
|
2011
|
-
|
|
2012
|
-
|
|
2076
|
+
Return adjacent cell zones for given face zones.
|
|
2013
2077
|
Parameters
|
|
2014
2078
|
----------
|
|
2015
2079
|
face_zone_id_list : list[int]
|
|
2080
|
+
List containing the face zone IDs.
|
|
2016
2081
|
face_zone_name_list : list[str]
|
|
2082
|
+
List containing the face zone names.
|
|
2017
2083
|
face_zone_name_pattern : str
|
|
2084
|
+
Face zone name pattern.
|
|
2018
2085
|
|
|
2019
2086
|
Returns
|
|
2020
2087
|
-------
|
|
@@ -2030,13 +2097,15 @@ class Root(PyMenu):
|
|
|
2030
2097
|
|
|
2031
2098
|
class get_adjacent_face_zones_for_given_cell_zones(PyQuery):
|
|
2032
2099
|
"""
|
|
2033
|
-
|
|
2034
|
-
|
|
2100
|
+
Return adjacent boundary face zones for given cell zones.
|
|
2035
2101
|
Parameters
|
|
2036
2102
|
----------
|
|
2037
2103
|
cell_zone_id_list : list[int]
|
|
2104
|
+
List containing the cell zone IDs.
|
|
2038
2105
|
cell_zone_name_list : list[str]
|
|
2106
|
+
List containing the cell zone names.
|
|
2039
2107
|
cell_zone_name_pattern : str
|
|
2108
|
+
Cell zone name pattern.
|
|
2040
2109
|
|
|
2041
2110
|
Returns
|
|
2042
2111
|
-------
|
|
@@ -2052,13 +2121,15 @@ class Root(PyMenu):
|
|
|
2052
2121
|
|
|
2053
2122
|
class get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones(PyQuery):
|
|
2054
2123
|
"""
|
|
2055
|
-
|
|
2056
|
-
|
|
2124
|
+
Return adjacent interior and boundary face zones for given cell zones.
|
|
2057
2125
|
Parameters
|
|
2058
2126
|
----------
|
|
2059
2127
|
cell_zone_id_list : list[int]
|
|
2128
|
+
List containing the cell zone IDs.
|
|
2060
2129
|
cell_zone_name_list : list[str]
|
|
2130
|
+
List containing the cell zone names.
|
|
2061
2131
|
cell_zone_name_pattern : str
|
|
2132
|
+
Cell zone name pattern.
|
|
2062
2133
|
|
|
2063
2134
|
Returns
|
|
2064
2135
|
-------
|
|
@@ -2074,13 +2145,15 @@ class Root(PyMenu):
|
|
|
2074
2145
|
|
|
2075
2146
|
class get_adjacent_zones_by_edge_connectivity(PyQuery):
|
|
2076
2147
|
"""
|
|
2077
|
-
|
|
2078
|
-
|
|
2148
|
+
Return adjacent zones based on edge connectivity.
|
|
2079
2149
|
Parameters
|
|
2080
2150
|
----------
|
|
2081
2151
|
zone_id_list : list[int]
|
|
2152
|
+
List containing the face or edge or cell or node zone IDs.
|
|
2082
2153
|
zone_name_list : list[str]
|
|
2154
|
+
List containing the face or edge or cell or node zone names.
|
|
2083
2155
|
zone_name_pattern : str
|
|
2156
|
+
Face or edge or cell or node zone name pattern.
|
|
2084
2157
|
|
|
2085
2158
|
Returns
|
|
2086
2159
|
-------
|
|
@@ -2096,13 +2169,15 @@ class Root(PyMenu):
|
|
|
2096
2169
|
|
|
2097
2170
|
class get_adjacent_zones_by_node_connectivity(PyQuery):
|
|
2098
2171
|
"""
|
|
2099
|
-
|
|
2100
|
-
|
|
2172
|
+
Return adjacent zones based on node connectivity.
|
|
2101
2173
|
Parameters
|
|
2102
2174
|
----------
|
|
2103
2175
|
zone_id_list : list[int]
|
|
2176
|
+
List containing the face or edge or cell or node zone IDs.
|
|
2104
2177
|
zone_name_list : list[str]
|
|
2178
|
+
List containing the face or edge or cell or node zone names.
|
|
2105
2179
|
zone_name_pattern : str
|
|
2180
|
+
Face or edge or cell or node zone name pattern.
|
|
2106
2181
|
|
|
2107
2182
|
Returns
|
|
2108
2183
|
-------
|
|
@@ -2118,8 +2193,7 @@ class Root(PyMenu):
|
|
|
2118
2193
|
|
|
2119
2194
|
class get_all_objects(PyQuery):
|
|
2120
2195
|
"""
|
|
2121
|
-
|
|
2122
|
-
|
|
2196
|
+
Return a list of all objects.
|
|
2123
2197
|
|
|
2124
2198
|
Returns
|
|
2125
2199
|
-------
|
|
@@ -2133,11 +2207,11 @@ class Root(PyMenu):
|
|
|
2133
2207
|
|
|
2134
2208
|
class get_average_bounding_box_center(PyQuery):
|
|
2135
2209
|
"""
|
|
2136
|
-
|
|
2137
|
-
|
|
2210
|
+
Return a suitable average point based on the zones specified.
|
|
2138
2211
|
Parameters
|
|
2139
2212
|
----------
|
|
2140
2213
|
face_zone_id_list : list[int]
|
|
2214
|
+
List containing the face zone IDs.
|
|
2141
2215
|
|
|
2142
2216
|
Returns
|
|
2143
2217
|
-------
|
|
@@ -2151,11 +2225,11 @@ class Root(PyMenu):
|
|
|
2151
2225
|
|
|
2152
2226
|
class get_baffles_for_face_zones(PyQuery):
|
|
2153
2227
|
"""
|
|
2154
|
-
|
|
2155
|
-
|
|
2228
|
+
Return the baffle zones based on the face zone list specified.
|
|
2156
2229
|
Parameters
|
|
2157
2230
|
----------
|
|
2158
2231
|
face_zone_id_list : list[int]
|
|
2232
|
+
List containing the face zone IDs.
|
|
2159
2233
|
|
|
2160
2234
|
Returns
|
|
2161
2235
|
-------
|
|
@@ -2169,11 +2243,11 @@ class Root(PyMenu):
|
|
|
2169
2243
|
|
|
2170
2244
|
class get_bounding_box_of_zone_list(PyQuery):
|
|
2171
2245
|
"""
|
|
2172
|
-
|
|
2173
|
-
|
|
2246
|
+
Return the bounding box extents for the list of zones.
|
|
2174
2247
|
Parameters
|
|
2175
2248
|
----------
|
|
2176
2249
|
zone_id_list : list[int]
|
|
2250
|
+
List containing the face or edge or cell or node zone IDs.
|
|
2177
2251
|
|
|
2178
2252
|
Returns
|
|
2179
2253
|
-------
|
|
@@ -2187,16 +2261,22 @@ class Root(PyMenu):
|
|
|
2187
2261
|
|
|
2188
2262
|
class get_cell_mesh_distribution(PyQuery):
|
|
2189
2263
|
"""
|
|
2190
|
-
|
|
2191
|
-
|
|
2264
|
+
- Report the cell mesh distribution based on the specified measure, partitions, and range.
|
|
2265
|
+
- 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.
|
|
2192
2266
|
Parameters
|
|
2193
2267
|
----------
|
|
2194
2268
|
cell_zone_id_list : list[int]
|
|
2269
|
+
List containing the cell zone IDs.
|
|
2195
2270
|
cell_zone_name_list : list[str]
|
|
2271
|
+
List containing the cell zone names.
|
|
2196
2272
|
cell_zone_name_pattern : str
|
|
2273
|
+
Cell zone name pattern.
|
|
2197
2274
|
measure : str
|
|
2275
|
+
Measure.
|
|
2198
2276
|
partitions : int
|
|
2277
|
+
Partitions.
|
|
2199
2278
|
range : list[float]
|
|
2279
|
+
Range.
|
|
2200
2280
|
|
|
2201
2281
|
Returns
|
|
2202
2282
|
-------
|
|
@@ -2212,14 +2292,19 @@ class Root(PyMenu):
|
|
|
2212
2292
|
|
|
2213
2293
|
class get_cell_quality_limits(PyQuery):
|
|
2214
2294
|
"""
|
|
2215
|
-
|
|
2216
|
-
|
|
2295
|
+
- Report the number of cells and the cell quality limits (minimum, maximum, average quality) for the list of zones based on the measure specified.
|
|
2296
|
+
- You can also report the cell size limits.
|
|
2297
|
+
- 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.
|
|
2217
2298
|
Parameters
|
|
2218
2299
|
----------
|
|
2219
2300
|
cell_zone_id_list : list[int]
|
|
2301
|
+
List containing the cell zone IDs.
|
|
2220
2302
|
cell_zone_name_list : list[str]
|
|
2303
|
+
List containing the cell zone names.
|
|
2221
2304
|
cell_zone_name_pattern : str
|
|
2305
|
+
Cell zone name pattern.
|
|
2222
2306
|
measure : str
|
|
2307
|
+
Measure.
|
|
2223
2308
|
|
|
2224
2309
|
Returns
|
|
2225
2310
|
-------
|
|
@@ -2235,13 +2320,15 @@ class Root(PyMenu):
|
|
|
2235
2320
|
|
|
2236
2321
|
class get_cell_zone_count(PyQuery):
|
|
2237
2322
|
"""
|
|
2238
|
-
|
|
2239
|
-
|
|
2323
|
+
Return count of entities for cell zones.
|
|
2240
2324
|
Parameters
|
|
2241
2325
|
----------
|
|
2242
2326
|
cell_zone_id_list : list[int]
|
|
2327
|
+
List containing the cell zone IDs.
|
|
2243
2328
|
cell_zone_name_list : list[str]
|
|
2329
|
+
List containing the cell zone names.
|
|
2244
2330
|
cell_zone_name_pattern : str
|
|
2331
|
+
Cell zone name pattern.
|
|
2245
2332
|
|
|
2246
2333
|
Returns
|
|
2247
2334
|
-------
|
|
@@ -2257,14 +2344,17 @@ class Root(PyMenu):
|
|
|
2257
2344
|
|
|
2258
2345
|
class get_cell_zone_id_list_with_labels(PyQuery):
|
|
2259
2346
|
"""
|
|
2260
|
-
|
|
2261
|
-
|
|
2347
|
+
Returns the list of cell zones (by ID) containing the labels specified.
|
|
2262
2348
|
Parameters
|
|
2263
2349
|
----------
|
|
2264
2350
|
cell_zone_id_list : list[int]
|
|
2351
|
+
List containing the cell zone IDs.
|
|
2265
2352
|
cell_zone_name_list : list[str]
|
|
2353
|
+
List containing the cell zone names.
|
|
2266
2354
|
cell_zone_name_pattern : str
|
|
2355
|
+
Cell zone name pattern.
|
|
2267
2356
|
label_name_list : list[str]
|
|
2357
|
+
List containing the label names.
|
|
2268
2358
|
|
|
2269
2359
|
Returns
|
|
2270
2360
|
-------
|
|
@@ -2280,11 +2370,11 @@ class Root(PyMenu):
|
|
|
2280
2370
|
|
|
2281
2371
|
class get_cell_zone_shape(PyQuery):
|
|
2282
2372
|
"""
|
|
2283
|
-
|
|
2284
|
-
|
|
2373
|
+
Return cell zone shape as string.
|
|
2285
2374
|
Parameters
|
|
2286
2375
|
----------
|
|
2287
2376
|
cell_zone_id : int
|
|
2377
|
+
Cell zone ID.
|
|
2288
2378
|
|
|
2289
2379
|
Returns
|
|
2290
2380
|
-------
|
|
@@ -2298,13 +2388,15 @@ class Root(PyMenu):
|
|
|
2298
2388
|
|
|
2299
2389
|
class get_cell_zone_volume(PyQuery):
|
|
2300
2390
|
"""
|
|
2301
|
-
|
|
2302
|
-
|
|
2391
|
+
Return cell zone volume for the specified zones.
|
|
2303
2392
|
Parameters
|
|
2304
2393
|
----------
|
|
2305
2394
|
cell_zone_id_list : list[int]
|
|
2395
|
+
List containing the cell zone IDs.
|
|
2306
2396
|
cell_zone_name_list : list[str]
|
|
2397
|
+
List containing the cell zone names.
|
|
2307
2398
|
cell_zone_name_pattern : str
|
|
2399
|
+
Cell zone name pattern.
|
|
2308
2400
|
|
|
2309
2401
|
Returns
|
|
2310
2402
|
-------
|
|
@@ -2320,13 +2412,19 @@ class Root(PyMenu):
|
|
|
2320
2412
|
|
|
2321
2413
|
class get_cell_zones(PyQuery):
|
|
2322
2414
|
"""
|
|
2323
|
-
|
|
2324
|
-
|
|
2415
|
+
- Get cell zones using 1 - maximum_entity_count and only_boundary or 2 - xyz_coordinates or 3 - filter.
|
|
2416
|
+
- Return a list of cell zones at or closest to a specified location (xyz_coordinates).
|
|
2417
|
+
- Return a list of cell zones with a count below the maximum entity count (maximum_entity_count) specified.
|
|
2418
|
+
- You can choose to restrict the report to only boundary cell zones, if required (only_boundary set to True or False).
|
|
2419
|
+
- Return a list of zones whose names contain the specified filter string.
|
|
2325
2420
|
Parameters
|
|
2326
2421
|
----------
|
|
2327
2422
|
maximum_entity_count : float
|
|
2423
|
+
Maximum entity count.
|
|
2328
2424
|
xyz_coordinates : list[float]
|
|
2425
|
+
X-Y-Z coordinates.
|
|
2329
2426
|
filter : str
|
|
2427
|
+
Cell zone name filter.
|
|
2330
2428
|
|
|
2331
2429
|
Returns
|
|
2332
2430
|
-------
|
|
@@ -2342,13 +2440,15 @@ class Root(PyMenu):
|
|
|
2342
2440
|
|
|
2343
2441
|
class get_edge_size_limits(PyQuery):
|
|
2344
2442
|
"""
|
|
2345
|
-
|
|
2346
|
-
|
|
2443
|
+
Report the edge size limits for the list of face zones.
|
|
2347
2444
|
Parameters
|
|
2348
2445
|
----------
|
|
2349
2446
|
face_zone_id_list : list[int]
|
|
2447
|
+
List containing the face zone IDs.
|
|
2350
2448
|
face_zone_name_list : list[str]
|
|
2449
|
+
List containing the face zone names.
|
|
2351
2450
|
face_zone_name_pattern : str
|
|
2451
|
+
Face zone name pattern.
|
|
2352
2452
|
|
|
2353
2453
|
Returns
|
|
2354
2454
|
-------
|
|
@@ -2364,14 +2464,17 @@ class Root(PyMenu):
|
|
|
2364
2464
|
|
|
2365
2465
|
class get_edge_zone_id_list_with_labels(PyQuery):
|
|
2366
2466
|
"""
|
|
2367
|
-
|
|
2368
|
-
|
|
2467
|
+
Returns the list of edge zones (by ID) containing the labels specified.
|
|
2369
2468
|
Parameters
|
|
2370
2469
|
----------
|
|
2371
2470
|
edge_zone_id_list : list[int]
|
|
2471
|
+
List containing the edge zone IDs.
|
|
2372
2472
|
edge_zone_name_list : list[str]
|
|
2473
|
+
List containing the edge zone names.
|
|
2373
2474
|
edge_zone_name_pattern : str
|
|
2475
|
+
Edge zone name pattern.
|
|
2374
2476
|
label_name_list : list[str]
|
|
2477
|
+
List containing the label names.
|
|
2375
2478
|
|
|
2376
2479
|
Returns
|
|
2377
2480
|
-------
|
|
@@ -2387,13 +2490,17 @@ class Root(PyMenu):
|
|
|
2387
2490
|
|
|
2388
2491
|
class get_edge_zones(PyQuery):
|
|
2389
2492
|
"""
|
|
2390
|
-
|
|
2391
|
-
|
|
2493
|
+
- 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.
|
|
2494
|
+
- You can choose to restrict the report to only boundary edge zones, if required (only_boundary set to True or False).
|
|
2495
|
+
- Return a list of zones whose names contain the specified filter string.
|
|
2392
2496
|
Parameters
|
|
2393
2497
|
----------
|
|
2394
2498
|
maximum_entity_count : float
|
|
2499
|
+
Maximum entity count.
|
|
2395
2500
|
only_boundary : bool
|
|
2501
|
+
Specify whether to restrict the report to only boundary edge zones.
|
|
2396
2502
|
filter : str
|
|
2503
|
+
Edge zone name filter.
|
|
2397
2504
|
|
|
2398
2505
|
Returns
|
|
2399
2506
|
-------
|
|
@@ -2408,11 +2515,11 @@ class Root(PyMenu):
|
|
|
2408
2515
|
|
|
2409
2516
|
class get_edge_zones_list(PyQuery):
|
|
2410
2517
|
"""
|
|
2411
|
-
|
|
2412
|
-
|
|
2518
|
+
Return a list of edge zones whose names contain the specified filter string.
|
|
2413
2519
|
Parameters
|
|
2414
2520
|
----------
|
|
2415
2521
|
filter : list[str]
|
|
2522
|
+
Edge zone name filter.
|
|
2416
2523
|
|
|
2417
2524
|
Returns
|
|
2418
2525
|
-------
|
|
@@ -2426,12 +2533,13 @@ class Root(PyMenu):
|
|
|
2426
2533
|
|
|
2427
2534
|
class get_edge_zones_of_object(PyQuery):
|
|
2428
2535
|
"""
|
|
2429
|
-
|
|
2430
|
-
|
|
2536
|
+
Return a list of edge zones in the specified object or objects.
|
|
2431
2537
|
Parameters
|
|
2432
2538
|
----------
|
|
2433
2539
|
objects : list[str]
|
|
2540
|
+
List containing the object names list.
|
|
2434
2541
|
object_name : str
|
|
2542
|
+
Mesh object name.
|
|
2435
2543
|
|
|
2436
2544
|
Returns
|
|
2437
2545
|
-------
|
|
@@ -2446,8 +2554,7 @@ class Root(PyMenu):
|
|
|
2446
2554
|
|
|
2447
2555
|
class get_embedded_baffles(PyQuery):
|
|
2448
2556
|
"""
|
|
2449
|
-
|
|
2450
|
-
|
|
2557
|
+
Return the embedded baffle zones.
|
|
2451
2558
|
|
|
2452
2559
|
Returns
|
|
2453
2560
|
-------
|
|
@@ -2461,16 +2568,22 @@ class Root(PyMenu):
|
|
|
2461
2568
|
|
|
2462
2569
|
class get_face_mesh_distribution(PyQuery):
|
|
2463
2570
|
"""
|
|
2464
|
-
|
|
2465
|
-
|
|
2571
|
+
- Report the face mesh distribution based on the specified measure, partitions, and range.
|
|
2572
|
+
- 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.
|
|
2466
2573
|
Parameters
|
|
2467
2574
|
----------
|
|
2468
2575
|
face_zone_id_list : list[int]
|
|
2576
|
+
List containing the face zone IDs.
|
|
2469
2577
|
face_zone_name_list : list[str]
|
|
2578
|
+
List containing the face zone names.
|
|
2470
2579
|
face_zone_name_pattern : str
|
|
2580
|
+
Face zone name pattern.
|
|
2471
2581
|
measure : str
|
|
2582
|
+
Measure.
|
|
2472
2583
|
partitions : int
|
|
2584
|
+
Partitions.
|
|
2473
2585
|
range : list[float]
|
|
2586
|
+
Range.
|
|
2474
2587
|
|
|
2475
2588
|
Returns
|
|
2476
2589
|
-------
|
|
@@ -2486,14 +2599,19 @@ class Root(PyMenu):
|
|
|
2486
2599
|
|
|
2487
2600
|
class get_face_quality_limits(PyQuery):
|
|
2488
2601
|
"""
|
|
2489
|
-
|
|
2490
|
-
|
|
2602
|
+
- Report the number of faces and the face quality limits (minimum, maximum, average quality) for the list of zones based on the measure specified.
|
|
2603
|
+
- You can also report the face size limits.
|
|
2604
|
+
- 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.
|
|
2491
2605
|
Parameters
|
|
2492
2606
|
----------
|
|
2493
2607
|
face_zone_id_list : list[int]
|
|
2608
|
+
List containing the face zone IDs.
|
|
2494
2609
|
face_zone_name_list : list[str]
|
|
2610
|
+
List containing the face zone names.
|
|
2495
2611
|
face_zone_name_pattern : str
|
|
2612
|
+
Face zone name pattern.
|
|
2496
2613
|
measure : str
|
|
2614
|
+
Measure.
|
|
2497
2615
|
|
|
2498
2616
|
Returns
|
|
2499
2617
|
-------
|
|
@@ -2509,13 +2627,15 @@ class Root(PyMenu):
|
|
|
2509
2627
|
|
|
2510
2628
|
class get_face_zone_area(PyQuery):
|
|
2511
2629
|
"""
|
|
2512
|
-
|
|
2513
|
-
|
|
2630
|
+
Return face zone area for the specified zones.
|
|
2514
2631
|
Parameters
|
|
2515
2632
|
----------
|
|
2516
2633
|
face_zone_id_list : list[int]
|
|
2634
|
+
List containing the face zone IDs.
|
|
2517
2635
|
face_zone_name_list : list[str]
|
|
2636
|
+
List containing the face zone names.
|
|
2518
2637
|
face_zone_name_pattern : str
|
|
2638
|
+
Face zone name pattern.
|
|
2519
2639
|
|
|
2520
2640
|
Returns
|
|
2521
2641
|
-------
|
|
@@ -2531,13 +2651,15 @@ class Root(PyMenu):
|
|
|
2531
2651
|
|
|
2532
2652
|
class get_face_zone_count(PyQuery):
|
|
2533
2653
|
"""
|
|
2534
|
-
|
|
2535
|
-
|
|
2654
|
+
Return count of entities for face zones.
|
|
2536
2655
|
Parameters
|
|
2537
2656
|
----------
|
|
2538
2657
|
face_zone_id_list : list[int]
|
|
2658
|
+
List containing the face zone IDs.
|
|
2539
2659
|
face_zone_name_list : list[str]
|
|
2660
|
+
List containing the face zone names.
|
|
2540
2661
|
face_zone_name_pattern : str
|
|
2662
|
+
Face zone name pattern.
|
|
2541
2663
|
|
|
2542
2664
|
Returns
|
|
2543
2665
|
-------
|
|
@@ -2553,14 +2675,17 @@ class Root(PyMenu):
|
|
|
2553
2675
|
|
|
2554
2676
|
class get_face_zone_id_list_with_labels(PyQuery):
|
|
2555
2677
|
"""
|
|
2556
|
-
|
|
2557
|
-
|
|
2678
|
+
Returns the list of face zones (by ID) containing the labels specified.
|
|
2558
2679
|
Parameters
|
|
2559
2680
|
----------
|
|
2560
2681
|
face_zone_id_list : list[int]
|
|
2682
|
+
List containing the face zone IDs.
|
|
2561
2683
|
face_zone_name_list : list[str]
|
|
2684
|
+
List containing the face zone names.
|
|
2562
2685
|
face_zone_name_pattern : str
|
|
2686
|
+
Face zone name pattern.
|
|
2563
2687
|
label_name_list : list[str]
|
|
2688
|
+
List containing the label names.
|
|
2564
2689
|
|
|
2565
2690
|
Returns
|
|
2566
2691
|
-------
|
|
@@ -2576,12 +2701,13 @@ class Root(PyMenu):
|
|
|
2576
2701
|
|
|
2577
2702
|
class get_face_zone_node_count(PyQuery):
|
|
2578
2703
|
"""
|
|
2579
|
-
|
|
2580
|
-
|
|
2704
|
+
Returns the node count for the specified face zone.
|
|
2581
2705
|
Parameters
|
|
2582
2706
|
----------
|
|
2583
2707
|
face_zone_id : int
|
|
2708
|
+
Face zone ID.
|
|
2584
2709
|
face_zone_name : str
|
|
2710
|
+
Face zone name.
|
|
2585
2711
|
|
|
2586
2712
|
Returns
|
|
2587
2713
|
-------
|
|
@@ -2596,15 +2722,24 @@ class Root(PyMenu):
|
|
|
2596
2722
|
|
|
2597
2723
|
class get_face_zones(PyQuery):
|
|
2598
2724
|
"""
|
|
2599
|
-
|
|
2600
|
-
|
|
2725
|
+
- Get face zones using 1 - maximum_entity_count and only_boundary or 2 - prism_control_name or 3 - xyz_coordinates or 4 - filter.
|
|
2726
|
+
- Return a list of face zones at or closest to a specified location (xyz_coordinates - not applicable to polyhedra mesh).
|
|
2727
|
+
- Return a list of face zones with a count below the maximum entity count (maximum_entity_count) specified.
|
|
2728
|
+
- You can choose to restrict the report to only boundary face zones, if required (only_boundary set to True or False).
|
|
2729
|
+
- Return a list of face zones to which the specified prism controls apply.
|
|
2730
|
+
- Return a list of zones whose names contain the specified filter string.
|
|
2601
2731
|
Parameters
|
|
2602
2732
|
----------
|
|
2603
2733
|
maximum_entity_count : float
|
|
2734
|
+
Maximum entity count.
|
|
2604
2735
|
only_boundary : bool
|
|
2736
|
+
Specify whether to restrict the report to only boundary face zones.
|
|
2605
2737
|
prism_control_name : str
|
|
2738
|
+
Prism control name.
|
|
2606
2739
|
xyz_coordinates : list[float]
|
|
2740
|
+
X-Y-Z coordinates.
|
|
2607
2741
|
filter : str
|
|
2742
|
+
Face zone name filter.
|
|
2608
2743
|
|
|
2609
2744
|
Returns
|
|
2610
2745
|
-------
|
|
@@ -2621,12 +2756,14 @@ class Root(PyMenu):
|
|
|
2621
2756
|
|
|
2622
2757
|
class get_face_zones_by_zone_area(PyQuery):
|
|
2623
2758
|
"""
|
|
2624
|
-
|
|
2625
|
-
|
|
2759
|
+
- Return a list of face zones with a maximum zone area below the maximum_zone_area specified.
|
|
2760
|
+
- Return a list of face zones with a minimum zone area above the minimum_zone_area specified.
|
|
2626
2761
|
Parameters
|
|
2627
2762
|
----------
|
|
2628
2763
|
maximum_zone_area : float
|
|
2764
|
+
Maximum zone area.
|
|
2629
2765
|
minimum_zone_area : float
|
|
2766
|
+
Minimum zone area.
|
|
2630
2767
|
|
|
2631
2768
|
Returns
|
|
2632
2769
|
-------
|
|
@@ -2641,15 +2778,20 @@ class Root(PyMenu):
|
|
|
2641
2778
|
|
|
2642
2779
|
class get_face_zones_of_object(PyQuery):
|
|
2643
2780
|
"""
|
|
2644
|
-
|
|
2645
|
-
|
|
2781
|
+
- 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.
|
|
2782
|
+
- where region_type is one of the 'fluid-fluid', 'solid-solid', or 'fluid-solid' value.
|
|
2646
2783
|
Parameters
|
|
2647
2784
|
----------
|
|
2648
2785
|
regions : list[str]
|
|
2786
|
+
List containing the region names.
|
|
2649
2787
|
labels : list[str]
|
|
2788
|
+
List containing the face zone labels.
|
|
2650
2789
|
region_type : str
|
|
2790
|
+
Region type.
|
|
2651
2791
|
objects : list[str]
|
|
2792
|
+
List containing the object names.
|
|
2652
2793
|
object_name : str
|
|
2794
|
+
Mesh object name.
|
|
2653
2795
|
|
|
2654
2796
|
Returns
|
|
2655
2797
|
-------
|
|
@@ -2667,8 +2809,7 @@ class Root(PyMenu):
|
|
|
2667
2809
|
|
|
2668
2810
|
class get_face_zones_with_zone_specific_prisms_applied(PyQuery):
|
|
2669
2811
|
"""
|
|
2670
|
-
|
|
2671
|
-
|
|
2812
|
+
Return a list of face zones with zone-specific prism settings applied.
|
|
2672
2813
|
|
|
2673
2814
|
Returns
|
|
2674
2815
|
-------
|
|
@@ -2682,13 +2823,15 @@ class Root(PyMenu):
|
|
|
2682
2823
|
|
|
2683
2824
|
class get_free_faces_count(PyQuery):
|
|
2684
2825
|
"""
|
|
2685
|
-
|
|
2686
|
-
|
|
2826
|
+
Returns the count of free faces for the face zones specified.
|
|
2687
2827
|
Parameters
|
|
2688
2828
|
----------
|
|
2689
2829
|
face_zone_id_list : list[int]
|
|
2830
|
+
List containing the face zone IDs.
|
|
2690
2831
|
face_zone_name_list : list[str]
|
|
2832
|
+
List containing the face zone names.
|
|
2691
2833
|
face_zone_name_pattern : str
|
|
2834
|
+
Face zone name pattern.
|
|
2692
2835
|
|
|
2693
2836
|
Returns
|
|
2694
2837
|
-------
|
|
@@ -2704,13 +2847,15 @@ class Root(PyMenu):
|
|
|
2704
2847
|
|
|
2705
2848
|
class get_interior_face_zones_for_given_cell_zones(PyQuery):
|
|
2706
2849
|
"""
|
|
2707
|
-
|
|
2708
|
-
|
|
2850
|
+
Returns interior face zones connected to given cell zones.
|
|
2709
2851
|
Parameters
|
|
2710
2852
|
----------
|
|
2711
2853
|
cell_zone_id_list : list[int]
|
|
2854
|
+
List containing the cell zone IDs.
|
|
2712
2855
|
cell_zone_name_list : list[str]
|
|
2856
|
+
List containing the cell zone names.
|
|
2713
2857
|
cell_zone_name_pattern : str
|
|
2858
|
+
Cell zone name pattern.
|
|
2714
2859
|
|
|
2715
2860
|
Returns
|
|
2716
2861
|
-------
|
|
@@ -2726,13 +2871,15 @@ class Root(PyMenu):
|
|
|
2726
2871
|
|
|
2727
2872
|
class get_labels(PyQuery):
|
|
2728
2873
|
"""
|
|
2729
|
-
|
|
2730
|
-
|
|
2874
|
+
Return a list of face zone labels in the specified object, whose names contain the specified filter or pattern string.
|
|
2731
2875
|
Parameters
|
|
2732
2876
|
----------
|
|
2733
2877
|
object_name : str
|
|
2878
|
+
Mesh object name.
|
|
2734
2879
|
filter : str
|
|
2880
|
+
Label name filter.
|
|
2735
2881
|
label_name_pattern : str
|
|
2882
|
+
Label name pattern.
|
|
2736
2883
|
|
|
2737
2884
|
Returns
|
|
2738
2885
|
-------
|
|
@@ -2748,13 +2895,15 @@ class Root(PyMenu):
|
|
|
2748
2895
|
|
|
2749
2896
|
class get_labels_on_cell_zones(PyQuery):
|
|
2750
2897
|
"""
|
|
2751
|
-
|
|
2752
|
-
|
|
2898
|
+
Returns the list of labels for the specified cell zones.
|
|
2753
2899
|
Parameters
|
|
2754
2900
|
----------
|
|
2755
2901
|
cell_zone_id_list : list[int]
|
|
2902
|
+
List containing the cell zone IDs.
|
|
2756
2903
|
cell_zone_name_list : list[str]
|
|
2904
|
+
List containing the cell zone names.
|
|
2757
2905
|
cell_zone_name_pattern : str
|
|
2906
|
+
Cell zone name pattern.
|
|
2758
2907
|
|
|
2759
2908
|
Returns
|
|
2760
2909
|
-------
|
|
@@ -2770,13 +2919,15 @@ class Root(PyMenu):
|
|
|
2770
2919
|
|
|
2771
2920
|
class get_labels_on_edge_zones(PyQuery):
|
|
2772
2921
|
"""
|
|
2773
|
-
|
|
2774
|
-
|
|
2922
|
+
Returns the list of labels for the specified edge zones.
|
|
2775
2923
|
Parameters
|
|
2776
2924
|
----------
|
|
2777
2925
|
edge_zone_id_list : list[int]
|
|
2926
|
+
List containing the edge zone IDs.
|
|
2778
2927
|
edge_zone_name_list : list[str]
|
|
2928
|
+
List containing the edge zone names.
|
|
2779
2929
|
edge_zone_name_pattern : str
|
|
2930
|
+
Edge zone name pattern.
|
|
2780
2931
|
|
|
2781
2932
|
Returns
|
|
2782
2933
|
-------
|
|
@@ -2792,13 +2943,15 @@ class Root(PyMenu):
|
|
|
2792
2943
|
|
|
2793
2944
|
class get_labels_on_face_zones(PyQuery):
|
|
2794
2945
|
"""
|
|
2795
|
-
|
|
2796
|
-
|
|
2946
|
+
Returns the list of labels for the specified face zones.
|
|
2797
2947
|
Parameters
|
|
2798
2948
|
----------
|
|
2799
2949
|
face_zone_id_list : list[int]
|
|
2950
|
+
List containing the face zone IDs.
|
|
2800
2951
|
face_zone_name_list : list[str]
|
|
2952
|
+
List containing the face zone names.
|
|
2801
2953
|
face_zone_name_pattern : str
|
|
2954
|
+
Face zone name pattern.
|
|
2802
2955
|
|
|
2803
2956
|
Returns
|
|
2804
2957
|
-------
|
|
@@ -2814,11 +2967,11 @@ class Root(PyMenu):
|
|
|
2814
2967
|
|
|
2815
2968
|
class get_labels_on_face_zones_list(PyQuery):
|
|
2816
2969
|
"""
|
|
2817
|
-
|
|
2818
|
-
|
|
2970
|
+
Returns the list of labels for the specified face zones.
|
|
2819
2971
|
Parameters
|
|
2820
2972
|
----------
|
|
2821
2973
|
face_zone_id_list : list[int]
|
|
2974
|
+
List containing the face zone IDs.
|
|
2822
2975
|
|
|
2823
2976
|
Returns
|
|
2824
2977
|
-------
|
|
@@ -2832,13 +2985,15 @@ class Root(PyMenu):
|
|
|
2832
2985
|
|
|
2833
2986
|
class get_maxsize_cell_zone_by_count(PyQuery):
|
|
2834
2987
|
"""
|
|
2835
|
-
|
|
2836
|
-
|
|
2988
|
+
Return cell zone with maximum count of elements for given list or pattern of cell zones.
|
|
2837
2989
|
Parameters
|
|
2838
2990
|
----------
|
|
2839
2991
|
zone_id_list : list[int]
|
|
2992
|
+
List containing the cell zone IDs.
|
|
2840
2993
|
zone_name_list : list[str]
|
|
2994
|
+
List containing the cell zone names.
|
|
2841
2995
|
zone_name_pattern : str
|
|
2996
|
+
Cell zone name pattern.
|
|
2842
2997
|
|
|
2843
2998
|
Returns
|
|
2844
2999
|
-------
|
|
@@ -2854,13 +3009,15 @@ class Root(PyMenu):
|
|
|
2854
3009
|
|
|
2855
3010
|
class get_maxsize_cell_zone_by_volume(PyQuery):
|
|
2856
3011
|
"""
|
|
2857
|
-
|
|
2858
|
-
|
|
3012
|
+
Return cell zone with maximum volume for given list or pattern of cell zones.
|
|
2859
3013
|
Parameters
|
|
2860
3014
|
----------
|
|
2861
3015
|
zone_id_list : list[int]
|
|
3016
|
+
List containing the cell zone IDs.
|
|
2862
3017
|
zone_name_list : list[str]
|
|
3018
|
+
List containing the cell zone names.
|
|
2863
3019
|
zone_name_pattern : str
|
|
3020
|
+
Cell zone name pattern.
|
|
2864
3021
|
|
|
2865
3022
|
Returns
|
|
2866
3023
|
-------
|
|
@@ -2876,13 +3033,15 @@ class Root(PyMenu):
|
|
|
2876
3033
|
|
|
2877
3034
|
class get_minsize_face_zone_by_area(PyQuery):
|
|
2878
3035
|
"""
|
|
2879
|
-
|
|
2880
|
-
|
|
3036
|
+
Return face zone with minimum area for given list or pattern of face zones.
|
|
2881
3037
|
Parameters
|
|
2882
3038
|
----------
|
|
2883
3039
|
zone_id_list : list[int]
|
|
3040
|
+
List containing the face zone IDs.
|
|
2884
3041
|
zone_name_list : list[str]
|
|
3042
|
+
List containing the face zone names.
|
|
2885
3043
|
zone_name_pattern : str
|
|
3044
|
+
Face zone name pattern.
|
|
2886
3045
|
|
|
2887
3046
|
Returns
|
|
2888
3047
|
-------
|
|
@@ -2898,13 +3057,15 @@ class Root(PyMenu):
|
|
|
2898
3057
|
|
|
2899
3058
|
class get_minsize_face_zone_by_count(PyQuery):
|
|
2900
3059
|
"""
|
|
2901
|
-
|
|
2902
|
-
|
|
3060
|
+
Return face zone with minimum count of elements for given list or pattern of face zones.
|
|
2903
3061
|
Parameters
|
|
2904
3062
|
----------
|
|
2905
3063
|
zone_id_list : list[int]
|
|
3064
|
+
List containing the face zone IDs.
|
|
2906
3065
|
zone_name_list : list[str]
|
|
3066
|
+
List containing the face zone names.
|
|
2907
3067
|
zone_name_pattern : str
|
|
3068
|
+
Face zone name pattern.
|
|
2908
3069
|
|
|
2909
3070
|
Returns
|
|
2910
3071
|
-------
|
|
@@ -2920,13 +3081,15 @@ class Root(PyMenu):
|
|
|
2920
3081
|
|
|
2921
3082
|
class get_multi_faces_count(PyQuery):
|
|
2922
3083
|
"""
|
|
2923
|
-
|
|
2924
|
-
|
|
3084
|
+
Returns the count of multi-connected faces for the face zones specified.
|
|
2925
3085
|
Parameters
|
|
2926
3086
|
----------
|
|
2927
3087
|
face_zone_id_list : list[int]
|
|
3088
|
+
List containing the face zone IDs.
|
|
2928
3089
|
face_zone_name_list : list[str]
|
|
3090
|
+
List containing the face zone names.
|
|
2929
3091
|
face_zone_name_pattern : str
|
|
3092
|
+
Face zone name pattern.
|
|
2930
3093
|
|
|
2931
3094
|
Returns
|
|
2932
3095
|
-------
|
|
@@ -2942,11 +3105,11 @@ class Root(PyMenu):
|
|
|
2942
3105
|
|
|
2943
3106
|
class get_node_zones(PyQuery):
|
|
2944
3107
|
"""
|
|
2945
|
-
|
|
2946
|
-
|
|
3108
|
+
Return a list of zones whose names contain the specified filter string.
|
|
2947
3109
|
Parameters
|
|
2948
3110
|
----------
|
|
2949
3111
|
filter : str
|
|
3112
|
+
Node zone name filter.
|
|
2950
3113
|
|
|
2951
3114
|
Returns
|
|
2952
3115
|
-------
|
|
@@ -2960,12 +3123,13 @@ class Root(PyMenu):
|
|
|
2960
3123
|
|
|
2961
3124
|
class get_objects(PyQuery):
|
|
2962
3125
|
"""
|
|
2963
|
-
|
|
2964
|
-
|
|
3126
|
+
Return a list of objects of the specified type or whose names contain the specified filter string.
|
|
2965
3127
|
Parameters
|
|
2966
3128
|
----------
|
|
2967
3129
|
type_name : str
|
|
3130
|
+
Mesh object type name.
|
|
2968
3131
|
filter : str
|
|
3132
|
+
Mesh object name filter.
|
|
2969
3133
|
|
|
2970
3134
|
Returns
|
|
2971
3135
|
-------
|
|
@@ -2980,13 +3144,15 @@ class Root(PyMenu):
|
|
|
2980
3144
|
|
|
2981
3145
|
class get_overlapping_face_zones(PyQuery):
|
|
2982
3146
|
"""
|
|
2983
|
-
|
|
2984
|
-
|
|
3147
|
+
Return a list of overlapping face zones based on the area_tolerance and distance_tolerance specified.
|
|
2985
3148
|
Parameters
|
|
2986
3149
|
----------
|
|
2987
3150
|
face_zone_name_pattern : str
|
|
3151
|
+
Face zone name pattern.
|
|
2988
3152
|
area_tolerance : float
|
|
3153
|
+
Area tolerance.
|
|
2989
3154
|
distance_tolerance : float
|
|
3155
|
+
Distance tolerance.
|
|
2990
3156
|
|
|
2991
3157
|
Returns
|
|
2992
3158
|
-------
|
|
@@ -3000,16 +3166,27 @@ class Root(PyMenu):
|
|
|
3000
3166
|
|
|
3001
3167
|
class get_pairs_of_overlapping_face_zones(PyQuery):
|
|
3002
3168
|
"""
|
|
3003
|
-
|
|
3004
|
-
|
|
3169
|
+
- Return the pairs of overlapping face zones based on the join tolerance and feature angle.
|
|
3170
|
+
- Specify the tolerance value for locating the overlapping faces (join_tolerance).
|
|
3171
|
+
- Choose to use an absolute tolerance value or relative to face edges (set absolute_tolerance to True or False).
|
|
3172
|
+
- Specify the feature angle to identify features in the overlap region (feature_angle).
|
|
3173
|
+
- The default value is 40.
|
|
3174
|
+
- Each member in the list returned includes the zone IDs for the overlapping zone pair and the join region represented by the bounding box.
|
|
3175
|
+
- The same pair of zones may appear multiple times (with different join region bounding box coordinates) in the returned list.
|
|
3005
3176
|
Parameters
|
|
3006
3177
|
----------
|
|
3007
3178
|
face_zone_id_list : list[int]
|
|
3179
|
+
List containing the face zone IDs.
|
|
3008
3180
|
face_zone_name_list : list[str]
|
|
3181
|
+
List containing the face zone names.
|
|
3009
3182
|
face_zone_name_pattern : str
|
|
3183
|
+
Face zone name pattern.
|
|
3010
3184
|
join_tolerance : float
|
|
3185
|
+
Join tolerance.
|
|
3011
3186
|
absolute_tolerance : bool
|
|
3187
|
+
Specify whether to use an absolute tolerance value or relative to face edges.
|
|
3012
3188
|
join_angle : float
|
|
3189
|
+
Join angle.
|
|
3013
3190
|
|
|
3014
3191
|
Returns
|
|
3015
3192
|
-------
|
|
@@ -3025,13 +3202,15 @@ class Root(PyMenu):
|
|
|
3025
3202
|
|
|
3026
3203
|
class get_prism_cell_zones(PyQuery):
|
|
3027
3204
|
"""
|
|
3028
|
-
|
|
3029
|
-
|
|
3205
|
+
Return a list of prism cell zones.
|
|
3030
3206
|
Parameters
|
|
3031
3207
|
----------
|
|
3032
3208
|
zone_id_list : list[int]
|
|
3209
|
+
List containing the cell zone IDs.
|
|
3033
3210
|
zone_name_list : list[str]
|
|
3211
|
+
List containing the cell zone names.
|
|
3034
3212
|
zone_name_pattern : str
|
|
3213
|
+
Cell zone name pattern.
|
|
3035
3214
|
|
|
3036
3215
|
Returns
|
|
3037
3216
|
-------
|
|
@@ -3047,13 +3226,18 @@ class Root(PyMenu):
|
|
|
3047
3226
|
|
|
3048
3227
|
class get_region_volume(PyQuery):
|
|
3049
3228
|
"""
|
|
3050
|
-
|
|
3051
|
-
|
|
3229
|
+
- Get region volume using 1 - object_name and region_name or 2 - object_name and order.
|
|
3230
|
+
- Return the region volume for the specified region of an object.
|
|
3231
|
+
- Returns a sorted list of volumetric regions by volume for the object specified.
|
|
3232
|
+
- Specify the order 'ascending' or 'descending'.
|
|
3052
3233
|
Parameters
|
|
3053
3234
|
----------
|
|
3054
3235
|
object_name : str
|
|
3236
|
+
Mesh object name.
|
|
3055
3237
|
region_name : str
|
|
3238
|
+
Region name.
|
|
3056
3239
|
sorting_order : str
|
|
3240
|
+
Region volume sorting order.
|
|
3057
3241
|
|
|
3058
3242
|
Returns
|
|
3059
3243
|
-------
|
|
@@ -3068,13 +3252,15 @@ class Root(PyMenu):
|
|
|
3068
3252
|
|
|
3069
3253
|
class get_regions(PyQuery):
|
|
3070
3254
|
"""
|
|
3071
|
-
|
|
3072
|
-
|
|
3255
|
+
Return a list of regions in the specified object, whose names contain the specified filter string or specified name pattern.
|
|
3073
3256
|
Parameters
|
|
3074
3257
|
----------
|
|
3075
3258
|
object_name : str
|
|
3259
|
+
Mesh object name.
|
|
3076
3260
|
region_name_pattern : str
|
|
3261
|
+
Region name pattern.
|
|
3077
3262
|
filter : str
|
|
3263
|
+
Region name filter.
|
|
3078
3264
|
|
|
3079
3265
|
Returns
|
|
3080
3266
|
-------
|
|
@@ -3090,13 +3276,15 @@ class Root(PyMenu):
|
|
|
3090
3276
|
|
|
3091
3277
|
class get_regions_of_face_zones(PyQuery):
|
|
3092
3278
|
"""
|
|
3093
|
-
|
|
3094
|
-
|
|
3279
|
+
Return a list of regions containing the face zones specified.
|
|
3095
3280
|
Parameters
|
|
3096
3281
|
----------
|
|
3097
3282
|
face_zone_id_list : list[int]
|
|
3283
|
+
List containing the face zone IDs.
|
|
3098
3284
|
face_zone_name_list : list[str]
|
|
3285
|
+
List containing the face zone names.
|
|
3099
3286
|
face_zone_name_pattern : str
|
|
3287
|
+
Face zone name pattern.
|
|
3100
3288
|
|
|
3101
3289
|
Returns
|
|
3102
3290
|
-------
|
|
@@ -3112,13 +3300,15 @@ class Root(PyMenu):
|
|
|
3112
3300
|
|
|
3113
3301
|
class get_shared_boundary_face_zones_for_given_cell_zones(PyQuery):
|
|
3114
3302
|
"""
|
|
3115
|
-
|
|
3116
|
-
|
|
3303
|
+
Returns the number of faces and the boundary face zones that are shared with the specified cell zones.
|
|
3117
3304
|
Parameters
|
|
3118
3305
|
----------
|
|
3119
3306
|
cell_zone_id_list : list[int]
|
|
3307
|
+
List containing the cell zone IDs.
|
|
3120
3308
|
cell_zone_name_list : list[str]
|
|
3309
|
+
List containing the cell zone names.
|
|
3121
3310
|
cell_zone_name_pattern : str
|
|
3311
|
+
Cell zone name pattern.
|
|
3122
3312
|
|
|
3123
3313
|
Returns
|
|
3124
3314
|
-------
|
|
@@ -3134,13 +3324,15 @@ class Root(PyMenu):
|
|
|
3134
3324
|
|
|
3135
3325
|
class get_tet_cell_zones(PyQuery):
|
|
3136
3326
|
"""
|
|
3137
|
-
|
|
3138
|
-
|
|
3327
|
+
Return a list of tet cell zones.
|
|
3139
3328
|
Parameters
|
|
3140
3329
|
----------
|
|
3141
3330
|
zone_id_list : list[int]
|
|
3331
|
+
List containing the cell zone IDs.
|
|
3142
3332
|
zone_name_list : list[str]
|
|
3333
|
+
List containing the cell zone names.
|
|
3143
3334
|
zone_name_pattern : str
|
|
3335
|
+
Cell zone name pattern.
|
|
3144
3336
|
|
|
3145
3337
|
Returns
|
|
3146
3338
|
-------
|
|
@@ -3156,11 +3348,11 @@ class Root(PyMenu):
|
|
|
3156
3348
|
|
|
3157
3349
|
class get_topos_on_face_zones_list(PyQuery):
|
|
3158
3350
|
"""
|
|
3159
|
-
|
|
3160
|
-
|
|
3351
|
+
Returns the list of topo labels for the specified face zones.
|
|
3161
3352
|
Parameters
|
|
3162
3353
|
----------
|
|
3163
3354
|
face_zone_id_list : list[int]
|
|
3355
|
+
List containing the face zone IDs.
|
|
3164
3356
|
|
|
3165
3357
|
Returns
|
|
3166
3358
|
-------
|
|
@@ -3170,12 +3362,13 @@ class Root(PyMenu):
|
|
|
3170
3362
|
|
|
3171
3363
|
class get_unreferenced_cell_zones(PyQuery):
|
|
3172
3364
|
"""
|
|
3173
|
-
|
|
3174
|
-
|
|
3365
|
+
Return a list of unreferenced cell zones by ID, whose names contain the specified pattern or filter.
|
|
3175
3366
|
Parameters
|
|
3176
3367
|
----------
|
|
3177
3368
|
filter : str
|
|
3369
|
+
Cell zone name filter.
|
|
3178
3370
|
zone_name_pattern : str
|
|
3371
|
+
Cell zone name pattern.
|
|
3179
3372
|
|
|
3180
3373
|
Returns
|
|
3181
3374
|
-------
|
|
@@ -3191,12 +3384,13 @@ class Root(PyMenu):
|
|
|
3191
3384
|
|
|
3192
3385
|
class get_unreferenced_edge_zones(PyQuery):
|
|
3193
3386
|
"""
|
|
3194
|
-
|
|
3195
|
-
|
|
3387
|
+
Return a list of unreferenced edge zones by ID, whose names contain the specified pattern or filter.
|
|
3196
3388
|
Parameters
|
|
3197
3389
|
----------
|
|
3198
3390
|
filter : str
|
|
3391
|
+
Edge zone name filter.
|
|
3199
3392
|
zone_name_pattern : str
|
|
3393
|
+
Edge zone name pattern.
|
|
3200
3394
|
|
|
3201
3395
|
Returns
|
|
3202
3396
|
-------
|
|
@@ -3212,12 +3406,13 @@ class Root(PyMenu):
|
|
|
3212
3406
|
|
|
3213
3407
|
class get_unreferenced_face_zones(PyQuery):
|
|
3214
3408
|
"""
|
|
3215
|
-
|
|
3216
|
-
|
|
3409
|
+
Return a list of unreferenced face zones by ID, whose names contain the specified pattern or filter.
|
|
3217
3410
|
Parameters
|
|
3218
3411
|
----------
|
|
3219
3412
|
filter : str
|
|
3413
|
+
Face zone name filter.
|
|
3220
3414
|
zone_name_pattern : str
|
|
3415
|
+
Face zone name pattern.
|
|
3221
3416
|
|
|
3222
3417
|
Returns
|
|
3223
3418
|
-------
|
|
@@ -3233,8 +3428,7 @@ class Root(PyMenu):
|
|
|
3233
3428
|
|
|
3234
3429
|
class get_wrapped_face_zones(PyQuery):
|
|
3235
3430
|
"""
|
|
3236
|
-
|
|
3237
|
-
|
|
3431
|
+
Return a list of wrapped face zones.
|
|
3238
3432
|
|
|
3239
3433
|
Returns
|
|
3240
3434
|
-------
|
|
@@ -3248,12 +3442,13 @@ class Root(PyMenu):
|
|
|
3248
3442
|
|
|
3249
3443
|
class get_zone_type(PyQuery):
|
|
3250
3444
|
"""
|
|
3251
|
-
|
|
3252
|
-
|
|
3445
|
+
Return zone type as integer.
|
|
3253
3446
|
Parameters
|
|
3254
3447
|
----------
|
|
3255
3448
|
zone_id : int
|
|
3449
|
+
Zone ID.
|
|
3256
3450
|
zone_name : str
|
|
3451
|
+
Zone name.
|
|
3257
3452
|
|
|
3258
3453
|
Returns
|
|
3259
3454
|
-------
|
|
@@ -3268,12 +3463,13 @@ class Root(PyMenu):
|
|
|
3268
3463
|
|
|
3269
3464
|
class get_zones(PyQuery):
|
|
3270
3465
|
"""
|
|
3271
|
-
|
|
3272
|
-
|
|
3466
|
+
Return a list of zones of the specified default zone type, group or user-defined group.
|
|
3273
3467
|
Parameters
|
|
3274
3468
|
----------
|
|
3275
3469
|
type_name : str
|
|
3470
|
+
Zone type name.
|
|
3276
3471
|
group_name : str
|
|
3472
|
+
Zone group name.
|
|
3277
3473
|
|
|
3278
3474
|
Returns
|
|
3279
3475
|
-------
|
|
@@ -3288,13 +3484,15 @@ class Root(PyMenu):
|
|
|
3288
3484
|
|
|
3289
3485
|
class get_zones_with_free_faces_for_given_face_zones(PyQuery):
|
|
3290
3486
|
"""
|
|
3291
|
-
|
|
3292
|
-
|
|
3487
|
+
Return a list of zones with free faces for the face zones specified.
|
|
3293
3488
|
Parameters
|
|
3294
3489
|
----------
|
|
3295
3490
|
face_zone_id_list : list[int]
|
|
3491
|
+
List containing the face zone IDs.
|
|
3296
3492
|
face_zone_name_list : list[str]
|
|
3493
|
+
List containing the face zone names.
|
|
3297
3494
|
face_zone_name_pattern : str
|
|
3495
|
+
Face zone name pattern.
|
|
3298
3496
|
|
|
3299
3497
|
Returns
|
|
3300
3498
|
-------
|
|
@@ -3310,13 +3508,15 @@ class Root(PyMenu):
|
|
|
3310
3508
|
|
|
3311
3509
|
class get_zones_with_marked_faces_for_given_face_zones(PyQuery):
|
|
3312
3510
|
"""
|
|
3313
|
-
|
|
3314
|
-
|
|
3511
|
+
Return a list of zones with marked faces for the face zones specified.
|
|
3315
3512
|
Parameters
|
|
3316
3513
|
----------
|
|
3317
3514
|
face_zone_id_list : list[int]
|
|
3515
|
+
List containing the face zone IDs.
|
|
3318
3516
|
face_zone_name_list : list[str]
|
|
3517
|
+
List containing the face zone names.
|
|
3319
3518
|
face_zone_name_pattern : str
|
|
3519
|
+
Face zone name pattern.
|
|
3320
3520
|
|
|
3321
3521
|
Returns
|
|
3322
3522
|
-------
|
|
@@ -3332,13 +3532,15 @@ class Root(PyMenu):
|
|
|
3332
3532
|
|
|
3333
3533
|
class get_zones_with_multi_faces_for_given_face_zones(PyQuery):
|
|
3334
3534
|
"""
|
|
3335
|
-
|
|
3336
|
-
|
|
3535
|
+
Return a list of zones with multi-connected faces for the face zones specified.
|
|
3337
3536
|
Parameters
|
|
3338
3537
|
----------
|
|
3339
3538
|
face_zone_id_list : list[int]
|
|
3539
|
+
List containing the face zone IDs.
|
|
3340
3540
|
face_zone_name_list : list[str]
|
|
3541
|
+
List containing the face zone names.
|
|
3341
3542
|
face_zone_name_pattern : str
|
|
3543
|
+
Face zone name pattern.
|
|
3342
3544
|
|
|
3343
3545
|
Returns
|
|
3344
3546
|
-------
|
|
@@ -3354,12 +3556,13 @@ class Root(PyMenu):
|
|
|
3354
3556
|
|
|
3355
3557
|
class interior_zone_exists(PyQuery):
|
|
3356
3558
|
"""
|
|
3357
|
-
|
|
3358
|
-
|
|
3559
|
+
Report if the interior face zone exists.
|
|
3359
3560
|
Parameters
|
|
3360
3561
|
----------
|
|
3361
3562
|
zone_id : int
|
|
3563
|
+
Zone ID.
|
|
3362
3564
|
zone_name : str
|
|
3565
|
+
Zone name.
|
|
3363
3566
|
|
|
3364
3567
|
Returns
|
|
3365
3568
|
-------
|
|
@@ -3374,15 +3577,19 @@ class Root(PyMenu):
|
|
|
3374
3577
|
|
|
3375
3578
|
class mark_bad_quality_faces(PyQuery):
|
|
3376
3579
|
"""
|
|
3377
|
-
|
|
3378
|
-
|
|
3580
|
+
Mark bad quality faces on the boundary face zones specified, based on the quality limit (quality_limit) and number of rings (number_of_rings).
|
|
3379
3581
|
Parameters
|
|
3380
3582
|
----------
|
|
3381
3583
|
face_zone_id_list : list[int]
|
|
3584
|
+
List containing the face zone IDs.
|
|
3382
3585
|
face_zone_name_list : list[str]
|
|
3586
|
+
List containing the face zone names.
|
|
3383
3587
|
face_zone_name_pattern : str
|
|
3588
|
+
Face zone name pattern.
|
|
3384
3589
|
quality_limit : float
|
|
3590
|
+
Quality limit.
|
|
3385
3591
|
number_of_rings : int
|
|
3592
|
+
Number of rings.
|
|
3386
3593
|
|
|
3387
3594
|
Returns
|
|
3388
3595
|
-------
|
|
@@ -3398,13 +3605,15 @@ class Root(PyMenu):
|
|
|
3398
3605
|
|
|
3399
3606
|
class mark_duplicate_faces(PyQuery):
|
|
3400
3607
|
"""
|
|
3401
|
-
|
|
3402
|
-
|
|
3608
|
+
Mark duplicate faces on the face zones specified.
|
|
3403
3609
|
Parameters
|
|
3404
3610
|
----------
|
|
3405
3611
|
face_zone_id_list : list[int]
|
|
3612
|
+
List containing the face zone IDs.
|
|
3406
3613
|
face_zone_name_list : list[str]
|
|
3614
|
+
List containing the face zone names.
|
|
3407
3615
|
face_zone_name_pattern : str
|
|
3616
|
+
Face zone name pattern.
|
|
3408
3617
|
|
|
3409
3618
|
Returns
|
|
3410
3619
|
-------
|
|
@@ -3420,18 +3629,32 @@ class Root(PyMenu):
|
|
|
3420
3629
|
|
|
3421
3630
|
class mark_face_strips_by_height_and_quality(PyQuery):
|
|
3422
3631
|
"""
|
|
3423
|
-
|
|
3424
|
-
|
|
3632
|
+
- Mark face strips based on the strip_type, strip_height, quality_measure, quality_limit, and feature_angle specified.
|
|
3633
|
+
- Possible values for strip_type are 1, 2, 3 and 4.
|
|
3634
|
+
- 1 - 'boundary-boundary' strip, multi-connected face edges are also considered as boundary here.
|
|
3635
|
+
- 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.
|
|
3636
|
+
- 3 - 'all-all' strip between all boundaries and features.
|
|
3637
|
+
- 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.
|
|
3638
|
+
- The recommended value is 2.
|
|
3639
|
+
- Specify the 'quality_measure' as one of the 'Skewness', 'Size Change', 'Edge Ratio', 'Area', 'Aspect Ratio', 'Warp', 'Dihedral Angle', 'Ortho Skew' value.
|
|
3425
3640
|
Parameters
|
|
3426
3641
|
----------
|
|
3427
3642
|
face_zone_id_list : list[int]
|
|
3643
|
+
List containing the face zone IDs.
|
|
3428
3644
|
face_zone_name_list : list[str]
|
|
3645
|
+
List containing the face zone names.
|
|
3429
3646
|
face_zone_name_pattern : str
|
|
3647
|
+
Face zone name pattern.
|
|
3430
3648
|
strip_type : int
|
|
3649
|
+
Strip type.
|
|
3431
3650
|
strip_height : float
|
|
3651
|
+
Strip height.
|
|
3432
3652
|
quality_measure : str
|
|
3653
|
+
Quality measure.
|
|
3433
3654
|
quality_limit : float
|
|
3655
|
+
Quality limit.
|
|
3434
3656
|
feature_angle : float
|
|
3657
|
+
Feature angle.
|
|
3435
3658
|
|
|
3436
3659
|
Returns
|
|
3437
3660
|
-------
|
|
@@ -3447,16 +3670,23 @@ class Root(PyMenu):
|
|
|
3447
3670
|
|
|
3448
3671
|
class mark_faces_by_quality(PyQuery):
|
|
3449
3672
|
"""
|
|
3450
|
-
|
|
3451
|
-
|
|
3673
|
+
- Mark faces based on the 'quality_measure' and 'quality_limit' specified.
|
|
3674
|
+
- Specify whether to append the faces to those previously marked or clear previously marked faces (append_marking set to True or False).
|
|
3675
|
+
- Specify the 'quality_measure' as one of the 'Skewness', 'Size Change', 'Edge Ratio', 'Area', 'Aspect Ratio', 'Warp', 'Dihedral Angle', 'Ortho Skew' value.
|
|
3452
3676
|
Parameters
|
|
3453
3677
|
----------
|
|
3454
3678
|
face_zone_id_list : list[int]
|
|
3679
|
+
List containing the face zone IDs.
|
|
3455
3680
|
face_zone_name_list : list[str]
|
|
3681
|
+
List containing the face zone names.
|
|
3456
3682
|
face_zone_name_pattern : str
|
|
3683
|
+
Face zone name pattern.
|
|
3457
3684
|
quality_measure : str
|
|
3685
|
+
Quality measure.
|
|
3458
3686
|
quality_limit : float
|
|
3687
|
+
Quality limit.
|
|
3459
3688
|
append_marking : bool
|
|
3689
|
+
Specify whether to append the faces to those previously marked or clear previously marked faces.
|
|
3460
3690
|
|
|
3461
3691
|
Returns
|
|
3462
3692
|
-------
|
|
@@ -3472,16 +3702,24 @@ class Root(PyMenu):
|
|
|
3472
3702
|
|
|
3473
3703
|
class mark_faces_deviating_from_size_field(PyQuery):
|
|
3474
3704
|
"""
|
|
3475
|
-
|
|
3476
|
-
|
|
3705
|
+
- Mark all faces at nodes based on deviation from the size field.
|
|
3706
|
+
- Specify the size field type to be used to get size at node.
|
|
3707
|
+
- Set 'size_factor_type_to_compare' to 'volumetric' or 'geodesic'.
|
|
3708
|
+
- 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.
|
|
3477
3709
|
Parameters
|
|
3478
3710
|
----------
|
|
3479
3711
|
face_zone_id_list : list[int]
|
|
3712
|
+
List containing the face zone IDs.
|
|
3480
3713
|
face_zone_name_list : list[str]
|
|
3714
|
+
List containing the face zone names.
|
|
3481
3715
|
face_zone_name_pattern : str
|
|
3716
|
+
Face zone name pattern.
|
|
3482
3717
|
min_size_factor : float
|
|
3718
|
+
Minimum size factor.
|
|
3483
3719
|
max_size_factor : float
|
|
3720
|
+
Maximum size factor.
|
|
3484
3721
|
size_factor_type_to_compare : str
|
|
3722
|
+
Size field type to be used to get size at node.
|
|
3485
3723
|
|
|
3486
3724
|
Returns
|
|
3487
3725
|
-------
|
|
@@ -3497,17 +3735,24 @@ class Root(PyMenu):
|
|
|
3497
3735
|
|
|
3498
3736
|
class mark_faces_in_self_proximity(PyQuery):
|
|
3499
3737
|
"""
|
|
3500
|
-
|
|
3501
|
-
|
|
3738
|
+
- Mark faces in self-proximity on the face zones specified.
|
|
3739
|
+
- 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).
|
|
3502
3740
|
Parameters
|
|
3503
3741
|
----------
|
|
3504
3742
|
face_zone_id_list : list[int]
|
|
3743
|
+
List containing the face zone IDs.
|
|
3505
3744
|
face_zone_name_list : list[str]
|
|
3745
|
+
List containing the face zone names.
|
|
3506
3746
|
face_zone_name_pattern : str
|
|
3747
|
+
Face zone name pattern.
|
|
3507
3748
|
relative_tolerance : bool
|
|
3749
|
+
Specify whether to use relative tolerance.
|
|
3508
3750
|
tolerance : float
|
|
3751
|
+
Tolerance.
|
|
3509
3752
|
proximity_angle : float
|
|
3753
|
+
Proximity angle.
|
|
3510
3754
|
ignore_orientation : bool
|
|
3755
|
+
Specify whether to ignore orientation.
|
|
3511
3756
|
|
|
3512
3757
|
Returns
|
|
3513
3758
|
-------
|
|
@@ -3523,14 +3768,18 @@ class Root(PyMenu):
|
|
|
3523
3768
|
|
|
3524
3769
|
class mark_faces_using_node_degree(PyQuery):
|
|
3525
3770
|
"""
|
|
3526
|
-
|
|
3527
|
-
|
|
3771
|
+
- Mark all faces with node degree above the specified threshold.
|
|
3772
|
+
- Node degree is defined as the number of edges connected to the node.
|
|
3528
3773
|
Parameters
|
|
3529
3774
|
----------
|
|
3530
3775
|
face_zone_id_list : list[int]
|
|
3776
|
+
List containing the face zone IDs.
|
|
3531
3777
|
face_zone_name_list : list[str]
|
|
3778
|
+
List containing the face zone names.
|
|
3532
3779
|
face_zone_name_pattern : str
|
|
3780
|
+
Face zone name pattern.
|
|
3533
3781
|
node_degree_threshold : int
|
|
3782
|
+
Number of edges connected to the node.
|
|
3534
3783
|
|
|
3535
3784
|
Returns
|
|
3536
3785
|
-------
|
|
@@ -3546,13 +3795,15 @@ class Root(PyMenu):
|
|
|
3546
3795
|
|
|
3547
3796
|
class mark_free_faces(PyQuery):
|
|
3548
3797
|
"""
|
|
3549
|
-
|
|
3550
|
-
|
|
3798
|
+
Mark free faces on the face zones specified.
|
|
3551
3799
|
Parameters
|
|
3552
3800
|
----------
|
|
3553
3801
|
face_zone_id_list : list[int]
|
|
3802
|
+
List containing the face zone IDs.
|
|
3554
3803
|
face_zone_name_list : list[str]
|
|
3804
|
+
List containing the face zone names.
|
|
3555
3805
|
face_zone_name_pattern : str
|
|
3806
|
+
Face zone name pattern.
|
|
3556
3807
|
|
|
3557
3808
|
Returns
|
|
3558
3809
|
-------
|
|
@@ -3568,13 +3819,15 @@ class Root(PyMenu):
|
|
|
3568
3819
|
|
|
3569
3820
|
class mark_invalid_normals(PyQuery):
|
|
3570
3821
|
"""
|
|
3571
|
-
|
|
3572
|
-
|
|
3822
|
+
Mark invalid normal locations on the face zones specified.
|
|
3573
3823
|
Parameters
|
|
3574
3824
|
----------
|
|
3575
3825
|
face_zone_id_list : list[int]
|
|
3826
|
+
List containing the face zone IDs.
|
|
3576
3827
|
face_zone_name_list : list[str]
|
|
3828
|
+
List containing the face zone names.
|
|
3577
3829
|
face_zone_name_pattern : str
|
|
3830
|
+
Face zone name pattern.
|
|
3578
3831
|
|
|
3579
3832
|
Returns
|
|
3580
3833
|
-------
|
|
@@ -3590,14 +3843,17 @@ class Root(PyMenu):
|
|
|
3590
3843
|
|
|
3591
3844
|
class mark_island_faces(PyQuery):
|
|
3592
3845
|
"""
|
|
3593
|
-
|
|
3594
|
-
|
|
3846
|
+
Mark island faces on the face zones specified, based on the island face count (island_face_count).
|
|
3595
3847
|
Parameters
|
|
3596
3848
|
----------
|
|
3597
3849
|
face_zone_id_list : list[int]
|
|
3850
|
+
List containing the face zone IDs.
|
|
3598
3851
|
face_zone_name_list : list[str]
|
|
3852
|
+
List containing the face zone names.
|
|
3599
3853
|
face_zone_name_pattern : str
|
|
3854
|
+
Face zone name pattern.
|
|
3600
3855
|
island_face_count : int
|
|
3856
|
+
Island face count.
|
|
3601
3857
|
|
|
3602
3858
|
Returns
|
|
3603
3859
|
-------
|
|
@@ -3613,14 +3869,17 @@ class Root(PyMenu):
|
|
|
3613
3869
|
|
|
3614
3870
|
class mark_multi_faces(PyQuery):
|
|
3615
3871
|
"""
|
|
3616
|
-
|
|
3617
|
-
|
|
3872
|
+
Mark multi-connected faces on the face zones specified based on fringe length (fringe_length).
|
|
3618
3873
|
Parameters
|
|
3619
3874
|
----------
|
|
3620
3875
|
face_zone_id_list : list[int]
|
|
3876
|
+
List containing the face zone IDs.
|
|
3621
3877
|
face_zone_name_list : list[str]
|
|
3878
|
+
List containing the face zone names.
|
|
3622
3879
|
face_zone_name_pattern : str
|
|
3880
|
+
Face zone name pattern.
|
|
3623
3881
|
fringe_length : int
|
|
3882
|
+
Fringe length.
|
|
3624
3883
|
|
|
3625
3884
|
Returns
|
|
3626
3885
|
-------
|
|
@@ -3636,13 +3895,15 @@ class Root(PyMenu):
|
|
|
3636
3895
|
|
|
3637
3896
|
class mark_point_contacts(PyQuery):
|
|
3638
3897
|
"""
|
|
3639
|
-
|
|
3640
|
-
|
|
3898
|
+
Mark point contact locations on the face zones specified.
|
|
3641
3899
|
Parameters
|
|
3642
3900
|
----------
|
|
3643
3901
|
face_zone_id_list : list[int]
|
|
3902
|
+
List containing the face zone IDs.
|
|
3644
3903
|
face_zone_name_list : list[str]
|
|
3904
|
+
List containing the face zone names.
|
|
3645
3905
|
face_zone_name_pattern : str
|
|
3906
|
+
Face zone name pattern.
|
|
3646
3907
|
|
|
3647
3908
|
Returns
|
|
3648
3909
|
-------
|
|
@@ -3658,14 +3919,18 @@ class Root(PyMenu):
|
|
|
3658
3919
|
|
|
3659
3920
|
class mark_self_intersecting_faces(PyQuery):
|
|
3660
3921
|
"""
|
|
3661
|
-
|
|
3662
|
-
|
|
3922
|
+
- Mark self-intersecting faces on the face zones specified.
|
|
3923
|
+
- Specify whether to mark folded faces or not (mark_folded set to True or False).
|
|
3663
3924
|
Parameters
|
|
3664
3925
|
----------
|
|
3665
3926
|
face_zone_id_list : list[int]
|
|
3927
|
+
List containing the face zone IDs.
|
|
3666
3928
|
face_zone_name_list : list[str]
|
|
3929
|
+
List containing the face zone names.
|
|
3667
3930
|
face_zone_name_pattern : str
|
|
3931
|
+
Face zone name pattern.
|
|
3668
3932
|
mark_folded : bool
|
|
3933
|
+
Specify whether to mark folded faces or not.
|
|
3669
3934
|
|
|
3670
3935
|
Returns
|
|
3671
3936
|
-------
|
|
@@ -3681,15 +3946,19 @@ class Root(PyMenu):
|
|
|
3681
3946
|
|
|
3682
3947
|
class mark_sliver_faces(PyQuery):
|
|
3683
3948
|
"""
|
|
3684
|
-
|
|
3685
|
-
|
|
3949
|
+
Mark sliver faces on the face zones specified, based on the maximum height (max_height) and skewness limit (skew_limit).
|
|
3686
3950
|
Parameters
|
|
3687
3951
|
----------
|
|
3688
3952
|
face_zone_id_list : list[int]
|
|
3953
|
+
List containing the face zone IDs.
|
|
3689
3954
|
face_zone_name_list : list[str]
|
|
3955
|
+
List containing the face zone names.
|
|
3690
3956
|
face_zone_name_pattern : str
|
|
3957
|
+
Face zone name pattern.
|
|
3691
3958
|
max_height : float
|
|
3959
|
+
Maximum height.
|
|
3692
3960
|
skew_limit : float
|
|
3961
|
+
Skew limit.
|
|
3693
3962
|
|
|
3694
3963
|
Returns
|
|
3695
3964
|
-------
|
|
@@ -3705,14 +3974,17 @@ class Root(PyMenu):
|
|
|
3705
3974
|
|
|
3706
3975
|
class mark_spikes(PyQuery):
|
|
3707
3976
|
"""
|
|
3708
|
-
|
|
3709
|
-
|
|
3977
|
+
Mark spikes on the face zones specified, based on the spike angle (spike_angle).
|
|
3710
3978
|
Parameters
|
|
3711
3979
|
----------
|
|
3712
3980
|
face_zone_id_list : list[int]
|
|
3981
|
+
List containing the face zone IDs.
|
|
3713
3982
|
face_zone_name_list : list[str]
|
|
3983
|
+
List containing the face zone names.
|
|
3714
3984
|
face_zone_name_pattern : str
|
|
3985
|
+
Face zone name pattern.
|
|
3715
3986
|
spike_angle : float
|
|
3987
|
+
Spike angle.
|
|
3716
3988
|
|
|
3717
3989
|
Returns
|
|
3718
3990
|
-------
|
|
@@ -3728,15 +4000,19 @@ class Root(PyMenu):
|
|
|
3728
4000
|
|
|
3729
4001
|
class mark_steps(PyQuery):
|
|
3730
4002
|
"""
|
|
3731
|
-
|
|
3732
|
-
|
|
4003
|
+
Mark steps on the face zones specified, based on the step angle (step_angle) and step width (step_width).
|
|
3733
4004
|
Parameters
|
|
3734
4005
|
----------
|
|
3735
4006
|
face_zone_id_list : list[int]
|
|
4007
|
+
List containing the face zone IDs.
|
|
3736
4008
|
face_zone_name_list : list[str]
|
|
4009
|
+
List containing the face zone names.
|
|
3737
4010
|
face_zone_name_pattern : str
|
|
4011
|
+
Face zone name pattern.
|
|
3738
4012
|
step_angle : float
|
|
4013
|
+
Step angle.
|
|
3739
4014
|
step_width : float
|
|
4015
|
+
Step width.
|
|
3740
4016
|
|
|
3741
4017
|
Returns
|
|
3742
4018
|
-------
|
|
@@ -3752,20 +4028,30 @@ class Root(PyMenu):
|
|
|
3752
4028
|
|
|
3753
4029
|
class mesh_check(PyQuery):
|
|
3754
4030
|
"""
|
|
3755
|
-
|
|
3756
|
-
|
|
4031
|
+
- Reports the selected mesh check statistics for the zones specified.
|
|
4032
|
+
- 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.
|
|
3757
4033
|
Parameters
|
|
3758
4034
|
----------
|
|
3759
4035
|
type_name : str
|
|
4036
|
+
Type name.
|
|
3760
4037
|
edge_zone_id_list : list[int]
|
|
4038
|
+
List containing the edge zone IDs.
|
|
3761
4039
|
edge_zone_name_list : list[str]
|
|
4040
|
+
List containing the edge zone names.
|
|
3762
4041
|
edge_zone_name_pattern : str
|
|
4042
|
+
Edge zone name pattern.
|
|
3763
4043
|
face_zone_id_list : list[int]
|
|
4044
|
+
List containing the face zone IDs.
|
|
3764
4045
|
face_zone_name_list : list[str]
|
|
4046
|
+
List containing the face zone names.
|
|
3765
4047
|
face_zone_name_pattern : str
|
|
4048
|
+
Face zone name pattern.
|
|
3766
4049
|
cell_zone_id_list : list[int]
|
|
4050
|
+
List containing the cell zone IDs.
|
|
3767
4051
|
cell_zone_name_list : list[str]
|
|
4052
|
+
List containing the cell zone names.
|
|
3768
4053
|
cell_zone_name_pattern : str
|
|
4054
|
+
Cell zone name pattern.
|
|
3769
4055
|
|
|
3770
4056
|
Returns
|
|
3771
4057
|
-------
|
|
@@ -3784,8 +4070,7 @@ class Root(PyMenu):
|
|
|
3784
4070
|
|
|
3785
4071
|
class mesh_exists(PyQuery):
|
|
3786
4072
|
"""
|
|
3787
|
-
|
|
3788
|
-
|
|
4073
|
+
Report if the volume mesh exists.
|
|
3789
4074
|
|
|
3790
4075
|
Returns
|
|
3791
4076
|
-------
|
|
@@ -3799,14 +4084,18 @@ class Root(PyMenu):
|
|
|
3799
4084
|
|
|
3800
4085
|
class print_worst_quality_cell(PyQuery):
|
|
3801
4086
|
"""
|
|
3802
|
-
|
|
3803
|
-
|
|
4087
|
+
- Report the worst quality cell (ID and location) for the cell zones based on the measure specified.
|
|
4088
|
+
- 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.
|
|
3804
4089
|
Parameters
|
|
3805
4090
|
----------
|
|
3806
4091
|
cell_zone_id_list : list[int]
|
|
4092
|
+
List containing the cell zone IDs.
|
|
3807
4093
|
cell_zone_name_list : list[str]
|
|
4094
|
+
List containing the cell zone names.
|
|
3808
4095
|
cell_zone_name_pattern : str
|
|
4096
|
+
Cell zone name pattern.
|
|
3809
4097
|
measure : str
|
|
4098
|
+
Measure.
|
|
3810
4099
|
|
|
3811
4100
|
Returns
|
|
3812
4101
|
-------
|
|
@@ -3822,11 +4111,12 @@ class Root(PyMenu):
|
|
|
3822
4111
|
|
|
3823
4112
|
class project_zone_on_plane(PyQuery):
|
|
3824
4113
|
"""
|
|
3825
|
-
|
|
3826
|
-
|
|
4114
|
+
- Project a zone on the plane specified.
|
|
4115
|
+
- Specify three points for defining the plane.
|
|
3827
4116
|
Parameters
|
|
3828
4117
|
----------
|
|
3829
4118
|
zone_id : int
|
|
4119
|
+
Zone ID.
|
|
3830
4120
|
plane : dict[str, Any]
|
|
3831
4121
|
|
|
3832
4122
|
Returns
|
|
@@ -3841,13 +4131,15 @@ class Root(PyMenu):
|
|
|
3841
4131
|
|
|
3842
4132
|
class refine_marked_faces_in_zones(PyQuery):
|
|
3843
4133
|
"""
|
|
3844
|
-
|
|
3845
|
-
|
|
4134
|
+
Refine marked faces.
|
|
3846
4135
|
Parameters
|
|
3847
4136
|
----------
|
|
3848
4137
|
face_zone_id_list : list[int]
|
|
4138
|
+
List containing the face zone IDs.
|
|
3849
4139
|
face_zone_name_list : list[str]
|
|
4140
|
+
List containing the face zone names.
|
|
3850
4141
|
face_zone_name_pattern : str
|
|
4142
|
+
Face zone name pattern.
|
|
3851
4143
|
|
|
3852
4144
|
Returns
|
|
3853
4145
|
-------
|
|
@@ -3863,16 +4155,22 @@ class Root(PyMenu):
|
|
|
3863
4155
|
|
|
3864
4156
|
class scale_cell_zones_around_pivot(PyQuery):
|
|
3865
4157
|
"""
|
|
3866
|
-
|
|
3867
|
-
|
|
4158
|
+
- Enables you to scale the cell zones around a pivot point or the bounding box center.
|
|
4159
|
+
- 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).
|
|
3868
4160
|
Parameters
|
|
3869
4161
|
----------
|
|
3870
4162
|
cell_zone_id_list : list[int]
|
|
4163
|
+
List containing the cell zone IDs.
|
|
3871
4164
|
cell_zone_name_list : list[str]
|
|
4165
|
+
List containing the cell zone names.
|
|
3872
4166
|
cell_zone_name_pattern : str
|
|
4167
|
+
Cell zone name pattern.
|
|
3873
4168
|
scale : list[float]
|
|
4169
|
+
Scale factors in the X, Y, Z directions.
|
|
3874
4170
|
pivot : list[float]
|
|
4171
|
+
Pivot point.
|
|
3875
4172
|
use_bbox_center : bool
|
|
4173
|
+
Specify whether to use the bounding box center.
|
|
3876
4174
|
|
|
3877
4175
|
Returns
|
|
3878
4176
|
-------
|
|
@@ -3888,16 +4186,22 @@ class Root(PyMenu):
|
|
|
3888
4186
|
|
|
3889
4187
|
class scale_face_zones_around_pivot(PyQuery):
|
|
3890
4188
|
"""
|
|
3891
|
-
|
|
3892
|
-
|
|
4189
|
+
- Enables you to scale the face zones around a pivot point or the bounding box center.
|
|
4190
|
+
- 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).
|
|
3893
4191
|
Parameters
|
|
3894
4192
|
----------
|
|
3895
4193
|
face_zone_id_list : list[int]
|
|
4194
|
+
List containing the face zone IDs.
|
|
3896
4195
|
face_zone_name_list : list[str]
|
|
4196
|
+
List containing the face zone names.
|
|
3897
4197
|
face_zone_name_pattern : str
|
|
4198
|
+
Face zone name pattern.
|
|
3898
4199
|
scale : list[float]
|
|
4200
|
+
Scale factors in the X, Y, Z directions.
|
|
3899
4201
|
pivot : list[float]
|
|
4202
|
+
Pivot point.
|
|
3900
4203
|
use_bbox_center : bool
|
|
4204
|
+
Specify whether to use the bounding box center.
|
|
3901
4205
|
|
|
3902
4206
|
Returns
|
|
3903
4207
|
-------
|
|
@@ -3913,15 +4217,21 @@ class Root(PyMenu):
|
|
|
3913
4217
|
|
|
3914
4218
|
class separate_cell_zone_layers_by_face_zone_using_id(PyQuery):
|
|
3915
4219
|
"""
|
|
3916
|
-
|
|
3917
|
-
|
|
4220
|
+
- Separates cells that are connected to specified face zones into another cell zone.
|
|
4221
|
+
- This separation method applies only to prism cells.
|
|
4222
|
+
- Specify the number of layers of cells (nlayers) to be separated.
|
|
3918
4223
|
Parameters
|
|
3919
4224
|
----------
|
|
3920
4225
|
cell_zone_id : int
|
|
4226
|
+
Cell zone ID.
|
|
3921
4227
|
face_zone_id_list : list[int]
|
|
4228
|
+
List containing the face zone IDs.
|
|
3922
4229
|
face_zone_name_list : list[str]
|
|
4230
|
+
List containing the face zone names.
|
|
3923
4231
|
face_zone_name_pattern : str
|
|
4232
|
+
Face zone name pattern.
|
|
3924
4233
|
nlayers : int
|
|
4234
|
+
Number of layers of cells to be separated.
|
|
3925
4235
|
|
|
3926
4236
|
Returns
|
|
3927
4237
|
-------
|
|
@@ -3937,15 +4247,21 @@ class Root(PyMenu):
|
|
|
3937
4247
|
|
|
3938
4248
|
class separate_cell_zone_layers_by_face_zone_using_name(PyQuery):
|
|
3939
4249
|
"""
|
|
3940
|
-
|
|
3941
|
-
|
|
4250
|
+
- Separates cells that are connected to specified face zones into another cell zone.
|
|
4251
|
+
- This separation method applies only to prism cells.
|
|
4252
|
+
- Specify the number of layers of cells (nlayers) to be separated.
|
|
3942
4253
|
Parameters
|
|
3943
4254
|
----------
|
|
3944
4255
|
cell_zone_name : str
|
|
4256
|
+
Cell zone name.
|
|
3945
4257
|
face_zone_id_list : list[int]
|
|
4258
|
+
List containing the face zone IDs.
|
|
3946
4259
|
face_zone_name_list : list[str]
|
|
4260
|
+
List containing the face zone names.
|
|
3947
4261
|
face_zone_name_pattern : str
|
|
4262
|
+
Face zone name pattern.
|
|
3948
4263
|
nlayers : int
|
|
4264
|
+
Number of layers of cells to be separated.
|
|
3949
4265
|
|
|
3950
4266
|
Returns
|
|
3951
4267
|
-------
|
|
@@ -3961,13 +4277,15 @@ class Root(PyMenu):
|
|
|
3961
4277
|
|
|
3962
4278
|
class separate_face_zones_by_cell_neighbor(PyQuery):
|
|
3963
4279
|
"""
|
|
3964
|
-
|
|
3965
|
-
|
|
4280
|
+
Separate face zones based on the cell neighbors.
|
|
3966
4281
|
Parameters
|
|
3967
4282
|
----------
|
|
3968
4283
|
face_zone_id_list : list[int]
|
|
4284
|
+
List containing the face zone IDs.
|
|
3969
4285
|
face_zone_name_list : list[str]
|
|
4286
|
+
List containing the face zone names.
|
|
3970
4287
|
face_zone_name_pattern : str
|
|
4288
|
+
Face zone name pattern.
|
|
3971
4289
|
|
|
3972
4290
|
Returns
|
|
3973
4291
|
-------
|
|
@@ -3983,13 +4301,15 @@ class Root(PyMenu):
|
|
|
3983
4301
|
|
|
3984
4302
|
class unpreserve_cell_zones(PyQuery):
|
|
3985
4303
|
"""
|
|
3986
|
-
|
|
3987
|
-
|
|
4304
|
+
Enables you to unpreserve some/all preserved cell zones during the meshing process.
|
|
3988
4305
|
Parameters
|
|
3989
4306
|
----------
|
|
3990
4307
|
cell_zone_id_list : list[int]
|
|
4308
|
+
List containing the cell zone IDs.
|
|
3991
4309
|
cell_zone_name_list : list[str]
|
|
4310
|
+
List containing the cell zone names.
|
|
3992
4311
|
cell_zone_name_pattern : str
|
|
4312
|
+
Cell zone name pattern.
|
|
3993
4313
|
|
|
3994
4314
|
Returns
|
|
3995
4315
|
-------
|