meshing_queries#

class ansys.fluent.core.services.meshing_queries.MeshingQueries(service)#

Bases: object

Meshing Queries.

Methods:

`__init__`(service)	__init__ method of MeshingQueries class.
`find_join_pairs`(face_zone_list_or_pattern, ...)	Return the pairs of overlapping face zones based on the join tolerance and feature angle.
`get_adjacent_cell_zones`(list_or_name_or_pattern)	Return adjacent cell zones for given face zone.
`get_adjacent_face_zones`(list_or_name_or_pattern)	Return adjacent boundary face zones for given cell zones.
`get_adjacent_interior_and_boundary_face_zones`(...)	Return adjacent interior and boundary face zones for given cell zones.
`get_adjacent_zones_by_edge_connectivity`(...)	Return adjacent zones based on edge connectivity.
`get_adjacent_zones_by_node_connectivity`(...)	Return adjacent zones based on node connectivity.
`get_all_object_name_list`()	Return a list of all objects.
`get_baffles`(face_zone_list)	Return the baffle zones based on the face zone list specified.
`get_cell_zone_at_location`(location)	Return cell zone at or closest to a specified location.
`get_cell_zone_id_list_of_object`(object)	Return a list of cell zones by ID in the specified face zone labels of an object.
`get_cell_zone_list_by_maximum_entity_count`(...)	Return a list of cell zones with a count below the maximum entity count (maximum-entity-count) specified.
`get_cell_zones_of_filter`(filter)	Return a list of cell zones whose names contain the specified filter string.
`get_edge_zone_id_list_of_object`(object)	Return a list of edge zones by ID in the specified face zone labels of an object.
`get_edge_zone_list_by_maximum_entity_count`(...)	Return a list of edge zones with a count below the maximum entity count (maximum-entity-count) specified.
`get_edge_zones_of_filter`(filter)	Return a list of edge zones whose names contain the specified filter string.
`get_edge_zones_of_objects`(object_list)	Return a list of edge zones in the specified objects.
`get_embedded_baffles`()	Return the embedded baffle zones.
`get_face_zone_at_location`(location)	Return face zone at or closest to a specified location.
`get_face_zone_id_list_of_labels`(object, ...)	Return a list of face zones by ID in the specified face zone labels of an object.
`get_face_zone_id_list_of_object`(object)	Return a list of face zones by ID in the specified face zone labels of an object.
`get_face_zone_id_list_of_regions`(object, ...)	Return a list of face zones by ID in the specified regions of an object.
`get_face_zone_list_by_maximum_entity_count`(...)	Return a list of face zones with a count below the maximum entity count (maximum-entity-count) specified.
`get_face_zone_list_by_maximum_zone_area`(...)	Return a list of face zones with a maximum zone area below the maximum-zone-area specified.
`get_face_zone_list_by_minimum_zone_area`(...)	Return a list of face zones with a minimum zone area above the minimum-zone-area specified.
`get_face_zones_of_filter`(filter)	Return a list of face zones whose names contain the specified filter string.
`get_face_zones_of_labels`(object, label_name_list)	Return a list of face zones in the specified face zone labels of the object specified.
`get_face_zones_of_objects`(object_list)	Return a list of face zones in the specified objects.
`get_face_zones_of_prism_controls`(control_name)	Return a list of face zones to which the specified prism controls apply.
`get_face_zones_of_regions`(object, ...)	Return a list of face zones in the specified regions.
`get_face_zones_shared_by_regions_of_type`(...)	Return a list of face zones shared by regions of specified types in the mesh object specified, where region-type is fluid-fluid, solid-solid, or fluid-solid.
`get_face_zones_with_zone_specific_prisms_applied`()	Return a list of face zones with zone-specific prism settings applied.
`get_interior_zones_connected_to_cell_zones`(...)	Returns interior face zones connected to given cell zones.
`get_maxsize_cell_zone_by_count`(list_or_pattern)	Return cell zone with maximum count of elements for given list or pattern of cell zones.
`get_maxsize_cell_zone_by_volume`(list_or_pattern)	Return cell zone with maximum volume for given list or pattern of cell zones.
`get_minsize_face_zone_by_area`(list_or_pattern)	Return face zone with minimum area for given list or pattern of face zones.
`get_minsize_face_zone_by_count`(list_or_pattern)	Return face zone with minimum count of elements for given list or pattern of face zones.
`get_node_zones_of_filter`(filter)	Return a list of node zones whose names contain the specified filter string.
`get_object_name_list_of_type`(type)	Return a list of objects of the specified type.
`get_objects_of_filter`(filter)	Return a list of objects whose names contain the specified filter string.
`get_objects_of_type`(type)	Return a list of objects of the specified type.
`get_overlapping_face_zones`(...)	Return a list of overlapping face zones based on the area-tolerance and distance-tolerance specified.
`get_prism_cell_zones`(list_or_pattern)	Return a list of prism cell zones.
`get_region_name_list_of_face_zones`(...)	Return a list of regions containing the face zones specified.
`get_region_name_list_of_object`(object)	Return a list of regions in the specified object.
`get_region_name_list_of_pattern`(object, ...)	Return a list of regions in the specified object, whose names contain the specified name pattern.
`get_region_volume`(object_name, region_name)	Return the region volume for the specified region of an object.
`get_regions_of_face_zones`(list_of_face_zone_ids)	Return a list of regions containing the face zones specified.
`get_regions_of_filter`(object, filter)	Return a list of regions in the specified object, whose names contain the specified filter string.
`get_regions_of_object`(object)	Return a list of regions in the specified object.
`get_shared_boundary_zones`(...)	Returns the number of faces and the boundary face zones that are shared with the specified cell zones.
`get_tet_cell_zones`(list_or_pattern)	Return a list of tet cell zones.
`get_unreferenced_cell_zone_id_list_of_pattern`(pattern)	Return a list of unreferenced cell zones by ID, whose names contain the specified pattern.
`get_unreferenced_cell_zones`()	Return a list of unreferenced cell zones.
`get_unreferenced_cell_zones_of_filter`(filter)	Return a list of unreferenced cell zones whose names contain the specified filter string.
`get_unreferenced_edge_zone_id_list_of_pattern`(pattern)	Return a list of unreferenced edge zones by ID, whose names contain the specified pattern.
`get_unreferenced_edge_zones`()	Return a list of unreferenced edge zones.
`get_unreferenced_edge_zones_of_filter`(filter)	Return a list of unreferenced edge zones whose names contain the specified filter string.
`get_unreferenced_face_zone_id_list_of_pattern`(pattern)	Return a list of unreferenced face zones by ID, whose names contain the specified pattern.
`get_unreferenced_face_zones`()	Return a list of unreferenced face zones.
`get_unreferenced_face_zones_of_filter`(filter)	Return a list of unreferenced face zones whose names contain the specified filter string.
`get_wrapped_zones`()	Return a list of wrapped face zones.
`get_zones_of_group`(group)	Return a list of zones of the specified default zone group or user-defined group.
`get_zones_of_type`(type)	Return a list of zones of the specified default zone type.
`get_zones_with_free_faces`(list_or_pattern)	Return a list of zones with free faces for the face zones specified.
`get_zones_with_marked_faces`(list_or_pattern)	Return a list of zones with marked faces for the face zones specified.
`get_zones_with_multi_faces`(list_or_pattern)	Return a list of zones with multi-connected faces for the face zones specified.
`sort_regions_by_volume`(object_name, order)	Returns a sorted list of volumetric regions by volume for the object specified.

