ansys-fluent-core 0.14.dev1__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 (76) 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/launcher/fluent_container.py +1 -1
  7. ansys/fluent/core/launcher/fluent_launcher_options.json +10 -0
  8. ansys/fluent/core/launcher/launcher.py +29 -15
  9. ansys/fluent/core/meshing/tui_231.py +7265 -7265
  10. ansys/fluent/core/services/datamodel_se.py +142 -110
  11. ansys/fluent/core/services/meshing_queries.py +920 -361
  12. ansys/fluent/core/session_pure_meshing.py +4 -5
  13. ansys/fluent/core/solver/flobject.py +20 -2
  14. ansys/fluent/core/solver/settings_222/change_type.py +1 -1
  15. ansys/fluent/core/solver/settings_222/clear_generated_data.py +1 -1
  16. ansys/fluent/core/solver/settings_222/compute_2.py +1 -1
  17. ansys/fluent/core/solver/settings_222/delete_design_points.py +1 -1
  18. ansys/fluent/core/solver/settings_222/position_1.py +1 -1
  19. ansys/fluent/core/solver/settings_222/setup_unsteady_statistics.py +1 -1
  20. ansys/fluent/core/solver/settings_222/target.py +1 -1
  21. ansys/fluent/core/solver/settings_222/up_vector.py +1 -1
  22. ansys/fluent/core/solver/settings_222/update_selected.py +1 -1
  23. ansys/fluent/core/solver/settings_222/write_1.py +1 -1
  24. ansys/fluent/core/solver/settings_222/write_views.py +1 -1
  25. ansys/fluent/core/solver/settings_231/abaqus.py +2 -2
  26. ansys/fluent/core/solver/settings_231/activate_cell_zone.py +1 -1
  27. ansys/fluent/core/solver/settings_231/calculate_patch.py +2 -2
  28. ansys/fluent/core/solver/settings_231/change_type.py +1 -1
  29. ansys/fluent/core/solver/settings_231/clear_generated_data.py +1 -1
  30. ansys/fluent/core/solver/settings_231/compute_1.py +1 -1
  31. ansys/fluent/core/solver/settings_231/convert_skewed_cells_1.py +1 -1
  32. ansys/fluent/core/solver/settings_231/custom_heat_flux.py +1 -1
  33. ansys/fluent/core/solver/settings_231/customize_fmg_initialization.py +2 -2
  34. ansys/fluent/core/solver/settings_231/delete_design_points.py +1 -1
  35. ansys/fluent/core/solver/settings_231/export_1.py +1 -1
  36. ansys/fluent/core/solver/settings_231/export_modifications.py +1 -1
  37. ansys/fluent/core/solver/settings_231/film_heat_transfer.py +1 -1
  38. ansys/fluent/core/solver/settings_231/film_mass_flow.py +1 -1
  39. ansys/fluent/core/solver/settings_231/forces.py +4 -4
  40. ansys/fluent/core/solver/settings_231/heat_transfer_1.py +1 -1
  41. ansys/fluent/core/solver/settings_231/heat_transfer_sensible.py +1 -1
  42. ansys/fluent/core/solver/settings_231/mass_flow_1.py +1 -1
  43. ansys/fluent/core/solver/settings_231/mechanical_apdl.py +1 -1
  44. ansys/fluent/core/solver/settings_231/mechanical_apdl_input.py +2 -2
  45. ansys/fluent/core/solver/settings_231/modified_setting.py +1 -1
  46. ansys/fluent/core/solver/settings_231/moments.py +2 -2
  47. ansys/fluent/core/solver/settings_231/number_density.py +2 -2
  48. ansys/fluent/core/solver/settings_231/particle_summary.py +1 -1
  49. ansys/fluent/core/solver/settings_231/position_1.py +1 -1
  50. ansys/fluent/core/solver/settings_231/pressure_work_1.py +1 -1
  51. ansys/fluent/core/solver/settings_231/print_histogram.py +1 -1
  52. ansys/fluent/core/solver/settings_231/projected_surface_area.py +2 -2
  53. ansys/fluent/core/solver/settings_231/rad_heat_trans.py +1 -1
  54. ansys/fluent/core/solver/settings_231/read_journal.py +1 -1
  55. ansys/fluent/core/solver/settings_231/rotate.py +2 -2
  56. ansys/fluent/core/solver/settings_231/sample_1.py +4 -4
  57. ansys/fluent/core/solver/settings_231/set_ambient_color.py +1 -1
  58. ansys/fluent/core/solver/settings_231/set_light.py +2 -2
  59. ansys/fluent/core/solver/settings_231/setup_unsteady_statistics.py +1 -1
  60. ansys/fluent/core/solver/settings_231/surface_integrals.py +1 -1
  61. ansys/fluent/core/solver/settings_231/taitherm.py +1 -1
  62. ansys/fluent/core/solver/settings_231/target.py +1 -1
  63. ansys/fluent/core/solver/settings_231/translate.py +1 -1
  64. ansys/fluent/core/solver/settings_231/up_vector.py +1 -1
  65. ansys/fluent/core/solver/settings_231/update_selected.py +1 -1
  66. ansys/fluent/core/solver/settings_231/viscous_work.py +1 -1
  67. ansys/fluent/core/solver/settings_231/volume_integrals.py +1 -1
  68. ansys/fluent/core/solver/settings_231/write_1.py +1 -1
  69. ansys/fluent/core/solver/settings_231/write_histogram.py +1 -1
  70. ansys/fluent/core/solver/settings_231/write_views.py +1 -1
  71. ansys/fluent/core/solver/tui_231.py +36777 -37552
  72. {ansys_fluent_core-0.14.dev1.dist-info → ansys_fluent_core-0.14.dev2.dist-info}/METADATA +29 -29
  73. {ansys_fluent_core-0.14.dev1.dist-info → ansys_fluent_core-0.14.dev2.dist-info}/RECORD +76 -76
  74. {ansys_fluent_core-0.14.dev1.dist-info → ansys_fluent_core-0.14.dev2.dist-info}/LICENSE +0 -0
  75. {ansys_fluent_core-0.14.dev1.dist-info → ansys_fluent_core-0.14.dev2.dist-info}/WHEEL +0 -0
  76. {ansys_fluent_core-0.14.dev1.dist-info → ansys_fluent_core-0.14.dev2.dist-info}/top_level.txt +0 -0
@@ -26,797 +26,1038 @@ class MeshingQueriesService:
26
26
  self._metadata = metadata
27
27
 
28
28
  @catch_grpc_error
