meshing.datamodel.MeshingUtilities#
- class ansys.fluent.core.generated.datamodel_251.MeshingUtilities.Root(service, rules, path)#
Bases:
PyMenu
Singleton Root.
Methods:
__init__
(service, rules, path)__init__ method of PyMenu class.
Classes:
add_labels_on_cell_zones
(service, rules, command)Add labels on the specified cell zones.
add_labels_on_edge_zones
(service, rules, command)Add labels on the specified edge zones.
add_labels_on_face_zones
(service, rules, command)Add labels on the specified face zones.
boundary_zone_exists
(service, rules, query)Report if the boundary face zone exists.
cell_zone_exists
(service, rules, query[, path])Report if the volume mesh exists.
clean_face_zone_names
(service, rules, command)Clean up face zone names by removing IDs wherever possible.
convert_zone_ids_to_name_strings
(service, ...)Convert a list of IDs to a list of names.
convert_zone_name_strings_to_ids
(service, ...)Convert a list of zone name strings to a list of IDs.
copy_face_zone_labels
(service, rules, query)count_marked_faces
(service, rules, query[, path])Returns the count of marked faces for the face zones specified.
delete_all_sub_domains
(service, rules, command)Deletes all sub-domains (all domains other than global).
delete_empty_cell_zones
(service, rules, command)Delete empty cell zones.
delete_empty_edge_zones
(service, rules, command)Delete empty edge zones.
delete_empty_face_zones
(service, rules, command)Delete empty face zones.
delete_empty_zones
(service, rules, command)Delete empty zones based on the zones specified.
delete_marked_faces_in_zones
(service, rules, ...)Delete marked faces.
dump_face_zone_orientation_in_region
(...[, path])Return the face zones and their orientation for the mesh file specified.
fill_holes_in_face_zone_list
(service, rules, ...)Fill holes associated with free edges for the face zones specified, based on the number of free edges (max_hole_edges).
Return adjacent cell zones for given face zones.
Return adjacent boundary face zones for given cell zones.
get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones
(...)Return adjacent interior and boundary face zones for given cell zones.
Return adjacent zones based on edge connectivity.
Return adjacent zones based on node connectivity.
get_all_objects
(service, rules, query[, path])Return a list of all objects.
get_average_bounding_box_center
(service, ...)Return a suitable average point based on the zones specified.
get_baffles_for_face_zones
(service, rules, query)Return the baffle zones based on the face zone list specified.
get_bounding_box_of_zone_list
(service, ...)Return the bounding box extents for the list of zones.
get_cell_mesh_distribution
(service, rules, query)get_cell_quality_limits
(service, rules, query)get_cell_zone_count
(service, rules, query[, ...])Return count of entities for cell zones.
get_cell_zone_id_list_with_labels
(service, ...)Returns the list of cell zones (by ID) containing the labels specified.
get_cell_zone_shape
(service, rules, query[, ...])Return cell zone shape as string.
get_cell_zone_volume
(service, rules, query)Return cell zone volume for the specified zones.
get_cell_zones
(service, rules, query[, path])get_edge_size_limits
(service, rules, query)Report the edge size limits for the list of face zones.
get_edge_zone_id_list_with_labels
(service, ...)Returns the list of edge zones (by ID) containing the labels specified.
get_edge_zones
(service, rules, query[, path])get_edge_zones_list
(service, rules, query[, ...])Return a list of edge zones whose names contain the specified filter string.
get_edge_zones_of_object
(service, rules, query)Return a list of edge zones in the specified object or objects.
get_embedded_baffles
(service, rules, query)Return the embedded baffle zones.
get_face_mesh_distribution
(service, rules, query)get_face_quality_limits
(service, rules, query)get_face_zone_area
(service, rules, query[, path])Return face zone area for the specified zones.
get_face_zone_count
(service, rules, query[, ...])Return count of entities for face zones.
get_face_zone_id_list_with_labels
(service, ...)Returns the list of face zones (by ID) containing the labels specified.
get_face_zone_node_count
(service, rules, query)Returns the node count for the specified face zone.
get_face_zones
(service, rules, query[, path])get_face_zones_by_zone_area
(service, rules, ...)get_face_zones_of_object
(service, rules, query)Return a list of face zones with zone-specific prism settings applied.
get_free_faces_count
(service, rules, query)Returns the count of free faces for the face zones specified.
Returns interior face zones connected to given cell zones.
get_labels
(service, rules, query[, path])Return a list of face zone labels in the specified object, whose names contain the specified filter or pattern string.
get_labels_on_cell_zones
(service, rules, query)Returns the list of labels for the specified cell zones.
get_labels_on_edge_zones
(service, rules, query)Returns the list of labels for the specified edge zones.
get_labels_on_face_zones
(service, rules, query)Returns the list of labels for the specified face zones.
get_labels_on_face_zones_list
(service, ...)Returns the list of labels for the specified face zones.
get_maxsize_cell_zone_by_count
(service, ...)Return cell zone with maximum count of elements for given list or pattern of cell zones.
get_maxsize_cell_zone_by_volume
(service, ...)Return cell zone with maximum volume for given list or pattern of cell zones.
get_minsize_face_zone_by_area
(service, ...)Return face zone with minimum area for given list or pattern of face zones.
get_minsize_face_zone_by_count
(service, ...)Return face zone with minimum count of elements for given list or pattern of face zones.
get_multi_faces_count
(service, rules, query)Returns the count of multi-connected faces for the face zones specified.
get_node_zones
(service, rules, query[, path])Return a list of zones whose names contain the specified filter string.
get_objects
(service, rules, query[, path])Return a list of objects of the specified type or whose names contain the specified filter string.
get_overlapping_face_zones
(service, rules, query)Return a list of overlapping face zones based on the area_tolerance and distance_tolerance specified.
get_pairs_of_overlapping_face_zones
(service, ...)get_prism_cell_zones
(service, rules, query)Return a list of prism cell zones.
get_region_volume
(service, rules, query[, path])get_regions
(service, rules, query[, path])Return a list of regions in the specified object, whose names contain the specified filter string or specified name pattern.
get_regions_of_face_zones
(service, rules, query)Return a list of regions containing the face zones specified.
Returns the number of faces and the boundary face zones that are shared with the specified cell zones.
get_tet_cell_zones
(service, rules, query[, path])Return a list of tet cell zones.
get_unreferenced_cell_zones
(service, rules, ...)Return a list of unreferenced cell zones by ID, whose names contain the specified pattern or filter.
get_unreferenced_edge_zones
(service, rules, ...)Return a list of unreferenced edge zones by ID, whose names contain the specified pattern or filter.
get_unreferenced_face_zones
(service, rules, ...)Return a list of unreferenced face zones by ID, whose names contain the specified pattern or filter.
get_wrapped_face_zones
(service, rules, query)Return a list of wrapped face zones.
get_zone_type
(service, rules, query[, path])Return zone type as integer.
get_zones
(service, rules, query[, path])Return a list of zones of the specified default zone type, group or user-defined group.
Return a list of zones with free faces for the face zones specified.
Return a list of zones with marked faces for the face zones specified.
Return a list of zones with multi-connected faces for the face zones specified.
interior_zone_exists
(service, rules, query)Report if the interior face zone exists.
mark_bad_quality_faces
(service, rules, query)Mark bad quality faces on the boundary face zones specified, based on the quality limit (quality_limit) and number of rings (number_of_rings).
mark_duplicate_faces
(service, rules, query)Mark duplicate faces on the face zones specified.
mark_faces_by_quality
(service, rules, query)mark_faces_deviating_from_size_field
(...[, path])mark_faces_in_self_proximity
(service, rules, ...)mark_faces_using_node_degree
(service, rules, ...)mark_free_faces
(service, rules, query[, path])Mark free faces on the face zones specified.
mark_invalid_normals
(service, rules, query)Mark invalid normal locations on the face zones specified.
mark_island_faces
(service, rules, query[, path])Mark island faces on the face zones specified, based on the island face count (island_face_count).
mark_multi_faces
(service, rules, query[, path])Mark multi-connected faces on the face zones specified based on fringe length (fringe_length).
mark_point_contacts
(service, rules, query[, ...])Mark point contact locations on the face zones specified.
mark_self_intersecting_faces
(service, rules, ...)mark_sliver_faces
(service, rules, query[, path])Mark sliver faces on the face zones specified, based on the maximum height (max_height) and skewness limit (skew_limit).
mark_spikes
(service, rules, query[, path])Mark spikes on the face zones specified, based on the spike angle (spike_angle).
mark_steps
(service, rules, query[, path])Mark steps on the face zones specified, based on the step angle (step_angle) and step width (step_width).
merge_cell_zones
(service, rules, command[, path])merge_cell_zones_with_same_prefix
(service, ...)Merge cell zones containing the specified prefix.
merge_cell_zones_with_same_suffix
(service, ...)Merge cell zones containing the specified suffix.
merge_face_zones
(service, rules, command[, path])merge_face_zones_of_type
(service, rules, command)Merges face zones of a given type based on name pattern.
merge_face_zones_with_same_prefix
(service, ...)Merge face zones containing the specified prefix.
mesh_check
(service, rules, query[, path])mesh_exists
(service, rules, query[, path])Report if the volume mesh exists.
print_worst_quality_cell
(service, rules, query)project_zone_on_plane
(service, rules, query)refine_marked_faces_in_zones
(service, rules, ...)Refine marked faces.
remove_id_suffix_from_face_zones
(service, ...)Removes the ID suffix from face zone names.
remove_ids_from_zone_names
(service, rules, ...)Remove the zone ID from zone ID list.
remove_labels_on_cell_zones
(service, rules, ...)Removes the specified labels from the cell zones.
remove_labels_on_edge_zones
(service, rules, ...)Removes the specified labels from the edge zones.
remove_labels_on_face_zones
(service, rules, ...)Removes the specified labels from the face zones.
rename_edge_zone
(service, rules, command[, path])Renames an existing edge zone.
rename_face_zone
(service, rules, command[, path])Renames an existing face zone.
rename_face_zone_label
(service, rules, command)Renames the face zone label.
rename_object
(service, rules, command[, path])Renames the object.
renumber_zone_ids
(service, rules, command[, ...])Renumber zone IDs starting from the number specified (start_number).
replace_cell_zone_suffix
(service, rules, command)replace_edge_zone_suffix
(service, rules, command)replace_face_zone_suffix
(service, rules, command)replace_label_suffix
(service, rules, command)Rename labels by replacing the label suffix with a new suffix.
replace_object_suffix
(service, rules, command)Rename objects by replacing the object suffix with a new suffix.
scale_cell_zones_around_pivot
(service, ...)scale_face_zones_around_pivot
(service, ...)separate_face_zones_by_cell_neighbor
(...[, path])Separate face zones based on the cell neighbors.
set_object_cell_zone_type
(service, rules, ...)Set object cell zone type.
set_quality_measure
(service, rules, command)unpreserve_cell_zones
(service, rules, query)Enables you to unpreserve some/all preserved cell zones during the meshing process.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- class _cell_zones_labels_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the cell zone labels.
- Returns:
Examples
>>> meshing_session.meshing_utilities._cell_zones_labels_fdl()
- class _cell_zones_str_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the cell zone IDs.
- Returns:
Examples
>>> meshing_session.meshing_utilities._cell_zones_str_fdl()
- class _edge_zones_labels_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the edge zone labels.
- Returns:
Examples
>>> meshing_session.meshing_utilities._edge_zones_labels_fdl()
- class _edge_zones_str_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the edge zone IDs.
- Returns:
Examples
>>> meshing_session.meshing_utilities._edge_zones_str_fdl()
- class _face_zones_labels_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the face zone labels.
- Returns:
Examples
>>> meshing_session.meshing_utilities._face_zones_labels_fdl()
- class _face_zones_str_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the face zone IDs.
- Returns:
Examples
>>> meshing_session.meshing_utilities._face_zones_str_fdl()
- class _node_zones_labels_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the node zone labels.
- Returns:
Examples
>>> meshing_session.meshing_utilities._node_zones_labels_fdl()
- class _node_zones_str_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the node zone IDs.
- Returns:
Examples
>>> meshing_session.meshing_utilities._node_zones_str_fdl()
- class _object_names_str_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the object names.
- Returns:
Examples
>>> meshing_session.meshing_utilities._object_names_str_fdl()
- class _prism_cell_zones_labels_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the prism cell zone labels.
- Returns:
Examples
>>> meshing_session.meshing_utilities._prism_cell_zones_labels_fdl()
- class _prism_cell_zones_str_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the prism cell zone IDs.
- Returns:
Examples
>>> meshing_session.meshing_utilities._prism_cell_zones_str_fdl()
- class _regions_str_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the region names.
- Returns:
Examples
>>> meshing_session.meshing_utilities._regions_str_fdl()
- class _zone_types_fdl(service, rules, query, path=None)#
Bases:
PyQuery
Get a list containing the zone type names.
- Returns:
Examples
>>> meshing_session.meshing_utilities._zone_types_fdl()
- class add_labels_on_cell_zones(service, rules, command, path=None)#
Bases:
PyCommand
Add labels on the specified cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.add_labels_on_cell_zones(cell_zone_name_list=["elbow-fluid"], label_name_list=["elbow-1"]) >>> meshing_session.meshing_utilities.add_labels_on_cell_zones(cell_zone_id_list=[87], label_name_list=["87-1"]) >>> meshing_session.meshing_utilities.add_labels_on_cell_zones(cell_zone_name_pattern="*", label_name_list=["cell-1"])
- class add_labels_on_edge_zones(service, rules, command, path=None)#
Bases:
PyCommand
Add labels on the specified edge zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.add_labels_on_edge_zones(edge_zone_name_list=["symmetry:xyplane:hot-inlet:elbow-fluid:feature.20", "hot-inlet:wall-inlet:elbow-fluid:feature.21"], label_name_list=["20-1", "21-1"]) >>> meshing_session.meshing_utilities.add_labels_on_edge_zones(edge_zone_id_list=[22, 23], label_name_list=["22-1", "23-1"]) >>> meshing_session.meshing_utilities.add_labels_on_edge_zones(edge_zone_name_pattern="cold-inlet*", label_name_list=["26-1"])
- class add_labels_on_face_zones(service, rules, command, path=None)#
Bases:
PyCommand
Add labels on the specified face zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.add_labels_on_face_zones(face_zone_name_list=["wall-inlet", "wall-elbow"], label_name_list=["wall-inlet-1", "wall-elbow-1"]) >>> meshing_session.meshing_utilities.add_labels_on_face_zones(face_zone_id_list=[30, 31], label_name_list=["hot-inlet-1", "cold-inlet-1"]) >>> meshing_session.meshing_utilities.add_labels_on_face_zones(face_zone_name_pattern="out*", label_name_list=["outlet-1"])
- class boundary_zone_exists(service, rules, query, path=None)#
Bases:
PyQuery
Report if the boundary face zone exists.
Examples
>>> meshing_session.meshing_utilities.boundary_zone_exists(zone_id=31) >>> meshing_session.meshing_utilities.boundary_zone_exists(zone_name="wall-inlet")
- class cell_zone_exists(service, rules, query, path=None)#
Bases:
PyQuery
Report if the volume mesh exists.
Examples
>>> meshing_session.meshing_utilities.cell_zone_exists(zone_id=87) >>> meshing_session.meshing_utilities.cell_zone_exists(zone_name="elbow.87")
- class clean_face_zone_names(service, rules, command, path=None)#
Bases:
PyCommand
Clean up face zone names by removing IDs wherever possible.
- Returns:
Examples
>>> meshing_session.meshing_utilities.clean_face_zone_names()
- class convert_zone_ids_to_name_strings(service, rules, query, path=None)#
Bases:
PyQuery
Convert a list of IDs to a list of names.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.convert_zone_ids_to_name_strings(zone_id_list=[32, 31])
- class convert_zone_name_strings_to_ids(service, rules, query, path=None)#
Bases:
PyQuery
Convert a list of zone name strings to a list of IDs.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.convert_zone_name_strings_to_ids(zone_name_list=["outlet", "cold-inlet"])
- class copy_face_zone_labels(service, rules, query, path=None)#
Bases:
PyQuery
Copy labels from one face zone to another.
Specify either face zone names or IDs.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.copy_face_zone_labels(from_face_zone_id=33, to_face_zone_id=34)
- class count_marked_faces(service, rules, query, path=None)#
Bases:
PyQuery
Returns the count of marked faces for the face zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.count_marked_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.count_marked_faces(face_zone_name_pattern="*")
- class create_boi_and_size_functions_from_refinement_regions(service, rules, query, path=None)#
Bases:
PyQuery
Create bodies of influence and if required body of influence size functions from the mesh refinement regions.
Specify the refinement region type (set ‘region_type’ to ‘tet’ or ‘hexcore’).
Specify the prefix for the BOI zones (‘boi_prefix_string’), and choose whether to create the size functions (set create_size_function to True or False).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.create_boi_and_size_functions_from_refinement_regions(region_type="hexcore", boi_prefix_string="wall", create_size_function=True)
- class delete_all_sub_domains(service, rules, command, path=None)#
Bases:
PyCommand
Deletes all sub-domains (all domains other than global).
- Returns:
Examples
>>> meshing_session.meshing_utilities.delete_all_sub_domains()
- class delete_empty_cell_zones(service, rules, command, path=None)#
Bases:
PyCommand
Delete empty cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.delete_empty_cell_zones(cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.delete_empty_cell_zones(cell_zone_name_list=["elbow.87"]) >>> meshing_session.meshing_utilities.delete_empty_cell_zones(cell_zone_name_pattern="*")
- class delete_empty_edge_zones(service, rules, command, path=None)#
Bases:
PyCommand
Delete empty edge zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.delete_empty_edge_zones(edge_zone_id_list=[20, 25, 26]) >>> meshing_session.meshing_utilities.delete_empty_edge_zones("symmetry:xyplane:hot-inlet:elbow-fluid:feature.20", "hot-inlet:wall-inlet:elbow-fluid:feature.21") >>> meshing_session.meshing_utilities.delete_empty_edge_zones(edge_zone_name_pattern="*")
- class delete_empty_face_zones(service, rules, command, path=None)#
Bases:
PyCommand
Delete empty face zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.delete_empty_face_zones(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.delete_empty_face_zones(face_zone_name_list=["wall-inlet", "wallfluid-new"]) >>> meshing_session.meshing_utilities.delete_empty_face_zones(face_zone_name_pattern="*")
- class delete_empty_zones(service, rules, command, path=None)#
Bases:
PyCommand
Delete empty zones based on the zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.delete_empty_zones(zone_id_list=[20, 32, 87]) >>> meshing_session.meshing_utilities.delete_empty_zones(zone_name_list=["hotfluid-new", "elbow.87"]) >>> meshing_session.meshing_utilities.delete_empty_zones(zone_name_pattern="*")
- class delete_marked_faces_in_zones(service, rules, command, path=None)#
Bases:
PyCommand
Delete marked faces.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.delete_marked_faces_in_zones(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.delete_marked_faces_in_zones(face_zone_name_list=["wall-inlet", "wallfluid-new"]) >>> meshing_session.meshing_utilities.delete_marked_faces_in_zones(face_zone_name_pattern="*")
- class dump_face_zone_orientation_in_region(service, rules, query, path=None)#
Bases:
PyQuery
Return the face zones and their orientation for the mesh file specified.
Examples
>>> meshing_session.meshing_utilities.dump_face_zone_orientation_in_region(file_name="facezonetest.txt")
- class fill_holes_in_face_zone_list(service, rules, query, path=None)#
Bases:
PyQuery
Fill holes associated with free edges for the face zones specified, based on the number of free edges (max_hole_edges).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.fill_holes_in_face_zone_list(face_zone_id_list=[30, 31, 32], max_hole_edges=2) >>> meshing_session.meshing_utilities.fill_holes_in_face_zone_list(face_zone_name_list=["wall-inlet", "wallfluid-new"], max_hole_edges=2) >>> meshing_session.meshing_utilities.fill_holes_in_face_zone_list(face_zone_name_pattern="wall*", max_hole_edges=2)
- class get_adjacent_cell_zones_for_given_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return adjacent cell zones for given face zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_adjacent_cell_zones_for_given_face_zones(face_zone_id_list=[29, 30, 31, 32, 33]) >>> meshing_session.meshing_utilities.get_adjacent_cell_zones_for_given_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_adjacent_cell_zones_for_given_face_zones(face_zone_name_pattern="*")
- class get_adjacent_face_zones_for_given_cell_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return adjacent boundary face zones for given cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_adjacent_face_zones_for_given_cell_zones(cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.get_adjacent_face_zones_for_given_cell_zones(cell_zone_name_list=["elbow-fluid"]) >>> meshing_session.meshing_utilities.get_adjacent_face_zones_for_given_cell_zones(cell_zone_name_pattern="*")
- class get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return adjacent interior and boundary face zones for given cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones(cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones(cell_zone_name_list=["elbow-fluid"]) >>> meshing_session.meshing_utilities.get_adjacent_interior_and_boundary_face_zones_for_given_cell_zones(cell_zone_name_pattern="*")
- class get_adjacent_zones_by_edge_connectivity(service, rules, query, path=None)#
Bases:
PyQuery
Return adjacent zones based on edge connectivity.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_adjacent_zones_by_edge_connectivity(zone_id_list=[29, 30, 31, 32, 33]) >>> meshing_session.meshing_utilities.get_adjacent_zones_by_edge_connectivity(zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_adjacent_zones_by_edge_connectivity(zone_name_pattern="*")
- class get_adjacent_zones_by_node_connectivity(service, rules, query, path=None)#
Bases:
PyQuery
Return adjacent zones based on node connectivity.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_adjacent_zones_by_node_connectivity(zone_id_list=[29, 30, 31, 32, 33]) >>> meshing_session.meshing_utilities.get_adjacent_zones_by_node_connectivity(zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_adjacent_zones_by_node_connectivity(zone_name_pattern="*")
- class get_all_objects(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of all objects.
Examples
>>> meshing_session.meshing_utilities.get_all_objects()
- class get_average_bounding_box_center(service, rules, query, path=None)#
Bases:
PyQuery
Return a suitable average point based on the zones specified.
Examples
>>> meshing_session.meshing_utilities.get_average_bounding_box_center(face_zone_id_list=[30, 31, 32])
- class get_baffles_for_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return the baffle zones based on the face zone list specified.
Examples
>>> meshing_session.meshing_utilities.get_baffles_for_face_zones(face_zone_id_list=[29, 30, 31, 32, 33])
- class get_bounding_box_of_zone_list(service, rules, query, path=None)#
Bases:
PyQuery
Return the bounding box extents for the list of zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_bounding_box_of_zone_list(zone_id_list=[26])
- class get_cell_mesh_distribution(service, rules, query, path=None)#
Bases:
PyQuery
Report the cell mesh distribution based on the specified measure, partitions, and range.
Specify the ‘measure’ as one of the ‘Orthogonal Quality’, ‘Skewness’, ‘Equiangle Skewness’, ‘Size Change’, ‘Edge Ratio’, ‘Size’, ‘Aspect Ratio’, ‘Squish’, ‘Warp’, ‘Dihedral Angle’, ‘ICEMCFD Quality’, ‘Ortho Skew’, ‘FLUENT Aspect Ratio’, ‘Inverse Orthogonal Quality’ value.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_cell_mesh_distribution(cell_zone_id_list=[87], measure="Orthogonal Quality", partitions=2, range=[0.9, 1]) >>> meshing_session.meshing_utilities.get_cell_mesh_distribution(cell_zone_name_list=["elbow-fluid"], measure="Orthogonal Quality", partitions=2, range=[0.9, 1]) >>> meshing_session.meshing_utilities.get_cell_mesh_distribution(cell_zone_name_pattern="*", measure="Orthogonal Quality", partitions=2, range=[0.9, 1])
- class get_cell_quality_limits(service, rules, query, path=None)#
Bases:
PyQuery
Report the number of cells and the cell quality limits (minimum, maximum, average quality) for the list of zones based on the measure specified.
You can also report the cell size limits.
Specify the ‘measure’ as one of the ‘Orthogonal Quality’, ‘Skewness’, ‘Equiangle Skewness’, ‘Size Change’, ‘Edge Ratio’, ‘Size’, ‘Aspect Ratio’, ‘Squish’, ‘Warp’, ‘Dihedral Angle’, ‘ICEMCFD Quality’, ‘Ortho Skew’, ‘FLUENT Aspect Ratio’, ‘Inverse Orthogonal Quality’ value.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_cell_quality_limits(cell_zone_id_list=[87], measure="Orthogonal Quality") >>> meshing_session.meshing_utilities.get_cell_quality_limits(cell_zone_name_list=["elbow-fluid"], measure="Orthogonal Quality") >>> meshing_session.meshing_utilities.get_cell_quality_limits(cell_zone_name_pattern="*", measure="Orthogonal Quality")
- class get_cell_zone_count(service, rules, query, path=None)#
Bases:
PyQuery
Return count of entities for cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_cell_zone_count(cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.get_cell_zone_count(cell_zone_name_list=["elbow-fluid"]) >>> meshing_session.meshing_utilities.get_cell_zone_count(cell_zone_name_pattern="*")
- class get_cell_zone_id_list_with_labels(service, rules, query, path=None)#
Bases:
PyQuery
Returns the list of cell zones (by ID) containing the labels specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_cell_zone_id_list_with_labels(cell_zone_id_list=[87], label_name_list=["elbow-1"]) >>> meshing_session.meshing_utilities.get_cell_zone_id_list_with_labels(cell_zone_name_list=["elbow-fluid"], label_name_list=["elbow-1"]) >>> meshing_session.meshing_utilities.get_cell_zone_id_list_with_labels(cell_zone_name_pattern="*", label_name_list=["elbow-1"])
- class get_cell_zone_shape(service, rules, query, path=None)#
Bases:
PyQuery
Return cell zone shape as string.
Examples
>>> meshing_session.meshing_utilities.get_cell_zone_shape(cell_zone_id=87)
- class get_cell_zone_volume(service, rules, query, path=None)#
Bases:
PyQuery
Return cell zone volume for the specified zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_cell_zone_volume(cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.get_cell_zone_volume(cell_zone_name_list=["elbow-fluid"]) >>> meshing_session.meshing_utilities.get_cell_zone_volume(cell_zone_name_pattern="*")
- class get_cell_zones(service, rules, query, path=None)#
Bases:
PyQuery
Get cell zones using 1 - maximum_entity_count and only_boundary or 2 - xyz_coordinates or 3 - filter.
Return a list of cell zones at or closest to a specified location (xyz_coordinates).
Return a list of cell zones with a count below the maximum entity count (maximum_entity_count) specified.
You can choose to restrict the report to only boundary cell zones, if required (only_boundary set to True or False).
Return a list of zones whose names contain the specified filter string.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_cell_zones(filter="*") >>> meshing_session.meshing_utilities.get_cell_zones(maximum_entity_count=100) >>> meshing_session.meshing_utilities.get_cell_zones(xyz_coordinates=[-7, -6, 0.4])
- class get_edge_size_limits(service, rules, query, path=None)#
Bases:
PyQuery
Report the edge size limits for the list of face zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_edge_size_limits(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.get_edge_size_limits(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.get_edge_size_limits(face_zone_name_pattern="*")
- class get_edge_zone_id_list_with_labels(service, rules, query, path=None)#
Bases:
PyQuery
Returns the list of edge zones (by ID) containing the labels specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_edge_zone_id_list_with_labels(edge_zone_id_list=[20, 21], label_name_list=["20-1", "21-1"]) >>> meshing_session.meshing_utilities.get_edge_zone_id_list_with_labels(edge_zone_name_list=["symmetry:xyplane:hot-inlet:elbow-fluid:feature.20", "hot-inlet:wall-inlet:elbow-fluid:feature.21"], label_name_list=["20-1", "21-1"]) >>> meshing_session.meshing_utilities.get_edge_zone_id_list_with_labels(edge_zone_name_pattern="*", label_name_list=["20-1", "21-1"])
- class get_edge_zones(service, rules, query, path=None)#
Bases:
PyQuery
Get edge zones using 1 - maximum_entity_count and only_boundary or 2 - filter Return a list of edge zones with a count below the maximum entity count (maximum_entity_count) specified.
You can choose to restrict the report to only boundary edge zones, if required (only_boundary set to True or False).
Return a list of zones whose names contain the specified filter string.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_edge_zones(filter="*") >>> meshing_session.meshing_utilities.get_edge_zones(maximum_entity_count=20, only_boundary=False)
- class get_edge_zones_list(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of edge zones whose names contain the specified filter string.
Examples
>>> meshing_session.meshing_utilities.get_edge_zones_list(filter="*")
- class get_edge_zones_of_object(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of edge zones in the specified object or objects.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_edge_zones_of_object(objects=["elbow-fluid"]) >>> meshing_session.meshing_utilities.get_edge_zones_of_object(object_name="elbow-fluid")
- class get_embedded_baffles(service, rules, query, path=None)#
Bases:
PyQuery
Return the embedded baffle zones.
Examples
>>> meshing_session.meshing_utilities.get_embedded_baffles()
- class get_face_mesh_distribution(service, rules, query, path=None)#
Bases:
PyQuery
Report the face mesh distribution based on the specified measure, partitions, and range.
Specify the ‘measure’ as one of the ‘Orthogonal Quality’, ‘Skewness’, ‘Equiangle Skewness’, ‘Size Change’, ‘Edge Ratio’, ‘Size’, ‘Aspect Ratio’, ‘Squish’, ‘Warp’, ‘Dihedral Angle’, ‘ICEMCFD Quality’, ‘Ortho Skew’, ‘FLUENT Aspect Ratio’, ‘Inverse Orthogonal Quality’ value.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_face_mesh_distribution(face_zone_id_list=[30, 31, 32], measure="Orthogonal Quality", partitions=2, range=[0.9, 1]) >>> meshing_session.meshing_utilities.get_face_mesh_distribution(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], measure="Orthogonal Quality", partitions=2, range=[0.9, 1]) >>> meshing_session.meshing_utilities.get_face_mesh_distribution(face_zone_name_pattern="*", measure="Orthogonal Quality", partitions=2, range=[0.9, 1])
- class get_face_quality_limits(service, rules, query, path=None)#
Bases:
PyQuery
Report the number of faces and the face quality limits (minimum, maximum, average quality) for the list of zones based on the measure specified.
You can also report the face size limits.
Specify the ‘measure’ as one of the ‘Orthogonal Quality’, ‘Skewness’, ‘Equiangle Skewness’, ‘Size Change’, ‘Edge Ratio’, ‘Size’, ‘Aspect Ratio’, ‘Squish’, ‘Warp’, ‘Dihedral Angle’, ‘ICEMCFD Quality’, ‘Ortho Skew’, ‘FLUENT Aspect Ratio’, ‘Inverse Orthogonal Quality’ value.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_face_quality_limits(face_zone_id_list=[30, 31, 32], measure="Orthogonal Quality") >>> meshing_session.meshing_utilities.get_face_quality_limits(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], measure="Orthogonal Quality") >>> meshing_session.meshing_utilities.get_face_quality_limits(face_zone_name_pattern="*", measure="Orthogonal Quality")
- class get_face_zone_area(service, rules, query, path=None)#
Bases:
PyQuery
Return face zone area for the specified zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_face_zone_area(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.get_face_zone_area(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.get_face_zone_area(face_zone_name_pattern="*")
- class get_face_zone_count(service, rules, query, path=None)#
Bases:
PyQuery
Return count of entities for face zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_face_zone_count(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.get_face_zone_count(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.get_face_zone_count(face_zone_name_pattern="*")
- class get_face_zone_id_list_with_labels(service, rules, query, path=None)#
Bases:
PyQuery
Returns the list of face zones (by ID) containing the labels specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_face_zone_id_list_with_labels(face_zone_id_list=[33, 34], label_name_list=["wall-inlet-1", "wall-elbow-1"]) >>> meshing_session.meshing_utilities.get_face_zone_id_list_with_labels(face_zone_name_list=["wall-inlet", "wall-elbow"], label_name_list=["wall-inlet-1", "wall-elbow-1"]) >>> meshing_session.meshing_utilities.get_face_zone_id_list_with_labels(face_zone_name_pattern="wall*", label_name_list=["wall-inlet-1", "wall-elbow-1"])
- class get_face_zone_node_count(service, rules, query, path=None)#
Bases:
PyQuery
Returns the node count for the specified face zone.
Examples
>>> meshing_session.meshing_utilities.get_face_zone_node_count(face_zone_id=32) >>> meshing_session.meshing_utilities.get_face_zone_node_count(face_zone_name="outlet")
- class get_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Get face zones using 1 - maximum_entity_count and only_boundary or 2 - prism_control_name or 3 - xyz_coordinates or 4 - filter.
Return a list of face zones at or closest to a specified location (xyz_coordinates - not applicable to polyhedra mesh).
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 face zones, if required (only_boundary set to True or False).
Return a list of face zones to which the specified prism controls apply.
Return a list of zones whose names contain the specified filter string.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_face_zones(filter="*") >>> meshing_session.meshing_utilities.get_face_zones(prism_control_name="*") >>> meshing_session.meshing_utilities.get_face_zones(xyz_coordinates=[1.4, 1.4, 1.4]) >>> meshing_session.meshing_utilities.get_face_zones(maximum_entity_count=20, only_boundary=True)
- class get_face_zones_by_zone_area(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of face zones with a maximum zone area below the maximum_zone_area specified.
Return a list of face zones with a minimum zone area above the minimum_zone_area specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_face_zones_by_zone_area(maximum_zone_area=100) >>> meshing_session.meshing_utilities.get_face_zones_by_zone_area(minimum_zone_area=10)
- class get_face_zones_of_object(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of face zones using 1 - object_name and regions or 2 - object_name and labels or 3 - object_name and region_type or 4 - object_name or 5 - objects.
where region_type is one of the ‘fluid-fluid’, ‘solid-solid’, or ‘fluid-solid’ value.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_face_zones_of_object(object_name="elbow-fluid", regions=["elbow-fluid"]) >>> meshing_session.meshing_utilities.get_face_zones_of_object(object_name="elbow-fluid", labels=["outlet"]) >>> meshing_session.meshing_utilities.get_face_zones_of_object(object_name="elbow-fluid", region_type="elbow-fluid") >>> meshing_session.meshing_utilities.get_face_zones_of_object(object_name="elbow-fluid") >>> meshing_session.meshing_utilities.get_face_zones_of_object(objects=["elbow-fluid"])
- class get_face_zones_with_zone_specific_prisms_applied(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of face zones with zone-specific prism settings applied.
Examples
>>> meshing_session.meshing_utilities.get_face_zones_with_zone_specific_prisms_applied()
- class get_free_faces_count(service, rules, query, path=None)#
Bases:
PyQuery
Returns the count of free faces for the face zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_free_faces_count(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.get_free_faces_count(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.get_free_faces_count(face_zone_name_pattern="*")
- class get_interior_face_zones_for_given_cell_zones(service, rules, query, path=None)#
Bases:
PyQuery
Returns interior face zones connected to given cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_interior_face_zones_for_given_cell_zones(cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.get_interior_face_zones_for_given_cell_zones(cell_zone_name_list=["elbow-fluid"]) >>> meshing_session.meshing_utilities.get_interior_face_zones_for_given_cell_zones(cell_zone_name_pattern="*")
- class get_labels(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of face zone labels in the specified object, whose names contain the specified filter or pattern string.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_labels(object_name="elbow-fluid") >>> meshing_session.meshing_utilities.get_labels(object_name="elbow-fluid", filter="*") >>> meshing_session.meshing_utilities.get_labels(object_name="elbow-fluid", label_name_pattern="*")
- class get_labels_on_cell_zones(service, rules, query, path=None)#
Bases:
PyQuery
Returns the list of labels for the specified cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_labels_on_cell_zones(cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.get_labels_on_cell_zones(cell_zone_name_list=["elbow-fluid"]) >>> meshing_session.meshing_utilities.get_labels_on_cell_zones(cell_zone_name_pattern="*")
- class get_labels_on_edge_zones(service, rules, query, path=None)#
Bases:
PyQuery
Returns the list of labels for the specified edge zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_labels_on_edge_zones(edge_zone_id_list=[22, 23]) >>> meshing_session.meshing_utilities.get_labels_on_edge_zones(edge_zone_name_list=["symmetry:xyplane:hot-inlet:elbow-fluid:feature.20", "hot-inlet:wall-inlet:elbow-fluid:feature.21"]) >>> meshing_session.meshing_utilities.get_labels_on_edge_zones(edge_zone_name_pattern="cold-inlet*")
- class get_labels_on_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Returns the list of labels for the specified face zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_labels_on_face_zones(face_zone_id_list=[30, 31]) >>> meshing_session.meshing_utilities.get_labels_on_face_zones(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.get_labels_on_face_zones(face_zone_name_pattern="out*")
- class get_labels_on_face_zones_list(service, rules, query, path=None)#
Bases:
PyQuery
Returns the list of labels for the specified face zones.
Examples
>>> meshing_session.meshing_utilities.get_labels_on_face_zones_list(face_zone_id_list=[30, 31])
- class get_maxsize_cell_zone_by_count(service, rules, query, path=None)#
Bases:
PyQuery
Return cell zone with maximum count of elements for given list or pattern of cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_count(zone_id_list=[87]) >>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_count(zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_count(zone_name_pattern="*")
- class get_maxsize_cell_zone_by_volume(service, rules, query, path=None)#
Bases:
PyQuery
Return cell zone with maximum volume for given list or pattern of cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_volume(zone_id_list=[87]) >>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_volume(zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_maxsize_cell_zone_by_volume(zone_name_pattern="*")
- class get_minsize_face_zone_by_area(service, rules, query, path=None)#
Bases:
PyQuery
Return face zone with minimum area for given list or pattern of face zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_minsize_face_zone_by_area(zone_id_list=[29, 30, 31, 32, 33]) >>> meshing_session.meshing_utilities.get_minsize_face_zone_by_area(zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_minsize_face_zone_by_area(zone_name_pattern="*")
- class get_minsize_face_zone_by_count(service, rules, query, path=None)#
Bases:
PyQuery
Return face zone with minimum count of elements for given list or pattern of face zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_minsize_face_zone_by_count(zone_id_list=[29, 30, 31, 32, 33]) >>> meshing_session.meshing_utilities.get_minsize_face_zone_by_count(zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_minsize_face_zone_by_count(zone_name_pattern="*")
- class get_multi_faces_count(service, rules, query, path=None)#
Bases:
PyQuery
Returns the count of multi-connected faces for the face zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_multi_faces_count(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.get_multi_faces_count(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.get_multi_faces_count(face_zone_name_pattern="*")
- class get_node_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of zones whose names contain the specified filter string.
Examples
>>> meshing_session.meshing_utilities.get_node_zones(filter="*")
- class get_objects(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of objects of the specified type or whose names contain the specified filter string.
Examples
>>> meshing_session.meshing_utilities.get_objects(type_name="mesh") >>> meshing_session.meshing_utilities.get_objects(filter="*")
- class get_overlapping_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of overlapping face zones based on the area_tolerance and distance_tolerance specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_overlapping_face_zones(face_zone_name_pattern="*", area_tolerance=0.01, distance_tolerance=0.01)
- class get_pairs_of_overlapping_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return the pairs of overlapping face zones based on the join tolerance and feature angle.
Specify the tolerance value for locating the overlapping faces (join_tolerance).
Choose to use an absolute tolerance value or relative to face edges (set absolute_tolerance to True or False).
Specify the feature angle to identify features in the overlap region (feature_angle).
The default value is 40.
Each member in the list returned includes the zone IDs for the overlapping zone pair and the join region represented by the bounding box.
The same pair of zones may appear multiple times (with different join region bounding box coordinates) in the returned list.
- Parameters:
- face_zone_id_list
list
[int
] List containing the face zone IDs.
- face_zone_name_list
list
[str
] List containing the face zone names.
- face_zone_name_pattern
str
Face zone name pattern.
- join_tolerance
float
Join tolerance.
- absolute_tolerancebool
Specify whether to use an absolute tolerance value or relative to face edges.
- join_angle
float
Join angle.
- face_zone_id_list
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_pairs_of_overlapping_face_zones(face_zone_id_list=[29, 30, 31, 32, 33], join_tolerance=0.001, absolute_tolerance=True, join_angle=45) >>> meshing_session.meshing_utilities.get_pairs_of_overlapping_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"], join_tolerance=0.001, absolute_tolerance=True, join_angle=45) >>> meshing_session.meshing_utilities.get_pairs_of_overlapping_face_zones(face_zone_name_pattern="*", join_tolerance=0.001, absolute_tolerance=True, join_angle=45)
- class get_prism_cell_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of prism cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_prism_cell_zones(zone_id_list=[87]) >>> meshing_session.meshing_utilities.get_prism_cell_zones(zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_prism_cell_zones(zone_name_pattern="*")
- class get_region_volume(service, rules, query, path=None)#
Bases:
PyQuery
Get region volume using 1 - object_name and region_name or 2 - object_name and order.
Return the region volume for the specified region of an object.
Returns a sorted list of volumetric regions by volume for the object specified.
Specify the order ‘ascending’ or ‘descending’.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_region_volume(object_name="elbow-fluid", sorting_order="ascending") >>> meshing_session.meshing_utilities.get_region_volume(object_name="elbow-fluid", region_name="elbow-fluid")
- class get_regions(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of regions in the specified object, whose names contain the specified filter string or specified name pattern.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_regions(object_name="elbow-fluid", region_name_pattern="*") >>> meshing_session.meshing_utilities.get_regions(object_name="elbow-fluid", filter="*") >>> meshing_session.meshing_utilities.get_regions(object_name="elbow-fluid")
- class get_regions_of_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of regions containing the face zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_regions_of_face_zones(face_zone_id_list=[29, 30, 31, 32, 33]) >>> meshing_session.meshing_utilities.get_regions_of_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_regions_of_face_zones(face_zone_name_pattern="*")
Bases:
PyQuery
Returns the number of faces and the boundary face zones that are shared with the specified cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_shared_boundary_face_zones_for_given_cell_zones(cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.get_shared_boundary_face_zones_for_given_cell_zones(cell_zone_name_list=["elbow-fluid"]) >>> meshing_session.meshing_utilities.get_shared_boundary_face_zones_for_given_cell_zones(cell_zone_name_pattern="*")
- class get_tet_cell_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of tet cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_tet_cell_zones(zone_id_list=[29, 30, 31, 32, 33]) >>> meshing_session.meshing_utilities.get_tet_cell_zones(zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_tet_cell_zones(zone_name_pattern="*")
- class get_unreferenced_cell_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of unreferenced cell zones by ID, whose names contain the specified pattern or filter.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_unreferenced_cell_zones() >>> meshing_session.meshing_utilities.get_unreferenced_cell_zones(filter="*") >>> meshing_session.meshing_utilities.get_unreferenced_cell_zones(zone_name_pattern="*")
- class get_unreferenced_edge_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of unreferenced edge zones by ID, whose names contain the specified pattern or filter.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_unreferenced_edge_zones() >>> meshing_session.meshing_utilities.get_unreferenced_edge_zones(filter="*") >>> meshing_session.meshing_utilities.get_unreferenced_edge_zones(zone_name_pattern="*")
- class get_unreferenced_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of unreferenced face zones by ID, whose names contain the specified pattern or filter.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_unreferenced_face_zones() >>> meshing_session.meshing_utilities.get_unreferenced_face_zones(filter="*") >>> meshing_session.meshing_utilities.get_unreferenced_face_zones(zone_name_pattern="*")
- class get_wrapped_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of wrapped face zones.
Examples
>>> meshing_session.meshing_utilities.get_wrapped_face_zones()
- class get_zone_type(service, rules, query, path=None)#
Bases:
PyQuery
Return zone type as integer.
Examples
>>> meshing_session.meshing_utilities.get_zone_type(zone_id=87) >>> meshing_session.meshing_utilities.get_zone_type(zone_name="elbow-fluid")
- class get_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of zones of the specified default zone type, group or user-defined group.
Examples
>>> meshing_session.meshing_utilities.get_zones(type_name="velocity-inlet") >>> meshing_session.meshing_utilities.get_zones(group_name="inlet")
- class get_zones_with_free_faces_for_given_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of zones with free faces for the face zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_zones_with_free_faces_for_given_face_zones(face_zone_id_list=[29, 30, 31, 32, 33]) >>> meshing_session.meshing_utilities.get_zones_with_free_faces_for_given_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_zones_with_free_faces_for_given_face_zones(face_zone_id_list=[face_zone_name_pattern="*"])
- class get_zones_with_marked_faces_for_given_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of zones with marked faces for the face zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_zones_with_marked_faces_for_given_face_zones(face_zone_id_list=[29, 30, 31, 32, 33]) >>> meshing_session.meshing_utilities.get_zones_with_marked_faces_for_given_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_zones_with_marked_faces_for_given_face_zones(face_zone_id_list=[face_zone_name_pattern="*"])
- class get_zones_with_multi_faces_for_given_face_zones(service, rules, query, path=None)#
Bases:
PyQuery
Return a list of zones with multi-connected faces for the face zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.get_zones_with_multi_faces_for_given_face_zones(face_zone_id_list=[29, 30, 31, 32, 33]) >>> meshing_session.meshing_utilities.get_zones_with_multi_faces_for_given_face_zones(face_zone_name_list=["outlet", "inlet", "wall", "internal"]) >>> meshing_session.meshing_utilities.get_zones_with_multi_faces_for_given_face_zones(face_zone_id_list=[face_zone_name_pattern="*"])
- class interior_zone_exists(service, rules, query, path=None)#
Bases:
PyQuery
Report if the interior face zone exists.
Examples
>>> meshing_session.meshing_utilities.interior_zone_exists(zone_id=31) >>> meshing_session.meshing_utilities.interior_zone_exists(zone_name="wall-inlet")
- class mark_bad_quality_faces(service, rules, query, path=None)#
Bases:
PyQuery
Mark bad quality faces on the boundary face zones specified, based on the quality limit (quality_limit) and number of rings (number_of_rings).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_bad_quality_faces(face_zone_id_list=[30, 31, 32], quality_limit=0.5, number_of_rings=2) >>> meshing_session.meshing_utilities.mark_bad_quality_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], quality_limit=0.5, number_of_rings=2) >>> meshing_session.meshing_utilities.mark_bad_quality_faces(face_zone_name_pattern="*", quality_limit=0.5, number_of_rings=2)
- class mark_duplicate_faces(service, rules, query, path=None)#
Bases:
PyQuery
Mark duplicate faces on the face zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_duplicate_faces(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.mark_duplicate_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.mark_duplicate_faces(face_zone_name_pattern="*")
- class mark_face_strips_by_height_and_quality(service, rules, query, path=None)#
Bases:
PyQuery
Mark face strips based on the strip_type, strip_height, quality_measure, quality_limit, and feature_angle specified.
Possible values for strip_type are 1, 2, 3 and 4.
1 - ‘boundary-boundary’ strip, multi-connected face edges are also considered as boundary here.
2 - feature-feature strip between angle based features, feature edges, multi-connected edges, and free edges are angle based features and boundary edges will be considered features if there is an angle.
3 - ‘all-all’ strip between all boundaries and features.
4 - ‘pure feature-feature’ strip, only pure features, boundary edges and multi edges will not be considered as pure feature edges even if there is an angle based feature.
The recommended value is 2.
Specify the ‘quality_measure’ as one of the ‘Skewness’, ‘Size Change’, ‘Edge Ratio’, ‘Area’, ‘Aspect Ratio’, ‘Warp’, ‘Dihedral Angle’, ‘Ortho Skew’ value.
- Parameters:
- face_zone_id_list
list
[int
] List containing the face zone IDs.
- face_zone_name_list
list
[str
] List containing the face zone names.
- face_zone_name_pattern
str
Face zone name pattern.
- strip_type
int
Strip type.
- strip_height
float
Strip height.
- quality_measure
str
Quality measure.
- quality_limit
float
Quality limit.
- feature_angle
float
Feature angle.
- face_zone_id_list
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_face_strips_by_height_and_quality(face_zone_id_list=[30, 31, 32], strip_type=2, strip_height=2, quality_measure="Size Change", quality_limit=0.5, feature_angle=40) >>> meshing_session.meshing_utilities.mark_face_strips_by_height_and_quality(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], strip_type=2, strip_height=2, quality_measure="Size Change", quality_limit=0.5, feature_angle=40) >>> meshing_session.meshing_utilities.mark_face_strips_by_height_and_quality(face_zone_name_pattern="cold*", strip_type=2, strip_height=2, quality_measure="Size Change", quality_limit=0.5, feature_angle=40)
- class mark_faces_by_quality(service, rules, query, path=None)#
Bases:
PyQuery
Mark faces based on the ‘quality_measure’ and ‘quality_limit’ specified.
Specify whether to append the faces to those previously marked or clear previously marked faces (append_marking set to True or False).
Specify the ‘quality_measure’ as one of the ‘Skewness’, ‘Size Change’, ‘Edge Ratio’, ‘Area’, ‘Aspect Ratio’, ‘Warp’, ‘Dihedral Angle’, ‘Ortho Skew’ value.
- Parameters:
- face_zone_id_list
list
[int
] List containing the face zone IDs.
- face_zone_name_list
list
[str
] List containing the face zone names.
- face_zone_name_pattern
str
Face zone name pattern.
- quality_measure
str
Quality measure.
- quality_limit
float
Quality limit.
- append_markingbool
Specify whether to append the faces to those previously marked or clear previously marked faces.
- face_zone_id_list
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_faces_by_quality(face_zone_id_list=[30, 31, 32], quality_measure="Skewness", quality_limit=0.9, append_marking=False) >>> meshing_session.meshing_utilities.mark_faces_by_quality(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], quality_measure="Skewness", quality_limit=0.9, append_marking=False) >>> meshing_session.meshing_utilities.mark_faces_by_quality(face_zone_name_pattern="*", quality_measure="Skewness", quality_limit=0.9, append_marking=False)
- class mark_faces_deviating_from_size_field(service, rules, query, path=None)#
Bases:
PyQuery
Mark all faces at nodes based on deviation from the size field.
Specify the size field type to be used to get size at node.
Set ‘size_factor_type_to_compare’ to ‘volumetric’ or ‘geodesic’.
Faces will be marked if the minimum edge length at the node is less than min_size_factor × size_factor_type_to_compare or the maximum edge length is greater than max_size_factor × size_factor_type_to_compare.
- Parameters:
- face_zone_id_list
list
[int
] List containing the face zone IDs.
- face_zone_name_list
list
[str
] List containing the face zone names.
- face_zone_name_pattern
str
Face zone name pattern.
- min_size_factor
float
Minimum size factor.
- max_size_factor
float
Maximum size factor.
- size_factor_type_to_compare
str
Size field type to be used to get size at node.
- face_zone_id_list
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_faces_deviating_from_size_field(face_zone_id_list=[30, 31, 32], min_size_factor=0.5, max_size_factor=1.1, size_factor_type_to_compare="geodesic") >>> meshing_session.meshing_utilities.mark_faces_deviating_from_size_field(face_zone_name_list=["cold-inlet", "hot-inlet"] min_size_factor=0.5, max_size_factor=1.1, size_factor_type_to_compare="geodesic") >>> meshing_session.meshing_utilities.mark_faces_deviating_from_size_field(face_zone_name_pattern="*", min_size_factor=0.5, max_size_factor=1.1, size_factor_type_to_compare="geodesic")
- class mark_faces_in_self_proximity(service, rules, query, path=None)#
Bases:
PyQuery
Mark faces in self-proximity on the face zones specified.
Specify whether to use relative tolerance (relative_tolerance set to True or False), tolerance value, the angle, and whether to ignore orientation (ignore_orientation set to True or False).
- Parameters:
- face_zone_id_list
list
[int
] List containing the face zone IDs.
- face_zone_name_list
list
[str
] List containing the face zone names.
- face_zone_name_pattern
str
Face zone name pattern.
- relative_tolerancebool
Specify whether to use relative tolerance.
- tolerance
float
Tolerance.
- proximity_angle
float
Proximity angle.
- ignore_orientationbool
Specify whether to ignore orientation.
- face_zone_id_list
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_faces_in_self_proximity(face_zone_id_list=[30, 31, 32], relative_tolerance=True, tolerance=0.05, proximity_angle=40.5, ignore_orientation=False) >>> meshing_session.meshing_utilities.mark_faces_in_self_proximity(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], relative_tolerance=True, tolerance=0.05, proximity_angle=40.5, ignore_orientation=False) >>> meshing_session.meshing_utilities.mark_faces_in_self_proximity(face_zone_name_pattern="*", relative_tolerance=True, tolerance=0.05, proximity_angle=40.5, ignore_orientation=False)
- class mark_faces_using_node_degree(service, rules, query, path=None)#
Bases:
PyQuery
Mark all faces with node degree above the specified threshold.
Node degree is defined as the number of edges connected to the node.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_faces_using_node_degree(face_zone_id_list=[30, 31, 32], node_degree_threshold=2) >>> meshing_session.meshing_utilities.mark_faces_using_node_degree(face_zone_name_list=["cold-inlet", "hot-inlet"], node_degree_threshold=2) >>> meshing_session.meshing_utilities.mark_faces_using_node_degree(face_zone_name_pattern="*", node_degree_threshold=2)
- class mark_free_faces(service, rules, query, path=None)#
Bases:
PyQuery
Mark free faces on the face zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_free_faces(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.mark_free_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.mark_free_faces(face_zone_name_pattern="*")
- class mark_invalid_normals(service, rules, query, path=None)#
Bases:
PyQuery
Mark invalid normal locations on the face zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_invalid_normals(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.mark_invalid_normals(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.mark_invalid_normals(face_zone_name_pattern="*")
- class mark_island_faces(service, rules, query, path=None)#
Bases:
PyQuery
Mark island faces on the face zones specified, based on the island face count (island_face_count).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_island_faces(face_zone_id_list=[30, 31, 32], island_face_count=5) >>> meshing_session.meshing_utilities.mark_island_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], island_face_count=5) >>> meshing_session.meshing_utilities.mark_island_faces(face_zone_name_pattern="cold*", island_face_count=5)
- class mark_multi_faces(service, rules, query, path=None)#
Bases:
PyQuery
Mark multi-connected faces on the face zones specified based on fringe length (fringe_length).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_multi_faces(face_zone_id_list=[30, 31, 32], fringe_length=5) >>> meshing_session.meshing_utilities.mark_multi_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], fringe_length=5) >>> meshing_session.meshing_utilities.mark_multi_faces(face_zone_name_pattern="cold*", fringe_length=5)
- class mark_point_contacts(service, rules, query, path=None)#
Bases:
PyQuery
Mark point contact locations on the face zones specified.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_point_contacts(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.mark_point_contacts(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.mark_point_contacts(face_zone_name_pattern="cold*")
- class mark_self_intersecting_faces(service, rules, query, path=None)#
Bases:
PyQuery
Mark self-intersecting faces on the face zones specified.
Specify whether to mark folded faces or not (mark_folded set to True or False).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_self_intersecting_faces(face_zone_id_list=[30, 31, 32], mark_folded=True) >>> meshing_session.meshing_utilities.mark_self_intersecting_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], mark_folded=True) >>> meshing_session.meshing_utilities.mark_self_intersecting_faces(face_zone_name_pattern="cold*", mark_folded=True)
- class mark_sliver_faces(service, rules, query, path=None)#
Bases:
PyQuery
Mark sliver faces on the face zones specified, based on the maximum height (max_height) and skewness limit (skew_limit).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_sliver_faces(face_zone_id_list=[30, 31, 32], max_height=2, skew_limit=0.2) >>> meshing_session.meshing_utilities.mark_sliver_faces(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], max_height=2, skew_limit=0.2) >>> meshing_session.meshing_utilities.mark_sliver_faces(face_zone_name_pattern="cold*", max_height=2, skew_limit=0.2)
- class mark_spikes(service, rules, query, path=None)#
Bases:
PyQuery
Mark spikes on the face zones specified, based on the spike angle (spike_angle).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_spikes(face_zone_id_list=[30, 31, 32], spike_angle=40.5) >>> meshing_session.meshing_utilities.mark_spikes(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], spike_angle=40.5) >>> meshing_session.meshing_utilities.mark_spikes(face_zone_name_pattern="cold*", spike_angle=40.5)
- class mark_steps(service, rules, query, path=None)#
Bases:
PyQuery
Mark steps on the face zones specified, based on the step angle (step_angle) and step width (step_width).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.mark_steps(face_zone_id_list=[30, 31, 32], step_angle=40.5, step_width=3.3) >>> meshing_session.meshing_utilities.mark_steps(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], step_angle=40.5, step_width=3.3) >>> meshing_session.meshing_utilities.mark_steps(face_zone_name_pattern="cold*", step_angle=40.5, step_width=3.3)
- class merge_cell_zones(service, rules, command, path=None)#
Bases:
PyCommand
Merges the specified cell zones.
Specify a list of cell zones or name pattern.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.merge_cell_zones(cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.merge_cell_zones(cell_zone_name_list=["elbow-fluid"]) >>> meshing_session.meshing_utilities.merge_cell_zones(cell_zone_name_pattern="*")
- class merge_cell_zones_with_same_prefix(service, rules, command, path=None)#
Bases:
PyCommand
Merge cell zones containing the specified prefix.
Examples
>>> meshing_session.meshing_utilities.merge_cell_zones_with_same_prefix(prefix="elbow")
- class merge_cell_zones_with_same_suffix(service, rules, command, path=None)#
Bases:
PyCommand
Merge cell zones containing the specified suffix.
Examples
>>> meshing_session.meshing_utilities.merge_cell_zones_with_same_suffix(suffix="fluid")
- class merge_face_zones(service, rules, command, path=None)#
Bases:
PyCommand
Merges the specified face zones.
Specify a list of zone IDs or name pattern.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.merge_face_zones(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.merge_face_zones(face_zone_name_pattern="wall*")
- class merge_face_zones_of_type(service, rules, command, path=None)#
Bases:
PyCommand
Merges face zones of a given type based on name pattern.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.merge_face_zones_of_type(face_zone_type="velocity-inlet", face_zone_name_pattern="*")
- class merge_face_zones_with_same_prefix(service, rules, command, path=None)#
Bases:
PyCommand
Merge face zones containing the specified prefix.
Examples
>>> meshing_session.meshing_utilities.merge_face_zones_with_same_prefix(prefix="elbow")
- class mesh_check(service, rules, query, path=None)#
Bases:
PyQuery
Reports the selected mesh check statistics for the zones specified.
Specify the ‘type_name’ as one of the ‘bounding-box-statistics’, ‘volume-statistics’, ‘face-area-statistics’, ‘nodes-per-edge’, ‘nodes-per-face’, ‘nodes-per-cell’, ‘faces-or-neighbors-per-cell’, ‘cell-faces-or-neighbors’, ‘isolated-cells’, ‘face-handedness’, ‘periodic-face-pairs’, ‘face-children’, ‘zone-boundary-conditions’, ‘invalid-node-coordinates’, ‘poly-cells’, ‘parallel-invalid-zones’, ‘parallel-invalid-neighborhood’, ‘parallel-invalid-interfaces’ value.
- Parameters:
- type_name
str
Type name.
- edge_zone_id_list
list
[int
] List containing the edge zone IDs.
- edge_zone_name_list
list
[str
] List containing the edge zone names.
- edge_zone_name_pattern
str
Edge zone name pattern.
- face_zone_id_list
list
[int
] List containing the face zone IDs.
- face_zone_name_list
list
[str
] List containing the face zone names.
- face_zone_name_pattern
str
Face zone name pattern.
- cell_zone_id_list
list
[int
] List containing the cell zone IDs.
- cell_zone_name_list
list
[str
] List containing the cell zone names.
- cell_zone_name_pattern
str
Cell zone name pattern.
- type_name
- Returns:
Examples
>>> meshing_session.meshing_utilities.mesh_check(type_name="face-children", edge_zone_id_list=[22, 23], face_zone_id_list=[30, 31, 32], cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.mesh_check(type_name="nodes-per-cell", edge_zone_name_pattern="cold-inlet*", face_zone_id_list=[30, 31, 32], cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.mesh_check(type_name="volume-statistics", edge_zone_id_list=[22, 23], face_zone_name_pattern="*", cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.mesh_check(type_name="nodes-per-cell", edge_zone_name_pattern="cold-inlet*", face_zone_name_pattern="*", cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.mesh_check(type_name="face-children", edge_zone_id_list=[22, 23], face_zone_id_list=[30, 31, 32], cell_zone_name_pattern="*") >>> meshing_session.meshing_utilities.mesh_check(type_name="volume-statistics", edge_zone_name_pattern="cold-inlet*", face_zone_name_pattern="*", cell_zone_name_pattern="*")
- class mesh_exists(service, rules, query, path=None)#
Bases:
PyQuery
Report if the volume mesh exists.
- Returns:
Examples
>>> meshing_session.meshing_utilities.mesh_exists()
- class print_worst_quality_cell(service, rules, query, path=None)#
Bases:
PyQuery
Report the worst quality cell (ID and location) for the cell zones based on the measure specified.
Specify the ‘measure’ as one of the ‘Orthogonal Quality’, ‘Skewness’, ‘Equiangle Skewness’, ‘Size Change’, ‘Edge Ratio’, ‘Size’, ‘Aspect Ratio’, ‘Squish’, ‘Warp’, ‘Dihedral Angle’, ‘ICEMCFD Quality’, ‘Ortho Skew’, ‘FLUENT Aspect Ratio’, ‘Inverse Orthogonal Quality’ value.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.print_worst_quality_cell(cell_zone_id_list=[87], measure="Orthogonal Quality") >>> meshing_session.meshing_utilities.print_worst_quality_cell(cell_zone_name_list=["elbow-fluid"], measure="Orthogonal Quality") >>> meshing_session.meshing_utilities.print_worst_quality_cell(cell_zone_name_pattern="*", measure="Orthogonal Quality")
- class project_zone_on_plane(service, rules, query, path=None)#
Bases:
PyQuery
Project a zone on the plane specified.
Specify three points for defining the plane.
Examples
>>> meshing_session.meshing_utilities.project_zone_on_plane(zone_id=87, plane=[[1, 0, 0], [0, 1, 0], [0, 0, 1]])
- class refine_marked_faces_in_zones(service, rules, query, path=None)#
Bases:
PyQuery
Refine marked faces.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.refine_marked_faces_in_zones(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.refine_marked_faces_in_zones(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.refine_marked_faces_in_zones(face_zone_name_pattern="cold*")
- class remove_id_suffix_from_face_zones(service, rules, command, path=None)#
Bases:
PyCommand
Removes the ID suffix from face zone names.
- Returns:
Examples
>>> meshing_session.meshing_utilities.remove_id_suffix_from_face_zones()
- class remove_ids_from_zone_names(service, rules, command, path=None)#
Bases:
PyCommand
Remove the zone ID from zone ID list.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.remove_ids_from_zone_names(zone_id_list=[30, 31, 32])
- class remove_labels_on_cell_zones(service, rules, command, path=None)#
Bases:
PyCommand
Removes the specified labels from the cell zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.remove_labels_on_cell_zones(cell_zone_name_list=["elbow-fluid"], label_name_list=["elbow-1"]) >>> meshing_session.meshing_utilities.remove_labels_on_cell_zones(cell_zone_id_list=[87], label_name_list=["87-1"]) >>> meshing_session.meshing_utilities.remove_labels_on_cell_zones(cell_zone_name_pattern="*", label_name_list=["cell-1"])
- class remove_labels_on_edge_zones(service, rules, command, path=None)#
Bases:
PyCommand
Removes the specified labels from the edge zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.remove_labels_on_edge_zones(edge_zone_name_list=["symmetry:xyplane:hot-inlet:elbow-fluid:feature.20"], label_name_list=["20-1"]) >>> meshing_session.meshing_utilities.remove_labels_on_edge_zones(edge_zone_id_list=[22], label_name_list=["22-1"]) >>> meshing_session.meshing_utilities.remove_labels_on_edge_zones(edge_zone_name_pattern="*", label_name_list=["26-1"])
- class remove_labels_on_face_zones(service, rules, command, path=None)#
Bases:
PyCommand
Removes the specified labels from the face zones.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.remove_labels_on_face_zones(face_zone_name_list=["wall-inlet"], label_name_list=["wall-inlet-1"]) >>> meshing_session.meshing_utilities.remove_labels_on_face_zones(face_zone_id_list=[30], label_name_list=["hot-inlet-1"]) >>> meshing_session.meshing_utilities.remove_labels_on_face_zones(face_zone_name_pattern="*", label_name_list=["wall-elbow-1"])
- class rename_edge_zone(service, rules, command, path=None)#
Bases:
PyCommand
Renames an existing edge zone.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.rename_edge_zone(zone_id=20, new_name="symmetry:xyplane:hot-inlet:elbow-fluid:feature.20-new")
- class rename_face_zone(service, rules, command, path=None)#
Bases:
PyCommand
Renames an existing face zone.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.rename_face_zone(zone_name="symmetry:xyplane:hot-inlet:elbow-fluid:feature.20-new", new_name="symmetry:xyplane:hot-inlet:elbow-fluid:feature.20") >>> meshing_session.meshing_utilities.rename_face_zone(zone_id=32, new_name="outlet-32") >>> meshing_session.meshing_utilities.rename_face_zone(zone_name="outlet-32", new_name="outlet")
- class rename_face_zone_label(service, rules, command, path=None)#
Bases:
PyCommand
Renames the face zone label.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.rename_face_zone_label(object_name="elbow-fluid-1", old_label_name="outlet", new_label_name="outlet-new")
- class rename_object(service, rules, command, path=None)#
Bases:
PyCommand
Renames the object.
Examples
>>> meshing_session.meshing_utilities.rename_object(old_object_name="elbow-fluid", new_object_name="elbow-fluid-1")
- class renumber_zone_ids(service, rules, command, path=None)#
Bases:
PyCommand
Renumber zone IDs starting from the number specified (start_number).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.renumber_zone_ids(zone_id_list=[30, 31, 32], start_number=1)
- class replace_cell_zone_suffix(service, rules, command, path=None)#
Bases:
PyCommand
Replace the cell zone suffix to rename cell zones.
Specify whether to merge the cell zones being renamed (set merge to True or False).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.replace_cell_zone_suffix(cell_zone_id_list=[87], old_suffix="fluid", new_suffix="fluid-new", merge=True) >>> meshing_session.meshing_utilities.replace_cell_zone_suffix(cell_zone_name_list=["elbow-fluid-new"], old_suffix="fluid", new_suffix="fluid-new", merge=True)
- class replace_edge_zone_suffix(service, rules, command, path=None)#
Bases:
PyCommand
Replace the edge zone suffix to rename edge zones.
Specify whether to merge the edge zones being renamed (set merge to True or False).
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.replace_edge_zone_suffix(edge_zone_id_list=[20], old_suffix="fluid", new_suffix="fluid-new", merge=True) >>> meshing_session.meshing_utilities.replace_edge_zone_suffix(edge_zone_name_list=["hot-inlet:wall-inlet:elbow-fluid:feature.21"], old_suffix="fluid", new_suffix="fluid-new", merge=True)
- class replace_face_zone_suffix(service, rules, command, path=None)#
Bases:
PyCommand
Replace the face zone suffix to rename face zones.
Specify whether to merge the face zones being renamed (set merge to True or False).
Note - If an empty string is specified for the separator (’ ‘), the string specified for replace with will be appended to the face zone names.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.replace_face_zone_suffix(face_zone_id_list=[30, 31, 32], separator="-suffix-", replace_with="-with-", merge=False) >>> meshing_session.meshing_utilities.replace_face_zone_suffix(face_zone_name_list=["cold-inlet", "hot-inlet"], separator="-suffix-", replace_with="-with-", merge=False)
- class replace_label_suffix(service, rules, command, path=None)#
Bases:
PyCommand
Rename labels by replacing the label suffix with a new suffix.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.replace_label_suffix(object_name_list=["elbow-fluid-1"], separator="-", new_suffix="fluid-new")
- class replace_object_suffix(service, rules, command, path=None)#
Bases:
PyCommand
Rename objects by replacing the object suffix with a new suffix.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.replace_object_suffix(object_name_list=["elbow-fluid"], separator="-", new_suffix="fluid-new")
- class scale_cell_zones_around_pivot(service, rules, query, path=None)#
Bases:
PyQuery
Enables you to scale the cell zones around a pivot point or the bounding box center.
Specify the cell zones, the scale factors in the X, Y, Z directions (scale), the pivot point (pivot), and choose whether to use the bounding box center (use_bbox_center set to True or False).
- Parameters:
- cell_zone_id_list
list
[int
] List containing the cell zone IDs.
- cell_zone_name_list
list
[str
] List containing the cell zone names.
- cell_zone_name_pattern
str
Cell zone name pattern.
- scale
list
[float
] Scale factors in the X, Y, Z directions.
- pivot
list
[float
] Pivot point.
- use_bbox_centerbool
Specify whether to use the bounding box center.
- cell_zone_id_list
- Returns:
Examples
>>> meshing_session.meshing_utilities.scale_cell_zones_around_pivot(cell_zone_id_list=[87], scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True) >>> meshing_session.meshing_utilities.scale_cell_zones_around_pivot(cell_zone_name_list=["elbow-fluid"], scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True) >>> meshing_session.meshing_utilities.scale_cell_zones_around_pivot(cell_zone_name_pattern="*", scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True)
- class scale_face_zones_around_pivot(service, rules, query, path=None)#
Bases:
PyQuery
Enables you to scale the face zones around a pivot point or the bounding box center.
Specify the face zones, the scale factors in the X, Y, Z directions (scale), the pivot point (pivot), and choose whether to use the bounding box center (use_bbox_center set to True or False).
- Parameters:
- face_zone_id_list
list
[int
] List containing the face zone IDs.
- face_zone_name_list
list
[str
] List containing the face zone names.
- face_zone_name_pattern
str
Face zone name pattern.
- scale
list
[float
] Scale factors in the X, Y, Z directions.
- pivot
list
[float
] Pivot point.
- use_bbox_centerbool
Specify whether to use the bounding box center.
- face_zone_id_list
- Returns:
Examples
>>> meshing_session.meshing_utilities.scale_face_zones_around_pivot(face_zone_id_list=[30, 31, 32], scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True) >>> meshing_session.meshing_utilities.scale_face_zones_around_pivot(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True) >>> meshing_session.meshing_utilities.scale_face_zones_around_pivot(face_zone_name_pattern="*", scale=[1.1, 1.2, 1.3], pivot=[1.1482939720153809, -2.2965879440307617, 0.7345014897547645], use_bbox_center=True)
- class separate_cell_zone_layers_by_face_zone_using_id(service, rules, query, path=None)#
Bases:
PyQuery
Separates cells that are connected to specified face zones into another cell zone.
This separation method applies only to prism cells.
Specify the number of layers of cells (nlayers) to be separated.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_id(cell_zone_id=87, face_zone_id_list=[30, 31, 32], nlayers=2) >>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_id(cell_zone_id=87, face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], nlayers=2) >>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_id(cell_zone_id=87, face_zone_name_pattern="*", nlayers=2)
- class separate_cell_zone_layers_by_face_zone_using_name(service, rules, query, path=None)#
Bases:
PyQuery
Separates cells that are connected to specified face zones into another cell zone.
This separation method applies only to prism cells.
Specify the number of layers of cells (nlayers) to be separated.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_name(cell_zone_name="elbow-fluid", face_zone_id_list=[30, 31, 32], nlayers=2) >>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_name(cell_zone_name="elbow-fluid", face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"], nlayers=2) >>> meshing_session.meshing_utilities.separate_cell_zone_layers_by_face_zone_using_name(cell_zone_name="elbow-fluid", face_zone_name_pattern="*", nlayers=2)
- class separate_face_zones_by_cell_neighbor(service, rules, query, path=None)#
Bases:
PyQuery
Separate face zones based on the cell neighbors.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.separate_face_zones_by_cell_neighbor(face_zone_id_list=[30, 31, 32]) >>> meshing_session.meshing_utilities.separate_face_zones_by_cell_neighbor(face_zone_name_list=["cold-inlet", "hot-inlet", "outlet"]) >>> meshing_session.meshing_utilities.separate_face_zones_by_cell_neighbor(face_zone_name_pattern="cold*")
- class set_number_of_parallel_compute_threads(service, rules, command, path=None)#
Bases:
PyCommand
Set the number of compute threads to use for algorithms like mesh check and quality computation.
You can use a variable number of compute threads for these algorithms depending on the current machine loads.
The number of compute threads is between 2 and the value (maximum-cores-available - 1).
Examples
>>> meshing_session.meshing_utilities.set_number_of_parallel_compute_threads(nthreads=2)
- class set_object_cell_zone_type(service, rules, command, path=None)#
Bases:
PyCommand
Set object cell zone type.
Examples
>>> meshing_session.meshing_utilities.set_object_cell_zone_type(object_name="elbow-fluid", cell_zone_type="mixed")
- class set_quality_measure(service, rules, command, path=None)#
Bases:
PyCommand
Set the quality measure.
Specify the ‘measure’ as one of the ‘Orthogonal Quality’, ‘Skewness’, ‘Equiangle Skewness’, ‘Size Change’, ‘Edge Ratio’, ‘Size’, ‘Aspect Ratio’, ‘Squish’, ‘Warp’, ‘Dihedral Angle’, ‘ICEMCFD Quality’, ‘Ortho Skew’, ‘FLUENT Aspect Ratio’, ‘Inverse Orthogonal Quality’ value.
Examples
>>> meshing_session.meshing_utilities.set_quality_measure(measure="Aspect Ratio")
- class unpreserve_cell_zones(service, rules, query, path=None)#
Bases:
PyQuery
Enables you to unpreserve some/all preserved cell zones during the meshing process.
- Parameters:
- Returns:
Examples
>>> meshing_session.meshing_utilities.unpreserve_cell_zones(cell_zone_id_list=[87]) >>> meshing_session.meshing_utilities.unpreserve_cell_zones(cell_zone_name_list=["elbow-fluid"]) >>> meshing_session.meshing_utilities.unpreserve_cell_zones(cell_zone_name_pattern="*")