Attributes:

docstring

__init__(service)#: __init__ method of MeshingQueries class.

docstring = None#

find_join_pairs(face_zone_list_or_pattern, join_tolerance, absolute_tolerance, join_angle)#

Return the pairs of overlapping face zones based on the join tolerance and feature angle.

>>> meshing_session.meshing_queries.find_join_pairs("outlet", 0.1, True, 40)

>>> meshing_session.meshing_queries.find_join_pairs([32], 0.1, True, 40))

>>> meshing_session.meshing_queries.find_join_pairs(["outlet"], 0.1, True, 40)

get_adjacent_cell_zones(list_or_name_or_pattern)#

Return adjacent cell zones for given face zone.

>>> meshing_session.meshing_queries.get_adjacent_cell_zones([30])

>>> meshing_session.meshing_queries.get_adjacent_cell_zones("*")

get_adjacent_face_zones(list_or_name_or_pattern)#

Return adjacent boundary face zones for given cell zones.

>>> meshing_session.meshing_queries.get_adjacent_face_zones([3460])

>>> meshing_session.meshing_queries.get_adjacent_face_zones("*")

get_adjacent_interior_and_boundary_face_zones(list_or_name_or_pattern)#

Return adjacent interior and boundary face zones for given cell zones.

>>> meshing_session.meshing_queries.get_adjacent_interior_and_boundary_face_zones([30])