29
- def GetFaceZoneAtLocation(
29
+ def get_face_zone_at_location(
30
30
  self, request: MeshingQueriesProtoModule.GetFaceZoneAtLocationRequest
31
31
  ) -> MeshingQueriesProtoModule.GetFaceZoneAtLocationResponse:
32
- """GetFaceZoneAtLocation rpc of MeshingQueriesService."""
32
+ """get_face_zone_at_location rpc of MeshingQueriesService."""
33
33
  return self._stub.GetFaceZoneAtLocation(request, metadata=self._metadata)
34
34
 
35
35
  @catch_grpc_error
36
- def GetCellZoneAtLocation(
36
+ def get_cell_zone_at_location(
37
37
  self, request: MeshingQueriesProtoModule.GetCellZoneAtLocationRequest
38
38
  ) -> MeshingQueriesProtoModule.GetCellZoneAtLocationResponse:
39
- """GetCellZoneAtLocation rpc of MeshingQueriesService."""
39
+ """get_cell_zone_at_location rpc of MeshingQueriesService."""
40
40
  return self._stub.GetCellZoneAtLocation(request, metadata=self._metadata)
41
41
 
42
42
  @catch_grpc_error
43
- def GetZonesOfType(
43
+ def get_zones_of_type(
44
44
  self, request: MeshingQueriesProtoModule.GetZonesOfTypeRequest
45
45
  ) -> MeshingQueriesProtoModule.GetZonesOfTypeResponse:
46
- """GetZonesOfType rpc of MeshingQueriesService."""
46
+ """get_zones_of_type rpc of MeshingQueriesService."""
47
47
  return self._stub.GetZonesOfType(request, metadata=self._metadata)
48
48
 
49
49
  @catch_grpc_error
50
- def GetZonesOfGroup(
50
+ def get_zones_of_group(
51
51
  self, request: MeshingQueriesProtoModule.GetZonesOfGroupRequest
52
52
  ) -> MeshingQueriesProtoModule.GetZonesOfGroupResponse:
53
- """GetZonesOfGroup rpc of MeshingQueriesService."""
53
+ """get_zones_of_group rpc of MeshingQueriesService."""
54
54
  return self._stub.GetZonesOfGroup(request, metadata=self._metadata)
55
55
 
56
56
  @catch_grpc_error
57
- def GetFaceZonesOfFilter(
57
+ def get_face_zones_of_filter(
58
58
  self, request: MeshingQueriesProtoModule.GetFaceZonesOfFilterRequest
59
59
  ) -> MeshingQueriesProtoModule.GetFaceZonesOfFilterResponse:
60
- """GetFaceZonesOfFilter rpc of MeshingQueriesService."""
60
+ """get_face_zones_of_filter rpc of MeshingQueriesService."""
61
61
  return self._stub.GetFaceZonesOfFilter(request, metadata=self._metadata)
62
62
 
63
63
  @catch_grpc_error
64
- def GetCellZonesOfFilter(
64
+ def get_cell_zones_of_filter(
65
65
  self, request: MeshingQueriesProtoModule.GetCellZonesOfFilterRequest
66
66
  ) -> MeshingQueriesProtoModule.GetCellZonesOfFilterResponse:
67
- """GetCellZonesOfFilter rpc of MeshingQueriesService."""
67
+ """get_cell_zones_of_filter rpc of MeshingQueriesService."""
68
68
  return self._stub.GetCellZonesOfFilter(request, metadata=self._metadata)
69
69
 
70
70
  @catch_grpc_error
71
- def GetEdgeZonesOfFilter(
71
+ def get_edge_zones_of_filter(
72
72
  self, request: MeshingQueriesProtoModule.GetEdgeZonesOfFilterRequest
73
73
  ) -> MeshingQueriesProtoModule.GetEdgeZonesOfFilterResponse:
74
- """GetEdgeZonesOfFilter rpc of MeshingQueriesService."""
74
+ """get_edge_zones_of_filter rpc of MeshingQueriesService."""
75
75
  return self._stub.GetEdgeZonesOfFilter(request, metadata=self._metadata)
76
76
 
77
77
  @catch_grpc_error
78
- def GetNodeZonesOfFilter(
78
+ def get_node_zones_of_filter(
79
79
  self, request: MeshingQueriesProtoModule.GetNodeZonesOfFilterRequest
80
80
  ) -> MeshingQueriesProtoModule.GetNodeZonesOfFilterResponse:
81
- """GetNodeZonesOfFilter rpc of MeshingQueriesService."""
81
+ """get_node_zones_of_filter rpc of MeshingQueriesService."""
82
82
  return self._stub.GetNodeZonesOfFilter(request, metadata=self._metadata)
83
83
 
84
84
  @catch_grpc_error
85
- def GetObjectsOfType(
85
+ def get_objects_of_type(
86
86
  self, request: MeshingQueriesProtoModule.GetObjectsOfTypeRequest
87
87
  ) -> MeshingQueriesProtoModule.GetObjectsOfTypeResponse:
88
- """GetObjectsOfType rpc of MeshingQueriesService."""
88
+ """get_objects_of_type rpc of MeshingQueriesService."""
89
89
  return self._stub.GetObjectsOfType(request, metadata=self._metadata)
90
90
 
91
91
  @catch_grpc_error
92
- def GetFaceZoneIdListOfObject(
92
+ def get_face_zone_id_list_of_object(
93
93
  self, request: MeshingQueriesProtoModule.GetFaceZoneIdListOfObjectRequest
94
94
  ) -> MeshingQueriesProtoModule.GetFaceZoneIdListOfObjectResponse:
95
- """GetFaceZoneIdListOfObject rpc of MeshingQueriesService."""
95
+ """get_face_zone_id_list_of_object rpc of MeshingQueriesService."""
96
96
  return self._stub.GetFaceZoneIdListOfObject(request, metadata=self._metadata)
97
97
 
98
98
  @catch_grpc_error
99
- def GetEdgeZoneIdListOfObject(
99
+ def get_edge_zone_id_list_of_object(
100
100
  self, request: MeshingQueriesProtoModule.GetEdgeZoneIdListOfObjectRequest
101
101
  ) -> MeshingQueriesProtoModule.GetEdgeZoneIdListOfObjectResponse:
102
- """GetEdgeZoneIdListOfObject rpc of MeshingQueriesService."""
102
+ """get_edge_zone_id_list_of_object rpc of MeshingQueriesService."""
103
103
  return self._stub.GetEdgeZoneIdListOfObject(request, metadata=self._metadata)
104
104
 
105
105
  @catch_grpc_error
106
- def GetCellZoneIdListOfObject(
106
+ def get_cell_zone_id_list_of_object(
107
107
  self, request: MeshingQueriesProtoModule.GetCellZoneIdListOfObjectRequest
108
108
  ) -> MeshingQueriesProtoModule.GetCellZoneIdListOfObjectResponse:
109
- """GetCellZoneIdListOfObject rpc of MeshingQueriesService."""
109
+ """get_cell_zone_id_list_of_object rpc of MeshingQueriesService."""
110
110
  return self._stub.GetCellZoneIdListOfObject(request, metadata=self._metadata)
111
111
 
112
112
  @catch_grpc_error
113
- def GetFaceZonesSharedByRegionsOfType(
113
+ def get_face_zones_shared_by_regions_of_type(
114
114
  self,
115
115
  request: MeshingQueriesProtoModule.GetFaceZonesSharedByRegionsOfTypeRequest,
116
116
  ) -> MeshingQueriesProtoModule.GetFaceZonesSharedByRegionsOfTypeResponse:
117
- """GetFaceZonesSharedByRegionsOfType rpc of MeshingQueriesService."""
117
+ """get_face_zones_shared_by_regions_of_type rpc of MeshingQueriesService."""
118
118
  return self._stub.GetFaceZonesSharedByRegionsOfType(
119
119
  request, metadata=self._metadata
120
120
  )
121
121
 
122
122
  @catch_grpc_error
123
- def GetFaceZonesOfRegions(
123
+ def get_face_zones_of_regions(
124
124
  self, request: MeshingQueriesProtoModule.GetFaceZonesOfRegionsRequest
125
125
  ) -> MeshingQueriesProtoModule.GetFaceZonesOfRegionsResponse:
126
- """GetFaceZonesOfRegions rpc of MeshingQueriesService."""
126
+ """get_face_zones_of_regions rpc of MeshingQueriesService."""
127
127
  return self._stub.GetFaceZonesOfRegions(request, metadata=self._metadata)
128
128
 
129
129
  @catch_grpc_error
130
- def GetFaceZonesOfLabels(
130
+ def get_face_zones_of_labels(
131
131
  self, request: MeshingQueriesProtoModule.GetFaceZonesOfLabelsRequest
132
132
  ) -> MeshingQueriesProtoModule.GetFaceZonesOfLabelsResponse:
133
- """GetFaceZonesOfLabels rpc of MeshingQueriesService."""
133
+ """get_face_zones_of_labels rpc of MeshingQueriesService."""
134
134
  return self._stub.GetFaceZonesOfLabels(request, metadata=self._metadata)
135
135
 
136
136
  @catch_grpc_error
137
- def GetFaceZoneIdListOfLabels(
137
+ def get_face_zone_id_list_of_labels(
138
138
  self,
139
139
  request: MeshingQueriesProtoModule.GetFaceZoneIdListOfLabelsRequest,
140
140
  ) -> MeshingQueriesProtoModule.GetFaceZoneIdListOfLabelsResponse:
141
- """GetFaceZoneIdListOfLabels rpc of MeshingQueriesService."""
141
+ """get_face_zone_id_list_of_labels rpc of MeshingQueriesService."""
142
142
  return self._stub.GetFaceZoneIdListOfLabels(request, metadata=self._metadata)
143
143
 
144
144
  @catch_grpc_error
145
- def GetFaceZonesOfObjects(
145
+ def get_face_zones_of_objects(
146
146
  self, request: MeshingQueriesProtoModule.GetFaceZonesOfObjectsRequest
147
147
  ) -> MeshingQueriesProtoModule.GetFaceZonesOfObjectsResponse:
148
- """GetFaceZonesOfObjects rpc of MeshingQueriesService."""
148
+ """get_face_zones_of_objects rpc of MeshingQueriesService."""
149
149
  return self._stub.GetFaceZonesOfObjects(request, metadata=self._metadata)
150
150
 
151
151
  @catch_grpc_error
152
- def GetEdgeZonesOfObjects(
152
+ def get_edge_zones_of_objects(
153
153
  self, request: MeshingQueriesProtoModule.GetEdgeZonesOfObjectsRequest
154
154
  ) -> MeshingQueriesProtoModule.GetEdgeZonesOfObjectsResponse:
155
- """GetEdgeZonesOfObjects rpc of MeshingQueriesService."""
155
+ """get_edge_zones_of_objects rpc of MeshingQueriesService."""
156
156
  return self._stub.GetEdgeZonesOfObjects(request, metadata=self._metadata)
157
157
 
158
158
  @catch_grpc_error
159
- def GetFaceZoneIdListOfRegions(
159
+ def get_face_zone_id_list_of_regions(
160
160
  self,
161
161
  request: MeshingQueriesProtoModule.GetFaceZoneIdListOfRegionsRequest,
162
162
  ) -> MeshingQueriesProtoModule.GetFaceZoneIdListOfRegionsResponse:
163
- """GetEdgeZonesOfObjects rpc of MeshingQueriesService."""
163
+ """get_face_zone_id_list_of_regions rpc of MeshingQueriesService."""
164
164
  return self._stub.GetFaceZoneIdListOfRegions(request, metadata=self._metadata)
165
165
 
166
166
  @catch_grpc_error
167
- def GetPrismCellZones(
167
+ def get_prism_cell_zones(
168
168
  self,
169
169
  request: MeshingQueriesProtoModule.GetPrismCellZonesRequest,
170
170
  ) -> MeshingQueriesProtoModule.GetPrismCellZonesResponse:
171
- """GetPrismCellZones rpc of MeshingQueriesService."""
171
+ """get_prism_cell_zones rpc of MeshingQueriesService."""
172
172
  return self._stub.GetPrismCellZones(request, metadata=self._metadata)
173
173
 
174
174
  @catch_grpc_error
175
- def GetTetCellZones(
175
+ def get_tet_cell_zones(
176
176
  self,
177
177
  request: MeshingQueriesProtoModule.GetTetCellZonesRequest,
178
178
  ) -> MeshingQueriesProtoModule.GetTetCellZonesResponse:
179
- """GetTetCellZones rpc of MeshingQueriesService."""
179
+ """get_tet_cell_zones rpc of MeshingQueriesService."""
180
180
  return self._stub.GetTetCellZones(request, metadata=self._metadata)
181
181
 
182
182
  @catch_grpc_error
183
- def GetAdjacentCellZones(
183
+ def get_adjacent_cell_zones(
184
184
  self,
185
185
  request: MeshingQueriesProtoModule.GetAdjacentCellZonesRequest,
186
186
  ) -> MeshingQueriesProtoModule.GetAdjacentCellZonesResponse:
187
- """GetAdjacentCellZones rpc of MeshingQueriesService."""
187
+ """get_adjacent_cell_zones rpc of MeshingQueriesService."""
188
188
  return self._stub.GetAdjacentCellZones(request, metadata=self._metadata)
189
189
 
190
190
  @catch_grpc_error
191
- def GetAdjacentFaceZones(
191
+ def get_adjacent_face_zones(
192
192
  self,
193
193
  request: MeshingQueriesProtoModule.GetAdjacentFaceZonesRequest,
194
194
  ) -> MeshingQueriesProtoModule.GetAdjacentFaceZonesResponse:
195
- """GetAdjacentFaceZones rpc of MeshingQueriesService."""
195
+ """get_adjacent_face_zones rpc of MeshingQueriesService."""
196
196
  return self._stub.GetAdjacentFaceZones(request, metadata=self._metadata)
197
197
 
198
198
  @catch_grpc_error
199
- def GetAdjacentInteriorAndBoundaryFaceZones(
199
+ def get_adjacent_interior_and_boundary_face_zones(
200
200
  self,
201
201
  request: MeshingQueriesProtoModule.GetAdjacentInteriorAndBoundaryFaceZonesRequest,
202
202
  ) -> MeshingQueriesProtoModule.GetAdjacentInteriorAndBoundaryFaceZonesResponse:
203
- """GetAdjacentInteriorAndBoundaryFaceZones rpc of MeshingQueriesService."""
203
+ """get_adjacent_interior_and_boundary_face_zones rpc of MeshingQueriesService."""
204
204
  return self._stub.GetAdjacentInteriorAndBoundaryFaceZones(
205
205
  request, metadata=self._metadata
206
206
  )
207
207
 
208
208
  @catch_grpc_error
209
- def GetAdjacentZonesByEdgeConnectivity(
209
+ def get_adjacent_zones_by_edge_connectivity(
210
210
  self,
211
211
  request: MeshingQueriesProtoModule.GetAdjacentZonesByEdgeConnectivityRequest,
212
212
  ) -> MeshingQueriesProtoModule.GetAdjacentZonesByEdgeConnectivityResponse:
213
- """GetAdjacentZonesByEdgeConnectivity rpc of MeshingQueriesService."""
213
+ """get_adjacent_zones_by_edge_connectivity rpc of MeshingQueriesService."""
214
214
  return self._stub.GetAdjacentZonesByEdgeConnectivity(
215
215
  request, metadata=self._metadata
216
216
  )
217
217
 
218
218
  @catch_grpc_error
219
- def GetAdjacentZonesByNodeConnectivity(
219
+ def get_adjacent_zones_by_node_connectivity(
220
220
  self,
221
221
  request: MeshingQueriesProtoModule.GetAdjacentZonesByNodeConnectivityRequest,
222
222
  ) -> MeshingQueriesProtoModule.GetAdjacentZonesByNodeConnectivityResponse:
223
- """GetAdjacentZonesByNodeConnectivity rpc of MeshingQueriesService."""
223
+ """get_adjacent_zones_by_node_connectivity rpc of MeshingQueriesService."""
224
224
  return self._stub.GetAdjacentZonesByNodeConnectivity(
225
225
  request, metadata=self._metadata
226
226
  )
227
227
 
228
228
  @catch_grpc_error
229
- def GetSharedBoundaryZones(
229
+ def get_shared_boundary_zones(
230
230
  self,
231
231
  request: MeshingQueriesProtoModule.GetSharedBoundaryZonesRequest,
232
232
  ) -> MeshingQueriesProtoModule.GetSharedBoundaryZonesResponse:
233
- """GetSharedBoundaryZones rpc of MeshingQueriesService."""
233
+ """get_shared_boundary_zones rpc of MeshingQueriesService."""
234
234
  return self._stub.GetSharedBoundaryZones(request, metadata=self._metadata)
235
235
 
236
236
  @catch_grpc_error
237
- def GetInteriorZonesConnectedToCellZones(
237
+ def get_interior_zones_connected_to_cell_zones(
238
238
  self,
239
239
  request: MeshingQueriesProtoModule.GetInteriorZonesConnectedToCellZonesRequest,
240
240
  ) -> MeshingQueriesProtoModule.GetInteriorZonesConnectedToCellZonesResponse:
241
- """GetInteriorZonesConnectedToCellZones rpc of MeshingQueriesService."""
241
+ """get_interior_zones_connected_to_cell_zones rpc of MeshingQueriesService."""
242
242
  return self._stub.GetInteriorZonesConnectedToCellZones(
243
243
  request, metadata=self._metadata
244
244
  )
245
245
 
246
246
  @catch_grpc_error
247
- def GetFaceZonesWithZoneSpecificPrismsApplied(
247
+ def get_face_zones_with_zone_specific_prisms_applied(
248
248
  self,
249
249
  request: MeshingQueriesProtoModule.Empty,
250
250
  ) -> MeshingQueriesProtoModule.GetFaceZonesWithZoneSpecificPrismsAppliedResponse:
251
- """GetFaceZonesWithZoneSpecificPrismsApplied rpc of MeshingQueriesService."""
251
+ """get_face_zones_with_zone_specific_prisms_applied rpc of MeshingQueriesService."""
252
252
  return self._stub.GetFaceZonesWithZoneSpecificPrismsApplied(
253
253
  request, metadata=self._metadata
254
254
  )
255
255
 
256
256
  @catch_grpc_error
257
- def GetFaceZonesOfPrismControls(
257
+ def get_face_zones_of_prism_controls(
258
258
  self,
259
259
  request: MeshingQueriesProtoModule.GetFaceZonesOfPrismControlsRequest,
260
260
  ) -> MeshingQueriesProtoModule.GetFaceZonesOfPrismControlsResponse:
261
- """GetFaceZonesOfPrismControls rpc of MeshingQueriesService."""
261
+ """get_face_zones_of_prism_controls rpc of MeshingQueriesService."""
262
262
  return self._stub.GetFaceZonesOfPrismControls(request, metadata=self._metadata)
263
263
 
264
264
  @catch_grpc_error
265
- def GetBaffles(
265
+ def get_baffles(
266
266
  self,
267
267
  request: MeshingQueriesProtoModule.GetBafflesRequest,
268
268
  ) -> MeshingQueriesProtoModule.GetBafflesResponse:
269
- """GetBaffles rpc of MeshingQueriesService."""
269
+ """get_baffles rpc of MeshingQueriesService."""
270
270
  return self._stub.GetBaffles(request, metadata=self._metadata)
271
271
 
272
272
  @catch_grpc_error
273
- def GetEmbeddedBaffles(
273
+ def get_embedded_baffles(
274
274
  self,
275
275
  request: MeshingQueriesProtoModule.Empty,
276
276
  ) -> MeshingQueriesProtoModule.GetEmbeddedBafflesResponse:
277
- """GetEmbeddedBaffles rpc of MeshingQueriesService."""
277
+ """get_embedded_baffles rpc of MeshingQueriesService."""
278
278
  return self._stub.GetEmbeddedBaffles(request, metadata=self._metadata)
279
279
 
280
280
  @catch_grpc_error
281
- def GetWrappedZones(
281
+ def get_wrapped_zones(
282
282
  self,
283
283
  request: MeshingQueriesProtoModule.Empty,
284
284
  ) -> MeshingQueriesProtoModule.GetWrappedZonesResponse:
285
- """GetWrappedZones rpc of MeshingQueriesService."""
285
+ """get_wrapped_zones rpc of MeshingQueriesService."""
286
286
  return self._stub.GetWrappedZones(request, metadata=self._metadata)
287
287
 
288
288
  @catch_grpc_error
289
- def GetUnreferencedEdgeZones(
289
+ def get_unreferenced_edge_zones(
290
290
  self,
291
291
  request: MeshingQueriesProtoModule.Empty,
292
292
  ) -> MeshingQueriesProtoModule.GetUnreferencedEdgeZonesResponse:
293
- """GetUnreferencedEdgeZones rpc of MeshingQueriesService."""
293
+ """get_unreferenced_edge_zones rpc of MeshingQueriesService."""
294
294
  return self._stub.GetUnreferencedEdgeZones(request, metadata=self._metadata)
295
295
 
296
296
  @catch_grpc_error
297
- def GetUnreferencedFaceZones(
297
+ def get_unreferenced_face_zones(
298
298
  self,
299
299
  request: MeshingQueriesProtoModule.Empty,
300
300
  ) -> MeshingQueriesProtoModule.GetUnreferencedFaceZonesResponse:
301
- """GetUnreferencedFaceZones rpc of MeshingQueriesService."""
301
+ """get_unreferenced_face_zones rpc of MeshingQueriesService."""
302
302
  return self._stub.GetUnreferencedFaceZones(request, metadata=self._metadata)
303
303
 
304
304
  @catch_grpc_error
305
- def GetUnreferencedCellZones(
305
+ def get_unreferenced_cell_zones(
306
306
  self,
307
307
  request: MeshingQueriesProtoModule.Empty,
308
308
  ) -> MeshingQueriesProtoModule.GetUnreferencedCellZonesResponse:
309
- """GetUnreferencedCellZones rpc of MeshingQueriesService."""
309
+ """get_unreferenced_cell_zones rpc of MeshingQueriesService."""
310
310
  return self._stub.GetUnreferencedCellZones(request, metadata=self._metadata)
311
311
 
312
312
  @catch_grpc_error
313
- def GetUnreferencedEdgeZonesOfFilter(
313
+ def get_unreferenced_edge_zones_of_filter(
314
314
  self,
315
315
  request: MeshingQueriesProtoModule.GetUnreferencedEdgeZonesOfFilterRequest,
316
316
  ) -> MeshingQueriesProtoModule.GetUnreferencedEdgeZonesOfFilterResponse:
317
- """GetUnreferencedEdgeZonesOfFilter rpc of MeshingQueriesService."""
317
+ """get_unreferenced_edge_zones_of_filter rpc of MeshingQueriesService."""
318
318
  return self._stub.GetUnreferencedEdgeZonesOfFilter(
319
319
  request, metadata=self._metadata
320
320
  )
321
321
 
322
322
  @catch_grpc_error
323
- def GetUnreferencedFaceZonesOfFilter(
323
+ def get_unreferenced_face_zones_of_filter(
324
324
  self,
325
325
  request: MeshingQueriesProtoModule.GetUnreferencedFaceZonesOfFilterRequest,
326
326
  ) -> MeshingQueriesProtoModule.GetUnreferencedFaceZonesOfFilterResponse:
327
- """GetUnreferencedFaceZonesOfFilter rpc of MeshingQueriesService."""
327
+ """get_unreferenced_face_zones_of_filter rpc of MeshingQueriesService."""
328
328
  return self._stub.GetUnreferencedFaceZonesOfFilter(
329
329
  request, metadata=self._metadata
330
330
  )
331
331
 
332
332
  @catch_grpc_error
333
- def GetUnreferencedCellZonesOfFilter(
333
+ def get_unreferenced_cell_zones_of_filter(
334
334
  self,
335
335
  request: MeshingQueriesProtoModule.GetUnreferencedCellZonesOfFilterRequest,
336
336
  ) -> MeshingQueriesProtoModule.GetUnreferencedCellZonesOfFilterResponse:
337
- """GetUnreferencedCellZonesOfFilter rpc of MeshingQueriesService."""
337
+ """get_unreferenced_cell_zones_of_filter rpc of MeshingQueriesService."""
338
338
  return self._stub.GetUnreferencedCellZonesOfFilter(
339
339
  request, metadata=self._metadata
340
340
  )
341
341
 
342
342
  @catch_grpc_error
343
- def GetUnreferencedEdgeZoneIdListOfPattern(
343
+ def get_unreferenced_edge_zone_id_list_of_pattern(
344
344
  self,
345
345
  request: MeshingQueriesProtoModule.GetUnreferencedEdgeZoneIdListOfPatternRequest,
346
346
  ) -> MeshingQueriesProtoModule.GetUnreferencedEdgeZoneIdListOfPatternResponse:
347
- """GetUnreferencedEdgeZoneIdListOfPattern rpc of MeshingQueriesService."""
347
+ """get_unreferenced_edge_zone_id_list_of_pattern rpc of MeshingQueriesService."""
348
348
  return self._stub.GetUnreferencedEdgeZoneIdListOfPattern(
349
349
  request, metadata=self._metadata
350
350
  )
351
351
 
352
352
  @catch_grpc_error
353
- def GetUnreferencedFaceZoneIdListOfPattern(
353
+ def get_unreferenced_face_zone_id_list_of_pattern(
354
354
  self,
355
355
  request: MeshingQueriesProtoModule.GetUnreferencedFaceZoneIdListOfPatternRequest,
356
356
  ) -> MeshingQueriesProtoModule.GetUnreferencedFaceZoneIdListOfPatternResponse:
357
- """GetUnreferencedFaceZoneIdListOfPattern rpc of MeshingQueriesService."""
357
+ """get_unreferenced_face_zone_id_list_of_pattern rpc of MeshingQueriesService."""
358
358
  return self._stub.GetUnreferencedFaceZoneIdListOfPattern(
359
359
  request, metadata=self._metadata
360
360
  )
361
361
 
362
362
  @catch_grpc_error
363
- def GetUnreferencedCellZoneIdListOfPattern(
363
+ def get_unreferenced_cell_zone_id_list_of_pattern(
364
364
  self,
365
365
  request: MeshingQueriesProtoModule.GetUnreferencedCellZoneIdListOfPatternRequest,
366
366
  ) -> MeshingQueriesProtoModule.GetUnreferencedCellZoneIdListOfPatternResponse:
367
- """GetUnreferencedCellZoneIdListOfPattern rpc of MeshingQueriesService."""
367
+ """get_unreferenced_cell_zone_id_list_of_pattern rpc of MeshingQueriesService."""
368
368
  return self._stub.GetUnreferencedCellZoneIdListOfPattern(
369
369
  request, metadata=self._metadata
370
370
  )
371
371
 
372
372
  @catch_grpc_error
373
- def GetMaxsizeCellZoneByVolume(
373
+ def get_maxsize_cell_zone_by_volume(
374
374
  self,
375
375
  request: MeshingQueriesProtoModule.GetMaxsizeCellZoneByVolumeRequest,
376
376
  ) -> MeshingQueriesProtoModule.GetMaxsizeCellZoneByVolumeResponse:
377
- """GetMaxsizeCellZoneByVolume rpc of MeshingQueriesService."""
377
+ """get_maxsize_cell_zone_by_volume rpc of MeshingQueriesService."""
378
378
  return self._stub.GetMaxsizeCellZoneByVolume(request, metadata=self._metadata)
379
379
 
380
380
  @catch_grpc_error
381
- def GetMaxsizeCellZoneByCount(
381
+ def get_maxsize_cell_zone_by_count(
382
382
  self,
383
383
  request: MeshingQueriesProtoModule.GetMaxsizeCellZoneByCountRequest,
384
384
  ) -> MeshingQueriesProtoModule.GetMaxsizeCellZoneByCountResponse:
385
- """GetMaxsizeCellZoneByCount rpc of MeshingQueriesService."""
385
+ """get_maxsize_cell_zone_by_count rpc of MeshingQueriesService."""
386
386
  return self._stub.GetMaxsizeCellZoneByCount(request, metadata=self._metadata)
387
387
 
388
388
  @catch_grpc_error
389
- def GetMinsizeFaceZoneByArea(
389
+ def get_minsize_face_zone_by_area(
390
390
  self,
391
391
  request: MeshingQueriesProtoModule.GetMinsizeFaceZoneByAreaRequest,
392
392
  ) -> MeshingQueriesProtoModule.GetMinsizeFaceZoneByAreaResponse:
393
- """GetMinsizeFaceZoneByArea rpc of MeshingQueriesService."""
393
+ """get_minsize_face_zone_by_area rpc of MeshingQueriesService."""
394
394
  return self._stub.GetMinsizeFaceZoneByArea(request, metadata=self._metadata)
395
395
 
396
396
  @catch_grpc_error
397
- def GetMinsizeFaceZoneByCount(
397
+ def get_minsize_face_zone_by_count(
398
398
  self,
399
399
  request: MeshingQueriesProtoModule.GetMinsizeFaceZoneByCountRequest,
400
400
  ) -> MeshingQueriesProtoModule.GetMinsizeFaceZoneByCountResponse:
401
- """GetMinsizeFaceZoneByCount rpc of MeshingQueriesService."""
401
+ """get_minsize_face_zone_by_count rpc of MeshingQueriesService."""
402
402
  return self._stub.GetMinsizeFaceZoneByCount(request, metadata=self._metadata)
403
403
 
404
404
  @catch_grpc_error
405
- def GetFaceZoneListByMaximumEntityCount(
405
+ def get_face_zone_list_by_maximum_entity_count(
406
406
  self,
407
407
  request: MeshingQueriesProtoModule.GetFaceZoneListByMaximumEntityCountRequest,
408
408
  ) -> MeshingQueriesProtoModule.GetFaceZoneListByMaximumEntityCountResponse:
409
- """GetFaceZoneListByMaximumEntityCount rpc of MeshingQueriesService."""
409
+ """get_face_zone_list_by_maximum_entity_count rpc of MeshingQueriesService."""
410
410
  return self._stub.GetFaceZoneListByMaximumEntityCount(
411
411
  request, metadata=self._metadata
412
412
  )
413
413
 
414
414
  @catch_grpc_error
415
- def GetEdgeZoneListByMaximumEntityCount(
415
+ def get_edge_zone_list_by_maximum_entity_count(
416
416
  self,
417
417
  request: MeshingQueriesProtoModule.GetEdgeZoneListByMaximumEntityCountRequest,
418
418
  ) -> MeshingQueriesProtoModule.GetEdgeZoneListByMaximumEntityCountResponse:
419
- """GetEdgeZoneListByMaximumEntityCount rpc of MeshingQueriesService."""
419
+ """get_edge_zone_list_by_maximum_entity_count rpc of MeshingQueriesService."""
420
420
  return self._stub.GetEdgeZoneListByMaximumEntityCount(
421
421
  request, metadata=self._metadata
422
422
  )
423
423
 
424
424
  @catch_grpc_error
425
- def GetCellZoneListByMaximumEntityCount(
425
+ def get_cell_zone_list_by_maximum_entity_count(
426
426
  self,
427
427
  request: MeshingQueriesProtoModule.GetCellZoneListByMaximumEntityCountRequest,
428
428
  ) -> MeshingQueriesProtoModule.GetCellZoneListByMaximumEntityCountResponse:
429
- """GetCellZoneListByMaximumEntityCount rpc of MeshingQueriesService."""
429
+ """get_cell_zone_list_by_maximum_entity_count rpc of MeshingQueriesService."""
430
430
  return self._stub.GetCellZoneListByMaximumEntityCount(
431
431
  request, metadata=self._metadata
432
432
  )
433
433
 
434
434
  @catch_grpc_error
435
- def GetFaceZoneListByMaximumZoneArea(
435
+ def get_face_zone_list_by_maximum_zone_area(
436
436
  self,
437
437
  request: MeshingQueriesProtoModule.GetFaceZoneListByMaximumZoneAreaRequest,
438
438
  ) -> MeshingQueriesProtoModule.GetFaceZoneListByMaximumZoneAreaResponse:
439
- """GetFaceZoneListByMaximumZoneArea rpc of MeshingQueriesService."""
439
+ """get_face_zone_list_by_maximum_zone_area rpc of MeshingQueriesService."""
440
440
  return self._stub.GetFaceZoneListByMaximumZoneArea(
441
441
  request, metadata=self._metadata
442
442
  )
443
443
 
444
444
  @catch_grpc_error
445
- def GetFaceZoneListByMinimumZoneArea(
445
+ def get_face_zone_list_by_minimum_zone_area(
446
446
  self,
447
447
  request: MeshingQueriesProtoModule.GetFaceZoneListByMinimumZoneAreaRequest,
448
448
  ) -> MeshingQueriesProtoModule.GetFaceZoneListByMinimumZoneAreaResponse:
449
- """GetFaceZoneListByMinimumZoneArea rpc of MeshingQueriesService."""
449
+ """get_face_zone_list_by_minimum_zone_area rpc of MeshingQueriesService."""
450
450
  return self._stub.GetFaceZoneListByMinimumZoneArea(
451
451
  request, metadata=self._metadata
452
452
  )
453
453
 
454
454
  @catch_grpc_error
455
- def GetZonesWithFreeFaces(
455
+ def get_zones_with_free_faces(
456
456
  self,
457
457
  request: MeshingQueriesProtoModule.GetZonesWithFreeFacesRequest,
458
458
  ) -> MeshingQueriesProtoModule.GetZonesWithFreeFacesResponse:
459
- """GetZonesWithFreeFaces rpc of MeshingQueriesService."""
459
+ """get_zones_with_free_faces rpc of MeshingQueriesService."""
460
460
  return self._stub.GetZonesWithFreeFaces(request, metadata=self._metadata)
461
461
 
462
462
  @catch_grpc_error
463
- def GetZonesWithFreeFaces(
463
+ def get_zones_with_free_faces(
464
464
  self,
465
465
  request: MeshingQueriesProtoModule.GetZonesWithFreeFacesRequest,
466
466
  ) -> MeshingQueriesProtoModule.GetZonesWithFreeFacesResponse:
467
- """GetZonesWithFreeFaces rpc of MeshingQueriesService."""
467
+ """get_zones_with_free_faces rpc of MeshingQueriesService."""
468
468
  return self._stub.GetZonesWithFreeFaces(request, metadata=self._metadata)
469
469
 
470
470
  @catch_grpc_error
471
- def GetZonesWithMultiFaces(
471
+ def get_zones_with_multi_faces(
472
472
  self,
473
473
  request: MeshingQueriesProtoModule.GetZonesWithMultiFacesRequest,
474
474
  ) -> MeshingQueriesProtoModule.GetZonesWithMultiFacesResponse:
475
- """GetZonesWithMultiFaces rpc of MeshingQueriesService."""
475
+ """get_zones_with_multi_faces rpc of MeshingQueriesService."""
476
476
  return self._stub.GetZonesWithMultiFaces(request, metadata=self._metadata)
477
477
 
478
478
  @catch_grpc_error
479
- def GetOverlappingFaceZones(
479
+ def get_overlapping_face_zones(
480
480
  self,
481
481
  request: MeshingQueriesProtoModule.GetOverlappingFaceZonesRequest,
482
482
  ) -> MeshingQueriesProtoModule.GetOverlappingFaceZonesResponse:
483
- """GetOverlappingFaceZones rpc of MeshingQueriesService."""
483
+ """get_overlapping_face_zones rpc of MeshingQueriesService."""
484
484
  return self._stub.GetOverlappingFaceZones(request, metadata=self._metadata)
485
485
 
486
486
  @catch_grpc_error
487
- def GetZonesWithMultiFaces(
487
+ def get_zones_with_multi_faces(
488
488
  self,
489
489
  request: MeshingQueriesProtoModule.GetZonesWithMultiFacesRequest,
490
490
  ) -> MeshingQueriesProtoModule.GetZonesWithMultiFacesResponse:
491
- """GetZonesWithMultiFaces rpc of MeshingQueriesService."""
491
+ """get_zones_with_multi_faces rpc of MeshingQueriesService."""
492
492
  return self._stub.GetZonesWithMultiFaces(request, metadata=self._metadata)
493
493
 
494
494
  @catch_grpc_error
495
- def GetZonesWithMarkedFaces(
495
+ def get_zones_with_marked_faces(
496
496
  self,
497
497
  request: MeshingQueriesProtoModule.GetZonesWithMarkedFacesRequest,
498
498
  ) -> MeshingQueriesProtoModule.GetZonesWithMarkedFacesResponse:
499
- """GetZonesWithMarkedFaces rpc of MeshingQueriesService."""
499
+ """get_zones_with_marked_faces rpc of MeshingQueriesService."""
500
500
  return self._stub.GetZonesWithMarkedFaces(request, metadata=self._metadata)
501
501
 
502
502
  @catch_grpc_error
503
- def GetZonesWithMarkedFaces(
504
- self,
505
- request: MeshingQueriesProtoModule.GetZonesWithMarkedFacesRequest,
506
- ) -> MeshingQueriesProtoModule.GetZonesWithMarkedFacesResponse:
507
- """GetZonesWithMarkedFaces rpc of MeshingQueriesService."""
508
- return self._stub.GetZonesWithMarkedFaces(request, metadata=self._metadata)
509
-
510
- @catch_grpc_error
511
- def GetAllObjectNameList(
503
+ def get_all_object_name_list(
512
504
  self,
513
505
  request: MeshingQueriesProtoModule.Empty,
514
506
  ) -> MeshingQueriesProtoModule.GetAllObjectNameListResponse:
515
- """GetAllObjectNameList rpc of MeshingQueriesService."""
507
+ """get_all_object_name_list rpc of MeshingQueriesService."""
516
508
  return self._stub.GetAllObjectNameList(request, metadata=self._metadata)
517
509
 
518
510
  @catch_grpc_error
519
- def GetObjectNameListOfType(
511
+ def get_object_name_list_of_type(
520
512
  self,
521
513
  request: MeshingQueriesProtoModule.GetObjectNameListOfTypeRequest,
522
514
  ) -> MeshingQueriesProtoModule.GetObjectNameListOfTypeResponse:
523
- """GetObjectNameListOfType rpc of MeshingQueriesService."""
515
+ """get_object_name_list_of_type rpc of MeshingQueriesService."""
524
516
  return self._stub.GetObjectNameListOfType(request, metadata=self._metadata)
525
517
 
526
518
  @catch_grpc_error
527
- def GetObjectsOfFilter(
528
- self,
529
- request: MeshingQueriesProtoModule.GetObjectsOfFilterRequest,
530
- ) -> MeshingQueriesProtoModule.GetObjectsOfFilterResponse:
531
- """GetObjectsOfFilter rpc of MeshingQueriesService."""
532
- return self._stub.GetObjectsOfFilter(request, metadata=self._metadata)
533
-
534
- @catch_grpc_error
535
- def GetObjectsOfFilter(
519
+ def get_objects_of_filter(
536
520
  self,
537
521
  request: MeshingQueriesProtoModule.GetObjectsOfFilterRequest,
538
522
  ) -> MeshingQueriesProtoModule.GetObjectsOfFilterResponse:
539
- """GetObjectsOfFilter rpc of MeshingQueriesService."""
523
+ """get_objects_of_filter rpc of MeshingQueriesService."""
540
524
  return self._stub.GetObjectsOfFilter(request, metadata=self._metadata)
541
525
 
542
526
  @catch_grpc_error
543
- def GetRegionsOfObject(
527
+ def get_regions_of_object(
544
528
  self,
545
529
  request: MeshingQueriesProtoModule.GetRegionsOfObjectRequest,
546
530
  ) -> MeshingQueriesProtoModule.GetRegionsOfObjectResponse:
547
- """GetRegionsOfObject rpc of MeshingQueriesService."""
531
+ """get_regions_of_object rpc of MeshingQueriesService."""
548
532
  return self._stub.GetRegionsOfObject(request, metadata=self._metadata)
549
533
 
550
534
  @catch_grpc_error
551
- def GetRegionNameListOfObject(
535
+ def get_region_name_list_of_object(
552
536
  self,
553
537
  request: MeshingQueriesProtoModule.GetRegionNameListOfObjectRequest,
554
538
  ) -> MeshingQueriesProtoModule.GetRegionNameListOfObjectResponse:
555
- """GetRegionNameListOfObject rpc of MeshingQueriesService."""
539
+ """get_region_name_list_of_object rpc of MeshingQueriesService."""
556
540
  return self._stub.GetRegionNameListOfObject(request, metadata=self._metadata)
557
541
 
558
542
  @catch_grpc_error
559
- def SortRegionsByVolume(
543
+ def sort_regions_by_volume(
560
544
  self,
561
545
  request: MeshingQueriesProtoModule.SortRegionsByVolumeRequest,
562
546
  ) -> MeshingQueriesProtoModule.SortRegionsByVolumeResponse:
563
- """SortRegionsByVolume rpc of MeshingQueriesService."""
547
+ """sort_regions_by_volume rpc of MeshingQueriesService."""
564
548
  return self._stub.SortRegionsByVolume(request, metadata=self._metadata)
565
549
 
566
550
  @catch_grpc_error
567
- def GetRegionVolume(
551
+ def get_region_volume(
568
552
  self,
569
553
  request: MeshingQueriesProtoModule.GetRegionVolumeRequest,
570
554
  ) -> MeshingQueriesProtoModule.GetRegionVolumeResponse:
571
- """GetRegionVolume rpc of MeshingQueriesService."""
555
+ """get_region_volume rpc of MeshingQueriesService."""
572
556
  return self._stub.GetRegionVolume(request, metadata=self._metadata)
573
557
 
574
558
  @catch_grpc_error
575
- def GetRegionsOfFilter(
559
+ def get_regions_of_filter(
576
560
  self,
577
561
  request: MeshingQueriesProtoModule.GetRegionsOfFilterRequest,
578
562
  ) -> MeshingQueriesProtoModule.GetRegionsOfFilterResponse:
579
- """GetRegionsOfFilter rpc of MeshingQueriesService."""
563
+ """get_regions_of_filter rpc of MeshingQueriesService."""
580
564
  return self._stub.GetRegionsOfFilter(request, metadata=self._metadata)
581
565
 
582
566
  @catch_grpc_error
583
- def GetRegionNameListOfPattern(
567
+ def get_region_name_list_of_pattern(
584
568
  self,
585
569
  request: MeshingQueriesProtoModule.GetRegionNameListOfPatternRequest,
586
570
  ) -> MeshingQueriesProtoModule.GetRegionNameListOfPatternResponse:
587
- """GetRegionNameListOfPattern rpc of MeshingQueriesService."""
571
+ """get_region_name_list_of_pattern rpc of MeshingQueriesService."""
588
572
  return self._stub.GetRegionNameListOfPattern(request, metadata=self._metadata)
589
573
 
590
574
  @catch_grpc_error
591
- def GetRegionsOfFaceZones(
575
+ def get_regions_of_face_zones(
592
576
  self,
593
577
  request: MeshingQueriesProtoModule.GetRegionsOfFaceZonesRequest,
594
578
  ) -> MeshingQueriesProtoModule.GetRegionsOfFaceZonesResponse:
595
- """GetRegionsOfFaceZones rpc of MeshingQueriesService."""
579
+ """get_regions_of_face_zones rpc of MeshingQueriesService."""
596
580
  return self._stub.GetRegionsOfFaceZones(request, metadata=self._metadata)
597
581
 
598
582
  @catch_grpc_error
599
- def FindJoinPairs(
583
+ def find_join_pairs(
600
584
  self,
601
585
  request: MeshingQueriesProtoModule.FindJoinPairsRequest,
602
586
  ) -> MeshingQueriesProtoModule.FindJoinPairsResponse:
603
- """FindJoinPairs rpc of MeshingQueriesService."""
587
+ """find_join_pairs rpc of MeshingQueriesService."""
604
588
  return self._stub.FindJoinPairs(request, metadata=self._metadata)
605
589
 
606
590
  @catch_grpc_error
607
- def GetRegionNameListOfFaceZones(
591
+ def get_region_name_list_of_face_zones(
608
592
  self,
609
593
  request: MeshingQueriesProtoModule.GetRegionNameListOfFaceZonesRequest,
610
594
  ) -> MeshingQueriesProtoModule.GetRegionNameListOfFaceZonesResponse:
611
- """GetRegionNameListOfFaceZones rpc of MeshingQueriesService."""
595
+ """get_region_name_list_of_face_zones rpc of MeshingQueriesService."""
612
596
  return self._stub.GetRegionNameListOfFaceZones(request, metadata=self._metadata)
613
597
 
614
598
 
615
599
  class MeshingQueries:
616
600
  """
617
- MeshingQueries.
601
+ Meshing Queries.
618
602
  """
619
603
 
620
604
  def __init__(self, service: MeshingQueriesService):
621
605
  """__init__ method of MeshingQueries class."""
622
606
  self.service = service
607
+ self.region_types = ["fluid-fluid", "solid-solid", "fluid-solid"]
608
+ self.orders = ["ascending", "descending"]
623
609
 
624
610
  docstring = None
625
611
 
626
- def GetFaceZoneAtLocation(self, location) -> Any:
627
- """GetFaceZoneAtLocation."""
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
+ """
628
682
  request = MeshingQueriesProtoModule.GetFaceZoneAtLocationRequest()
629
683
  request.location.x = location[0]
630
684
  request.location.y = location[1]
631
685
  request.location.z = location[2]
632
- response = self.service.GetFaceZoneAtLocation(request)
686
+ response = self.service.get_face_zone_at_location(request)
633
687
  return response.face_zone_id
634
688
 
635
- def GetCellZoneAtLocation(self, location) -> Any:
636
- """GetCellZoneAtLocation."""
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
+ """
637
698
  request = MeshingQueriesProtoModule.GetCellZoneAtLocationRequest()
638
699
  request.location.x = location[0]
639
700
  request.location.y = location[1]
640
701
  request.location.z = location[2]
641
- response = self.service.GetCellZoneAtLocation(request)
702
+ response = self.service.get_cell_zone_at_location(request)
642
703
  return response.cell_zone_id
643
704
 
644
- def GetZonesOfType(self, type) -> Any:
645
- """GetZonesOfType."""
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
+ """
646
714
  request = MeshingQueriesProtoModule.GetZonesOfTypeRequest()
647
715
  request.type = type
648
- response = self.service.GetZonesOfType(request)
716
+ response = self.service.get_zones_of_type(request)
649
717
  return response.zone_ids
650
718
 
651
- def GetZonesOfGroup(self, group) -> Any:
652
- """GetZonesOfGroup."""
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
+ """
653
728
  request = MeshingQueriesProtoModule.GetZonesOfGroupRequest()
654
729
  request.group = group
655
- response = self.service.GetZonesOfGroup(request)
730
+ response = self.service.get_zones_of_group(request)
656
731
  return response.zone_ids
657
732
 
658
- def GetFaceZonesOfFilter(self, filter) -> Any:
659
- """GetFaceZonesOfFilter."""
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
+ """
660
742
  request = MeshingQueriesProtoModule.GetFaceZonesOfFilterRequest()
661
743
  request.filter = filter
662
- response = self.service.GetFaceZonesOfFilter(request)
744
+ response = self.service.get_face_zones_of_filter(request)
663
745
  return response.face_zone_ids
664
746
 
665
- def GetCellZonesOfFilter(self, filter) -> Any:
666
- """GetCellZonesOfFilter."""
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
+ """
667
756
  request = MeshingQueriesProtoModule.GetCellZonesOfFilterRequest()
668
757
  request.filter = filter
669
- response = self.service.GetCellZonesOfFilter(request)
758
+ response = self.service.get_cell_zones_of_filter(request)
670
759
  return response.cell_zone_ids
671
760
 
672
- def GetEdgeZonesOfFilter(self, filter) -> Any:
673
- """GetEdgeZonesOfFilter."""
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
+ """
674
770
  request = MeshingQueriesProtoModule.GetEdgeZonesOfFilterRequest()
675
771
  request.filter = filter
676
- response = self.service.GetEdgeZonesOfFilter(request)
772
+ response = self.service.get_edge_zones_of_filter(request)
677
773
  return response.edge_zone_ids
678
774
 
679
- def GetNodeZonesOfFilter(self, filter) -> Any:
680
- """GetNodeZonesOfFilter."""
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
+ """
681
784
  request = MeshingQueriesProtoModule.GetNodeZonesOfFilterRequest()
682
785
  request.filter = filter
683
- response = self.service.GetNodeZonesOfFilter(request)
786
+ response = self.service.get_node_zones_of_filter(request)
684
787
  return response.node_zone_ids
685
788
 
686
- def GetObjectsOfType(self, type) -> Any:
687
- """GetObjectsOfType."""
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
+ """
688
798
  request = MeshingQueriesProtoModule.GetObjectsOfTypeRequest()
689
799
  request.type = type
690
- response = self.service.GetObjectsOfType(request)
800
+ response = self.service.get_objects_of_type(request)
691
801
  return response.objects
692
802
 
693
- def GetFaceZoneIdListOfObject(self, object) -> Any:
694
- """GetFaceZoneIdListOfObject."""
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)
695
813
  request = MeshingQueriesProtoModule.GetFaceZoneIdListOfObjectRequest()
696
814
  request.object = object
697
- response = self.service.GetFaceZoneIdListOfObject(request)
815
+ response = self.service.get_face_zone_id_list_of_object(request)
698
816
  return response.face_zone_ids
699
817
 
700
- def GetEdgeZoneIdListOfObject(self, object) -> Any:
701
- """GetEdgeZoneIdListOfObject."""
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)
702
828
  request = MeshingQueriesProtoModule.GetEdgeZoneIdListOfObjectRequest()
703
829
  request.object = object
704
- response = self.service.GetEdgeZoneIdListOfObject(request)
830
+ response = self.service.get_edge_zone_id_list_of_object(request)
705
831
  return response.edge_zone_ids
706
832
 
707
- def GetCellZoneIdListOfObject(self, object) -> Any:
708
- """GetCellZoneIdListOfObject."""
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)
709
843
  request = MeshingQueriesProtoModule.GetCellZoneIdListOfObjectRequest()
710
844
  request.object = object
711
- response = self.service.GetCellZoneIdListOfObject(request)
845
+ response = self.service.get_cell_zone_id_list_of_object(request)
712
846
  return response.cell_zone_ids
713
847
 
714
- def GetFaceZonesSharedByRegionsOfType(self, mesh_object, region_type) -> Any:
715
- """GetFaceZonesSharedByRegionsOfType."""
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)
716
860
  request = MeshingQueriesProtoModule.GetFaceZonesSharedByRegionsOfTypeRequest()
717
861
  request.mesh_object = mesh_object
718
862
  request.region_type = region_type
719
- response = self.service.GetFaceZonesSharedByRegionsOfType(request)
863
+ response = self.service.get_face_zones_shared_by_regions_of_type(request)
720
864
  return response.shared_face_zone_ids
721
865
 
722
- def GetFaceZonesOfRegions(self, object, region_name_list) -> Any:
723
- """GetFaceZonesOfRegions."""
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)
724
877
  request = MeshingQueriesProtoModule.GetFaceZonesOfRegionsRequest()
725
878
  request.object = object
726
879
  for region in region_name_list:
727
880
  request.regions.append(region)
728
- response = self.service.GetFaceZonesOfRegions(request)
881
+ response = self.service.get_face_zones_of_regions(request)
729
882
  return response.zone_ids
730
883
 
731
- def GetFaceZonesOfLabels(self, object, label_name_list) -> Any:
732
- """GetFaceZonesOfLabels."""
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
+ """
733
893
  request = MeshingQueriesProtoModule.GetFaceZonesOfLabelsRequest()
734
894
  request.object = object
735
895
  for label in label_name_list:
736
896
  request.labels.append(label)
737
- response = self.service.GetFaceZonesOfLabels(request)
897
+ response = self.service.get_face_zones_of_labels(request)
738
898
  return response.zone_ids
739
899
 
740
- def GetFaceZoneIdListOfLabels(self, object, zone_label_list) -> Any:
741
- """GetFaceZoneIdListOfLabels."""
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
+ """
742
909
  request = MeshingQueriesProtoModule.GetFaceZoneIdListOfLabelsRequest()
743
910
  request.object = object
744
911
  for zone_label in zone_label_list:
745
912
  request.labels.append(zone_label)
746
- response = self.service.GetFaceZoneIdListOfLabels(request)
913
+ response = self.service.get_face_zone_id_list_of_labels(request)
747
914
  return response.zone_ids
748
915
 
749
- def GetFaceZonesOfObjects(self, object_list) -> Any:
750
- """GetFaceZonesOfObjects."""
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)
751
926
  request = MeshingQueriesProtoModule.GetFaceZonesOfObjectsRequest()
752
927
  for object in object_list:
753
928
  request.object_list.append(object)
754
- response = self.service.GetFaceZonesOfObjects(request)
929
+ response = self.service.get_face_zones_of_objects(request)
755
930
  return response.face_zone_ids
756
931
 
757
- def GetEdgeZonesOfObjects(self, object_list) -> Any:
758
- """GetEdgeZonesOfObjects."""
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)
759
942
  request = MeshingQueriesProtoModule.GetEdgeZonesOfObjectsRequest()
760
943
  for object in object_list:
761
944
  request.object_list.append(object)
762
- response = self.service.GetEdgeZonesOfObjects(request)
945
+ response = self.service.get_edge_zones_of_objects(request)
763
946
  return response.edge_zone_ids
764
947
 
765
- def GetFaceZoneIdListOfRegions(self, object, region_list) -> Any:
766
- """GetFaceZoneIdListOfRegions."""
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)
767
959
  request = MeshingQueriesProtoModule.GetFaceZoneIdListOfRegionsRequest()
768
960
  request.object = object
769
961
  for region in region_list:
770
962
  request.labels.append(region)
771
- response = self.service.GetFaceZoneIdListOfRegions(request)
963
+ response = self.service.get_face_zone_id_list_of_regions(request)
772
964
  return response.zone_ids
773
965
 
774
- def GetPrismCellZones(self, list_or_pattern) -> Any:
775
- """GetPrismCellZones."""
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
+ """
776
977
  request = MeshingQueriesProtoModule.GetPrismCellZonesRequest()
777
978
  if isinstance(list_or_pattern, str):
778
979
  request.zone_name_or_pattern = list_or_pattern
779
980
  elif isinstance(list_or_pattern, list):
780
981
  for items in list_or_pattern:
781
982
  request.zones.append(items)
782
- response = self.service.GetPrismCellZones(request)
983
+ response = self.service.get_prism_cell_zones(request)
783
984
  return response.prism_cell_zones
784
985
 
785
- def GetTetCellZones(self, list_or_pattern) -> Any:
786
- """GetTetCellZones."""
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
+ """
787
997
  request = MeshingQueriesProtoModule.GetTetCellZonesRequest()
788
998
  if isinstance(list_or_pattern, str):
789
999
  request.zone_name_or_pattern = list_or_pattern
790
1000
  elif isinstance(list_or_pattern, list):
791
1001
  for items in list_or_pattern:
792
1002
  request.zones.append(items)
793
- response = self.service.GetTetCellZones(request)
1003
+ response = self.service.get_tet_cell_zones(request)
794
1004
  return response.tet_cell_zones
795
1005
 
796
- def GetAdjacentCellZones(self, list_or_name_or_pattern) -> Any:
797
- """GetAdjacentCellZones."""
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
+ """
798
1017
  request = MeshingQueriesProtoModule.GetAdjacentCellZonesRequest()
799
1018
  if isinstance(list_or_name_or_pattern, str):
800
1019
  request.zone_name_or_pattern = list_or_name_or_pattern
801
1020
  elif isinstance(list_or_name_or_pattern, list):
802
1021
  for items in list_or_name_or_pattern:
803
1022
  request.face_zone_ids.append(items)
804
- response = self.service.GetAdjacentCellZones(request)
1023
+ response = self.service.get_adjacent_cell_zones(request)
805
1024
  return response.adjacent_cell_zones
806
1025
 
807
- def GetAdjacentFaceZones(self, list_or_name_or_pattern) -> Any:
808
- """GetAdjacentFaceZones."""
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
+ """
809
1037
  request = MeshingQueriesProtoModule.GetAdjacentFaceZonesRequest()
810
1038
  if isinstance(list_or_name_or_pattern, str):
811
1039
  request.zone_name_or_pattern = list_or_name_or_pattern
812
1040
  elif isinstance(list_or_name_or_pattern, list):
813
1041
  for items in list_or_name_or_pattern:
814
1042
  request.cell_zone_ids.append(items)
815
- response = self.service.GetAdjacentFaceZones(request)
1043
+ response = self.service.get_adjacent_face_zones(request)
816
1044
  return response.adjacent_boundary_face_zones
817
1045
 
818
- def GetAdjacentInteriorAndBoundaryFaceZones(self, list_or_name_or_pattern) -> Any:
819
- """GetAdjacentInteriorAndBoundaryFaceZones."""
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
+ """
820
1061
  request = (
821
1062
  MeshingQueriesProtoModule.GetAdjacentInteriorAndBoundaryFaceZonesRequest()
822
1063
  )
@@ -825,44 +1066,82 @@ class MeshingQueries:
825
1066
  elif isinstance(list_or_name_or_pattern, list):
826
1067
  for items in list_or_name_or_pattern:
827
1068
  request.cell_zone_ids.append(items)
828
- response = self.service.GetAdjacentInteriorAndBoundaryFaceZones(request)
1069
+ response = self.service.get_adjacent_interior_and_boundary_face_zones(request)
829
1070
  return response.adjacent_interior_and_boundary_face_zones
830
1071
 
831
- def GetAdjacentZonesByEdgeConnectivity(self, list_or_name_or_pattern) -> Any:
832
- """GetAdjacentZonesByEdgeConnectivity."""
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
+ """
833
1083
  request = MeshingQueriesProtoModule.GetAdjacentZonesByEdgeConnectivityRequest()
834
1084
  if isinstance(list_or_name_or_pattern, str):
835
1085
  request.zone_name_or_pattern = list_or_name_or_pattern
836
1086
  elif isinstance(list_or_name_or_pattern, list):
837
1087
  for items in list_or_name_or_pattern:
838
1088
  request.zone_ids.append(items)
839
- response = self.service.GetAdjacentZonesByEdgeConnectivity(request)
1089
+ response = self.service.get_adjacent_zones_by_edge_connectivity(request)
840
1090
  return response.adjacent_zone_ids
841
1091
 
842
- def GetAdjacentZonesByNodeConnectivity(self, list_or_name_or_pattern) -> Any:
843
- """GetAdjacentZonesByNodeConnectivity."""
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
+ """
844
1103
  request = MeshingQueriesProtoModule.GetAdjacentZonesByNodeConnectivityRequest()
845
1104
  if isinstance(list_or_name_or_pattern, str):
846
1105
  request.zone_name_or_pattern = list_or_name_or_pattern
847
1106
  elif isinstance(list_or_name_or_pattern, list):
848
1107
  for items in list_or_name_or_pattern:
849
1108
  request.zone_ids.append(items)
850
- response = self.service.GetAdjacentZonesByNodeConnectivity(request)
1109
+ response = self.service.get_adjacent_zones_by_node_connectivity(request)
851
1110
  return response.adjacent_zone_ids
852
1111
 
853
- def GetSharedBoundaryZones(self, list_or_name_or_pattern) -> Any:
854
- """GetSharedBoundaryZones."""
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
+ """
855
1123
  request = MeshingQueriesProtoModule.GetSharedBoundaryZonesRequest()
856
1124
  if isinstance(list_or_name_or_pattern, str):
857
1125
  request.cell_zone_name_or_pattern = list_or_name_or_pattern
858
1126
  elif isinstance(list_or_name_or_pattern, list):
859
1127
  for items in list_or_name_or_pattern:
860
1128
  request.cell_zone_ids.append(items)
861
- response = self.service.GetSharedBoundaryZones(request)
1129
+ response = self.service.get_shared_boundary_zones(request)
862
1130
  return response.shared_boundary_zone_ids
863
1131
 
864
- def GetInteriorZonesConnectedToCellZones(self, list_or_name_or_pattern) -> Any:
865
- """GetInteriorZonesConnectedToCellZones."""
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
+ """
866
1145
  request = (
867
1146
  MeshingQueriesProtoModule.GetInteriorZonesConnectedToCellZonesRequest()
868
1147
  )
@@ -871,110 +1150,219 @@ class MeshingQueries:
871
1150
  elif isinstance(list_or_name_or_pattern, list):
872
1151
  for items in list_or_name_or_pattern:
873
1152
  request.face_zone_ids.append(items)
874
- response = self.service.GetInteriorZonesConnectedToCellZones(request)
1153
+ response = self.service.get_interior_zones_connected_to_cell_zones(request)
875
1154
  return response.interior_zone_ids
876
1155
 
877
- def GetFaceZonesWithZoneSpecificPrismsApplied(self) -> Any:
878
- """GetFaceZonesWithZoneSpecificPrismsApplied."""
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
+ """
879
1165
  request = MeshingQueriesProtoModule.Empty()
880
- response = self.service.GetFaceZonesWithZoneSpecificPrismsApplied(request)
1166
+ response = self.service.get_face_zones_with_zone_specific_prisms_applied(
1167
+ request
1168
+ )
881
1169
  return response.face_zone_ids
882
1170
 
883
- def GetFaceZonesOfPrismControls(self, control_name) -> Any:
884
- """GetInteriorZonesConnectedToCellZones."""
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
+ """
885
1180
  request = MeshingQueriesProtoModule.GetFaceZonesOfPrismControlsRequest()
886
1181
  request.control_name = control_name
887
- response = self.service.GetFaceZonesOfPrismControls(request)
1182
+ response = self.service.get_face_zones_of_prism_controls(request)
888
1183
  return response.face_zone_ids
889
1184
 
890
- def GetBaffles(self, face_zone_list) -> Any:
891
- """GetBaffles."""
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
+ """
892
1194
  request = MeshingQueriesProtoModule.GetBafflesRequest()
893
1195
  for items in face_zone_list:
894
1196
  request.face_zone_ids.append(items)
895
- response = self.service.GetBaffles(request)
1197
+ response = self.service.get_baffles(request)
896
1198
  return response.baffle_zone_ids
897
1199
 
898
- def GetEmbeddedBaffles(self) -> Any:
899
- """GetEmbeddedBaffles."""
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
+ """
900
1209
  request = MeshingQueriesProtoModule.Empty()
901
- response = self.service.GetEmbeddedBaffles(request)
1210
+ response = self.service.get_embedded_baffles(request)
902
1211
  return response.embedded_baffles_zone_ids
903
1212
 
904
- def GetWrappedZones(self) -> Any:
905
- """GetWrappedZones."""
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
+ """
906
1222
  request = MeshingQueriesProtoModule.Empty()
907
- response = self.service.GetWrappedZones(request)
1223
+ response = self.service.get_wrapped_zones(request)
908
1224
  return response.wrapped_face_zone_ids
909
1225
 
910
- def GetUnreferencedEdgeZones(self) -> Any:
911
- """GetUnreferencedEdgeZones."""
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
+ """
912
1235
  request = MeshingQueriesProtoModule.Empty()
913
- response = self.service.GetUnreferencedEdgeZones(request)
1236
+ response = self.service.get_unreferenced_edge_zones(request)
914
1237
  return response.unreferenced_edge_zone_ids
915
1238
 
916
- def GetUnreferencedFaceZones(self) -> Any:
917
- """GetUnreferencedFaceZones."""
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
+ """
918
1248
  request = MeshingQueriesProtoModule.Empty()
919
- response = self.service.GetUnreferencedFaceZones(request)
1249
+ response = self.service.get_unreferenced_face_zones(request)
920
1250
  return response.unreferenced_face_zone_ids
921
1251
 
922
- def GetUnreferencedCellZones(self) -> Any:
923
- """GetUnreferencedCellZones."""
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
+ """
924
1261
  request = MeshingQueriesProtoModule.Empty()
925
- response = self.service.GetUnreferencedCellZones(request)
1262
+ response = self.service.get_unreferenced_cell_zones(request)
926
1263
  return response.unreferenced_cell_zone_ids
927
1264
 
928
- def GetUnreferencedEdgeZonesOfFilter(self, filter) -> Any:
929
- """GetUnreferencedEdgeZonesOfFilter."""
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
+ """
930
1274
  request = MeshingQueriesProtoModule.GetUnreferencedEdgeZonesOfFilterRequest()
931
1275
  request.filter = filter
932
- response = self.service.GetUnreferencedEdgeZonesOfFilter(request)
1276
+ response = self.service.get_unreferenced_edge_zones_of_filter(request)
933
1277
  return response.unreferenced_edge_zone_ids
934
1278
 
935
- def GetUnreferencedFaceZonesOfFilter(self, filter) -> Any:
936
- """GetUnreferencedFaceZonesOfFilter."""
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
+ """
937
1288
  request = MeshingQueriesProtoModule.GetUnreferencedFaceZonesOfFilterRequest()
938
1289
  request.filter = filter
939
- response = self.service.GetUnreferencedFaceZonesOfFilter(request)
1290
+ response = self.service.get_unreferenced_face_zones_of_filter(request)
940
1291
  return response.unreferenced_face_zone_ids
941
1292
 
942
- def GetUnreferencedCellZonesOfFilter(self, filter) -> Any:
943
- """GetUnreferencedEdgeZonesOfFilter."""
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
+ """
944
1302
  request = MeshingQueriesProtoModule.GetUnreferencedCellZonesOfFilterRequest()
945
1303
  request.filter = filter
946
- response = self.service.GetUnreferencedCellZonesOfFilter(request)
1304
+ response = self.service.get_unreferenced_cell_zones_of_filter(request)
947
1305
  return response.unreferenced_cell_zone_ids
948
1306
 
949
- def GetUnreferencedEdgeZoneIdListOfPattern(self, pattern) -> Any:
950
- """GetUnreferencedEdgeZoneIdListOfPattern."""
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
+ """
951
1316
  request = (
952
1317
  MeshingQueriesProtoModule.GetUnreferencedEdgeZoneIdListOfPatternRequest()
953
1318
  )
954
1319
  request.pattern = pattern
955
- response = self.service.GetUnreferencedEdgeZoneIdListOfPattern(request)
1320
+ response = self.service.get_unreferenced_edge_zone_id_list_of_pattern(request)
956
1321
  return response.unreferenced_edge_zone_ids
957
1322
 
958
- def GetUnreferencedFaceZoneIdListOfPattern(self, pattern) -> Any:
959
- """GetUnreferencedFaceZoneIdListOfPattern."""
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
+ """
960
1332
  request = (
961
1333
  MeshingQueriesProtoModule.GetUnreferencedFaceZoneIdListOfPatternRequest()
962
1334
  )
963
1335
  request.pattern = pattern
964
- response = self.service.GetUnreferencedFaceZoneIdListOfPattern(request)
1336
+ response = self.service.get_unreferenced_face_zone_id_list_of_pattern(request)
965
1337
  return response.unreferenced_face_zone_ids
966
1338
 
967
- def GetUnreferencedCellZoneIdListOfPattern(self, pattern) -> Any:
968
- """GetUnreferencedCellZoneIdListOfPattern."""
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
+ """
969
1348
  request = (
970
1349
  MeshingQueriesProtoModule.GetUnreferencedCellZoneIdListOfPatternRequest()
971
1350
  )
972
1351
  request.pattern = pattern
973
- response = self.service.GetUnreferencedCellZoneIdListOfPattern(request)
1352
+ response = self.service.get_unreferenced_cell_zone_id_list_of_pattern(request)
974
1353
  return response.unreferenced_cell_zone_ids
975
1354
 
976
- def GetMaxsizeCellZoneByVolume(self, list_or_pattern) -> Any:
977
- """GetMaxsizeCellZoneByVolume."""
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
+ """
978
1366
  request = MeshingQueriesProtoModule.GetMaxsizeCellZoneByVolumeRequest()
979
1367
  if isinstance(list_or_pattern, str):
980
1368
  request.cell_zone_pattern = list_or_pattern
@@ -985,11 +1373,20 @@ class MeshingQueries:
985
1373
  elif isinstance(list_or_pattern[0], str):
986
1374
  for items in list_or_pattern:
987
1375
  request.cell_zone_names.append(items)
988
- response = self.service.GetMaxsizeCellZoneByVolume(request)
1376
+ response = self.service.get_maxsize_cell_zone_by_volume(request)
989
1377
  return response.cell_zone_id
990
1378
 
991
- def GetMaxsizeCellZoneByCount(self, list_or_pattern) -> Any:
992
- """GetMaxsizeCellZoneByCount."""
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
+ """
993
1390
  request = MeshingQueriesProtoModule.GetMaxsizeCellZoneByCountRequest()
994
1391
  if isinstance(list_or_pattern, str):
995
1392
  request.cell_zone_pattern = list_or_pattern
@@ -1000,11 +1397,20 @@ class MeshingQueries:
1000
1397
  elif isinstance(list_or_pattern[0], str):
1001
1398
  for items in list_or_pattern:
1002
1399
  request.cell_zone_names.append(items)
1003
- response = self.service.GetMaxsizeCellZoneByCount(request)
1400
+ response = self.service.get_maxsize_cell_zone_by_count(request)
1004
1401
  return response.cell_zone_id
1005
1402
 
1006
- def GetMinsizeFaceZoneByArea(self, list_or_pattern) -> Any:
1007
- """GetMinsizeFaceZoneByArea."""
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
+ """
1008
1414
  request = MeshingQueriesProtoModule.GetMinsizeFaceZoneByAreaRequest()
1009
1415
  if isinstance(list_or_pattern, str):
1010
1416
  request.face_zone_pattern = list_or_pattern
@@ -1015,11 +1421,20 @@ class MeshingQueries:
1015
1421
  elif isinstance(list_or_pattern[0], str):
1016
1422
  for items in list_or_pattern:
1017
1423
  request.face_zone_names.append(items)
1018
- response = self.service.GetMinsizeFaceZoneByArea(request)
1424
+ response = self.service.get_minsize_face_zone_by_area(request)
1019
1425
  return response.face_zone_id
1020
1426
 
1021
- def GetMinsizeFaceZoneByCount(self, list_or_pattern) -> Any:
1022
- """GetMinsizeFaceZoneByCount."""
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
+ """
1023
1438
  request = MeshingQueriesProtoModule.GetMinsizeFaceZoneByCountRequest()
1024
1439
  if isinstance(list_or_pattern, str):
1025
1440
  request.face_zone_pattern = list_or_pattern
@@ -1030,52 +1445,100 @@ class MeshingQueries:
1030
1445
  elif isinstance(list_or_pattern[0], str):
1031
1446
  for items in list_or_pattern:
1032
1447
  request.face_zone_names.append(items)
1033
- response = self.service.GetMinsizeFaceZoneByCount(request)
1448
+ response = self.service.get_minsize_face_zone_by_count(request)
1034
1449
  return response.face_zone_id
1035
1450
 
1036
- def GetFaceZoneListByMaximumEntityCount(
1451
+ def get_face_zone_list_by_maximum_entity_count(
1037
1452
  self, max_entity_count, only_boundary
1038
1453
  ) -> Any:
1039
- """GetFaceZoneListByMaximumEntityCount."""
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
+ """
1040
1463
  request = MeshingQueriesProtoModule.GetFaceZoneListByMaximumEntityCountRequest()
1041
1464
  request.maximum_entity_count = max_entity_count
1042
1465
  request.only_boundary = only_boundary
1043
- response = self.service.GetFaceZoneListByMaximumEntityCount(request)
1466
+ response = self.service.get_face_zone_list_by_maximum_entity_count(request)
1044
1467
  return response.face_zone_ids
1045
1468
 
1046
- def GetEdgeZoneListByMaximumEntityCount(
1469
+ def get_edge_zone_list_by_maximum_entity_count(
1047
1470
  self, max_entity_count, only_boundary
1048
1471
  ) -> Any:
1049
- """GetEdgeZoneListByMaximumEntityCount."""
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
+ """
1050
1481
  request = MeshingQueriesProtoModule.GetEdgeZoneListByMaximumEntityCountRequest()
1051
1482
  request.maximum_entity_count = max_entity_count
1052
1483
  request.only_boundary = only_boundary
1053
- response = self.service.GetEdgeZoneListByMaximumEntityCount(request)
1484
+ response = self.service.get_edge_zone_list_by_maximum_entity_count(request)
1054
1485
  return response.edge_zone_ids
1055
1486
 
1056
- def GetCellZoneListByMaximumEntityCount(self, maximum_entity_count) -> Any:
1057
- """GetCellZoneListByMaximumEntityCount."""
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
+ """
1058
1496
  request = MeshingQueriesProtoModule.GetCellZoneListByMaximumEntityCountRequest()
1059
1497
  request.maximum_entity_count = maximum_entity_count
1060
- response = self.service.GetCellZoneListByMaximumEntityCount(request)
1498
+ response = self.service.get_cell_zone_list_by_maximum_entity_count(request)
1061
1499
  return response.cell_zone_ids
1062
1500
 
1063
- def GetFaceZoneListByMaximumZoneArea(self, maximum_zone_area) -> Any:
1064
- """GetFaceZoneListByMaximumZoneArea."""
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
+ """
1065
1510
  request = MeshingQueriesProtoModule.GetFaceZoneListByMaximumZoneAreaRequest()
1066
1511
  request.maximum_zone_area = maximum_zone_area
1067
- response = self.service.GetFaceZoneListByMaximumZoneArea(request)
1512
+ response = self.service.get_face_zone_list_by_maximum_zone_area(request)
1068
1513
  return response.face_zone_ids
1069
1514
 
1070
- def GetFaceZoneListByMinimumZoneArea(self, minimum_zone_area) -> Any:
1071
- """GetFaceZoneListByMinimumZoneArea."""
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
+ """
1072
1524
  request = MeshingQueriesProtoModule.GetFaceZoneListByMinimumZoneAreaRequest()
1073
1525
  request.minimum_zone_area = minimum_zone_area
1074
- response = self.service.GetFaceZoneListByMinimumZoneArea(request)
1526
+ response = self.service.get_face_zone_list_by_minimum_zone_area(request)
1075
1527
  return response.face_zone_ids
1076
1528
 
1077
- def GetZonesWithFreeFaces(self, list_or_pattern) -> Any:
1078
- """GetZonesWithFreeFaces."""
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
+ """
1079
1542
  request = MeshingQueriesProtoModule.GetZonesWithFreeFacesRequest()
1080
1543
  if isinstance(list_or_pattern, str):
1081
1544
  request.face_zone_pattern = list_or_pattern
@@ -1086,11 +1549,22 @@ class MeshingQueries:
1086
1549
  elif isinstance(list_or_pattern[0], str):
1087
1550
  for items in list_or_pattern:
1088
1551
  request.face_zone_names.append(items)
1089
- response = self.service.GetZonesWithFreeFaces(request)
1552
+ response = self.service.get_zones_with_free_faces(request)
1090
1553
  return response.zones_with_free_faces
1091
1554
 
1092
- def GetZonesWithMultiFaces(self, list_or_pattern) -> Any:
1093
- """GetZonesWithMultiFaces."""
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
+ """
1094
1568
  request = MeshingQueriesProtoModule.GetZonesWithMultiFacesRequest()
1095
1569
  if isinstance(list_or_pattern, str):
1096
1570
  request.face_zone_pattern = list_or_pattern
@@ -1101,22 +1575,40 @@ class MeshingQueries:
1101
1575
  elif isinstance(list_or_pattern[0], str):
1102
1576
  for items in list_or_pattern:
1103
1577
  request.face_zone_names.append(items)
1104
- response = self.service.GetZonesWithMultiFaces(request)
1578
+ response = self.service.get_zones_with_multi_faces(request)
1105
1579
  return response.zones_with_multi_connected_faces
1106
1580
 
1107
- def GetOverlappingFaceZones(
1581
+ def get_overlapping_face_zones(
1108
1582
  self, zone_name_pattern, area_tolerance, distance_tolerance
1109
1583
  ) -> Any:
1110
- """GetOverlappingFaceZones."""
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
+ """
1111
1592
  request = MeshingQueriesProtoModule.GetOverlappingFaceZonesRequest()
1112
1593
  request.face_zone_name_or_pattern = zone_name_pattern
1113
1594
  request.area_tolerance = area_tolerance
1114
1595
  request.distance_tolerance = distance_tolerance
1115
- response = self.service.GetOverlappingFaceZones(request)
1596
+ response = self.service.get_overlapping_face_zones(request)
1116
1597
  return response.overlapping_face_zone_ids
1117
1598
 
1118
- def GetZonesWithMarkedFaces(self, list_or_pattern) -> Any:
1119
- """GetZonesWithMarkedFaces."""
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
+ """
1120
1612
  request = MeshingQueriesProtoModule.GetZonesWithMarkedFacesRequest()
1121
1613
  if isinstance(list_or_pattern, str):
1122
1614
  request.face_zone_pattern = list_or_pattern
@@ -1127,87 +1619,147 @@ class MeshingQueries:
1127
1619
  elif isinstance(list_or_pattern[0], str):
1128
1620
  for items in list_or_pattern:
1129
1621
  request.face_zone_names.append(items)
1130
- response = self.service.GetZonesWithMarkedFaces(request)
1622
+ response = self.service.get_zones_with_marked_faces(request)
1131
1623
  return response.zones_with_marked_faces
1132
1624
 
1133
- def GetAllObjectNameList(self) -> Any:
1134
- """GetAllObjectNameList."""
1135
- request = MeshingQueriesProtoModule.Empty()
1136
- response = self.service.GetAllObjectNameList(request)
1137
- return response.objects
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")
1138
1632
 
1139
- def GetObjectNameListOfType(self, type) -> Any:
1140
- """GetObjectNameListOfType."""
1633
+ """
1141
1634
  request = MeshingQueriesProtoModule.GetObjectNameListOfTypeRequest()
1142
1635
  request.type = type
1143
- response = self.service.GetObjectNameListOfType(request)
1636
+ response = self.service.get_object_name_list_of_type(request)
1144
1637
  return response.objects
1145
1638
 
1146
- def GetObjectsOfFilter(self, filter) -> Any:
1147
- """GetObjectsOfFilter."""
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
+ """
1148
1648
  request = MeshingQueriesProtoModule.GetObjectsOfFilterRequest()
1149
1649
  request.filter = filter
1150
- response = self.service.GetObjectsOfFilter(request)
1650
+ response = self.service.get_objects_of_filter(request)
1151
1651
  return response.objects
1152
1652
 
1153
- def GetRegionsOfObject(self, object) -> Any:
1154
- """GetRegionsOfObject."""
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)
1155
1663
  request = MeshingQueriesProtoModule.GetRegionsOfObjectRequest()
1156
1664
  request.object = object
1157
- response = self.service.GetRegionsOfObject(request)
1665
+ response = self.service.get_regions_of_object(request)
1158
1666
  return response.regions
1159
1667
 
1160
- def GetRegionNameListOfObject(self, object) -> Any:
1161
- """GetRegionNameListOfObject."""
1162
- request = MeshingQueriesProtoModule.GetRegionNameListOfObjectRequest()
1163
- request.object = object
1164
- response = self.service.GetRegionNameListOfObject(request)
1165
- return response.regions
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
1166
1674
 
1167
- def SortRegionsByVolume(self, object_name, order) -> Any:
1168
- """SortRegionsByVolume."""
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)
1169
1680
  request = MeshingQueriesProtoModule.SortRegionsByVolumeRequest()
1170
1681
  request.object_name = object_name
1171
1682
  request.order = order
1172
- response = self.service.SortRegionsByVolume(request)
1683
+ response = self.service.sort_regions_by_volume(request)
1173
1684
  return response.regions
1174
1685
 
1175
- def GetRegionVolume(self, object_name, region_name) -> Any:
1176
- """GetRegionVolume."""
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)
1177
1697
  request = MeshingQueriesProtoModule.GetRegionVolumeRequest()
1178
1698
  request.object_name = object_name
1179
1699
  request.region_name = region_name
1180
- response = self.service.GetRegionVolume(request)
1700
+ response = self.service.get_region_volume(request)
1181
1701
  return response.region_volume
1182
1702
 
1183
- def GetRegionsOfFilter(self, object, filter) -> Any:
1184
- """GetRegionsOfFilter."""
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
+ """
1185
1712
  request = MeshingQueriesProtoModule.GetRegionsOfFilterRequest()
1186
1713
  request.object = object
1187
1714
  request.filter = filter
1188
- response = self.service.GetRegionsOfFilter(request)
1715
+ response = self.service.get_regions_of_filter(request)
1189
1716
  return response.regions
1190
1717
 
1191
- def GetRegionNameListOfPattern(self, object, region_name_or_pattern) -> Any:
1192
- """GetRegionNameListOfPattern."""
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
+ """
1193
1727
  request = MeshingQueriesProtoModule.GetRegionNameListOfPatternRequest()
1194
1728
  request.object = object
1195
1729
  request.region_name_or_pattern = region_name_or_pattern
1196
- response = self.service.GetRegionNameListOfPattern(request)
1730
+ response = self.service.get_region_name_list_of_pattern(request)
1197
1731
  return response.regions
1198
1732
 
1199
- def GetRegionsOfFaceZones(self, list_of_face_zone_ids) -> Any:
1200
- """GetRegionsOfFaceZones."""
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
+ """
1201
1742
  request = MeshingQueriesProtoModule.GetRegionsOfFaceZonesRequest()
1202
1743
  for id in list_of_face_zone_ids:
1203
1744
  request.face_zone_ids.append(id)
1204
- response = self.service.GetRegionsOfFaceZones(request)
1745
+ response = self.service.get_regions_of_face_zones(request)
1205
1746
  return response.regions
1206
1747
 
1207
- def FindJoinPairs(
1748
+ def find_join_pairs(
1208
1749
  self, face_zone_list_or_pattern, join_tolerance, absolute_tolerance, join_angle
1209
1750
  ) -> Any:
1210
- """FindJoinPairs."""
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
+ """
1211
1763
  request = MeshingQueriesProtoModule.FindJoinPairsRequest()
1212
1764
  if isinstance(face_zone_list_or_pattern, str):
1213
1765
  request.face_zone_name_or_pattern = face_zone_list_or_pattern
@@ -1221,16 +1773,23 @@ class MeshingQueries:
1221
1773
  request.join_tolerance = join_tolerance
1222
1774
  request.absolute_tolerance = absolute_tolerance
1223
1775
  request.join_angle = join_angle
1224
- response = self.service.FindJoinPairs(request)
1776
+ response = self.service.find_join_pairs(request)
1225
1777
  return response.pairs
1226
1778
 
1227
- def GetRegionNameListOfFaceZones(self, list_or_pattern) -> Any:
1228
- """GetRegionNameListOfFaceZones."""
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
+ """
1229
1788
  request = MeshingQueriesProtoModule.GetRegionNameListOfFaceZonesRequest()
1230
1789
  if isinstance(list_or_pattern, str):
1231
1790
  request.face_zone_name_or_pattern = list_or_pattern
1232
1791
  elif isinstance(list_or_pattern, list):
1233
1792
  for items in list_or_pattern:
1234
1793
  request.face_zone_ids.append(items)
1235
- response = self.service.GetRegionNameListOfFaceZones(request)
1794
+ response = self.service.get_region_name_list_of_face_zones(request)
1236
1795
  return response.regions