ansys-fluent-core 0.14.dev0__py3-none-any.whl → 0.14.dev2__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 (80) hide show
  1. ansys/fluent/core/__init__.py +12 -12
  2. ansys/fluent/core/_version.py +1 -1
  3. ansys/fluent/core/docs/README.rst +26 -26
  4. ansys/fluent/core/examples/downloads.py +28 -16
  5. ansys/fluent/core/filereader/case_file.py +20 -11
  6. ansys/fluent/core/fluent_connection.py +21 -1
  7. ansys/fluent/core/launcher/fluent_container.py +1 -1
  8. ansys/fluent/core/launcher/fluent_launcher_options.json +10 -0
  9. ansys/fluent/core/launcher/launcher.py +29 -15
  10. ansys/fluent/core/meshing/tui_231.py +7642 -7642
  11. ansys/fluent/core/services/datamodel_se.py +142 -110
  12. ansys/fluent/core/services/field_data.py +278 -29
  13. ansys/fluent/core/services/meshing_queries.py +1795 -0
  14. ansys/fluent/core/services/settings.py +1 -1
  15. ansys/fluent/core/services/svar.py +606 -0
  16. ansys/fluent/core/session_pure_meshing.py +4 -5
  17. ansys/fluent/core/solver/flobject.py +59 -2
  18. ansys/fluent/core/solver/settings_222/change_type.py +1 -1
  19. ansys/fluent/core/solver/settings_222/clear_generated_data.py +1 -1
  20. ansys/fluent/core/solver/settings_222/compute_2.py +1 -1
  21. ansys/fluent/core/solver/settings_222/delete_design_points.py +1 -1
  22. ansys/fluent/core/solver/settings_222/position_1.py +1 -1
  23. ansys/fluent/core/solver/settings_222/setup_unsteady_statistics.py +1 -1
  24. ansys/fluent/core/solver/settings_222/target.py +1 -1
  25. ansys/fluent/core/solver/settings_222/up_vector.py +1 -1
  26. ansys/fluent/core/solver/settings_222/update_selected.py +1 -1
  27. ansys/fluent/core/solver/settings_222/write_1.py +1 -1
  28. ansys/fluent/core/solver/settings_222/write_views.py +1 -1
  29. ansys/fluent/core/solver/settings_231/abaqus.py +2 -2
  30. ansys/fluent/core/solver/settings_231/activate_cell_zone.py +1 -1
  31. ansys/fluent/core/solver/settings_231/calculate_patch.py +2 -2
  32. ansys/fluent/core/solver/settings_231/change_type.py +1 -1
  33. ansys/fluent/core/solver/settings_231/clear_generated_data.py +1 -1
  34. ansys/fluent/core/solver/settings_231/compute_1.py +1 -1
  35. ansys/fluent/core/solver/settings_231/convert_skewed_cells_1.py +1 -1
  36. ansys/fluent/core/solver/settings_231/custom_heat_flux.py +1 -1
  37. ansys/fluent/core/solver/settings_231/customize_fmg_initialization.py +2 -2
  38. ansys/fluent/core/solver/settings_231/delete_design_points.py +1 -1
  39. ansys/fluent/core/solver/settings_231/export_1.py +1 -1
  40. ansys/fluent/core/solver/settings_231/export_modifications.py +1 -1
  41. ansys/fluent/core/solver/settings_231/film_heat_transfer.py +1 -1
  42. ansys/fluent/core/solver/settings_231/film_mass_flow.py +1 -1
  43. ansys/fluent/core/solver/settings_231/forces.py +4 -4
  44. ansys/fluent/core/solver/settings_231/heat_transfer_1.py +1 -1
  45. ansys/fluent/core/solver/settings_231/heat_transfer_sensible.py +1 -1
  46. ansys/fluent/core/solver/settings_231/mass_flow_1.py +1 -1
  47. ansys/fluent/core/solver/settings_231/mechanical_apdl.py +1 -1
  48. ansys/fluent/core/solver/settings_231/mechanical_apdl_input.py +2 -2
  49. ansys/fluent/core/solver/settings_231/modified_setting.py +1 -1
  50. ansys/fluent/core/solver/settings_231/moments.py +2 -2
  51. ansys/fluent/core/solver/settings_231/number_density.py +2 -2
  52. ansys/fluent/core/solver/settings_231/particle_summary.py +1 -1
  53. ansys/fluent/core/solver/settings_231/position_1.py +1 -1
  54. ansys/fluent/core/solver/settings_231/pressure_work_1.py +1 -1
  55. ansys/fluent/core/solver/settings_231/print_histogram.py +1 -1
  56. ansys/fluent/core/solver/settings_231/projected_surface_area.py +2 -2
  57. ansys/fluent/core/solver/settings_231/rad_heat_trans.py +1 -1
  58. ansys/fluent/core/solver/settings_231/read_journal.py +1 -1
  59. ansys/fluent/core/solver/settings_231/rotate.py +2 -2
  60. ansys/fluent/core/solver/settings_231/sample_1.py +4 -4
  61. ansys/fluent/core/solver/settings_231/set_ambient_color.py +1 -1
  62. ansys/fluent/core/solver/settings_231/set_light.py +2 -2
  63. ansys/fluent/core/solver/settings_231/setup_unsteady_statistics.py +1 -1
  64. ansys/fluent/core/solver/settings_231/surface_integrals.py +1 -1
  65. ansys/fluent/core/solver/settings_231/taitherm.py +1 -1
  66. ansys/fluent/core/solver/settings_231/target.py +1 -1
  67. ansys/fluent/core/solver/settings_231/translate.py +1 -1
  68. ansys/fluent/core/solver/settings_231/up_vector.py +1 -1
  69. ansys/fluent/core/solver/settings_231/update_selected.py +1 -1
  70. ansys/fluent/core/solver/settings_231/viscous_work.py +1 -1
  71. ansys/fluent/core/solver/settings_231/volume_integrals.py +1 -1
  72. ansys/fluent/core/solver/settings_231/write_1.py +1 -1
  73. ansys/fluent/core/solver/settings_231/write_histogram.py +1 -1
  74. ansys/fluent/core/solver/settings_231/write_views.py +1 -1
  75. ansys/fluent/core/solver/tui_231.py +36423 -36423
  76. {ansys_fluent_core-0.14.dev0.dist-info → ansys_fluent_core-0.14.dev2.dist-info}/METADATA +30 -30
  77. {ansys_fluent_core-0.14.dev0.dist-info → ansys_fluent_core-0.14.dev2.dist-info}/RECORD +80 -78
  78. {ansys_fluent_core-0.14.dev0.dist-info → ansys_fluent_core-0.14.dev2.dist-info}/LICENSE +0 -0
  79. {ansys_fluent_core-0.14.dev0.dist-info → ansys_fluent_core-0.14.dev2.dist-info}/WHEEL +0 -0
  80. {ansys_fluent_core-0.14.dev0.dist-info → ansys_fluent_core-0.14.dev2.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,1795 @@
1
+ """Wrappers over Meshing queries gRPC service of Fluent."""
2
+
3
+ from typing import Any, List, Tuple
4
+
5
+ import grpc
6
+
7
+ from ansys.api.fluent.v0 import meshing_queries_pb2 as MeshingQueriesProtoModule
8
+ from ansys.api.fluent.v0 import meshing_queries_pb2_grpc as MeshingQueriesGrpcModule
9
+ from ansys.fluent.core.services.error_handler import catch_grpc_error
10
+ from ansys.fluent.core.services.interceptors import BatchInterceptor, TracingInterceptor
11
+
12
+ Path = List[Tuple[str, str]]
13
+
14
+
15
+ class MeshingQueriesService:
16
+ """
17
+ Meshing Queries Service.
18
+ """
19
+
20
+ def __init__(self, channel: grpc.Channel, metadata: List[Tuple[str, str]]):
21
+ """__init__ method of MeshingQueriesService class."""
22
+ intercept_channel = grpc.intercept_channel(
23
+ channel, TracingInterceptor(), BatchInterceptor()
24
+ )
25
+ self._stub = MeshingQueriesGrpcModule.MeshingQueriesStub(intercept_channel)
26
+ self._metadata = metadata
27
+
28
+ @catch_grpc_error
29
+ def get_face_zone_at_location(
30
+ self, request: MeshingQueriesProtoModule.GetFaceZoneAtLocationRequest
31
+ ) -> MeshingQueriesProtoModule.GetFaceZoneAtLocationResponse:
32
+ """get_face_zone_at_location rpc of MeshingQueriesService."""
33
+ return self._stub.GetFaceZoneAtLocation(request, metadata=self._metadata)
34
+
35
+ @catch_grpc_error
36
+ def get_cell_zone_at_location(
37
+ self, request: MeshingQueriesProtoModule.GetCellZoneAtLocationRequest
38
+ ) -> MeshingQueriesProtoModule.GetCellZoneAtLocationResponse:
39
+ """get_cell_zone_at_location rpc of MeshingQueriesService."""
40
+ return self._stub.GetCellZoneAtLocation(request, metadata=self._metadata)
41
+
42
+ @catch_grpc_error
43
+ def get_zones_of_type(
44
+ self, request: MeshingQueriesProtoModule.GetZonesOfTypeRequest
45
+ ) -> MeshingQueriesProtoModule.GetZonesOfTypeResponse:
46
+ """get_zones_of_type rpc of MeshingQueriesService."""
47
+ return self._stub.GetZonesOfType(request, metadata=self._metadata)
48
+
49
+ @catch_grpc_error
50
+ def get_zones_of_group(
51
+ self, request: MeshingQueriesProtoModule.GetZonesOfGroupRequest
52
+ ) -> MeshingQueriesProtoModule.GetZonesOfGroupResponse:
53
+ """get_zones_of_group rpc of MeshingQueriesService."""
54
+ return self._stub.GetZonesOfGroup(request, metadata=self._metadata)
55
+
56
+ @catch_grpc_error
57
+ def get_face_zones_of_filter(
58
+ self, request: MeshingQueriesProtoModule.GetFaceZonesOfFilterRequest
59
+ ) -> MeshingQueriesProtoModule.GetFaceZonesOfFilterResponse:
60
+ """get_face_zones_of_filter rpc of MeshingQueriesService."""
61
+ return self._stub.GetFaceZonesOfFilter(request, metadata=self._metadata)
62
+
63
+ @catch_grpc_error
64
+ def get_cell_zones_of_filter(
65
+ self, request: MeshingQueriesProtoModule.GetCellZonesOfFilterRequest
66
+ ) -> MeshingQueriesProtoModule.GetCellZonesOfFilterResponse:
67
+ """get_cell_zones_of_filter rpc of MeshingQueriesService."""
68
+ return self._stub.GetCellZonesOfFilter(request, metadata=self._metadata)
69
+
70
+ @catch_grpc_error
71
+ def get_edge_zones_of_filter(
72
+ self, request: MeshingQueriesProtoModule.GetEdgeZonesOfFilterRequest
73
+ ) -> MeshingQueriesProtoModule.GetEdgeZonesOfFilterResponse:
74
+ """get_edge_zones_of_filter rpc of MeshingQueriesService."""
75
+ return self._stub.GetEdgeZonesOfFilter(request, metadata=self._metadata)
76
+
77
+ @catch_grpc_error
78
+ def get_node_zones_of_filter(
79
+ self, request: MeshingQueriesProtoModule.GetNodeZonesOfFilterRequest
80
+ ) -> MeshingQueriesProtoModule.GetNodeZonesOfFilterResponse:
81
+ """get_node_zones_of_filter rpc of MeshingQueriesService."""
82
+ return self._stub.GetNodeZonesOfFilter(request, metadata=self._metadata)
83
+
84
+ @catch_grpc_error
85
+ def get_objects_of_type(
86
+ self, request: MeshingQueriesProtoModule.GetObjectsOfTypeRequest
87
+ ) -> MeshingQueriesProtoModule.GetObjectsOfTypeResponse:
88
+ """get_objects_of_type rpc of MeshingQueriesService."""
89
+ return self._stub.GetObjectsOfType(request, metadata=self._metadata)
90
+
91
+ @catch_grpc_error
92
+ def get_face_zone_id_list_of_object(
93
+ self, request: MeshingQueriesProtoModule.GetFaceZoneIdListOfObjectRequest
94
+ ) -> MeshingQueriesProtoModule.GetFaceZoneIdListOfObjectResponse:
95
+ """get_face_zone_id_list_of_object rpc of MeshingQueriesService."""
96
+ return self._stub.GetFaceZoneIdListOfObject(request, metadata=self._metadata)
97
+
98
+ @catch_grpc_error
99
+ def get_edge_zone_id_list_of_object(
100
+ self, request: MeshingQueriesProtoModule.GetEdgeZoneIdListOfObjectRequest
101
+ ) -> MeshingQueriesProtoModule.GetEdgeZoneIdListOfObjectResponse:
102
+ """get_edge_zone_id_list_of_object rpc of MeshingQueriesService."""
103
+ return self._stub.GetEdgeZoneIdListOfObject(request, metadata=self._metadata)
104
+
105
+ @catch_grpc_error
106
+ def get_cell_zone_id_list_of_object(
107
+ self, request: MeshingQueriesProtoModule.GetCellZoneIdListOfObjectRequest
108
+ ) -> MeshingQueriesProtoModule.GetCellZoneIdListOfObjectResponse:
109
+ """get_cell_zone_id_list_of_object rpc of MeshingQueriesService."""
110
+ return self._stub.GetCellZoneIdListOfObject(request, metadata=self._metadata)
111
+
112
+ @catch_grpc_error
113
+ def get_face_zones_shared_by_regions_of_type(
114
+ self,
115
+ request: MeshingQueriesProtoModule.GetFaceZonesSharedByRegionsOfTypeRequest,
116
+ ) -> MeshingQueriesProtoModule.GetFaceZonesSharedByRegionsOfTypeResponse:
117
+ """get_face_zones_shared_by_regions_of_type rpc of MeshingQueriesService."""
118
+ return self._stub.GetFaceZonesSharedByRegionsOfType(
119
+ request, metadata=self._metadata
120
+ )
121
+
122
+ @catch_grpc_error
123
+ def get_face_zones_of_regions(
124
+ self, request: MeshingQueriesProtoModule.GetFaceZonesOfRegionsRequest
125
+ ) -> MeshingQueriesProtoModule.GetFaceZonesOfRegionsResponse:
126
+ """get_face_zones_of_regions rpc of MeshingQueriesService."""
127
+ return self._stub.GetFaceZonesOfRegions(request, metadata=self._metadata)
128
+
129
+ @catch_grpc_error
130
+ def get_face_zones_of_labels(
131
+ self, request: MeshingQueriesProtoModule.GetFaceZonesOfLabelsRequest
132
+ ) -> MeshingQueriesProtoModule.GetFaceZonesOfLabelsResponse:
133
+ """get_face_zones_of_labels rpc of MeshingQueriesService."""
134
+ return self._stub.GetFaceZonesOfLabels(request, metadata=self._metadata)
135
+
136
+ @catch_grpc_error
137
+ def get_face_zone_id_list_of_labels(
138
+ self,
139
+ request: MeshingQueriesProtoModule.GetFaceZoneIdListOfLabelsRequest,
140
+ ) -> MeshingQueriesProtoModule.GetFaceZoneIdListOfLabelsResponse:
141
+ """get_face_zone_id_list_of_labels rpc of MeshingQueriesService."""
142
+ return self._stub.GetFaceZoneIdListOfLabels(request, metadata=self._metadata)
143
+
144
+ @catch_grpc_error
145
+ def get_face_zones_of_objects(
146
+ self, request: MeshingQueriesProtoModule.GetFaceZonesOfObjectsRequest
147
+ ) -> MeshingQueriesProtoModule.GetFaceZonesOfObjectsResponse:
148
+ """get_face_zones_of_objects rpc of MeshingQueriesService."""
149
+ return self._stub.GetFaceZonesOfObjects(request, metadata=self._metadata)
150
+
151
+ @catch_grpc_error
152
+ def get_edge_zones_of_objects(
153
+ self, request: MeshingQueriesProtoModule.GetEdgeZonesOfObjectsRequest
154
+ ) -> MeshingQueriesProtoModule.GetEdgeZonesOfObjectsResponse:
155
+ """get_edge_zones_of_objects rpc of MeshingQueriesService."""
156
+ return self._stub.GetEdgeZonesOfObjects(request, metadata=self._metadata)
157
+
158
+ @catch_grpc_error
159
+ def get_face_zone_id_list_of_regions(
160
+ self,
161
+ request: MeshingQueriesProtoModule.GetFaceZoneIdListOfRegionsRequest,
162
+ ) -> MeshingQueriesProtoModule.GetFaceZoneIdListOfRegionsResponse:
163
+ """get_face_zone_id_list_of_regions rpc of MeshingQueriesService."""
164
+ return self._stub.GetFaceZoneIdListOfRegions(request, metadata=self._metadata)
165
+
166
+ @catch_grpc_error
167
+ def get_prism_cell_zones(
168
+ self,
169
+ request: MeshingQueriesProtoModule.GetPrismCellZonesRequest,
170
+ ) -> MeshingQueriesProtoModule.GetPrismCellZonesResponse:
171
+ """get_prism_cell_zones rpc of MeshingQueriesService."""
172
+ return self._stub.GetPrismCellZones(request, metadata=self._metadata)
173
+
174
+ @catch_grpc_error
175
+ def get_tet_cell_zones(
176
+ self,
177
+ request: MeshingQueriesProtoModule.GetTetCellZonesRequest,
178
+ ) -> MeshingQueriesProtoModule.GetTetCellZonesResponse:
179
+ """get_tet_cell_zones rpc of MeshingQueriesService."""
180
+ return self._stub.GetTetCellZones(request, metadata=self._metadata)
181
+
182
+ @catch_grpc_error
183
+ def get_adjacent_cell_zones(
184
+ self,
185
+ request: MeshingQueriesProtoModule.GetAdjacentCellZonesRequest,
186
+ ) -> MeshingQueriesProtoModule.GetAdjacentCellZonesResponse:
187
+ """get_adjacent_cell_zones rpc of MeshingQueriesService."""
188
+ return self._stub.GetAdjacentCellZones(request, metadata=self._metadata)
189
+
190
+ @catch_grpc_error
191
+ def get_adjacent_face_zones(
192
+ self,
193
+ request: MeshingQueriesProtoModule.GetAdjacentFaceZonesRequest,
194
+ ) -> MeshingQueriesProtoModule.GetAdjacentFaceZonesResponse:
195
+ """get_adjacent_face_zones rpc of MeshingQueriesService."""
196
+ return self._stub.GetAdjacentFaceZones(request, metadata=self._metadata)
197
+
198
+ @catch_grpc_error
199
+ def get_adjacent_interior_and_boundary_face_zones(
200
+ self,
201
+ request: MeshingQueriesProtoModule.GetAdjacentInteriorAndBoundaryFaceZonesRequest,
202
+ ) -> MeshingQueriesProtoModule.GetAdjacentInteriorAndBoundaryFaceZonesResponse:
203
+ """get_adjacent_interior_and_boundary_face_zones rpc of MeshingQueriesService."""
204
+ return self._stub.GetAdjacentInteriorAndBoundaryFaceZones(
205
+ request, metadata=self._metadata
206
+ )
207
+
208
+ @catch_grpc_error
209
+ def get_adjacent_zones_by_edge_connectivity(
210
+ self,
211
+ request: MeshingQueriesProtoModule.GetAdjacentZonesByEdgeConnectivityRequest,
212
+ ) -> MeshingQueriesProtoModule.GetAdjacentZonesByEdgeConnectivityResponse:
213
+ """get_adjacent_zones_by_edge_connectivity rpc of MeshingQueriesService."""
214
+ return self._stub.GetAdjacentZonesByEdgeConnectivity(
215
+ request, metadata=self._metadata
216
+ )
217
+
218
+ @catch_grpc_error
219
+ def get_adjacent_zones_by_node_connectivity(
220
+ self,
221
+ request: MeshingQueriesProtoModule.GetAdjacentZonesByNodeConnectivityRequest,
222
+ ) -> MeshingQueriesProtoModule.GetAdjacentZonesByNodeConnectivityResponse:
223
+ """get_adjacent_zones_by_node_connectivity rpc of MeshingQueriesService."""
224
+ return self._stub.GetAdjacentZonesByNodeConnectivity(
225
+ request, metadata=self._metadata
226
+ )
227
+
228
+ @catch_grpc_error
229
+ def get_shared_boundary_zones(
230
+ self,
231
+ request: MeshingQueriesProtoModule.GetSharedBoundaryZonesRequest,
232
+ ) -> MeshingQueriesProtoModule.GetSharedBoundaryZonesResponse:
233
+ """get_shared_boundary_zones rpc of MeshingQueriesService."""
234
+ return self._stub.GetSharedBoundaryZones(request, metadata=self._metadata)
235
+
236
+ @catch_grpc_error
237
+ def get_interior_zones_connected_to_cell_zones(
238
+ self,
239
+ request: MeshingQueriesProtoModule.GetInteriorZonesConnectedToCellZonesRequest,
240
+ ) -> MeshingQueriesProtoModule.GetInteriorZonesConnectedToCellZonesResponse:
241
+ """get_interior_zones_connected_to_cell_zones rpc of MeshingQueriesService."""
242
+ return self._stub.GetInteriorZonesConnectedToCellZones(
243
+ request, metadata=self._metadata
244
+ )
245
+
246
+ @catch_grpc_error
247
+ def get_face_zones_with_zone_specific_prisms_applied(
248
+ self,
249
+ request: MeshingQueriesProtoModule.Empty,
250
+ ) -> MeshingQueriesProtoModule.GetFaceZonesWithZoneSpecificPrismsAppliedResponse:
251
+ """get_face_zones_with_zone_specific_prisms_applied rpc of MeshingQueriesService."""
252
+ return self._stub.GetFaceZonesWithZoneSpecificPrismsApplied(
253
+ request, metadata=self._metadata
254
+ )
255
+
256
+ @catch_grpc_error
257
+ def get_face_zones_of_prism_controls(
258
+ self,
259
+ request: MeshingQueriesProtoModule.GetFaceZonesOfPrismControlsRequest,
260
+ ) -> MeshingQueriesProtoModule.GetFaceZonesOfPrismControlsResponse:
261
+ """get_face_zones_of_prism_controls rpc of MeshingQueriesService."""
262
+ return self._stub.GetFaceZonesOfPrismControls(request, metadata=self._metadata)
263
+
264
+ @catch_grpc_error
265
+ def get_baffles(
266
+ self,
267
+ request: MeshingQueriesProtoModule.GetBafflesRequest,
268
+ ) -> MeshingQueriesProtoModule.GetBafflesResponse:
269
+ """get_baffles rpc of MeshingQueriesService."""
270
+ return self._stub.GetBaffles(request, metadata=self._metadata)
271
+
272
+ @catch_grpc_error
273
+ def get_embedded_baffles(
274
+ self,
275
+ request: MeshingQueriesProtoModule.Empty,
276
+ ) -> MeshingQueriesProtoModule.GetEmbeddedBafflesResponse:
277
+ """get_embedded_baffles rpc of MeshingQueriesService."""
278
+ return self._stub.GetEmbeddedBaffles(request, metadata=self._metadata)
279
+
280
+ @catch_grpc_error
281
+ def get_wrapped_zones(
282
+ self,
283
+ request: MeshingQueriesProtoModule.Empty,
284
+ ) -> MeshingQueriesProtoModule.GetWrappedZonesResponse:
285
+ """get_wrapped_zones rpc of MeshingQueriesService."""
286
+ return self._stub.GetWrappedZones(request, metadata=self._metadata)
287
+
288
+ @catch_grpc_error
289
+ def get_unreferenced_edge_zones(
290
+ self,
291
+ request: MeshingQueriesProtoModule.Empty,
292
+ ) -> MeshingQueriesProtoModule.GetUnreferencedEdgeZonesResponse:
293
+ """get_unreferenced_edge_zones rpc of MeshingQueriesService."""
294
+ return self._stub.GetUnreferencedEdgeZones(request, metadata=self._metadata)
295
+
296
+ @catch_grpc_error
297
+ def get_unreferenced_face_zones(
298
+ self,
299
+ request: MeshingQueriesProtoModule.Empty,
300
+ ) -> MeshingQueriesProtoModule.GetUnreferencedFaceZonesResponse:
301
+ """get_unreferenced_face_zones rpc of MeshingQueriesService."""
302
+ return self._stub.GetUnreferencedFaceZones(request, metadata=self._metadata)
303
+
304
+ @catch_grpc_error
305
+ def get_unreferenced_cell_zones(
306
+ self,
307
+ request: MeshingQueriesProtoModule.Empty,
308
+ ) -> MeshingQueriesProtoModule.GetUnreferencedCellZonesResponse:
309
+ """get_unreferenced_cell_zones rpc of MeshingQueriesService."""
310
+ return self._stub.GetUnreferencedCellZones(request, metadata=self._metadata)
311
+
312
+ @catch_grpc_error
313
+ def get_unreferenced_edge_zones_of_filter(
314
+ self,
315
+ request: MeshingQueriesProtoModule.GetUnreferencedEdgeZonesOfFilterRequest,
316
+ ) -> MeshingQueriesProtoModule.GetUnreferencedEdgeZonesOfFilterResponse:
317
+ """get_unreferenced_edge_zones_of_filter rpc of MeshingQueriesService."""
318
+ return self._stub.GetUnreferencedEdgeZonesOfFilter(
319
+ request, metadata=self._metadata
320
+ )
321
+
322
+ @catch_grpc_error
323
+ def get_unreferenced_face_zones_of_filter(
324
+ self,
325
+ request: MeshingQueriesProtoModule.GetUnreferencedFaceZonesOfFilterRequest,
326
+ ) -> MeshingQueriesProtoModule.GetUnreferencedFaceZonesOfFilterResponse:
327
+ """get_unreferenced_face_zones_of_filter rpc of MeshingQueriesService."""
328
+ return self._stub.GetUnreferencedFaceZonesOfFilter(
329
+ request, metadata=self._metadata
330
+ )
331
+
332
+ @catch_grpc_error
333
+ def get_unreferenced_cell_zones_of_filter(
334
+ self,
335
+ request: MeshingQueriesProtoModule.GetUnreferencedCellZonesOfFilterRequest,
336
+ ) -> MeshingQueriesProtoModule.GetUnreferencedCellZonesOfFilterResponse:
337
+ """get_unreferenced_cell_zones_of_filter rpc of MeshingQueriesService."""
338
+ return self._stub.GetUnreferencedCellZonesOfFilter(
339
+ request, metadata=self._metadata
340
+ )
341
+
342
+ @catch_grpc_error
343
+ def get_unreferenced_edge_zone_id_list_of_pattern(
344
+ self,
345
+ request: MeshingQueriesProtoModule.GetUnreferencedEdgeZoneIdListOfPatternRequest,
346
+ ) -> MeshingQueriesProtoModule.GetUnreferencedEdgeZoneIdListOfPatternResponse:
347
+ """get_unreferenced_edge_zone_id_list_of_pattern rpc of MeshingQueriesService."""
348
+ return self._stub.GetUnreferencedEdgeZoneIdListOfPattern(
349
+ request, metadata=self._metadata
350
+ )
351
+
352
+ @catch_grpc_error
353
+ def get_unreferenced_face_zone_id_list_of_pattern(
354
+ self,
355
+ request: MeshingQueriesProtoModule.GetUnreferencedFaceZoneIdListOfPatternRequest,
356
+ ) -> MeshingQueriesProtoModule.GetUnreferencedFaceZoneIdListOfPatternResponse:
357
+ """get_unreferenced_face_zone_id_list_of_pattern rpc of MeshingQueriesService."""
358
+ return self._stub.GetUnreferencedFaceZoneIdListOfPattern(
359
+ request, metadata=self._metadata
360
+ )
361
+
362
+ @catch_grpc_error
363
+ def get_unreferenced_cell_zone_id_list_of_pattern(
364
+ self,
365
+ request: MeshingQueriesProtoModule.GetUnreferencedCellZoneIdListOfPatternRequest,
366
+ ) -> MeshingQueriesProtoModule.GetUnreferencedCellZoneIdListOfPatternResponse:
367
+ """get_unreferenced_cell_zone_id_list_of_pattern rpc of MeshingQueriesService."""
368
+ return self._stub.GetUnreferencedCellZoneIdListOfPattern(
369
+ request, metadata=self._metadata
370
+ )
371
+
372
+ @catch_grpc_error
373
+ def get_maxsize_cell_zone_by_volume(
374
+ self,
375
+ request: MeshingQueriesProtoModule.GetMaxsizeCellZoneByVolumeRequest,
376
+ ) -> MeshingQueriesProtoModule.GetMaxsizeCellZoneByVolumeResponse:
377
+ """get_maxsize_cell_zone_by_volume rpc of MeshingQueriesService."""
378
+ return self._stub.GetMaxsizeCellZoneByVolume(request, metadata=self._metadata)
379
+
380
+ @catch_grpc_error
381
+ def get_maxsize_cell_zone_by_count(
382
+ self,
383
+ request: MeshingQueriesProtoModule.GetMaxsizeCellZoneByCountRequest,
384
+ ) -> MeshingQueriesProtoModule.GetMaxsizeCellZoneByCountResponse:
385
+ """get_maxsize_cell_zone_by_count rpc of MeshingQueriesService."""
386
+ return self._stub.GetMaxsizeCellZoneByCount(request, metadata=self._metadata)
387
+
388
+ @catch_grpc_error
389
+ def get_minsize_face_zone_by_area(
390
+ self,
391
+ request: MeshingQueriesProtoModule.GetMinsizeFaceZoneByAreaRequest,
392
+ ) -> MeshingQueriesProtoModule.GetMinsizeFaceZoneByAreaResponse:
393
+ """get_minsize_face_zone_by_area rpc of MeshingQueriesService."""
394
+ return self._stub.GetMinsizeFaceZoneByArea(request, metadata=self._metadata)
395
+
396
+ @catch_grpc_error
397
+ def get_minsize_face_zone_by_count(
398
+ self,
399
+ request: MeshingQueriesProtoModule.GetMinsizeFaceZoneByCountRequest,
400
+ ) -> MeshingQueriesProtoModule.GetMinsizeFaceZoneByCountResponse:
401
+ """get_minsize_face_zone_by_count rpc of MeshingQueriesService."""
402
+ return self._stub.GetMinsizeFaceZoneByCount(request, metadata=self._metadata)
403
+
404
+ @catch_grpc_error
405
+ def get_face_zone_list_by_maximum_entity_count(
406
+ self,
407
+ request: MeshingQueriesProtoModule.GetFaceZoneListByMaximumEntityCountRequest,
408
+ ) -> MeshingQueriesProtoModule.GetFaceZoneListByMaximumEntityCountResponse:
409
+ """get_face_zone_list_by_maximum_entity_count rpc of MeshingQueriesService."""
410
+ return self._stub.GetFaceZoneListByMaximumEntityCount(
411
+ request, metadata=self._metadata
412
+ )
413
+
414
+ @catch_grpc_error
415
+ def get_edge_zone_list_by_maximum_entity_count(
416
+ self,
417
+ request: MeshingQueriesProtoModule.GetEdgeZoneListByMaximumEntityCountRequest,
418
+ ) -> MeshingQueriesProtoModule.GetEdgeZoneListByMaximumEntityCountResponse:
419
+ """get_edge_zone_list_by_maximum_entity_count rpc of MeshingQueriesService."""
420
+ return self._stub.GetEdgeZoneListByMaximumEntityCount(
421
+ request, metadata=self._metadata
422
+ )
423
+
424
+ @catch_grpc_error
425
+ def get_cell_zone_list_by_maximum_entity_count(
426
+ self,
427
+ request: MeshingQueriesProtoModule.GetCellZoneListByMaximumEntityCountRequest,
428
+ ) -> MeshingQueriesProtoModule.GetCellZoneListByMaximumEntityCountResponse:
429
+ """get_cell_zone_list_by_maximum_entity_count rpc of MeshingQueriesService."""
430
+ return self._stub.GetCellZoneListByMaximumEntityCount(
431
+ request, metadata=self._metadata
432
+ )
433
+
434
+ @catch_grpc_error
435
+ def get_face_zone_list_by_maximum_zone_area(
436
+ self,
437
+ request: MeshingQueriesProtoModule.GetFaceZoneListByMaximumZoneAreaRequest,
438
+ ) -> MeshingQueriesProtoModule.GetFaceZoneListByMaximumZoneAreaResponse:
439
+ """get_face_zone_list_by_maximum_zone_area rpc of MeshingQueriesService."""
440
+ return self._stub.GetFaceZoneListByMaximumZoneArea(
441
+ request, metadata=self._metadata
442
+ )
443
+
444
+ @catch_grpc_error
445
+ def get_face_zone_list_by_minimum_zone_area(
446
+ self,
447
+ request: MeshingQueriesProtoModule.GetFaceZoneListByMinimumZoneAreaRequest,
448
+ ) -> MeshingQueriesProtoModule.GetFaceZoneListByMinimumZoneAreaResponse:
449
+ """get_face_zone_list_by_minimum_zone_area rpc of MeshingQueriesService."""
450
+ return self._stub.GetFaceZoneListByMinimumZoneArea(
451
+ request, metadata=self._metadata
452
+ )
453
+
454
+ @catch_grpc_error
455
+ def get_zones_with_free_faces(
456
+ self,
457
+ request: MeshingQueriesProtoModule.GetZonesWithFreeFacesRequest,
458
+ ) -> MeshingQueriesProtoModule.GetZonesWithFreeFacesResponse:
459
+ """get_zones_with_free_faces rpc of MeshingQueriesService."""
460
+ return self._stub.GetZonesWithFreeFaces(request, metadata=self._metadata)
461
+
462
+ @catch_grpc_error
463
+ def get_zones_with_free_faces(
464
+ self,
465
+ request: MeshingQueriesProtoModule.GetZonesWithFreeFacesRequest,
466
+ ) -> MeshingQueriesProtoModule.GetZonesWithFreeFacesResponse:
467
+ """get_zones_with_free_faces rpc of MeshingQueriesService."""
468
+ return self._stub.GetZonesWithFreeFaces(request, metadata=self._metadata)
469
+
470
+ @catch_grpc_error
471
+ def get_zones_with_multi_faces(
472
+ self,
473
+ request: MeshingQueriesProtoModule.GetZonesWithMultiFacesRequest,
474
+ ) -> MeshingQueriesProtoModule.GetZonesWithMultiFacesResponse:
475
+ """get_zones_with_multi_faces rpc of MeshingQueriesService."""
476
+ return self._stub.GetZonesWithMultiFaces(request, metadata=self._metadata)
477
+
478
+ @catch_grpc_error
479
+ def get_overlapping_face_zones(
480
+ self,
481
+ request: MeshingQueriesProtoModule.GetOverlappingFaceZonesRequest,
482
+ ) -> MeshingQueriesProtoModule.GetOverlappingFaceZonesResponse:
483
+ """get_overlapping_face_zones rpc of MeshingQueriesService."""
484
+ return self._stub.GetOverlappingFaceZones(request, metadata=self._metadata)
485
+
486
+ @catch_grpc_error
487
+ def get_zones_with_multi_faces(
488
+ self,
489
+ request: MeshingQueriesProtoModule.GetZonesWithMultiFacesRequest,
490
+ ) -> MeshingQueriesProtoModule.GetZonesWithMultiFacesResponse:
491
+ """get_zones_with_multi_faces rpc of MeshingQueriesService."""
492
+ return self._stub.GetZonesWithMultiFaces(request, metadata=self._metadata)
493
+
494
+ @catch_grpc_error
495
+ def get_zones_with_marked_faces(
496
+ self,
497
+ request: MeshingQueriesProtoModule.GetZonesWithMarkedFacesRequest,
498
+ ) -> MeshingQueriesProtoModule.GetZonesWithMarkedFacesResponse:
499
+ """get_zones_with_marked_faces rpc of MeshingQueriesService."""
500
+ return self._stub.GetZonesWithMarkedFaces(request, metadata=self._metadata)
501
+
502
+ @catch_grpc_error
503
+ def get_all_object_name_list(
504
+ self,
505
+ request: MeshingQueriesProtoModule.Empty,
506
+ ) -> MeshingQueriesProtoModule.GetAllObjectNameListResponse:
507
+ """get_all_object_name_list rpc of MeshingQueriesService."""
508
+ return self._stub.GetAllObjectNameList(request, metadata=self._metadata)
509
+
510
+ @catch_grpc_error
511
+ def get_object_name_list_of_type(
512
+ self,
513
+ request: MeshingQueriesProtoModule.GetObjectNameListOfTypeRequest,
514
+ ) -> MeshingQueriesProtoModule.GetObjectNameListOfTypeResponse:
515
+ """get_object_name_list_of_type rpc of MeshingQueriesService."""
516
+ return self._stub.GetObjectNameListOfType(request, metadata=self._metadata)
517
+
518
+ @catch_grpc_error
519
+ def get_objects_of_filter(
520
+ self,
521
+ request: MeshingQueriesProtoModule.GetObjectsOfFilterRequest,
522
+ ) -> MeshingQueriesProtoModule.GetObjectsOfFilterResponse:
523
+ """get_objects_of_filter rpc of MeshingQueriesService."""
524
+ return self._stub.GetObjectsOfFilter(request, metadata=self._metadata)
525
+
526
+ @catch_grpc_error
527
+ def get_regions_of_object(
528
+ self,
529
+ request: MeshingQueriesProtoModule.GetRegionsOfObjectRequest,
530
+ ) -> MeshingQueriesProtoModule.GetRegionsOfObjectResponse:
531
+ """get_regions_of_object rpc of MeshingQueriesService."""
532
+ return self._stub.GetRegionsOfObject(request, metadata=self._metadata)
533
+
534
+ @catch_grpc_error
535
+ def get_region_name_list_of_object(
536
+ self,
537
+ request: MeshingQueriesProtoModule.GetRegionNameListOfObjectRequest,
538
+ ) -> MeshingQueriesProtoModule.GetRegionNameListOfObjectResponse:
539
+ """get_region_name_list_of_object rpc of MeshingQueriesService."""
540
+ return self._stub.GetRegionNameListOfObject(request, metadata=self._metadata)
541
+
542
+ @catch_grpc_error
543
+ def sort_regions_by_volume(
544
+ self,
545
+ request: MeshingQueriesProtoModule.SortRegionsByVolumeRequest,
546
+ ) -> MeshingQueriesProtoModule.SortRegionsByVolumeResponse:
547
+ """sort_regions_by_volume rpc of MeshingQueriesService."""
548
+ return self._stub.SortRegionsByVolume(request, metadata=self._metadata)
549
+
550
+ @catch_grpc_error
551
+ def get_region_volume(
552
+ self,
553
+ request: MeshingQueriesProtoModule.GetRegionVolumeRequest,
554
+ ) -> MeshingQueriesProtoModule.GetRegionVolumeResponse:
555
+ """get_region_volume rpc of MeshingQueriesService."""
556
+ return self._stub.GetRegionVolume(request, metadata=self._metadata)
557
+
558
+ @catch_grpc_error
559
+ def get_regions_of_filter(
560
+ self,
561
+ request: MeshingQueriesProtoModule.GetRegionsOfFilterRequest,
562
+ ) -> MeshingQueriesProtoModule.GetRegionsOfFilterResponse:
563
+ """get_regions_of_filter rpc of MeshingQueriesService."""
564
+ return self._stub.GetRegionsOfFilter(request, metadata=self._metadata)
565
+
566
+ @catch_grpc_error
567
+ def get_region_name_list_of_pattern(
568
+ self,
569
+ request: MeshingQueriesProtoModule.GetRegionNameListOfPatternRequest,
570
+ ) -> MeshingQueriesProtoModule.GetRegionNameListOfPatternResponse:
571
+ """get_region_name_list_of_pattern rpc of MeshingQueriesService."""
572
+ return self._stub.GetRegionNameListOfPattern(request, metadata=self._metadata)
573
+
574
+ @catch_grpc_error
575
+ def get_regions_of_face_zones(
576
+ self,
577
+ request: MeshingQueriesProtoModule.GetRegionsOfFaceZonesRequest,
578
+ ) -> MeshingQueriesProtoModule.GetRegionsOfFaceZonesResponse:
579
+ """get_regions_of_face_zones rpc of MeshingQueriesService."""
580
+ return self._stub.GetRegionsOfFaceZones(request, metadata=self._metadata)
581
+
582
+ @catch_grpc_error
583
+ def find_join_pairs(
584
+ self,
585
+ request: MeshingQueriesProtoModule.FindJoinPairsRequest,
586
+ ) -> MeshingQueriesProtoModule.FindJoinPairsResponse:
587
+ """find_join_pairs rpc of MeshingQueriesService."""
588
+ return self._stub.FindJoinPairs(request, metadata=self._metadata)
589
+
590
+ @catch_grpc_error
591
+ def get_region_name_list_of_face_zones(
592
+ self,
593
+ request: MeshingQueriesProtoModule.GetRegionNameListOfFaceZonesRequest,
594
+ ) -> MeshingQueriesProtoModule.GetRegionNameListOfFaceZonesResponse:
595
+ """get_region_name_list_of_face_zones rpc of MeshingQueriesService."""
596
+ return self._stub.GetRegionNameListOfFaceZones(request, metadata=self._metadata)
597
+
598
+
599
+ class MeshingQueries:
600
+ """
601
+ Meshing Queries.
602
+ """
603
+
604
+ def __init__(self, service: MeshingQueriesService):
605
+ """__init__ method of MeshingQueries class."""
606
+ self.service = service
607
+ self.region_types = ["fluid-fluid", "solid-solid", "fluid-solid"]
608
+ self.orders = ["ascending", "descending"]
609
+
610
+ docstring = None
611
+
612
+ def get_allowed_region_type(self, region_type):
613
+ if region_type not in self.region_types:
614
+ raise ValueError(f"Allowed region types - {self.region_types}\n")
615
+
616
+ def get_allowed_orders(self, order):
617
+ if order not in self.orders:
618
+ raise ValueError(f"Allowed orders - {self.orders}\n")
619
+
620
+ def get_all_object_name_list(self) -> Any:
621
+ """
622
+ Return a list of all objects.
623
+
624
+ .. code-block:: python
625
+
626
+ >>> meshing_session.meshing_queries.get_all_object_name_list()
627
+
628
+ """
629
+ request = MeshingQueriesProtoModule.Empty()
630
+ response = self.service.get_all_object_name_list(request)
631
+ return response.objects
632
+
633
+ def get_allowed_object(self, object):
634
+ allowed_args = [args for args in self.get_all_object_name_list()]
635
+ if isinstance(object, list):
636
+ for obj in object:
637
+ if obj not in allowed_args:
638
+ raise ValueError(f"Allowed objects - {allowed_args}\n")
639
+ elif isinstance(object, str):
640
+ if object not in allowed_args:
641
+ raise ValueError(f"Allowed objects - {allowed_args}\n")
642
+
643
+ def get_region_name_list_of_object(self, object) -> Any:
644
+ """
645
+ Return a list of regions in the specified object.
646
+
647
+ .. code-block:: python
648
+
649
+ >>> meshing_session.meshing_queries.get_region_name_list_of_object("elbow-fluid")
650
+
651
+ """
652
+ self.get_allowed_object(object)
653
+ request = MeshingQueriesProtoModule.GetRegionNameListOfObjectRequest()
654
+ request.object = object
655
+ response = self.service.get_region_name_list_of_object(request)
656
+ return response.regions
657
+
658
+ def get_allowed_region(self, region):
659
+ objects = [objs for objs in self.get_all_object_name_list()]
660
+ regions = []
661
+ for obj in objects:
662
+ regions.extend(self.get_region_name_list_of_object(obj))
663
+ if isinstance(region, list):
664
+ for reg in region:
665
+ if reg not in regions:
666
+ raise ValueError(f"Allowed regions - {regions}\n")
667
+ elif isinstance(region, str):
668
+ if region not in regions:
669
+ raise ValueError(f"Allowed regions - {regions}\n")
670
+
671
+ def get_face_zone_at_location(self, location) -> Any:
672
+ """
673
+ Return face zone at or closest to a specified location.
674
+
675
+ Note: This function is not applicable to polyhedral meshes.
676
+
677
+ .. code-block:: python
678
+
679
+ >>> meshing_session.meshing_queries.get_face_zone_at_location([1.4, 1.4, 1.4])
680
+
681
+ """
682
+ request = MeshingQueriesProtoModule.GetFaceZoneAtLocationRequest()
683
+ request.location.x = location[0]
684
+ request.location.y = location[1]
685
+ request.location.z = location[2]
686
+ response = self.service.get_face_zone_at_location(request)
687
+ return response.face_zone_id
688
+
689
+ def get_cell_zone_at_location(self, location) -> Any:
690
+ """
691
+ Return cell zone at or closest to a specified location.
692
+
693
+ .. code-block:: python
694
+
695
+ >>> meshing_session.meshing_queries.get_cell_zone_at_location([1.4, 1.4, 1.4])
696
+
697
+ """
698
+ request = MeshingQueriesProtoModule.GetCellZoneAtLocationRequest()
699
+ request.location.x = location[0]
700
+ request.location.y = location[1]
701
+ request.location.z = location[2]
702
+ response = self.service.get_cell_zone_at_location(request)
703
+ return response.cell_zone_id
704
+
705
+ def get_zones_of_type(self, type) -> Any:
706
+ """
707
+ Return a list of zones of the specified default zone type.
708
+
709
+ .. code-block:: python
710
+
711
+ >>> meshing_session.meshing_queries.get_zones_of_type("velocity-inlet")
712
+
713
+ """
714
+ request = MeshingQueriesProtoModule.GetZonesOfTypeRequest()
715
+ request.type = type
716
+ response = self.service.get_zones_of_type(request)
717
+ return response.zone_ids
718
+
719
+ def get_zones_of_group(self, group) -> Any:
720
+ """
721
+ Return a list of zones of the specified default zone group or user-defined group.
722
+
723
+ .. code-block:: python
724
+
725
+ >>> meshing_session.meshing_queries.get_zones_of_group("inlet")
726
+
727
+ """
728
+ request = MeshingQueriesProtoModule.GetZonesOfGroupRequest()
729
+ request.group = group
730
+ response = self.service.get_zones_of_group(request)
731
+ return response.zone_ids
732
+
733
+ def get_face_zones_of_filter(self, filter) -> Any:
734
+ """
735
+ Return a list of face zones whose names contain the specified filter string.
736
+
737
+ .. code-block:: python
738
+
739
+ >>> meshing_session.meshing_queries.get_face_zones_of_filter("*")
740
+
741
+ """
742
+ request = MeshingQueriesProtoModule.GetFaceZonesOfFilterRequest()
743
+ request.filter = filter
744
+ response = self.service.get_face_zones_of_filter(request)
745
+ return response.face_zone_ids
746
+
747
+ def get_cell_zones_of_filter(self, filter) -> Any:
748
+ """
749
+ Return a list of cell zones whose names contain the specified filter string.
750
+
751
+ .. code-block:: python
752
+
753
+ >>> meshing_session.meshing_queries.get_cell_zones_of_filter("*")
754
+
755
+ """
756
+ request = MeshingQueriesProtoModule.GetCellZonesOfFilterRequest()
757
+ request.filter = filter
758
+ response = self.service.get_cell_zones_of_filter(request)
759
+ return response.cell_zone_ids
760
+
761
+ def get_edge_zones_of_filter(self, filter) -> Any:
762
+ """
763
+ Return a list of edge zones whose names contain the specified filter string.
764
+
765
+ .. code-block:: python
766
+
767
+ >>> meshing_session.meshing_queries.get_edge_zones_of_filter("*")
768
+
769
+ """
770
+ request = MeshingQueriesProtoModule.GetEdgeZonesOfFilterRequest()
771
+ request.filter = filter
772
+ response = self.service.get_edge_zones_of_filter(request)
773
+ return response.edge_zone_ids
774
+
775
+ def get_node_zones_of_filter(self, filter) -> Any:
776
+ """
777
+ Return a list of node zones whose names contain the specified filter string.
778
+
779
+ .. code-block:: python
780
+
781
+ >>> meshing_session.meshing_queries.get_node_zones_of_filter("*")
782
+
783
+ """
784
+ request = MeshingQueriesProtoModule.GetNodeZonesOfFilterRequest()
785
+ request.filter = filter
786
+ response = self.service.get_node_zones_of_filter(request)
787
+ return response.node_zone_ids
788
+
789
+ def get_objects_of_type(self, type) -> Any:
790
+ """
791
+ Return a list of objects of the specified type.
792
+
793
+ .. code-block:: python
794
+
795
+ >>> meshing_session.meshing_queries.get_objects_of_type("mesh")
796
+
797
+ """
798
+ request = MeshingQueriesProtoModule.GetObjectsOfTypeRequest()
799
+ request.type = type
800
+ response = self.service.get_objects_of_type(request)
801
+ return response.objects
802
+
803
+ def get_face_zone_id_list_of_object(self, object) -> Any:
804
+ """
805
+ Return a list of face zones by ID in the specified face zone labels of an object.
806
+
807
+ .. code-block:: python
808
+
809
+ >>> meshing_session.meshing_queries.get_face_zone_id_list_of_object("elbow-fluid")
810
+
811
+ """
812
+ self.get_allowed_object(object)
813
+ request = MeshingQueriesProtoModule.GetFaceZoneIdListOfObjectRequest()
814
+ request.object = object
815
+ response = self.service.get_face_zone_id_list_of_object(request)
816
+ return response.face_zone_ids
817
+
818
+ def get_edge_zone_id_list_of_object(self, object) -> Any:
819
+ """
820
+ Return a list of edge zones by ID in the specified face zone labels of an object
821
+
822
+ .. code-block:: python
823
+
824
+ >>> meshing_session.meshing_queries.get_edge_zone_id_list_of_object("elbow-fluid")
825
+
826
+ """
827
+ self.get_allowed_object(object)
828
+ request = MeshingQueriesProtoModule.GetEdgeZoneIdListOfObjectRequest()
829
+ request.object = object
830
+ response = self.service.get_edge_zone_id_list_of_object(request)
831
+ return response.edge_zone_ids
832
+
833
+ def get_cell_zone_id_list_of_object(self, object) -> Any:
834
+ """
835
+ Return a list of cell zones by ID in the specified face zone labels of an object.
836
+
837
+ .. code-block:: python
838
+
839
+ >>> meshing_session.meshing_queries.get_cell_zone_id_list_of_object("elbow-fluid")
840
+
841
+ """
842
+ self.get_allowed_object(object)
843
+ request = MeshingQueriesProtoModule.GetCellZoneIdListOfObjectRequest()
844
+ request.object = object
845
+ response = self.service.get_cell_zone_id_list_of_object(request)
846
+ return response.cell_zone_ids
847
+
848
+ def get_face_zones_shared_by_regions_of_type(self, mesh_object, region_type) -> Any:
849
+ """
850
+ Return a list of face zones shared by regions of specified types in the mesh object specified,
851
+ where region-type is fluid-fluid, solid-solid, or fluid-solid.
852
+
853
+ .. code-block:: python
854
+
855
+ >>> meshing_session.meshing_queries.get_face_zones_shared_by_regions_of_type("elbow-fluid", "fluid-fluid")
856
+
857
+ """
858
+ self.get_allowed_object(mesh_object)
859
+ self.get_allowed_region_type(region_type)
860
+ request = MeshingQueriesProtoModule.GetFaceZonesSharedByRegionsOfTypeRequest()
861
+ request.mesh_object = mesh_object
862
+ request.region_type = region_type
863
+ response = self.service.get_face_zones_shared_by_regions_of_type(request)
864
+ return response.shared_face_zone_ids
865
+
866
+ def get_face_zones_of_regions(self, object, region_name_list) -> Any:
867
+ """
868
+ Return a list of face zones in the specified regions.
869
+
870
+ .. code-block:: python
871
+
872
+ >>> meshing_session.meshing_queries.get_face_zones_of_regions("elbow-fluid", ["fluid"])
873
+
874
+ """
875
+ self.get_allowed_object(object)
876
+ self.get_allowed_region(region_name_list)
877
+ request = MeshingQueriesProtoModule.GetFaceZonesOfRegionsRequest()
878
+ request.object = object
879
+ for region in region_name_list:
880
+ request.regions.append(region)
881
+ response = self.service.get_face_zones_of_regions(request)
882
+ return response.zone_ids
883
+
884
+ def get_face_zones_of_labels(self, object, label_name_list) -> Any:
885
+ """
886
+ Return a list of face zones in the specified face zone labels of the object specified.
887
+
888
+ .. code-block:: python
889
+
890
+ >>> meshing_session.meshing_queries.get_face_zones_of_labels("elbow-fluid", ["inlet", "outlet", "wall", "internal"])
891
+
892
+ """
893
+ request = MeshingQueriesProtoModule.GetFaceZonesOfLabelsRequest()
894
+ request.object = object
895
+ for label in label_name_list:
896
+ request.labels.append(label)
897
+ response = self.service.get_face_zones_of_labels(request)
898
+ return response.zone_ids
899
+
900
+ def get_face_zone_id_list_of_labels(self, object, zone_label_list) -> Any:
901
+ """
902
+ Return a list of face zones by ID in the specified face zone labels of an object.
903
+
904
+ .. code-block:: python
905
+
906
+ >>> meshing_session.meshing_queries.get_face_zone_id_list_of_labels("elbow-fluid", ["outlet"])
907
+
908
+ """
909
+ request = MeshingQueriesProtoModule.GetFaceZoneIdListOfLabelsRequest()
910
+ request.object = object
911
+ for zone_label in zone_label_list:
912
+ request.labels.append(zone_label)
913
+ response = self.service.get_face_zone_id_list_of_labels(request)
914
+ return response.zone_ids
915
+
916
+ def get_face_zones_of_objects(self, object_list) -> Any:
917
+ """
918
+ Return a list of face zones in the specified objects.
919
+
920
+ .. code-block:: python
921
+
922
+ >>> meshing_session.meshing_queries.get_face_zones_of_objects(["elbow-fluid"])
923
+
924
+ """
925
+ self.get_allowed_object(object_list)
926
+ request = MeshingQueriesProtoModule.GetFaceZonesOfObjectsRequest()
927
+ for object in object_list:
928
+ request.object_list.append(object)
929
+ response = self.service.get_face_zones_of_objects(request)
930
+ return response.face_zone_ids
931
+
932
+ def get_edge_zones_of_objects(self, object_list) -> Any:
933
+ """
934
+ Return a list of edge zones in the specified objects.
935
+
936
+ .. code-block:: python
937
+
938
+ >>> meshing_session.meshing_queries.get_edge_zones_of_objects(["elbow-fluid"])
939
+
940
+ """
941
+ self.get_allowed_object(object_list)
942
+ request = MeshingQueriesProtoModule.GetEdgeZonesOfObjectsRequest()
943
+ for object in object_list:
944
+ request.object_list.append(object)
945
+ response = self.service.get_edge_zones_of_objects(request)
946
+ return response.edge_zone_ids
947
+
948
+ def get_face_zone_id_list_of_regions(self, object, region_list) -> Any:
949
+ """
950
+ Return a list of face zones by ID in the specified regions of an object.
951
+
952
+ .. code-block:: python
953
+
954
+ >>> meshing_session.meshing_queries.get_face_zone_id_list_of_regions("elbow-fluid", ["fluid"])
955
+
956
+ """
957
+ self.get_allowed_object(object)
958
+ self.get_allowed_region(region_list)
959
+ request = MeshingQueriesProtoModule.GetFaceZoneIdListOfRegionsRequest()
960
+ request.object = object
961
+ for region in region_list:
962
+ request.labels.append(region)
963
+ response = self.service.get_face_zone_id_list_of_regions(request)
964
+ return response.zone_ids
965
+
966
+ def get_prism_cell_zones(self, list_or_pattern) -> Any:
967
+ """
968
+ Return a list of prism cell zones.
969
+
970
+ .. code-block:: python
971
+
972
+ >>> meshing_session.meshing_queries.get_prism_cell_zones(["inlet", "outlet"])
973
+
974
+ >>> meshing_session.meshing_queries.get_prism_cell_zones("*")
975
+
976
+ """
977
+ request = MeshingQueriesProtoModule.GetPrismCellZonesRequest()
978
+ if isinstance(list_or_pattern, str):
979
+ request.zone_name_or_pattern = list_or_pattern
980
+ elif isinstance(list_or_pattern, list):
981
+ for items in list_or_pattern:
982
+ request.zones.append(items)
983
+ response = self.service.get_prism_cell_zones(request)
984
+ return response.prism_cell_zones
985
+
986
+ def get_tet_cell_zones(self, list_or_pattern) -> Any:
987
+ """
988
+ Return a list of tet cell zones.
989
+
990
+ .. code-block:: python
991
+
992
+ >>> meshing_session.meshing_queries.get_tet_cell_zones(["inlet", "outlet"])
993
+
994
+ >>> meshing_session.meshing_queries.get_tet_cell_zones("*")
995
+
996
+ """
997
+ request = MeshingQueriesProtoModule.GetTetCellZonesRequest()
998
+ if isinstance(list_or_pattern, str):
999
+ request.zone_name_or_pattern = list_or_pattern
1000
+ elif isinstance(list_or_pattern, list):
1001
+ for items in list_or_pattern:
1002
+ request.zones.append(items)
1003
+ response = self.service.get_tet_cell_zones(request)
1004
+ return response.tet_cell_zones
1005
+
1006
+ def get_adjacent_cell_zones(self, list_or_name_or_pattern) -> Any:
1007
+ """
1008
+ Return adjacent cell zones for given face zone
1009
+
1010
+ .. code-block:: python
1011
+
1012
+ >>> meshing_session.meshing_queries.get_adjacent_cell_zones([30])
1013
+
1014
+ >>> meshing_session.meshing_queries.get_adjacent_cell_zones("*")
1015
+
1016
+ """
1017
+ request = MeshingQueriesProtoModule.GetAdjacentCellZonesRequest()
1018
+ if isinstance(list_or_name_or_pattern, str):
1019
+ request.zone_name_or_pattern = list_or_name_or_pattern
1020
+ elif isinstance(list_or_name_or_pattern, list):
1021
+ for items in list_or_name_or_pattern:
1022
+ request.face_zone_ids.append(items)
1023
+ response = self.service.get_adjacent_cell_zones(request)
1024
+ return response.adjacent_cell_zones
1025
+
1026
+ def get_adjacent_face_zones(self, list_or_name_or_pattern) -> Any:
1027
+ """
1028
+ Return adjacent boundary face zones for given cell zones.
1029
+
1030
+ .. code-block:: python
1031
+
1032
+ >>> meshing_session.meshing_queries.get_adjacent_face_zones([3460])
1033
+
1034
+ >>> meshing_session.meshing_queries.get_adjacent_face_zones("*")
1035
+
1036
+ """
1037
+ request = MeshingQueriesProtoModule.GetAdjacentFaceZonesRequest()
1038
+ if isinstance(list_or_name_or_pattern, str):
1039
+ request.zone_name_or_pattern = list_or_name_or_pattern
1040
+ elif isinstance(list_or_name_or_pattern, list):
1041
+ for items in list_or_name_or_pattern:
1042
+ request.cell_zone_ids.append(items)
1043
+ response = self.service.get_adjacent_face_zones(request)
1044
+ return response.adjacent_boundary_face_zones
1045
+
1046
+ def get_adjacent_interior_and_boundary_face_zones(
1047
+ self, list_or_name_or_pattern
1048
+ ) -> Any:
1049
+ """
1050
+ Return adjacent interior and boundary face zones for given cell zones.
1051
+
1052
+ .. code-block:: python
1053
+
1054
+ >>> meshing_session.meshing_queries.get_adjacent_interior_and_boundary_face_zones([30])
1055
+
1056
+ >>> meshing_session.meshing_queries.get_adjacent_interior_and_boundary_face_zones("fluid")
1057
+
1058
+ >>> meshing_session.meshing_queries.get_adjacent_interior_and_boundary_face_zones("*")
1059
+
1060
+ """
1061
+ request = (
1062
+ MeshingQueriesProtoModule.GetAdjacentInteriorAndBoundaryFaceZonesRequest()
1063
+ )
1064
+ if isinstance(list_or_name_or_pattern, str):
1065
+ request.zone_name_or_pattern = list_or_name_or_pattern
1066
+ elif isinstance(list_or_name_or_pattern, list):
1067
+ for items in list_or_name_or_pattern:
1068
+ request.cell_zone_ids.append(items)
1069
+ response = self.service.get_adjacent_interior_and_boundary_face_zones(request)
1070
+ return response.adjacent_interior_and_boundary_face_zones
1071
+
1072
+ def get_adjacent_zones_by_edge_connectivity(self, list_or_name_or_pattern) -> Any:
1073
+ """
1074
+ Return adjacent zones based on edge connectivity
1075
+
1076
+ .. code-block:: python
1077
+
1078
+ >>> meshing_session.meshing_queries.get_adjacent_zones_by_edge_connectivity([30])
1079
+
1080
+ >>> meshing_session.meshing_queries.get_adjacent_zones_by_edge_connectivity("*")
1081
+
1082
+ """
1083
+ request = MeshingQueriesProtoModule.GetAdjacentZonesByEdgeConnectivityRequest()
1084
+ if isinstance(list_or_name_or_pattern, str):
1085
+ request.zone_name_or_pattern = list_or_name_or_pattern
1086
+ elif isinstance(list_or_name_or_pattern, list):
1087
+ for items in list_or_name_or_pattern:
1088
+ request.zone_ids.append(items)
1089
+ response = self.service.get_adjacent_zones_by_edge_connectivity(request)
1090
+ return response.adjacent_zone_ids
1091
+
1092
+ def get_adjacent_zones_by_node_connectivity(self, list_or_name_or_pattern) -> Any:
1093
+ """
1094
+ Return adjacent zones based on node connectivity
1095
+
1096
+ .. code-block:: python
1097
+
1098
+ >>> meshing_session.meshing_queries.get_adjacent_zones_by_node_connectivity([30])
1099
+
1100
+ >>> meshing_session.meshing_queries.get_adjacent_zones_by_node_connectivity("*")
1101
+
1102
+ """
1103
+ request = MeshingQueriesProtoModule.GetAdjacentZonesByNodeConnectivityRequest()
1104
+ if isinstance(list_or_name_or_pattern, str):
1105
+ request.zone_name_or_pattern = list_or_name_or_pattern
1106
+ elif isinstance(list_or_name_or_pattern, list):
1107
+ for items in list_or_name_or_pattern:
1108
+ request.zone_ids.append(items)
1109
+ response = self.service.get_adjacent_zones_by_node_connectivity(request)
1110
+ return response.adjacent_zone_ids
1111
+
1112
+ def get_shared_boundary_zones(self, list_or_name_or_pattern) -> Any:
1113
+ """
1114
+ Returns the number of faces and the boundary face zones that are shared with the specified cell zones.
1115
+
1116
+ .. code-block:: python
1117
+
1118
+ >>> meshing_session.meshing_queries.get_shared_boundary_zones("*")
1119
+
1120
+ >>> meshing_session.meshing_queries.get_shared_boundary_zones([3460])
1121
+
1122
+ """
1123
+ request = MeshingQueriesProtoModule.GetSharedBoundaryZonesRequest()
1124
+ if isinstance(list_or_name_or_pattern, str):
1125
+ request.cell_zone_name_or_pattern = list_or_name_or_pattern
1126
+ elif isinstance(list_or_name_or_pattern, list):
1127
+ for items in list_or_name_or_pattern:
1128
+ request.cell_zone_ids.append(items)
1129
+ response = self.service.get_shared_boundary_zones(request)
1130
+ return response.shared_boundary_zone_ids
1131
+
1132
+ def get_interior_zones_connected_to_cell_zones(
1133
+ self, list_or_name_or_pattern
1134
+ ) -> Any:
1135
+ """
1136
+ Returns interior face zones connected to given cell zones.
1137
+
1138
+ .. code-block:: python
1139
+
1140
+ >>> meshing_session.meshing_queries.get_interior_zones_connected_to_cell_zones([3460])
1141
+
1142
+ >>> meshing_session.meshing_queries.get_interior_zones_connected_to_cell_zones("*")
1143
+
1144
+ """
1145
+ request = (
1146
+ MeshingQueriesProtoModule.GetInteriorZonesConnectedToCellZonesRequest()
1147
+ )
1148
+ if isinstance(list_or_name_or_pattern, str):
1149
+ request.cell_zone_name_or_pattern = list_or_name_or_pattern
1150
+ elif isinstance(list_or_name_or_pattern, list):
1151
+ for items in list_or_name_or_pattern:
1152
+ request.face_zone_ids.append(items)
1153
+ response = self.service.get_interior_zones_connected_to_cell_zones(request)
1154
+ return response.interior_zone_ids
1155
+
1156
+ def get_face_zones_with_zone_specific_prisms_applied(self) -> Any:
1157
+ """
1158
+ Return a list of face zones with zone-specific prism settings applied.
1159
+
1160
+ .. code-block:: python
1161
+
1162
+ >>> meshing_session.meshing_queries.get_face_zones_with_zone_specific_prisms_applied()
1163
+
1164
+ """
1165
+ request = MeshingQueriesProtoModule.Empty()
1166
+ response = self.service.get_face_zones_with_zone_specific_prisms_applied(
1167
+ request
1168
+ )
1169
+ return response.face_zone_ids
1170
+
1171
+ def get_face_zones_of_prism_controls(self, control_name) -> Any:
1172
+ """
1173
+ Return a list of face zones to which the specified prism controls apply.
1174
+
1175
+ .. code-block:: python
1176
+
1177
+ >>> meshing_session.meshing_queries.get_face_zones_of_prism_controls("*")
1178
+
1179
+ """
1180
+ request = MeshingQueriesProtoModule.GetFaceZonesOfPrismControlsRequest()
1181
+ request.control_name = control_name
1182
+ response = self.service.get_face_zones_of_prism_controls(request)
1183
+ return response.face_zone_ids
1184
+
1185
+ def get_baffles(self, face_zone_list) -> Any:
1186
+ """
1187
+ Return the baffle zones based on the face zone list specified.
1188
+
1189
+ .. code-block:: python
1190
+
1191
+ >>> meshing_session.meshing_queries.get_baffles([29, 30])
1192
+
1193
+ """
1194
+ request = MeshingQueriesProtoModule.GetBafflesRequest()
1195
+ for items in face_zone_list:
1196
+ request.face_zone_ids.append(items)
1197
+ response = self.service.get_baffles(request)
1198
+ return response.baffle_zone_ids
1199
+
1200
+ def get_embedded_baffles(self) -> Any:
1201
+ """
1202
+ Return the embedded baffle zones.
1203
+
1204
+ .. code-block:: python
1205
+
1206
+ >>> meshing_session.meshing_queries.get_embedded_baffles()
1207
+
1208
+ """
1209
+ request = MeshingQueriesProtoModule.Empty()
1210
+ response = self.service.get_embedded_baffles(request)
1211
+ return response.embedded_baffles_zone_ids
1212
+
1213
+ def get_wrapped_zones(self) -> Any:
1214
+ """
1215
+ Return a list of wrapped face zones.
1216
+
1217
+ .. code-block:: python
1218
+
1219
+ >>> meshing_session.meshing_queries.get_wrapped_zones()
1220
+
1221
+ """
1222
+ request = MeshingQueriesProtoModule.Empty()
1223
+ response = self.service.get_wrapped_zones(request)
1224
+ return response.wrapped_face_zone_ids
1225
+
1226
+ def get_unreferenced_edge_zones(self) -> Any:
1227
+ """
1228
+ Return a list of unreferenced edge zones.
1229
+
1230
+ .. code-block:: python
1231
+
1232
+ >>> meshing_session.meshing_queries.get_unreferenced_edge_zones()
1233
+
1234
+ """
1235
+ request = MeshingQueriesProtoModule.Empty()
1236
+ response = self.service.get_unreferenced_edge_zones(request)
1237
+ return response.unreferenced_edge_zone_ids
1238
+
1239
+ def get_unreferenced_face_zones(self) -> Any:
1240
+ """
1241
+ Return a list of unreferenced face zones.
1242
+
1243
+ .. code-block:: python
1244
+
1245
+ >>> meshing_session.meshing_queries.get_unreferenced_face_zones()
1246
+
1247
+ """
1248
+ request = MeshingQueriesProtoModule.Empty()
1249
+ response = self.service.get_unreferenced_face_zones(request)
1250
+ return response.unreferenced_face_zone_ids
1251
+
1252
+ def get_unreferenced_cell_zones(self) -> Any:
1253
+ """
1254
+ Return a list of unreferenced cell zones.
1255
+
1256
+ .. code-block:: python
1257
+
1258
+ >>> meshing_session.meshing_queries.get_unreferenced_cell_zones()
1259
+
1260
+ """
1261
+ request = MeshingQueriesProtoModule.Empty()
1262
+ response = self.service.get_unreferenced_cell_zones(request)
1263
+ return response.unreferenced_cell_zone_ids
1264
+
1265
+ def get_unreferenced_edge_zones_of_filter(self, filter) -> Any:
1266
+ """
1267
+ Return a list of unreferenced edge zones whose names contain the specified filter string.
1268
+
1269
+ .. code-block:: python
1270
+
1271
+ >>> meshing_session.meshing_queries.get_unreferenced_edge_zones_of_filter("*")
1272
+
1273
+ """
1274
+ request = MeshingQueriesProtoModule.GetUnreferencedEdgeZonesOfFilterRequest()
1275
+ request.filter = filter
1276
+ response = self.service.get_unreferenced_edge_zones_of_filter(request)
1277
+ return response.unreferenced_edge_zone_ids
1278
+
1279
+ def get_unreferenced_face_zones_of_filter(self, filter) -> Any:
1280
+ """
1281
+ Return a list of unreferenced face zones whose names contain the specified filter string.
1282
+
1283
+ .. code-block:: python
1284
+
1285
+ >>> meshing_session.meshing_queries.get_unreferenced_face_zones_of_filter("*")
1286
+
1287
+ """
1288
+ request = MeshingQueriesProtoModule.GetUnreferencedFaceZonesOfFilterRequest()
1289
+ request.filter = filter
1290
+ response = self.service.get_unreferenced_face_zones_of_filter(request)
1291
+ return response.unreferenced_face_zone_ids
1292
+
1293
+ def get_unreferenced_cell_zones_of_filter(self, filter) -> Any:
1294
+ """
1295
+ Return a list of unreferenced cell zones whose names contain the specified filter string.
1296
+
1297
+ .. code-block:: python
1298
+
1299
+ >>> meshing_session.meshing_queries.get_unreferenced_cell_zones_of_filter("*")
1300
+
1301
+ """
1302
+ request = MeshingQueriesProtoModule.GetUnreferencedCellZonesOfFilterRequest()
1303
+ request.filter = filter
1304
+ response = self.service.get_unreferenced_cell_zones_of_filter(request)
1305
+ return response.unreferenced_cell_zone_ids
1306
+
1307
+ def get_unreferenced_edge_zone_id_list_of_pattern(self, pattern) -> Any:
1308
+ """
1309
+ Return a list of unreferenced edge zones by ID, whose names contain the specified pattern.
1310
+
1311
+ .. code-block:: python
1312
+
1313
+ >>> meshing_session.meshing_queries.get_unreferenced_edge_zone_id_list_of_pattern("*")
1314
+
1315
+ """
1316
+ request = (
1317
+ MeshingQueriesProtoModule.GetUnreferencedEdgeZoneIdListOfPatternRequest()
1318
+ )
1319
+ request.pattern = pattern
1320
+ response = self.service.get_unreferenced_edge_zone_id_list_of_pattern(request)
1321
+ return response.unreferenced_edge_zone_ids
1322
+
1323
+ def get_unreferenced_face_zone_id_list_of_pattern(self, pattern) -> Any:
1324
+ """
1325
+ Return a list of unreferenced face zones by ID, whose names contain the specified pattern.
1326
+
1327
+ .. code-block:: python
1328
+
1329
+ >>> meshing_session.meshing_queries.get_unreferenced_face_zone_id_list_of_pattern("*")
1330
+
1331
+ """
1332
+ request = (
1333
+ MeshingQueriesProtoModule.GetUnreferencedFaceZoneIdListOfPatternRequest()
1334
+ )
1335
+ request.pattern = pattern
1336
+ response = self.service.get_unreferenced_face_zone_id_list_of_pattern(request)
1337
+ return response.unreferenced_face_zone_ids
1338
+
1339
+ def get_unreferenced_cell_zone_id_list_of_pattern(self, pattern) -> Any:
1340
+ """
1341
+ Return a list of unreferenced cell zones by ID, whose names contain the specified pattern.
1342
+
1343
+ .. code-block:: python
1344
+
1345
+ >>> meshing_session.meshing_queries.get_unreferenced_cell_zone_id_list_of_pattern("*")
1346
+
1347
+ """
1348
+ request = (
1349
+ MeshingQueriesProtoModule.GetUnreferencedCellZoneIdListOfPatternRequest()
1350
+ )
1351
+ request.pattern = pattern
1352
+ response = self.service.get_unreferenced_cell_zone_id_list_of_pattern(request)
1353
+ return response.unreferenced_cell_zone_ids
1354
+
1355
+ def get_maxsize_cell_zone_by_volume(self, list_or_pattern) -> Any:
1356
+ """
1357
+ Return cell zone with maximum volume for given list or pattern of cell zones.
1358
+
1359
+ .. code-block:: python
1360
+
1361
+ >>> meshing_session.meshing_queries.get_maxsize_cell_zone_by_volume("*")
1362
+
1363
+ >>> meshing_session.meshing_queries.get_maxsize_cell_zone_by_volume([3460])
1364
+
1365
+ """
1366
+ request = MeshingQueriesProtoModule.GetMaxsizeCellZoneByVolumeRequest()
1367
+ if isinstance(list_or_pattern, str):
1368
+ request.cell_zone_pattern = list_or_pattern
1369
+ elif isinstance(list_or_pattern, list):
1370
+ if isinstance(list_or_pattern[0], int):
1371
+ for items in list_or_pattern:
1372
+ request.cell_zone_ids.append(items)
1373
+ elif isinstance(list_or_pattern[0], str):
1374
+ for items in list_or_pattern:
1375
+ request.cell_zone_names.append(items)
1376
+ response = self.service.get_maxsize_cell_zone_by_volume(request)
1377
+ return response.cell_zone_id
1378
+
1379
+ def get_maxsize_cell_zone_by_count(self, list_or_pattern) -> Any:
1380
+ """
1381
+ Return cell zone with maximum count of elements for given list or pattern of cell zones.
1382
+
1383
+ .. code-block:: python
1384
+
1385
+ >>> meshing_session.meshing_queries.get_maxsize_cell_zone_by_count("*")
1386
+
1387
+ >>> meshing_session.meshing_queries.get_maxsize_cell_zone_by_count([3460])
1388
+
1389
+ """
1390
+ request = MeshingQueriesProtoModule.GetMaxsizeCellZoneByCountRequest()
1391
+ if isinstance(list_or_pattern, str):
1392
+ request.cell_zone_pattern = list_or_pattern
1393
+ elif isinstance(list_or_pattern, list):
1394
+ if isinstance(list_or_pattern[0], int):
1395
+ for items in list_or_pattern:
1396
+ request.cell_zone_ids.append(items)
1397
+ elif isinstance(list_or_pattern[0], str):
1398
+ for items in list_or_pattern:
1399
+ request.cell_zone_names.append(items)
1400
+ response = self.service.get_maxsize_cell_zone_by_count(request)
1401
+ return response.cell_zone_id
1402
+
1403
+ def get_minsize_face_zone_by_area(self, list_or_pattern) -> Any:
1404
+ """
1405
+ Return face zone with minimum area for given list or pattern of face zones.
1406
+
1407
+ .. code-block:: python
1408
+
1409
+ >>> meshing_session.meshing_queries.get_minsize_face_zone_by_area("*")
1410
+
1411
+ >>> meshing_session.meshing_queries.get_minsize_face_zone_by_area([29, 30, 31, 32, 33, 34])
1412
+
1413
+ """
1414
+ request = MeshingQueriesProtoModule.GetMinsizeFaceZoneByAreaRequest()
1415
+ if isinstance(list_or_pattern, str):
1416
+ request.face_zone_pattern = list_or_pattern
1417
+ elif isinstance(list_or_pattern, list):
1418
+ if isinstance(list_or_pattern[0], int):
1419
+ for items in list_or_pattern:
1420
+ request.face_zone_ids.append(items)
1421
+ elif isinstance(list_or_pattern[0], str):
1422
+ for items in list_or_pattern:
1423
+ request.face_zone_names.append(items)
1424
+ response = self.service.get_minsize_face_zone_by_area(request)
1425
+ return response.face_zone_id
1426
+
1427
+ def get_minsize_face_zone_by_count(self, list_or_pattern) -> Any:
1428
+ """
1429
+ Return face zone with minimum count of elements for given list or pattern of face zones.
1430
+
1431
+ .. code-block:: python
1432
+
1433
+ >>> meshing_session.meshing_queries.get_minsize_face_zone_by_count("*")
1434
+
1435
+ >>> meshing_session.meshing_queries.get_minsize_face_zone_by_count([29, 30, 31, 32, 33, 34])
1436
+
1437
+ """
1438
+ request = MeshingQueriesProtoModule.GetMinsizeFaceZoneByCountRequest()
1439
+ if isinstance(list_or_pattern, str):
1440
+ request.face_zone_pattern = list_or_pattern
1441
+ elif isinstance(list_or_pattern, list):
1442
+ if isinstance(list_or_pattern[0], int):
1443
+ for items in list_or_pattern:
1444
+ request.face_zone_ids.append(items)
1445
+ elif isinstance(list_or_pattern[0], str):
1446
+ for items in list_or_pattern:
1447
+ request.face_zone_names.append(items)
1448
+ response = self.service.get_minsize_face_zone_by_count(request)
1449
+ return response.face_zone_id
1450
+
1451
+ def get_face_zone_list_by_maximum_entity_count(
1452
+ self, max_entity_count, only_boundary
1453
+ ) -> Any:
1454
+ """
1455
+ Return a list of face zones with a count below the maximum entity count (maximum-entity-count) specified.
1456
+ You can choose to restrict the report to only boundary edge zones, if required (only-boundary? set to True or False).
1457
+
1458
+ .. code-block:: python
1459
+
1460
+ >>> meshing_session.meshing_queries.get_face_zone_list_by_maximum_entity_count(20, True)
1461
+
1462
+ """
1463
+ request = MeshingQueriesProtoModule.GetFaceZoneListByMaximumEntityCountRequest()
1464
+ request.maximum_entity_count = max_entity_count
1465
+ request.only_boundary = only_boundary
1466
+ response = self.service.get_face_zone_list_by_maximum_entity_count(request)
1467
+ return response.face_zone_ids
1468
+
1469
+ def get_edge_zone_list_by_maximum_entity_count(
1470
+ self, max_entity_count, only_boundary
1471
+ ) -> Any:
1472
+ """
1473
+ Return a list of edge zones with a count below the maximum entity count (maximum-entity-count) specified.
1474
+ You can choose to restrict the report to only boundary edge zones, if required (only-boundary? set to True or False).
1475
+
1476
+ .. code-block:: python
1477
+
1478
+ >>> meshing_session.meshing_queries.get_edge_zone_list_by_maximum_entity_count(20, False)
1479
+
1480
+ """
1481
+ request = MeshingQueriesProtoModule.GetEdgeZoneListByMaximumEntityCountRequest()
1482
+ request.maximum_entity_count = max_entity_count
1483
+ request.only_boundary = only_boundary
1484
+ response = self.service.get_edge_zone_list_by_maximum_entity_count(request)
1485
+ return response.edge_zone_ids
1486
+
1487
+ def get_cell_zone_list_by_maximum_entity_count(self, maximum_entity_count) -> Any:
1488
+ """
1489
+ Return a list of cell zones with a count below the maximum entity count (maximum-entity-count) specified.
1490
+
1491
+ .. code-block:: python
1492
+
1493
+ >>> meshing_session.meshing_queries.get_cell_zone_list_by_maximum_entity_count(1)
1494
+
1495
+ """
1496
+ request = MeshingQueriesProtoModule.GetCellZoneListByMaximumEntityCountRequest()
1497
+ request.maximum_entity_count = maximum_entity_count
1498
+ response = self.service.get_cell_zone_list_by_maximum_entity_count(request)
1499
+ return response.cell_zone_ids
1500
+
1501
+ def get_face_zone_list_by_maximum_zone_area(self, maximum_zone_area) -> Any:
1502
+ """
1503
+ Return a list of face zones with a maximum zone area below the maximum-zone-area specified.
1504
+
1505
+ .. code-block:: python
1506
+
1507
+ >>> meshing_session.meshing_queries.get_face_zone_list_by_maximum_zone_area(100)
1508
+
1509
+ """
1510
+ request = MeshingQueriesProtoModule.GetFaceZoneListByMaximumZoneAreaRequest()
1511
+ request.maximum_zone_area = maximum_zone_area
1512
+ response = self.service.get_face_zone_list_by_maximum_zone_area(request)
1513
+ return response.face_zone_ids
1514
+
1515
+ def get_face_zone_list_by_minimum_zone_area(self, minimum_zone_area) -> Any:
1516
+ """
1517
+ Return a list of face zones with a minimum zone area above the minimum-zone-area specified.
1518
+
1519
+ .. code-block:: python
1520
+
1521
+ >>> meshing_session.meshing_queries.get_face_zone_list_by_minimum_zone_area(10)
1522
+
1523
+ """
1524
+ request = MeshingQueriesProtoModule.GetFaceZoneListByMinimumZoneAreaRequest()
1525
+ request.minimum_zone_area = minimum_zone_area
1526
+ response = self.service.get_face_zone_list_by_minimum_zone_area(request)
1527
+ return response.face_zone_ids
1528
+
1529
+ def get_zones_with_free_faces(self, list_or_pattern) -> Any:
1530
+ """
1531
+ Return a list of zones with free faces for the face zones specified.
1532
+
1533
+ .. code-block:: python
1534
+
1535
+ >>> meshing_session.meshing_queries.get_zones_with_free_faces("*")
1536
+
1537
+ >>> meshing_session.meshing_queries.get_zones_with_free_faces([29, 30, 31, 32])
1538
+
1539
+ >>> meshing_session.meshing_queries.get_zones_with_free_faces(["inlet", "outlet"])
1540
+
1541
+ """
1542
+ request = MeshingQueriesProtoModule.GetZonesWithFreeFacesRequest()
1543
+ if isinstance(list_or_pattern, str):
1544
+ request.face_zone_pattern = list_or_pattern
1545
+ elif isinstance(list_or_pattern, list):
1546
+ if isinstance(list_or_pattern[0], int):
1547
+ for items in list_or_pattern:
1548
+ request.face_zone_ids.append(items)
1549
+ elif isinstance(list_or_pattern[0], str):
1550
+ for items in list_or_pattern:
1551
+ request.face_zone_names.append(items)
1552
+ response = self.service.get_zones_with_free_faces(request)
1553
+ return response.zones_with_free_faces
1554
+
1555
+ def get_zones_with_multi_faces(self, list_or_pattern) -> Any:
1556
+ """
1557
+ Return a list of zones with multi-connected faces for the face zones specified.
1558
+
1559
+ .. code-block:: python
1560
+
1561
+ >>> meshing_session.meshing_queries.get_zones_with_multi_faces("*")
1562
+
1563
+ >>> meshing_session.meshing_queries.get_zones_with_multi_faces([29, 30, 31, 32])
1564
+
1565
+ >>> meshing_session.meshing_queries.get_zones_with_multi_faces(["inlet", "outlet"])
1566
+
1567
+ """
1568
+ request = MeshingQueriesProtoModule.GetZonesWithMultiFacesRequest()
1569
+ if isinstance(list_or_pattern, str):
1570
+ request.face_zone_pattern = list_or_pattern
1571
+ elif isinstance(list_or_pattern, list):
1572
+ if isinstance(list_or_pattern[0], int):
1573
+ for items in list_or_pattern:
1574
+ request.face_zone_ids.append(items)
1575
+ elif isinstance(list_or_pattern[0], str):
1576
+ for items in list_or_pattern:
1577
+ request.face_zone_names.append(items)
1578
+ response = self.service.get_zones_with_multi_faces(request)
1579
+ return response.zones_with_multi_connected_faces
1580
+
1581
+ def get_overlapping_face_zones(
1582
+ self, zone_name_pattern, area_tolerance, distance_tolerance
1583
+ ) -> Any:
1584
+ """
1585
+ Return a list of overlapping face zones based on the area-tolerance and distance-tolerance specified.
1586
+
1587
+ .. code-block:: python
1588
+
1589
+ >>> meshing_session.meshing_queries.GetOverlappingFaceZones("*", 0.1, 0.1)
1590
+
1591
+ """
1592
+ request = MeshingQueriesProtoModule.GetOverlappingFaceZonesRequest()
1593
+ request.face_zone_name_or_pattern = zone_name_pattern
1594
+ request.area_tolerance = area_tolerance
1595
+ request.distance_tolerance = distance_tolerance
1596
+ response = self.service.get_overlapping_face_zones(request)
1597
+ return response.overlapping_face_zone_ids
1598
+
1599
+ def get_zones_with_marked_faces(self, list_or_pattern) -> Any:
1600
+ """
1601
+ Return a list of zones with marked faces for the face zones specified.
1602
+
1603
+ .. code-block:: python
1604
+
1605
+ >>> meshing_session.meshing_queries.get_zones_with_marked_faces("*")
1606
+
1607
+ >>> meshing_session.meshing_queries.get_zones_with_marked_faces([29, 30, 31, 32])
1608
+
1609
+ >>> meshing_session.meshing_queries.get_zones_with_marked_faces(["inlet", "outlet"])
1610
+
1611
+ """
1612
+ request = MeshingQueriesProtoModule.GetZonesWithMarkedFacesRequest()
1613
+ if isinstance(list_or_pattern, str):
1614
+ request.face_zone_pattern = list_or_pattern
1615
+ elif isinstance(list_or_pattern, list):
1616
+ if isinstance(list_or_pattern[0], int):
1617
+ for items in list_or_pattern:
1618
+ request.face_zone_ids.append(items)
1619
+ elif isinstance(list_or_pattern[0], str):
1620
+ for items in list_or_pattern:
1621
+ request.face_zone_names.append(items)
1622
+ response = self.service.get_zones_with_marked_faces(request)
1623
+ return response.zones_with_marked_faces
1624
+
1625
+ def get_object_name_list_of_type(self, type) -> Any:
1626
+ """
1627
+ Return a list of objects of the specified type.
1628
+
1629
+ .. code-block:: python
1630
+
1631
+ >>> meshing_session.meshing_queries.get_object_name_list_of_type("mesh")
1632
+
1633
+ """
1634
+ request = MeshingQueriesProtoModule.GetObjectNameListOfTypeRequest()
1635
+ request.type = type
1636
+ response = self.service.get_object_name_list_of_type(request)
1637
+ return response.objects
1638
+
1639
+ def get_objects_of_filter(self, filter) -> Any:
1640
+ """
1641
+ Return a list of objects whose names contain the specified filter string.
1642
+
1643
+ .. code-block:: python
1644
+
1645
+ >>> meshing_session.meshing_queries.get_objects_of_filter("*")
1646
+
1647
+ """
1648
+ request = MeshingQueriesProtoModule.GetObjectsOfFilterRequest()
1649
+ request.filter = filter
1650
+ response = self.service.get_objects_of_filter(request)
1651
+ return response.objects
1652
+
1653
+ def get_regions_of_object(self, object) -> Any:
1654
+ """
1655
+ Return a list of regions in the specified object.
1656
+
1657
+ .. code-block:: python
1658
+
1659
+ >>> meshing_session.meshing_queries.get_regions_of_object("elbow-fluid")
1660
+
1661
+ """
1662
+ self.get_allowed_object(object)
1663
+ request = MeshingQueriesProtoModule.GetRegionsOfObjectRequest()
1664
+ request.object = object
1665
+ response = self.service.get_regions_of_object(request)
1666
+ return response.regions
1667
+
1668
+ def sort_regions_by_volume(self, object_name, order) -> Any:
1669
+ """
1670
+ Returns a sorted list of volumetric regions by volume for the object specified.
1671
+ Specify the order (ascending or descending).
1672
+
1673
+ .. code-block:: python
1674
+
1675
+ >>> meshing_session.meshing_queries.sort_regions_by_volume("elbow-fluid", "ascending")
1676
+
1677
+ """
1678
+ self.get_allowed_object(object_name)
1679
+ self.get_allowed_orders(order)
1680
+ request = MeshingQueriesProtoModule.SortRegionsByVolumeRequest()
1681
+ request.object_name = object_name
1682
+ request.order = order
1683
+ response = self.service.sort_regions_by_volume(request)
1684
+ return response.regions
1685
+
1686
+ def get_region_volume(self, object_name, region_name) -> Any:
1687
+ """
1688
+ Return the region volume for the specified region of an object.
1689
+
1690
+ .. code-block:: python
1691
+
1692
+ >>> meshing_session.meshing_queries.get_region_volume("elbow-fluid", "fluid")
1693
+
1694
+ """
1695
+ self.get_allowed_object(object_name)
1696
+ self.get_allowed_region(region_name)
1697
+ request = MeshingQueriesProtoModule.GetRegionVolumeRequest()
1698
+ request.object_name = object_name
1699
+ request.region_name = region_name
1700
+ response = self.service.get_region_volume(request)
1701
+ return response.region_volume
1702
+
1703
+ def get_regions_of_filter(self, object, filter) -> Any:
1704
+ """
1705
+ Return a list of regions in the specified object, whose names contain the specified filter string.
1706
+
1707
+ .. code-block:: python
1708
+
1709
+ >>> meshing_session.meshing_queries.get_regions_of_filter("elbow-fluid", "*")
1710
+
1711
+ """
1712
+ request = MeshingQueriesProtoModule.GetRegionsOfFilterRequest()
1713
+ request.object = object
1714
+ request.filter = filter
1715
+ response = self.service.get_regions_of_filter(request)
1716
+ return response.regions
1717
+
1718
+ def get_region_name_list_of_pattern(self, object, region_name_or_pattern) -> Any:
1719
+ """
1720
+ Return a list of regions in the specified object, whose names contain the specified name pattern.
1721
+
1722
+ .. code-block:: python
1723
+
1724
+ >>> meshing_session.meshing_queries.get_region_name_list_of_pattern("elbow-fluid", "*")
1725
+
1726
+ """
1727
+ request = MeshingQueriesProtoModule.GetRegionNameListOfPatternRequest()
1728
+ request.object = object
1729
+ request.region_name_or_pattern = region_name_or_pattern
1730
+ response = self.service.get_region_name_list_of_pattern(request)
1731
+ return response.regions
1732
+
1733
+ def get_regions_of_face_zones(self, list_of_face_zone_ids) -> Any:
1734
+ """
1735
+ Return a list of regions containing the face zones specified.
1736
+
1737
+ .. code-block:: python
1738
+
1739
+ >>> meshing_session.meshing_queries.get_regions_of_face_zones([29, 30, 31, 32, 33, 34])
1740
+
1741
+ """
1742
+ request = MeshingQueriesProtoModule.GetRegionsOfFaceZonesRequest()
1743
+ for id in list_of_face_zone_ids:
1744
+ request.face_zone_ids.append(id)
1745
+ response = self.service.get_regions_of_face_zones(request)
1746
+ return response.regions
1747
+
1748
+ def find_join_pairs(
1749
+ self, face_zone_list_or_pattern, join_tolerance, absolute_tolerance, join_angle
1750
+ ) -> Any:
1751
+ """
1752
+ Return the pairs of overlapping face zones based on the join tolerance and feature angle.
1753
+
1754
+ .. code-block:: python
1755
+
1756
+ >>> meshing_session.meshing_queries.find_join_pairs("outlet", 0.1, True, 40)
1757
+
1758
+ >>> meshing_session.meshing_queries.find_join_pairs([32], 0.1, True, 40))
1759
+
1760
+ >>> meshing_session.meshing_queries.find_join_pairs(["outlet"], 0.1, True, 40)
1761
+
1762
+ """
1763
+ request = MeshingQueriesProtoModule.FindJoinPairsRequest()
1764
+ if isinstance(face_zone_list_or_pattern, str):
1765
+ request.face_zone_name_or_pattern = face_zone_list_or_pattern
1766
+ elif isinstance(face_zone_list_or_pattern, list):
1767
+ if isinstance(face_zone_list_or_pattern[0], int):
1768
+ for items in face_zone_list_or_pattern:
1769
+ request.face_zone_ids.append(items)
1770
+ elif isinstance(face_zone_list_or_pattern[0], str):
1771
+ for items in face_zone_list_or_pattern:
1772
+ request.face_zone_names.append(items)
1773
+ request.join_tolerance = join_tolerance
1774
+ request.absolute_tolerance = absolute_tolerance
1775
+ request.join_angle = join_angle
1776
+ response = self.service.find_join_pairs(request)
1777
+ return response.pairs
1778
+
1779
+ def get_region_name_list_of_face_zones(self, list_or_pattern) -> Any:
1780
+ """
1781
+ Return a list of regions containing the face zones specified.
1782
+
1783
+ .. code-block:: python
1784
+
1785
+ >>> meshing_session.meshing_queries.get_region_name_list_of_face_zones([29, 30, 31, 32, 33, 34])
1786
+
1787
+ """
1788
+ request = MeshingQueriesProtoModule.GetRegionNameListOfFaceZonesRequest()
1789
+ if isinstance(list_or_pattern, str):
1790
+ request.face_zone_name_or_pattern = list_or_pattern
1791
+ elif isinstance(list_or_pattern, list):
1792
+ for items in list_or_pattern:
1793
+ request.face_zone_ids.append(items)
1794
+ response = self.service.get_region_name_list_of_face_zones(request)
1795
+ return response.regions