>>> meshing_session.meshing_queries.get_adjacent_interior_and_boundary_face_zones("fluid")

>>> meshing_session.meshing_queries.get_adjacent_interior_and_boundary_face_zones("*")

get_adjacent_zones_by_edge_connectivity(list_or_name_or_pattern)#

Return adjacent zones based on edge connectivity.

>>> meshing_session.meshing_queries.get_adjacent_zones_by_edge_connectivity([30])

>>> meshing_session.meshing_queries.get_adjacent_zones_by_edge_connectivity("*")

get_adjacent_zones_by_node_connectivity(list_or_name_or_pattern)#

Return adjacent zones based on node connectivity.

>>> meshing_session.meshing_queries.get_adjacent_zones_by_node_connectivity([30])

>>> meshing_session.meshing_queries.get_adjacent_zones_by_node_connectivity("*")

get_all_object_name_list()#

Return a list of all objects.

>>> meshing_session.meshing_queries.get_all_object_name_list()

get_baffles(face_zone_list)#

Return the baffle zones based on the face zone list specified.

>>> meshing_session.meshing_queries.get_baffles([29, 30])

get_cell_zone_at_location(location)#

Return cell zone at or closest to a specified location.

>>> meshing_session.meshing_queries.get_cell_zone_at_location([1.4, 1.4, 1.4])

get_cell_zone_id_list_of_object(object)#

Return a list of cell zones by ID in the specified face zone labels of an object.

>>> meshing_session.meshing_queries.get_cell_zone_id_list_of_object("elbow-fluid")

get_cell_zone_list_by_maximum_entity_count(maximum_entity_count)#

Return a list of cell zones with a count below the maximum entity count (maximum-entity-count) specified.

>>> meshing_session.meshing_queries.get_cell_zone_list_by_maximum_entity_count(1)

get_cell_zones_of_filter(filter)#

Return a list of cell zones whose names contain the specified filter string.

>>> meshing_session.meshing_queries.get_cell_zones_of_filter("*")

get_edge_zone_id_list_of_object(object)#

Return a list of edge zones by ID in the specified face zone labels of an object.

>>> meshing_session.meshing_queries.get_edge_zone_id_list_of_object("elbow-fluid")

get_edge_zone_list_by_maximum_entity_count(max_entity_count, only_boundary)#

Return a list of edge zones with a count below the maximum entity count (maximum-entity-count) specified. You can choose to restrict the report to only boundary edge zones, if required (only-boundary? set to True or False).

>>> meshing_session.meshing_queries.get_edge_zone_list_by_maximum_entity_count(20, False)

get_edge_zones_of_filter(filter)#

Return a list of edge zones whose names contain the specified filter string.

>>> meshing_session.meshing_queries.get_edge_zones_of_filter("*")

get_edge_zones_of_objects(object_list)#

Return a list of edge zones in the specified objects.

>>> meshing_session.meshing_queries.get_edge_zones_of_objects(["elbow-fluid"])

get_embedded_baffles()#

Return the embedded baffle zones.

