ansys-fluent-core 0.32.1__py3-none-any.whl → 0.32.4__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.

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