meshing.tui#

class ansys.fluent.core.meshing.tui_231.main_menu(path, service)#

Bases: TUIMenu

Fluent meshing main menu.

Methods:

`beta_feature_access`(args, *kwargs)	Enable access to beta features in the interface.
`close_fluent`(args, *kwargs)	(ANSYS Fluent in Workbench only) Exits program.
`exit`(args, *kwargs)	Exits the program.
`print_license_usage`(args, *kwargs)	Print license usage information.
`switch_to_solution_mode`(args, *kwargs)	Enables you to transfer the mesh data from meshing mode to solution mode in ANSYS Fluent.

Classes:

`boundary`(path, service)	Enter the boundary menu.
`cad_assemblies`(path, service)	Menu for cad assemblies.
`diagnostics`(path, service)	Diagnostic tools.
`display`(path, service)	Enter the display menu.
`file`(path, service)	Enter the file menu.
`material_point`(path, service)	Manage material points.
`mesh`(path, service)	Enter the grid menu.
`objects`(path, service)	Manage objects.
`openmp_controls`(path, service)	Enter the openmp menu.
`parallel`(path, service)	Enter the parallel menu.
`preferences`(path, service)	Set preferences.
`reference_frames`(path, service)	Manage reference frames.
`report`(path, service)	Enter the report menu.
`scoped_sizing`(path, service)	Manage scoped sizing.
`size_functions`(path, service)	Manage advanced size functions.

beta_feature_access(*args, **kwargs)#: Enable access to beta features in the interface.

class boundary(path, service)#

Bases: TUIMenu

Enter the boundary menu.

Methods:

`auto_slit_faces`(args, *kwargs)	Slits all boundary faces with cells on both sides (these cells must be in the same cell zone).
`check_boundary_mesh`(args, *kwargs)	Reports the number of Delaunay violations on the triangular surface mesh and the number of isolated nodes.
`check_duplicate_geom`(args, *kwargs)	Displays the names of the duplicate surfaces and prints maximum and average distance between them.
`clear_marked_faces`(args, *kwargs)	Clears marked faces.
`clear_marked_nodes`(args, *kwargs)	Clears nodes that were marked using the mark-duplicate-nodes command.
`coarsen_boundary_faces`(args, *kwargs)	Coarsen boundary face zones.
`compute_bounding_box`(args, *kwargs)	Computes the bounding box for the zones specified.
`count_free_nodes`(args, *kwargs)	Reports the number of boundary nodes associated with edges having only one attached face.
`count_marked_faces`(args, *kwargs)	Reports the number of marked faces.
`count_unused_bound_node`(args, *kwargs)	Counts the unused boundary nodes in the domain.
`count_unused_faces`(args, *kwargs)	Lists the number of boundary faces that are not used by any cell.
`count_unused_nodes`(args, *kwargs)	Lists the number of boundary nodes that are not used by any cell.
`create_bounding_box`(args, *kwargs)	Creates the bounding box for the specified zones.
`create_cylinder`(args, *kwargs)	Creates a cylinder by specifying the axis, radius, and edge length or three arc nodes, the axial delta, the radial gap, and the edge length.
`create_plane_surface`(args, *kwargs)	Creates a plane surface by specifying either the axis direction, axial location, and the extents of the surface or three points defining the plane.
`create_revolved_surface`(args, *kwargs)	Creates a revolved surface by rotating the specified edge through the angle specified.
`create_swept_surface`(args, *kwargs)	Creates a surface by sweeping the specified edge in the direction specified.
`delete_all_dup_faces`(args, *kwargs)	Searches for faces on all boundary zones that have the same nodes and deletes the duplicates.
`delete_duplicate_faces`(args, *kwargs)	Searches for faces on a specified zone that have the same nodes and deletes the duplicates.
`delete_free_edge_faces`(args, *kwargs)	Enables you to remove faces with the specified number of free edges from the specified boundary zones.
`delete_island_faces`(args, *kwargs)	Enables you to delete faces in a non-contiguous region of a face zone.
`delete_unconnected_faces`(args, *kwargs)	Enables you to delete the unconnected face-zones.
`delete_unused_faces`(args, *kwargs)	Deletes all the boundary faces that are not used by any cell.
`delete_unused_nodes`(args, *kwargs)	Deletes the boundary nodes that are not used by any boundary faces.
`edge_limits`(args, *kwargs)	Prints the length of the shortest and longest edges on the boundary.
`expand_marked_faces_by_rings`(args, *kwargs)	Mark rings of faces around marked faces.
`face_distribution`(args, *kwargs)	Reports the distribution of face quality in the text window.
`face_skewness`(args, *kwargs)	Lists the worst face skewness.
`fix_mconnected_edges`(args, *kwargs)	Resolves multi-connected edges/non-manifold configurations in the boundary mesh by deleting fringes and overlaps based on threshold values specified.
`improve_surface_mesh`(args, *kwargs)	Improve surface mesh by swapping face edges where Delaunay violations occur.
`jiggle_boundary_nodes`(args, *kwargs)	Randomly perturbs all boundary nodes based on an input tolerance.
`make_periodic`(args, *kwargs)	Enables you to make the specified boundaries periodic.
`mark_bad_quality_faces`(args, *kwargs)	Mark Bad Quality Faces.
`mark_duplicate_nodes`(args, *kwargs)	Marks duplicate nodes.
`mark_face_intersection`(args, *kwargs)	Marks intersecting faces.
`mark_face_proximity`(args, *kwargs)	Marks faces that are in proximity to each other.
`mark_faces_in_region`(args, *kwargs)	Marks the faces that are contained in a specified local refinement region.
`merge_nodes`(args, *kwargs)	Merges duplicate nodes.
`merge_small_face_zones`(args, *kwargs)	Merges the face zones having area less than the minimum area.
`orient_faces_by_point`(args, *kwargs)	Orients the normals based on the specified material point.
`print_info`(args, *kwargs)	Prints information about the grid in the text window.
`project_face_zone`(args, *kwargs)	Projects nodes on a selected face zone onto a target face zone.
`recover_periodic_surfaces`(args, *kwargs)	Restores the periodic relationship between face zones.
`reset_element_type`(args, *kwargs)	Resets the element type (mixed, tri, or quad) of a boundary zone.
`resolve_face_intersection`(args, *kwargs)	Resolves self intersection on manifold surface meshes.
`scale_nodes`(args, *kwargs)	Applies a scaling factor to all node coordinates.
`set_periodicity`(args, *kwargs)	Defines the periodicity parameters.
`slit_boundary_face`(args, *kwargs)	Slits a boundary face zone by duplicating all faces and nodes, except those nodes that are located at the edges of the boundary zone.
`smooth_marked_faces`(args, *kwargs)	Smooths the marked faces.
`unmark_faces_in_zones`(args, *kwargs)	Unmark faces in zones.
`unmark_selected_faces`(args, *kwargs)	Unmarks the marked selected faces.
`wrapper`(args, *kwargs)	Enters the surface wrapper menu.

Classes:

`boundary_conditions`(path, service)	Contains options for copying or clearing boundary conditions when a case file is read.
`feature`(path, service)	Enables you to create and modify features.
`improve`(path, service)	Enables you to improve boundary surfaces.
`manage`(path, service)	Contains options for manipulating the boundary zones.
`modify`(path, service)	Contains commands used to modify the boundary mesh.
`refine`(path, service)	Discusses the commands used to refine the boundary mesh.
`remesh`(path, service)	Has a set of commands for remeshing the face zones.
`separate`(path, service)	Contains options for separating face zones.
`shell_boundary_layer`(path, service)	Enter the shell boundary layer menu.

auto_slit_faces(*args, **kwargs)#: Slits all boundary faces with cells on both sides (these cells must be in the same cell zone). A displacement can be specified to provide thickness to the boundary.

class boundary_conditions(path, service)#

Bases: TUIMenu

Contains options for copying or clearing boundary conditions when a case file is read.

Methods:

`clear`(args, *kwargs)	Clears the boundary conditions assigned to the specified face zones.
`clear_all`(args, *kwargs)	Clears the boundary conditions assigned to all the face zones.
`copy`(args, *kwargs)	Enables you to copy the boundary conditions from the face zone selected to the face zones specified.

clear(*args, **kwargs)#: Clears the boundary conditions assigned to the specified face zones.

clear_all(*args, **kwargs)#: Clears the boundary conditions assigned to all the face zones.

copy(*args, **kwargs)#: Enables you to copy the boundary conditions from the face zone selected to the face zones specified.

check_boundary_mesh(*args, **kwargs)#: Reports the number of Delaunay violations on the triangular surface mesh and the number of isolated nodes.

check_duplicate_geom(*args, **kwargs)#: Displays the names of the duplicate surfaces and prints maximum and average distance between them.

clear_marked_faces(*args, **kwargs)#: Clears marked faces.

clear_marked_nodes(*args, **kwargs)#: Clears nodes that were marked using the mark-duplicate-nodes command.

coarsen_boundary_faces(*args, **kwargs)#: Coarsen boundary face zones.

compute_bounding_box(*args, **kwargs)#: Computes the bounding box for the zones specified.

count_free_nodes(*args, **kwargs)#: Reports the number of boundary nodes associated with edges having only one attached face.

count_marked_faces(*args, **kwargs)#: Reports the number of marked faces.

count_unused_bound_node(*args, **kwargs)#: Counts the unused boundary nodes in the domain.

count_unused_faces(*args, **kwargs)#: Lists the number of boundary faces that are not used by any cell.

count_unused_nodes(*args, **kwargs)#: Lists the number of boundary nodes that are not used by any cell.

create_bounding_box(*args, **kwargs)#: Creates the bounding box for the specified zones. You can specify the zone type, name, edge length, and the extents of the box, as required. You can also optionally create a geometry object from the bounding box created.

create_cylinder(*args, **kwargs)#: Creates a cylinder by specifying the axis, radius, and edge length or three arc nodes, the axial delta, the radial gap, and the edge length. You can also specify the prefix for the zone being created, as required. You can also optionally create a geometry object from the cylinder created.

create_plane_surface(*args, **kwargs)#: Creates a plane surface by specifying either the axis direction, axial location, and the extents of the surface or three points defining the plane. You can also optionally create a geometry object from the plane surface created.

create_revolved_surface(*args, **kwargs)#: Creates a revolved surface by rotating the specified edge through the angle specified. Specify the number of segments, scale factor, and the pivot point and axis of rotation. You can also optionally create a geometry object from the revolved surface created.

create_swept_surface(*args, **kwargs)#: Creates a surface by sweeping the specified edge in the direction specified. You need to specify the distance to sweep through and the number of offsets, as required. You can also optionally create a geometry object from the swept surface created.

delete_all_dup_faces(*args, **kwargs)#: Searches for faces on all boundary zones that have the same nodes and deletes the duplicates.

delete_duplicate_faces(*args, **kwargs)#: Searches for faces on a specified zone that have the same nodes and deletes the duplicates. Duplicate faces may be present if you generated the boundary mesh using a third-party grid generator, or if you have used the slit-boundary-face command to modify the boundary mesh and then merged the nodes.

delete_free_edge_faces(*args, **kwargs)#: Enables you to remove faces with the specified number of free edges from the specified boundary zones.

delete_island_faces(*args, **kwargs)#: Enables you to delete faces in a non-contiguous region of a face zone.

delete_unconnected_faces(*args, **kwargs)#: Enables you to delete the unconnected face-zones.

delete_unused_faces(*args, **kwargs)#: Deletes all the boundary faces that are not used by any cell.

delete_unused_nodes(*args, **kwargs)#: Deletes the boundary nodes that are not used by any boundary faces.

edge_limits(*args, **kwargs)#: Prints the length of the shortest and longest edges on the boundary. This information is useful for setting initial mesh parameters and refinement controls.

expand_marked_faces_by_rings(*args, **kwargs)#: Mark rings of faces around marked faces.

face_distribution(*args, **kwargs)#: Reports the distribution of face quality in the text window.

face_skewness(*args, **kwargs)#: Lists the worst face skewness.

class feature(path, service)#

Bases: TUIMenu

Enables you to create and modify features.

Methods:

`copy_edge_zones`(args, *kwargs)	Copies the specified edge zone(s) to new edge zone(s).
`create_edge_zones`(args, *kwargs)	Extracts edge loops for the specified face zone(s) based on the feature method specified.
`delete_degenerated_edges`(args, *kwargs)	Deletes degenerated edges (edges where the two end nodes are the same) for the edge zone(s) specified.
`delete_edge_zones`(args, *kwargs)	Deletes the specified edge zone(s).
`edge_size_limits`(args, *kwargs)	Reports the minimum, maximum, and average edge length for the specified edge zone(s) in the console.
`group`(args, *kwargs)	Associates the specified edge zone(s) with the specified face zone.
`intersect_edge_zones`(args, *kwargs)	Intersects the specified edge loops to create a new edge loop comprising the common edges.
`list_edge_zones`(args, *kwargs)	Lists the name, ID, type, and count for the specified edge zone(s).
`merge_edge_zones`(args, *kwargs)	Merges multiple edge loops of the same type into a single loop.
`orient_edge_direction`(args, *kwargs)	Orients the edges on the loop to point in the same direction.
`project_edge_zones`(args, *kwargs)	Projects the edges of the specified loop onto the specified face zone using the specified projection method.
`remesh_edge_zones`(args, *kwargs)	Remeshes the specified edge loop(s), modifying the node distribution according to the specified remeshing method, spacing values, and feature angle.
`reverse_edge_direction`(args, *kwargs)	Reverses the direction of the edge loop.
`separate_delete_small_edges`(args, *kwargs)	Separates the edge zones based on the feature angle specified, and then deletes the edges having a count smaller than the minimum count specified.
`separate_edge_zones`(args, *kwargs)	Separates the specified edge loop based on connectivity and the specified feature angle.
`separate_edge_zones_by_seed`(args, *kwargs)	Separates the edge loop based on the seed edge specified.
`toggle_edge_type`(args, *kwargs)	Toggles the edge type between boundary and interior.
`ungroup`(args, *kwargs)	Ungroups previously grouped edge zones.

copy_edge_zones(*args, **kwargs)#: Copies the specified edge zone(s) to new edge zone(s).

create_edge_zones(*args, **kwargs)#: Extracts edge loops for the specified face zone(s) based on the feature method specified. You also need to specify an appropriate value for feature angle when using the fixed-angle method. The Face Seed approach cannot be used when creating edge loops using text commands.

delete_degenerated_edges(*args, **kwargs)#: Deletes degenerated edges (edges where the two end nodes are the same) for the edge zone(s) specified.

delete_edge_zones(*args, **kwargs)#: Deletes the specified edge zone(s).

edge_size_limits(*args, **kwargs)#: Reports the minimum, maximum, and average edge length for the specified edge zone(s) in the console.

group(*args, **kwargs)#: Associates the specified edge zone(s) with the specified face zone.

intersect_edge_zones(*args, **kwargs)#: Intersects the specified edge loops to create a new edge loop comprising the common edges. You can enable automatic deleting of overlapped edges and specify an appropriate intersection tolerance.

list_edge_zones(*args, **kwargs)#: Lists the name, ID, type, and count for the specified edge zone(s).

merge_edge_zones(*args, **kwargs)#: Merges multiple edge loops of the same type into a single loop.

orient_edge_direction(*args, **kwargs)#: Orients the edges on the loop to point in the same direction.

project_edge_zones(*args, **kwargs)#: Projects the edges of the specified loop onto the specified face zone using the specified projection method.

remesh_edge_zones(*args, **kwargs)#: Remeshes the specified edge loop(s), modifying the node distribution according to the specified remeshing method, spacing values, and feature angle. You can also enable quadratic reconstruction, if required.

reverse_edge_direction(*args, **kwargs)#: Reverses the direction of the edge loop.

separate_delete_small_edges(*args, **kwargs)#: Separates the edge zones based on the feature angle specified, and then deletes the edges having a count smaller than the minimum count specified.

separate_edge_zones(*args, **kwargs)#: Separates the specified edge loop based on connectivity and the specified feature angle.

separate_edge_zones_by_seed(*args, **kwargs)#: Separates the edge loop based on the seed edge specified. The edge zone separation angle is used to separate the edge zone (default 40).

toggle_edge_type(*args, **kwargs)#: Toggles the edge type between boundary and interior.

ungroup(*args, **kwargs)#: Ungroups previously grouped edge zones.

fix_mconnected_edges(*args, **kwargs)#: Resolves multi-connected edges/non-manifold configurations in the boundary mesh by deleting fringes and overlaps based on threshold values specified.

class improve(path, service)#

Bases: TUIMenu

Enables you to improve boundary surfaces.

Methods:

`collapse_bad_faces`(args, *kwargs)	Enables you to collapse the short edge of faces having a high aspect ratio or skewness in the specified face zone(s).
`degree_swap`(args, *kwargs)	Enables you to improve the boundary mesh by swapping edges based on a node degree value other than 6.
`improve`(args, *kwargs)	Enables you to improve the boundary surface quality using skewness, size change, aspect ratio, or area as the quality measure.
`smooth`(args, *kwargs)	Enables you to improve the boundary surface using smoothing.
`swap`(args, *kwargs)	Enables you to improve the boundary surface using edge swapping.

collapse_bad_faces(*args, **kwargs)#: Enables you to collapse the short edge of faces having a high aspect ratio or skewness in the specified face zone(s).

degree_swap(*args, **kwargs)#: Enables you to improve the boundary mesh by swapping edges based on a node degree value other than 6. The node degree is defined as the number of edges connected to the node.

improve(*args, **kwargs)#: Enables you to improve the boundary surface quality using skewness, size change, aspect ratio, or area as the quality measure.

smooth(*args, **kwargs)#: Enables you to improve the boundary surface using smoothing.

swap(*args, **kwargs)#: Enables you to improve the boundary surface using edge swapping.

improve_surface_mesh(*args, **kwargs)#: Improve surface mesh by swapping face edges where Delaunay violations occur.

jiggle_boundary_nodes(*args, **kwargs)#: Randomly perturbs all boundary nodes based on an input tolerance. Some nodes will be perturbed less than the tolerance value, while others will be perturbed by half of the tolerance value in all three coordinate directions.

make_periodic(*args, **kwargs)#: Enables you to make the specified boundaries periodic. You can specify the type of periodicity (rotational or translational), the angle, pivot, and axis of rotation, for rotational periodicity or the translational shift for translational periodicity. For each of the zones specified, a corresponding periodic shadow boundary zone will be created.

class manage(path, service)#

Bases: TUIMenu

Contains options for manipulating the boundary zones.

Methods:

`auto_delete_nodes`(args, *kwargs)	Specifies whether or not unused nodes should be deleted when their face zone is deleted.
`change_prefix`(args, *kwargs)	Enables you to change the prefix for the specified face zones.
`change_suffix`(args, *kwargs)	Change the suffix for specified face zones.
`copy`(args, *kwargs)	Copies all nodes and faces of the specified face zone(s).
`create`(args, *kwargs)	Creates a new face zone.
`delete`(args, *kwargs)	Deletes the face zone.
`flip`(args, *kwargs)	Reverses the normal direction of the specified boundary zone(s).
`id`(args, *kwargs)	Specifies a new boundary zone ID.
`list`(args, *kwargs)	Prints information about all boundary zones.
`merge`(args, *kwargs)	Merges face zones.
`name`(args, *kwargs)	Gives a face zone a new name.
`orient`(args, *kwargs)	Consistently orients the faces in the specified zones.
`origin`(args, *kwargs)	Specifies a new origin for the mesh, to be used for face zone rotation and for periodic zone creation.
`remove_suffix`(args, *kwargs)	Removes the suffix (characters including and after the leftmost ":") in the face zone names.
`rotate`(args, *kwargs)	Rotates all nodes of the specified face zone(s).
`rotate_model`(args, *kwargs)	Rotates all nodes of the model through the specified angle, based on the specified point and axis of rotation.
`scale`(args, *kwargs)	Scales all nodes of the specified face zone(s).
`scale_model`(args, *kwargs)	Scales all nodes of the model by multiplying the node coordinates by the specified scale factors (x, y, z).
`translate`(args, *kwargs)	Translates all nodes of the specified face zone(s).
`translate_model`(args, *kwargs)	Translates all nodes of the model by the specified translation offsets (x, y, z).
`type`(args, *kwargs)	Changes the boundary type of the face zone.

Classes:

user_defined_groups(path, service)

Enables you to manipulate user-defined groups.

auto_delete_nodes(*args, **kwargs)#: Specifies whether or not unused nodes should be deleted when their face zone is deleted.

change_prefix(*args, **kwargs)#: Enables you to change the prefix for the specified face zones.

change_suffix(*args, **kwargs)#: Change the suffix for specified face zones.

copy(*args, **kwargs)#: Copies all nodes and faces of the specified face zone(s).

create(*args, **kwargs)#: Creates a new face zone.

delete(*args, **kwargs)#: Deletes the face zone.

flip(*args, **kwargs)#: Reverses the normal direction of the specified boundary zone(s).

id(*args, **kwargs)#: Specifies a new boundary zone ID. If there is a conflict, the change will be ignored.

list(*args, **kwargs)#: Prints information about all boundary zones.

merge(*args, **kwargs)#: Merges face zones.

name(*args, **kwargs)#: Gives a face zone a new name.

orient(*args, **kwargs)#: Consistently orients the faces in the specified zones.

origin(*args, **kwargs)#: Specifies a new origin for the mesh, to be used for face zone rotation and for periodic zone creation. The default origin is (0,0,0).

remove_suffix(*args, **kwargs)#: Removes the suffix (characters including and after the leftmost “:”) in the face zone names.

rotate(*args, **kwargs)#: Rotates all nodes of the specified face zone(s).

rotate_model(*args, **kwargs)#: Rotates all nodes of the model through the specified angle, based on the specified point and axis of rotation.

scale(*args, **kwargs)#: Scales all nodes of the specified face zone(s).

scale_model(*args, **kwargs)#: Scales all nodes of the model by multiplying the node coordinates by the specified scale factors (x, y, z).

translate(*args, **kwargs)#: Translates all nodes of the specified face zone(s).

translate_model(*args, **kwargs)#: Translates all nodes of the model by the specified translation offsets (x, y, z). The translation offsets are interpreted as absolute numbers in meshing mode. In solution mode, however, the translation offsets are assumed to be distances in the length unit set. This may lead to differences in domain extents reported after translating the mesh in the respective modes.

type(*args, **kwargs)#: Changes the boundary type of the face zone. When changing the boundary type of any zone to type interior, ensure that there is a single cell zone across the interior boundary. Retaining multiple cell zones across an interior boundary can cause undesirable results with further tet meshing or smoothing operations. Also, face zones having no/one neighboring cell zone should not be changed to type interior. The mesh check will issue a warning if multiple cell zones are maintained across an interior boundary. The boundary type in such cases should be set to internal instead.

class user_defined_groups(path, service)#

Bases: TUIMenu

Enables you to manipulate user-defined groups.

Methods:

`activate`(args, *kwargs)	Activates the specified user-defined groups.
`create`(args, *kwargs)	Creates the user-defined group comprising the specified zones.
`delete`(args, *kwargs)	Deletes the specified user-defined group.
`list`(args, *kwargs)	Lists the groups in the console.
`update`(args, *kwargs)	Enables you to modify an existing group.

activate(*args, **kwargs)#: Activates the specified user-defined groups.

create(*args, **kwargs)#: Creates the user-defined group comprising the specified zones.

delete(*args, **kwargs)#: Deletes the specified user-defined group.

list(*args, **kwargs)#: Lists the groups in the console.

update(*args, **kwargs)#: Enables you to modify an existing group.

mark_bad_quality_faces(*args, **kwargs)#: Mark Bad Quality Faces.

mark_duplicate_nodes(*args, **kwargs)#: Marks duplicate nodes. The marked nodes will appear in the grid display when nodes are displayed. For a list of duplicate nodes, set the /report/verbosity level to 2 before using the mark-duplicate-nodes command.

mark_face_intersection(*args, **kwargs)#: Marks intersecting faces. Intersection is detected if the line defined by any two consecutive nodes on a face intersects any face in the current domain. The marked faces will appear in the grid display when faces are displayed. For a list of intersecting faces, set the /report/verbosity level to 2 before using the mark-face-intersection command.

mark_face_proximity(*args, **kwargs)#: Marks faces that are in proximity to each other. Face A is considered to be in proximity to face B if any of the nodes on face A are within the calculated proximity distance from face B. The proximity distance is calculated based on the specified relative distance and the sphere radius. The sphere radius is determined by the maximum distance from the centroid of the face to its nodes. The marked faces will appear in the grid display when faces are displayed. For a list of faces in proximity to each other, set the /report/verbosity level to 2 before using the mark-face-proximity command.

mark_faces_in_region(*args, **kwargs)#: Marks the faces that are contained in a specified local refinement region.

merge_nodes(*args, **kwargs)#: Merges duplicate nodes.

merge_small_face_zones(*args, **kwargs)#: Merges the face zones having area less than the minimum area.

class modify(path, service)#

Bases: TUIMenu

Contains commands used to modify the boundary mesh.

Methods:

`analyze_bnd_connectvty`(args, *kwargs)	Finds and marks free edges and nodes and multiply-connected edges and nodes.
`auto_patch_holes`(args, *kwargs)	Patch zone(s) by filling holes.
`clear_selections`(args, *kwargs)	Clears all selections.
`clear_skew_faces`(args, *kwargs)	Clears faces that were marked using the mark-skew-face command.
`collapse`(args, *kwargs)	Collapses pairs of nodes, edge(s), or face(s).
`create`(args, *kwargs)	Creates a boundary face if the selection list contains 3 nodes and an optional zone.
`create_mid_node`(args, *kwargs)	Creates a node at the midpoint between two selected nodes.
`delete`(args, *kwargs)	Deletes all selected faces and nodes.
`delta_move`(args, *kwargs)	Moves the selected node by specified magnitude.
`deselect_last`(args, *kwargs)	Removes the last selection from the selection list.
`hole_feature_angle`(args, *kwargs)	Specifies the feature angle for consideration of holes in the geometry.
`list_selections`(args, *kwargs)	Lists all of the selected objects.
`local_remesh`(args, *kwargs)	Remeshes marked faces or faces based on selections in the graphics window.
`mark_skew_face`(args, *kwargs)	Marks faces that should be skipped when the worst skewed face is reported using the Modify Boundary dialog box.
`merge`(args, *kwargs)	Merges pairs of nodes.
`move`(args, *kwargs)	Moves the selected node to the selected position if the selection list contains a node and a position.
`next_skew`(args, *kwargs)	Finds the triangular face of nearest lower skewness value than that of the worst skewed face.
`patch_options`(args, *kwargs)	Settings for Patching zone(s) by filling holes.
`rezone`(args, *kwargs)	Moves the selected faces from their current zone into the selected zone, if the selection list contains a zone and one or more faces.
`select_entity`(args, *kwargs)	Adds a cell, face, or node to the selection list by entering the name of the entity.
`select_filter`(args, *kwargs)	Selects a filter.
`select_position`(args, *kwargs)	Adds a position to the selection list by entering the coordinates of the position.
`select_probe`(args, *kwargs)	Selects the probe function.
`select_visible_entities`(args, *kwargs)	Enables you to select only visible entities (nodes, edges, faces, zones, objects) when the box select or polygon select options are used.
`select_zone`(args, *kwargs)	Adds a zone to the selection list by entering the zone name or ID.
`show_filter`(args, *kwargs)	Shows the current filter.
`show_probe`(args, *kwargs)	Shows the current probe function.
`skew`(args, *kwargs)	Finds the face with the highest (worst) skewness, selects it in the graphics window, and reports its skewness and zone ID in the console window.
`skew_report_zone`(args, *kwargs)	Enables you to select the zone for which you want to report the skewness.
`smooth`(args, *kwargs)	Uses Laplace smoothing to modify the position of the nodes in the selection list.
`split_face`(args, *kwargs)	Splits two selected faces into four faces.
`swap`(args, *kwargs)	Swaps boundary edges (of triangular faces) if the selection list contains edges.
`undo`(args, *kwargs)	Undoes the previous operation.

analyze_bnd_connectvty(*args, **kwargs)#: Finds and marks free edges and nodes and multiply-connected edges and nodes. This process is necessary if the boundary mesh has been changed with Scheme functions.

auto_patch_holes(*args, **kwargs)#: Patch zone(s) by filling holes.

clear_selections(*args, **kwargs)#: Clears all selections.

clear_skew_faces(*args, **kwargs)#: Clears faces that were marked using the mark-skew-face command.

collapse(*args, **kwargs)#: Collapses pairs of nodes, edge(s), or face(s). If a pair of nodes is selected, both the nodes are deleted and a new node is created at the midpoint of the two nodes. If a triangular face is selected, the complete face is collapsed into a single node at the centroid of the face.

create(*args, **kwargs)#: Creates a boundary face if the selection list contains 3 nodes and an optional zone. If the selection list contains positions, then nodes are created.

create_mid_node(*args, **kwargs)#: Creates a node at the midpoint between two selected nodes.

delete(*args, **kwargs)#: Deletes all selected faces and nodes.

delta_move(*args, **kwargs)#: Moves the selected node by specified magnitude.

deselect_last(*args, **kwargs)#: Removes the last selection from the selection list.

hole_feature_angle(*args, **kwargs)#: Specifies the feature angle for consideration of holes in the geometry.

list_selections(*args, **kwargs)#: Lists all of the selected objects.

local_remesh(*args, **kwargs)#: Remeshes marked faces or faces based on selections in the graphics window. Select the faces to be remeshed and specify the sizing source (constant-size, geometry, or size-field), the number of radial layers of faces to be remeshed (rings), the feature angle to be preserved while remeshing the selected faces, and the size for constant size remeshing (if applicable).

mark_skew_face(*args, **kwargs)#: Marks faces that should be skipped when the worst skewed face is reported using the Modify Boundary dialog box. This enables you to search for the next skewed face.

merge(*args, **kwargs)#: Merges pairs of nodes. The first node selected is retained, and the second is the duplicate that is merged.

move(*args, **kwargs)#: Moves the selected node to the selected position if the selection list contains a node and a position.

next_skew(*args, **kwargs)#: Finds the triangular face of nearest lower skewness value than that of the worst skewed face. The face ID, its skewness, the longest edge ID, and the node ID opposite to the longest edge are displayed in the console.

patch_options(*args, **kwargs)#: Settings for Patching zone(s) by filling holes.

rezone(*args, **kwargs)#: Moves the selected faces from their current zone into the selected zone, if the selection list contains a zone and one or more faces.

select_entity(*args, **kwargs)#: Adds a cell, face, or node to the selection list by entering the name of the entity.

select_filter(*args, **kwargs)#: Selects a filter. The possible filters are off, cell, face, edge, node, zone, position, object, and size. If off is chosen, then when a selection is made, it is first checked to see if it is a cell, then a face, an edge, and so on. When the node filter is used, and if a cell or face is selected, the node closest to the selection point is picked. Thus, the nodes do not have to be displayed, to be picked.

select_position(*args, **kwargs)#: Adds a position to the selection list by entering the coordinates of the position.

select_probe(*args, **kwargs)#: Selects the probe function. The possible functions are:.

select_visible_entities(*args, **kwargs)#: Enables you to select only visible entities (nodes, edges, faces, zones, objects) when the box select or polygon select options are used. Ensure that the model is zoomed to an appropriate level for correct selection.

select_zone(*args, **kwargs)#: Adds a zone to the selection list by entering the zone name or ID.

show_filter(*args, **kwargs)#: Shows the current filter.

show_probe(*args, **kwargs)#: Shows the current probe function.

skew(*args, **kwargs)#: Finds the face with the highest (worst) skewness, selects it in the graphics window, and reports its skewness and zone ID in the console window.

skew_report_zone(*args, **kwargs)#: Enables you to select the zone for which you want to report the skewness. You can either specify zone name or zone ID.

smooth(*args, **kwargs)#: Uses Laplace smoothing to modify the position of the nodes in the selection list. It moves the selected node to a position computed from an average of its node neighbors. The new position is an average of the neighboring node coordinates and is not reprojected to the discrete surface.

split_face(*args, **kwargs)#: Splits two selected faces into four faces.

swap(*args, **kwargs)#: Swaps boundary edges (of triangular faces) if the selection list contains edges.

undo(*args, **kwargs)#: Undoes the previous operation. When an operation is performed, the reverse operation is stored on the undo stack. For example, a create operation places a delete on the stack, and a delete adds a create operation. The undo operation requires that the name of the object exist when the action is undone. If the name does not exist, then the undo will fail. You can undo the last few operations, but if many operations are being performed it is recommended that you also save the mesh periodically.

orient_faces_by_point(*args, **kwargs)#: Orients the normals based on the specified material point.

print_info(*args, **kwargs)#: Prints information about the grid in the text window.

project_face_zone(*args, **kwargs)#: Projects nodes on a selected face zone onto a target face zone. Projection can be performed based on normal direction, closest point, or specified direction.

recover_periodic_surfaces(*args, **kwargs)#: Restores the periodic relationship between face zones. You will be prompted for the type (rotational or translational), method (semi-automatic, automatic, or manual, depending on the periodicity type) and for face zones. Periodicity information (angle, pivot point, axis of rotation, or translational shift) are read in with the mesh file.

class refine(path, service)#

Bases: TUIMenu

Discusses the commands used to refine the boundary mesh.

Methods:

`auto_refine`(args, *kwargs)	Automatically refines a face zone based on proximity.
`clear`(args, *kwargs)	Clears all refinement marks from all boundary faces.
`count`(args, *kwargs)	Counts the number of faces marked on each boundary zone.
`limits`(args, *kwargs)	Prints a report of the minimum and maximum size of each specified zone.
`mark`(args, *kwargs)	Marks the faces for refinement.
`refine`(args, *kwargs)	Refines the marked faces.

Classes:

local_regions(path, service)

Enters the local refinement menu.

auto_refine(*args, **kwargs)#: Automatically refines a face zone based on proximity. The original face zone is treated as a background mesh. Faces are refined by multiple face splitting passes, so that no face is in close proximity to any face in the current domain.

clear(*args, **kwargs)#: Clears all refinement marks from all boundary faces.

count(*args, **kwargs)#: Counts the number of faces marked on each boundary zone.

limits(*args, **kwargs)#: Prints a report of the minimum and maximum size of each specified zone. This report will also tell you how many faces on each zone have been marked for refinement.

class local_regions(path, service)#

Bases: TUIMenu

Enters the local refinement menu.

Methods:

`define`(args, *kwargs)	Defines the refinement region according to the specified parameters.
`delete`(args, *kwargs)	Deletes the specified region.
`init`(args, *kwargs)	Creates a region encompassing the entire geometry.
`list_all_regions`(args, *kwargs)	Lists all the refinement regions in the console.

define(*args, **kwargs)#: Defines the refinement region according to the specified parameters.

delete(*args, **kwargs)#: Deletes the specified region.

init(*args, **kwargs)#: Creates a region encompassing the entire geometry.

list_all_regions(*args, **kwargs)#: Lists all the refinement regions in the console.

mark(*args, **kwargs)#: Marks the faces for refinement.

refine(*args, **kwargs)#: Refines the marked faces.

class remesh(path, service)#

Bases: TUIMenu

Has a set of commands for remeshing the face zones.

Methods:

`clear_marked_faces`(args, *kwargs)	Clears the highlighting of the triangles that are marked.
`coarsen_and_refine`(args, *kwargs)	Remeshes (coarsens/refines) the boundary face zones based on the computed size field.
`create_all_intrst_loops`(args, *kwargs)	Creates edge loop of intersection for all boundary zones in current domain.
`create_edge_loops`(args, *kwargs)	Creates edge loops for a specified face zone, based on feature angle.
`create_intersect_loop`(args, *kwargs)	Creates an interior edge loop at the intersection between two adjacent face zones.
`create_join_loop`(args, *kwargs)	Creates edge loop on boundary of the region of overlap of two surfaces.
`create_stitch_loop`(args, *kwargs)	Creates edge loops for connecting two surfaces along their free edges.
`delete_overlapped_edges`(args, *kwargs)	Deletes edges that overlap selected edge loops.
`faceted_stitch_zones`(args, *kwargs)	Performs the faceted stitching of zones.
`insert_edge_zone`(args, *kwargs)	Inserts an edge zone into a triangulated boundary face zone.
`intersect_all_face_zones`(args, *kwargs)	Remeshes all the intersecting face zones.
`intersect_face_zones`(args, *kwargs)	Remeshes two intersecting face zones so that they become conformal.
`join_all_face_zones`(args, *kwargs)	Connects all overlapping face zones using the join operation.
`join_face_zones`(args, *kwargs)	Connects two overlapping faces.
`mark_intersecting_faces`(args, *kwargs)	Highlights the triangles in the neighborhood of the line of intersection.
`mark_join_faces`(args, *kwargs)	Highlights the triangles in the neighborhood of the join edge loop.
`mark_stitch_faces`(args, *kwargs)	Highlights the triangles in the neighborhood of the stitch edge loop.
`remesh_constant_size`(args, *kwargs)	Remeshes the specified face zones to a constant triangle size while maintaining conformity with adjacent zones.
`remesh_face_zone`(args, *kwargs)	Remeshes a specified face zone by automatically extracting edge loops.
`remesh_face_zones_conformally`(args, *kwargs)	Remeshes face zones using the current size function and keeping a conformal interface between them.
`remesh_marked_faces`(args, *kwargs)	Locally remesh marked faces.
`remesh_overlapping_zones`(args, *kwargs)	Remeshes overlapping face zones.
`stitch_all_face_zones`(args, *kwargs)	Connects (stitches) all the face zones along the free edges.
`stitch_face_zones`(args, *kwargs)	Connects two surfaces along their free edges.
`stitch_with_preserve_boundary`(args, *kwargs)	Connects (stitches) a zone to another which is connected to an existing volume mesh, while preserving the boundary of the zones connected to the volume mesh.
`triangulate`(args, *kwargs)	Triangulates quad zones.

Classes:

`controls`(path, service)	Enters the edge loop tools text menu.
`size_functions`(path, service)	Enters the size functions menu where you can define size functions for controlling mesh size distribution.

clear_marked_faces(*args, **kwargs)#: Clears the highlighting of the triangles that are marked.

coarsen_and_refine(*args, **kwargs)#: Remeshes (coarsens/refines) the boundary face zones based on the computed size field. Specify the boundary face zones to be remeshed, the boundary edge zones, feature angle, and corner angle. Additionally, specify whether the current boundary face zones should be replaced by the remeshed face zones after the operation is complete.

class controls(path, service)#

Bases: TUIMenu

Enters the edge loop tools text menu.

Methods:

`delete_overlapped`(args, *kwargs)	Toggles the deletion of region of overlap of the two surfaces.
`direction`(args, *kwargs)	Specifies the direction of the edge loop projection.
`project_method`(args, *kwargs)	Specifies the method for projecting edge loops.
`proximity_local_search`(args, *kwargs)	Includes the selected face for proximity calculation.
`quadratic_recon`(args, *kwargs)	Enables/disables quadratic reconstruction of edge loops.
`remesh_method`(args, *kwargs)	Specifies the method to be used for the node distribution on the edge loop.
`spacing`(args, *kwargs)	Sets the node spacing for the edge loop.
`tolerance`(args, *kwargs)	Sets the tolerance for determining if two edges intersect.

Classes:

intersect(path, service)

Enters the intersect control menu.

delete_overlapped(*args, **kwargs)#: Toggles the deletion of region of overlap of the two surfaces.

direction(*args, **kwargs)#: Specifies the direction of the edge loop projection.

class intersect(path, service)#

Bases: TUIMenu

Enters the intersect control menu.

Methods:

`absolute_tolerance`(args, *kwargs)	Enables you to switch between the use of absolute and relative tolerance.
`delete_overlap`(args, *kwargs)	Enables/disables the deletion of overlapped edges.
`feature_angle`(args, *kwargs)	Specifies the minimum feature angle that should be considered while retriangulating the boundary zones.
`ignore_parallel_faces`(args, *kwargs)	Default is yes.
`join_match_angle`(args, *kwargs)	Specifies the allowed maximum angle between the normals of the two overlapping surfaces to be joined.
`join_project_angle`(args, *kwargs)	Specifies the allowed maximum angle between the face normal and the project direction for the overlapping surfaces to be joined.
`refine_region`(args, *kwargs)	Enables you to refine the regions that are modified during the intersect operations.
`remesh_post_intersection`(args, *kwargs)	Used to enable or disable automatic post-remesh operation after any connect operation (join, intersect, or stitch).
`retri_improve`(args, *kwargs)	Enables you to improve the mesh.
`separate`(args, *kwargs)	Enables the automatic separation of intersected zones.
`stitch_preserve`(args, *kwargs)	Indicates that shape of the first zone specified is to be preserved.
`tolerance`(args, *kwargs)	Specifies the tolerance value for the intersect operations.
`within_tolerance`(args, *kwargs)	Performs the intersection operation only within the specified tolerance value.

absolute_tolerance(*args, **kwargs)#: Enables you to switch between the use of absolute and relative tolerance. By default, the relative tolerance value is used.

delete_overlap(*args, **kwargs)#: Enables/disables the deletion of overlapped edges. It toggles the automatic deletion of region of overlap of the two surfaces. This option is used by while remeshing overlapping zones and retriangulating prisms. By default, this option is enabled.

feature_angle(*args, **kwargs)#: Specifies the minimum feature angle that should be considered while retriangulating the boundary zones. All the edges in the zone having feature angle greater than the specified feature angle are retained. This option is useful for preserving the shape of the intersecting boundary zones. The default value of feature angle is 40, however, a value in the range of 10–50 degrees is recommended. A large value may distort the shape of the intersecting boundary zones.

ignore_parallel_faces(*args, **kwargs)#: Default is yes. If there are close-to-parallel faces, set to no to separate the zones and avoid creating an intersection loop.

join_match_angle(*args, **kwargs)#: Specifies the allowed maximum angle between the normals of the two overlapping surfaces to be joined. This parameter is used to control the size of the join region.

join_project_angle(*args, **kwargs)#: Specifies the allowed maximum angle between the face normal and the project direction for the overlapping surfaces to be joined. This parameter is used to control the size of the join region.

refine_region(*args, **kwargs)#: Enables you to refine the regions that are modified during the intersect operations. It toggles the refinement of the intersecting regions after performing any of the intersection operation. This operation improves the quality of the resulting mesh, however, this option is disabled by default.

remesh_post_intersection(*args, **kwargs)#: Used to enable or disable automatic post-remesh operation after any connect operation (join, intersect, or stitch).

retri_improve(*args, **kwargs)#: Enables you to improve the mesh. After performing any intersection operation, the slivers are removed along the curve of intersection, Laplace smoothing is performed, and followed by the edge swapping. Laplace smoothing is also performed for insert-edge-zone, remesh-overlapped-zones, and prism-retriangulation options. Smoothing is performed again. The smooth-swap operations can be controlled by changing the various defaults such as swapping iterations, smoothing iterations, etc.

separate(*args, **kwargs)#: Enables the automatic separation of intersected zones.

stitch_preserve(*args, **kwargs)#: Indicates that shape of the first zone specified is to be preserved. This option is enabled by default.

tolerance(*args, **kwargs)#: Specifies the tolerance value for the intersect operations.

within_tolerance(*args, **kwargs)#: Performs the intersection operation only within the specified tolerance value. It is useful only for the Intersect option.

project_method(*args, **kwargs)#: Specifies the method for projecting edge loops.

proximity_local_search(*args, **kwargs)#: Includes the selected face for proximity calculation.

quadratic_recon(*args, **kwargs)#: Enables/disables quadratic reconstruction of edge loops.

remesh_method(*args, **kwargs)#: Specifies the method to be used for the node distribution on the edge loop.

spacing(*args, **kwargs)#: Sets the node spacing for the edge loop.

tolerance(*args, **kwargs)#: Sets the tolerance for determining if two edges intersect.

create_all_intrst_loops(*args, **kwargs)#: Creates edge loop of intersection for all boundary zones in current domain.

create_edge_loops(*args, **kwargs)#: Creates edge loops for a specified face zone, based on feature angle.

create_intersect_loop(*args, **kwargs)#: Creates an interior edge loop at the intersection between two adjacent face zones. Edges created in this way will not be remeshed by default.

create_join_loop(*args, **kwargs)#: Creates edge loop on boundary of the region of overlap of two surfaces.

create_stitch_loop(*args, **kwargs)#: Creates edge loops for connecting two surfaces along their free edges.

delete_overlapped_edges(*args, **kwargs)#: Deletes edges that overlap selected edge loops.

faceted_stitch_zones(*args, **kwargs)#: Performs the faceted stitching of zones.

insert_edge_zone(*args, **kwargs)#: Inserts an edge zone into a triangulated boundary face zone.

intersect_all_face_zones(*args, **kwargs)#: Remeshes all the intersecting face zones. After the intersect operation, remesh is called automatically. To disable the post-remesh operation, use the text command: /boundary/remesh/controls/intersect/remesh-post-intersection? no.

intersect_face_zones(*args, **kwargs)#: Remeshes two intersecting face zones so that they become conformal. After the intersect operation, remesh is called automatically. To disable the post-remesh operation, use the text command: /boundary/remesh/controls/intersect/remesh-post-intersection? no.

join_all_face_zones(*args, **kwargs)#: Connects all overlapping face zones using the join operation. After the join operation, remesh is called automatically. To disable the post-remesh operation, use the text command: /boundary/remesh/controls/intersect/remesh-post-intersection? no.

join_face_zones(*args, **kwargs)#: Connects two overlapping faces. After the join operation, remesh is called automatically. To disable the post-remesh operation, use the text command: /boundary/remesh/controls/intersect/remesh-post-intersection? no.

mark_intersecting_faces(*args, **kwargs)#: Highlights the triangles in the neighborhood of the line of intersection.

mark_join_faces(*args, **kwargs)#: Highlights the triangles in the neighborhood of the join edge loop.

mark_stitch_faces(*args, **kwargs)#: Highlights the triangles in the neighborhood of the stitch edge loop.

remesh_constant_size(*args, **kwargs)#: Remeshes the specified face zones to a constant triangle size while maintaining conformity with adjacent zones. Specify the boundary face zones to be remeshed, the boundary edge zones, feature angle, corner angle, and the constant size. Additionally, specify whether the current boundary face zones should be replaced by the remeshed face zones after the operation is complete.

remesh_face_zone(*args, **kwargs)#: Remeshes a specified face zone by automatically extracting edge loops. If edge loops are present in the current domain (for example, if they were created using the create-edge-loops command), they are used to remesh the specified face zone.

remesh_face_zones_conformally(*args, **kwargs)#: Remeshes face zones using the current size function and keeping a conformal interface between them. If no size function is defined, an error message will be generated. This command will prompt for: Boundary Face Zones Boundary Edge Zones feature angle – used to determine the minimum angle between features that will be preserved during remeshing corner angle – used to specify the minimum angle between feature edges that will be preserved Replace Face Zone? – (default is Yes) the remeshed face zone(s) will take the name and -id of the original zones, and the original face zone(s) will have “orig” appended to their name. If No, the remeshed face zone(s) will have “retri” added postfix. Periodic face zones cannot be remeshed using this command.

remesh_marked_faces(*args, **kwargs)#: Locally remesh marked faces.

remesh_overlapping_zones(*args, **kwargs)#: Remeshes overlapping face zones. The non-overlapping region is remeshed using the edge loops created from the overlapping face zones.

class size_functions(path, service)#

Bases: TUIMenu

Enters the size functions menu where you can define size functions for controlling mesh size distribution.

Methods:

`compute`(args, *kwargs)	Computes the size field based on the defined parameters.
`create`(args, *kwargs)	Defines the size function based on the specified parameters.
`create_defaults`(args, *kwargs)	Creates default size functions based on face and edge curvature and proximity.
`delete`(args, *kwargs)	Deletes the specified size function or the current size field.
`delete_all`(args, *kwargs)	Deletes all the defined size functions.
`disable_periodicity_filter`(args, *kwargs)	Removes periodicity from the size field.
`enable_periodicity_filter`(args, *kwargs)	Enable size field periodicity.
`list`(args, *kwargs)	Lists all the defined size functions and the parameter values defined.
`list_periodicity_filter`(args, *kwargs)	List periodic in size field.
`reset_global_controls`(args, *kwargs)	Resets the global controls to their default values.
`set_global_controls`(args, *kwargs)	Sets the values for the global minimum and maximum size, and the growth rate.
`set_prox_gap_tolerance`(args, *kwargs)	Sets the tolerance relative to minimum size to take gaps into account.
`set_scaling_filter`(args, *kwargs)	Specifies the scale factor, and minimum and maximum size values to filter the size output from the size field.
`triangulate_quad_faces`(args, *kwargs)	Identifies the zones comprising non-triangular elements and uses a triangulated copy of these zones for computing the size functions.
`use_cad_imported_curvature`(args, *kwargs)	Enables/disables curvature data from the nodes of the CAD facets.

Classes:

`contours`(path, service)	Contains options for displaying contours of size functions.
`controls`(path, service)	Menu to control different behavior of sf.

compute(*args, **kwargs)#: Computes the size field based on the defined parameters.

class contours(path, service)#

Bases: TUIMenu

Contains options for displaying contours of size functions.

Methods:

draw(*args, **kwargs)

Displays contours in the graphics window.

Classes:

set(path, service)

Set contour options.

draw(*args, **kwargs)#: Displays contours in the graphics window. Compute the size field using /size-functions/compute or read in a size field file prior to displaying the contours of size.

class set(path, service)#

Bases: TUIMenu

Set contour options.

Methods:

refine_facets(*args, **kwargs)

Enables you to specify smaller facets if the original are too large.

refine_facets(*args, **kwargs)#: Enables you to specify smaller facets if the original are too large. Default is no.

class controls(path, service)#

Bases: TUIMenu

Menu to control different behavior of sf.

Methods:

`curvature_method`(args, *kwargs)	Option to get facet curvature.
`meshed_sf_behavior`(args, *kwargs)	Set meshed size function processing to hard.

curvature_method(*args, **kwargs)#: Option to get facet curvature.

meshed_sf_behavior(*args, **kwargs)#: Set meshed size function processing to hard.

create(*args, **kwargs)#: Defines the size function based on the specified parameters.

create_defaults(*args, **kwargs)#: Creates default size functions based on face and edge curvature and proximity.

delete(*args, **kwargs)#: Deletes the specified size function or the current size field.

delete_all(*args, **kwargs)#: Deletes all the defined size functions.

disable_periodicity_filter(*args, **kwargs)#: Removes periodicity from the size field.

enable_periodicity_filter(*args, **kwargs)#: Enable size field periodicity.

list(*args, **kwargs)#: Lists all the defined size functions and the parameter values defined.

list_periodicity_filter(*args, **kwargs)#: List periodic in size field.

reset_global_controls(*args, **kwargs)#: Resets the global controls to their default values.

set_global_controls(*args, **kwargs)#: Sets the values for the global minimum and maximum size, and the growth rate.

set_prox_gap_tolerance(*args, **kwargs)#: Sets the tolerance relative to minimum size to take gaps into account. Gaps whose thickness is less than the global minimum size multiplied by this factor will not be regarded as a proximity gap.

set_scaling_filter(*args, **kwargs)#: Specifies the scale factor, and minimum and maximum size values to filter the size output from the size field.

triangulate_quad_faces(*args, **kwargs)#: Identifies the zones comprising non-triangular elements and uses a triangulated copy of these zones for computing the size functions.

use_cad_imported_curvature(*args, **kwargs)#: Enables/disables curvature data from the nodes of the CAD facets.

stitch_all_face_zones(*args, **kwargs)#: Connects (stitches) all the face zones along the free edges. After the stitch operation, remesh is called automatically. To disable the post-remesh operation, use the text command: /boundary/remesh/controls/intersect/remesh-post-intersection? no.

stitch_face_zones(*args, **kwargs)#: Connects two surfaces along their free edges. After the stitch operation, remesh is called automatically. To disable the post-remesh operation, use the text command: /boundary/remesh/controls/intersect/remesh-post-intersection? no.

stitch_with_preserve_boundary(*args, **kwargs)#: Connects (stitches) a zone to another which is connected to an existing volume mesh, while preserving the boundary of the zones connected to the volume mesh. Specify a list of boundary zones to be preserved, a list of the boundary zones to be connected to each of these zones, and the tolerance value. After the stitch operation, remesh is called automatically. To disable the post-remesh operation, use the text command: /boundary/remesh/controls/intersect/remesh-post-intersection? no This command will not work for overlapping or partially overlapping face zones.

triangulate(*args, **kwargs)#: Triangulates quad zones.

reset_element_type(*args, **kwargs)#: Resets the element type (mixed, tri, or quad) of a boundary zone. If you have separated a mixed (tri and quad) face zone into one tri face zone and one quad face zone, for example, each of these will be identified as a “mixed” zone. Resetting the element type for each of these new zones will identify them as, respectively, a triangular zone and a quadrilateral zone.

resolve_face_intersection(*args, **kwargs)#: Resolves self intersection on manifold surface meshes.

scale_nodes(*args, **kwargs)#: Applies a scaling factor to all node coordinates. You can use this command to change the units of the grid.

class separate(path, service)#

Bases: TUIMenu

Contains options for separating face zones.

Classes:

local_regions(path, service)

Enters the local refinement menu.

Methods:

`mark_faces_in_region`(args, *kwargs)	Marks the faces that are contained in a specified local refinement region.
`sep_face_zone_by_angle`(args, *kwargs)	Separates a boundary face zone based on significant angle.
`sep_face_zone_by_cnbor`(args, *kwargs)	Separates a boundary/interior face zone based on its cell neighbors.
`sep_face_zone_by_mark`(args, *kwargs)	Separates a boundary face zone by moving marked faces to a new zone.
`sep_face_zone_by_region`(args, *kwargs)	Separates a boundary face zone based on contiguous regions.
`sep_face_zone_by_seed`(args, *kwargs)	Separates a boundary face zone by defining a seed face on the surface.
`sep_face_zone_by_seed_angle`(args, *kwargs)	Separates faces connected to the seed face, whose normal fall within the specified cone.
`sep_face_zone_by_shape`(args, *kwargs)	Separates a boundary face zone based on the shape of the faces (triangular or quadrilateral).

class local_regions(path, service)#

Bases: TUIMenu

Enters the local refinement menu.

Methods:

`define`(args, *kwargs)	Enables you to define the local region.
`delete`(args, *kwargs)	Deletes the specified local region.
`init`(args, *kwargs)	Creates a region encompassing the entire geometry.
`list_all_regions`(args, *kwargs)	Lists all the local regions defined.

define(*args, **kwargs)#: Enables you to define the local region.

delete(*args, **kwargs)#: Deletes the specified local region.

init(*args, **kwargs)#: Creates a region encompassing the entire geometry.

list_all_regions(*args, **kwargs)#: Lists all the local regions defined.

mark_faces_in_region(*args, **kwargs)#: Marks the faces that are contained in a specified local refinement region.

sep_face_zone_by_angle(*args, **kwargs)#: Separates a boundary face zone based on significant angle.

sep_face_zone_by_cnbor(*args, **kwargs)#: Separates a boundary/interior face zone based on its cell neighbors.

sep_face_zone_by_mark(*args, **kwargs)#: Separates a boundary face zone by moving marked faces to a new zone.

sep_face_zone_by_region(*args, **kwargs)#: Separates a boundary face zone based on contiguous regions.

sep_face_zone_by_seed(*args, **kwargs)#: Separates a boundary face zone by defining a seed face on the surface.

sep_face_zone_by_seed_angle(*args, **kwargs)#: Separates faces connected to the seed face, whose normal fall within the specified cone.

sep_face_zone_by_shape(*args, **kwargs)#: Separates a boundary face zone based on the shape of the faces (triangular or quadrilateral).

set_periodicity(*args, **kwargs)#: Defines the periodicity parameters. You will be prompted for the type of periodicity (rotational or translational). For rotational periodicity, you will be prompted for the angle and axis of rotation parameters. For translational periodicity, you will be prompted for the shift vector components.

class shell_boundary_layer(path, service)#

Bases: TUIMenu

Enter the shell boundary layer menu.

Classes:

controls(path, service)

Shell Boundary Layer Controls.

Methods:

create(*args, **kwargs)

Create shell boundary layers from one or more face zones.

class controls(path, service)#

Bases: TUIMenu

Shell Boundary Layer Controls.

Classes:

zone_specific_growth(path, service)

Shell boundary Layer Growth Controls.

class zone_specific_growth(path, service)#

Bases: TUIMenu

Shell boundary Layer Growth Controls.

Methods:

`apply_growth`(args, *kwargs)	Apply shell boundary la growth on individual edge zones.
`clear_growth`(args, *kwargs)	Clear shell boundary layer specific growth on individual edge zones.

apply_growth(*args, **kwargs)#: Apply shell boundary la growth on individual edge zones.

clear_growth(*args, **kwargs)#: Clear shell boundary layer specific growth on individual edge zones.

create(*args, **kwargs)#: Create shell boundary layers from one or more face zones.

slit_boundary_face(*args, **kwargs)#: Slits a boundary face zone by duplicating all faces and nodes, except those nodes that are located at the edges of the boundary zone. A displacement can be specified to provide thickness to the boundary. The slit command only works when it is possible to move from face to face using the connectivity provided by the cells. You should slit the boundary face after you generate the volume mesh so that cells will not be placed inside the gap. There may be some inaccuracies when you graphically display solution data for a mesh with a slit boundary in ANSYS Fluent.

smooth_marked_faces(*args, **kwargs)#: Smooths the marked faces.

unmark_faces_in_zones(*args, **kwargs)#: Unmark faces in zones.

unmark_selected_faces(*args, **kwargs)#: Unmarks the marked selected faces.

wrapper(*args, **kwargs)#: Enters the surface wrapper menu. This menu is no longer supported, and will be removed in a future release.

class cad_assemblies(path, service)#

Bases: TUIMenu

Menu for cad assemblies.

Methods:

`add_prefix`(args, *kwargs)	Enables you to add a prefix to the selected entities.
`add_to_object`(args, *kwargs)	Enables you to add the selected CAD entities to an existing object.
`create_objects`(args, *kwargs)	Enables you to create new geometry/mesh objects for the selected entities.
`delete_cad_assemblies`(args, *kwargs)	Deletes all the CAD assemblies data.
`draw`(args, *kwargs)	Displays the selected CAD entities.
`extract_edges_zones`(args, *kwargs)	Extract feature edges for CAD assemblies.
`rename`(args, *kwargs)	Enables you to rename the selected entities.
`replace_object`(args, *kwargs)	Enables you to replace an object with the selected CAD entities.
`update_cad_assemblies`(args, *kwargs)	Reimports the selected CAD entities using new parameters specified in the update-options/ menu.

Classes:

`draw_options`(path, service)	Contains additional options for displaying CAD entities.
`labels`(path, service)	Contains options for displaying and managing labels.
`manage_state`(path, service)	Contains options for setting the CAD entity state.
`update_options`(path, service)	Contains options for updating the CAD entities on reimport.

add_prefix(*args, **kwargs)#: Enables you to add a prefix to the selected entities. Specify the path for the entities and the prefix to be added.

add_to_object(*args, **kwargs)#: Enables you to add the selected CAD entities to an existing object. Specify the path for the entities to be added and select the object to be modified.

create_objects(*args, **kwargs)#: Enables you to create new geometry/mesh objects for the selected entities. Specify the path for the entities and if required, choose to create one object per CAD entity selected and/or retain the CAD zone granularity for object creation. By default, a single object will be created for all entities selected and the CAD zone granularity will not be retained. Specify the object name (if applicable), object type (geom or mesh), and cell zone type (dead, fluid, or solid).

delete_cad_assemblies(*args, **kwargs)#: Deletes all the CAD assemblies data.

draw(*args, **kwargs)#: Displays the selected CAD entities.

class draw_options(path, service)#

Bases: TUIMenu

Contains additional options for displaying CAD entities.

Methods:

`add_to_graphics`(args, *kwargs)	Adds the selected entities to the display in the graphics window.
`draw_unlabelled_zones`(args, *kwargs)	Displays the unlabeled zones for the selected entities in the graphics window.
`remove_from_graphics`(args, *kwargs)	Removes the selected entities from the display in the graphics window.

add_to_graphics(*args, **kwargs)#: Adds the selected entities to the display in the graphics window.

draw_unlabelled_zones(*args, **kwargs)#: Displays the unlabeled zones for the selected entities in the graphics window.

remove_from_graphics(*args, **kwargs)#: Removes the selected entities from the display in the graphics window.

extract_edges_zones(*args, **kwargs)#: Extract feature edges for CAD assemblies.

class labels(path, service)#

Bases: TUIMenu

Contains options for displaying and managing labels.

Methods:

`add_to_graphics`(args, *kwargs)	Adds the selected labels to the display in the graphics window.
`delete`(args, *kwargs)	Deletes the selected labels.
`draw`(args, *kwargs)	Displays the selected labels.
`remove_from_graphics`(args, *kwargs)	Removes the selected labels from the display in the graphics window.
`rename`(args, *kwargs)	Enables you to rename the selected labels.

add_to_graphics(*args, **kwargs)#: Adds the selected labels to the display in the graphics window.

delete(*args, **kwargs)#: Deletes the selected labels.

draw(*args, **kwargs)#: Displays the selected labels.

remove_from_graphics(*args, **kwargs)#: Removes the selected labels from the display in the graphics window.

rename(*args, **kwargs)#: Enables you to rename the selected labels. Specify the path for the labels and the new name. For multiple selections, the specified name will be used, with a suitable index as suffix. For example, specifying a new label name wall will result in entities wall.1, wall.2, etc.

class manage_state(path, service)#

Bases: TUIMenu

Contains options for setting the CAD entity state.

Methods:

`suppress`(args, *kwargs)	Suppresses the selected CAD entities.
`unlock`(args, *kwargs)	Unlocks the selected CAD entities.
`unsuppress`(args, *kwargs)	Unsuppresses the selected CAD entities.

suppress(*args, **kwargs)#: Suppresses the selected CAD entities.

unlock(*args, **kwargs)#: Unlocks the selected CAD entities.

unsuppress(*args, **kwargs)#: Unsuppresses the selected CAD entities.

rename(*args, **kwargs)#: Enables you to rename the selected entities. Specify the path for the entities and the new name. For multiple entities, the specified name will be used, with a suitable index as suffix. For example, specifying a new name wall will result in entities wall.1, wall.2, etc.

replace_object(*args, **kwargs)#: Enables you to replace an object with the selected CAD entities. Specify the path for the entities to be added and select the object to be modified.

update_cad_assemblies(*args, **kwargs)#: Reimports the selected CAD entities using new parameters specified in the update-options/ menu.

class update_options(path, service)#

Bases: TUIMenu

Contains options for updating the CAD entities on reimport.

Methods:

`import_edge_zones`(args, *kwargs)	Enables you to import edge zones from the CAD entities on reimport.
`one_object_per`(args, *kwargs)	Enables you to change the CAD object granularity on reimport.
`one_zone_per`(args, *kwargs)	Enables you to change the CAD zone granularity on reimport.
`tessellation`(args, *kwargs)	Enables you to control the tessellation (faceting) during reimport.

import_edge_zones(*args, **kwargs)#: Enables you to import edge zones from the CAD entities on reimport. Specify an appropriate value for feature angle.

one_object_per(*args, **kwargs)#: Enables you to change the CAD object granularity on reimport.

one_zone_per(*args, **kwargs)#: Enables you to change the CAD zone granularity on reimport.

tessellation(*args, **kwargs)#: Enables you to control the tessellation (faceting) during reimport. You can select either cad-faceting or cfd-surface-mesh. CAD faceting enables you to control the tessellation based on the CAD faceting tolerance and maximum facet size specified. CFD Surface Mesh enables you to use a size field file during reimport. If you enter yes, specify the size field file to be read. If you do not want to use a size field file, you can obtain conformal faceting based on the underlying curve and surface curvature (using the minimum and maximum facet sizes, and the facet curvature normal angle specified) and edge proximity (using the cells per gap specified). You can also save the size field in a file (size field is computed based on the specified parameters; that is, Min Size, Max Size, Curvature Normal Angle, Cells Per Gap).

close_fluent(*args, **kwargs)#: (ANSYS Fluent in Workbench only) Exits program.

class diagnostics(path, service)#

Bases: TUIMenu

Diagnostic tools.

Classes:

`face_connectivity`(path, service)	Contains options for fixing problems with face connectivity on the specified object face zones or boundary face zones.
`quality`(path, service)	Contains options for fixing problems related to surface mesh quality on the specified object face zones or boundary face zones.

Methods:

`manage_summary`(args, *kwargs)	Manage diagnostics summary checks.
`modify_defaults`(args, *kwargs)	Modify diagnostics defaults.
`perform_summary`(args, *kwargs)	Performs diagnostics check and report in console.
`set_scope`(args, *kwargs)	Set Diagnostics scope.

class face_connectivity(path, service)#

Bases: TUIMenu

Contains options for fixing problems with face connectivity on the specified object face zones or boundary face zones.

Methods:

`add_label_to_small_neighbors`(args, *kwargs)	Separates island object face zones from all connected neighbors and merges them to the connected neighboring face zone label based on minimum face count specified.
`fix_deviations`(args, *kwargs)	Fixes deviations in the wrapped surface mesh by imprinting edges on the wrapped face zones.
`fix_duplicate_faces`(args, *kwargs)	Removes duplicate faces.
`fix_free_faces`(args, *kwargs)	Removes free faces by the method selected.
`fix_invalid_normals`(args, *kwargs)	Fixes invalid normals by smoothing.
`fix_islands`(args, *kwargs)	Deletes groups of island faces based on the absolute face count specified.
`fix_multi_faces`(args, *kwargs)	Fixes multiply connected faces by a combination of deleting face fringes, overlapping faces, and disconnected faces.
`fix_point_contacts`(args, *kwargs)	Fixes non-manifold configurations by removing point contacts.
`fix_self_intersections`(args, *kwargs)	Fixes self intersecting or folded faces.
`fix_slivers`(args, *kwargs)	Fixes faces based on skewness and height criteria.
`fix_spikes`(args, *kwargs)	Fixes spiked faces based on the spike angle specified.
`fix_steps`(args, *kwargs)	Fixes step configurations by smoothing or collapsing faces based on the angle and step width specified.
`remove_label_from_small_islands`(args, *kwargs)	Change small disconnected island labels to their connected neighbors.

add_label_to_small_neighbors(*args, **kwargs)#: Separates island object face zones from all connected neighbors and merges them to the connected neighboring face zone label based on minimum face count specified.

fix_deviations(*args, **kwargs)#: Fixes deviations in the wrapped surface mesh by imprinting edges on the wrapped face zones. Specify the number of imprint iterations and aggressive imprint iterations to be performed.

fix_duplicate_faces(*args, **kwargs)#: Removes duplicate faces.

fix_free_faces(*args, **kwargs)#: Removes free faces by the method selected. The methods available are:.

fix_invalid_normals(*args, **kwargs)#: Fixes invalid normals by smoothing. Zone-specific or scoped prism settings should be applied prior to using this command.

fix_islands(*args, **kwargs)#: Deletes groups of island faces based on the absolute face count specified.

fix_multi_faces(*args, **kwargs)#: Fixes multiply connected faces by a combination of deleting face fringes, overlapping faces, and disconnected faces. Specify the maximum number of fringe faces, overlapping faces, and multiply connected edges, respectively.

fix_point_contacts(*args, **kwargs)#: Fixes non-manifold configurations by removing point contacts.

fix_self_intersections(*args, **kwargs)#: Fixes self intersecting or folded faces. For fixing folded faces by smoothing, specify whether features should be imprinted.

fix_slivers(*args, **kwargs)#: Fixes faces based on skewness and height criteria. Height is the perpendicular distance between the longest edge of the triangle and the opposite node.

fix_spikes(*args, **kwargs)#: Fixes spiked faces based on the spike angle specified.

fix_steps(*args, **kwargs)#: Fixes step configurations by smoothing or collapsing faces based on the angle and step width specified.

remove_label_from_small_islands(*args, **kwargs)#: Change small disconnected island labels to their connected neighbors.

manage_summary(*args, **kwargs)#: Manage diagnostics summary checks.

modify_defaults(*args, **kwargs)#: Modify diagnostics defaults.

perform_summary(*args, **kwargs)#: Performs diagnostics check and report in console.

class quality(path, service)#

Bases: TUIMenu

Contains options for fixing problems related to surface mesh quality on the specified object face zones or boundary face zones.

Methods:

`collapse`(args, *kwargs)	Collapses bad quality faces based on area or skewness.
`delaunay_swap`(args, *kwargs)	Improves the surface mesh by swapping based on the minimum skewness value and feature angle specified.
`general_improve`(args, *kwargs)	Improves the surface mesh based on aspect ratio, size change, or skewness.
`smooth`(args, *kwargs)	Improves the surface mesh by smoothing.

collapse(*args, **kwargs)#: Collapses bad quality faces based on area or skewness. For collapsing based on face area, specify the maximum face area and relative maximum area. For collapsing based on face skewness, specify the minimum skewness and feature angle. Additionally, specify the number of iterations and whether the boundary should be preserved.

delaunay_swap(*args, **kwargs)#: Improves the surface mesh by swapping based on the minimum skewness value and feature angle specified. Additionally, specify the number of iterations and whether the boundary should be preserved.

general_improve(*args, **kwargs)#: Improves the surface mesh based on aspect ratio, size change, or skewness. Specify the minimum quality value, feature angle, number of iterations, and whether the boundary should be preserved.

smooth(*args, **kwargs)#: Improves the surface mesh by smoothing. Specify the number of smoothing iterations and whether the boundary should be preserved.

set_scope(*args, **kwargs)#: Set Diagnostics scope.

class display(path, service)#

Bases: TUIMenu

Enter the display menu.

Classes:

`advanced_rendering`(path, service)	Enter the advanced rendering menu.
`display_states`(path, service)	Enter the display states menu.
`objects`(path, service)	Contains commands for displaying objects.
`set`(path, service)	Enables you to enter the set menu to set the display parameters.
`set_grid`(path, service)	Contains options controlling the display of the grid.
`update_scene`(path, service)	Contains commands that enable you to update the scene description.
`xy_plot`(path, service)	Enters the XY plot menu.
`zones`(path, service)	Contains commands for displaying zones.

Methods:

`all_grid`(args, *kwargs)	Displays the grid according to the currently set parameters.
`annotate`(args, *kwargs)	Adds annotation text to a graphics window.
`boundary_cells`(args, *kwargs)	Displays boundary cells attached to the specified face zones.
`boundary_grid`(args, *kwargs)	Displays only boundary zones according to the currently set parameters.
`center_view_on`(args, *kwargs)	Sets the camera target to be the center (centroid) of an entity.
`clear`(args, *kwargs)	Clears the active graphics window.
`clear_annotation`(args, *kwargs)	Removes all annotations and attachment lines from the active graphics window.
`draw_cells_using_faces`(args, *kwargs)	Draws cells that are neighbors for the selected faces.
`draw_cells_using_nodes`(args, *kwargs)	Draws cells that are connected to the selected nodes.
`draw_face_zones_using_entities`(args, *kwargs)	Draws cells that are connected to the selected entities.
`draw_zones`(args, *kwargs)	Draws the boundary/cell zones using the zone ID specified as input.
`redisplay`(args, *kwargs)	Redraws the grid in the graphics window.
`save_picture`(args, *kwargs)	Saves a picture file of the active graphics window.
`set_list_tree_separator`(args, *kwargs)	Sets the separator character to be used to determine the common prefix for items listed in the selection lists, when the tree view is used.
`show_hide_clipping_plane_triad`(args, *kwargs)
`update_layout`(args, *kwargs)	Update the fluent layout.
`views`(args, *kwargs)	Enters the view window options menu.

class advanced_rendering(path, service)#

Bases: TUIMenu

Enter the advanced rendering menu.

Methods:

`edge_color`(args, *kwargs)	Choose between black and body colored edges.
`fast_silhouette_edges`(args, *kwargs)	Enhances viewability by adding fast silhouette edges.
`max_extent_culling`(args, *kwargs)	Truncates zones smaller that the maximum extent culling pixel value.
`simple_shadow`(args, *kwargs)	Enhances viewability by adding a simple shadow.
`static_model`(args, *kwargs)	Static model driver setting.

edge_color(*args, **kwargs)#: Choose between black and body colored edges.

fast_silhouette_edges(*args, **kwargs)#: Enhances viewability by adding fast silhouette edges.

max_extent_culling(*args, **kwargs)#: Truncates zones smaller that the maximum extent culling pixel value.

simple_shadow(*args, **kwargs)#: Enhances viewability by adding a simple shadow.

static_model(*args, **kwargs)#: Static model driver setting.

all_grid(*args, **kwargs)#: Displays the grid according to the currently set parameters.

annotate(*args, **kwargs)#: Adds annotation text to a graphics window. It will prompt you for a string to use as the annotation text, and then a dialog box will prompt you to select a screen location using the mouse-probe button on your mouse.

boundary_cells(*args, **kwargs)#: Displays boundary cells attached to the specified face zones.

boundary_grid(*args, **kwargs)#: Displays only boundary zones according to the currently set parameters.

center_view_on(*args, **kwargs)#: Sets the camera target to be the center (centroid) of an entity.

clear(*args, **kwargs)#: Clears the active graphics window. This option is useful when you redo an overlay.

clear_annotation(*args, **kwargs)#: Removes all annotations and attachment lines from the active graphics window.

class display_states(path, service)#

Bases: TUIMenu

Enter the display states menu.

Methods:

`apply`(args, *kwargs)	Apply a display state to the active graphics window.
`copy`(args, *kwargs)	Copy the settings of an existing display state to another existing display state.
`create`(args, *kwargs)	Create a new display state.
`delete`(args, *kwargs)	Delete a display state.
`edit`(args, *kwargs)	Edit a display state.
`list`(args, *kwargs)	Print the names of the existing display states to the console.
`read`(args, *kwargs)	Read in display states from a file.
`use_active`(args, *kwargs)	Save the display state settings of the active graphics window to an existing display state.
`write`(args, *kwargs)	Write one or more of the saved display states to a file.

apply(*args, **kwargs)#: Apply a display state to the active graphics window.

copy(*args, **kwargs)#: Copy the settings of an existing display state to another existing display state.

create(*args, **kwargs)#: Create a new display state.

delete(*args, **kwargs)#: Delete a display state.

edit(*args, **kwargs)#: Edit a display state. Enter quit (or a substring, such as q or qui) to exit the editing loop.

list(*args, **kwargs)#: Print the names of the existing display states to the console.

read(*args, **kwargs)#: Read in display states from a file.

use_active(*args, **kwargs)#: Save the display state settings of the active graphics window to an existing display state. This command is not available when the active window is displaying a 2D plot.

write(*args, **kwargs)#: Write one or more of the saved display states to a file.

draw_cells_using_faces(*args, **kwargs)#: Draws cells that are neighbors for the selected faces.

draw_cells_using_nodes(*args, **kwargs)#: Draws cells that are connected to the selected nodes.

draw_face_zones_using_entities(*args, **kwargs)#: Draws cells that are connected to the selected entities.

draw_zones(*args, **kwargs)#: Draws the boundary/cell zones using the zone ID specified as input.

class objects(path, service)#

Bases: TUIMenu

Contains commands for displaying objects.

Methods:

`display_neighborhood`(args, *kwargs)	Displays the objects that are in the neighborhood of the selected object.
`display_similar_area`(args, *kwargs)	Displays the objects with similar area to the selected object area.
`explode`(args, *kwargs)	Explodes the objects in the geometry.
`hide_objects`(args, *kwargs)	Hides the selected objects in the display.
`implode`(args, *kwargs)	Implodes or assembles the objects in the geometry.
`isolate_objects`(args, *kwargs)	Displays only the selected objects.
`make_transparent`(args, *kwargs)	Makes the geometry transparent so that internal objects are visible.
`select_all_visible`(args, *kwargs)	Selects all the visible objects in the graphics window.
`show_all`(args, *kwargs)	Unhides all the objects in the geometry and displays them.
`toggle_color_mode`(args, *kwargs)	Toggles the colors of the geometry.
`toggle_color_palette`(args, *kwargs)	Toggles the color palette of the geometry.

display_neighborhood(*args, **kwargs)#: Displays the objects that are in the neighborhood of the selected object. The neighboring objects have to be in contact, or intersecting the selected object.

display_similar_area(*args, **kwargs)#: Displays the objects with similar area to the selected object area.

explode(*args, **kwargs)#: Explodes the objects in the geometry. (This command is valid only when the geometry is an assembled mode.).

hide_objects(*args, **kwargs)#: Hides the selected objects in the display.

implode(*args, **kwargs)#: Implodes or assembles the objects in the geometry. (This command is available only when the geometry is an exploded mode.).

isolate_objects(*args, **kwargs)#: Displays only the selected objects.

make_transparent(*args, **kwargs)#: Makes the geometry transparent so that internal objects are visible. This command works as a toggle undoing the transparency of the previously selected objects.

select_all_visible(*args, **kwargs)#: Selects all the visible objects in the graphics window.

show_all(*args, **kwargs)#: Unhides all the objects in the geometry and displays them.

toggle_color_mode(*args, **kwargs)#: Toggles the colors of the geometry. In one mode geometry is colored object-wise while in the other mode it is colored zone-wise.

toggle_color_palette(*args, **kwargs)#: Toggles the color palette of the geometry.

redisplay(*args, **kwargs)#: Redraws the grid in the graphics window.

save_picture(*args, **kwargs)#: Saves a picture file of the active graphics window.

class set(path, service)#

Bases: TUIMenu

Enables you to enter the set menu to set the display parameters.

Classes:

`colors`(path, service)	Enables you to enter the colors options menu.
`lights`(path, service)	Enters the lights menu.
`picture`(path, service)	Saves a hardcopy file of the active graphics window.
`rendering_options`(path, service)	Contains the commands that enable you to set options that determine how the scene is rendered.
`styles`(path, service)	Contains commands for setting the display style for the different types of nodes and faces that can be displayed.

Methods:

`edges`(args, *kwargs)	Enables/disables the display of face/cell edges.
`filled_grid`(args, *kwargs)	Enables/disables the filled grid option.
`highlight_tree_selection`(args, *kwargs)	Turn on/off outline display of tree selection in graphics window.
`line_weight`(args, *kwargs)	Sets the line width factor for the window.
`native_display_defaults`(args, *kwargs)	Resets graphics window parameters to optimal settings for a local display.
`overlays`(args, *kwargs)	Turns overlays on and off.
`quick_moves_algorithm`(args, *kwargs)	Select quick moves algorithm for icons and helptext overlay.
`re_render`(args, *kwargs)	Re-renders the current window after modifying the variables in the set menu.
`remote_display_defaults`(args, *kwargs)	Adjusts graphics window parameters to optimal settings for a remote display.
`reset_graphics`(args, *kwargs)	Resets the graphics system.
`shrink_factor`(args, *kwargs)	Sets shrinkage of both faces and cells.
`title`(args, *kwargs)	Sets the problem title.
`windows`(args, *kwargs)	Enters the windows options menu, which contains commands that enable you to customize the relative positions of sub-windows inside the active graphics window.

class colors(path, service)#

Bases: TUIMenu

Enables you to enter the colors options menu.

Methods:

`automatic_skip`(args, *kwargs)	Specify whether the number of colormap labels is determined automatically.
`axis_faces`(args, *kwargs)	Sets the color of axisymmetric faces.
`background`(args, *kwargs)	Sets the background (window) color.
`color_by_type`(args, *kwargs)	Enables you to specify that the entities should be colored by their type or ID.
`far_field_faces`(args, *kwargs)	Sets the color of far field faces.
`foreground`(args, *kwargs)	Sets the foreground (text and window frame) color.
`free_surface_faces`(args, *kwargs)	Sets the color of free surface faces.
`graphics_color_theme`(args, *kwargs)	Sets the color theme for the graphics window.
`inlet_faces`(args, *kwargs)	Sets the color of the inlet faces.
`interface_faces`(args, *kwargs)	Sets the color of grid interface faces.
`interior_faces`(args, *kwargs)	Sets the color of the interior faces.
`internal_faces`(args, *kwargs)	Sets the color of the internal interface faces.
`list`(args, *kwargs)	Lists the colors available for the selected zone type.
`outlet_faces`(args, *kwargs)	Sets the color of the outlet faces.
`overset_faces`(args, *kwargs)	Sets the color of the overset faces.
`periodic_faces`(args, *kwargs)	Sets the color of periodic faces.
`rans_les_interface_faces`(args, *kwargs)	Sets the color of RANS/LES interface faces.
`reset_colors`(args, *kwargs)	Resets the individual grid surface colors to the defaults.
`reset_user_colors`(args, *kwargs)	Resets individual grid surface colors to the defaults.
`show_user_colors`(args, *kwargs)	Lists the current defined user colors.
`skip_label`(args, *kwargs)	Sets the number of labels to be skipped in the colormap scale.
`surface`(args, *kwargs)	Sets the color of surfaces.
`symmetry_faces`(args, *kwargs)	Sets the color of symmetric faces.
`traction_faces`(args, *kwargs)	Sets the color for traction faces.
`user_color`(args, *kwargs)	Enables you to change the color for the specified zone.
`wall_faces`(args, *kwargs)	Sets color for wall faces.

Classes:

`by_surface`(path, service)	Enter the surface(s) color and material assignment menu.
`by_type`(path, service)	Enter the zone type color and material assignment menu.

automatic_skip(*args, **kwargs)#: Specify whether the number of colormap labels is determined automatically. The default is yes.

axis_faces(*args, **kwargs)#: Sets the color of axisymmetric faces.

background(*args, **kwargs)#: Sets the background (window) color.

class by_surface(path, service)#

Bases: TUIMenu

Enter the surface(s) color and material assignment menu.

Methods:

`list_surfaces_by_color`(args, *kwargs)	To list the surfaces by its color.
`list_surfaces_by_material`(args, *kwargs)	To list the surfaces by its material.
`reset`(args, *kwargs)	To reset colors and/or materials to the defaults.
`surfaces`(args, *kwargs)	Select the surface(s) to specify colors and/or materials.

list_surfaces_by_color(*args, **kwargs)#: To list the surfaces by its color.

list_surfaces_by_material(*args, **kwargs)#: To list the surfaces by its material.

reset(*args, **kwargs)#: To reset colors and/or materials to the defaults.

surfaces(*args, **kwargs)#: Select the surface(s) to specify colors and/or materials.

class by_type(path, service)#

Bases: TUIMenu

Enter the zone type color and material assignment menu.

Methods:

`only_list_case_boundaries`(args, *kwargs)	Only list the boundary types that are assigned in this case.
`reset`(args, *kwargs)	To reset colors and/or materials to the defaults.

Classes:

type_name(path, service)

Select the boundary type to specify colors and/or materials.

only_list_case_boundaries(*args, **kwargs)#: Only list the boundary types that are assigned in this case.

reset(*args, **kwargs)#: To reset colors and/or materials to the defaults.

class type_name(path, service)#

Bases: TUIMenu

Select the boundary type to specify colors and/or materials.

Methods:

`axis`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`far_field`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`free_surface`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`inlet`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`interface`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`interior`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`internal`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`outlet`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`overset`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`periodic`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`rans_les_interface`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`surface`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`symmetry`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`traction`(args, *kwargs)	Set the material and/or color for the selected boundary type.
`wall`(args, *kwargs)	Set the material and/or color for the selected boundary type.

axis(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

far_field(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

free_surface(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

inlet(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

interface(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

interior(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

internal(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

outlet(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

overset(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

periodic(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

rans_les_interface(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

surface(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

symmetry(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

traction(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

wall(*args, **kwargs)#: Set the material and/or color for the selected boundary type.

color_by_type(*args, **kwargs)#: Enables you to specify that the entities should be colored by their type or ID.

far_field_faces(*args, **kwargs)#: Sets the color of far field faces.

foreground(*args, **kwargs)#: Sets the foreground (text and window frame) color.

free_surface_faces(*args, **kwargs)#: Sets the color of free surface faces.

graphics_color_theme(*args, **kwargs)#: Sets the color theme for the graphics window. The color options (black, white, gray-gradient, or workbench) are for the background display, but changing the theme also changes the default colors for items that display in the graphics windows, like faces and edges.

inlet_faces(*args, **kwargs)#: Sets the color of the inlet faces.

interface_faces(*args, **kwargs)#: Sets the color of grid interface faces.

interior_faces(*args, **kwargs)#: Sets the color of the interior faces.

internal_faces(*args, **kwargs)#: Sets the color of the internal interface faces.

list(*args, **kwargs)#: Lists the colors available for the selected zone type.

outlet_faces(*args, **kwargs)#: Sets the color of the outlet faces.

overset_faces(*args, **kwargs)#: Sets the color of the overset faces.

periodic_faces(*args, **kwargs)#: Sets the color of periodic faces.

rans_les_interface_faces(*args, **kwargs)#: Sets the color of RANS/LES interface faces.

reset_colors(*args, **kwargs)#: Resets the individual grid surface colors to the defaults.

reset_user_colors(*args, **kwargs)#: Resets individual grid surface colors to the defaults.

show_user_colors(*args, **kwargs)#: Lists the current defined user colors.

skip_label(*args, **kwargs)#: Sets the number of labels to be skipped in the colormap scale.

surface(*args, **kwargs)#: Sets the color of surfaces.

symmetry_faces(*args, **kwargs)#: Sets the color of symmetric faces.

traction_faces(*args, **kwargs)#: Sets the color for traction faces.

user_color(*args, **kwargs)#: Enables you to change the color for the specified zone.

wall_faces(*args, **kwargs)#: Sets color for wall faces.

edges(*args, **kwargs)#: Enables/disables the display of face/cell edges.

filled_grid(*args, **kwargs)#: Enables/disables the filled grid option. When a grid is not filled, only its outline is drawn.

highlight_tree_selection(*args, **kwargs)#: Turn on/off outline display of tree selection in graphics window.

class lights(path, service)#

Bases: TUIMenu

Enters the lights menu.

Methods:

`headlight_on`(args, *kwargs)	Turns the light that moves with the camera on or off.
`lighting_interpolation`(args, *kwargs)	Sets the lighting interpolation method to be used.
`lights_on`(args, *kwargs)	Enables/disables the display of all lights.
`set_ambient_color`(args, *kwargs)	Sets the ambient color for the scene.
`set_light`(args, *kwargs)	Adds or modifies a directional, colored light.

headlight_on(*args, **kwargs)#: Turns the light that moves with the camera on or off. This is controlled automatically by default.

lighting_interpolation(*args, **kwargs)#: Sets the lighting interpolation method to be used. You can choose automatic, flat, gouraud, or phong. “Automatic” automatically picks the best lighting method for the display in the graphics window. Flat is the most basic method, and the others are more sophisticated and provide smoother gradations of color.

lights_on(*args, **kwargs)#: Enables/disables the display of all lights.

set_ambient_color(*args, **kwargs)#: Sets the ambient color for the scene. The ambient color is the background light color in scene.

set_light(*args, **kwargs)#: Adds or modifies a directional, colored light.

line_weight(*args, **kwargs)#: Sets the line width factor for the window.

native_display_defaults(*args, **kwargs)#: Resets graphics window parameters to optimal settings for a local display. Used after setting parameters for a remote display with remote-display-defaults.

overlays(*args, **kwargs)#: Turns overlays on and off.

class picture(path, service)#

Bases: TUIMenu

Saves a hardcopy file of the active graphics window.

Classes:

`color_mode`(path, service)	Contains the available color modes.
`driver`(path, service)	Contains the available hardcopy formats.

Methods:

`dpi`(args, *kwargs)	Specifies the resolution in dots per inch for EPS and PostScript files.
`invert_background`(args, *kwargs)	Enables/disables the exchange of foreground/background colors for hardcopy files.
`jpeg_hardcopy_quality`(args, *kwargs)	Controls the size and quality of how JPEG files are saved based on a scale of 0-100, with zero being low quality small files and 100 being high quality larger files.
`landscape`(args, *kwargs)	Toggles between landscape or portrait orientation.
`preview`(args, *kwargs)	Applies the settings of the color-mode, invert-background, and landscape options to the currently active graphics window to preview the appearance of printed hardcopies.
`set_standard_resolution`(args, *kwargs)	Select from pre-defined resolution list.
`use_window_resolution`(args, *kwargs)	Disables/enables the use of the current graphics window resolution when saving an image of the graphics window.
`x_resolution`(args, *kwargs)	Sets the width of the raster format images in pixels (0 implies that the hardcopy should use the same resolution as the active graphics window).
`y_resolution`(args, *kwargs)	Sets the height of the raster format images in pixels (0 implies that the hardcopy should use the same resolution as the active graphics window).

class color_mode(path, service)#

Bases: TUIMenu

Contains the available color modes.

Methods:

`color`(args, *kwargs)	Selects full color and plots the hardcopy in color.
`gray_scale`(args, *kwargs)	Selects gray scale (that is, various shades of gray) and converts color to gray-scale for hardcopy.
`list`(args, *kwargs)	Displays the current hardcopy color mode.
`mono_chrome`(args, *kwargs)	Selects color to monochrome (black and white) for hardcopy.

color(*args, **kwargs)#: Selects full color and plots the hardcopy in color.

gray_scale(*args, **kwargs)#: Selects gray scale (that is, various shades of gray) and converts color to gray-scale for hardcopy.

list(*args, **kwargs)#: Displays the current hardcopy color mode.

mono_chrome(*args, **kwargs)#: Selects color to monochrome (black and white) for hardcopy.

dpi(*args, **kwargs)#: Specifies the resolution in dots per inch for EPS and PostScript files.

class driver(path, service)#

Bases: TUIMenu

Contains the available hardcopy formats.

Methods:

`avz`(args, *kwargs)	Use AVZ output for hardcopies.
`dump_window`(args, *kwargs)	Sets the command to dump a graphics window to a file.
`eps`(args, *kwargs)	Sets the Encapsulated PostScript format.
`glb`(args, *kwargs)	Produces GLB output for hardcopies.
`hsf`(args, *kwargs)	Produces HOOPS Visualize Stream Format (HSF) output for hardcopies.
`jpeg`(args, *kwargs)	Sets the JPEG image format.
`list`(args, *kwargs)	Displays the current hardcopy format.
`options`(args, *kwargs)	Enables you to set hardcopy options, such as landscape orientation, pen speed, and physical size.
`png`(args, *kwargs)	Sets the PNG image format.
`post_script`(args, *kwargs)	Sets the PostScript format.
`ppm`(args, *kwargs)	Sets the PPM format.
`tiff`(args, *kwargs)	Sets the TIFF format.
`vrml`(args, *kwargs)	Sets the VRML format.

Classes:

post_format(path, service)

Contains commands for setting the PostScript driver format and save files in PS files that can be printed quickly.

avz(*args, **kwargs)#: Use AVZ output for hardcopies.

dump_window(*args, **kwargs)#: Sets the command to dump a graphics window to a file.

eps(*args, **kwargs)#: Sets the Encapsulated PostScript format.

glb(*args, **kwargs)#: Produces GLB output for hardcopies.

hsf(*args, **kwargs)#: Produces HOOPS Visualize Stream Format (HSF) output for hardcopies.

jpeg(*args, **kwargs)#: Sets the JPEG image format.

list(*args, **kwargs)#: Displays the current hardcopy format.

options(*args, **kwargs)#: Enables you to set hardcopy options, such as landscape orientation, pen speed, and physical size. The options may be entered on one line if you separate them with commas.

png(*args, **kwargs)#: Sets the PNG image format.

class post_format(path, service)#

Bases: TUIMenu

Contains commands for setting the PostScript driver format and save files in PS files that can be printed quickly.

Methods:

`fast_raster`(args, *kwargs)	Enables a raster file that may be larger than the standard raster file, but will print much more quickly.
`raster`(args, *kwargs)	Enables the standard raster file.
`rle_raster`(args, *kwargs)	Enables a run-length encoded raster file that will be about the same size as the standard raster file, but will print slightly more quickly.
`vector`(args, *kwargs)	Enables the standard vector file.

fast_raster(*args, **kwargs)#: Enables a raster file that may be larger than the standard raster file, but will print much more quickly.

raster(*args, **kwargs)#: Enables the standard raster file.

rle_raster(*args, **kwargs)#: Enables a run-length encoded raster file that will be about the same size as the standard raster file, but will print slightly more quickly. This is the default file type.

vector(*args, **kwargs)#: Enables the standard vector file.

post_script(*args, **kwargs)#: Sets the PostScript format.

ppm(*args, **kwargs)#: Sets the PPM format.

tiff(*args, **kwargs)#: Sets the TIFF format.

vrml(*args, **kwargs)#: Sets the VRML format.

invert_background(*args, **kwargs)#: Enables/disables the exchange of foreground/background colors for hardcopy files.

jpeg_hardcopy_quality(*args, **kwargs)#: Controls the size and quality of how JPEG files are saved based on a scale of 0-100, with zero being low quality small files and 100 being high quality larger files.

landscape(*args, **kwargs)#: Toggles between landscape or portrait orientation.

preview(*args, **kwargs)#: Applies the settings of the color-mode, invert-background, and landscape options to the currently active graphics window to preview the appearance of printed hardcopies.

set_standard_resolution(*args, **kwargs)#: Select from pre-defined resolution list.

use_window_resolution(*args, **kwargs)#: Disables/enables the use of the current graphics window resolution when saving an image of the graphics window. If disabled, the resolution will be as specified for x-resolution and y-resolution.

x_resolution(*args, **kwargs)#: Sets the width of the raster format images in pixels (0 implies that the hardcopy should use the same resolution as the active graphics window).

y_resolution(*args, **kwargs)#: Sets the height of the raster format images in pixels (0 implies that the hardcopy should use the same resolution as the active graphics window).

quick_moves_algorithm(*args, **kwargs)#: Select quick moves algorithm for icons and helptext overlay.

re_render(*args, **kwargs)#: Re-renders the current window after modifying the variables in the set menu.

remote_display_defaults(*args, **kwargs)#: Adjusts graphics window parameters to optimal settings for a remote display. Restore parameters for local display using native-display-defaults.

class rendering_options(path, service)#

Bases: TUIMenu

Contains the commands that enable you to set options that determine how the scene is rendered.

Methods:

`animation_option`(args, *kwargs)	Enables you to specify the animation option as appropriate.
`auto_spin`(args, *kwargs)	Enables mouse view rotations to continue to spin the display after the button is released.
`color_map_alignment`(args, *kwargs)	Sets the color bar alignment.
`device_info`(args, *kwargs)	Prints out information about your graphics driver.
`double_buffering`(args, *kwargs)	Enables or disables double buffering.
`driver`(args, *kwargs)	Changes the current graphics driver.
`face_displacement`(args, *kwargs)	Sets the face displacement (in Z-buffer units along the camera Z-axis) for the displayed geometry when both faces and edges are displayed simultaneously.
`help_text_color`(args, *kwargs)	Sets the color of the help text on the screen.
`hidden_surface_method`(args, *kwargs)	Enables you to choose from among the hidden surface removal methods that are supported.
`hidden_surfaces`(args, *kwargs)	Enables/disables the display of hidden surfaces.
`outer_face_cull`(args, *kwargs)	Enables/disables the display of outer faces.
`set_rendering_options`(args, *kwargs)	Sets the rendering options.
`show_colormap`(args, *kwargs)	Enable/Disable colormap.
`surface_edge_visibility`(args, *kwargs)	Controls whether or not the mesh edges are drawn.

animation_option(*args, **kwargs)#: Enables you to specify the animation option as appropriate.

auto_spin(*args, **kwargs)#: Enables mouse view rotations to continue to spin the display after the button is released.

color_map_alignment(*args, **kwargs)#: Sets the color bar alignment.

device_info(*args, **kwargs)#: Prints out information about your graphics driver.

double_buffering(*args, **kwargs)#: Enables or disables double buffering. Double buffering dramatically reduces screen flicker during graphics updates. If your display hardware does not support double buffering and you turn this option on, double buffering will be done in software. Software double buffering uses extra memory.

driver(*args, **kwargs)#: Changes the current graphics driver. When enabling graphics display, you have various options: for Linux, the available drivers include opengl and x11; for Windows, the available drivers include opengl, dx11 (for DirectX 11), and msw (for Microsoft Windows). You can also disable the graphics display window by entering null. For a comprehensive list of the drivers available to you, press the Enter key at the driver> prompt. For any session that displays graphics in a graphics window and/or saves picture files, having the driver set to x11, msw, or null will cause the rendering / saving speed to be significantly slower.

face_displacement(*args, **kwargs)#: Sets the face displacement (in Z-buffer units along the camera Z-axis) for the displayed geometry when both faces and edges are displayed simultaneously.

help_text_color(*args, **kwargs)#: Sets the color of the help text on the screen. You can select black, default, or white.

hidden_surface_method(*args, **kwargs)#: Enables you to choose from among the hidden surface removal methods that are supported. These options (listed below) are display hardware dependent.

hidden_surfaces(*args, **kwargs)#: Enables/disables the display of hidden surfaces.

outer_face_cull(*args, **kwargs)#: Enables/disables the display of outer faces.

set_rendering_options(*args, **kwargs)#: Sets the rendering options.

show_colormap(*args, **kwargs)#: Enable/Disable colormap.

surface_edge_visibility(*args, **kwargs)#: Controls whether or not the mesh edges are drawn.

reset_graphics(*args, **kwargs)#: Resets the graphics system.

shrink_factor(*args, **kwargs)#: Sets shrinkage of both faces and cells. A value of zero indicates no shrinkage, while a value of one would shrink the face or cell to a point.

class styles(path, service)#

Bases: TUIMenu

Contains commands for setting the display style for the different types of nodes and faces that can be displayed.

Methods:

dummy(*args, **kwargs)

dummy(*args, **kwargs)#: .

title(*args, **kwargs)#: Sets the problem title.

windows(*args, **kwargs)#: Enters the windows options menu, which contains commands that enable you to customize the relative positions of sub-windows inside the active graphics window.

class set_grid(path, service)#

Bases: TUIMenu

Contains options controlling the display of the grid.

Methods:

`all_cells`(args, *kwargs)	Enables/disables the display of all cells.
`all_faces`(args, *kwargs)	Enables/disables the display of all faces.
`all_nodes`(args, *kwargs)	Enables/disables the display of all nodes.
`cell_quality`(args, *kwargs)	Sets the lower and upper bounds of quality for cells to be displayed.
`default`(args, *kwargs)	Resets the grid display parameters to their default values.
`face_quality`(args, *kwargs)	Sets the lower and upper bounds of quality for faces to be displayed.
`free`(args, *kwargs)	Enables/disables the drawing of faces/nodes that have no neighboring face on at least one edge.
`label_alignment`(args, *kwargs)	Sets the alignment of labels that appear in the graphics window.
`label_font`(args, *kwargs)	Sets the label font.
`label_scale`(args, *kwargs)	Scales the size of the label.
`labels`(args, *kwargs)	Enables/disables the display of labels.
`left_handed`(args, *kwargs)	Enables/disables the display of left-handed faces.
`list`(args, *kwargs)	Lists all the grid display settings.
`marked`(args, *kwargs)	Enables/disables the display of marked nodes.
`multi`(args, *kwargs)	Enables/disables the display of those faces/nodes that have more than one neighboring face on an edge.
`neighborhood`(args, *kwargs)	Sets the x, y, and z range to be within a specified neighborhood of a specified grid object.
`node_size`(args, *kwargs)	Sets the node symbol scaling factor.
`node_symbol`(args, *kwargs)	Specifies the node symbol.
`normal_scale`(args, *kwargs)	Sets the scale factor for face normals.
`normals`(args, *kwargs)	Enables/disables the display of face normals.
`refine`(args, *kwargs)	Enables/disables the display of those faces that have been marked for refinement.
`tagged`(args, *kwargs)	Enables/disables the display of tagged nodes.
`unmeshed`(args, *kwargs)	Enables/disables the display of nodes and faces that have not been meshed.
`unused`(args, *kwargs)	Enables/disables the display of unused nodes.
`x_range`(args, *kwargs)	Limits the display of grid objects to the specified x-range.
`y_range`(args, *kwargs)	Limits the display of grid objects to the specified y-range.
`z_range`(args, *kwargs)	Limits the display of grid objects to the specified z-range.

all_cells(*args, **kwargs)#: Enables/disables the display of all cells.

all_faces(*args, **kwargs)#: Enables/disables the display of all faces.

all_nodes(*args, **kwargs)#: Enables/disables the display of all nodes.

cell_quality(*args, **kwargs)#: Sets the lower and upper bounds of quality for cells to be displayed. Only cells with a quality measure value (for example, skewness) within the specified range will be displayed.

default(*args, **kwargs)#: Resets the grid display parameters to their default values.

face_quality(*args, **kwargs)#: Sets the lower and upper bounds of quality for faces to be displayed. Only faces with a quality measure value (for example, skewness) within the specified range will be displayed.

free(*args, **kwargs)#: Enables/disables the drawing of faces/nodes that have no neighboring face on at least one edge.

label_alignment(*args, **kwargs)#: Sets the alignment of labels that appear in the graphics window. By default, the label is centered on the node, cell, and so on, to which the label refers. You can specify *,ˆ, v, <, > for center, top, bottom, left, or right. You can also combine symbols—for example, “*v” for bottom center.

label_font(*args, **kwargs)#: Sets the label font. By default, all labels appear in “sans serif” font. Some other choices are roman, typewriter, and stroked.

label_scale(*args, **kwargs)#: Scales the size of the label.

labels(*args, **kwargs)#: Enables/disables the display of labels.

left_handed(*args, **kwargs)#: Enables/disables the display of left-handed faces.

list(*args, **kwargs)#: Lists all the grid display settings.

marked(*args, **kwargs)#: Enables/disables the display of marked nodes.

multi(*args, **kwargs)#: Enables/disables the display of those faces/nodes that have more than one neighboring face on an edge.

neighborhood(*args, **kwargs)#: Sets the x, y, and z range to be within a specified neighborhood of a specified grid object.

node_size(*args, **kwargs)#: Sets the node symbol scaling factor.

node_symbol(*args, **kwargs)#: Specifies the node symbol.

normal_scale(*args, **kwargs)#: Sets the scale factor for face normals.

normals(*args, **kwargs)#: Enables/disables the display of face normals.

refine(*args, **kwargs)#: Enables/disables the display of those faces that have been marked for refinement.

tagged(*args, **kwargs)#: Enables/disables the display of tagged nodes.

unmeshed(*args, **kwargs)#: Enables/disables the display of nodes and faces that have not been meshed.

unused(*args, **kwargs)#: Enables/disables the display of unused nodes.

x_range(*args, **kwargs)#: Limits the display of grid objects to the specified x-range.

y_range(*args, **kwargs)#: Limits the display of grid objects to the specified y-range.

z_range(*args, **kwargs)#: Limits the display of grid objects to the specified z-range.

set_list_tree_separator(*args, **kwargs)#: Sets the separator character to be used to determine the common prefix for items listed in the selection lists, when the tree view is used.

show_hide_clipping_plane_triad(*args, **kwargs)#

update_layout(*args, **kwargs)#: Update the fluent layout.

class update_scene(path, service)#

Bases: TUIMenu

Contains commands that enable you to update the scene description.

Methods:

`delete`(args, *kwargs)	Deletes the geometry selected using the select-geometry command.
`display`(args, *kwargs)	Displays the geometry selected using the select-geometry command.
`draw_frame`(args, *kwargs)	Enables/disables the drawing of the bounding frame.
`iso_sweep`(args, *kwargs)	Changes iso-sweep values.
`overlays`(args, *kwargs)	Enables/disables the overlays option.
`pathline`(args, *kwargs)	Changes pathline attributes.
`select_geometry`(args, *kwargs)	Enables you to select the geometry to be updated.
`set_frame`(args, *kwargs)	Enables you to change the frame options.
`time`(args, *kwargs)	Changes time-step value.
`transform`(args, *kwargs)	Enables you to apply the transformation matrix to the geometry selected using the select-geometry command.

delete(*args, **kwargs)#: Deletes the geometry selected using the select-geometry command.

display(*args, **kwargs)#: Displays the geometry selected using the select-geometry command.

draw_frame(*args, **kwargs)#: Enables/disables the drawing of the bounding frame.

iso_sweep(*args, **kwargs)#: Changes iso-sweep values.

overlays(*args, **kwargs)#: Enables/disables the overlays option.

pathline(*args, **kwargs)#: Changes pathline attributes.

select_geometry(*args, **kwargs)#: Enables you to select the geometry to be updated.

set_frame(*args, **kwargs)#: Enables you to change the frame options.

time(*args, **kwargs)#: Changes time-step value.

transform(*args, **kwargs)#: Enables you to apply the transformation matrix to the geometry selected using the select-geometry command.

views(*args, **kwargs)#: Enters the view window options menu.

class xy_plot(path, service)#

Bases: TUIMenu

Enters the XY plot menu.

Methods:

`cell_distribution`(args, *kwargs)	Plots a histogram of cell quality.
`face_distribution`(args, *kwargs)	Plots a histogram of face quality.
`file`(args, *kwargs)	Enables you to choose a file from which to create an xy plot.
`set`(args, *kwargs)	Enters the set window options menu.

cell_distribution(*args, **kwargs)#: Plots a histogram of cell quality.

face_distribution(*args, **kwargs)#: Plots a histogram of face quality.

file(*args, **kwargs)#: Enables you to choose a file from which to create an xy plot.

set(*args, **kwargs)#: Enters the set window options menu.

class zones(path, service)#

Bases: TUIMenu

Contains commands for displaying zones.

Methods:

`display_neighborhood`(args, *kwargs)	Displays the zones that are in the neighborhood of the selected zones.
`display_similar_area`(args, *kwargs)	Displays the zones with similar area to the selected zone area.
`hide_zones`(args, *kwargs)	Hides the selected zones in the display.
`isolate_zones`(args, *kwargs)	Displays only the selected zones.
`make_transparent`(args, *kwargs)	Makes the geometry transparent so that internal zones are visible.
`select_all_visible`(args, *kwargs)	Selects all the visible zones in the graphics window.
`show_all`(args, *kwargs)	Unhides all the zones in the geometry and displays them.
`toggle_color_mode`(args, *kwargs)	Toggles the colors of the geometry.
`toggle_color_palette`(args, *kwargs)	Toggles the color palette of the geometry.

display_neighborhood(*args, **kwargs)#: Displays the zones that are in the neighborhood of the selected zones. The neighboring zones have to be in contact, or intersecting the selected zone.

display_similar_area(*args, **kwargs)#: Displays the zones with similar area to the selected zone area.

hide_zones(*args, **kwargs)#: Hides the selected zones in the display.

isolate_zones(*args, **kwargs)#: Displays only the selected zones.

make_transparent(*args, **kwargs)#: Makes the geometry transparent so that internal zones are visible. This command works as a toggle undoing the transparency of the previously selected zones.

select_all_visible(*args, **kwargs)#: Selects all the visible zones in the graphics window.

show_all(*args, **kwargs)#: Unhides all the zones in the geometry and displays them.

toggle_color_mode(*args, **kwargs)#: Toggles the colors of the geometry. In one mode geometry is colored object-wise while in the other mode it is colored zone-wise.

toggle_color_palette(*args, **kwargs)#: Toggles the color palette of the geometry.

exit(*args, **kwargs)#: Exits the program.

class file(path, service)#

Bases: TUIMenu

Enter the file menu.

Methods:

`append_mesh`(args, *kwargs)	Enables you to append the mesh files.
`append_meshes_by_tmerge`(args, *kwargs)	Enables you to append the mesh files using the tmerge utility.
`cff_files`(args, *kwargs)	Answering yes will set the Common Fluids Format (CFF) as the default file format for reading and writing case/data files.
`confirm_overwrite`(args, *kwargs)	Controls whether attempts to overwrite existing files require confirmation.
`file_format`(args, *kwargs)	Enables/disables the writing of binary files.
`filter_list`(args, *kwargs)	Lists the names of the converters that are used to change foreign mesh (while importing mesh files from third-party packages) files.
`filter_options`(args, *kwargs)	Enables you to change the extension (such as .cas, .msh, .neu) and arguments used with a specified filter.
`hdf_files`(args, *kwargs)	Indicate whether to write Ansys common fluids format (CFF) files or legacy case files.
`load_act_tool`(args, *kwargs)	Loads the Ansys ACT tool.
`read_boundary_mesh`(args, *kwargs)	Enables you to read a boundary mesh.
`read_case`(args, *kwargs)	Enables you to read the mesh contained in a case file.
`read_domains`(args, *kwargs)	Enables you to read domain files.
`read_journal`(args, *kwargs)	Enables you to read a journal file into the program.
`read_mesh`(args, *kwargs)	Enables you to read a mesh file.
`read_mesh_vars`(args, *kwargs)	Reads mesh varaibles from a mesh file.
`read_meshes_by_tmerge`(args, *kwargs)	Uses the tmerge utility to read the mesh contained in two or more separate files.
`read_multi_bound_mesh`(args, *kwargs)	Enables you to read multiple boundary mesh files into the meshing mode.
`read_multiple_mesh`(args, *kwargs)	Enables you to read in two or more files together and have the complete mesh assembled for you, if the mesh files are contained in two or more separate files.
`read_options`(args, *kwargs)	Enables you to set the following options for reading mesh files:.
`read_size_field`(args, *kwargs)	Enables you to read in a size field file.
`set_idle_timeout`(args, *kwargs)	Allows you to set an idle timeout so that an idle ANSYS Fluent session will automatically save and close after the specified time.
`set_tui_version`(args, *kwargs)	Allows you to improve backwards compatibility for journal files.
`show_configuration`(args, *kwargs)	Displays the current release and version information.
`start_journal`(args, *kwargs)	Starts recording all input and writes it to a file.
`start_transcript`(args, *kwargs)	Starts recording input and output in a file.
`stop_journal`(args, *kwargs)	Stops recording input and closes the journal file.
`stop_transcript`(args, *kwargs)	Stops recording input and output, and closes the transcript file.
`write_boundaries`(args, *kwargs)	Enables you to write the specified boundaries into a mesh file.
`write_case`(args, *kwargs)	Enables you to write a case file that can be read by Fluent.
`write_domains`(args, *kwargs)	Enables you to write all the mesh domains (except global) into a file that can be read.
`write_mesh`(args, *kwargs)	Enables you to write a mesh file.
`write_mesh_vars`(args, *kwargs)	Writes mesh varaibles to a file.
`write_options`(args, *kwargs)	Allows you to enable or disable the enforce mesh topology option for writing mesh/case files.
`write_size_field`(args, *kwargs)	Enables you to write a size field file.

Classes:

`checkpoint`(path, service)	Checkpoint stores the mesh in the memory instead of writing it to a file.
`export`(path, service)	Exports case and data information.
`import_`(path, service)	Enables you to import mesh information generated by some CAD packages (Ansys, I-deas, NASTRAN, PATRAN, and HYPERMESH), as well as mesh information in the CGNS (CFD general notation system) format.
`project`(path, service)	Enter to create new project, open project, save and archive project.

append_mesh(*args, **kwargs)#: Enables you to append the mesh files. This command is available only after a mesh file has been read in.

append_meshes_by_tmerge(*args, **kwargs)#: Enables you to append the mesh files using the tmerge utility. This command is available only after a mesh file has been read in.

cff_files(*args, **kwargs)#: Answering yes will set the Common Fluids Format (CFF) as the default file format for reading and writing case/data files.

class checkpoint(path, service)#

Bases: TUIMenu

Checkpoint stores the mesh in the memory instead of writing it to a file.

Methods:

`delete_checkpoint`(args, *kwargs)	Delete checkpoint.
`list_checkpoint_names`(args, *kwargs)	Get all checkpoint names.
`restore_checkpoint`(args, *kwargs)	Restore to checkpoint.
`write_checkpoint`(args, *kwargs)	Write checkpoint.

delete_checkpoint(*args, **kwargs)#: Delete checkpoint.

list_checkpoint_names(*args, **kwargs)#: Get all checkpoint names.

restore_checkpoint(*args, **kwargs)#: Restore to checkpoint.

write_checkpoint(*args, **kwargs)#: Write checkpoint.

confirm_overwrite(*args, **kwargs)#: Controls whether attempts to overwrite existing files require confirmation. If you do not want ANSYS Fluent to ask you for confirmation before it overwrites existing files, you can enter the file/confirm-overwrite? text command and answer no.

class export(path, service)#

Bases: TUIMenu

Exports case and data information.

Methods:

`ansys`(args, *kwargs)	Write a Ansys mesh file.
`hypermesh`(args, *kwargs)	Write a HYPERMESH ascii file.
`nastran`(args, *kwargs)	Writes a NASTRAN file.
`patran`(args, *kwargs)	Write a PATRAN mesh file.
`stl`(args, *kwargs)	Write a STL boundary mesh file.

ansys(*args, **kwargs)#: Write a Ansys mesh file.

hypermesh(*args, **kwargs)#: Write a HYPERMESH ascii file.

nastran(*args, **kwargs)#: Writes a NASTRAN file.

patran(*args, **kwargs)#: Write a PATRAN mesh file.

stl(*args, **kwargs)#: Write a STL boundary mesh file.

file_format(*args, **kwargs)#: Enables/disables the writing of binary files.

filter_list(*args, **kwargs)#: Lists the names of the converters that are used to change foreign mesh (while importing mesh files from third-party packages) files.

filter_options(*args, **kwargs)#: Enables you to change the extension (such as .cas, .msh, .neu) and arguments used with a specified filter. For example, if you saved the PATRAN files with a .NEU extension instead of .neu, you can substitute or add .NEU to the extension list. For some filters, one of the arguments will be the dimensionality of the grid. When you use the filter-options command for such a filter, you will see a default dimensionality argument of -d a. The dimension will automatically be determined, so you need not substitute 2 or 3 for a.

hdf_files(*args, **kwargs)#: Indicate whether to write Ansys common fluids format (CFF) files or legacy case files.

class import_(path, service)#

Bases: TUIMenu

Enables you to import mesh information generated by some CAD packages (Ansys, I-deas, NASTRAN, PATRAN, and HYPERMESH), as well as mesh information in the CGNS (CFD general notation system) format.

Methods:

`ansys_surf_mesh`(args, *kwargs)	Enables you to read a Ansys surface mesh file.
`ansys_vol_mesh`(args, *kwargs)	Enables you to read a Ansys volume mesh file.
`cad`(args, *kwargs)	Enables you to import CAD files based on the options set.
`cad_geometry`(args, *kwargs)	Enables you to import CAD files based on the options set.
`cgns_surf_mesh`(args, *kwargs)	Enables you to read a CGNS surface mesh file.
`cgns_vol_mesh`(args, *kwargs)	Enables you to read a CGNS volume mesh file.
`fidap_surf_mesh`(args, *kwargs)	Enables you to read a FIDAP surface mesh file.
`fidap_vol_mesh`(args, *kwargs)	Enables you to read a FIDAP volume mesh file.
`fl_uns2_mesh`(args, *kwargs)	Enables you to read a Fluent UNS V2 case file.
`fluent_2d_mesh`(args, *kwargs)	Enables you to read a 2D mesh into the 3D version.
`fluent_3d_mesh`(args, *kwargs)	Read a 3D mesh.
`gambit_surf_mesh`(args, *kwargs)	Enables you to read a GAMBIT surface mesh file.
`gambit_vol_mesh`(args, *kwargs)	Enables you to read a GAMBIT volume mesh file.
`hypermesh_surf_mesh`(args, *kwargs)	Enables you to read a HYPERMESH surface mesh file.
`hypermesh_vol_mesh`(args, *kwargs)	Enables you to read a HYPERMESH volume mesh file.
`ideas_surf_mesh`(args, *kwargs)	Enables you to read an I-deas surface mesh file.
`ideas_vol_mesh`(args, *kwargs)	Enables you to read an I-deas volume mesh file.
`nastran_surf_mesh`(args, *kwargs)	Enables you to read a NASTRAN surface mesh file.
`nastran_vol_mesh`(args, *kwargs)	Enables you to read a NASTRAN volume mesh file.
`patran_surf_mesh`(args, *kwargs)	Enables you to read a PATRAN surface mesh file.
`patran_vol_mesh`(args, *kwargs)	Enables you to read a PATRAN volume mesh file.
`reimport_last_with_cfd_surface_mesh`(*args, ...)	Reimport CAD using the size field.
`stl`(args, *kwargs)	Read a surface mesh from a stereolithography (STL) file.

Classes:

cad_options(path, service)

Contains additional options for importing CAD files.

ansys_surf_mesh(*args, **kwargs)#: Enables you to read a Ansys surface mesh file.

ansys_vol_mesh(*args, **kwargs)#: Enables you to read a Ansys volume mesh file.

cad(*args, **kwargs)#: Enables you to import CAD files based on the options set.

cad_geometry(*args, **kwargs)#: Enables you to import CAD files based on the options set.

class cad_options(path, service)#

Bases: TUIMenu

Contains additional options for importing CAD files.

Methods:

`continue_on_error`(args, *kwargs)	Enables you to continue the import of the CAD file(s), despite errors or problems creating the faceting on certain surfaces, or other issues.
`create_cad_assemblies`(args, *kwargs)	Enables creating the CAD Assemblies tree on CAD import.
`create_label_per_body_during_cad_faceting`(...)	Create label Per Body during cad faceting.
`derive_zone_name_from_object_scope`(*args, ...)	Enables zones without Named Selections to inherit the object name on import.
`double_connected_face_label`(args, *kwargs)	Adds the specified label to the name of double-connected face zones (face zones shared by two bodies).
`enclosure_symm_processing`(args, *kwargs)	Enables processing of enclosure and symmetry named selections during import.
`extract_features`(args, *kwargs)	Enables feature extraction from the CAD model on import.
`import_body_names`(args, *kwargs)	Enables import of Body names from the CAD files.
`import_curvature_data_from_CAD`(args, *kwargs)	Enables importing of the curvature data from the nodes of the CAD facets.
`import_label_for_body_named_selection`(*args, ...)	Import face zone labels for body named selections.
`import_part_names`(args, *kwargs)	Enables import of Part names from the CAD file(s).
`merge_nodes`(args, *kwargs)	Enables the merging of geometry object nodes during CAD import.
`merge_objects_per_body_named_selection`(...)	Merge Objects per body named selection.
`modify_all_duplicate_names`(args, *kwargs)	Enables you to modify all duplicate object/zone names by adding incremental integers as suffix.
`name_separator_character`(args, *kwargs)	:.
`named_selection_tessellation_failure`(*args, ...)	Set named selection for CFD surface mesh failures.
`named_selections`(args, *kwargs)	Enables you to import Named Selections from the CAD file(s), including Named Selections from Ansys DesignModeler, publications from CATIA, and so on.
`object_type`(args, *kwargs)	Enables the setting of object type on import.
`one_face_zone_per`(args, *kwargs)	Enables you to create one face zone per body/face/object to be imported.
`one_object_per`(args, *kwargs)	Enables you to create one object per body/part/file/selection to be imported.
`read_all_cad_in_subdirectories`(args, *kwargs)	When enabled, all files in the specified directory as well as in its subdirectories will be imported.
`reconstruct_topology`(args, *kwargs)	Reconstruct topology for STL files.
`replacement_character`(args, *kwargs)	Name replacement character.
`save_PMDB`(args, *kwargs)	Saves a PMDB (*.pmdb) file in the directory containing the CAD files imported.
`separate_features_by_type`(args, *kwargs)	Enables separation of feature edges based on angle, connectivity, and named selections on import.
`single_connected_edge_label`(args, *kwargs)	Adds the specified label to the name of single-connected edge zones (edge zones referenced by a single face).
`strip_file_name_extension_from_naming`(*args, ...)	Removes the extension of the CAD files from the object/face zone names on import.
`strip_path_prefix_from_names`(args, *kwargs)	Enables you to remove the path prefix from the object/face zone names on import.
`tessellation`(args, *kwargs)	Enables you to control the tessellation (faceting) during file import.
`use_body_names`(args, *kwargs)	Use body names for CAD files.
`use_collection_names`(args, *kwargs)	Enables you to use the Named Selections for the object/zone names on import.
`use_component_names`(args, *kwargs)	Enables you to add the component (part or assembly) names to the object/zone names on import.
`use_part_names`(args, *kwargs)	Enables you to choose whether to add the part names from the CAD file to the object and zone names on import.
`use_part_or_body_names_as_suffix_to_named_selections`(...)	Part or Body names are used as suffix for named selections spanning over multiple parts or bodies.

continue_on_error(*args, **kwargs)#: Enables you to continue the import of the CAD file(s), despite errors or problems creating the faceting on certain surfaces, or other issues. This option is disabled by default.

create_cad_assemblies(*args, **kwargs)#: Enables creating the CAD Assemblies tree on CAD import. The CAD Assemblies tree represents the CAD tree as it is presented in the CAD package in which it was created. All sub-assembly levels from the CAD are maintained on import in Fluent Meshing. For commands specific to the CAD assemblies, refer to cad-assemblies/.

create_label_per_body_during_cad_faceting(*args, **kwargs)#: Create label Per Body during cad faceting.

derive_zone_name_from_object_scope(*args, **kwargs)#: Enables zones without Named Selections to inherit the object name on import. This option is disabled by default.

double_connected_face_label(*args, **kwargs)#: Adds the specified label to the name of double-connected face zones (face zones shared by two bodies).

enclosure_symm_processing(*args, **kwargs)#: Enables processing of enclosure and symmetry named selections during import. This option is disabled by default. This option is applicable only to Ansys DesignModeler (*.agdb) files.

extract_features(*args, **kwargs)#: Enables feature extraction from the CAD model on import. You can choose to disable this, if desired. Specify an appropriate value for feature angle. The default value is 40.

import_body_names(*args, **kwargs)#: Enables import of Body names from the CAD files. This option is enabled by default. Any renaming of Body names in Ansys Mechanical/Ansys Meshing prior to the export of the mechdat/meshdat files is ignored during import. Only original Body names will be imported.

import_curvature_data_from_CAD(*args, **kwargs)#: Enables importing of the curvature data from the nodes of the CAD facets. You can choose to disable this, if desired.

import_label_for_body_named_selection(*args, **kwargs)#: Import face zone labels for body named selections.

import_part_names(*args, **kwargs)#: Enables import of Part names from the CAD file(s). This option is enabled by default. Any renaming of Part names in Ansys Mechanical/Ansys Meshing prior to the export of the mechdat/meshdat files is ignored during import. Only original Part names will be imported.

merge_nodes(*args, **kwargs)#: Enables the merging of geometry object nodes during CAD import. This option is enabled by default. This option can be optionally enabled/disabled only when geometry objects are imported using the CAD Faceting option for CAD import. Mesh object nodes will always be merged when the CFD Surface Mesh is selected for CAD import.

merge_objects_per_body_named_selection(*args, **kwargs)#: Merge Objects per body named selection.

modify_all_duplicate_names(*args, **kwargs)#: Enables you to modify all duplicate object/zone names by adding incremental integers as suffix. This option is disabled by default.

name_separator_character(*args, **kwargs)#: :.

named_selection_tessellation_failure(*args, **kwargs)#: Set named selection for CFD surface mesh failures.

named_selections(*args, **kwargs)#: Enables you to import Named Selections from the CAD file(s), including Named Selections from Ansys DesignModeler, publications from CATIA, and so on. You can additionally choose to ignore import of certain Named Selections based on the pattern specified (for example, Layer* to ignore layer Named Selections from CATIA), or by specifying multiple wild cards (for example, ^(Color|Layer|Material).* to remove color, layer, and material Named Selections from CATIA).

object_type(*args, **kwargs)#: Enables the setting of object type on import. The options available are auto, geometry, and mesh. The default setting is auto based on the tessellation method selected: geometry objects will be created when the cad-faceting method is used, while mesh objects will be created when the cfd-surface-mesh method is used.

one_face_zone_per(*args, **kwargs)#: Enables you to create one face zone per body/face/object to be imported.

one_object_per(*args, **kwargs)#: Enables you to create one object per body/part/file/selection to be imported. The default program-controlled option allows the software to make the appropriate choice. This option makes a choice between per body and per part based on whether shared topology is off or on, respectively. For Ansys ICEM CFD files (*.tin), set the object granularity to one object per selection.

read_all_cad_in_subdirectories(*args, **kwargs)#: When enabled, all files in the specified directory as well as in its subdirectories will be imported. This option is disabled by default.

reconstruct_topology(*args, **kwargs)#: Reconstruct topology for STL files.

replacement_character(*args, **kwargs)#: Name replacement character.

save_PMDB(*args, **kwargs)#: Saves a PMDB (*.pmdb) file in the directory containing the CAD files imported. You can use this file to import the same CAD file(s) again with different options set, for a quicker import than the full import. This option is disabled by default. Some options will not be available any more once the model is imported from a PMDB file (for example, enclosure-symm-processing?), since they are processed before the PMDB file is created.

separate_features_by_type(*args, **kwargs)#: Enables separation of feature edges based on angle, connectivity, and named selections on import. Edge zone names will have suitable suffixes depending on separation criteria, order of zones, existing zone names and other import options selected.

single_connected_edge_label(*args, **kwargs)#: Adds the specified label to the name of single-connected edge zones (edge zones referenced by a single face).

strip_file_name_extension_from_naming(*args, **kwargs)#: Removes the extension of the CAD files from the object/face zone names on import. This option is disabled by default.

strip_path_prefix_from_names(*args, **kwargs)#: Enables you to remove the path prefix from the object/face zone names on import. The default setting is auto which removes the path prefix from object/face zone names when the object creation granularity is set to one object per file. You can also explicitly select yes or no.

tessellation(*args, **kwargs)#: Enables you to control the tessellation (faceting) during file import. You can select either cad-faceting or cfd-surface-mesh. CAD faceting enables you to control the tessellation based on the CAD faceting tolerance and maximum facet size specified. CFD Surface Mesh enables you to use a size field file, (Use size field file?). If you enter yes, specify the size field file to be read. If you do not want to use a size field file, you can obtain conformal faceting based on the underlying curve and surface curvature (using the minimum and maximum facet sizes, and the facet curvature normal angle specified) and edge proximity (using the cells per gap specified). You can also save a size field in a file (size field is computed based on the specified parameters; that is, Min Size, Max Size, Curvature Normal Angle, Cells Per Gap).

use_body_names(*args, **kwargs)#: Use body names for CAD files.

use_collection_names(*args, **kwargs)#: Enables you to use the Named Selections for the object/zone names on import. Select auto, no, or yes. The default selection is auto where the Named Selection will be used as the object/zone name, except when the object creation granularity is set to one object per file.

use_component_names(*args, **kwargs)#: Enables you to add the component (part or assembly) names to the object/zone names on import. Select auto, no, or yes. The default selection is auto where the component name will be added to the object/zone name.

use_part_names(*args, **kwargs)#: Enables you to choose whether to add the part names from the CAD file to the object and zone names on import. The default setting is auto which adds the part names to both object and zone names when object creation granularity is set to body. When the object creation granularity is set to part or file, the part names are not added to the zone names, face zone labels, or the region names, by default. You can also explicitly select yes or no.

use_part_or_body_names_as_suffix_to_named_selections(*args, **kwargs)#: Part or Body names are used as suffix for named selections spanning over multiple parts or bodies.

cgns_surf_mesh(*args, **kwargs)#: Enables you to read a CGNS surface mesh file.

cgns_vol_mesh(*args, **kwargs)#: Enables you to read a CGNS volume mesh file.

fidap_surf_mesh(*args, **kwargs)#: Enables you to read a FIDAP surface mesh file.

fidap_vol_mesh(*args, **kwargs)#: Enables you to read a FIDAP volume mesh file.

fl_uns2_mesh(*args, **kwargs)#: Enables you to read a Fluent UNS V2 case file.

fluent_2d_mesh(*args, **kwargs)#: Enables you to read a 2D mesh into the 3D version.

fluent_3d_mesh(*args, **kwargs)#: Read a 3D mesh.

gambit_surf_mesh(*args, **kwargs)#: Enables you to read a GAMBIT surface mesh file.

gambit_vol_mesh(*args, **kwargs)#: Enables you to read a GAMBIT volume mesh file.

hypermesh_surf_mesh(*args, **kwargs)#: Enables you to read a HYPERMESH surface mesh file.

hypermesh_vol_mesh(*args, **kwargs)#: Enables you to read a HYPERMESH volume mesh file.

ideas_surf_mesh(*args, **kwargs)#: Enables you to read an I-deas surface mesh file.

ideas_vol_mesh(*args, **kwargs)#: Enables you to read an I-deas volume mesh file.

nastran_surf_mesh(*args, **kwargs)#: Enables you to read a NASTRAN surface mesh file.

nastran_vol_mesh(*args, **kwargs)#: Enables you to read a NASTRAN volume mesh file.

patran_surf_mesh(*args, **kwargs)#: Enables you to read a PATRAN surface mesh file.

patran_vol_mesh(*args, **kwargs)#: Enables you to read a PATRAN volume mesh file.

reimport_last_with_cfd_surface_mesh(*args, **kwargs)#: Reimport CAD using the size field.

stl(*args, **kwargs)#: Read a surface mesh from a stereolithography (STL) file.

load_act_tool(*args, **kwargs)#: Loads the Ansys ACT tool.

class project(path, service)#

Bases: TUIMenu

Enter to create new project, open project, save and archive project.

Methods:

`archive`(args, *kwargs)	Archive Project.
`new`(args, *kwargs)	Create New Project.
`open`(args, *kwargs)	Open project.
`save`(args, *kwargs)	Save Project.
`save_as`(args, *kwargs)	Save As Project.
`save_as_copy`(args, *kwargs)	Save As Copy.

archive(*args, **kwargs)#: Archive Project.

new(*args, **kwargs)#: Create New Project.

open(*args, **kwargs)#: Open project.

save(*args, **kwargs)#: Save Project.

save_as(*args, **kwargs)#: Save As Project.

save_as_copy(*args, **kwargs)#: Save As Copy.

read_boundary_mesh(*args, **kwargs)#: Enables you to read a boundary mesh. If the boundary mesh is contained in two or more separate files, you can read them in together and assemble the complete boundary mesh. This option is also convenient if you want to reuse the boundary mesh from a file containing a large volume mesh. The naming of face zones can be controlled by Named Selections defined in Ansys Workbench. For details on exporting faceted geometry from Ansys Workbench, refer to the Ansys Workbench Help.

read_case(*args, **kwargs)#: Enables you to read the mesh contained in a case file. Cell hierarchy in case files adapted in the solution mode will be lost when they are read in the meshing mode. Case files containing polyhedral cells can also be read in the meshing mode of Fluent. You can display the polyhedral mesh, perform certain mesh manipulation operations, check the mesh quality, and so on.

read_domains(*args, **kwargs)#: Enables you to read domain files. Each mesh file written by Fluent has a domain section. A domain file is the domain section of the mesh file and is written as a separate file. It contains a list of node, face, and cell zone IDs that make up each domain in the mesh. If a domain that is being read already exists in the mesh, a warning message is displayed. Fluent verifies if the zones defining the domains exist in the mesh. If not, it will display a warning message.

read_journal(*args, **kwargs)#: Enables you to read a journal file into the program. The read-journal command always loads the file in the main (that is, top-level) menu, regardless of where you are in the menu hierarchy when you invoke it.

read_mesh(*args, **kwargs)#: Enables you to read a mesh file. You can also use this command to read a Fluent mesh file created with GAMBIT, or to read the mesh available in a Fluent case file. Reading a case file as a mesh file will result in loss of boundary condition data as the mesh file does not contain any information on boundary conditions. Case files containing polyhedral cells can also be read in the meshing mode of Fluent. You can display the polyhedral mesh, perform certain mesh manipulation operations, check the mesh quality, and so on. Important: You cannot read meshes from solvers that have been adapted using hanging nodes. To read one of these meshes in the meshing mode in Fluent, coarsen the mesh within the solver until you have recovered the original unadapted grid. The naming of face zones can be controlled by Named Selections defined in Ansys Workbench. For details on exporting faceted geometry from Ansys Workbench, refer to the Ansys Workbench Help.

read_mesh_vars(*args, **kwargs)#: Reads mesh varaibles from a mesh file.

read_meshes_by_tmerge(*args, **kwargs)#: Uses the tmerge utility to read the mesh contained in two or more separate files. It enables you to read the mesh files together and helps assemble the complete mesh.

read_multi_bound_mesh(*args, **kwargs)#: Enables you to read multiple boundary mesh files into the meshing mode.

read_multiple_mesh(*args, **kwargs)#: Enables you to read in two or more files together and have the complete mesh assembled for you, if the mesh files are contained in two or more separate files. For example, if you are going to create a hybrid mesh by reading in a triangular boundary mesh and a volume mesh consisting of hexahedral cells, you can read both files at the same time using this command.

read_options(*args, **kwargs)#: Enables you to set the following options for reading mesh files:.

read_size_field(*args, **kwargs)#: Enables you to read in a size field file. If you read a size-field file after scaling the model, ensure that the size-field file is appropriate for the scaled model (size-field vertices should match the scaled model).

set_idle_timeout(*args, **kwargs)#: Allows you to set an idle timeout so that an idle ANSYS Fluent session will automatically save and close after the specified time.

set_tui_version(*args, **kwargs)#: Allows you to improve backwards compatibility for journal files. This command hides any new TUI prompts that are added at a future release of ANSYS Fluent and reverts to the arguments of the release that you specify using the command (within two full releases of the current release). The command is automatically added to a journal file as soon as you start the recording. See for details.

show_configuration(*args, **kwargs)#: Displays the current release and version information.

start_journal(*args, **kwargs)#: Starts recording all input and writes it to a file. The current Fluent version is automatically recorded in the journal file. Note that commands entered using paths from older versions of Fluent will be upgraded to their current path in the journal file. See .

start_transcript(*args, **kwargs)#: Starts recording input and output in a file. A transcript file contains a complete record of all standard input to and output from Fluent (usually all keyboard and user interface input and all screen output).Start the transcription process with the file/start-transcript command, and end it with the file/stop-transcript command (or by exiting the program).

stop_journal(*args, **kwargs)#: Stops recording input and closes the journal file.

stop_transcript(*args, **kwargs)#: Stops recording input and output, and closes the transcript file.

write_boundaries(*args, **kwargs)#: Enables you to write the specified boundaries into a mesh file. This is useful for large cases where you may want to mesh different parts of the mesh separately and then merge them together. This enables you to avoid frequent switching between domains for such cases. You can write out selected boundaries to a mesh file and then create the volume mesh for the part in a separate session. You can then read the saved mesh into the previous session and merge the part with the rest of the mesh.

write_case(*args, **kwargs)#: Enables you to write a case file that can be read by Fluent. You should delete dead zones in the mesh before writing the mesh or case file for Fluent.

write_domains(*args, **kwargs)#: Enables you to write all the mesh domains (except global) into a file that can be read.

write_mesh(*args, **kwargs)#: Enables you to write a mesh file. You should delete dead zones in the mesh before writing the mesh or case file for Fluent.

write_mesh_vars(*args, **kwargs)#: Writes mesh varaibles to a file.

write_options(*args, **kwargs)#: Allows you to enable or disable the enforce mesh topology option for writing mesh/case files. This option is enabled by default; where it will orient the face zones consistently when the mesh file is written. If necessary, the zones will be separated, such that each boundary face zone has at most two cell zones as neighbors, one on either side. Also, internal face zones will be inserted between neighboring cell zones that are connected by interior faces.

write_size_field(*args, **kwargs)#: Enables you to write a size field file.

class material_point(path, service)#

Bases: TUIMenu

Manage material points.

Methods:

`create_material_point`(args, *kwargs)	Enables the definition of a material point.
`delete_all_material_points`(args, *kwargs)	Enables the deletion of all defined material points.
`delete_material_point`(args, *kwargs)	Deletes the specified material point.
`list_material_points`(args, *kwargs)	Lists all the defined material points.

create_material_point(*args, **kwargs)#: Enables the definition of a material point. Specify the fluid zone name and the location to define the material point.

delete_all_material_points(*args, **kwargs)#: Enables the deletion of all defined material points.

delete_material_point(*args, **kwargs)#: Deletes the specified material point.

list_material_points(*args, **kwargs)#: Lists all the defined material points.

class mesh(path, service)#

Bases: TUIMenu

Enter the grid menu.

Methods:

`activate_lean_datastructures`(args, *kwargs)	Activates Lean data structures to reduce memory.
`auto_mesh`(args, *kwargs)	Enables you to generate the volume mesh automatically.
`auto_mesh_multiple_objects`(args, *kwargs)	Automatically executes initialization and refinement of mesh for multiple objects.
`auto_prefix_cell_zones`(args, *kwargs)	Enables you to specify a prefix for cell zones created during the auto mesh procedure.
`check_mesh`(args, *kwargs)	Checks the mesh for topological errors.
`check_quality`(args, *kwargs)	Enables you to ensure that the mesh quality is appropriate before transferring the mesh to the solution mode.
`check_quality_level`(args, *kwargs)	Enables you to report additional quality metrics when set to 1.
`clear_mesh`(args, *kwargs)	Enables you to generate a new mesh by deleting the internal mesh and leaving only the boundary faces and nodes.
`clear_undo_stack`(args, *kwargs)	Clears undo stack.
`create_frustrum`(args, *kwargs)	Create a cylindrical hex mesh.
`create_heat_exchanger`(args, *kwargs)	Creates the heat exchanger mesh.
`cutcell`(args, *kwargs)	Enters the cutcell menu.
`deactivate_lean_datastructures`(args, *kwargs)	Deactivates Lean data structures.
`laplace_smooth_nodes`(args, *kwargs)	Applies a Laplacian smoothing operator to the mesh nodes.
`list_mesh_parameter`(args, *kwargs)	Shows all mesh parameters.
`prepare_for_solve`(args, *kwargs)	Prepares the mesh for solving in solution mode by performing a cleanup operation after the volume mesh has been generated.
`repair_face_handedness`(args, *kwargs)	Reverses face node orientation.
`reset_mesh`(args, *kwargs)	Clears the entire mesh.
`reset_mesh_parameter`(args, *kwargs)	Resets all parameters to their default value.
`selective_mesh_check`(args, *kwargs)	Performs a customized mesh check on specific zones rather than all zones.
`zone_names_clean_up`(args, *kwargs)

Classes:

`auto_mesh_controls`(path, service)	Enters the auto-mesh-controls submenu.
`cartesian`(path, service)	Enter Cartesian mesh menu.
`cavity`(path, service)	Enters the cavity menu.
`cell_zone_conditions`(path, service)	Contains options for copying or clearing cell zone conditions when a case file is read.
`domains`(path, service)	Enters the domain menu.
`hexcore`(path, service)	Enters the hexcore menu.
`manage`(path, service)	Enters the manage cell zones menu.
`modify`(path, service)	Enters the mesh modify menu.
`non_conformals`(path, service)	Enters the non-conformals menu.
`poly`(path, service)	Enters the polyhedral mesh generation menu.
`poly_hexcore`(path, service)	Enters the menu for poly-hexcore mesh.
`prism`(path, service)	Enters the prism menu.
`pyramid`(path, service)	Enters the pyramid menu.
`rapid_octree`(path, service)	Enters the rapid octree menu, which provides text commands for using the Rapid Octree mesher.
`scoped_prisms`(path, service)	Contains options for creating scoped prism controls for mesh objects.
`separate`(path, service)	Separates cells by various user-defined methods.
`tet`(path, service)	Enters the tetrahedral mesh menu.
`thin_volume_mesh`(path, service)	Creates a sweep-like mesh for a body occupying a thin gap.

activate_lean_datastructures(*args, **kwargs)#: Activates Lean data structures to reduce memory.

auto_mesh(*args, **kwargs)#: Enables you to generate the volume mesh automatically. Specify a mesh object name for object-based auto mesh; if no name is given, face zone based auto mesh is performed. Specify the mesh elements to be used when prompted. Specify whether to merge the cells into a single zone or keep the cell zones separate. For face zone based meshing, specify whether automatically identify the domain to be meshed based on the topology information.

class auto_mesh_controls(path, service)#

Bases: TUIMenu

Enters the auto-mesh-controls submenu.

Methods:

backup_object(*args, **kwargs)

Enables creation of a backup of the surface mesh before volume meshing starts.

backup_object(*args, **kwargs)#: Enables creation of a backup of the surface mesh before volume meshing starts. This option is enabled by default.

auto_mesh_multiple_objects(*args, **kwargs)#: Automatically executes initialization and refinement of mesh for multiple objects.

auto_prefix_cell_zones(*args, **kwargs)#: Enables you to specify a prefix for cell zones created during the auto mesh procedure. The auto-prefix-cell-zones command is not relevant for object-based meshing, where the cell zone names are generated based on the material points and the objects used to generate the mesh object.

class cartesian(path, service)#

Bases: TUIMenu

Enter Cartesian mesh menu.

Methods:

mesh(*args, **kwargs)

Generate Cartesian mesh.

mesh(*args, **kwargs)#: Generate Cartesian mesh.

class cavity(path, service)#

Bases: TUIMenu

Enters the cavity menu.

Methods:

`add_zones`(args, *kwargs)	Enables you to create a cavity for adding new zones to the existing volume mesh.
`create_hexcore_cavity_by_region`(args, *kwargs)	Creates the cavity in the hexcore mesh based on the zones and bounding box extents specified.
`create_hexcore_cavity_by_scale`(args, *kwargs)	Creates the cavity in the hexcore mesh based on the zones and scale specified.
`merge_cavity`(args, *kwargs)	Enables you to merge the specified cavity domain with the parent domain.
`region`(args, *kwargs)	Enables you to create a cavity to modify the existing volume mesh in the specified region.
`remesh_hexcore_cavity`(args, *kwargs)	Remesh a cavity in hexcore mesh.
`remove_zones`(args, *kwargs)	Enables you to create a cavity for removing zones from the existing volume mesh.
`replace_zones`(args, *kwargs)	Enables you to create a cavity for removing a set of zones from an existing volume mesh and replacing them with new set of zones.

add_zones(*args, **kwargs)#: Enables you to create a cavity for adding new zones to the existing volume mesh.

create_hexcore_cavity_by_region(*args, **kwargs)#: Creates the cavity in the hexcore mesh based on the zones and bounding box extents specified. The create-hexcore-cavity-by-region option is no longer supported and will be removed at a future release.

create_hexcore_cavity_by_scale(*args, **kwargs)#: Creates the cavity in the hexcore mesh based on the zones and scale specified. The create-hexcore-cavity-by-scale option is no longer supported and will be removed at a future release.

merge_cavity(*args, **kwargs)#: Enables you to merge the specified cavity domain with the parent domain. During the merging operation, the cavity cell zones merges with the zones in the parent domain. The wall boundaries extracted from the interior zones will be converted to interior type and merged with the corresponding zones in the parent domain.

region(*args, **kwargs)#: Enables you to create a cavity to modify the existing volume mesh in the specified region.

remesh_hexcore_cavity(*args, **kwargs)#: Remesh a cavity in hexcore mesh.

remove_zones(*args, **kwargs)#: Enables you to create a cavity for removing zones from the existing volume mesh.

replace_zones(*args, **kwargs)#: Enables you to create a cavity for removing a set of zones from an existing volume mesh and replacing them with new set of zones.

class cell_zone_conditions(path, service)#

Bases: TUIMenu

Contains options for copying or clearing cell zone conditions when a case file is read.

Methods:

`clear`(args, *kwargs)	Clears the cell zone conditions assigned to the specified zones.
`clear_all`(args, *kwargs)	Clears the cell conditions assigned to all the zones.
`copy`(args, *kwargs)	Enables you to copy the cell zone conditions from the zone selected to the zones specified.

clear(*args, **kwargs)#: Clears the cell zone conditions assigned to the specified zones.

clear_all(*args, **kwargs)#: Clears the cell conditions assigned to all the zones.

copy(*args, **kwargs)#: Enables you to copy the cell zone conditions from the zone selected to the zones specified.

check_mesh(*args, **kwargs)#: Checks the mesh for topological errors.

check_quality(*args, **kwargs)#: Enables you to ensure that the mesh quality is appropriate before transferring the mesh to the solution mode.

check_quality_level(*args, **kwargs)#: Enables you to report additional quality metrics when set to 1. In addition to the orthogonal quality and Fluent aspect ratio, additional metrics such as cell squish and skewness will be reported when the check-quality-level is set to 1.

clear_mesh(*args, **kwargs)#: Enables you to generate a new mesh by deleting the internal mesh and leaving only the boundary faces and nodes.

clear_undo_stack(*args, **kwargs)#: Clears undo stack.

create_frustrum(*args, **kwargs)#: Create a cylindrical hex mesh.

create_heat_exchanger(*args, **kwargs)#: Creates the heat exchanger mesh. You need to specify the method for selecting the Location coordinates (by Position or Nodes), the location coordinates, the parameters for setting up mesh density (by Interval or Size), and the number of intervals (sizes) between points (nodes) 1–2, 1–3, 1–4. Also specify the object/zone name prefix and enable creating the mesh object, if required.

cutcell(*args, **kwargs)#: Enters the cutcell menu. This menu is no longer supported, and will be removed in a future release.

deactivate_lean_datastructures(*args, **kwargs)#: Deactivates Lean data structures.

class domains(path, service)#

Bases: TUIMenu

Enters the domain menu.

Methods:

`activate`(args, *kwargs)	Activates the specified domain for meshing or reporting operations.
`create`(args, *kwargs)	Creates a new domain based on the specified boundary face zones.
`create_by_cell_zone`(args, *kwargs)	Creates a new domain based on the specified cell zone.
`create_by_point`(args, *kwargs)	Creates a new domain based on the specified The create-by-point option works only for cases with no overlapping face zones.
`delete`(args, *kwargs)	Deletes the specified domain.
`draw`(args, *kwargs)	Displays the boundary face zones of the specified domain.
`print`(args, *kwargs)	Prints the information for the specified domain.

activate(*args, **kwargs)#: Activates the specified domain for meshing or reporting operations.

create(*args, **kwargs)#: Creates a new domain based on the specified boundary face zones. Ensure valid boundary zones are specified; specifying invalid zones will generate an error.

create_by_cell_zone(*args, **kwargs)#: Creates a new domain based on the specified cell zone.

create_by_point(*args, **kwargs)#: Creates a new domain based on the specified The create-by-point option works only for cases with no overlapping face zones.

delete(*args, **kwargs)#: Deletes the specified domain.

draw(*args, **kwargs)#: Displays the boundary face zones of the specified domain.

print(*args, **kwargs)#: Prints the information for the specified domain.

class hexcore(path, service)#

Bases: TUIMenu

Enters the hexcore menu.

Classes:

`controls`(path, service)	Enters the hexcore controls menu.
`local_regions`(path, service)	Enters the hexcore local refinement region sub-menu.

Methods:

`create`(args, *kwargs)	Enables you to create the hexcore mesh according to the specified parameters.
`merge_tets_to_pyramids`(args, *kwargs)	Enables the merge-tets-to-pyramids command to reduce the total cell count.

class controls(path, service)#

Bases: TUIMenu

Enters the hexcore controls menu.

Methods:

`avoid_1_by_8_cell_jump_in_hexcore`(*args, ...)	Avoid-1:8-cell-jump-in-hexcore.
`buffer_layers`(args, *kwargs)	Sets the number of addition cells to mark for subdivision.
`compute_max_cell_length`(args, *kwargs)	Computes the maximum cell length for the hexcore mesh.
`define_hexcore_extents`(args, *kwargs)	Enables you to extend the hexcore mesh to specified domain extents and/or selected planar boundaries.
`delete_dead_zones`(args, *kwargs)	Toggles the automatic deleting of the dead zones.
`maximum_cell_length`(args, *kwargs)	Sets the maximum cell length for the hex cells in the domain.
`maximum_initial_cells`(args, *kwargs)	Specifies the maximum number of cells in the initial Cartesian mesh.
`merge_tets_to_pyramids`(args, *kwargs)	Merge tets into pyramids.
`non_fluid_type`(args, *kwargs)	Selects the default non-fluid cell zone type.
`octree_hexcore`(args, *kwargs)	Speeds up hexahedral core generation by enabling the octree technique for hexcore mesh generation.
`peel_layers`(args, *kwargs)	Specifies the distance for the hexcore interface to peel-back from the boundary.
`print_region_based_sizing`(args, *kwargs)	Displays local sizing settings (max cell length and growth rate) for specified region(s).
`set_region_based_sizing`(args, *kwargs)	Allows you to specify local sizing settings (max cell length and growth rate) for specified region(s).
`skip_tet_refinement`(args, *kwargs)	Enables you to omit the tetrahedral refinement phase for reducing total cell count (default is no).

Classes:

outer_domain_params(path, service)

Contains options for defining the outer domain parameters.

avoid_1_by_8_cell_jump_in_hexcore(*args, **kwargs)#: Avoid-1:8-cell-jump-in-hexcore.

buffer_layers(*args, **kwargs)#: Sets the number of addition cells to mark for subdivision.

compute_max_cell_length(*args, **kwargs)#: Computes the maximum cell length for the hexcore mesh.

define_hexcore_extents(*args, **kwargs)#: Enables you to extend the hexcore mesh to specified domain extents and/or selected planar boundaries. When enabled, the outer-domain-params sub-menu will be available.

delete_dead_zones(*args, **kwargs)#: Toggles the automatic deleting of the dead zones.

maximum_cell_length(*args, **kwargs)#: Sets the maximum cell length for the hex cells in the domain.

maximum_initial_cells(*args, **kwargs)#: Specifies the maximum number of cells in the initial Cartesian mesh.

merge_tets_to_pyramids(*args, **kwargs)#: Merge tets into pyramids.

non_fluid_type(*args, **kwargs)#: Selects the default non-fluid cell zone type. After the mesh is initialized, any non-fluid zones will be set to this type. If the mesh includes multiple regions (for example, the problem for which you are creating the mesh includes a fluid zone and one or more solid zones), and you plan to refine all of them using the same refinement parameters, modify the Non-Fluid Type before generating the hexcore mesh. For zone-based meshing, if any cell zone has at least one boundary zone type as inlet, it will automatically be set to fluid type. For object based meshing, volume region type is used to determine the cell zone type.

octree_hexcore(*args, **kwargs)#: Speeds up hexahedral core generation by enabling the octree technique for hexcore mesh generation. This option is disabled by default. Body-of-influence sizing may be used for refinement. This option does not support hexcore generation up to boundaries.

class outer_domain_params(path, service)#

Bases: TUIMenu

Contains options for defining the outer domain parameters. This sub-menu is available only when define-hexcore-extents? is enabled.

Methods:

`auto_align`(args, *kwargs)	Enables you to axis-align non-aligned planar boundaries to which hexcore mesh is to be generated.
`auto_align_boundaries`(args, *kwargs)	Aligns the boundary zones specified (using the boundaries command) with the tolerance specified (using the auto-align-tolerance command) when auto-align? is enabled.
`auto_align_tolerance`(args, *kwargs)	Specifies the tolerance for aligning boundary zones when auto-align? is enabled.
`boundaries`(args, *kwargs)	Specifies the boundaries to which the hexcore mesh is to be generated when the specify-boundaries? option is enabled.
`coordinates`(args, *kwargs)	Specifies the extents (min and max coordinates) of the hexcore outer box.
`delete_old_face_zones`(args, *kwargs)	Enables you to delete the original tri face zones that have been replaced during the hexcore meshing process.
`list`(args, *kwargs)	Lists the boundaries to which the hexcore mesh is to be generated.
`specify_boundaries`(args, *kwargs)	Enables you to specify selected boundaries to which the hexcore mesh is to be generated using the boundaries command.
`specify_coordinates`(args, *kwargs)	Enables you to specify the extents of the hexcore outer box using the coordinates command.

auto_align(*args, **kwargs)#: Enables you to axis-align non-aligned planar boundaries to which hexcore mesh is to be generated. This option is available only when the specify-boundaries? option is enabled and the boundaries are specified.

auto_align_boundaries(*args, **kwargs)#: Aligns the boundary zones specified (using the boundaries command) with the tolerance specified (using the auto-align-tolerance command) when auto-align? is enabled.

auto_align_tolerance(*args, **kwargs)#: Specifies the tolerance for aligning boundary zones when auto-align? is enabled.

boundaries(*args, **kwargs)#: Specifies the boundaries to which the hexcore mesh is to be generated when the specify-boundaries? option is enabled. After specifying the boundaries, the auto-align?, delete-old-face-zones?, and list options will also be available.

coordinates(*args, **kwargs)#: Specifies the extents (min and max coordinates) of the hexcore outer box. This command is available when the specify-coordinates? option is enabled.

delete_old_face_zones(*args, **kwargs)#: Enables you to delete the original tri face zones that have been replaced during the hexcore meshing process. This option is available only when the specify-boundaries? option is enabled and the boundaries are specified.

list(*args, **kwargs)#: Lists the boundaries to which the hexcore mesh is to be generated. This option is available only when the specify-boundaries? option is enabled and the boundaries are specified.

specify_boundaries(*args, **kwargs)#: Enables you to specify selected boundaries to which the hexcore mesh is to be generated using the boundaries command.

specify_coordinates(*args, **kwargs)#: Enables you to specify the extents of the hexcore outer box using the coordinates command.

peel_layers(*args, **kwargs)#: Specifies the distance for the hexcore interface to peel-back from the boundary. The default value is 0. The higher the value of peel layer, the bigger the distance between the hexcore interface and the boundary.

print_region_based_sizing(*args, **kwargs)#: Displays local sizing settings (max cell length and growth rate) for specified region(s).

set_region_based_sizing(*args, **kwargs)#: Allows you to specify local sizing settings (max cell length and growth rate) for specified region(s).

skip_tet_refinement(*args, **kwargs)#: Enables you to omit the tetrahedral refinement phase for reducing total cell count (default is no). Hex cell count is unaffected.

create(*args, **kwargs)#: Enables you to create the hexcore mesh according to the specified parameters.

class local_regions(path, service)#

Bases: TUIMenu

Enters the hexcore local refinement region sub-menu.

Methods:

`activate`(args, *kwargs)	Enables you to activate the specified local regions for refinement.
`deactivate`(args, *kwargs)	Enables you to deactivate the specified local regions for refinement.
`define`(args, *kwargs)	Defines the local region according to the specified parameters.
`delete`(args, *kwargs)	Deletes the specified refinement region.
`ideal_hex_vol`(args, *kwargs)	Reports the ideal hex volume for the given edge length.
`ideal_quad_area`(args, *kwargs)	Ideal quad area for given edge length.
`init`(args, *kwargs)	Creates a default region encompassing the entire geometry.
`list_all_regions`(args, *kwargs)	Lists the defined and active regions in the console.

activate(*args, **kwargs)#: Enables you to activate the specified local regions for refinement.

deactivate(*args, **kwargs)#: Enables you to deactivate the specified local regions for refinement.

define(*args, **kwargs)#: Defines the local region according to the specified parameters.

delete(*args, **kwargs)#: Deletes the specified refinement region.

ideal_hex_vol(*args, **kwargs)#: Reports the ideal hex volume for the given edge length.

ideal_quad_area(*args, **kwargs)#: Ideal quad area for given edge length.

init(*args, **kwargs)#: Creates a default region encompassing the entire geometry.

list_all_regions(*args, **kwargs)#: Lists the defined and active regions in the console.

merge_tets_to_pyramids(*args, **kwargs)#: Enables the merge-tets-to-pyramids command to reduce the total cell count. If skip-tet-refinement is enabled, pairs of tets will be merged into pyramids. Hexcore count is unaffected.

laplace_smooth_nodes(*args, **kwargs)#: Applies a Laplacian smoothing operator to the mesh nodes. This command can be used for smoothing of all cell types, including prismatic cells.

list_mesh_parameter(*args, **kwargs)#: Shows all mesh parameters.

class manage(path, service)#

Bases: TUIMenu

Enters the manage cell zones menu.

Methods:

`active_list`(args, *kwargs)	Lists all active zones.
`adjacent_face_zones`(args, *kwargs)	Lists all face zones that refer to the specified cell zone.
`auto_set_active`(args, *kwargs)	Sets the active zones based on points that are defined in an external file.
`change_prefix`(args, *kwargs)	Enables you to change the prefix for the cell zone.
`change_suffix`(args, *kwargs)	Change the suffix for specified face zones.
`copy`(args, *kwargs)	Copies all nodes and faces of specified cell zones.
`delete`(args, *kwargs)	Deletes a cell zone, along with its associated nodes and faces.
`get_material_point`(args, *kwargs)	Prints the coordinates of the material point for the specified cell zone.
`id`(args, *kwargs)	Specifies a new cell zone ID.
`list`(args, *kwargs)	Prints information on all cell zones.
`merge`(args, *kwargs)	Merges two or more cell zones.
`merge_dead_zones`(args, *kwargs)	Enables you to merge dead zones having a cell count lower than the specified threshold value, with the adjacent cell zone.
`name`(args, *kwargs)	Enables you to rename a cell zone.
`origin`(args, *kwargs)	Specifies a new origin for the mesh, to be used for cell zone rotation.
`revolve_face_zone`(args, *kwargs)	Generates cells by revolving a face thread.
`rotate`(args, *kwargs)	Rotates all nodes of specified cell zones by a specified angle.
`rotate_model`(args, *kwargs)	Rotates all nodes of the model by a specified angle.
`scale`(args, *kwargs)	Scales all nodes of specified cell zones by a specified factor.
`scale_model`(args, *kwargs)	Scales all nodes of the model by a specified factor.
`set_active`(args, *kwargs)	Sets the specified cell zones to be active.
`translate`(args, *kwargs)	Translates all nodes of specified cell zones by a specified vector.
`translate_model`(args, *kwargs)	Translates all nodes of the model by a specified vector.
`type`(args, *kwargs)	Changes the type and name of a cell zone.

active_list(*args, **kwargs)#: Lists all active zones.

adjacent_face_zones(*args, **kwargs)#: Lists all face zones that refer to the specified cell zone.

auto_set_active(*args, **kwargs)#: Sets the active zones based on points that are defined in an external file. For each zone you want to activate, you need to specify the coordinates of a point in the zone, the zone type (for example, fluid), and (optionally) a new name. A sample file is shown below:.

change_prefix(*args, **kwargs)#: Enables you to change the prefix for the cell zone.

change_suffix(*args, **kwargs)#: Change the suffix for specified face zones.

copy(*args, **kwargs)#: Copies all nodes and faces of specified cell zones.

delete(*args, **kwargs)#: Deletes a cell zone, along with its associated nodes and faces. When deleting cell zones that contain poly cells, you will be warned that the original mesh needs to be deleted and the original faces restored prior to remeshing the volumetric region.

get_material_point(*args, **kwargs)#: Prints the coordinates of the material point for the specified cell zone. If the cell zone is non-contiguous, the get-material-point command will print a list of material points, one for each contiguous region.

id(*args, **kwargs)#: Specifies a new cell zone ID. If a conflict is detected, the change will be ignored.

list(*args, **kwargs)#: Prints information on all cell zones.

merge(*args, **kwargs)#: Merges two or more cell zones. For object-based merge, the selected zones must be in the same volumetric region. If not, you will have to merge the volumetric regions first using /objects/volumetric-regions/merge. If the volumetric regions cannot be merged because they are not contiguous, you will have to delete the object(s) only before merging the cell zones.

merge_dead_zones(*args, **kwargs)#: Enables you to merge dead zones having a cell count lower than the specified threshold value, with the adjacent cell zone. The result of the merge operation is determined by the type of the adjacent cell zone and the shared face area. The priority for merging with the adjacent cell zone based on type is fluid > solid > dead (that is, merging with an adjacent fluid zone takes priority over merging with an adjacent solid zone, which in turn takes priority over merging with a dead zone). Also, if the adjacent zones are of the same type (for example, fluid), the zone will be merged with the zone having the largest shared face area.

name(*args, **kwargs)#: Enables you to rename a cell zone.

origin(*args, **kwargs)#: Specifies a new origin for the mesh, to be used for cell zone rotation. The default origin is (0,0,0).

revolve_face_zone(*args, **kwargs)#: Generates cells by revolving a face thread.

rotate(*args, **kwargs)#: Rotates all nodes of specified cell zones by a specified angle.

rotate_model(*args, **kwargs)#: Rotates all nodes of the model by a specified angle.

scale(*args, **kwargs)#: Scales all nodes of specified cell zones by a specified factor.

scale_model(*args, **kwargs)#: Scales all nodes of the model by a specified factor.

set_active(*args, **kwargs)#: Sets the specified cell zones to be active.

translate(*args, **kwargs)#: Translates all nodes of specified cell zones by a specified vector.

translate_model(*args, **kwargs)#: Translates all nodes of the model by a specified vector.

type(*args, **kwargs)#: Changes the type and name of a cell zone.

class modify(path, service)#

Bases: TUIMenu

Enters the mesh modify menu.

Methods:

`auto_improve_warp`(args, *kwargs)	Enables you to improve face warp by node movement.
`auto_node_move`(args, *kwargs)	Enables you to improve the mesh quality by node movement.
`clear_selections`(args, *kwargs)	Clears all items from the selection list.
`delete_isolated_cells`(args, *kwargs)	Delete isolated cells.
`deselect_last`(args, *kwargs)	Deselects the last item you selected using the select-entity command.
`extract_unused_nodes`(args, *kwargs)	Places all unused nodes in a separate interior node zone.
`list_selections`(args, *kwargs)	Lists all items in the selection list.
`list_skewed_cells`(args, *kwargs)	Lists cells with skewness in a specified range.
`mesh_node`(args, *kwargs)	Attempts to introduce a new node into the existing mesh.
`mesh_nodes_on_zone`(args, *kwargs)	Inserts nodes associated with node or face zone into the volume mesh.
`neighborhood_skew`(args, *kwargs)	Reports the maximum skewness of cells using the specified node.
`refine_cell`(args, *kwargs)	Attempts to refine the cells in the probe list by introducing a node nears its centroid.
`repair_negative_volume_cells`(args, *kwargs)	Repairs negative volume cells by moving nodes.
`select_entity`(args, *kwargs)	Adds an entity (face, node, cell, etc.) to the selection list.
`smooth_node`(args, *kwargs)	Applies Laplace smoothing to the nodes in the selection list.

auto_improve_warp(*args, **kwargs)#: Enables you to improve face warp by node movement. Specify the appropriate cell zones and boundary zones, the maximum warp, the number of iterations per face to be improved, and the number of iterations of the automatic node movement procedure (default, 4).

auto_node_move(*args, **kwargs)#: Enables you to improve the mesh quality by node movement. Specify the appropriate cell zones and boundary zones, the quality limit based on the quality measure selected, dihedral angle, the number of iterations per node to be moved and the number of iterations of the automatic node movement procedure (default, 1). You can also choose to restrict the movement of boundary nodes along the surface.

clear_selections(*args, **kwargs)#: Clears all items from the selection list.

delete_isolated_cells(*args, **kwargs)#: Delete isolated cells.

deselect_last(*args, **kwargs)#: Deselects the last item you selected using the select-entity command.

extract_unused_nodes(*args, **kwargs)#: Places all unused nodes in a separate interior node zone.

list_selections(*args, **kwargs)#: Lists all items in the selection list.

list_skewed_cells(*args, **kwargs)#: Lists cells with skewness in a specified range.

mesh_node(*args, **kwargs)#: Attempts to introduce a new node into the existing mesh.

mesh_nodes_on_zone(*args, **kwargs)#: Inserts nodes associated with node or face zone into the volume mesh.

neighborhood_skew(*args, **kwargs)#: Reports the maximum skewness of cells using the specified node.

refine_cell(*args, **kwargs)#: Attempts to refine the cells in the probe list by introducing a node nears its centroid. This technique is useful for removing very flat cells near the boundary when boundary sliver removal is not possible. After refining the cell, you should smooth the mesh.

repair_negative_volume_cells(*args, **kwargs)#: Repairs negative volume cells by moving nodes. Specify the appropriate boundary zones, the number of iterations per node to be moved, dihedral angle, whether to restrict the movement of boundary nodes along the surface, and the number of iterations of the automatic node movement procedure (default, 1).

select_entity(*args, **kwargs)#: Adds an entity (face, node, cell, etc.) to the selection list.

smooth_node(*args, **kwargs)#: Applies Laplace smoothing to the nodes in the selection list.

class non_conformals(path, service)#

Bases: TUIMenu

Enters the non-conformals menu.

Classes:

controls(path, service)

Enters the non-conformals controls menu.

Methods:

`create`(args, *kwargs)	Creates the non-conformal interface on the specified face zones using the specified retriangulation method.
`separate`(args, *kwargs)	Enables you to separate the face zones comprising the non-conformal interface between the cell zones specified.

class controls(path, service)#

Bases: TUIMenu

Enters the non-conformals controls menu.

Methods:

`enable`(args, *kwargs)	Toggles the creation of a non-conformal interface.
`retri_method`(args, *kwargs)	Specifies the method to be used for retriangulating the quad faces on the non-conformal zones.

enable(*args, **kwargs)#: Toggles the creation of a non-conformal interface.

retri_method(*args, **kwargs)#: Specifies the method to be used for retriangulating the quad faces on the non-conformal zones.

create(*args, **kwargs)#: Creates the non-conformal interface on the specified face zones using the specified retriangulation method.

separate(*args, **kwargs)#: Enables you to separate the face zones comprising the non-conformal interface between the cell zones specified. Specify the cell zones where the interface is non-conformal, an appropriate gap distance, and the critical angle to be used for separating the face zones. You can also choose to orient the boundary face zones after separation and additionally write a journal file for the separation operation. If you choose to write a journal file when using the /mesh/non-conformals/separate command to separate the mesh interface zones, you can read the journal file to create the mesh interface automatically in solution mode.

class poly(path, service)#

Bases: TUIMenu

Enters the polyhedral mesh generation menu.

Methods:

`collapse`(args, *kwargs)	Merge nodes to remove short edges and small faces.
`improve`(args, *kwargs)	Allows you to improve the polyhedral mesh quality based on the quality-method.
`quality_method`(args, *kwargs)	Asks you to choose from internal-default, orthoskew or squish quality measure for mesh improvement.
`remesh`(args, *kwargs)	Improves the quality in a local region based on the minimum skewness threshold.

Classes:

`controls`(path, service)	Enters the controls menu for setting poly parameters.
`local_regions`(path, service)	Enters the local refinement menu.

collapse(*args, **kwargs)#: Merge nodes to remove short edges and small faces. The decision threshold uses edge size ratio, face size ratio, and (face) area fraction.

class controls(path, service)#

Bases: TUIMenu

Enters the controls menu for setting poly parameters.

Methods:

`cell_sizing`(args, *kwargs)	Sets cell volume distribution function as geometric, linear, or size-field.
`edge_size_ratio`(args, *kwargs)	Sets the threshold for the size ratio of two connected edges.
`face_size_ratio`(args, *kwargs)	Sets the threshold for the size ratio of two faces on one cell.
`feature_angle`(args, *kwargs)	Sets the minimum threshold that should be preserved as a feature.
`improve`(args, *kwargs)	Enables poly mesh improvement by smoothing based on the smooth-controls.
`merge_skew`(args, *kwargs)	Sets the minimum skewness threshold for cell merge.
`non_fluid_type`(args, *kwargs)	Selects the default type for non-fluid zones.
`remesh_skew`(args, *kwargs)	Sets the target skewness when remeshing.
`sliver_cell_area_fraction`(args, *kwargs)	Sets the threshold for the area of a single face to the cell surface area.

Classes:

`prism`(path, service)	Poly prism transition controls.
`smooth_controls`(path, service)	Enters the menu for setting smoothing parameters for poly mesh.

cell_sizing(*args, **kwargs)#: Sets cell volume distribution function as geometric, linear, or size-field.

edge_size_ratio(*args, **kwargs)#: Sets the threshold for the size ratio of two connected edges. Recommended range is 20 to 200.

face_size_ratio(*args, **kwargs)#: Sets the threshold for the size ratio of two faces on one cell. Recommended range is 100 to 300.

feature_angle(*args, **kwargs)#: Sets the minimum threshold that should be preserved as a feature.

improve(*args, **kwargs)#: Enables poly mesh improvement by smoothing based on the smooth-controls.

merge_skew(*args, **kwargs)#: Sets the minimum skewness threshold for cell merge.

non_fluid_type(*args, **kwargs)#: Selects the default type for non-fluid zones.

class prism(path, service)#

Bases: TUIMenu

Poly prism transition controls.

Methods:

`apply_growth`(args, *kwargs)	Apply growth settings.
`clear_growth`(args, *kwargs)	Clear growth settings.
`list_growth`(args, *kwargs)	List growth settings.

apply_growth(*args, **kwargs)#: Apply growth settings.

clear_growth(*args, **kwargs)#: Clear growth settings.

list_growth(*args, **kwargs)#: List growth settings.

remesh_skew(*args, **kwargs)#: Sets the target skewness when remeshing.

sliver_cell_area_fraction(*args, **kwargs)#: Sets the threshold for the area of a single face to the cell surface area. Recommended range is 0.00001 to 0.001.

class smooth_controls(path, service)#

Bases: TUIMenu

Enters the menu for setting smoothing parameters for poly mesh.

Methods:

`centroid_smooth_iterations`(args, *kwargs)	Sets the number of passes for tet-cell centroid smoothing during the poly mesh generation phase.
`edge_smooth_iterations`(args, *kwargs)	Sets the number of passes for tet-cell edge smoothing during the poly mesh generation phase.
`laplace_smooth_iterations`(args, *kwargs)	Sets the number of passes for tet-cell Laplace smoothing during the poly mesh generation phase.
`smooth_attempts`(args, *kwargs)	Sets the maximum number of movements for a single node during poly mesh smoothing.
`smooth_boundary`(args, *kwargs)	Enables boundary smoothing as part of poly cell smoothing.
`smooth_iterations`(args, *kwargs)	Sets the number of improvement passes over the full poly mesh.
`smooth_on_layer`(args, *kwargs)	Constrains movement of nodes to maintain layering during poly mesh smoothing.
`smooth_skew`(args, *kwargs)	Sets the minimum skewness threshold for poly mesh smoothing.

centroid_smooth_iterations(*args, **kwargs)#: Sets the number of passes for tet-cell centroid smoothing during the poly mesh generation phase.

edge_smooth_iterations(*args, **kwargs)#: Sets the number of passes for tet-cell edge smoothing during the poly mesh generation phase.

laplace_smooth_iterations(*args, **kwargs)#: Sets the number of passes for tet-cell Laplace smoothing during the poly mesh generation phase.

smooth_attempts(*args, **kwargs)#: Sets the maximum number of movements for a single node during poly mesh smoothing.

smooth_boundary(*args, **kwargs)#: Enables boundary smoothing as part of poly cell smoothing. Default is no.

smooth_iterations(*args, **kwargs)#: Sets the number of improvement passes over the full poly mesh.

smooth_on_layer(*args, **kwargs)#: Constrains movement of nodes to maintain layering during poly mesh smoothing.

smooth_skew(*args, **kwargs)#: Sets the minimum skewness threshold for poly mesh smoothing.

improve(*args, **kwargs)#: Allows you to improve the polyhedral mesh quality based on the quality-method.

class local_regions(path, service)#

Bases: TUIMenu

Enters the local refinement menu. Poly meshing follows tet meshing. These commands behave like the equivalent commands under /mesh/tet/local-regions/.

Methods:

`activate`(args, *kwargs)	Activates the specified regions for refinement.
`deactivate`(args, *kwargs)	Deactivates the specified regions for refinement.
`define`(args, *kwargs)	Defines the refinement region according to the specified parameters.
`delete`(args, *kwargs)	Deletes the specified refinement region.
`ideal_area`(args, *kwargs)	Ideal triangle area for given edge length.
`ideal_vol`(args, *kwargs)	Reports the volume of an ideal tetrahedron for the edge length specified.
`init`(args, *kwargs)	Defines the default refinement region encompassing the entire geometry.
`list_all_regions`(args, *kwargs)	Lists all refinement region parameters and the activated regions in the console.
`refine`(args, *kwargs)	Refines the active cells inside the selected region based on the specified refinement parameters.

activate(*args, **kwargs)#: Activates the specified regions for refinement.

deactivate(*args, **kwargs)#: Deactivates the specified regions for refinement.

define(*args, **kwargs)#: Defines the refinement region according to the specified parameters.

delete(*args, **kwargs)#: Deletes the specified refinement region.

ideal_area(*args, **kwargs)#: Ideal triangle area for given edge length.

ideal_vol(*args, **kwargs)#: Reports the volume of an ideal tetrahedron for the edge length specified.

init(*args, **kwargs)#: Defines the default refinement region encompassing the entire geometry.

list_all_regions(*args, **kwargs)#: Lists all refinement region parameters and the activated regions in the console.

refine(*args, **kwargs)#: Refines the active cells inside the selected region based on the specified refinement parameters.

quality_method(*args, **kwargs)#: Asks you to choose from internal-default, orthoskew or squish quality measure for mesh improvement.

remesh(*args, **kwargs)#: Improves the quality in a local region based on the minimum skewness threshold.

class poly_hexcore(path, service)#

Bases: TUIMenu

Enters the menu for poly-hexcore mesh.

Classes:

controls(path, service)

Enters the menu for setting parameters for poly-hexcore mesh.

class controls(path, service)#

Bases: TUIMenu

Enters the menu for setting parameters for poly-hexcore mesh.

Methods:

`avoid_1_by_8_cell_jump_in_hexcore`(*args, ...)	Avoid-1:8-cell-jump-in-hexcore.
`mark_core_region_cell_type_as_hex`(*args, ...)	Determines whether or not to apply hexahedra cells in the core region of the mesh.
`only_polyhedra_for_selected_regions`(*args, ...)	Determines if polyhedra cells are to be applied to the selected regions.

avoid_1_by_8_cell_jump_in_hexcore(*args, **kwargs)#: Avoid-1:8-cell-jump-in-hexcore.

mark_core_region_cell_type_as_hex(*args, **kwargs)#: Determines whether or not to apply hexahedra cells in the core region of the mesh. The default value is yes.

only_polyhedra_for_selected_regions(*args, **kwargs)#: Determines if polyhedra cells are to be applied to the selected regions.

prepare_for_solve(*args, **kwargs)#: Prepares the mesh for solving in solution mode by performing a cleanup operation after the volume mesh has been generated. Operations such as deleting dead zones, deleting geometry objects, deleting edge zones, deleting unused faces and nodes are performed during this operation.

class prism(path, service)#

Bases: TUIMenu

Enters the prism menu.

Classes:

`controls`(path, service)	Enters the prism controls menu.
`improve`(path, service)	Enters the prism improve menu.
`post_ignore`(path, service)	Contains the following options for ignoring prism cells:.
`split`(path, service)	Contains options for splitting the prism layers after the initial prism layers are generated, to generate the total number of layers required.

Methods:

`create`(args, *kwargs)	Creates prism layers on one or more boundary face zones based on the offset method, growth method, number of layers, and rate specified.
`list_parameters`(args, *kwargs)	Shows all prism mesh parameters.
`mark_ignore_faces`(args, *kwargs)	Enables you to mark the faces to be ignored during prism meshing.
`mark_nonmanifold_nodes`(args, *kwargs)	Enables you to mark the non-manifold prism base nodes.
`mark_proximity_faces`(args, *kwargs)	Mark prism base faces with certain gap.
`quality_method`(args, *kwargs)	Specifies the quality method used during prism generation.
`reset_parameters`(args, *kwargs)	Resets all prism parameters.

class controls(path, service)#

Bases: TUIMenu

Enters the prism controls menu.

Classes:

`adjacent_zone`(path, service)	Enters the prism adjacent zone controls menu.
`improve`(path, service)	Enters the prism smoothing controls menu.
`morph`(path, service)	Enters the prism morphing controls menu.
`normal`(path, service)	Enters the prism normal controls menu.
`offset`(path, service)	Enters the prism offset controls menu.
`post_ignore`(path, service)	Contains options for setting the parameters for removing poor quality prism cells after the required prism layers are created.
`proximity`(path, service)	Enters the prism proximity controls menu.
`zone_specific_growth`(path, service)	Enters the prism growth controls menu.

Methods:

`check_quality`(args, *kwargs)	Enables/disables the checking of volume, skewness, and handedness of each new cell and face.
`merge_ignored_threads`(args, *kwargs)	Enables you to automatically merge all ignored zones related to a base thread into a single thread.
`remove_invalid_layer`(args, *kwargs)	Removes the last prism layer if it fails in the quality check.
`set_overset_prism_controls`(args, *kwargs)	Set boundary layer controls for overset mesh generation.
`set_post_mesh_controls`(args, *kwargs)	Sets controls specific to growing prisms post volume mesh generation.
`split`(args, *kwargs)	Enables you to set parameters for splitting the prism layers after the initial prism layers are generated, to generate the total number of layers required.

class adjacent_zone(path, service)#

Bases: TUIMenu

Enters the prism adjacent zone controls menu.

Methods:

`project_adjacent_angle`(args, *kwargs)	Determines whether or not to project to an adjacent zone.
`side_feature_angle`(args, *kwargs)	Specifies the angle used for computing the feature normals.

project_adjacent_angle(*args, **kwargs)#: Determines whether or not to project to an adjacent zone. If a zone shares outer nodes with any of the zones from which the layers are being grown (the “base zones”), its angle with respect to the growth direction is compared with this value. If the angle is less than or equal to this value, then the zone will be projected to. The default value is 75 degrees. See for details.

side_feature_angle(*args, **kwargs)#: Specifies the angle used for computing the feature normals.

check_quality(*args, **kwargs)#: Enables/disables the checking of volume, skewness, and handedness of each new cell and face.

class improve(path, service)#

Bases: TUIMenu

Enters the prism smoothing controls menu.

Methods:

`check_allowable_skew`(args, *kwargs)	Enables you to check the skewness of the prism cap for every layer.
`corner_height_weight`(args, *kwargs)	When enabled, the offset height at corners with large angles (for example, 270º) is reduced to give a smoother prism cap.
`edge_swap_base_angle`(args, *kwargs)	Specifies the maximum allowable angle between the normals of the base faces for skewness-driven edge swapping.
`edge_swap_cap_angle`(args, *kwargs)	Specifies the maximum allowable angle between the normals of the cap faces for skewness-driven edge swapping.
`face_smooth_skew`(args, *kwargs)	Min.
`improve_warp`(args, *kwargs)	Enables or disables improving of face warp during prism generation.
`left_hand_check`(args, *kwargs)	Controls checking for left-handedness of faces.
`max_allowable_cap_skew`(args, *kwargs)	Specifies the maximum skewness allowed for a prism cap face.
`max_allowable_cell_skew`(args, *kwargs)	Specifies the cell quality criteria for smoothing and quality checking.
`smooth_improve_prism_cells`(args, *kwargs)	Enables you to set the parameters for improving the prism cells after the required prism layers are created.

check_allowable_skew(*args, **kwargs)#: Enables you to check the skewness of the prism cap for every layer.

corner_height_weight(*args, **kwargs)#: When enabled, the offset height at corners with large angles (for example, 270º) is reduced to give a smoother prism cap.

edge_swap_base_angle(*args, **kwargs)#: Specifies the maximum allowable angle between the normals of the base faces for skewness-driven edge swapping.

edge_swap_cap_angle(*args, **kwargs)#: Specifies the maximum allowable angle between the normals of the cap faces for skewness-driven edge swapping.

face_smooth_skew(*args, **kwargs)#: Min. skewness to smooth cap faces.

improve_warp(*args, **kwargs)#: Enables or disables improving of face warp during prism generation. This option is disabled by default.

left_hand_check(*args, **kwargs)#: Controls checking for left-handedness of faces. The default setting of 0 implies face handedness will not be checked. A value of 1 implies only cap faces will be checked, while 2 implies faces of all cells in current layer will be checked.

max_allowable_cap_skew(*args, **kwargs)#: Specifies the maximum skewness allowed for a prism cap face. If the skewness of a cap face exceeds this value, the meshing process will stop and a warning indicates that the skewness for that layer is too high.

max_allowable_cell_skew(*args, **kwargs)#: Specifies the cell quality criteria for smoothing and quality checking.

smooth_improve_prism_cells(*args, **kwargs)#: Enables you to set the parameters for improving the prism cells after the required prism layers are created. You can select optimized smoothing (smooth), node movement (improve), or a combination of both to improve the quality. Specify the quality measure to be used, the cell quality threshold, the number of improvement iterations, and the minimum improvement required.

merge_ignored_threads(*args, **kwargs)#: Enables you to automatically merge all ignored zones related to a base thread into a single thread. This option is enabled by default. When this option is disabled, more than one ignored thread will be generated per base thread. However, various zones can be created by ignoring this option. They are:.

class morph(path, service)#

Bases: TUIMenu

Enters the prism morphing controls menu.

Methods:

`improve_threshold`(args, *kwargs)	Specifies the quality threshold used for improving the quality during the morphing operation.
`morphing_convergence_limit`(args, *kwargs)	Specifies the convergence limit for the morphing operation.
`morphing_frequency`(args, *kwargs)	Specifies the frequency of the morphing operation.

improve_threshold(*args, **kwargs)#: Specifies the quality threshold used for improving the quality during the morphing operation.

morphing_convergence_limit(*args, **kwargs)#: Specifies the convergence limit for the morphing operation. The morpher uses an iterative solver. It is assumed to have converged when the relative residual is less than this number.

morphing_frequency(*args, **kwargs)#: Specifies the frequency of the morphing operation. The number specified denotes the number of prism layers after which the morpher is applied to the remainder of the mesh (for example, a value of 5 indicates that the morpher is applied to the mesh after every 5 prism layers grown).

class normal(path, service)#

Bases: TUIMenu

Enters the prism normal controls menu.

Methods:

`bisect_angle`(args, *kwargs)	Is required for growing prisms out of sharp interior corners.
`compute_normal`(args, *kwargs)	Computes the normal for the specified face zone.
`direction_method`(args, *kwargs)	Specifies whether the prism layers should be grown normal to surfaces or along a specified direction vector.
`direction_vector`(args, *kwargs)	Specifies the direction vector for prism extrusion when the uniform method is selected for direction-method.
`ignore_invalid_normals`(args, *kwargs)	Enables you to ignore nodes that have poor normals.
`max_angle_change`(args, *kwargs)	Specifies the maximum angle by which the normal direction at a node can change during smoothing.
`orient_mesh_object_face_normals`(args, *kwargs)	Enables you to orient the face normals for mesh object boundary zones.
`orthogonal_layers`(args, *kwargs)	Specifies the number of layers to preserve orthogonality.

bisect_angle(*args, **kwargs)#: Is required for growing prisms out of sharp interior corners. When the value of this angle is set, the normals are automatically projected onto the plane bisecting the angle between faces having an interior angle less than this angle.

compute_normal(*args, **kwargs)#: Computes the normal for the specified face zone.

direction_method(*args, **kwargs)#: Specifies whether the prism layers should be grown normal to surfaces or along a specified direction vector.

direction_vector(*args, **kwargs)#: Specifies the direction vector for prism extrusion when the uniform method is selected for direction-method.

ignore_invalid_normals(*args, **kwargs)#: Enables you to ignore nodes that have poor normals.

max_angle_change(*args, **kwargs)#: Specifies the maximum angle by which the normal direction at a node can change during smoothing.

orient_mesh_object_face_normals(*args, **kwargs)#: Enables you to orient the face normals for mesh object boundary zones. Specify the mesh object, region or material point as appropriate, and specify whether walls, baffles or both comprising the prism base zones are to be separated and oriented.

orthogonal_layers(*args, **kwargs)#: Specifies the number of layers to preserve orthogonality. All smoothing is deferred until after these layers.

class offset(path, service)#

Bases: TUIMenu

Enters the prism offset controls menu.

Methods:

`first_aspect_ratio_min`(args, *kwargs)	Specifies the minimum first aspect ratio (ratio of prism base length to prism layer height) for the prism cells.
`min_aspect_ratio`(args, *kwargs)	Specifies the minimum aspect ratio (ratio of prism base length to prism layer height) for the prism cells.

first_aspect_ratio_min(*args, **kwargs)#: Specifies the minimum first aspect ratio (ratio of prism base length to prism layer height) for the prism cells.

min_aspect_ratio(*args, **kwargs)#: Specifies the minimum aspect ratio (ratio of prism base length to prism layer height) for the prism cells.

class post_ignore(path, service)#

Bases: TUIMenu

Contains options for setting the parameters for removing poor quality prism cells after the required prism layers are created.

Methods:

post_remove_cells(*args, **kwargs)

Enables you to set the parameters for removing poor quality prism cells after the required prism layers are created.

post_remove_cells(*args, **kwargs)#: Enables you to set the parameters for removing poor quality prism cells after the required prism layers are created. You can remove cells based on quality, intersection, interior warp, and feature edges. Specify options for removing additional cells in regions of high aspect ratio and feature angle, the number of cell rings to be removed around the marked cells, and options for smoothing the prism boundary and prism side height.

class proximity(path, service)#

Bases: TUIMenu

Enters the prism proximity controls menu.

Methods:

`allow_ignore`(args, *kwargs)	Enables you to ignore nodes where the specified maximum shrink factor cannot be maintained.
`allow_shrinkage`(args, *kwargs)	Enables shrinkage while growing prism layers.
`gap_factor`(args, *kwargs)	Controls the gap between the intersecting prisms layers in the proximity region with respect to the cell size of the prisms.
`keep_first_layer_offsets`(args, *kwargs)	Enables you to retain first layer offsets while performing proximity detection.
`max_aspect_ratio`(args, *kwargs)	Specifies the maximum allowable cell aspect ratio to determine the limit for the shrinkage of prism layers.
`max_shrink_factor`(args, *kwargs)	Specifies the shrink factor determining the maximum shrinkage of the prism layers.

allow_ignore(*args, **kwargs)#: Enables you to ignore nodes where the specified maximum shrink factor cannot be maintained.

allow_shrinkage(*args, **kwargs)#: Enables shrinkage while growing prism layers.

gap_factor(*args, **kwargs)#: Controls the gap between the intersecting prisms layers in the proximity region with respect to the cell size of the prisms.

keep_first_layer_offsets(*args, **kwargs)#: Enables you to retain first layer offsets while performing proximity detection.

max_aspect_ratio(*args, **kwargs)#: Specifies the maximum allowable cell aspect ratio to determine the limit for the shrinkage of prism layers. This option is available only when the allow-ignore? option is disabled.

max_shrink_factor(*args, **kwargs)#: Specifies the shrink factor determining the maximum shrinkage of the prism layers. This option is available only when the allow-ignore? option is enabled.

remove_invalid_layer(*args, **kwargs)#: Removes the last prism layer if it fails in the quality check.

set_overset_prism_controls(*args, **kwargs)#: Set boundary layer controls for overset mesh generation.

set_post_mesh_controls(*args, **kwargs)#: Sets controls specific to growing prisms post volume mesh generation.

split(*args, **kwargs)#: Enables you to set parameters for splitting the prism layers after the initial prism layers are generated, to generate the total number of layers required. Specify the number of divisions per layer.

class zone_specific_growth(path, service)#

Bases: TUIMenu

Enters the prism growth controls menu.

Methods:

`apply_growth`(args, *kwargs)	Applies the zone-specific growth parameters specified.
`clear_growth`(args, *kwargs)	Clears the zone-specific growth specified.
`list_growth`(args, *kwargs)	Lists the zone-specific growth parameters specified for individual zones in the console.

apply_growth(*args, **kwargs)#: Applies the zone-specific growth parameters specified.

clear_growth(*args, **kwargs)#: Clears the zone-specific growth specified.

list_growth(*args, **kwargs)#: Lists the zone-specific growth parameters specified for individual zones in the console.

create(*args, **kwargs)#: Creates prism layers on one or more boundary face zones based on the offset method, growth method, number of layers, and rate specified.

class improve(path, service)#

Bases: TUIMenu

Enters the prism improve menu.

Methods:

`improve_prism_cells`(args, *kwargs)	Collects and smooths cells in layers around poor quality cells.
`smooth_brute_force`(args, *kwargs)	Forcibly smooths cells if cell skewness is still high after regular smoothing.
`smooth_cell_rings`(args, *kwargs)	Specifies the number of cell rings around the skewed cell used by improve-prism-cells.
`smooth_improve_prism_cells`(args, *kwargs)	Uses a combination of node movement and optimized smoothing to improve the quality.
`smooth_prism_cells`(args, *kwargs)	Enables optimization based smoothing of prism cells.
`smooth_sliver_skew`(args, *kwargs)	Specifies the skewness above which prism cells will be smoothed.

improve_prism_cells(*args, **kwargs)#: Collects and smooths cells in layers around poor quality cells. Cells with quality worse than the specified threshold value will be identified, and the nodes of the cells surrounding the poor quality cells will be moved to improve quality.

smooth_brute_force(*args, **kwargs)#: Forcibly smooths cells if cell skewness is still high after regular smoothing.

smooth_cell_rings(*args, **kwargs)#: Specifies the number of cell rings around the skewed cell used by improve-prism-cells.

smooth_improve_prism_cells(*args, **kwargs)#: Uses a combination of node movement and optimized smoothing to improve the quality. This command is a combination of the smooth-prism-cells and improve-prism-cells commands. The cell aspect ratio will also be maintained based on the value specified for max-aspect-ratio.

smooth_prism_cells(*args, **kwargs)#: Enables optimization based smoothing of prism cells. The nodes of cells with quality worse than the specified threshold value will be moved to improve quality. The cell aspect ratio will also be maintained based on the value specified for max-aspect-ratio.

smooth_sliver_skew(*args, **kwargs)#: Specifies the skewness above which prism cells will be smoothed.

list_parameters(*args, **kwargs)#: Shows all prism mesh parameters.

mark_ignore_faces(*args, **kwargs)#: Enables you to mark the faces to be ignored during prism meshing.

mark_nonmanifold_nodes(*args, **kwargs)#: Enables you to mark the non-manifold prism base nodes. A list of the non-manifold nodes will be printed in the console. The faces connected to the non-manifold nodes will also be marked. You can use this command after specifying zone-specific prism settings, prior to generating the prisms to verify that non-manifold configurations do not exist.

mark_proximity_faces(*args, **kwargs)#: Mark prism base faces with certain gap.

class post_ignore(path, service)#

Bases: TUIMenu

Contains the following options for ignoring prism cells:.

Methods:

`create_cavity`(args, *kwargs)	Creates a cavity in regions where prism quality is adequate, but the quality of adjacent tetrahedra is poor.
`mark_cavity_prism_cap`(args, *kwargs)	Marks the prism cap faces and tetrahedral cell faces bounding the cavity to be created in regions where prism quality is adequate, but the quality of adjacent tetrahedra is poor.
`mark_prism_cap`(args, *kwargs)	Marks the prism cap faces for ignoring prism cells in regions of poor quality cells and sharp corners.
`post_remove_cells`(args, *kwargs)	Enables you to remove prism cells in layers around poor quality cells and sharp corners.

create_cavity(*args, **kwargs)#: Creates a cavity in regions where prism quality is adequate, but the quality of adjacent tetrahedra is poor. The cavity is created based on the tetrahedral cell zone, the quality measure and the corresponding threshold value, and the additional number of cell rings specified. You can create a cavity comprising only tetrahedral cells or optionally include prism cells in the cavity created. When prism cells are also included in the cavity, you can specify whether the non-conformal interface is to be created.

mark_cavity_prism_cap(*args, **kwargs)#: Marks the prism cap faces and tetrahedral cell faces bounding the cavity to be created in regions where prism quality is adequate, but the quality of adjacent tetrahedra is poor. Specify the tetrahedral cell zone, the quality measure and the corresponding threshold value to be used, and the additional number of cell rings based on which the cavity will be created.

mark_prism_cap(*args, **kwargs)#: Marks the prism cap faces for ignoring prism cells in regions of poor quality cells and sharp corners. Specify the prism cell zone and the basis for ignoring prism cells and the relevant parameters. The prism cells can be ignored based on quality, intersection, (both enabled by default), warp, and features (both disabled by default). Specify the quality measure and threshold value to be used for ignoring cells based on quality and (if applicable) the feature edges for ignoring cells based on features. Additionally, specify whether cells are to be marked in regions of high aspect ratio and based on feature angle, and the additional number of cell rings based on which prism cells will be removed.

post_remove_cells(*args, **kwargs)#: Enables you to remove prism cells in layers around poor quality cells and sharp corners. Specify the prism cell zone, the basis for ignoring prism cells (quality, intersection, warp, features) and the relevant parameters. Specify the number of cell rings to be removed around the marked cells. Cells will be marked for removal in regions of sharp corners based on quality, intersection, warp, and features (as applicable) and then extended based on the number of cell rings specified. Additional cells will be marked for removal in regions of high aspect ratio and based on feature angle (if applicable) around the exposed prism side. The boundary will be smoothed at feature corners after the prism cells have been removed. The prism-side faces exposed by the removal of the prism cells will be collected in a zone named prism-side-#, while for a zone wall-n, the faces corresponding to the ignored prism cells will be collected in a zone named wall-n:ignore. You can also optionally smooth the prism side nodes from the base node to the cap node to create better triangles for the non-conformal interface.

quality_method(*args, **kwargs)#: Specifies the quality method used during prism generation.

reset_parameters(*args, **kwargs)#: Resets all prism parameters.

class split(path, service)#

Bases: TUIMenu

Contains options for splitting the prism layers after the initial prism layers are generated, to generate the total number of layers required.

Methods:

split(*args, **kwargs)

Enables you to split the prism layers after the initial prism layers are generated, to generate the total number of layers required.

split(*args, **kwargs)#: Enables you to split the prism layers after the initial prism layers are generated, to generate the total number of layers required. Specify the prism cell zones to be split and the number of divisions per layer. You can also choose to use the existing growth rate (default) or specify the growth rate to be used while splitting the prism layers.

class pyramid(path, service)#

Bases: TUIMenu

Enters the pyramid menu.

Classes:

controls(path, service)

Enters the pyramid controls menu.

Methods:

create(*args, **kwargs)

Creates a layer of pyramids on the quad face zone.

class controls(path, service)#

Bases: TUIMenu

Enters the pyramid controls menu.

Methods:

`neighbor_angle`(args, *kwargs)	Sets the threshold dihedral angle used to limit the neighboring faces considered for pyramid creation.
`offset_factor`(args, *kwargs)	Specifies the fraction of the computed pyramid height (offset) by which the pyramid heights will be randomly adjusted.
`offset_scaling`(args, *kwargs)	Specifies the scaling, to be used to determine the height of the pyramid.
`vertex_method`(args, *kwargs)	Specifies the method by which the location of the new vertex of the pyramid will be determined.

neighbor_angle(*args, **kwargs)#: Sets the threshold dihedral angle used to limit the neighboring faces considered for pyramid creation. For example, if the value is set to 110° and the angle between a given quadrilateral face and a neighboring triangular face is greater than 110°, the resulting pyramid will not include the triangular face.

offset_factor(*args, **kwargs)#: Specifies the fraction of the computed pyramid height (offset) by which the pyramid heights will be randomly adjusted. The default value is 0, indicating that all pyramids will have the exact height computed. A value of 0.1, for example, will limit each adjustment to ±10percentage of the computed height.

offset_scaling(*args, **kwargs)#: Specifies the scaling, to be used to determine the height of the pyramid.

vertex_method(*args, **kwargs)#: Specifies the method by which the location of the new vertex of the pyramid will be determined. The skewness method is used by default.

create(*args, **kwargs)#: Creates a layer of pyramids on the quad face zone.

class rapid_octree(path, service)#

Bases: TUIMenu

Enters the rapid octree menu, which provides text commands for using the Rapid Octree mesher.

Classes:

`advanced_meshing_options`(path, service)	Advanced and experimental options for octree mesh generation.
`boundary_layer_mesh_configuration`(path, service)	Define anisotropic refinements of the projection layer (prismatic layers).
`mesh_sizing`(path, service)	Enters the mesh sizing menu, which allows you to define the cell sizes.
`refinement_regions`(path, service)	Enters the rapid octree refinement region menu, which allows you to manage the refinement regions.

Methods:

`boundary_mesh_optimization`(args, *kwargs)	Enable optimization to improve orthogonality at the boundary mesh.
`boundary_treatment`(args, *kwargs)	Selects the boundary treatment option.
`bounding_box`(args, *kwargs)	Defines/modifies the bounding box around the geometry.
`create`(args, *kwargs)	Creates a mesh using the Rapid Octree mesher.
`create_stair_step_mesh`(args, *kwargs)	Create rapid octree mesh with a cartesian boundary approximation.
`delete_poor_quality_cells`(args, *kwargs)	Delete all cells with orthogonal-quality less than 0.01.
`distribute_geometry`(args, *kwargs)	Enables/disables the distribution of the input geometry across partitions / compute nodes, so that it is not copied to each process.
`dry_run`(args, *kwargs)	If yes: Just print diagnostic information, do not create a mesh.
`estimate_cell_count`(args, *kwargs)	Give a quick estimate about the expected number of cells.
`flow_volume`(args, *kwargs)	Specifies the volume to be filled by the mesh.
`geometry`(args, *kwargs)	Allows you to apply the Rapid Octree mesher to a defined mesh object or geometry object rather than all available surface zones.
`improve_geometry_resolution`(args, *kwargs)	Enables improved geometry resolution.
`is_manifold_geo`(args, *kwargs)	Set to yes if the geomety is manifold (speed up mesh generation).
`reset_bounding_box`(args, *kwargs)	Redefines the bounding box extents to encompass all of the surfaces of the currently selected geometry, and updates the base length scale used in the mesh generation process.
`undo_last_meshing_operation`(args, *kwargs)	Attempts to restore the object state (including its surfaces) as it was prior to the meshing operation performed by the Rapid Octree mesher.
`verbosity`(args, *kwargs)	Sets the verbosity of the messages printed by the Rapid Octree mesher.

class advanced_meshing_options(path, service)#

Bases: TUIMenu

Advanced and experimental options for octree mesh generation.

Methods:

`aspect_ratio_skewness_limit`(args, *kwargs)	Ignore cells with higher skew in aspect ratio improvement.
`distance_erosion_factor`(args, *kwargs)	Set distance erosion factor as a factor of prism edge length.
`mesh_optimization_scheme`(args, *kwargs)	Set optimization scheme for boundary mesh optimization in projection meshing.
`projection_priority_zones`(args, *kwargs)	Prioritize zone association of faces crossing multiple boundary zones.
`pseudo_normal_mode`(args, *kwargs)	Sets the mode for cumputing projection front sudo normals.
`rename_bounding_box_zones`(args, *kwargs)	Set flag to change naming scheme of bounding box surface zones.
`target_bnd_face_warp`(args, *kwargs)	Set target face warpage for boundary faces in mesh (-1.0 - 1.0).
`target_cell_orthoskew`(args, *kwargs)	Set target orthoskew in mesh (0.0-1.0).
`target_int_face_warp`(args, *kwargs)	Set target face warpage for interior faces in mesh (-1.0 - 1.0).

aspect_ratio_skewness_limit(*args, **kwargs)#: Ignore cells with higher skew in aspect ratio improvement.

distance_erosion_factor(*args, **kwargs)#: Set distance erosion factor as a factor of prism edge length.

mesh_optimization_scheme(*args, **kwargs)#: Set optimization scheme for boundary mesh optimization in projection meshing.

projection_priority_zones(*args, **kwargs)#: Prioritize zone association of faces crossing multiple boundary zones.

pseudo_normal_mode(*args, **kwargs)#: Sets the mode for cumputing projection front sudo normals.

rename_bounding_box_zones(*args, **kwargs)#: Set flag to change naming scheme of bounding box surface zones.

target_bnd_face_warp(*args, **kwargs)#: Set target face warpage for boundary faces in mesh (-1.0 - 1.0). Higher values are likely to increase pullback.

target_cell_orthoskew(*args, **kwargs)#: Set target orthoskew in mesh (0.0-1.0). Smaller values are likely to increase pullback.

target_int_face_warp(*args, **kwargs)#: Set target face warpage for interior faces in mesh (-1.0 - 1.0). Higher values are likely to increase pullback.

class boundary_layer_mesh_configuration(path, service)#

Bases: TUIMenu

Define anisotropic refinements of the projection layer (prismatic layers).

Methods:

`add`(args, *kwargs)	Add a boudnary layer definition.
`delete`(args, *kwargs)	Specify the number of prismatic layers for surface zones.
`delete_all`(args, *kwargs)	Specify the number of prismatic layers for surface zones.
`edit`(args, *kwargs)	Specify the number of prismatic layers for surface zones.
`list`(args, *kwargs)	Specify the number of prismatic layers for surface zones.

add(*args, **kwargs)#: Add a boudnary layer definition.

delete(*args, **kwargs)#: Specify the number of prismatic layers for surface zones.

delete_all(*args, **kwargs)#: Specify the number of prismatic layers for surface zones.

edit(*args, **kwargs)#: Specify the number of prismatic layers for surface zones.

list(*args, **kwargs)#: Specify the number of prismatic layers for surface zones.

boundary_mesh_optimization(*args, **kwargs)#: Enable optimization to improve orthogonality at the boundary mesh.

boundary_treatment(*args, **kwargs)#: Selects the boundary treatment option. Enter 0 for the Boundary Projection treatment or 1 for the Cartesian Snapping treatment.

bounding_box(*args, **kwargs)#: Defines/modifies the bounding box around the geometry.

create(*args, **kwargs)#: Creates a mesh using the Rapid Octree mesher.

create_stair_step_mesh(*args, **kwargs)#: Create rapid octree mesh with a cartesian boundary approximation.

delete_poor_quality_cells(*args, **kwargs)#: Delete all cells with orthogonal-quality less than 0.01.

distribute_geometry(*args, **kwargs)#: Enables/disables the distribution of the input geometry across partitions / compute nodes, so that it is not copied to each process. This reduces the memory requirements of the mesh generation significantly, especially for geometries with a high number of triangles. Note that this geometric distribution is enabled by default and is automatically deactivated if the geometry is not fully enclosed by the defined bounding box.

dry_run(*args, **kwargs)#: If yes: Just print diagnostic information, do not create a mesh.

estimate_cell_count(*args, **kwargs)#: Give a quick estimate about the expected number of cells.

flow_volume(*args, **kwargs)#: Specifies the volume to be filled by the mesh.

geometry(*args, **kwargs)#: Allows you to apply the Rapid Octree mesher to a defined mesh object or geometry object rather than all available surface zones. Note that using a mesh object with multiple volumetric regions allows you to generate multiple disconnected cell zones that can be coupled by a non-conformal mesh interface in the solution mode; all other input objects result in the creation of a single volume / cell zone.

improve_geometry_resolution(*args, **kwargs)#: Enables improved geometry resolution.

is_manifold_geo(*args, **kwargs)#: Set to yes if the geomety is manifold (speed up mesh generation).

class mesh_sizing(path, service)#

Bases: TUIMenu

Enters the mesh sizing menu, which allows you to define the cell sizes.

Methods:

`add_surface_sizing`(args, *kwargs)	Add a size function definition.
`boundary_cell_size`(args, *kwargs)	Sets the default cell size for the geometry.
`boundary_layers`(args, *kwargs)	Set the minimum number of constant-size cells adjacent to the geometry.
`buffer_layers`(args, *kwargs)	Set the number of buffer layers.
`change_surface_sizing`(args, *kwargs)	Change a size function definition.
`clear_all_surface_sizings`(args, *kwargs)	Delete all size function definitions.
`delete_surface_sizing`(args, *kwargs)	Delete a size function definition.
`feature_angle_refinement`(args, *kwargs)	Defines the angular threshold and number of refinement levels for features.
`list_surface_sizings`(args, *kwargs)	List all size function definitions.
`max_cell_size`(args, *kwargs)	Sets the maximum cell size in the octree mesh.
`mesh_coarsening_exponent`(args, *kwargs)	Set the exponent for mesh coarsening.
`surface_coarsening_layers`(args, *kwargs)	Set the minimum number of constant-size cells adjacent to the geometry.

add_surface_sizing(*args, **kwargs)#: Add a size function definition.

boundary_cell_size(*args, **kwargs)#: Sets the default cell size for the geometry.

boundary_layers(*args, **kwargs)#: Set the minimum number of constant-size cells adjacent to the geometry.

buffer_layers(*args, **kwargs)#: Set the number of buffer layers.

change_surface_sizing(*args, **kwargs)#: Change a size function definition.

clear_all_surface_sizings(*args, **kwargs)#: Delete all size function definitions.

delete_surface_sizing(*args, **kwargs)#: Delete a size function definition.

feature_angle_refinement(*args, **kwargs)#: Defines the angular threshold and number of refinement levels for features. This text command is only available when the Boundary Projection treatment is selected through the /mesh/rapid-octree/boundary-treatment text command.

list_surface_sizings(*args, **kwargs)#: List all size function definitions.

max_cell_size(*args, **kwargs)#: Sets the maximum cell size in the octree mesh.

mesh_coarsening_exponent(*args, **kwargs)#: Set the exponent for mesh coarsening.

surface_coarsening_layers(*args, **kwargs)#: Set the minimum number of constant-size cells adjacent to the geometry.

class refinement_regions(path, service)#

Bases: TUIMenu

Enters the rapid octree refinement region menu, which allows you to manage the refinement regions.

Methods:

`add`(args, *kwargs)	Adds a refinement region to the domain.
`delete`(args, *kwargs)	Deletes a refinement region.
`list`(args, *kwargs)	Lists all of the refinement regions.

add(*args, **kwargs)#: Adds a refinement region to the domain.

delete(*args, **kwargs)#: Deletes a refinement region.

list(*args, **kwargs)#: Lists all of the refinement regions.

reset_bounding_box(*args, **kwargs)#: Redefines the bounding box extents to encompass all of the surfaces of the currently selected geometry, and updates the base length scale used in the mesh generation process.

undo_last_meshing_operation(*args, **kwargs)#: Attempts to restore the object state (including its surfaces) as it was prior to the meshing operation performed by the Rapid Octree mesher.

verbosity(*args, **kwargs)#: Sets the verbosity of the messages printed by the Rapid Octree mesher.

repair_face_handedness(*args, **kwargs)#: Reverses face node orientation.

reset_mesh(*args, **kwargs)#: Clears the entire mesh.

reset_mesh_parameter(*args, **kwargs)#: Resets all parameters to their default value.

class scoped_prisms(path, service)#

Bases: TUIMenu

Contains options for creating scoped prism controls for mesh objects.

Methods:

`create`(args, *kwargs)	Creates a new scoped prism control based on the parameters and scope specified.
`delete`(args, *kwargs)	Deletes the specified scoped prism control.
`growth_options`(args, *kwargs)	Enables you to specify scoped prism growth options.
`list`(args, *kwargs)	Lists all the defined scoped prism controls.
`modify`(args, *kwargs)	Modifies the specified control based on the parameters specified.
`poly_keep_nlayer_prism_characteristics`(...)	Number of layers to maintain poly-prism characteristics.
`read`(args, *kwargs)	Reads in the specified scoped prism control file (*.pzmcontrol).
`set_advanced_controls`(args, *kwargs)	Used to specify various controls for scoped prisms.
`set_no_imprint_zones`(args, *kwargs)	Used to specify face zones that should not be imprinted during prism generation.
`set_overset_prism_controls`(args, *kwargs)	Set boundary layer controls for overset mesh generation.
`write`(args, *kwargs)	Writes the scoped prism controls to a prism control file (*.pzmcontrol).

create(*args, **kwargs)#: Creates a new scoped prism control based on the parameters and scope specified. Specify the name, offset method, first height or aspect ratio, number of layers, and rate or last percent. Select the mesh object and set the scope (fluid-regions, named-regions, or solid-regions). Specify the zones to grow prisms (all-zones, only-walls, selected-face-zones, or selected-labels, or solid-fluid-interface). When named-regions and/or selected-face-zones or selected-labels are selected, specify the volume and/or boundary scope. If interior baffle zones are selected, retain the option to grow prisms on both sides of the baffles or disable it to grow prisms on one side.

delete(*args, **kwargs)#: Deletes the specified scoped prism control.

growth_options(*args, **kwargs)#: Enables you to specify scoped prism growth options. Select Fix First Height if required, and specify the gap factor, maximum aspect ratio, prism quality method, and the threshold quality value for stair stepping.

list(*args, **kwargs)#: Lists all the defined scoped prism controls.

modify(*args, **kwargs)#: Modifies the specified control based on the parameters specified.

poly_keep_nlayer_prism_characteristics(*args, **kwargs)#: Number of layers to maintain poly-prism characteristics.

read(*args, **kwargs)#: Reads in the specified scoped prism control file (*.pzmcontrol).

set_advanced_controls(*args, **kwargs)#: Used to specify various controls for scoped prisms. Prompts include setting iterations for normal based prisms, smoothing, prism improvement, automatic node movement, and warp improvement. Prompts also include checks for stair-step interactions, as well as proximity, quality, and the exposure of quad quality. Automatic stair-stepping occurs during prism generation based on the proximity and quality limits. You can intentionally avoid stair-stepping by setting the last three prompts (proximity, quality, and the exposure of quad quality) to no, although you may also retain some poor quality cells.

set_no_imprint_zones(*args, **kwargs)#: Used to specify face zones that should not be imprinted during prism generation.

set_overset_prism_controls(*args, **kwargs)#: Set boundary layer controls for overset mesh generation.

write(*args, **kwargs)#: Writes the scoped prism controls to a prism control file (*.pzmcontrol). Specify the scoped prism file name.

selective_mesh_check(*args, **kwargs)#: Performs a customized mesh check on specific zones rather than all zones.

class separate(path, service)#

Bases: TUIMenu

Separates cells by various user-defined methods.

Classes:

local_regions(path, service)

Enters the local refinement menu.

Methods:

`separate_cell_by_face`(args, *kwargs)	Separates cells that are connected to a specified face zone into another cell zone.
`separate_cell_by_mark`(args, *kwargs)	Separates cells within a specified local region into another cell zone.
`separate_cell_by_region`(args, *kwargs)	Separates contiguous regions within a cell zone into separate cell zones.
`separate_cell_by_shape`(args, *kwargs)	Separates cells with different shapes (pyramids, tetrahedra, etc.) into separate cell zones.
`separate_cell_by_size`(args, *kwargs)	Separates cells based on the specified minimum and maximum cell sizes.
`separate_cell_by_skew`(args, *kwargs)	Separates cells based on the specified cell skewness.
`separate_prisms_from_hex`(args, *kwargs)	Separate prism cells from hex.
`separate_prisms_from_poly`(args, *kwargs)	Separates the poly-prism cells from the poly cells within your mesh.
`separate_wedge_prisms`(args, *kwargs)	Separate wedge-prism cells from bulk.

class local_regions(path, service)#

Bases: TUIMenu

Enters the local refinement menu.

Methods:

`define`(args, *kwargs)	Enables you to define the parameters for the refinement region.
`delete`(args, *kwargs)	Enables you to delete a refinement region.
`init`(args, *kwargs)	Deletes all current regions and adds the default refinement region.
`list_all_regions`(args, *kwargs)	Lists all the refinement regions.

define(*args, **kwargs)#: Enables you to define the parameters for the refinement region.

delete(*args, **kwargs)#: Enables you to delete a refinement region.

init(*args, **kwargs)#: Deletes all current regions and adds the default refinement region.

list_all_regions(*args, **kwargs)#: Lists all the refinement regions.

separate_cell_by_face(*args, **kwargs)#: Separates cells that are connected to a specified face zone into another cell zone. This separation method applies only to prism cells.

separate_cell_by_mark(*args, **kwargs)#: Separates cells within a specified local region into another cell zone.

separate_cell_by_region(*args, **kwargs)#: Separates contiguous regions within a cell zone into separate cell zones.

separate_cell_by_shape(*args, **kwargs)#: Separates cells with different shapes (pyramids, tetrahedra, etc.) into separate cell zones.

separate_cell_by_size(*args, **kwargs)#: Separates cells based on the specified minimum and maximum cell sizes.

separate_cell_by_skew(*args, **kwargs)#: Separates cells based on the specified cell skewness.

separate_prisms_from_hex(*args, **kwargs)#: Separate prism cells from hex.

separate_prisms_from_poly(*args, **kwargs)#: Separates the poly-prism cells from the poly cells within your mesh. Available only when the report/enhanced-orthogonal-quality? flag is set to yes, and is only supported for the .h5 format.

separate_wedge_prisms(*args, **kwargs)#: Separate wedge-prism cells from bulk.

class tet(path, service)#

Bases: TUIMenu

Enters the tetrahedral mesh menu.

Classes:

`controls`(path, service)	Enters the tet controls menu.
`improve`(path, service)	Enters the tet improve menu.
`local_regions`(path, service)	Enters the local refinement menu.

Methods:

`delete_virtual_cells`(args, *kwargs)	Deletes virtual cells created due to the use of the keep-virtual-entities? option.
`init`(args, *kwargs)	Generates the initial Delaunay mesh by meshing the boundary nodes.
`init_refine`(args, *kwargs)	Generates the tetrahedral mesh.
`mesh_object`(args, *kwargs)	Tet mesh object of type mesh.
`preserve_cell_zone`(args, *kwargs)	Allows you to specify the cell zones to be preserved during the meshing process.
`refine`(args, *kwargs)	Refines the initialized mesh.
`trace_path_between_cells`(args, *kwargs)	Detects holes in the geometry by tracing the path between the two specified cells.
`un_preserve_cell_zone`(args, *kwargs)	Un-preserve cell zone.

class controls(path, service)#

Bases: TUIMenu

Enters the tet controls menu.

Classes:

`adv_front_method`(path, service)	Enters the advancing front refinement controls menu.
`improve_mesh`(path, service)	Enters the improve mesh controls menu.
`remove_slivers`(path, service)	Enters the sliver remove controls menu.
`tet_improve`(path, service)	Improve cells controls.

Methods:

`cell_sizing`(args, *kwargs)	Specifies the cell sizing function for refinement.
`clear_zone_growth_rate`(args, *kwargs)	Clear zone specific geometric growth rates.
`compute_max_cell_volume`(args, *kwargs)	Computes the maximum cell volume for the current mesh.
`delete_dead_zones`(args, *kwargs)	Specifies the maximum allowable cell volume.
`max_cell_length`(args, *kwargs)	Specifies the maximum allowable cell length.
`max_cell_volume`(args, *kwargs)	Specifies the maximum allowable cell volume.
`non_fluid_type`(args, *kwargs)	Selects the non-fluid cell zone type.
`print_region_based_sizing`(args, *kwargs)	Displays local sizing settings (max cell length) for specified region(s).
`refine_method`(args, *kwargs)	Enables you to select the refinement method.
`set_region_based_sizing`(args, *kwargs)	Allows you to specify local sizing settings (max cell length) for specified region(s).
`set_zone_growth_rate`(args, *kwargs)	Set zone specific geometric growth rates.
`skewness_method`(args, *kwargs)	Enters the skewness refinement controls menu.
`use_max_cell_size`(args, *kwargs)	Enables you to use the maximum cell size specified instead of recomputing the value based on the objects, when the volume mesh is generated.

class adv_front_method(path, service)#

Bases: TUIMenu

Enters the advancing front refinement controls menu.

Methods:

`first_improve_params`(args, *kwargs)	Defines the refining front improvement parameters for the advancing front method.
`refine_parameters`(args, *kwargs)	Defines the cell zone improvement parameters for the advancing front method.
`second_improve_params`(args, *kwargs)	Defines the cell zone improvement parameters for the advancing front method.

Classes:

skew_improve(path, service)

Enters the refine improve controls menu.

first_improve_params(*args, **kwargs)#: Defines the refining front improvement parameters for the advancing front method.

refine_parameters(*args, **kwargs)#: Defines the cell zone improvement parameters for the advancing front method.

second_improve_params(*args, **kwargs)#: Defines the cell zone improvement parameters for the advancing front method.

class skew_improve(path, service)#

Bases: TUIMenu

Enters the refine improve controls menu.

Methods:

`attempts`(args, *kwargs)	Specifies the number of overall improvement attempts for the advancing front method.
`boundary_sliver_skew`(args, *kwargs)	Specifies the boundary sliver skewness for the advancing front method.
`iterations`(args, *kwargs)	Specifies the number of improvement iterations in each attempt for the advancing front method.
`sliver_skew`(args, *kwargs)	Specifies the sliver skewness for the advancing front method.
`target`(args, *kwargs)	Enables you to enable targeted skewness-based refinement for the advancing front method.
`target_low_skew`(args, *kwargs)	Specifies the targeted skewness threshold above which cells will be improved.
`target_skew`(args, *kwargs)	Specifies the targeted skewness during improvement for the advancing front method.

attempts(*args, **kwargs)#: Specifies the number of overall improvement attempts for the advancing front method.

boundary_sliver_skew(*args, **kwargs)#: Specifies the boundary sliver skewness for the advancing front method. This parameter is used for removing sliver cells along the boundary.

iterations(*args, **kwargs)#: Specifies the number of improvement iterations in each attempt for the advancing front method.

sliver_skew(*args, **kwargs)#: Specifies the sliver skewness for the advancing front method. This parameter is used for removing sliver cells in the interior.

target(*args, **kwargs)#: Enables you to enable targeted skewness-based refinement for the advancing front method. This option enables you to improve the mesh until the targeted skewness value is achieved.

target_low_skew(*args, **kwargs)#: Specifies the targeted skewness threshold above which cells will be improved. The improve operation will attempt to improve cells with skewness above the target-low-skew value specified, but there will be no attempt to reduce the skewness below the specified value. A limited set of improve operations will be used as compared to the operations required for the target-skew value-based improvement. The value specified could be approximately 0.1 lower than the target-skew value.

target_skew(*args, **kwargs)#: Specifies the targeted skewness during improvement for the advancing front method.

cell_sizing(*args, **kwargs)#: Specifies the cell sizing function for refinement. You can select geometric, linear, none, or size-field as appropriate.

clear_zone_growth_rate(*args, **kwargs)#: Clear zone specific geometric growth rates.

compute_max_cell_volume(*args, **kwargs)#: Computes the maximum cell volume for the current mesh.

delete_dead_zones(*args, **kwargs)#: Specifies the maximum allowable cell volume.

class improve_mesh(path, service)#

Bases: TUIMenu

Enters the improve mesh controls menu.

Methods:

`improve`(args, *kwargs)	Automatically improves the mesh.
`laplace_smooth`(args, *kwargs)	Enables you to specify the Laplace smoothing parameters.
`skewness_smooth`(args, *kwargs)	Enables you to specify the skewness smooth parameters.
`swap`(args, *kwargs)	Enables you to specify the face swap parameters.

improve(*args, **kwargs)#: Automatically improves the mesh.

laplace_smooth(*args, **kwargs)#: Enables you to specify the Laplace smoothing parameters.

skewness_smooth(*args, **kwargs)#: Enables you to specify the skewness smooth parameters.

swap(*args, **kwargs)#: Enables you to specify the face swap parameters.

max_cell_length(*args, **kwargs)#: Specifies the maximum allowable cell length.

max_cell_volume(*args, **kwargs)#: Specifies the maximum allowable cell volume.

non_fluid_type(*args, **kwargs)#: Selects the non-fluid cell zone type. After the mesh is initialized, any non-fluid zones will be set to this type. If the mesh includes multiple regions (for example, the problem for which you are creating the mesh includes a fluid zone and one or more solid zones), and you plan to refine all of them using the same refinement parameters, modify the non-fluid type before generating the mesh. For zone-based meshing, if any cell zone has at least one boundary zone type as inlet, it will automatically be set to fluid type. For object based meshing, volume region type is used to determine the cell zone type.

print_region_based_sizing(*args, **kwargs)#: Displays local sizing settings (max cell length) for specified region(s).

refine_method(*args, **kwargs)#: Enables you to select the refinement method. You can select either skewness-based refinement or the advancing front method. The skewness-based refinement option is no longer supported and will be removed at a future release.

class remove_slivers(path, service)#

Bases: TUIMenu

Enters the sliver remove controls menu.

Methods:

`angle`(args, *kwargs)	Specifies the maximum dihedral angle for considering the cell to be a sliver.
`attempts`(args, *kwargs)	Specifies the number of attempts overall to remove slivers.
`iterations`(args, *kwargs)	Specifies the number of iterations to be performed for the specific sliver removal operation.
`low_skew`(args, *kwargs)	Specifies the targeted skewness threshold above which cells will be improved.
`method`(args, *kwargs)	Enables you to select the method for sliver removal.
`remove`(args, *kwargs)	Enables/disables the automatic removal of slivers.
`skew`(args, *kwargs)	Specifies the skewness threshold for sliver removal.

angle(*args, **kwargs)#: Specifies the maximum dihedral angle for considering the cell to be a sliver.

attempts(*args, **kwargs)#: Specifies the number of attempts overall to remove slivers.

iterations(*args, **kwargs)#: Specifies the number of iterations to be performed for the specific sliver removal operation.

low_skew(*args, **kwargs)#: Specifies the targeted skewness threshold above which cells will be improved. The improve operation will attempt to improve cells with skewness above the low-skew value specified, but there will be no attempt to reduce the skewness below the specified value. A limited set of improve operations will be used as compared to the operations required for the skew value-based improvement.

method(*args, **kwargs)#: Enables you to select the method for sliver removal. The default method used is the fast method. The fast and the aggressive methods use the same controls and give similar results for good quality surface meshes. In case of poor surface meshes, the aggressive method will typically succeed in improving the mesh to a greater extent, but it may be slower than the fast method.

remove(*args, **kwargs)#: Enables/disables the automatic removal of slivers.

skew(*args, **kwargs)#: Specifies the skewness threshold for sliver removal.

set_region_based_sizing(*args, **kwargs)#: Allows you to specify local sizing settings (max cell length) for specified region(s).

set_zone_growth_rate(*args, **kwargs)#: Set zone specific geometric growth rates.

skewness_method(*args, **kwargs)#: Enters the skewness refinement controls menu.

class tet_improve(path, service)#

Bases: TUIMenu

Improve cells controls.

Methods:

`angle`(args, *kwargs)	Max dihedral angle defining a valid boundary cell.
`attempts`(args, *kwargs)	Improve attempts.
`iterations`(args, *kwargs)	Improve iterations.
`skew`(args, *kwargs)	Remove skew.

angle(*args, **kwargs)#: Max dihedral angle defining a valid boundary cell.

attempts(*args, **kwargs)#: Improve attempts.

iterations(*args, **kwargs)#: Improve iterations.

skew(*args, **kwargs)#: Remove skew.

use_max_cell_size(*args, **kwargs)#: Enables you to use the maximum cell size specified instead of recomputing the value based on the objects, when the volume mesh is generated. This option is disabled by default.

delete_virtual_cells(*args, **kwargs)#: Deletes virtual cells created due to the use of the keep-virtual-entities? option.

class improve(path, service)#

Bases: TUIMenu

Enters the tet improve menu.

Methods:

`collapse_slivers`(args, *kwargs)	Attempts to collapse the nodes of a skewed sliver cell on any one of its neighbors.
`improve_cells`(args, *kwargs)	Improves skewed tetrahedral cells.
`refine_boundary_slivers`(args, *kwargs)	Attempts to increase the volume of boundary slivers to create a valid tet cell.
`refine_slivers`(args, *kwargs)	Attempts to remove the sliver by placing a node at or near the centroid of the sliver cell.
`skew_smooth_nodes`(args, *kwargs)	Applies skewness-based smoothing to nodes on the tetrahedral cell zones to improve the mesh quality.
`sliver_boundary_swap`(args, *kwargs)	Removes boundary slivers by moving the boundary to exclude the cells from the zone.
`smooth_boundary_sliver`(args, *kwargs)	Smooths nodes on sliver cells having all four nodes on the boundary until the skewness value is less than the specified value.
`smooth_interior_sliver`(args, *kwargs)	Smooths non-boundary nodes on sliver cells having skewness greater than the specified threshold value.
`smooth_nodes`(args, *kwargs)	Enables you to apply either Laplacian or variational smoothing to nodes on the tetrahedral cell zones to improve the mesh quality.
`swap_faces`(args, *kwargs)	Performs interior face swapping to improve cell skewness.

collapse_slivers(*args, **kwargs)#: Attempts to collapse the nodes of a skewed sliver cell on any one of its neighbors.

improve_cells(*args, **kwargs)#: Improves skewed tetrahedral cells.

refine_boundary_slivers(*args, **kwargs)#: Attempts to increase the volume of boundary slivers to create a valid tet cell. Tetrahedra having one or two faces on the boundary are identified and then the appropriate edge split. The split node is then smoothed such that the volume of the tetrahedron increases, thereby creating a valid tet cell.

refine_slivers(*args, **kwargs)#: Attempts to remove the sliver by placing a node at or near the centroid of the sliver cell. Swapping and smoothing are performed to improve the skewness. You can also specify whether boundary cells are to be refined. Refining the boundary cells may enable you to carry out further improvement options such as smoothing, swapping, and collapsing slivers.

skew_smooth_nodes(*args, **kwargs)#: Applies skewness-based smoothing to nodes on the tetrahedral cell zones to improve the mesh quality.

sliver_boundary_swap(*args, **kwargs)#: Removes boundary slivers by moving the boundary to exclude the cells from the zone.

smooth_boundary_sliver(*args, **kwargs)#: Smooths nodes on sliver cells having all four nodes on the boundary until the skewness value is less than the specified value. The default values for the skewness threshold, minimum dihedral angle between boundary faces, and feature angle are 0.985, 10, and 30, respectively.

smooth_interior_sliver(*args, **kwargs)#: Smooths non-boundary nodes on sliver cells having skewness greater than the specified threshold value. The default value for the skewness threshold is 0.985.

smooth_nodes(*args, **kwargs)#: Enables you to apply either Laplacian or variational smoothing to nodes on the tetrahedral cell zones to improve the mesh quality.

swap_faces(*args, **kwargs)#: Performs interior face swapping to improve cell skewness.

init(*args, **kwargs)#: Generates the initial Delaunay mesh by meshing the boundary nodes.

init_refine(*args, **kwargs)#: Generates the tetrahedral mesh.

class local_regions(path, service)#

Bases: TUIMenu

Enters the local refinement menu.

Methods:

`activate`(args, *kwargs)	Activates the specified regions for refinement.
`deactivate`(args, *kwargs)	Deactivates the specified regions for refinement.
`define`(args, *kwargs)	Defines the refinement region according to the specified parameters.
`delete`(args, *kwargs)	Deletes the specified refinement region.
`ideal_area`(args, *kwargs)	Ideal triangle area for given edge length.
`ideal_vol`(args, *kwargs)	Reports the volume of an ideal tetrahedron for the edge length specified.
`init`(args, *kwargs)	Defines the default refinement region encompassing the entire geometry.
`list_all_regions`(args, *kwargs)	Lists all refinement region parameters and the activated regions in the console.
`refine`(args, *kwargs)	Refines the active cells inside the selected region based on the specified refinement parameters.

activate(*args, **kwargs)#: Activates the specified regions for refinement.

deactivate(*args, **kwargs)#: Deactivates the specified regions for refinement.

define(*args, **kwargs)#: Defines the refinement region according to the specified parameters.

delete(*args, **kwargs)#: Deletes the specified refinement region.

ideal_area(*args, **kwargs)#: Ideal triangle area for given edge length.

ideal_vol(*args, **kwargs)#: Reports the volume of an ideal tetrahedron for the edge length specified.

init(*args, **kwargs)#: Defines the default refinement region encompassing the entire geometry.

list_all_regions(*args, **kwargs)#: Lists all refinement region parameters and the activated regions in the console.

refine(*args, **kwargs)#: Refines the active cells inside the selected region based on the specified refinement parameters.

mesh_object(*args, **kwargs)#: Tet mesh object of type mesh.

preserve_cell_zone(*args, **kwargs)#: Allows you to specify the cell zones to be preserved during the meshing process.

refine(*args, **kwargs)#: Refines the initialized mesh.

trace_path_between_cells(*args, **kwargs)#: Detects holes in the geometry by tracing the path between the two specified cells.

un_preserve_cell_zone(*args, **kwargs)#: Un-preserve cell zone.

class thin_volume_mesh(path, service)#

Bases: TUIMenu

Creates a sweep-like mesh for a body occupying a thin gap. You define source and target boundary faces zones (the source face normal should point to the target). The source face mesh may be triangles or quads.

Methods:

create(*args, **kwargs)

Initiates the dialog box to specify source and target faces and specify the following parameters.

create(*args, **kwargs)#: Initiates the dialog box to specify source and target faces and specify the following parameters.

zone_names_clean_up(*args, **kwargs)#

class objects(path, service)#

Bases: TUIMenu

Manage objects.

Classes:

`cad_association`(path, service)	Contains options for modifying the selected objects based on the associated CAD entities and attaching/detaching the CAD entities from the objects.
`create_new_mesh_object`(path, service)	Contains options for creating a new mesh object by wrapping or remeshing existing objects.
`deprecated`(path, service)	Deprecated features.
`fix_holes`(path, service)	Fix holes in surface mesh using octree.
`join_intersect`(path, service)	Contains options for connecting overlapping and intersecting face zones.
`labels`(path, service)	Contains options for creating and managing face zone labels.
`remove_gaps`(path, service)	Contains options for removing gaps between the mesh objects specified or removing the thickness in the mesh objects specified.
`set`(path, service)	Contains options for setting additional object-related settings.
`volumetric_regions`(path, service)	Manage volumetric regions of an object.
`wrap`(path, service)	Contains options related to the object wrapping operation.

Methods:

`change_object_type`(args, *kwargs)	Allows you to change the object type (geom, or mesh).
`change_prefix`(args, *kwargs)	Change the prefix for specified objects.
`change_suffix`(args, *kwargs)	Change the suffix for specified objects.
`check_mesh`(args, *kwargs)	Checks the mesh on the specified objects for connectivity and orientation of faces.
`clear_backup`(args, *kwargs)	Clear backup data of objects.
`create`(args, *kwargs)	Creates the object based on the priority, cell zone type, face zone(s), edge zone(s), and object type specified.
`create_and_activate_domain`(args, *kwargs)	Creates and activates the domain comprising the face zone(s) from the object(s) specified.
`create_groups`(args, *kwargs)	Creates a face group and an edge group comprising the face zone(s) and edge zone(s) included in the specified object(s), respectively.
`create_intersection_loops`(args, *kwargs)	Allows you to create intersection loops for objects.
`create_multiple`(args, *kwargs)	Creates multiple objects by creating an object per face zone specified.
`delete`(args, *kwargs)	Deletes the specified object(s).
`delete_all`(args, *kwargs)	Deletes all the defined objects.
`delete_all_geom`(args, *kwargs)	Deletes all the defined geom objects.
`delete_unreferenced_faces_and_edges`(*args, ...)	Deletes all the faces and edges that are not included in any defined objects.
`extract_edges`(args, *kwargs)	Extracts the edge zone(s) from the face zone(s) included in the specified object(s), based on the edge-feature-angle value specified (/objects/set/set-edge-feature-angle).
`improve_feature_capture`(args, *kwargs)	Enables you to imprint the edges comprising the object on to the object face zones to improve feature capture for mesh objects.
`improve_object_quality`(args, *kwargs)	Enables you to improve the surface mesh quality for mesh objects.
`list`(args, *kwargs)	Lists details such as cell zone type, priority, object type, comprising face and edge zones, and object reference point for all the defined objects.
`merge`(args, *kwargs)	Merges the specified objects into a single object.
`merge_edges`(args, *kwargs)	Merges all the edge zones in an object into a single edge zone.
`merge_nodes`(args, *kwargs)	Merges the free nodes at the object level based on the specified tolerance or using a tolerance that is a specified percentage of shortest connected edge length.
`merge_voids`(args, *kwargs)	Allows you to merge voids in the mesh object after the sewing operation.
`merge_walls`(args, *kwargs)	Merges all the face zones of type wall in an object into a single face zone.
`rename_cell_zone_boundaries_using_labels`(...)	Renames the boundaries of the cell zones based on the existing face zone labels.
`rename_object`(args, *kwargs)	Allows you to rename a specified geometry or mesh object with another specified name.
`rename_object_zones`(args, *kwargs)	Renames the face and edge zones comprising the object based on the object name.
`restore_faces`(args, *kwargs)	Restores the mesh object surface mesh from the backup created.
`rotate`(args, *kwargs)	Rotates the object(s) based on the angle of rotation, pivot point, and axis of rotation specified.
`scale`(args, *kwargs)	Scales the object(s) based on the scale factors specified.
`separate_faces_by_angle`(args, *kwargs)	Separates the face zone(s) comprising the object based on the angle specified.
`separate_faces_by_seed`(args, *kwargs)	Separates the face zone(s) comprising the object based on the seed face specified.
`sew`(args, *kwargs)	Contains options related to the object sewing operation.
`summary`(args, *kwargs)	Allows you to obtain a summary of a specified geometry or mesh object, or obtain a summary of all geometry or mesh objects.
`translate`(args, *kwargs)	Translates the object(s) based on the translation offsets specified.
`update`(args, *kwargs)	Allows you to update the objects defined when the face and/or edge zone(s) comprising the object have been deleted.

class cad_association(path, service)#

Bases: TUIMenu

Contains options for modifying the selected objects based on the associated CAD entities and attaching/detaching the CAD entities from the objects. This menu is available when the CAD Assemblies tree is created during CAD import.

Methods:

`attach_cad`(args, *kwargs)	Attaches CAD entities to the selected geometry/mesh objects.
`detach_all_objects`(args, *kwargs)	Detaches all the CAD objects associated with the geometry/mesh objects.
`detach_objects`(args, *kwargs)	Detaches the CAD objects associated with the specified geometry/mesh objects.
`query_object_association`(args, *kwargs)	Returns a list of the CAD entities associated with the objects selected.
`restore_cad`(args, *kwargs)	Restores the geometry/mesh objects from the associated CAD objects.
`unlock_cad`(args, *kwargs)	Unlocks the CAD objects associated with the selected geometry/mesh objects.
`update_all_objects`(args, *kwargs)	Updates all geometry/mesh objects based on changes to the associated CAD objects.
`update_objects`(args, *kwargs)	Updates the specified geometry/mesh objects based on changes to the associated CAD objects.

attach_cad(*args, **kwargs)#: Attaches CAD entities to the selected geometry/mesh objects. Select the geometry/mesh objects and specify the path for the CAD entities to be associated with the objects. The selected geometry/mesh objects will be associated with the CAD entities which will then be locked.

detach_all_objects(*args, **kwargs)#: Detaches all the CAD objects associated with the geometry/mesh objects. Specify the type of objects (geom or mesh) to be detached. All association will be removed and the geometry/mesh objects will be independent of changes to the CAD entities.

detach_objects(*args, **kwargs)#: Detaches the CAD objects associated with the specified geometry/mesh objects. All association will be removed and the selected geometry/mesh objects will be independent of changes to the CAD entities.

query_object_association(*args, **kwargs)#: Returns a list of the CAD entities associated with the objects selected.

restore_cad(*args, **kwargs)#: Restores the geometry/mesh objects from the associated CAD objects.

unlock_cad(*args, **kwargs)#: Unlocks the CAD objects associated with the selected geometry/mesh objects.

update_all_objects(*args, **kwargs)#: Updates all geometry/mesh objects based on changes to the associated CAD objects. Specify the type of objects (geom or mesh) to be updated.

update_objects(*args, **kwargs)#: Updates the specified geometry/mesh objects based on changes to the associated CAD objects.

change_object_type(*args, **kwargs)#: Allows you to change the object type (geom, or mesh).

change_prefix(*args, **kwargs)#: Change the prefix for specified objects.

change_suffix(*args, **kwargs)#: Change the suffix for specified objects.

check_mesh(*args, **kwargs)#: Checks the mesh on the specified objects for connectivity and orientation of faces. The domain extents, volume statistics, and face area statistics will be reported along with the results of other checks on the mesh.

clear_backup(*args, **kwargs)#: Clear backup data of objects.

create(*args, **kwargs)#: Creates the object based on the priority, cell zone type, face zone(s), edge zone(s), and object type specified. You can specify the object name or retain the default blank entry to have the object name generated automatically.

create_and_activate_domain(*args, **kwargs)#: Creates and activates the domain comprising the face zone(s) from the object(s) specified.

create_groups(*args, **kwargs)#: Creates a face group and an edge group comprising the face zone(s) and edge zone(s) included in the specified object(s), respectively.

create_intersection_loops(*args, **kwargs)#: Allows you to create intersection loops for objects.

create_multiple(*args, **kwargs)#: Creates multiple objects by creating an object per face zone specified. The objects will be named automatically based on the prefix and priority specified.

class create_new_mesh_object(path, service)#

Bases: TUIMenu

Contains options for creating a new mesh object by wrapping or remeshing existing objects.

Methods:

`remesh`(args, *kwargs)	Creates a new mesh object by remeshing geometry objects individually or collectively.
`wrap`(args, *kwargs)	Creates a new mesh object by wrapping the specified objects individually or collectively.

remesh(*args, **kwargs)#: Creates a new mesh object by remeshing geometry objects individually or collectively.

wrap(*args, **kwargs)#: Creates a new mesh object by wrapping the specified objects individually or collectively.

delete(*args, **kwargs)#: Deletes the specified object(s).

delete_all(*args, **kwargs)#: Deletes all the defined objects.

delete_all_geom(*args, **kwargs)#: Deletes all the defined geom objects.

delete_unreferenced_faces_and_edges(*args, **kwargs)#: Deletes all the faces and edges that are not included in any defined objects.

class deprecated(path, service)#

Bases: TUIMenu

Deprecated features.

Methods:

create_mesh_object_from_wrap(*args, **kwargs)

Create mesh object from a wrap object.

create_mesh_object_from_wrap(*args, **kwargs)#: Create mesh object from a wrap object.

extract_edges(*args, **kwargs)#: Extracts the edge zone(s) from the face zone(s) included in the specified object(s), based on the edge-feature-angle value specified (/objects/set/set-edge-feature-angle).

class fix_holes(path, service)#

Bases: TUIMenu

Fix holes in surface mesh using octree.

Classes:

advanced(path, service)

Advanced fix holes options.

Methods:

`find_holes`(args, *kwargs)	Find holes in objects using octree.
`open_all_holes`(args, *kwargs)	Open all wetted holes of the material point.
`open_holes`(args, *kwargs)	Open holes even not connected by material point.
`patch_all_holes`(args, *kwargs)	Patch all wetted holes of the material point.
`patch_holes`(args, *kwargs)	Patch holes even not connected by material point.
`reset_material_point`(args, *kwargs)	Reset material point of of region of interest.
`shrink_wrap`(args, *kwargs)	Shrink wrap wetted region of material point.

class advanced(path, service)#

Bases: TUIMenu

Advanced fix holes options.

Methods:

`open_holes_between_material_points`(*args, ...)	Open holes separating the material points to merge them.
`open_holes_connected_to_material_points`(...)	Open all holes wetted by material points.
`open_holes_not_connected_to_material_points`(...)	Open all holes other than holes wetted by material points.
`open_traced_holes_between_material_points`(...)	Trace a path between material points and open holes part of the traced path.
`patch_holes_between_material_points`(*args, ...)	Patch holes separating the material points.
`patch_holes_connected_to_material_points`(...)	Patch all holes wetted by material points.
`patch_holes_not_connected_to_material_points`(...)	Patch all holes other than holes wetted by material points.

open_holes_between_material_points(*args, **kwargs)#: Open holes separating the material points to merge them.

open_holes_connected_to_material_points(*args, **kwargs)#: Open all holes wetted by material points.

open_holes_not_connected_to_material_points(*args, **kwargs)#: Open all holes other than holes wetted by material points.

open_traced_holes_between_material_points(*args, **kwargs)#: Trace a path between material points and open holes part of the traced path.

patch_holes_between_material_points(*args, **kwargs)#: Patch holes separating the material points.

patch_holes_connected_to_material_points(*args, **kwargs)#: Patch all holes wetted by material points.

patch_holes_not_connected_to_material_points(*args, **kwargs)#: Patch all holes other than holes wetted by material points.

find_holes(*args, **kwargs)#: Find holes in objects using octree.

open_all_holes(*args, **kwargs)#: Open all wetted holes of the material point.

open_holes(*args, **kwargs)#: Open holes even not connected by material point.

patch_all_holes(*args, **kwargs)#: Patch all wetted holes of the material point.

patch_holes(*args, **kwargs)#: Patch holes even not connected by material point.

reset_material_point(*args, **kwargs)#: Reset material point of of region of interest.

shrink_wrap(*args, **kwargs)#: Shrink wrap wetted region of material point.

improve_feature_capture(*args, **kwargs)#: Enables you to imprint the edges comprising the object on to the object face zones to improve feature capture for mesh objects. You can specify the number of imprinting iterations to be performed. The geometry objects used to create the mesh objects should be available when the improve-feature-capture command is invoked. Additionally, the face zones comprising the objects should be of type other than geometry.

improve_object_quality(*args, **kwargs)#: Enables you to improve the surface mesh quality for mesh objects. Select the mesh objects and the method for improving the surface mesh. The smooth-and-improve method improves the mesh by a combination of smoothing, swapping, and surface mesh improvement operations. Object normals are correctly oriented and island faces are also deleted. You can optionally coarsen the surface mesh by specifying a suitable coarsening factor. Additional imprinting operations can be done to improve feature capture on the surface mesh. The surface-remesh method improves the mesh by remeshing based on the current size field. Object normals are correctly oriented and island faces are also deleted.

class join_intersect(path, service)#

Bases: TUIMenu

Contains options for connecting overlapping and intersecting face zones.

Methods:

`add_objects_to_mesh_object`(args, *kwargs)	Allows you to specify one or more mesh objects to be added to an existing mesh object.
`change_region_type`(args, *kwargs)	Allows you to select a cell zone type (solid, fluid or dead) for a specific region.
`compute_regions`(args, *kwargs)	Closed cell zone regions are computed from the specified mesh object.
`create_mesh_object`(args, *kwargs)	Allows you to specify one or more mesh objects to be connected in one mesh object.
`delete_region`(args, *kwargs)	Removes a closed cell zone region and all of its face zones, except those which are shared by other regions, from the specified mesh object.
`intersect`(args, *kwargs)	Connects two intersecting face zones within specified angle and tolerance.
`join`(args, *kwargs)	Connects two overlapping face zones within specified angle and tolerance.
`list_regions`(args, *kwargs)	Lists details of region type, volume, material point, and comprising face zones for the topological regions computed for the specified mesh object.
`merge_regions`(args, *kwargs)	Specified regions are joined into a single region.
`rename_region`(args, *kwargs)	Enables you to specify a new name for a specified region.

Classes:

controls(path, service)

Build topology controls.

add_objects_to_mesh_object(*args, **kwargs)#: Allows you to specify one or more mesh objects to be added to an existing mesh object.

change_region_type(*args, **kwargs)#: Allows you to select a cell zone type (solid, fluid or dead) for a specific region.

compute_regions(*args, **kwargs)#: Closed cell zone regions are computed from the specified mesh object. You may include a material point, if desired.

class controls(path, service)#

Bases: TUIMenu

Build topology controls.

Methods:

remesh_post_intersection(*args, **kwargs)

Used to enable or disable automatic post-remesh operation after join or intersect.

remesh_post_intersection(*args, **kwargs)#: Used to enable or disable automatic post-remesh operation after join or intersect.

create_mesh_object(*args, **kwargs)#: Allows you to specify one or more mesh objects to be connected in one mesh object.

delete_region(*args, **kwargs)#: Removes a closed cell zone region and all of its face zones, except those which are shared by other regions, from the specified mesh object.

intersect(*args, **kwargs)#: Connects two intersecting face zones within specified angle and tolerance.

join(*args, **kwargs)#: Connects two overlapping face zones within specified angle and tolerance.

list_regions(*args, **kwargs)#: Lists details of region type, volume, material point, and comprising face zones for the topological regions computed for the specified mesh object.

merge_regions(*args, **kwargs)#: Specified regions are joined into a single region.

rename_region(*args, **kwargs)#: Enables you to specify a new name for a specified region.

class labels(path, service)#

Bases: TUIMenu

Contains options for creating and managing face zone labels.

Methods:

`add_zones`(args, *kwargs)	Adds the specified face zones to the existing face zone label for an object.
`create`(args, *kwargs)	Creates a new face zone label for the specified face zones.
`create_label_per_object`(args, *kwargs)	Creates a new face zone label for all the face zones in every object.
`create_label_per_zone`(args, *kwargs)	Creates a new face zone label for each face zone in the object.
`delete`(args, *kwargs)	Deletes the specified face zone labels.
`label_unlabeled_zones`(args, *kwargs)	Creates labels for unlabeled face zones within the specified object.
`merge`(args, *kwargs)	Merges the specified face zone labels to a single label with the name specified.
`remove_all_labels_on_zones`(args, *kwargs)	Removes all the face zone labels for the specified face zones.
`remove_zones`(args, *kwargs)	Removes the specified face zones from the existing face zone label for an object.
`rename`(args, *kwargs)	Renames the specified face zone label.

Classes:

cavity(path, service)

Enter menu to create cavity using labels.

add_zones(*args, **kwargs)#: Adds the specified face zones to the existing face zone label for an object.

class cavity(path, service)#

Bases: TUIMenu

Enter menu to create cavity using labels.

Methods:

`add`(args, *kwargs)	Create cavity by adding labels from another mesh object.
`remove`(args, *kwargs)	Create cavity by removing labels.
`replace`(args, *kwargs)	Create cavity by replacing labels from another mesh object.

add(*args, **kwargs)#: Create cavity by adding labels from another mesh object.

remove(*args, **kwargs)#: Create cavity by removing labels.

replace(*args, **kwargs)#: Create cavity by replacing labels from another mesh object.

create(*args, **kwargs)#: Creates a new face zone label for the specified face zones.

create_label_per_object(*args, **kwargs)#: Creates a new face zone label for all the face zones in every object.

create_label_per_zone(*args, **kwargs)#: Creates a new face zone label for each face zone in the object.

delete(*args, **kwargs)#: Deletes the specified face zone labels.

label_unlabeled_zones(*args, **kwargs)#: Creates labels for unlabeled face zones within the specified object. You can either use the object name as the label or provide your own label.

merge(*args, **kwargs)#: Merges the specified face zone labels to a single label with the name specified.

remove_all_labels_on_zones(*args, **kwargs)#: Removes all the face zone labels for the specified face zones. This command is applicable to geometry objects only.

remove_zones(*args, **kwargs)#: Removes the specified face zones from the existing face zone label for an object.

rename(*args, **kwargs)#: Renames the specified face zone label.

list(*args, **kwargs)#: Lists details such as cell zone type, priority, object type, comprising face and edge zones, and object reference point for all the defined objects.

merge(*args, **kwargs)#: Merges the specified objects into a single object.

merge_edges(*args, **kwargs)#: Merges all the edge zones in an object into a single edge zone. If the object is composed of edge zones of different types (boundary and interior), the edge zones of the same type (boundary or interior) will be merged into a single edge zone.

merge_nodes(*args, **kwargs)#: Merges the free nodes at the object level based on the specified tolerance or using a tolerance that is a specified percentage of shortest connected edge length.

merge_voids(*args, **kwargs)#: Allows you to merge voids in the mesh object after the sewing operation.

merge_walls(*args, **kwargs)#: Merges all the face zones of type wall in an object into a single face zone.

class remove_gaps(path, service)#

Bases: TUIMenu

Contains options for removing gaps between the mesh objects specified or removing the thickness in the mesh objects specified.

Methods:

`ignore_orientation`(args, *kwargs)	Allows you to set whether the orientation of the normals should be taken into account while identifying the gap to be removed.
`remove_gaps`(args, *kwargs)	Allows you to remove gaps between the mesh objects specified or remove the thickness in the mesh objects specified.
`show_gaps`(args, *kwargs)	Marks the faces at the gap between mesh objects based on the gap distance and percentage margin specified.

ignore_orientation(*args, **kwargs)#: Allows you to set whether the orientation of the normals should be taken into account while identifying the gap to be removed.

remove_gaps(*args, **kwargs)#: Allows you to remove gaps between the mesh objects specified or remove the thickness in the mesh objects specified. Select the appropriate repair option and specify the other parameters required.

show_gaps(*args, **kwargs)#: Marks the faces at the gap between mesh objects based on the gap distance and percentage margin specified.

rename_cell_zone_boundaries_using_labels(*args, **kwargs)#: Renames the boundaries of the cell zones based on the existing face zone labels. This allows for the cell zone boundaries in solution mode to have names corresponding to the face zone labels in meshing mode. This command will not work if you read in a volume mesh generated in a version prior to release 16.2. In such cases, regenerate the volume mesh before using the command.

rename_object(*args, **kwargs)#: Allows you to rename a specified geometry or mesh object with another specified name.

rename_object_zones(*args, **kwargs)#: Renames the face and edge zones comprising the object based on the object name. You can also specify the separator to be used.

restore_faces(*args, **kwargs)#: Restores the mesh object surface mesh from the backup created. The current mesh object face zones and cell zones will be deleted. If the object backup is disabled (/mesh/auto-mesh-controls/backup-object no), you will not be able to restore the surface mesh using this command. There may be a difference in the initial volume mesh generated for an object and that generated after restoring the object surface mesh due to differences in the order of zones/entities processed during volume meshing.

rotate(*args, **kwargs)#: Rotates the object(s) based on the angle of rotation, pivot point, and axis of rotation specified.

scale(*args, **kwargs)#: Scales the object(s) based on the scale factors specified.

separate_faces_by_angle(*args, **kwargs)#: Separates the face zone(s) comprising the object based on the angle specified.

separate_faces_by_seed(*args, **kwargs)#: Separates the face zone(s) comprising the object based on the seed face specified.

class set(path, service)#

Bases: TUIMenu

Contains options for setting additional object-related settings.

Methods:

`set_edge_feature_angle`(args, *kwargs)	Sets the edge feature angle to be used for extracting edge zone(s) from the face zone(s) included in the object(s).
`show_edge_zones`(args, *kwargs)	Displays the edge zone(s) comprising the object(s) drawn in the graphics window.
`show_face_zones`(args, *kwargs)	Displays the face zone(s) comprising the object(s) drawn in the graphics window.

set_edge_feature_angle(*args, **kwargs)#: Sets the edge feature angle to be used for extracting edge zone(s) from the face zone(s) included in the object(s).

show_edge_zones(*args, **kwargs)#: Displays the edge zone(s) comprising the object(s) drawn in the graphics window.

show_face_zones(*args, **kwargs)#: Displays the face zone(s) comprising the object(s) drawn in the graphics window.

sew(*args, **kwargs)#: Contains options related to the object sewing operation. This menu is no longer supported, and will be removed in a future release.

summary(*args, **kwargs)#: Allows you to obtain a summary of a specified geometry or mesh object, or obtain a summary of all geometry or mesh objects.

translate(*args, **kwargs)#: Translates the object(s) based on the translation offsets specified.

update(*args, **kwargs)#: Allows you to update the objects defined when the face and/or edge zone(s) comprising the object have been deleted.

class volumetric_regions(path, service)#

Bases: TUIMenu

Manage volumetric regions of an object.

Methods:

`auto_fill_volume`(args, *kwargs)	Creates the volume mesh for the selected volumetric regions based on the meshing parameters set.
`change_type`(args, *kwargs)	Enables you to change the region type.
`compute`(args, *kwargs)	Computes the volumetric regions based on the face zone labels.
`delete`(args, *kwargs)	Deletes the specified volumetric regions.
`delete_cells`(args, *kwargs)	Deletes the cell zones of the specified regions.
`fill_empty_volume`(args, *kwargs)	Fill empty volume of selected regions.
`list`(args, *kwargs)	Prints region information to the console, including type, volume, material point and face zones.
`merge`(args, *kwargs)	Merges specified regions in to a single region.
`merge_cells`(args, *kwargs)	Merge all cell zones assocaited to a region.
`rename`(args, *kwargs)	Renames the region.
`update`(args, *kwargs)	Recomputes the selected volumetric region(s) while preserving the region name(s) and type(s).

Classes:

`hexcore`(path, service)	Contains options for setting hexcore mesh controls.
`scoped_prism`(path, service)	Contains options for setting scoped prism controls.
`tet`(path, service)	Contains options for setting tetrahedral mesh controls.

auto_fill_volume(*args, **kwargs)#: Creates the volume mesh for the selected volumetric regions based on the meshing parameters set.

change_type(*args, **kwargs)#: Enables you to change the region type.

compute(*args, **kwargs)#: Computes the volumetric regions based on the face zone labels. You can choose to use existing material points for computing the regions. When regions are computed, region names and types will be based on the face zone labels of the mesh object selected. If regions are recomputed, all previous region names and types will be over written.

delete(*args, **kwargs)#: Deletes the specified volumetric regions.

delete_cells(*args, **kwargs)#: Deletes the cell zones of the specified regions.

fill_empty_volume(*args, **kwargs)#: Fill empty volume of selected regions.

class hexcore(path, service)#

Bases: TUIMenu

Contains options for setting hexcore mesh controls. See mesh/.

Methods:

generate(*args, **kwargs)

Fill empty volume of selected regions with hexcore.

Classes:

set(path, service)

Enter hexcore settings.

generate(*args, **kwargs)#: Fill empty volume of selected regions with hexcore.

class set(path, service)#

Bases: TUIMenu

Enter hexcore settings.

Methods:

`avoid_1_by_8_cell_jump_in_hexcore`(*args, ...)	Avoid-1:8-cell-jump-in-hexcore.
`buffer_layers`(args, *kwargs)	Number of addition cells to mark for subdivision.
`compute_max_cell_length`(args, *kwargs)	Compute maximum cell length.
`define_hexcore_extents`(args, *kwargs)	Enables sspecificaton of hexcore outer domain parameters.
`delete_dead_zones`(args, *kwargs)	Delete dead zones after hexcore creation.
`maximum_cell_length`(args, *kwargs)	Maximum cell length.
`maximum_initial_cells`(args, *kwargs)	Maximum number of initial Cartesian cells.
`merge_tets_to_pyramids`(args, *kwargs)	Merge tets into pyramids.
`non_fluid_type`(args, *kwargs)	Set non fluid type for cell zones.
`octree_hexcore`(args, *kwargs)	Create hexcore using size-function driven octree.
`peel_layers`(args, *kwargs)	Number of hexcore cells to peel back from boundary.
`print_region_based_sizing`(args, *kwargs)	Print region based sizings.
`set_region_based_sizing`(args, *kwargs)	Set region based sizings.
`skip_tet_refinement`(args, *kwargs)	Skip tethedral refinement in transition cell generation.

Classes:

outer_domain_params(path, service)

Define outer domain parameters.

avoid_1_by_8_cell_jump_in_hexcore(*args, **kwargs)#: Avoid-1:8-cell-jump-in-hexcore.

buffer_layers(*args, **kwargs)#: Number of addition cells to mark for subdivision.

compute_max_cell_length(*args, **kwargs)#: Compute maximum cell length.

define_hexcore_extents(*args, **kwargs)#: Enables sspecificaton of hexcore outer domain parameters.

delete_dead_zones(*args, **kwargs)#: Delete dead zones after hexcore creation.

maximum_cell_length(*args, **kwargs)#: Maximum cell length.

maximum_initial_cells(*args, **kwargs)#: Maximum number of initial Cartesian cells.

merge_tets_to_pyramids(*args, **kwargs)#: Merge tets into pyramids.

non_fluid_type(*args, **kwargs)#: Set non fluid type for cell zones.

octree_hexcore(*args, **kwargs)#: Create hexcore using size-function driven octree.

class outer_domain_params(path, service)#

Bases: TUIMenu

Define outer domain parameters.

Methods:

`auto_align`(args, *kwargs)	Enable auto-align?.
`auto_align_boundaries`(args, *kwargs)	Auto-align selected boundaries.
`auto_align_tolerance`(args, *kwargs)	Set auto-align-tolerance.
`boundaries`(args, *kwargs)	Set box-aligned zones which have to be removed from hexcore meshing.
`coordinates`(args, *kwargs)	Secifiy coordinates of outer box.
`delete_old_face_zones`(args, *kwargs)	Delete replaced old tri face zones.
`list`(args, *kwargs)	List the face zones selected for hexcore up to boundaries.
`specify_boundaries`(args, *kwargs)	Set parameters to get hex mesh to boundary(s).
`specify_coordinates`(args, *kwargs)	Enables specification of coordinates of hexcore outer box.

auto_align(*args, **kwargs)#: Enable auto-align?.

auto_align_boundaries(*args, **kwargs)#: Auto-align selected boundaries.

auto_align_tolerance(*args, **kwargs)#: Set auto-align-tolerance.

boundaries(*args, **kwargs)#: Set box-aligned zones which have to be removed from hexcore meshing.

coordinates(*args, **kwargs)#: Secifiy coordinates of outer box.

delete_old_face_zones(*args, **kwargs)#: Delete replaced old tri face zones.

list(*args, **kwargs)#: List the face zones selected for hexcore up to boundaries.

specify_boundaries(*args, **kwargs)#: Set parameters to get hex mesh to boundary(s).

specify_coordinates(*args, **kwargs)#: Enables specification of coordinates of hexcore outer box.

peel_layers(*args, **kwargs)#: Number of hexcore cells to peel back from boundary.

print_region_based_sizing(*args, **kwargs)#: Print region based sizings.

set_region_based_sizing(*args, **kwargs)#: Set region based sizings.

skip_tet_refinement(*args, **kwargs)#: Skip tethedral refinement in transition cell generation.

list(*args, **kwargs)#: Prints region information to the console, including type, volume, material point and face zones.

merge(*args, **kwargs)#: Merges specified regions in to a single region. If there are shared face zones, merging regions will delete the shared face zones. However, if there are cell zones associated with the regions, then merging the regions will not delete the shared face zones. In this case, the shared face zones will be deleted when the cell zones are deleted.

merge_cells(*args, **kwargs)#: Merge all cell zones assocaited to a region.

rename(*args, **kwargs)#: Renames the region.

class scoped_prism(path, service)#

Bases: TUIMenu

Contains options for setting scoped prism controls.

Methods:

generate(*args, **kwargs)

Grow prism into selected region using scoped prism controls.

Classes:

set(path, service)

Enter scoped prism settings.

generate(*args, **kwargs)#: Grow prism into selected region using scoped prism controls.

class set(path, service)#

Bases: TUIMenu

Enter scoped prism settings.

Methods:

`create`(args, *kwargs)	Create new scoped prism.
`delete`(args, *kwargs)	Delete scoped prisms.
`growth_options`(args, *kwargs)	Set scoped prisms growth options.
`list`(args, *kwargs)	List all scoped prisms parameters.
`modify`(args, *kwargs)	Modify scoped prisms.
`poly_keep_nlayer_prism_characteristics`(...)	Number of layers to maintain poly-prism characteristics.
`read`(args, *kwargs)	Read scoped prisms from a file.
`set_advanced_controls`(args, *kwargs)	Set scoped boundary layer controls.
`set_no_imprint_zones`(args, *kwargs)	Set zones which should not be imprinted during prism generation.
`set_overset_prism_controls`(args, *kwargs)	Set boundary layer controls for overset mesh generation.
`write`(args, *kwargs)	Write scoped prisms to a file.

create(*args, **kwargs)#: Create new scoped prism.

delete(*args, **kwargs)#: Delete scoped prisms.

growth_options(*args, **kwargs)#: Set scoped prisms growth options.

list(*args, **kwargs)#: List all scoped prisms parameters.

modify(*args, **kwargs)#: Modify scoped prisms.

poly_keep_nlayer_prism_characteristics(*args, **kwargs)#: Number of layers to maintain poly-prism characteristics.

read(*args, **kwargs)#: Read scoped prisms from a file.

set_advanced_controls(*args, **kwargs)#: Set scoped boundary layer controls.

set_no_imprint_zones(*args, **kwargs)#: Set zones which should not be imprinted during prism generation.

set_overset_prism_controls(*args, **kwargs)#: Set boundary layer controls for overset mesh generation.

write(*args, **kwargs)#: Write scoped prisms to a file.

class tet(path, service)#

Bases: TUIMenu

Contains options for setting tetrahedral mesh controls. See mesh/.

Methods:

generate(*args, **kwargs)

Fill empty volume of selected regions with tets.

Classes:

set(path, service)

Enter tet settings.

generate(*args, **kwargs)#: Fill empty volume of selected regions with tets.

class set(path, service)#

Bases: TUIMenu

Enter tet settings.

Classes:

`adv_front_method`(path, service)	Advancing front refinement controls.
`improve_mesh`(path, service)	Improve mesh controls.
`remove_slivers`(path, service)	Sliver remove controls.
`tet_improve`(path, service)	Improve cells controls.

Methods:

`cell_sizing`(args, *kwargs)	Allow cell volume distribution to be determined based on boundary.
`clear_zone_growth_rate`(args, *kwargs)	Clear zone specific geometric growth rates.
`compute_max_cell_volume`(args, *kwargs)	Computes max cell size.
`delete_dead_zones`(args, *kwargs)	Automatically delete dead face and cell zones?.
`max_cell_length`(args, *kwargs)	Set max-cell-length.
`max_cell_volume`(args, *kwargs)	Set max-cell-volume.
`non_fluid_type`(args, *kwargs)	Select the default non-fluid cell zone type.
`print_region_based_sizing`(args, *kwargs)	Print region based sizings.
`refine_method`(args, *kwargs)	Define refinement method.
`set_region_based_sizing`(args, *kwargs)	Set region based sizings.
`set_zone_growth_rate`(args, *kwargs)	Set zone specific geometric growth rates.
`skewness_method`(args, *kwargs)	Skewness refinement controls.
`use_max_cell_size`(args, *kwargs)	Use max cell size for objects in auto-mesh and do not recompute it based on the object being meshed.

class adv_front_method(path, service)#

Bases: TUIMenu

Advancing front refinement controls.

Methods:

`first_improve_params`(args, *kwargs)	Define refine front improve parameters.
`refine_parameters`(args, *kwargs)	Define refine parameters.
`second_improve_params`(args, *kwargs)	Define cell zone improve parameters.

Classes:

skew_improve(path, service)

Refine improve controls.

first_improve_params(*args, **kwargs)#: Define refine front improve parameters.

refine_parameters(*args, **kwargs)#: Define refine parameters.

second_improve_params(*args, **kwargs)#: Define cell zone improve parameters.

class skew_improve(path, service)#

Bases: TUIMenu

Refine improve controls.

Methods:

`attempts`(args, *kwargs)	Refine improve attempts.
`boundary_sliver_skew`(args, *kwargs)	Refine improve boundary sliver skew.
`iterations`(args, *kwargs)	Refine improve iterations.
`sliver_skew`(args, *kwargs)	Refine improve sliver skew.
`target`(args, *kwargs)	Activate target skew refinement.
`target_low_skew`(args, *kwargs)	Refine improve target low skew.
`target_skew`(args, *kwargs)	Refine improve target skew.

attempts(*args, **kwargs)#: Refine improve attempts.

boundary_sliver_skew(*args, **kwargs)#: Refine improve boundary sliver skew.

iterations(*args, **kwargs)#: Refine improve iterations.

sliver_skew(*args, **kwargs)#: Refine improve sliver skew.

target(*args, **kwargs)#: Activate target skew refinement.

target_low_skew(*args, **kwargs)#: Refine improve target low skew.

target_skew(*args, **kwargs)#: Refine improve target skew.

cell_sizing(*args, **kwargs)#: Allow cell volume distribution to be determined based on boundary.

clear_zone_growth_rate(*args, **kwargs)#: Clear zone specific geometric growth rates.

compute_max_cell_volume(*args, **kwargs)#: Computes max cell size.

delete_dead_zones(*args, **kwargs)#: Automatically delete dead face and cell zones?.

class improve_mesh(path, service)#

Bases: TUIMenu

Improve mesh controls.

Methods:

`improve`(args, *kwargs)	Automatically improve mesh.
`laplace_smooth`(args, *kwargs)	Laplace smooth parameters.
`skewness_smooth`(args, *kwargs)	Skewness smooth parametersx.
`swap`(args, *kwargs)	Face swap parameters.

improve(*args, **kwargs)#: Automatically improve mesh.

laplace_smooth(*args, **kwargs)#: Laplace smooth parameters.

skewness_smooth(*args, **kwargs)#: Skewness smooth parametersx.

swap(*args, **kwargs)#: Face swap parameters.

max_cell_length(*args, **kwargs)#: Set max-cell-length.

max_cell_volume(*args, **kwargs)#: Set max-cell-volume.

non_fluid_type(*args, **kwargs)#: Select the default non-fluid cell zone type.

print_region_based_sizing(*args, **kwargs)#: Print region based sizings.

refine_method(*args, **kwargs)#: Define refinement method.

class remove_slivers(path, service)#

Bases: TUIMenu

Sliver remove controls.

Methods:

`angle`(args, *kwargs)	Max dihedral angle defining a valid boundary sliver.
`attempts`(args, *kwargs)	Sliver remove attempts.
`iterations`(args, *kwargs)	Sliver remove iterations.
`low_skew`(args, *kwargs)	Remove sliver low skew.
`method`(args, *kwargs)	Sliver remove method.
`remove`(args, *kwargs)	Automatically remove slivers.
`skew`(args, *kwargs)	Remove sliver skew.

angle(*args, **kwargs)#: Max dihedral angle defining a valid boundary sliver.

attempts(*args, **kwargs)#: Sliver remove attempts.

iterations(*args, **kwargs)#: Sliver remove iterations.

low_skew(*args, **kwargs)#: Remove sliver low skew.

method(*args, **kwargs)#: Sliver remove method.

remove(*args, **kwargs)#: Automatically remove slivers.

skew(*args, **kwargs)#: Remove sliver skew.

set_region_based_sizing(*args, **kwargs)#: Set region based sizings.

set_zone_growth_rate(*args, **kwargs)#: Set zone specific geometric growth rates.

skewness_method(*args, **kwargs)#: Skewness refinement controls.

class tet_improve(path, service)#

Bases: TUIMenu

Improve cells controls.

Methods:

`angle`(args, *kwargs)	Max dihedral angle defining a valid boundary cell.
`attempts`(args, *kwargs)	Improve attempts.
`iterations`(args, *kwargs)	Improve iterations.
`skew`(args, *kwargs)	Remove skew.

angle(*args, **kwargs)#: Max dihedral angle defining a valid boundary cell.

attempts(*args, **kwargs)#: Improve attempts.

iterations(*args, **kwargs)#: Improve iterations.

skew(*args, **kwargs)#: Remove skew.

use_max_cell_size(*args, **kwargs)#: Use max cell size for objects in auto-mesh and do not recompute it based on the object being meshed.

update(*args, **kwargs)#: Recomputes the selected volumetric region(s) while preserving the region name(s) and type(s).

class wrap(path, service)#

Bases: TUIMenu

Contains options related to the object wrapping operation.

Methods:

`check_holes`(args, *kwargs)	Allows you to check for holes in the objects.
`debug`(args, *kwargs)	Debug from intermediate objects.
`object_zone_separate`(args, *kwargs)	Separate Object Face Zones.
`wrap`(args, *kwargs)	Creates the mesh objects based on the geometry objects selected and other object wrapping parameters specified.

Classes:

set(path, service)

Contains additional options related to the object wrapping operation.

check_holes(*args, **kwargs)#: Allows you to check for holes in the objects. The number of hole faces marked will be reported.

debug(*args, **kwargs)#: Debug from intermediate objects.

object_zone_separate(*args, **kwargs)#: Separate Object Face Zones.

class set(path, service)#

Bases: TUIMenu

Contains additional options related to the object wrapping operation.

Methods:

`add_geometry_recovery_level_to_zones`(*args, ...)	Enables you to set the geometry recovery level (high or low) for the specified face zones.
`delete_far_edges`(args, *kwargs)	Delete-far-edges-after-wrap.
`include_thin_cut_edges_and_faces`(args, *kwargs)	Allows better recovery of thin region configurations during the object wrapping operation.
`list_zones_geometry_recovery_levels`(*args, ...)	Lists the zones based on geometry recovery level specified.
`max_free_edges_for_hole_patching`(args, *kwargs)	Allows you to set the maximum number of free edges in a loop to fill the holes.
`minimum_relative_topo_area`(args, *kwargs)	Specifies the minimum relative topological area for shrink wrapping.
`minimum_relative_topo_count`(args, *kwargs)	Specifies the minimum relative topological count for shrink wrapping.
`minimum_topo_area`(args, *kwargs)	Specifies the minimum topological area for shrink wrapping.
`minimum_topo_count`(args, *kwargs)	Specifies the minimum topological count for shrink wrapping.
`relative_feature_tolerance`(args, *kwargs)	Specifies the relative feature tolerance for shrink wrapping.
`report_holes`(args, *kwargs)	Allows you to check for holes in the mesh object created.
`resolution_factor`(args, *kwargs)	Sets the resolution factor for shrink wrapping.
`shrink_wrap_rezone_parameters`(args, *kwargs)	Allows you to set the parameters for improving the mesh object surface quality using rezoning.
`use_ray_tracing`(args, *kwargs)	Use ray tracing.
`use_smooth_folded_faces`(args, *kwargs)	Use smooth folded faces.
`zone_name_prefix`(args, *kwargs)	Allows you to specify a prefix for the zones included in the mesh object created using the object wrapping operation.

add_geometry_recovery_level_to_zones(*args, **kwargs)#: Enables you to set the geometry recovery level (high or low) for the specified face zones.

delete_far_edges(*args, **kwargs)#: Delete-far-edges-after-wrap.

include_thin_cut_edges_and_faces(*args, **kwargs)#: Allows better recovery of thin region configurations during the object wrapping operation.

list_zones_geometry_recovery_levels(*args, **kwargs)#: Lists the zones based on geometry recovery level specified.

max_free_edges_for_hole_patching(*args, **kwargs)#: Allows you to set the maximum number of free edges in a loop to fill the holes.

minimum_relative_topo_area(*args, **kwargs)#: Specifies the minimum relative topological area for shrink wrapping.

minimum_relative_topo_count(*args, **kwargs)#: Specifies the minimum relative topological count for shrink wrapping.

minimum_topo_area(*args, **kwargs)#: Specifies the minimum topological area for shrink wrapping.

minimum_topo_count(*args, **kwargs)#: Specifies the minimum topological count for shrink wrapping.

relative_feature_tolerance(*args, **kwargs)#: Specifies the relative feature tolerance for shrink wrapping.

report_holes(*args, **kwargs)#: Allows you to check for holes in the mesh object created. Holes, if any will be reported at the end of the object wrapping operation.

resolution_factor(*args, **kwargs)#: Sets the resolution factor for shrink wrapping. This option can be used to set sampling coarser or finer than the final surface mesh.

shrink_wrap_rezone_parameters(*args, **kwargs)#: Allows you to set the parameters for improving the mesh object surface quality using rezoning. The geometry object zones will be separated based on the separation angle specified to improve the feature imprinting on the mesh object.

use_ray_tracing(*args, **kwargs)#: Use ray tracing.

use_smooth_folded_faces(*args, **kwargs)#: Use smooth folded faces.

zone_name_prefix(*args, **kwargs)#: Allows you to specify a prefix for the zones included in the mesh object created using the object wrapping operation.

wrap(*args, **kwargs)#: Creates the mesh objects based on the geometry objects selected and other object wrapping parameters specified.

class openmp_controls(path, service)#

Bases: TUIMenu

Enter the openmp menu.

Methods:

`get_active_cores`(args, *kwargs)	Number of Active Cores.
`get_max_cores`(args, *kwargs)	Max Number of Cores.
`set_num_cores`(args, *kwargs)	Enter Number of Cores.

get_active_cores(*args, **kwargs)#: Number of Active Cores.

get_max_cores(*args, **kwargs)#: Max Number of Cores.

set_num_cores(*args, **kwargs)#: Enter Number of Cores.

class parallel(path, service)#

Bases: TUIMenu

Enter the parallel menu.

Methods:

`agglomerate`(args, *kwargs)	Recombines distributed mesh data into a single partition on compute node 0.
`auto_partition`(args, *kwargs)	Automatically partitions face-zones for parallel meshing.
`print_partition_info`(args, *kwargs)	Displays computed partition data to the console.
`spawn_solver_processes`(args, *kwargs)	Specifies the number of solver processes.
`thread_number_control`(args, *kwargs)	Controls the maximum number of threads on each machine.

agglomerate(*args, **kwargs)#: Recombines distributed mesh data into a single partition on compute node 0.

auto_partition(*args, **kwargs)#: Automatically partitions face-zones for parallel meshing.

print_partition_info(*args, **kwargs)#: Displays computed partition data to the console.

spawn_solver_processes(*args, **kwargs)#: Specifies the number of solver processes. Additional processes will be spawned as necessary when switching to solution mode in Linux with the default MPI. You will also be prompted for (Linux and mixed Windows/Linux) interconnect type, machine list or host file, and (Linux and mixed Windows/Linux) option to be used.

thread_number_control(*args, **kwargs)#: Controls the maximum number of threads on each machine.

class preferences(path, service)#

Bases: TUIMenu

Set preferences.

Classes:

`appearance`(path, service)	Enter the menu for preferences covering appearance.
`general`(path, service)	Enter the menu for general preferences.
`gpuapp`(path, service)	.
`graphics`(path, service)	Enter the menu for preferences covering appearance.
`mat_pro_app`(path, service)	.
`meshing_workflow`(path, service)	Enter the menu for preferences covering the Fluent Meshing workflows.
`navigation`(path, service)	Enter the menu for controlling navigation in ANSYS Fluent.
`parametric_study`(path, service)	.
`simulation`(path, service)	.
`turbo_workflow`(path, service)	.

class appearance(path, service)#

Bases: TUIMenu

Enter the menu for preferences covering appearance.

Classes:

`ansys_logo`(path, service)	Enter the menu for controlling Ansys logo visibility.
`charts`(path, service)	Enter the menu for controlling the display of 2D charts/plots.
`selections`(path, service)	Enters the menu for controlling selections in the graphics window.

Methods:

`application_font_size`(args, *kwargs)	.
`axis_triad`(args, *kwargs)	Enable or disable the visibility of the axis triad in the graphics window.
`color_theme`(args, *kwargs)	Specify a color theme for the appearance of ANSYS Fluent.
`completer`(args, *kwargs)	Enable/disable the console automatic-completer, which suggests available commands as you type in the console.
`custom_title_bar`(args, *kwargs)	.
`default_view`(args, *kwargs)	.
`graphics_background_color1`(args, *kwargs)	Controls the primary background color of the graphics window.
`graphics_background_color2`(args, *kwargs)	Controls the secondary background color when the style is set as a gradient.
`graphics_background_style`(args, *kwargs)	Specify whether the background color is uniform or if there is a gradient.
`graphics_color_theme`(args, *kwargs)	.
`graphics_default_manual_face_color`(*args, ...)	.
`graphics_default_manual_node_color`(*args, ...)	.
`graphics_edge_color`(args, *kwargs)	.
`graphics_foreground_color`(args, *kwargs)	Specify the color of graphics window text.
`graphics_partition_boundary_color`(*args, ...)	.
`graphics_surface_color`(args, *kwargs)	.
`graphics_title_window_framecolor`(args, *kwargs)	.
`graphics_view`(args, *kwargs)	Specify whether the default view is orthographic or perspective.
`graphics_wall_face_color`(args, *kwargs)	Set the default face color for when the mesh is displayed.
`group_by_tree_view`(args, *kwargs)	Specify how boundary conditions are grouped in the tree.
`model_color_scheme`(args, *kwargs)	.
`number_of_files_recently_used`(args, *kwargs)	Controls how many recently-used files are listed in the File ribbon tab and the Fluent Launcher.
`number_of_pastel_colors`(args, *kwargs)	.
`pastel_color_saturation`(args, *kwargs)	.
`pastel_color_value`(args, *kwargs)	.
`quick_property_view`(args, *kwargs)	Enables/Disables the "quick-edit" properties panels that appear when you select a boundary in the graphics windows.
`ruler`(args, *kwargs)	Adds or removes the ruler from the graphics window.
`show_enabled_models`(args, *kwargs)	.
`show_interface_children_zone`(args, *kwargs)	Enable/disable the showing of the non-overlapping zones and interior zones associated with one-to-one mesh interfaces under Setup / Boundary Conditions (under their zone types) in the outline view tree.
`show_model_edges`(args, *kwargs)	Enable/disable whether mesh edges are shown in a mesh display.
`solution_mode_edge_color_in_meshing_mode`(...)	.
`surface_emissivity`(args, *kwargs)	.
`surface_specularity`(args, *kwargs)	Specify the specularity of all surfaces except those included in contour plots.
`surface_specularity_for_contours`(args, *kwargs)	.
`titles`(args, *kwargs)	Enable/disable the display of solver information in the graphics window.
`titles_border_offset`(args, *kwargs)	.

class ansys_logo(path, service)#

Bases: TUIMenu

Enter the menu for controlling Ansys logo visibility.

Methods:

`color`(args, *kwargs)	Specify whether the Ansys logo is white or black.
`visible`(args, *kwargs)	Enable or disable the visibility of the Ansys logo in the graphics window.

color(*args, **kwargs)#: Specify whether the Ansys logo is white or black.

visible(*args, **kwargs)#: Enable or disable the visibility of the Ansys logo in the graphics window.

application_font_size(*args, **kwargs)#: .

axis_triad(*args, **kwargs)#: Enable or disable the visibility of the axis triad in the graphics window.

class charts(path, service)#

Bases: TUIMenu

Enter the menu for controlling the display of 2D charts/plots.

Methods:

`curve_colors`(args, *kwargs)	Specify the initial set of default colors for the rendering of curves.
`enable_open_glfor_modern_plots`(args, *kwargs)	.
`legend_alignment`(args, *kwargs)	.
`legend_visibility`(args, *kwargs)	.
`modern_plots_enabled`(args, *kwargs)	Enables enhanced plots, which is a beta feature.
`modern_plots_points_threshold`(args, *kwargs)	.
`plots_behavior`(args, *kwargs)	.
`print_plot_data`(args, *kwargs)	.
`print_residuals_data`(args, *kwargs)	.
`threshold`(args, *kwargs)	.
`tooltip_interpolation`(args, *kwargs)	.

Classes:

font(path, service)

text_color(path, service)

curve_colors(*args, **kwargs)#: Specify the initial set of default colors for the rendering of curves. Note that changing this setting requires any plots to be replotted before you see the effect of the new setting.

enable_open_glfor_modern_plots(*args, **kwargs)#: .

class font(path, service)#

Bases: TUIMenu

Methods:

`axes`(args, *kwargs)	.
`axes_titles`(args, *kwargs)	.
`legend`(args, *kwargs)	.
`title`(args, *kwargs)	.

axes(*args, **kwargs)#: .

axes_titles(*args, **kwargs)#: .

legend(*args, **kwargs)#: .

title(*args, **kwargs)#: .

legend_alignment(*args, **kwargs)#: .

legend_visibility(*args, **kwargs)#: .

modern_plots_enabled(*args, **kwargs)#: Enables enhanced plots, which is a beta feature. Enabling this feature exposes new fields (all beta functionality).

modern_plots_points_threshold(*args, **kwargs)#: .

plots_behavior(*args, **kwargs)#: .

print_plot_data(*args, **kwargs)#: .

print_residuals_data(*args, **kwargs)#: .

class text_color(path, service)#

Bases: TUIMenu

Methods:

`axes`(args, *kwargs)	.
`axes_titles`(args, *kwargs)	.
`legend`(args, *kwargs)	.
`title`(args, *kwargs)	.

axes(*args, **kwargs)#: .

axes_titles(*args, **kwargs)#: .

legend(*args, **kwargs)#: .

title(*args, **kwargs)#: .

threshold(*args, **kwargs)#: .

tooltip_interpolation(*args, **kwargs)#: .

color_theme(*args, **kwargs)#: Specify a color theme for the appearance of ANSYS Fluent.

completer(*args, **kwargs)#: Enable/disable the console automatic-completer, which suggests available commands as you type in the console.

custom_title_bar(*args, **kwargs)#: .

default_view(*args, **kwargs)#: .

graphics_background_color1(*args, **kwargs)#: Controls the primary background color of the graphics window.

graphics_background_color2(*args, **kwargs)#: Controls the secondary background color when the style is set as a gradient.

graphics_background_style(*args, **kwargs)#: Specify whether the background color is uniform or if there is a gradient.

graphics_color_theme(*args, **kwargs)#: .

graphics_default_manual_face_color(*args, **kwargs)#: .

graphics_default_manual_node_color(*args, **kwargs)#: .

graphics_edge_color(*args, **kwargs)#: .

graphics_foreground_color(*args, **kwargs)#: Specify the color of graphics window text.

graphics_partition_boundary_color(*args, **kwargs)#: .

graphics_surface_color(*args, **kwargs)#: .

graphics_title_window_framecolor(*args, **kwargs)#: .

graphics_view(*args, **kwargs)#: Specify whether the default view is orthographic or perspective.

graphics_wall_face_color(*args, **kwargs)#: Set the default face color for when the mesh is displayed.

group_by_tree_view(*args, **kwargs)#: Specify how boundary conditions are grouped in the tree.

model_color_scheme(*args, **kwargs)#: .

number_of_files_recently_used(*args, **kwargs)#: Controls how many recently-used files are listed in the File ribbon tab and the Fluent Launcher.

number_of_pastel_colors(*args, **kwargs)#: .

pastel_color_saturation(*args, **kwargs)#: .

pastel_color_value(*args, **kwargs)#: .

quick_property_view(*args, **kwargs)#: Enables/Disables the “quick-edit” properties panels that appear when you select a boundary in the graphics windows.

ruler(*args, **kwargs)#: Adds or removes the ruler from the graphics window. Note that you must be in orthographic view for the ruler to be visible in the graphics window.

class selections(path, service)#

Bases: TUIMenu

Enters the menu for controlling selections in the graphics window.

Methods:

`general_displacement`(args, *kwargs)	.
`highlight_edge_color`(args, *kwargs)	Specifies the color used to highlight edges when the Hover-Over Highlight feature is enabled (mouse-over-highlight-enabled).
`highlight_edge_weight`(args, *kwargs)	Specifies the thickness of the edge highlights when the Hover-Over Highlight feature is enabled (mouse-over-highlight-enabled).
`highlight_face_color`(args, *kwargs)	Specify which color indicates that a face is selected.
`highlight_gloss`(args, *kwargs)	.
`highlight_specular_component`(args, *kwargs)	.
`highlight_transparency`(args, *kwargs)	Specify the transparency of the coloring on a selected surface.
`mouse_hover_probe_values_enabled`(args, *kwargs)	.
`mouse_over_highlight_enabled`(args, *kwargs)	Enable/disable the highlighted outline of a surface when hovered-over.
`probe_tooltip_hide_delay_timer`(args, *kwargs)	.
`probe_tooltip_show_delay_timer`(args, *kwargs)	.

general_displacement(*args, **kwargs)#: .

highlight_edge_color(*args, **kwargs)#: Specifies the color used to highlight edges when the Hover-Over Highlight feature is enabled (mouse-over-highlight-enabled).

highlight_edge_weight(*args, **kwargs)#: Specifies the thickness of the edge highlights when the Hover-Over Highlight feature is enabled (mouse-over-highlight-enabled).

highlight_face_color(*args, **kwargs)#: Specify which color indicates that a face is selected.

highlight_gloss(*args, **kwargs)#: .

highlight_specular_component(*args, **kwargs)#: .

highlight_transparency(*args, **kwargs)#: Specify the transparency of the coloring on a selected surface. 0.1 is fully opaque and 1 is fully transparent.

mouse_hover_probe_values_enabled(*args, **kwargs)#: .

mouse_over_highlight_enabled(*args, **kwargs)#: Enable/disable the highlighted outline of a surface when hovered-over. Note that objects must be redisplayed after changing this setting before the new setting is visible.

probe_tooltip_hide_delay_timer(*args, **kwargs)#: .

probe_tooltip_show_delay_timer(*args, **kwargs)#: .

show_enabled_models(*args, **kwargs)#: .

show_interface_children_zone(*args, **kwargs)#: Enable/disable the showing of the non-overlapping zones and interior zones associated with one-to-one mesh interfaces under Setup / Boundary Conditions (under their zone types) in the outline view tree.

show_model_edges(*args, **kwargs)#: Enable/disable whether mesh edges are shown in a mesh display.

solution_mode_edge_color_in_meshing_mode(*args, **kwargs)#: .

surface_emissivity(*args, **kwargs)#: .

surface_specularity(*args, **kwargs)#: Specify the specularity of all surfaces except those included in contour plots. Sepecularity is the reflectiveness of a surface; higher values (closer to 1) equate to a more reflective surface.

surface_specularity_for_contours(*args, **kwargs)#: .

titles(*args, **kwargs)#: Enable/disable the display of solver information in the graphics window.

titles_border_offset(*args, **kwargs)#: .

class general(path, service)#

Bases: TUIMenu

Enter the menu for general preferences.

Methods:

`advanced_partition`(args, *kwargs)	.
`automatic_transcript`(args, *kwargs)	Enable/disable the automatic creation of a transcript file for each ANSYS Fluent session.
`default_ioformat`(args, *kwargs)	.
`dock_editor`(args, *kwargs)	.
`enable_parametric_study`(args, *kwargs)	.
`flow_model`(args, *kwargs)	.
`idle_timeout`(args, *kwargs)	Specify the default file format for saving case and data files.
`initial_physics_volume_definitions`(*args, ...)	.
`key_behavioral_changes_message`(args, *kwargs)	.
`laplace_auto_partition_default`(args, *kwargs)	.
`qaservice_message`(args, *kwargs)	.
`utlcreate_physics_on_mode_change`(args, *kwargs)	.
`utlmode`(args, *kwargs)	.

advanced_partition(*args, **kwargs)#: .

automatic_transcript(*args, **kwargs)#: Enable/disable the automatic creation of a transcript file for each ANSYS Fluent session.

default_ioformat(*args, **kwargs)#: .

dock_editor(*args, **kwargs)#: .

enable_parametric_study(*args, **kwargs)#: .

flow_model(*args, **kwargs)#: .

idle_timeout(*args, **kwargs)#: Specify the default file format for saving case and data files.

initial_physics_volume_definitions(*args, **kwargs)#: .

key_behavioral_changes_message(*args, **kwargs)#: .

laplace_auto_partition_default(*args, **kwargs)#: .

qaservice_message(*args, **kwargs)#: .

utlcreate_physics_on_mode_change(*args, **kwargs)#: .

utlmode(*args, **kwargs)#: .

class gpuapp(path, service)#

Bases: TUIMenu

Methods:

alpha_features(*args, **kwargs)

alpha_features(*args, **kwargs)#: .

class graphics(path, service)#

Bases: TUIMenu

Enter the menu for preferences covering appearance.

Methods:

`animation_option`(args, *kwargs)	Specify whether the entire model or just a wireframe is shown during manipulations in the graphics window.
`double_buffering`(args, *kwargs)	Enable/disable double-buffering, which reduces screen flicker, but may use more memory on some machines.
`enable_non_object_based_workflow`(args, *kwargs)	.
`event_poll_interval`(args, *kwargs)	.
`event_poll_timeout`(args, *kwargs)	.
`force_key_frame_animation_markers_to_off`(...)	.
`graphics_window_line_width`(args, *kwargs)	Specify the thickness of lines that appear in the graphics window.
`graphics_window_point_symbol`(args, *kwargs)	Specify the symbol used for indicating points in the graphics window (like the points in an XY plot).
`hidden_surface_removal_method`(args, *kwargs)	Specify the method for removing hidden surfaces.
`higher_resolution_graphics_window_line_width`(...)	.
`lower_resolution_graphics_window_line_width`(...)	.
`marker_drawing_mode`(args, *kwargs)	.
`max_graphics_text_size`(args, *kwargs)	.
`min_graphics_text_size`(args, *kwargs)	.
`plot_legend_margin`(args, *kwargs)	.
`point_tool_size`(args, *kwargs)	Specify the size of the point tool (10-100).
`remove_partition_lines`(args, *kwargs)	.
`remove_partition_lines_tolerance`(args, *kwargs)	.
`rotation_centerpoint_visible`(args, *kwargs)	.
`scroll_wheel_event_end_timer`(args, *kwargs)	.
`set_camera_normal_to_surface_increments`(...)	.
`show_hidden_lines`(args, *kwargs)	.
`show_hidden_surfaces`(args, *kwargs)	Enable/disable the display of hidden surfaces.
`switch_to_open_glfor_remote_visualization`(...)	.
`test_use_external_function`(args, *kwargs)	.
`text_window_line_width`(args, *kwargs)	.

Classes:

`boundary_markers`(path, service)	Enter the boundary markers menu.
`colormap_settings`(path, service)	Enter the colormap settings menu.
`embedded_windows`(path, service)	.
`export_video_settings`(path, service)	.
`graphics_effects`(path, service)	Enter the graphics effects menu.
`hardcopy_settings`(path, service)	Enter the menu for saving picture settings.
`lighting`(path, service)	Enter the lighting menu.
`manage_hoops_memory`(path, service)	.
`material_effects`(path, service)	.
`meshing_mode`(path, service)	Enter the menu for meshing-specific graphics settings.
`performance`(path, service)	Enter the menu for selecting the predefined graphics effects settings.
`transparency`(path, service)	.
`vector_settings`(path, service)	.

animation_option(*args, **kwargs)#: Specify whether the entire model or just a wireframe is shown during manipulations in the graphics window.

class boundary_markers(path, service)#

Bases: TUIMenu

Enter the boundary markers menu.

Methods:

`color_option`(args, *kwargs)	Specify whether boundary markers are a fixed color or if they match the color of the surface they are identifying.
`enabled`(args, *kwargs)	Enable/disable boundary marker display.
`exclude_from_bounding`(args, *kwargs)	.
`inlet_color`(args, *kwargs)	Specify the color of the inlet boundary markers.
`marker_fraction`(args, *kwargs)	Specify marker density factor (0.1-1).
`marker_size_limiting_scale_multiplier`(*args, ...)	.
`markers_limit`(args, *kwargs)	.
`outlet_color`(args, *kwargs)	Specify the color of the outlet boundary markers.
`scale_marker`(args, *kwargs)	Specify the scale factor for the boundary markers (0.1-10), which controls the overall size of the markers.
`show_inlet_markers`(args, *kwargs)	Enable/disable the display of boundary markers for inlets.
`show_outlet_markers`(args, *kwargs)	Enable/disable the display of boundary markers for outlets.

color_option(*args, **kwargs)#: Specify whether boundary markers are a fixed color or if they match the color of the surface they are identifying.

enabled(*args, **kwargs)#: Enable/disable boundary marker display.

exclude_from_bounding(*args, **kwargs)#: .

inlet_color(*args, **kwargs)#: Specify the color of the inlet boundary markers.

marker_fraction(*args, **kwargs)#: Specify marker density factor (0.1-1).

marker_size_limiting_scale_multiplier(*args, **kwargs)#: .

markers_limit(*args, **kwargs)#: .

outlet_color(*args, **kwargs)#: Specify the color of the outlet boundary markers.

scale_marker(*args, **kwargs)#: Specify the scale factor for the boundary markers (0.1-10), which controls the overall size of the markers.

show_inlet_markers(*args, **kwargs)#: Enable/disable the display of boundary markers for inlets.

show_outlet_markers(*args, **kwargs)#: Enable/disable the display of boundary markers for outlets.

class colormap_settings(path, service)#

Bases: TUIMenu

Enter the colormap settings menu.

Methods:

`alignment`(args, *kwargs)	Specify the default colormap location.
`aspect_ratio_when_horizontal`(args, *kwargs)	.
`aspect_ratio_when_vertical`(args, *kwargs)	Specify the length vs.
`auto_refit_on_resize`(args, *kwargs)	.
`automatic_resize`(args, *kwargs)	.
`border_style`(args, *kwargs)	Specify how/when the colormap border appears.
`colormap`(args, *kwargs)	Choose the default colormap.
`isolines_position_offset`(args, *kwargs)	.
`labels`(args, *kwargs)	Specify whether there is a label for every colormap value or if some are skipped.
`levels`(args, *kwargs)	Specify the default colormap size.
`log_scale`(args, *kwargs)	Enable/disable the use of a logarithmic scale for the colormap.
`major_length_to_screen_ratio_when_horizontal`(...)	.
`major_length_to_screen_ratio_when_vertical`(...)	Choose the length of the colormap as a fraction of graphics window height, when the colormap is vertical.
`margin_from_edge_to_screen_ratio`(args, *kwargs)	.
`max_size_scale_factor`(args, *kwargs)	.
`min_size_scale_factor`(args, *kwargs)	.
`number_format_precision`(args, *kwargs)	Specify the colormap number label precision.
`number_format_type`(args, *kwargs)	Specify how colormap numbers are displayed.
`preserve_aspect_ratio_for_hardcopy`(*args, ...)	.
`show_colormap`(args, *kwargs)	Enable/disable the display of colormaps.
`skip_value`(args, *kwargs)	Specify how many number labels are skipped in the colormap.
`text_behavior`(args, *kwargs)	Specify whether colormap label text automatically scales with the colormap size.
`text_font_automatic_horizontal_size`(*args, ...)	.
`text_font_automatic_size`(args, *kwargs)	.
`text_font_automatic_units`(args, *kwargs)	.
`text_font_automatic_vertical_size`(*args, ...)	Specify the initial font size as a ratio of the colormap overall size, for vertically aligned colormaps.
`text_font_fixed_horizontal_size`(args, *kwargs)	.
`text_font_fixed_size`(args, *kwargs)	Set the font size for colormap labels.
`text_font_fixed_units`(args, *kwargs)	.
`text_font_fixed_vertical_size`(args, *kwargs)	.
`text_font_name`(args, *kwargs)	.
`text_truncation_limit_for_horizontal_colormaps`(...)	.
`text_truncation_limit_for_vertical_colormaps`(...)	.
`type`(args, *kwargs)	Specify whether the colormap appearance is smooth or banded.
`use_no_sub_windows`(args, *kwargs)	.

alignment(*args, **kwargs)#: Specify the default colormap location.

aspect_ratio_when_horizontal(*args, **kwargs)#: .

aspect_ratio_when_vertical(*args, **kwargs)#: Specify the length vs. width ratio for a vertical colormap, which controls the thickness of the colormap; smaller values mean a thicker colormap.

auto_refit_on_resize(*args, **kwargs)#: .

automatic_resize(*args, **kwargs)#: .

border_style(*args, **kwargs)#: Specify how/when the colormap border appears.

colormap(*args, **kwargs)#: Choose the default colormap.

isolines_position_offset(*args, **kwargs)#: .

labels(*args, **kwargs)#: Specify whether there is a label for every colormap value or if some are skipped.

levels(*args, **kwargs)#: Specify the default colormap size.

log_scale(*args, **kwargs)#: Enable/disable the use of a logarithmic scale for the colormap.

major_length_to_screen_ratio_when_horizontal(*args, **kwargs)#: .

major_length_to_screen_ratio_when_vertical(*args, **kwargs)#: Choose the length of the colormap as a fraction of graphics window height, when the colormap is vertical.

margin_from_edge_to_screen_ratio(*args, **kwargs)#: .

max_size_scale_factor(*args, **kwargs)#: .

min_size_scale_factor(*args, **kwargs)#: .

number_format_precision(*args, **kwargs)#: Specify the colormap number label precision.

number_format_type(*args, **kwargs)#: Specify how colormap numbers are displayed.

preserve_aspect_ratio_for_hardcopy(*args, **kwargs)#: .

show_colormap(*args, **kwargs)#: Enable/disable the display of colormaps.

skip_value(*args, **kwargs)#: Specify how many number labels are skipped in the colormap.

text_behavior(*args, **kwargs)#: Specify whether colormap label text automatically scales with the colormap size.

text_font_automatic_horizontal_size(*args, **kwargs)#: .

text_font_automatic_size(*args, **kwargs)#: .

text_font_automatic_units(*args, **kwargs)#: .

text_font_automatic_vertical_size(*args, **kwargs)#: Specify the initial font size as a ratio of the colormap overall size, for vertically aligned colormaps.

text_font_fixed_horizontal_size(*args, **kwargs)#: .

text_font_fixed_size(*args, **kwargs)#: Set the font size for colormap labels.

text_font_fixed_units(*args, **kwargs)#: .

text_font_fixed_vertical_size(*args, **kwargs)#: .

text_font_name(*args, **kwargs)#: .

text_truncation_limit_for_horizontal_colormaps(*args, **kwargs)#: .

text_truncation_limit_for_vertical_colormaps(*args, **kwargs)#: .

type(*args, **kwargs)#: Specify whether the colormap appearance is smooth or banded.

use_no_sub_windows(*args, **kwargs)#: .

double_buffering(*args, **kwargs)#: Enable/disable double-buffering, which reduces screen flicker, but may use more memory on some machines.

class embedded_windows(path, service)#

Bases: TUIMenu

Methods:

`default_embedded_mesh_windows_view`(*args, ...)	.
`default_embedded_windows_view`(args, *kwargs)	.
`save_embedded_window_layout`(args, *kwargs)	.
`show_border_for_embedded_window`(args, *kwargs)	.

default_embedded_mesh_windows_view(*args, **kwargs)#: .

default_embedded_windows_view(*args, **kwargs)#: .

save_embedded_window_layout(*args, **kwargs)#: .

show_border_for_embedded_window(*args, **kwargs)#: .

enable_non_object_based_workflow(*args, **kwargs)#: .

event_poll_interval(*args, **kwargs)#: .

event_poll_timeout(*args, **kwargs)#: .

class export_video_settings(path, service)#

Bases: TUIMenu

Classes:

advanced_video_quality_options(path, service)

Methods:

`video_format`(args, *kwargs)	.
`video_fps`(args, *kwargs)	.
`video_quality`(args, *kwargs)	.
`video_resoution_x`(args, *kwargs)	.
`video_resoution_y`(args, *kwargs)	.
`video_scale`(args, *kwargs)	.
`video_smooth_scaling`(args, *kwargs)	.
`video_use_frame_resolution`(args, *kwargs)	.

class advanced_video_quality_options(path, service)#

Bases: TUIMenu

Methods:

`bit_rate_quality`(args, *kwargs)	.
`bitrate`(args, *kwargs)	.
`compression_method`(args, *kwargs)	.
`enable_h264`(args, *kwargs)	.

bit_rate_quality(*args, **kwargs)#: .

bitrate(*args, **kwargs)#: .

compression_method(*args, **kwargs)#: .

enable_h264(*args, **kwargs)#: .

video_format(*args, **kwargs)#: .

video_fps(*args, **kwargs)#: .

video_quality(*args, **kwargs)#: .

video_resoution_x(*args, **kwargs)#: .

video_resoution_y(*args, **kwargs)#: .

video_scale(*args, **kwargs)#: .

video_smooth_scaling(*args, **kwargs)#: .

video_use_frame_resolution(*args, **kwargs)#: .

force_key_frame_animation_markers_to_off(*args, **kwargs)#: .

class graphics_effects(path, service)#

Bases: TUIMenu

Enter the graphics effects menu.

Methods:

`ambient_occlusion_enabled`(args, *kwargs)	.
`ambient_occlusion_quality`(args, *kwargs)	.
`ambient_occlusion_strength`(args, *kwargs)	.
`anti_aliasing`(args, *kwargs)	Enable/disable the smoothing of lines and text.
`bloom_blur`(args, *kwargs)	.
`bloom_enabled`(args, *kwargs)	.
`bloom_strength`(args, *kwargs)	.
`grid_color`(args, *kwargs)	Specify the color of the grid lines when the ground plane grid is shown.
`grid_plane_count`(args, *kwargs)	.
`grid_plane_enabled`(args, *kwargs)	Enable/disable the display of the ground plane grid.
`grid_plane_offset`(args, *kwargs)	Set the grid plane offset from the model as a percentage of the model size.
`grid_plane_size_factor`(args, *kwargs)	.
`plane_direction`(args, *kwargs)	Specify the direction of the plane for the ground plane grid and reflections.
`reflections_enabled`(args, *kwargs)	Enable/disable model reflections (mirror-type reflections).
`shadow_map_enabled`(args, *kwargs)	Enable/disable dynamic shadows, which show shadows of geometric entities on other objects based on lighting and object orientation.
`show_edge_reflections`(args, *kwargs)	Enable/disable the display of model edges in reflections.
`show_marker_reflections`(args, *kwargs)	.
`simple_shadows_enabled`(args, *kwargs)	Enable/disable the display of static shadows on the ground plane.
`update_after_mouse_release`(args, *kwargs)	Enable/disable the updating of graphics effects as a model is being manipulated in the graphics window.

ambient_occlusion_enabled(*args, **kwargs)#: .

ambient_occlusion_quality(*args, **kwargs)#: .

ambient_occlusion_strength(*args, **kwargs)#: .

anti_aliasing(*args, **kwargs)#: Enable/disable the smoothing of lines and text.

bloom_blur(*args, **kwargs)#: .

bloom_enabled(*args, **kwargs)#: .

bloom_strength(*args, **kwargs)#: .

grid_color(*args, **kwargs)#: Specify the color of the grid lines when the ground plane grid is shown.

grid_plane_count(*args, **kwargs)#: .

grid_plane_enabled(*args, **kwargs)#: Enable/disable the display of the ground plane grid.

grid_plane_offset(*args, **kwargs)#: Set the grid plane offset from the model as a percentage of the model size.

grid_plane_size_factor(*args, **kwargs)#: .

plane_direction(*args, **kwargs)#: Specify the direction of the plane for the ground plane grid and reflections.

reflections_enabled(*args, **kwargs)#: Enable/disable model reflections (mirror-type reflections).

shadow_map_enabled(*args, **kwargs)#: Enable/disable dynamic shadows, which show shadows of geometric entities on other objects based on lighting and object orientation.

show_edge_reflections(*args, **kwargs)#: Enable/disable the display of model edges in reflections. Note that this can negatively affect performance.

show_marker_reflections(*args, **kwargs)#: .

simple_shadows_enabled(*args, **kwargs)#: Enable/disable the display of static shadows on the ground plane.

update_after_mouse_release(*args, **kwargs)#: Enable/disable the updating of graphics effects as a model is being manipulated in the graphics window.

graphics_window_line_width(*args, **kwargs)#: Specify the thickness of lines that appear in the graphics window.

graphics_window_point_symbol(*args, **kwargs)#: Specify the symbol used for indicating points in the graphics window (like the points in an XY plot).

class hardcopy_settings(path, service)#

Bases: TUIMenu

Enter the menu for saving picture settings.

Methods:

`export_edges_for_avz`(args, *kwargs)	.
`hardcopy_driver`(args, *kwargs)	Specify the default format for saving pictures.
`hardcopy_line_width`(args, *kwargs)	Specify the thinkness of lines for saved pictures.
`hardware_image_accel`(args, *kwargs)	.
`post_script_permission_override`(args, *kwargs)	.
`save_embedded_hardcopies_separately`(*args, ...)	.
`save_embedded_windows_in_hardcopy`(*args, ...)	.
`transparent_embedded_windows`(args, *kwargs)	.

export_edges_for_avz(*args, **kwargs)#: .

hardcopy_driver(*args, **kwargs)#: Specify the default format for saving pictures.

hardcopy_line_width(*args, **kwargs)#: Specify the thinkness of lines for saved pictures.

hardware_image_accel(*args, **kwargs)#: .

post_script_permission_override(*args, **kwargs)#: .

save_embedded_hardcopies_separately(*args, **kwargs)#: .

save_embedded_windows_in_hardcopy(*args, **kwargs)#: .

transparent_embedded_windows(*args, **kwargs)#: .

hidden_surface_removal_method(*args, **kwargs)#: Specify the method for removing hidden surfaces. These methods vary in speed and quality, depending on your machine.

higher_resolution_graphics_window_line_width(*args, **kwargs)#: .

class lighting(path, service)#

Bases: TUIMenu

Enter the lighting menu.

Methods:

`ambient_light_intensity`(args, *kwargs)	.
`headlight`(args, *kwargs)	Turn the headlight on or off or set it as automatic.
`headlight_intensity`(args, *kwargs)	Specify the intensity of the headlight.
`lighting_method`(args, *kwargs)	Specify the default lighting method.

ambient_light_intensity(*args, **kwargs)#: .

headlight(*args, **kwargs)#: Turn the headlight on or off or set it as automatic.

headlight_intensity(*args, **kwargs)#: Specify the intensity of the headlight.

lighting_method(*args, **kwargs)#: Specify the default lighting method.

lower_resolution_graphics_window_line_width(*args, **kwargs)#: .

class manage_hoops_memory(path, service)#

Bases: TUIMenu

Methods:

enabled(*args, **kwargs)

hsfimport_limit(*args, **kwargs)

enabled(*args, **kwargs)#: .

hsfimport_limit(*args, **kwargs)#: .

marker_drawing_mode(*args, **kwargs)#: .

class material_effects(path, service)#

Bases: TUIMenu

Methods:

decimation_filter(*args, **kwargs)

parameterization_source(*args, **kwargs)

tiling_style(*args, **kwargs)

decimation_filter(*args, **kwargs)#: .

parameterization_source(*args, **kwargs)#: .

tiling_style(*args, **kwargs)#: .

max_graphics_text_size(*args, **kwargs)#: .

class meshing_mode(path, service)#

Bases: TUIMenu

Enter the menu for meshing-specific graphics settings.

Methods:

`graphics_window_display_timeout`(args, *kwargs)	Enable/disable graphics window display timeout.
`graphics_window_display_timeout_value`(*args, ...)	Specify the graphics window display timeout value.

graphics_window_display_timeout(*args, **kwargs)#: Enable/disable graphics window display timeout.

graphics_window_display_timeout_value(*args, **kwargs)#: Specify the graphics window display timeout value.

min_graphics_text_size(*args, **kwargs)#: .

class performance(path, service)#

Bases: TUIMenu

Enter the menu for selecting the predefined graphics effects settings.

Classes:

fast_display_mode(path, service)

minimum_frame_rate(path, service)

Enter the menu for minimum frame-rate settings.

Methods:

optimize_for(*args, **kwargs)

Choose a preset selection for how graphics are displayed.

ratio_of_target_frame_rate_to_classify_heavy_geometry(...)

ratio_of_target_frame_rate_to_declassify_heavy_geometry(...)

class fast_display_mode(path, service)#

Bases: TUIMenu

Methods:

`culling`(args, *kwargs)	.
`faces_shown`(args, *kwargs)	.
`markers_decimation`(args, *kwargs)	.
`nodes_shown`(args, *kwargs)	.
`perimeter_edges_shown`(args, *kwargs)	.
`silhouette_shown`(args, *kwargs)	.
`status`(args, *kwargs)	.
`transparency`(args, *kwargs)	.

culling(*args, **kwargs)#: .

faces_shown(*args, **kwargs)#: .

markers_decimation(*args, **kwargs)#: .

nodes_shown(*args, **kwargs)#: .

perimeter_edges_shown(*args, **kwargs)#: .

silhouette_shown(*args, **kwargs)#: .

status(*args, **kwargs)#: .

transparency(*args, **kwargs)#: .

class minimum_frame_rate(path, service)#

Bases: TUIMenu

Enter the menu for minimum frame-rate settings.

Methods:

`dynamic_adjustment`(args, *kwargs)	Enable/disable dynamic adjustment of quality loss per frame to get to the desired frame rate.
`enabled`(args, *kwargs)	Enable/disable minimum frame rate.
`fixed_culling_value`(args, *kwargs)	.
`maximum_culling_threshold`(args, *kwargs)	With minimum frame rate enabled, Fluent will not cull beyond this number of pixels.
`minimum_culling_threshold`(args, *kwargs)	With minimum frame rate enabled, Fluent will cull at least this number of pixels.
`target_fps`(args, *kwargs)	Specify the target frames-per-second.

dynamic_adjustment(*args, **kwargs)#: Enable/disable dynamic adjustment of quality loss per frame to get to the desired frame rate.

enabled(*args, **kwargs)#: Enable/disable minimum frame rate.

fixed_culling_value(*args, **kwargs)#: .

maximum_culling_threshold(*args, **kwargs)#: With minimum frame rate enabled, Fluent will not cull beyond this number of pixels.

minimum_culling_threshold(*args, **kwargs)#: With minimum frame rate enabled, Fluent will cull at least this number of pixels.

target_fps(*args, **kwargs)#: Specify the target frames-per-second.

optimize_for(*args, **kwargs)#: Choose a preset selection for how graphics are displayed.

ratio_of_target_frame_rate_to_classify_heavy_geometry(*args, **kwargs)#: .

ratio_of_target_frame_rate_to_declassify_heavy_geometry(*args, **kwargs)#: .

plot_legend_margin(*args, **kwargs)#: .

point_tool_size(*args, **kwargs)#: Specify the size of the point tool (10-100).

remove_partition_lines(*args, **kwargs)#: .

remove_partition_lines_tolerance(*args, **kwargs)#: .

rotation_centerpoint_visible(*args, **kwargs)#: .

scroll_wheel_event_end_timer(*args, **kwargs)#: .

set_camera_normal_to_surface_increments(*args, **kwargs)#: .

show_hidden_lines(*args, **kwargs)#: .

show_hidden_surfaces(*args, **kwargs)#: Enable/disable the display of hidden surfaces.

switch_to_open_glfor_remote_visualization(*args, **kwargs)#: .

test_use_external_function(*args, **kwargs)#: .

text_window_line_width(*args, **kwargs)#: .

class transparency(path, service)#

Bases: TUIMenu

Methods:

`algorithm_for_modern_drivers`(args, *kwargs)	.
`depth_peeling_layers`(args, *kwargs)	.
`depth_peeling_preference`(args, *kwargs)	.
`quick_moves`(args, *kwargs)	.
`zsort_options`(args, *kwargs)	.

algorithm_for_modern_drivers(*args, **kwargs)#: .

depth_peeling_layers(*args, **kwargs)#: .

depth_peeling_preference(*args, **kwargs)#: .

quick_moves(*args, **kwargs)#: .

zsort_options(*args, **kwargs)#: .

class vector_settings(path, service)#

Bases: TUIMenu

Methods:

`arrow3_dradius1_factor`(args, *kwargs)	.
`arrow3_dradius2_factor`(args, *kwargs)	.
`arrowhead3_dradius1_factor`(args, *kwargs)	.
`line_arrow3_dperpendicular_radius`(*args, ...)	.

arrow3_dradius1_factor(*args, **kwargs)#: .

arrow3_dradius2_factor(*args, **kwargs)#: .

arrowhead3_dradius1_factor(*args, **kwargs)#: .

line_arrow3_dperpendicular_radius(*args, **kwargs)#: .

class mat_pro_app(path, service)#

Bases: TUIMenu

Methods:

beta_features(*args, **kwargs)

focus(*args, **kwargs)

warning(*args, **kwargs)

beta_features(*args, **kwargs)#: .

focus(*args, **kwargs)#: .

warning(*args, **kwargs)#: .

class meshing_workflow(path, service)#

Bases: TUIMenu

Enter the menu for preferences covering the Fluent Meshing workflows.

Methods:

`checkpointing_option`(args, *kwargs)	Specify how Fluent Meshing will save data when you edit a task.
`save_checkpoint_files`(args, *kwargs)	Enable/disable the saving of task editing data when writing a mesh file.
`temp_folder`(args, *kwargs)	Specify a temporary location to hold generated mesh files.
`templates_folder`(args, *kwargs)	.
`verbosity`(args, *kwargs)	Enable/disable the printing of additional information and messages in the Console.

Classes:

draw_settings(path, service)

Enter the menu for specifying drawing settings.

checkpointing_option(*args, **kwargs)#: Specify how Fluent Meshing will save data when you edit a task.

class draw_settings(path, service)#

Bases: TUIMenu

Enter the menu for specifying drawing settings.

Methods:

`auto_draw`(args, *kwargs)	Enable/disable the automatic display of changes in the graphics window based on the current task.
`face_zone_limit`(args, *kwargs)	Specify the cutoff number of face zones, beyond which, Fluent Meshing will not automatically display changes.
`facet_limit`(args, *kwargs)	Specify the cutoff number facets, beyond which, Fluent Meshing will not automatically display changes.

auto_draw(*args, **kwargs)#: Enable/disable the automatic display of changes in the graphics window based on the current task.

face_zone_limit(*args, **kwargs)#: Specify the cutoff number of face zones, beyond which, Fluent Meshing will not automatically display changes.

facet_limit(*args, **kwargs)#: Specify the cutoff number facets, beyond which, Fluent Meshing will not automatically display changes.

save_checkpoint_files(*args, **kwargs)#: Enable/disable the saving of task editing data when writing a mesh file.

temp_folder(*args, **kwargs)#: Specify a temporary location to hold generated mesh files. If nothing is specified, Fluent Meshing will write to percentageTEMPpercentage on Windows and to /tmp on Linux.

templates_folder(*args, **kwargs)#: .

verbosity(*args, **kwargs)#: Enable/disable the printing of additional information and messages in the Console.

class navigation(path, service)#

Bases: TUIMenu

Enter the menu for controlling navigation in ANSYS Fluent.

Classes:

mouse_mapping(path, service)

Enable/disable the printing of additional information and messages in the Console.

class mouse_mapping(path, service)#

Bases: TUIMenu

Enable/disable the printing of additional information and messages in the Console.

Classes:

additional(path, service)

Enter the menu for controlling mouse mappings that include a modifier button such as Ctrl and Shift.

basic(path, service)

Methods:

mousemaptheme(*args, **kwargs)

class additional(path, service)#

Bases: TUIMenu

Enter the menu for controlling mouse mappings that include a modifier button such as Ctrl and Shift.

Methods:

`ctrllmbclick`(args, *kwargs)	Specify the action/behavoir for Ctrl + left-mouse-button + click.
`ctrllmbdrag`(args, *kwargs)	Specify the action/behavior for Ctrl + left-mouse-button + drag.
`ctrlmmbclick`(args, *kwargs)	Specify the action/behavior for Ctrl + middle-mouse-button + click.
`ctrlmmbdrag`(args, *kwargs)	Specify the action/behavior for Ctrl + middle-mouse-button + drag.
`ctrlrmbclick`(args, *kwargs)	Specify the action/behavior for Ctrl + right-mouse-button + click.
`ctrlrmbdrag`(args, *kwargs)	Specify the action/behavior for Ctrl + right-mouse-button + drag.
`mouseprobe`(args, *kwargs)	Specify whether the probe action provides a long description or a short description.
`mousewheel`(args, *kwargs)	Specify the action/behavior of the mouse-wheel.
`mousewheelsensitivity`(args, *kwargs)	Specify the sensitivity of the mouse-wheel (0 is least sensitive, 1 is most sensitive).
`reversewheeldirection`(args, *kwargs)	Reverse the behavior of the mouse-wheel.
`shiftlmbclick`(args, *kwargs)	Specify the action/behavior for Shift + left-mouse-button + click.
`shiftlmbdrag`(args, *kwargs)	Specify the action/behavior for Shift + left-mouse-button + drag.
`shiftmmbclick`(args, *kwargs)	Specify the action/behavior for Shift + middle-mouse-button + click.
`shiftmmbdrag`(args, *kwargs)	Specify the action/behavior for Shift + middle-mouse-button + drag.
`shiftrmbclick`(args, *kwargs)	Specify the action/behavior for Shift + right-mouse-button + click.
`shiftrmbdrag`(args, *kwargs)	Specify the action/behavior for Shift + right-mouse-button + drag.

ctrllmbclick(*args, **kwargs)#: Specify the action/behavoir for Ctrl + left-mouse-button + click.

ctrllmbdrag(*args, **kwargs)#: Specify the action/behavior for Ctrl + left-mouse-button + drag.

ctrlmmbclick(*args, **kwargs)#: Specify the action/behavior for Ctrl + middle-mouse-button + click.

ctrlmmbdrag(*args, **kwargs)#: Specify the action/behavior for Ctrl + middle-mouse-button + drag.

ctrlrmbclick(*args, **kwargs)#: Specify the action/behavior for Ctrl + right-mouse-button + click.

ctrlrmbdrag(*args, **kwargs)#: Specify the action/behavior for Ctrl + right-mouse-button + drag.

mouseprobe(*args, **kwargs)#: Specify whether the probe action provides a long description or a short description.

mousewheel(*args, **kwargs)#: Specify the action/behavior of the mouse-wheel.

mousewheelsensitivity(*args, **kwargs)#: Specify the sensitivity of the mouse-wheel (0 is least sensitive, 1 is most sensitive).

reversewheeldirection(*args, **kwargs)#: Reverse the behavior of the mouse-wheel.

shiftlmbclick(*args, **kwargs)#: Specify the action/behavior for Shift + left-mouse-button + click.

shiftlmbdrag(*args, **kwargs)#: Specify the action/behavior for Shift + left-mouse-button + drag.

shiftmmbclick(*args, **kwargs)#: Specify the action/behavior for Shift + middle-mouse-button + click.

shiftmmbdrag(*args, **kwargs)#: Specify the action/behavior for Shift + middle-mouse-button + drag.

shiftrmbclick(*args, **kwargs)#: Specify the action/behavior for Shift + right-mouse-button + click.

shiftrmbdrag(*args, **kwargs)#: Specify the action/behavior for Shift + right-mouse-button + drag.

class basic(path, service)#

Bases: TUIMenu

Methods:

`lmb`(args, *kwargs)	.
`lmbclick`(args, *kwargs)	.
`mmb`(args, *kwargs)	.
`mmbclick`(args, *kwargs)	.
`rmb`(args, *kwargs)	.
`rmbclick`(args, *kwargs)	.

lmb(*args, **kwargs)#: .

lmbclick(*args, **kwargs)#: .

mmb(*args, **kwargs)#: .

mmbclick(*args, **kwargs)#: .

rmb(*args, **kwargs)#: .

rmbclick(*args, **kwargs)#: .

mousemaptheme(*args, **kwargs)#: .

class parametric_study(path, service)#

Bases: TUIMenu

Classes:

layout_options(path, service)

update_options(path, service)

class layout_options(path, service)#

Bases: TUIMenu

Methods:

current_case_parameters(*args, **kwargs)

parametric_study_tree(*args, **kwargs)

current_case_parameters(*args, **kwargs)#: .

parametric_study_tree(*args, **kwargs)#: .

class update_options(path, service)#

Bases: TUIMenu

Methods:

`auto_refresh_time`(args, *kwargs)	.
`capture_sim_report_data`(args, *kwargs)	.
`enable_auto_refresh`(args, *kwargs)	.
`save_project_after_dpupdate`(args, *kwargs)	.
`write_data`(args, *kwargs)	.

auto_refresh_time(*args, **kwargs)#: .

capture_sim_report_data(*args, **kwargs)#: .

enable_auto_refresh(*args, **kwargs)#: .

save_project_after_dpupdate(*args, **kwargs)#: .

write_data(*args, **kwargs)#: .

class simulation(path, service)#

Bases: TUIMenu

Methods:

flow_model(*args, **kwargs)

local_residual_scaling(*args, **kwargs)

Classes:

report_definitions(path, service)

Enter the menu for report definition preferences.

flow_model(*args, **kwargs)#: .

local_residual_scaling(*args, **kwargs)#: .

class report_definitions(path, service)#

Bases: TUIMenu

Enter the menu for report definition preferences.

Methods:

`automatic_plot_file`(args, *kwargs)	New report definitions will automatically create associated report files and plots.
`report_plot_history_data_size`(args, *kwargs)	Specify how many data points are read from the associated report file and plotted in the graphics window.

automatic_plot_file(*args, **kwargs)#: New report definitions will automatically create associated report files and plots.

report_plot_history_data_size(*args, **kwargs)#: Specify how many data points are read from the associated report file and plotted in the graphics window. If the case/data files are already open, read the case and data again, after changing this setting, and re-plot to see the updated report plot.

class turbo_workflow(path, service)#

Bases: TUIMenu

Classes:

cell_zone_settings(path, service)

face_zone_settings(path, service)

graphics_settings(path, service)

Methods:

checkpointing_option(*args, **kwargs)

save_checkpoint_files(*args, **kwargs)

class cell_zone_settings(path, service)#

Bases: TUIMenu

Methods:

czsearch_order(*args, **kwargs)

rotating(*args, **kwargs)

stationary(*args, **kwargs)

czsearch_order(*args, **kwargs)#: .

rotating(*args, **kwargs)#: .

stationary(*args, **kwargs)#: .

checkpointing_option(*args, **kwargs)#: .

class face_zone_settings(path, service)#

Bases: TUIMenu

Methods:

`blade_region`(args, *kwargs)	.
`fzsearch_order`(args, *kwargs)	.
`hub_region`(args, *kwargs)	.
`inlet_region`(args, *kwargs)	.
`interior_region`(args, *kwargs)	.
`outlet_region`(args, *kwargs)	.
`periodic1_region`(args, *kwargs)	.
`periodic2_region`(args, *kwargs)	.
`shroud_region`(args, *kwargs)	.
`symmetry_region`(args, *kwargs)	.
`tip1_region`(args, *kwargs)	.
`tip2_region`(args, *kwargs)	.

blade_region(*args, **kwargs)#: .

fzsearch_order(*args, **kwargs)#: .

hub_region(*args, **kwargs)#: .

inlet_region(*args, **kwargs)#: .

interior_region(*args, **kwargs)#: .

outlet_region(*args, **kwargs)#: .

periodic1_region(*args, **kwargs)#: .

periodic2_region(*args, **kwargs)#: .

shroud_region(*args, **kwargs)#: .

symmetry_region(*args, **kwargs)#: .

tip1_region(*args, **kwargs)#: .

tip2_region(*args, **kwargs)#: .

class graphics_settings(path, service)#

Bases: TUIMenu

Methods:

auto_draw(*args, **kwargs)

auto_draw(*args, **kwargs)#: .

save_checkpoint_files(*args, **kwargs)#: .

print_license_usage(*args, **kwargs)#: Print license usage information.

class reference_frames(path, service)#

Bases: TUIMenu

Manage reference frames.

Methods:

`add`(args, *kwargs)	Add a new object.
`delete`(args, *kwargs)	Delete an object.
`display`(args, *kwargs)	Display Reference Frame.
`display_edit`(args, *kwargs)	Display and edit reference frame from graphics.
`edit`(args, *kwargs)	Edit an object.
`hide`(args, *kwargs)	Hide Reference Frame.
`list`(args, *kwargs)	List objects.
`list_properties`(args, *kwargs)	List properties of an object.

add(*args, **kwargs)#: Add a new object.

delete(*args, **kwargs)#: Delete an object.

display(*args, **kwargs)#: Display Reference Frame.

display_edit(*args, **kwargs)#: Display and edit reference frame from graphics.

edit(*args, **kwargs)#: Edit an object.

hide(*args, **kwargs)#: Hide Reference Frame.

list(*args, **kwargs)#: List objects.

list_properties(*args, **kwargs)#: List properties of an object.

class report(path, service)#

Bases: TUIMenu

Enter the report menu.

Methods:

`boundary_cell_quality`(args, *kwargs)	Reports the number and quality limits of boundary cells containing the specified number of boundary faces.
`cell_distribution`(args, *kwargs)	Reports the distribution of cell quality or size based on the bounding limits and number of partitions specified.
`cell_quality_limits`(args, *kwargs)	Reports the cell quality limits.
`cell_size_limits`(args, *kwargs)	Reports the cell size limits.
`cell_zone_at_location`(args, *kwargs)	Returns the cell zone at or closest to the specified location.
`cell_zone_volume`(args, *kwargs)	Reports the volume of the specified cell zone.
`edge_size_limits`(args, *kwargs)	Reports the edge size limits.
`enhanced_orthogonal_quality`(args, *kwargs)	Employs an enhanced definition of the orthogonal quality measure that combines a variety of quality measures, including: the orthogonality of a face relative to a vector between the face and cell centroids; a metric that detects poor cell shape at a local edge (such as twisting and/or concavity); and the variation of normals between the faces that can be constructed from the cell face.
`face_distribution`(args, *kwargs)	Reports the distribution of face quality or size based on the bounding limits and number of partitions specified.
`face_node_degree_distribution`(args, *kwargs)	Reports the distribution of boundary faces based on face node degree.
`face_quality_limits`(args, *kwargs)	Reports the face quality limits.
`face_size_limits`(args, *kwargs)	Reports the face size limits.
`face_zone_area`(args, *kwargs)	Reports the area of the specified face zone.
`face_zone_at_location`(args, *kwargs)	Reports the face zone at the given location.
`list_cell_quality`(args, *kwargs)	Reports a list of cells with the specified quality measure within a specified range.
`memory_usage`(args, *kwargs)	Reports the amount of memory used for all nodes, faces, and cells, and the total memory allocated.
`mesh_size`(args, *kwargs)	Reports the number of nodes, faces, and cells in the mesh.
`mesh_statistics`(args, *kwargs)	Writes mesh statistics (such as zone information, number of cells, faces, and nodes, range of quality and size) to an external file.
`meshing_time`(args, *kwargs)	Report meshing time.
`neighborhood_quality`(args, *kwargs)	Reports the maximum skewness, aspect ratio, or size change of all cells using a specified node.
`number_meshed`(args, *kwargs)	Reports the number of elements that have been meshed.
`print_info`(args, *kwargs)	Prints information about individual components of the mesh.
`quality_method`(args, *kwargs)	Specifies the method to be used for reporting face and cell quality.
`spy_level`(args, *kwargs)	Spy on meshing process.
`unrefined_cells`(args, *kwargs)	Reports the number of cells that have not been refined.
`update_bounding_box`(args, *kwargs)	Updates the bounding box.
`verbosity_level`(args, *kwargs)	Specifies how much information should be displayed during mesh initialization, refinement and other operations.

boundary_cell_quality(*args, **kwargs)#: Reports the number and quality limits of boundary cells containing the specified number of boundary faces. If you specify zero for number of boundary faces, you will be prompted for number of boundary nodes.

cell_distribution(*args, **kwargs)#: Reports the distribution of cell quality or size based on the bounding limits and number of partitions specified.

cell_quality_limits(*args, **kwargs)#: Reports the cell quality limits.

cell_size_limits(*args, **kwargs)#: Reports the cell size limits.

cell_zone_at_location(*args, **kwargs)#: Returns the cell zone at or closest to the specified location.

cell_zone_volume(*args, **kwargs)#: Reports the volume of the specified cell zone.

edge_size_limits(*args, **kwargs)#: Reports the edge size limits.

enhanced_orthogonal_quality(*args, **kwargs)#: Employs an enhanced definition of the orthogonal quality measure that combines a variety of quality measures, including: the orthogonality of a face relative to a vector between the face and cell centroids; a metric that detects poor cell shape at a local edge (such as twisting and/or concavity); and the variation of normals between the faces that can be constructed from the cell face. This definition is optimal for evaluating thin prism cells.

face_distribution(*args, **kwargs)#: Reports the distribution of face quality or size based on the bounding limits and number of partitions specified.

face_node_degree_distribution(*args, **kwargs)#: Reports the distribution of boundary faces based on face node degree. The node degree is the number of faces connected to the node. Specify the list of boundary face zones and the minimum and maximum face node degree to be reported. You can also consider only internal nodes, if required.

face_quality_limits(*args, **kwargs)#: Reports the face quality limits.

face_size_limits(*args, **kwargs)#: Reports the face size limits.

face_zone_area(*args, **kwargs)#: Reports the area of the specified face zone.

face_zone_at_location(*args, **kwargs)#: Reports the face zone at the given location.

list_cell_quality(*args, **kwargs)#: Reports a list of cells with the specified quality measure within a specified range. The valid prefixes are bn (boundary node), n (node), bf (boundary face), f (face), and c (cell).

memory_usage(*args, **kwargs)#: Reports the amount of memory used for all nodes, faces, and cells, and the total memory allocated.

mesh_size(*args, **kwargs)#: Reports the number of nodes, faces, and cells in the mesh.

mesh_statistics(*args, **kwargs)#: Writes mesh statistics (such as zone information, number of cells, faces, and nodes, range of quality and size) to an external file.

meshing_time(*args, **kwargs)#: Report meshing time.

neighborhood_quality(*args, **kwargs)#: Reports the maximum skewness, aspect ratio, or size change of all cells using a specified node.

number_meshed(*args, **kwargs)#: Reports the number of elements that have been meshed.

print_info(*args, **kwargs)#: Prints information about individual components of the mesh. This command also appears in the boundary menu. When you use this command, you will be prompted for an “entity” (that is, a node, face, or cell). An entity name consists of a prefix and an index. For a description of the displayed information see.

quality_method(*args, **kwargs)#: Specifies the method to be used for reporting face and cell quality.

spy_level(*args, **kwargs)#: Spy on meshing process.

unrefined_cells(*args, **kwargs)#: Reports the number of cells that have not been refined.

update_bounding_box(*args, **kwargs)#: Updates the bounding box.

verbosity_level(*args, **kwargs)#: Specifies how much information should be displayed during mesh initialization, refinement and other operations. Changing the value to 2 from the default value of 1 will produce more messages, while changing it to 0 will disable all messages.

class scoped_sizing(path, service)#

Bases: TUIMenu

Manage scoped sizing.

Methods:

`compute`(args, *kwargs)	Computes the size field based on the defined size functions and/or scoped size controls.
`create`(args, *kwargs)	Defines the scoped size based on the specified parameters.
`delete`(args, *kwargs)	Deletes the specified scoped size controls.
`delete_all`(args, *kwargs)	Deletes all the defined scoped size controls.
`delete_size_field`(args, *kwargs)	Deletes the current size field.
`list`(args, *kwargs)	Lists all the defined scoped size controls and the corresponding parameter values defined.
`list_zones_uncovered_by_controls`(args, *kwargs)	Lists the zones for which no scoped sizing controls have been defined.
`modify`(args, *kwargs)	Modifies the scoped size control definition.
`read`(args, *kwargs)	Enables you to read in a scoped sizing file (*.szcontrol).
`validate`(args, *kwargs)	Validates the scoped sizing controls defined.
`write`(args, *kwargs)	Enables you to write a scoped sizing file (*.szcontrol).

compute(*args, **kwargs)#: Computes the size field based on the defined size functions and/or scoped size controls.

create(*args, **kwargs)#: Defines the scoped size based on the specified parameters.

delete(*args, **kwargs)#: Deletes the specified scoped size controls.

delete_all(*args, **kwargs)#: Deletes all the defined scoped size controls.

delete_size_field(*args, **kwargs)#: Deletes the current size field.

list(*args, **kwargs)#: Lists all the defined scoped size controls and the corresponding parameter values defined.

list_zones_uncovered_by_controls(*args, **kwargs)#: Lists the zones for which no scoped sizing controls have been defined.

modify(*args, **kwargs)#: Modifies the scoped size control definition.

read(*args, **kwargs)#: Enables you to read in a scoped sizing file (*.szcontrol).

validate(*args, **kwargs)#: Validates the scoped sizing controls defined. An error will be reported if the scoped sizing controls do not exist or the scope for one (or more) controls is invalid.

write(*args, **kwargs)#: Enables you to write a scoped sizing file (*.szcontrol).

class size_functions(path, service)#

Bases: TUIMenu

Manage advanced size functions.

Methods:

`compute`(args, *kwargs)	Computes the size function based on the defined parameters.
`create`(args, *kwargs)	Defines the size function based on the specified parameters.
`create_defaults`(args, *kwargs)	Creates default size functions based on face and edge curvature and proximity.
`delete`(args, *kwargs)	Deletes the specified size function or the current size field.
`delete_all`(args, *kwargs)	Deletes all the defined size functions.
`disable_periodicity_filter`(args, *kwargs)	Removes periodicity from the size field.
`enable_periodicity_filter`(args, *kwargs)	Applies periodicity to the size field.
`list`(args, *kwargs)	Lists all the defined size functions and the corresponding parameter values defined.
`list_periodicity_filter`(args, *kwargs)	List periodic in size field.
`reset_global_controls`(args, *kwargs)	Resets the global controls to their default values.
`set_global_controls`(args, *kwargs)	Sets the values for the global minimum and maximum size, and the growth rate.
`set_prox_gap_tolerance`(args, *kwargs)	Sets the tolerance relative to minimum size to take gaps into account.
`set_scaling_filter`(args, *kwargs)	Allows you specify the scale factor, and minimum and maximum size values to filter the size output from the size field.
`triangulate_quad_faces`(args, *kwargs)	Identifies the zones comprising non-triangular elements and uses a triangulated copy of these zones for computing the size functions.
`use_cad_imported_curvature`(args, *kwargs)	Allows you to disable curvature data from the nodes of the CAD facets.

Classes:

`contours`(path, service)	Contains options for managing contours.
`controls`(path, service)	Menu to control different behavior of sf.

compute(*args, **kwargs)#: Computes the size function based on the defined parameters.

class contours(path, service)#

Bases: TUIMenu

Contains options for managing contours.

Methods:

draw(*args, **kwargs)

Displays contours in the graphics window.

Classes:

set(path, service)

Contains options to manage the contour size.

draw(*args, **kwargs)#: Displays contours in the graphics window. Run compute prior to contours/draw.

class set(path, service)#

Bases: TUIMenu

Contains options to manage the contour size.

Methods:

refine_facets(*args, **kwargs)

Allows you to specify smaller facets if the original are too large.

refine_facets(*args, **kwargs)#: Allows you to specify smaller facets if the original are too large. Default is no.

class controls(path, service)#

Bases: TUIMenu

Menu to control different behavior of sf.

Methods:

`curvature_method`(args, *kwargs)	Option to get facet curvature.
`meshed_sf_behavior`(args, *kwargs)	Set meshed size function processing to hard.

curvature_method(*args, **kwargs)#: Option to get facet curvature.

meshed_sf_behavior(*args, **kwargs)#: Set meshed size function processing to hard.

create(*args, **kwargs)#: Defines the size function based on the specified parameters.

create_defaults(*args, **kwargs)#: Creates default size functions based on face and edge curvature and proximity.

delete(*args, **kwargs)#: Deletes the specified size function or the current size field.

delete_all(*args, **kwargs)#: Deletes all the defined size functions.

disable_periodicity_filter(*args, **kwargs)#: Removes periodicity from the size field.

enable_periodicity_filter(*args, **kwargs)#: Applies periodicity to the size field. Specify the angle, pivot, and axis of rotation to set up periodicity. If periodicity has been previously defined, the existing settings will be applied. Only rotational periodicity is supported, translational periodicity is not supported currently.

list(*args, **kwargs)#: Lists all the defined size functions and the corresponding parameter values defined.

list_periodicity_filter(*args, **kwargs)#: List periodic in size field.

reset_global_controls(*args, **kwargs)#: Resets the global controls to their default values.

set_global_controls(*args, **kwargs)#: Sets the values for the global minimum and maximum size, and the growth rate. If you set the global minimum size to a value greater than the local minimum size defined for existing proximity, curvature, or hard size functions, a warning will appear, indicating that the global minimum size cannot be greater than the specified local minimum size.

set_prox_gap_tolerance(*args, **kwargs)#: Sets the tolerance relative to minimum size to take gaps into account. Gaps whose thickness is less than the global minimum size multiplied by this factor will not be regarded as a proximity gap.

set_scaling_filter(*args, **kwargs)#: Allows you specify the scale factor, and minimum and maximum size values to filter the size output from the size field.

triangulate_quad_faces(*args, **kwargs)#: Identifies the zones comprising non-triangular elements and uses a triangulated copy of these zones for computing the size functions.

use_cad_imported_curvature(*args, **kwargs)#: Allows you to disable curvature data from the nodes of the CAD facets.

switch_to_solution_mode(*args, **kwargs)#: Enables you to transfer the mesh data from meshing mode to solution mode in ANSYS Fluent. When you use the switch-to-solution-mode command, you will be asked to confirm that you want to switch to solution mode.

`all_grid`(args, *kwargs)	Displays the grid according to the currently set parameters.
`annotate`(args, *kwargs)	Adds annotation text to a graphics window.
`boundary_cells`(args, *kwargs)	Displays boundary cells attached to the specified face zones.
`boundary_grid`(args, *kwargs)	Displays only boundary zones according to the currently set parameters.
`center_view_on`(args, *kwargs)	Sets the camera target to be the center (centroid) of an entity.
`clear`(args, *kwargs)	Clears the active graphics window.
`clear_annotation`(args, *kwargs)	Removes all annotations and attachment lines from the active graphics window.
`draw_cells_using_faces`(args, *kwargs)	Draws cells that are neighbors for the selected faces.
`draw_cells_using_nodes`(args, *kwargs)	Draws cells that are connected to the selected nodes.
`draw_face_zones_using_entities`(args, *kwargs)	Draws cells that are connected to the selected entities.
`draw_zones`(args, *kwargs)	Draws the boundary/cell zones using the zone ID specified as input.
`redisplay`(args, *kwargs)	Redraws the grid in the graphics window.
`save_picture`(args, *kwargs)	Saves a picture file of the active graphics window.
`set_list_tree_separator`(args, *kwargs)	Sets the separator character to be used to determine the common prefix for items listed in the selection lists, when the tree view is used.
`show_hide_clipping_plane_triad`(args, *kwargs)
`update_layout`(args, *kwargs)	Update the fluent layout.
`views`(args, *kwargs)	Enters the view window options menu.