>>> meshing_session.meshing_queries.get_embedded_baffles()

get_face_zone_at_location(location)#

Return face zone at or closest to a specified location.

Note: This function is not applicable to polyhedral meshes.

>>> meshing_session.meshing_queries.get_face_zone_at_location([1.4, 1.4, 1.4])

get_face_zone_id_list_of_labels(object, zone_label_list)#

Return a list of face zones by ID in the specified face zone labels of an object.

>>> meshing_session.meshing_queries.get_face_zone_id_list_of_labels("elbow-fluid", ["outlet"])

get_face_zone_id_list_of_object(object)#

Return a list of face zones by ID in the specified face zone labels of an object.

>>> meshing_session.meshing_queries.get_face_zone_id_list_of_object("elbow-fluid")

get_face_zone_id_list_of_regions(object, region_list)#

Return a list of face zones by ID in the specified regions of an object.

>>> meshing_session.meshing_queries.get_face_zone_id_list_of_regions("elbow-fluid", ["fluid"])

get_face_zone_list_by_maximum_entity_count(max_entity_count, only_boundary)#

Return a list of face zones with a count below the maximum entity count (maximum-entity-count) specified. You can choose to restrict the report to only boundary edge zones, if required (only-boundary? set to True or False).

>>> meshing_session.meshing_queries.get_face_zone_list_by_maximum_entity_count(20, True)

get_face_zone_list_by_maximum_zone_area(maximum_zone_area)#

Return a list of face zones with a maximum zone area below the maximum-zone-area specified.

>>> meshing_session.meshing_queries.get_face_zone_list_by_maximum_zone_area(100)

get_face_zone_list_by_minimum_zone_area(minimum_zone_area)#

Return a list of face zones with a minimum zone area above the minimum-zone-area specified.

>>> meshing_session.meshing_queries.get_face_zone_list_by_minimum_zone_area(10)

get_face_zones_of_filter(filter)#

Return a list of face zones whose names contain the specified filter string.

>>> meshing_session.meshing_queries.get_face_zones_of_filter("*")

get_face_zones_of_labels(object, label_name_list)#

Return a list of face zones in the specified face zone labels of the object specified.

>>> meshing_session.meshing_queries.get_face_zones_of_labels("elbow-fluid", ["inlet", "outlet", "wall", "internal"])

get_face_zones_of_objects(object_list)#

Return a list of face zones in the specified objects.

>>> meshing_session.meshing_queries.get_face_zones_of_objects(["elbow-fluid"])

get_face_zones_of_prism_controls(control_name)#

Return a list of face zones to which the specified prism controls apply.

>>> meshing_session.meshing_queries.get_face_zones_of_prism_controls("*")

get_face_zones_of_regions(object, region_name_list)#

Return a list of face zones in the specified regions.

>>> meshing_session.meshing_queries.get_face_zones_of_regions("elbow-fluid", ["fluid"])

get_face_zones_shared_by_regions_of_type(mesh_object, region_type)#

Return a list of face zones shared by regions of specified types in the mesh object specified, where region-type is fluid-fluid, solid-solid, or fluid-solid.

>>> meshing_session.meshing_queries.get_face_zones_shared_by_regions_of_type("elbow-fluid", "fluid-fluid")

get_face_zones_with_zone_specific_prisms_applied()#

Return a list of face zones with zone-specific prism settings applied.

>>> meshing_session.meshing_queries.get_face_zones_with_zone_specific_prisms_applied()

get_interior_zones_connected_to_cell_zones(list_or_name_or_pattern)#

Returns interior face zones connected to given cell zones.

>>> meshing_session.meshing_queries.get_interior_zones_connected_to_cell_zones([3460])

>>> meshing_session.meshing_queries.get_interior_zones_connected_to_cell_zones("*")

get_maxsize_cell_zone_by_count(list_or_pattern)#

Return cell zone with maximum count of elements for given list or pattern of cell zones.

>>> meshing_session.meshing_queries.get_maxsize_cell_zone_by_count("*")

