objects

class ansys.fluent.core.meshing.tui_231.main_menu.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.