>>> meshing_session.meshing_queries.get_maxsize_cell_zone_by_count([3460])

get_maxsize_cell_zone_by_volume(list_or_pattern)#

Return cell zone with maximum volume for given list or pattern of cell zones.

>>> meshing_session.meshing_queries.get_maxsize_cell_zone_by_volume("*")

>>> meshing_session.meshing_queries.get_maxsize_cell_zone_by_volume([3460])

get_minsize_face_zone_by_area(list_or_pattern)#

Return face zone with minimum area for given list or pattern of face zones.

>>> meshing_session.meshing_queries.get_minsize_face_zone_by_area("*")

>>> meshing_session.meshing_queries.get_minsize_face_zone_by_area([29, 30, 31, 32, 33, 34])

get_minsize_face_zone_by_count(list_or_pattern)#

Return face zone with minimum count of elements for given list or pattern of face zones.

>>> meshing_session.meshing_queries.get_minsize_face_zone_by_count("*")

>>> meshing_session.meshing_queries.get_minsize_face_zone_by_count([29, 30, 31, 32, 33, 34])

get_node_zones_of_filter(filter)#

Return a list of node zones whose names contain the specified filter string.

>>> meshing_session.meshing_queries.get_node_zones_of_filter("*")

get_object_name_list_of_type(type)#

Return a list of objects of the specified type.

>>> meshing_session.meshing_queries.get_object_name_list_of_type("mesh")

get_objects_of_filter(filter)#

Return a list of objects whose names contain the specified filter string.

>>> meshing_session.meshing_queries.get_objects_of_filter("*")

get_objects_of_type(type)#

Return a list of objects of the specified type.

>>> meshing_session.meshing_queries.get_objects_of_type("mesh")

get_overlapping_face_zones(zone_name_pattern, area_tolerance, distance_tolerance)#

Return a list of overlapping face zones based on the area-tolerance and distance-tolerance specified.

>>> meshing_session.meshing_queries.GetOverlappingFaceZones("*", 0.1, 0.1)

get_prism_cell_zones(list_or_pattern)#

Return a list of prism cell zones.

>>> meshing_session.meshing_queries.get_prism_cell_zones(["inlet", "outlet"])

>>> meshing_session.meshing_queries.get_prism_cell_zones("*")

get_region_name_list_of_face_zones(list_or_pattern)#

Return a list of regions containing the face zones specified.

>>> meshing_session.meshing_queries.get_region_name_list_of_face_zones([29, 30, 31, 32, 33, 34])

get_region_name_list_of_object(object)#

Return a list of regions in the specified object.

>>> meshing_session.meshing_queries.get_region_name_list_of_object("elbow-fluid")

get_region_name_list_of_pattern(object, region_name_or_pattern)#

Return a list of regions in the specified object, whose names contain the specified name pattern.

>>> meshing_session.meshing_queries.get_region_name_list_of_pattern("elbow-fluid", "*")

get_region_volume(object_name, region_name)#

Return the region volume for the specified region of an object.

>>> meshing_session.meshing_queries.get_region_volume("elbow-fluid", "fluid")

get_regions_of_face_zones(list_of_face_zone_ids)#

Return a list of regions containing the face zones specified.

>>> meshing_session.meshing_queries.get_regions_of_face_zones([29, 30, 31, 32, 33, 34])

get_regions_of_filter(object, filter)#

Return a list of regions in the specified object, whose names contain the specified filter string.

>>> meshing_session.meshing_queries.get_regions_of_filter("elbow-fluid", "*")

get_regions_of_object(object)#

Return a list of regions in the specified object.

>>> meshing_session.meshing_queries.get_regions_of_object("elbow-fluid")

get_shared_boundary_zones(list_or_name_or_pattern)#

Returns the number of faces and the boundary face zones that are shared with the specified cell zones.

>>> meshing_session.meshing_queries.get_shared_boundary_zones("*")

>>> meshing_session.meshing_queries.get_shared_boundary_zones([3460])

get_tet_cell_zones(list_or_pattern)#

Return a list of tet cell zones.

>>> meshing_session.meshing_queries.get_tet_cell_zones(["inlet", "outlet"])

>>> meshing_session.meshing_queries.get_tet_cell_zones("*")

get_unreferenced_cell_zone_id_list_of_pattern(pattern)#

Return a list of unreferenced cell zones by ID, whose names contain the specified pattern.

>>> meshing_session.meshing_queries.get_unreferenced_cell_zone_id_list_of_pattern("*")

get_unreferenced_cell_zones()#

Return a list of unreferenced cell zones.

>>> meshing_session.meshing_queries.get_unreferenced_cell_zones()

get_unreferenced_cell_zones_of_filter(filter)#

Return a list of unreferenced cell zones whose names contain the specified filter string.

>>> meshing_session.meshing_queries.get_unreferenced_cell_zones_of_filter("*")

get_unreferenced_edge_zone_id_list_of_pattern(pattern)#

Return a list of unreferenced edge zones by ID, whose names contain the specified pattern.

>>> meshing_session.meshing_queries.get_unreferenced_edge_zone_id_list_of_pattern("*")

get_unreferenced_edge_zones()#

Return a list of unreferenced edge zones.

>>> meshing_session.meshing_queries.get_unreferenced_edge_zones()

get_unreferenced_edge_zones_of_filter(filter)#

Return a list of unreferenced edge zones whose names contain the specified filter string.

>>> meshing_session.meshing_queries.get_unreferenced_edge_zones_of_filter("*")

get_unreferenced_face_zone_id_list_of_pattern(pattern)#

Return a list of unreferenced face zones by ID, whose names contain the specified pattern.

>>> meshing_session.meshing_queries.get_unreferenced_face_zone_id_list_of_pattern("*")

get_unreferenced_face_zones()#

Return a list of unreferenced face zones.

>>> meshing_session.meshing_queries.get_unreferenced_face_zones()

get_unreferenced_face_zones_of_filter(filter)#

Return a list of unreferenced face zones whose names contain the specified filter string.

>>> meshing_session.meshing_queries.get_unreferenced_face_zones_of_filter("*")

get_wrapped_zones()#

Return a list of wrapped face zones.

>>> meshing_session.meshing_queries.get_wrapped_zones()

get_zones_of_group(group)#

Return a list of zones of the specified default zone group or user-defined group.

>>> meshing_session.meshing_queries.get_zones_of_group("inlet")

get_zones_of_type(type)#

Return a list of zones of the specified default zone type.

>>> meshing_session.meshing_queries.get_zones_of_type("velocity-inlet")

get_zones_with_free_faces(list_or_pattern)#

Return a list of zones with free faces for the face zones specified.

>>> meshing_session.meshing_queries.get_zones_with_free_faces("*")

>>> meshing_session.meshing_queries.get_zones_with_free_faces([29, 30, 31, 32])

>>> meshing_session.meshing_queries.get_zones_with_free_faces(["inlet", "outlet"])

get_zones_with_marked_faces(list_or_pattern)#

Return a list of zones with marked faces for the face zones specified.

>>> meshing_session.meshing_queries.get_zones_with_marked_faces("*")

>>> meshing_session.meshing_queries.get_zones_with_marked_faces([29, 30, 31, 32])

>>> meshing_session.meshing_queries.get_zones_with_marked_faces(["inlet", "outlet"])

get_zones_with_multi_faces(list_or_pattern)#

Return a list of zones with multi-connected faces for the face zones specified.

>>> meshing_session.meshing_queries.get_zones_with_multi_faces("*")

>>> meshing_session.meshing_queries.get_zones_with_multi_faces([29, 30, 31, 32])

>>> meshing_session.meshing_queries.get_zones_with_multi_faces(["inlet", "outlet"])

sort_regions_by_volume(object_name, order)#

Returns a sorted list of volumetric regions by volume for the object specified. Specify the order (ascending or descending).

>>> meshing_session.meshing_queries.sort_regions_by_volume("elbow-fluid", "ascending")