application#

class ansys.fluent.core.generated.datamodel_271.meshing_workflow.Root.application(service, rules, path)#

Bases: PyMenu

Singleton application.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

`add_2d_boundary_layers`(service, rules, command)	Adds boundary layers to a 2D mesh.
`add_boundary_layers`(service, rules, command)	Adds boundary layers to a mesh for enhanced resolution near specified surfaces.
`add_boundary_layers_for_part_replacement`(...)	Adds boundary layers to the part replacement region.
`add_boundary_type`(service, rules, command[, ...])	Defines a boundary type for meshing operations.
`add_linear_mesh_pattern`(service, rules, command)	Adds a linear mesh pattern to the model.
`add_local_sizing_wtm`(service, rules, command)	Adds local sizing controls to define mesh element sizes in specific regions.
`add_multizone_controls`(service, rules, command)	Adds MultiZone controls to the meshing setup.
`add_shell_boundary_layers`(service, rules, ...)	Adds controls for creating layered shell meshes.
`add_thin_volume_meshing_controls`(service, ...)	Adds controls for meshing thin volumes.
`add_virtual_topology`(service, rules, command)	Adds a virtual topology to the mesh.
`apply_share_topology`(service, rules, command)	Applies shared topology across connected bodies or parts.
`axisymmetric_sweep`(service, rules, command)	Creates a mesh by sweeping an axisymmetric profile around an axis.
`capping`(service, rules, command[, path])	Encloses fluid regions by capping open boundaries.
`check_mesh`(service, rules, command[, path])	Validates the integrity and quality of a mesh.
`check_surface_quality`(service, rules, command)	Analyzes the quality of a surface based on geometric and mesh criteria.
`check_volume_quality`(service, rules, command)	Evaluates the quality of the volume mesh.
`choose_mesh_control_options`(service, rules, ...)	Selects options for controlling mesh generation.
`close_leakage`(service, rules, command[, path])	Seals gaps or holes in a mesh to ensure it is watertight.
`compute_regions`(service, rules, command[, path])	Computes meshing regions based on defined parameters.
`compute_size_fields`(service, rules, command)	Computes size fields for mesh generation.
`create_collar_mesh`(service, rules, command)	Generates a collar mesh around a specified region.
`create_component_mesh`(service, rules, command)	Generates a mesh for the specified component.
`create_contact_patch`(service, rules, command)	Generates a contact patch for a specified mesh.
`create_external_flow_boundaries`(service, ...)	Generates external flow boundary conditions for simulations.
`create_gap_cover`(service, rules, command[, path])	Generates a surface to bridge gaps between defined geometries.
`create_group`(service, rules, command[, path])	Creates a group within the meshing context.
`create_leak_shield`(service, rules, command)	Generates a leak shield to prevent fluid leaks in a mesh.
`create_local_refinement_regions`(service, ...)	Defines regions for localized mesh refinement.
`create_mesh_objects`(service, rules, command)	Generates mesh objects based on specified parameters.
`create_multizone_mesh`(service, rules, command)	Generates a MultiZone mesh for the defined geometry.
`create_overset_mesh`(service, rules, command)	Generates overset interfaces for overlapping mesh regions.
`create_porous_regions`(service, rules, command)	Generates porous regions within the mesh.
`create_regions`(service, rules, command[, path])	Creates regions within a meshing context.
`create_surface_mesh`(service, rules, command)	Generates a surface mesh for the given geometry.
`create_volume_mesh_ftm`(service, rules, command)	Generates the volume mesh for a given geometry.
`create_volume_mesh_wtm`(service, rules, command)	Generates the volume mesh for the defined geometry.
`create_zero_thickness_geometry`(service, ...)	Adds thickness to a mesh.
`custom_journal_task`(service, rules, command)	Executes a custom journal file for meshing operations.
`define_boundary_layer_controls`(service, ...)	Configures boundary layer settings for meshing.
`define_global_sizing`(service, rules, command)	Sets the global element sizing controls for meshing.
`define_leakage_threshold`(service, rules, command)	Sets the threshold for leakage detection during meshing.
`describe_geometry`(service, rules, command[, ...])	Defines the geometric properties and structure for mesh generation.
`describe_geometry_and_flow`(service, rules, ...)	Defines the geometry and flow properties for meshing.
`describe_overset_features`(service, rules, ...)	Provides details about the overset meshing features available.
`diagnostics`(service, rules, path)	Provides tools to analyze and report issues in the meshing process.
`extract_edge_features`(service, rules, command)	Identifies and extracts edge features from a mesh.
`extrude_volume_mesh`(service, rules, command)	Generates a 3D volume mesh by extruding an existing 2D surface mesh.
`file`(service, rules, path)	Handles input and output operations for mesh files.
`generate_initial_surface_mesh`(service, ...)	Generates the initial mesh for a surface.
`generate_map_mesh`(service, rules, command[, ...])	Generates a mesh based on a map configuration.
`generate_prism_layers`(service, rules, command)	Generates boundary layer elements in the mesh.
`generate_surface_mesh`(service, rules, command)	Generates the surface mesh for a given geometry.
`generate_volume_mesh`(service, rules, command)	Generates a volume mesh for the fluid domain.
`global_settings`(service, rules, path)	Manages global parameters and configurations for mesh generation.
`graphics`(service, rules, path)	Handles graphical representation and visualization of mesh-related data.
`identify_construction_surfaces`(service, ...)	Detects and categorizes surfaces used for constructing geometric features.
`identify_deviated_faces`(service, rules, command)	Detects faces that deviate from specified geometric or dimensional criteria.
`identify_orphans`(service, rules, command[, path])	Identifies orphaned elements or nodes in the mesh.
`identify_regions`(service, rules, command[, path])	Identifies distinct regions within a mesh based on connectivity.
`import_boi_geometry`(service, rules, command)	Imports geometry to define a body of influence for meshing.
`import_cad_and_part_management`(service, ...)	Manages CAD imports and organizes parts.
`import_geometry`(service, rules, command[, path])	Imports a geometry file for meshing tasks.
`improve_surface_mesh`(service, rules, command)	Optimizes the quality of a surface mesh.
`improve_volume_mesh`(service, rules, command)	Enhances the quality of a volume mesh.
`load_cad_geometry`(service, rules, command[, ...])	Loads CAD geometry into the meshing environment.
`manage_zones_ftm`(service, rules, command[, path])	Manages and organizes zones within the meshing process.
`mesh_controls_table`(service, rules, command)	Retrieves or modifies the table of size controls for meshing.
`modify_mesh_refinement`(service, rules, command)	Adjusts the refinement level of a mesh.
`part_replacement_options`(service, rules, command)	Defines options for replacing parts during meshing operations.
`part_replacement_settings`(service, rules, ...)	Defines settings for replacing parts in a mesh.
`prepare_for_volume_meshing`(service, rules, ...)	Generates necessary configurations and setups required for performing volume meshing.
`remesh_surface`(service, rules, command[, path])	Remeshes a surface to improve mesh quality or meet specific criteria.
`separate_contacts`(service, rules, command[, ...])	Separates contact regions into distinct surfaces.
`set_up_rotational_periodic_boundaries`(...[, ...])	Configures periodic boundary conditions for the meshing process.
`setup_size_controls`(service, rules, command)	Adds a localized sizing control to the mesh.
`switch_to_solution`(service, rules, command)	Changes the context to the solution phase in the meshing workflow.
`transform_volume_mesh`(service, rules, command)	Applies a geometric transformation to a volume mesh.
`update_boundaries`(service, rules, command[, ...])	Updates the boundary definitions of the mesh.
`update_region_settings`(service, rules, command)	Updates the settings of a specified region.
`update_regions`(service, rules, command[, path])	Updates the defined regions in the mesh.
`update_volume_mesh`(service, rules, command)	Updates the volume mesh with the latest changes.
`wrap_main`(service, rules, command[, path])	Wraps the main geometry to create a sealed surface.
`write_2d_mesh`(service, rules, command[, path])	Exports a Fluent 2D mesh file.
`write_skin`(service, rules, command[, path])	Exports a skinned surface mesh to a specified location.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class add_2d_boundary_layers(service, rules, command, path=None)#

Bases: PyCommand

Adds boundary layers to a 2D mesh.

Parameters:

add_childbool
control_namestr
offset_method_typestr
number_of_layersint
first_aspect_ratiofloat
transition_ratiofloat
last_aspect_ratiofloat
ratefloat
first_layer_heightfloat
max_layer_heightfloat
addinstr
face_label_listlist[str]
grow_onstr
edge_label_listlist[str]
edge_zone_listlist[str]
shell_bl_advanced_optionsdict[str, Any]: Manages advanced settings for shell boundary layer generation.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class add_boundary_layers(service, rules, command, path=None)#

Bases: PyCommand

Adds boundary layers to a mesh for enhanced resolution near specified surfaces.

Parameters:

add_childstr: Determine whether (yes) or not (no) you want to specify one or more boundary layers for your simulation. If none are yet defined, you can choose yes, using prism control file and read in a prism control file that holds the boundary layer definition.
read_prism_control_filestr: The .pzmcontrol file containing boundary layer specifications.
control_namestr: Specify a name for the boundary layer control or use the default value.
offset_method_typestr: Choose the type of offset to determine how the mesh cells closest to the boundary are generated. More…
number_of_layersint: Select the number of boundary layers to be generated.
first_aspect_ratiofloat: Specify the aspect ratio of the first layer of prism cells that are extruded from the base boundary zone.
transition_ratiofloat: For the smooth transition offset method, specify the rate at which adjacent elements grow. For the last-ratio offset method, specify the factor by which the thickness of each subsequent boundary layer increases or decreases compared to the previous layer.
ratefloat: Specify the rate of growth for the boundary layer.
first_heightfloat: Specify the height of the first layer of cells in the boundary layer.
max_layer_heightfloat
face_scopedict[str, Any]: Defines the scope of faces for adding boundary layers in part replacement operations.
region_scopelist[str]: Select the named region(s) from the list to which you would like to add a boundary layer. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
bl_label_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
local_prism_preferencesdict[str, Any]: Handles settings and preferences for local prism boundary layers during part replacement.
zone_listlist[str]
region_listlist[str]
invalid_addedstr
complete_region_scopelist[str]: Select the named region(s) from the list to which you would like to add a boundary layer. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_bl_label_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_bl_zone_listlist[str]
complete_bl_region_listlist[str]
complete_zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_label_selection_listlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class add_boundary_layers_for_part_replacement(service, rules, command, path=None)#

Bases: PyCommand

Adds boundary layers to the part replacement region.

Parameters:

add_childstr: Determine whether (yes) or not (no) you want to specify one or more boundary layers for your simulation. If none are yet defined, you can choose yes, using prism control file and read in a prism control file that holds the boundary layer definition.
read_prism_control_filestr: The path to a .pzmcontrol file containing boundary layer specifications.
control_namestr: Specify a name for the boundary layer control or use the default value.
offset_method_typestr: Choose the type of offset to determine how the mesh cells closest to the boundary are generated. More…
number_of_layersint: Select the number of boundary layers to be generated.
first_aspect_ratiofloat: Specify the aspect ratio of the first layer of prism cells that are extruded from the base boundary zone.
transition_ratiofloat: For the smooth transition offset method, specify the rate at which adjacent elements grow. For the last-ratio offset method, specify the factor by which the thickness of each subsequent boundary layer increases or decreases compared to the previous layer.
ratefloat: Specify the rate of growth for the boundary layer.
first_heightfloat: Specify the height of the first layer of cells in the boundary layer.
max_layer_heightfloat
face_scopedict[str, Any]: Defines the scope of faces for adding boundary layers in part replacement operations.
region_scopelist[str]: Select the named region(s) from the list to which you would like to add a boundary layer. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
label_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
local_prism_preferencesdict[str, Any]: Handles settings and preferences for local prism boundary layers during part replacement.
bl_zone_listlist[str]
bl_region_listlist[str]
complete_region_scopelist[str]: Select the named region(s) from the list to which you would like to add a boundary layer. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_bl_label_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_bl_zone_listlist[str]
complete_bl_region_listlist[str]
complete_zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_label_selection_listlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class add_boundary_type(service, rules, command, path=None)#

Bases: PyCommand

Defines a boundary type for meshing operations.

Parameters:

mesh_objectstr
new_boundary_label_namestr: Specify a name for the boundary type.
new_boundary_typestr: Choose a boundary type from the available options.
selection_typestr
boundary_face_zone_listlist[str]: Enter a text string to filter out the list of zones. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
topology_listlist[str]
mergebool: Determine whether or not to merge the selected zones (set to yes by default).
zone_locationlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class add_linear_mesh_pattern(service, rules, command, path=None)#

Bases: PyCommand

Adds a linear mesh pattern to the model.

Parameters:

child_namestr: Specify a name for the mesh pattern or use the default value.
object_listlist[str]: Select one or more parts from the list below that you want to use for creating the mesh pattern. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
auto_populate_vectorstr: Indicate whether or not you want Fluent to approximate both the axes orientation and the pitch value, or whether you want to estimate the Pitch Only (default). This estimation only takes place once, either when the object is selected, or when the option is changed.
axis_directiondict[str, Any]: Represents a vector defining the direction and magnitude of a linear mesh pattern within a meshing framework.
pitchfloat: Specify a value for the pitch, or displacement factor, or use the default value.
number_of_unitsint: Indicate the overall number of instances that the pattern will use.
check_overlapping_facesbool: Graphically highlights the mesh pattern units so that you can visualize them and make sure they are properly aligned. Misaligned units can cause a failure in the share topology of the battery cells.
battery_modeling_optionsdict[str, Any]: Defines options for configuring battery modeling parameters in linear mesh patterns.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class add_local_sizing_wtm(service, rules, command, path=None)#

Bases: PyCommand

Adds local sizing controls to define mesh element sizes in specific regions.

Parameters:

add_childbool: Choose whether or not you want to add local size controls in order to create the surface mesh.
boi_control_namestr: Provide a name for this specific size control.
boi_growth_ratefloat: Specify the increase in element edge length with each succeeding layer of elements.
boi_executionstr: Choose whether the size control is to be applied to a local edge size, a local face size, a local body size, a body of influence, a face of influence, curvature, or proximity.
assign_size_usingstr
boi_sizefloat: Specify a value for the desired size of the local sizing (or body/face of influence) to be applied to the indicated label(s) or zone(s).
numberof_layersint
smallest_heightfloat
growth_patternstr
growth_methodstr
bias_factorfloat
boi_min_sizefloat: Specify the minimum size of the elements for the surface mesh.
boi_max_sizefloat: Specify the maximum size of the elements for the surface mesh.
boi_curvature_normal_anglefloat: Specify the maximum allowable angle (from 0 to 180 degrees) that one element edge is allowed to span given a particular geometry curvature. You can use this field to limit the number of elements that are generated along a curve or surface if the minimum size is too small for that particular curve.
boi_cells_per_gapfloat: Specify the minimum number of layers of elements to be generated in the gaps. The number of cells per gap can be a real value, with a minimum value of 0.01.
boi_scope_tostr: Set curvature or proximity based refinement. The edges option considers edge-to-edge proximity, while faces considers face-to-face proximity, and faces and edges considers both. The edge labels option considers edge sizing based on edge labels. Note that when you use the edges or the faces and edges options, you can only select face zones or face labels. Also, saving a size control file after using either of these two options will not be persistent.
ignore_orientationbool: Specify whether or not you need to apply additional refinement in and around thin areas (such as between plates), without over-refinement. This ignores face proximity within voids and will not allow you to refine in thin voids, but will allow refinement in gaps. This should be used in predominantly fluid regions with no thin solid regions.
ignore_proximity_across_objectsbool: Enable to prevent proximity sizing from considering gaps to other separate objects, which can reduce over-refinement between distinct parts.
boi_zoneor_labelstr: Choose how you want to select your surface (by label or by zone).
boi_face_label_listlist[str]: Choose one or more face zone labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
boi_face_zone_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
edge_label_listlist[str]
edge_zone_listlist[str]
topology_listlist[str]
reverse_edge_zone_orientationbool
reverse_edge_zone_listlist[str]
boi_patchingtogglebool: Enable this option to repair any openings that may still exist in the body of influence-based local sizing control.
draw_size_controlbool: Enable this field to display the size boxes in the graphics window.
zone_locationlist[str]
complete_face_zone_listlist[str]
complete_face_label_listlist[str]
complete_edge_label_listlist[str]
complete_topology_listlist[str]
prime_size_control_idint

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class add_multizone_controls(service, rules, command, path=None)#

Bases: PyCommand

Adds MultiZone controls to the meshing setup.

Parameters:

control_typestr: Determine if you want to define the multi-zone control by selecting regions or edges.
multi_z_namestr: Enter a name for the multi-zone mesh control, or use the default.
mesh_methodstr: Choose a multi-zone meshing technique: Standard or the Thin volume technique (for only a single layer)
fill_withstr: Choose a multi-zone meshing fill type: Hex-Pave, Hex-Map, Prism, or Mixed.
use_sweep_sizebool: Specify the minimum size for the edge-based multizone control.
max_sweep_sizefloat: Indicates the maximum value for the sweep size.
region_scopelist[str]: Select the named region(s) from the list to which you would like to create the multi-zone control. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
source_methodstr: Choose one or more face zones or labels from the list below. You can also provide the ability to select all source-target zones that are parallel to a global plane by choosing Zones parallel to XY plane, Zones parallel to XZ plane, or Zones parallel to YZ plane. For zones or labels. use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
parallel_selectionbool: When your desired zones are aligned with the global x,y, or z plane, enable this checkbox to automatically select all parallel zones in the selected region(s).
show_edge_biasingstr: If edge labels are automatically created on all edges, preserving the face/edge topology, use this field to determine if you want to save time and preview any edge biasing, since when many edges are selected, there can be many nodes and biases that can take additional time. Choices include yes, selected to only preview the selected edge, yes, all to preview all edges, and no to not preview edge biasing.
topo_source_listlist[str]
label_source_listlist[str]: Choose one or more face zone labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_source_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
assign_size_usingstr: For edge-based multizone controls, you can choose from Interval, Size, or Smallest Height. If double graded biasing is used and the Interval is set to an odd number (or the Size or Smallest Height results in an odd number Interval), the interval will automatically be increased by one.
intervalsint: Specify the number of intervals for the edge-based multizone control. If double graded biasing is used and the Interval is set to an odd number (or the Size or Smallest Height results in an odd number Interval), the interval will automatically be increased by one.
sizefloat: Specify the minimum size for the edge-based multizone control.
smallest_heightfloat: Specify a value for the smallest height for the edge-based multizone control.
bias_methodstr: Select from a choice of patterns that you want to apply to your edge-based multizone control.
growth_methodstr: For edge-based multizone controls when using variable Growth Patterns, determine how you would like to determine the growth: either as a Growth Rate or as Bias Factor.
growth_ratefloat: Specify a value for the growth rate for the multizone, or use the default value.
bias_factorfloat: Specify a value for the bias factor for the multizone, or use the default value. The Bias Factor is the ratio of the largest to the smallest segment on the edge.
edge_label_selectionlist[str]
edge_label_listlist[str]: Choose one or more edge labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
cfd_surface_mesh_controlsdict[str, Any]: Controls refinement settings for CFD surface meshing.
complete_region_scopelist[str]: Select the named region(s) from the list to which you would like to create the multi-zone control. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_edge_scopelist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class add_shell_boundary_layers(service, rules, command, path=None)#

Bases: PyCommand

Adds controls for creating layered shell meshes.

Parameters:

add_childbool
control_namestr
offset_method_typestr
number_of_layersint
first_aspect_ratiofloat
last_aspect_ratiofloat
ratefloat
first_layer_heightfloat
max_layer_heightfloat
grow_onstr
face_label_listlist[str]
face_zone_listlist[str]
edge_selection_typestr
edge_label_listlist[str]
edge_zone_listlist[str]
shell_bl_advanced_optionsdict[str, Any]: Manages advanced settings for shell boundary layer generation.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class add_thin_volume_meshing_controls(service, rules, command, path=None)#

Bases: PyCommand

Adds controls for meshing thin volumes.

Parameters:

thin_meshing_namestr: Enter a name for the thin volume mesh control, or use the default.
assign_size_usingstr: Specify the sizing of the mesh layers to be based on Intervals or based on the Size of the plates.
intervalsint: Specifies the minimum number of mesh layers to be created within the thin volume mesh.
max_number_of_intervalsint: Specifies the minimum number of mesh layers to be created within the thin volume mesh.
sizefloat: enter the Size of each thin mesh layer or use the default.
growth_ratefloat: Specify the Growth Rate which is the expansion rate of the extrusion for each thin volume mesh layer and is set to 1 by default. A growth rate of 1.2 for example will expand each layer of the extrusion by 20 percent of the previous length.
remesh_overlappingbool
double_biasingbool: Enable the Doubling biasing option to invoke double biasing on edges of the thin volume mesh layers. Enabling double biasing will automatically set the Growth Rate to 1.3. When disabled, the thin volume mesh can only be graded from the Source to the Target.
side_imprintsbool: Specifies the mesher to project the outer nodes of the thin volume mesh onto adjacent boundary face zones and is enabled by default. This ensures that geometric details of the thin volume are accurately captured at the boundary.
stacked_platesbool: For models consisting of stacked planar plates, you can enable the Stacked Plates option to select all source-target zones that are aligned with the global x-y-z plane.
auto_control_creationbool: enter the Size of each thin mesh layer or use the default.
objectslist[str]
region_scopelist[str]: Specify the Region(s) where the thin volume meshing controls will be applied.
select_source_bystr: Choose whether to select the source surfaces by label or by zone.
parallel_sourcebool: Enable this option if you have multiple source zones in parallel that you want to select for thin meshing.
label_source_listlist[str]: Select the label(s) to use as the source.
zone_source_listlist[str]: Select the zone(s) to use as the source.
topo_source_listlist[str]
select_target_bystr: Choose whether to select the source surfaces by label or by zone.
parallel_targetbool: Enable this option if you have multiple target zones in parallel that you want to select for thin meshing,
label_target_listlist[str]: Select the label(s) to use as the target.
zone_target_listlist[str]: Select the zone(s) to use as the target.
thin_vol_regslist[str]
complete_region_scopelist[str]: Specify the Region(s) where the thin volume meshing controls will be applied.
complete_label_source_listlist[str]: Select the label(s) to use as the source.
complete_zone_source_listlist[str]: Select the zone(s) to use as the source.
complete_topo_source_listlist[str]
complete_label_target_listlist[str]: Select the label(s) to use as the target.
complete_zone_target_listlist[str]: Select the zone(s) to use as the target.
thin_volume_preferencesdict[str, Any]: Defines preferences for controlling the meshing of thin volume regions.
zone_locationlist[str]
zone_location_2list[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class add_virtual_topology(service, rules, command, path=None)#

Bases: PyCommand

Adds a virtual topology to the mesh.

Parameters:

add_childbool
control_namestr
selection_typestr
face_label_listlist[str]
face_zone_listlist[str]
new_faceslist[int]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class apply_share_topology(service, rules, command, path=None)#

Bases: PyCommand

Applies shared topology across connected bodies or parts.

Parameters:

gap_distancefloat: Specify the maximum distance under which gaps will be removed. Use the Show Marked Gaps button to display such gaps.
gap_distance_connectfloat: Specify the maximum distance under which gaps will be removed (the default value of 0 is recommended). Use the Show Marked Gaps button to display such gaps.
min_sizefloat
interface_selectstr: Choose whether to have the interface labels selected manually (Manual), automatically (Automatic), or when force share connect topology is utilized in the geometry (Automatic - Using Connect Topology).
edge_labelslist[str]
share_topology_preferencesdict[str, Any]: Manages preferences for controlling the behavior of shared topology in meshing operations.
improve_surface_mesh_preferencesdict[str, Any]: Defines preferences for improving the quality of a surface mesh.
surface_mesh_preferencesdict[str, Any]: Controls preferences for generating surface meshes in a shared topology setup.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class axisymmetric_sweep(service, rules, command, path=None)#

Bases: PyCommand

Creates a mesh by sweeping an axisymmetric profile around an axis.

Parameters:

axis_sweep_control_namestr: Specify a name for this axisymmetric sweep control.
selection_typestr
sweep_boundary_zone_listlist[str]: Select one or more boundary zones from the list to which you will apply the sweep. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
topology_listlist[str]
axis_origindict[str, Any]: Defines the origin point for an axisymmetric sweep operation.
axis_directiondict[str, Any]: Defines the direction of the axis for an axisymmetric sweep operation.
revolution_angle_degfloat: Specify the revolution angle for the sweep in degrees (typically 360 for a full rotation).
number_of_layersint: Specify the number of layers (divisions) used in the swept direction.
zone_locationlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class capping(service, rules, command, path=None)#

Bases: PyCommand

Encloses fluid regions by capping open boundaries.

Parameters:

patch_namestr: Enter a name for the capping surface.
zone_typestr: Choose the type of zone to assign to the capping surface (velocity inlet, pressure outlet, etc.).
patch_typestr: Choose the type of capping surface: a regular, simple opening with one or more faces: or an annular opening where the fluid is within two concentric cylinders:
selection_typestr: Choose how you want to select your surface (by label or by zone).
label_selection_listlist[str]: Choose one or more face zone labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
topology_listlist[str]
create_patch_preferencesdict[str, Any]: Defines preferences for creating patch capping operations in meshing.
object_associationstr
new_object_namestr
patch_object_namestr
cap_labelslist[str]
zone_locationlist[str]
complete_zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_label_selection_listlist[str]: Choose one or more face zone labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_topology_listlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class check_mesh(service, rules, command, path=None)#

Bases: PyCommand

Validates the integrity and quality of a mesh.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class check_surface_quality(service, rules, command, path=None)#

Bases: PyCommand

Analyzes the quality of a surface based on geometric and mesh criteria.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class check_volume_quality(service, rules, command, path=None)#

Bases: PyCommand

Evaluates the quality of the volume mesh.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class choose_mesh_control_options(service, rules, command, path=None)#

Bases: PyCommand

Selects options for controlling mesh generation.

Parameters:

read_or_createstr: Determine whether you want to create new, or use existing mesh size controls or size fields.
size_control_file_namestr: The path and name of the size control file (.szcontrol) defining your mesh controls.
wrap_size_control_file_namestr: The location and name of the size control file (.szcontrol) containing mesh controls.
creation_methodstr: Determine whether you want to use default size controls or not. Default will populate your size controls with default settings, based on the number of objects in your model. The Custom option can be used to populate as many size controls as you need using your own customized settings.
view_optionstr: Determine if you would like to use separate tasks or a table to view and work with your mesh controls.
global_minfloat
global_maxfloat
global_growth_ratefloat
mesh_control_optionsdict[str, Any]: Represents available mesh control settings to customize meshing behavior.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class close_leakage(service, rules, command, path=None)#

Bases: PyCommand

Seals gaps or holes in a mesh to ensure it is watertight.

Parameters:

close_leakage_optionbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class compute_regions(service, rules, command, path=None)#

Bases: PyCommand

Computes meshing regions based on defined parameters.

Parameters:

complex_meshing_regions_optionbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class compute_size_fields(service, rules, command, path=None)#

Bases: PyCommand

Computes size fields for mesh generation.

Parameters:

compute_size_field_controlbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_collar_mesh(service, rules, command, path=None)#

Bases: PyCommand

Generates a collar mesh around a specified region.

Parameters:

refinement_regions_namestr: Specify a name for the collar mesh or use the default name.
creation_methodstr: Choose how you want to create the collar mesh: either by using intersecting objects, an edge-based collar, or an existing object.
boi_max_sizefloat: Specify the maximum size of the elements for the collar mesh.
boi_size_namestr
selection_typestr: Choose how you want to make your selection (by object, label, or zone name).
zone_selection_listlist[str]: Choose one or more zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
label_selection_listlist[str]: Select one or more labels that will make up the collar mesh. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
object_selection_listlist[str]: Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_singlelist[str]: Choose a single zone from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
object_selection_singlelist[str]: Choose a single object from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
topology_listlist[str]
bounding_box_objectdict[str, Any]: Defines a bounding box for creating a background mesh in the meshing process.
offset_objectdict[str, Any]: Generates an offset version of a given object to define boundaries for background meshing.
cylinder_methodstr
cylinder_objectdict[str, Any]: Defines a cylindrical mesh region for background meshing.
axisdict[str, Any]: Defines the axis parameters for creating a background mesh in meshing operations.
volume_fillstr: Specify the type of mesh cell to use to fill the collar mesh. Available options are tetrahedral, hexcore, poly, or poly-hexcore. .
cylinder_lengthfloat
geometry_tools_propertiesdict[str, Any]: Configures properties for geometry tools used in background mesh creation.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_component_mesh(service, rules, command, path=None)#

Bases: PyCommand

Generates a mesh for the specified component.

Parameters:

refinement_regions_namestr: Specify a name for the component mesh or use the default value.
creation_methodstr: Choose how you want to create the component mesh: either by using an offset surface, creating a bounding box, using an existing portion of the geometry, or by growing a boundary layer.
boi_max_sizefloat: Specify the maximum size of the elements for the component mesh.
boi_size_namestr
selection_typestr: Choose how you want to make your selection (by object, label, or zone name).
zone_selection_listlist[str]: Choose one or more zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
label_selection_listlist[str]: Select one or more labels that will make up the component mesh. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
object_selection_listlist[str]: Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_singlelist[str]: Choose a single zone from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
object_selection_singlelist[str]: Choose a single object from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
topology_listlist[str]
bounding_box_objectdict[str, Any]: Defines a bounding box for creating a background mesh in the meshing process.
offset_objectdict[str, Any]: Generates an offset version of a given object to define boundaries for background meshing.
cylinder_methodstr
cylinder_objectdict[str, Any]: Defines a cylindrical mesh region for background meshing.
axisdict[str, Any]: Defines the axis parameters for creating a background mesh in meshing operations.
volume_fillstr: Specify the type of mesh cell to use to fill the component mesh. Available options are tetrahedral, hexcore, poly, or poly-hexcore. .
cylinder_lengthfloat
geometry_tools_propertiesdict[str, Any]: Configures properties for geometry tools used in background mesh creation.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_contact_patch(service, rules, command, path=None)#

Bases: PyCommand

Generates a contact patch for a specified mesh.

Parameters:

contact_patch_namestr: Specify a name for the contact patch object, or retain the default name.
selection_typestr: Choose how you want to make your selection (for instance, by object, zone, or label).
zone_selection_listlist[str]: Choose one or more face zones from the list below that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
object_selection_listlist[str]: Choose an object from the list below that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
label_selection_listlist[str]: Select one or more labels that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
ground_zone_selection_listlist[str]: Choose one or more face zones from the list below that represent the contact target (for instance, the ground face zone in an enclosing bounding box for a tire-ground contact scenario).
distancefloat: Specify the distance of the contact patch geometry from the ground zone, or the thickness of the contact patch.
contact_patch_defeaturing_sizefloat: Allows you to control the smoothness of the contact patch. With the default value of 0, no smoothing takes place. With a value greater than 0, the patch is defeatured to create a smooth patch. This will lead to better quality volume mesh at the contact, for instance, between the tire and the ground.
feature_anglefloat: Specify a value for the angle used to extract feature edges on the contact patch object.
patch_holebool: Indicate whether you want the contact patch object to be filled or not.
flip_directionbool: Use this option to switch the direction/orientation of the contact patch.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_external_flow_boundaries(service, rules, command, path=None)#

Bases: PyCommand

Generates external flow boundary conditions for simulations.

Parameters:

external_boundaries_namestr: Enter a name for the external flow boundary or use the default value.
creation_methodstr: Choose how you want to create the external flow boundary: either by creating a new boundary using a bounding box, or use an existing portion of the geometry.
extraction_methodstr: Choose whether you would like to extract the external flow region either as a surface mesh object (a direct surface remesh of the object) a wrap, or an existing mesh (for overset components). The object setting is applied later when generating the surface mesh.
selection_typestr: Choose how you want to make your selection (by object, label, or zone name).
object_selection_listlist[str]: Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_listlist[str]: Choose one or more zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
label_selection_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
object_selection_singlelist[str]: Choose a single object from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_singlelist[str]: Choose a single zone from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
label_selection_singlelist[str]: Choose a single label from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
original_object_namestr
bounding_box_objectdict[str, Any]: Defines a bounding box for creating a background mesh in the meshing process.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_gap_cover(service, rules, command, path=None)#

Bases: PyCommand

Generates a surface to bridge gaps between defined geometries.

Parameters:

gap_cover_namestr: Specify a name for the gap cover object, or retain the default name.
sizing_methodstr: Determine the method for specifying the gap cover sizing controls. The Wrapper Based on Size Field option uses the size field control settings defined in the Choose Mesh Controls task. Using the Uniform Wrapper option requires you to provide a value for the Max Gap Size. If this task is located at a point in the workflow prior to the Choose Mesh Control Options task, then only the Uniform Wrapper option is available.
gap_size_ratiofloat: Specify a value for the gap size factor that, when multiplied by the local initial size field, corresponds to the size of the gap that needs to be covered.
gap_sizefloat: A specified maximum width for the gap.
selection_typestr: Choose how you want to make your selection (for instance, by object name, zone name, or label name).
zone_selection_listlist[str]: Choose one or more face zones from the list below that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
label_selection_listlist[str]: Select one or more labels that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
object_selection_listlist[str]: Choose an object from the list below that represent the contact source. Use the Filter Text field to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
gap_cover_between_zonesbool: Determine if you only want to cover gaps between boundary zones (Yes), or if you want to cover all gaps within and between boundary zones (No)
gap_cover_refine_factorfloat: Allows you to control the resolution of the gap cover size based on a scaling of the Max Gap Size (or Max Gap Size Factor). It ranges from 0.0625 to 1 with a default value of 1.0). The higher the Resolution Factor, the more likely that some gaps may not be fully covered. Depending on the gap in question, lowering the Resolution Factor reduces the wrapper to sufficiently cover the gap in most cases.
gap_cover_refine_factor_at_gapfloat: Allows you to specify the level of refinement for the gap-cover (patch). Decreasing the value increases the refinement of the patch.
refine_wrapper_before_projectionbool
advanced_optionsbool: Display advanced options that you may want to apply to the task.
max_island_face_for_gap_coverint: Specify the maximum face count required for isolated areas (islands) to be created during surface mesh generation. Any islands that have a face count smaller than this value will be removed, and only larger islands will remain.
gap_cover_feature_imprintbool: Use this option to better define gap coverings. When this option is set to Yes, the gap covers are more accurate. Once the coarse wrap closes any gaps, this option also snaps the nodes of the wrapper onto all previously defined edge features to more closely cover the gaps. Setting this option to Yes, however, can be computationally expensive when modeling large vehicles (such as in aerospace), thus, the default is No. Here, when set to No, wrapper faces at the corners are not on the geometry and are incorrectly marked as a gap. When set to Yes, only wrap faces at the gap are marked.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_group(service, rules, command, path=None)#

Bases: PyCommand

Creates a group within the meshing context.

Parameters:

new_group_namestr
selection_typestr
topology_listlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_leak_shield(service, rules, command, path=None)#

Bases: PyCommand

Generates a leak shield to prevent fluid leaks in a mesh.

Parameters:

leak_shield_namestr
use_size_fieldstr
size_field_file_namestr: The file name for the size field used in leak shielding.
min_hole_sizefloat
max_hole_sizefloat
specify_objbool
specify_livebool
specify_deadbool
object_selection_listlist[str]
live_mpt_selection_listlist[str]
dead_regions_listlist[str]
patch_at_livebool
prompt_for_cleanupbool
merge_patchesbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_local_refinement_regions(service, rules, command, path=None)#

Bases: PyCommand

Defines regions for localized mesh refinement.

Parameters:

refinement_regions_namestr: Enter a name for the body of influence.
creation_methodstr: Choose how you want to create the refinement region: by creating a bounding box, a cylindrical bounding region, or using an offset surface. You should select a closed body for the offset surface.
boi_max_sizefloat: Specify the cell size for the refinement region mesh.
boi_size_namestr
selection_typestr: Choose how you want to make your selection (by object, label, or zone name).
zone_selection_listlist[str]: Choose one or more zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
label_selection_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
object_selection_listlist[str]: Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_singlelist[str]
object_selection_singlelist[str]: Choose a single object from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
topology_listlist[str]
bounding_box_objectdict[str, Any]: Defines a bounding box for creating a background mesh in the meshing process.
offset_objectdict[str, Any]: Generates an offset version of a given object to define boundaries for background meshing.
cylinder_methodstr: Choose how the cylindrical refinement region will be defined. The Vector and Length option allows you to define the cylindrical refinement region based either on the location of selected object(s) or zone(s), or by coordinates. If you choose to select by object(s) or zone(s), the location of the cylindrical refinement region will be at the center point of the selected surface. The Two Positions option allows you to explicitly define the location and dimension of the cylindrical refinement region without having to select object(s) or zone(s).
cylinder_objectdict[str, Any]: Defines a cylindrical mesh region for background meshing.
axisdict[str, Any]: Defines the axis parameters for creating a background mesh in meshing operations.
volume_fillstr
cylinder_lengthfloat: Specify the Length of the cylinder.
geometry_tools_propertiesdict[str, Any]: Configures properties for geometry tools used in background mesh creation.
prime_size_control_idint

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_mesh_objects(service, rules, command, path=None)#

Bases: PyCommand

Generates mesh objects based on specified parameters.

Parameters:

merge_zones_based_on_labelsbool
create_a_face_zone_per_bodybool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_multizone_mesh(service, rules, command, path=None)#

Bases: PyCommand

Generates a MultiZone mesh for the defined geometry.

Parameters:

orthogonal_quality_limitfloat: This value sets the threshold for when mesh quality improvements are automatically invoked that employ the orthogonal quality limit, and is recommended to be around 0.04.
selection_typestr
region_scopelist[str]: Select the named region(s) from the list to which you would like to generate the multi-zone mesh. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
non_conformalstr: Optionally specify that multizone regions are non-conformally connected to other volumetric regions. If you want to have a conformal mesh but, because of meshing constraints, that is not possible, then you can switch to non-conformal here and avoid doing so in the CAD model.
size_function_scale_factorfloat: Enable the scaling of the multizone mesh. In some cases when the multizone region is too coarse when compared to the adjacent surface mesh, a connection is not possible. You can specify a size function scaling factor here to improve the sizing match between the multizone and the non-multizone regions and avoid any free faces. Typically, a value between 0.7 and 0.8 is recommended.
meshing_strategystr
re_merge_zonesbool
merge_body_labelsbool
cfd_surface_mesh_controlsdict[str, Any]: Controls refinement settings for CFD surface meshing.
body_label_listlist[str]
body_label_body_listlist[str]
cell_zone_listlist[str]
complete_region_scopelist[str]: Select the named region(s) from the list to which you would like to generate the multi-zone mesh. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_overset_mesh(service, rules, command, path=None)#

Bases: PyCommand

Generates overset interfaces for overlapping mesh regions.

Parameters:

overset_interfaces_namestr: Specify a name for the overset mesh interface or use the default value.
object_selection_listlist[str]: Select one or more overset mesh objects that will make up the mesh interface. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_porous_regions(service, rules, command, path=None)#

Bases: PyCommand

Generates porous regions within the mesh.

Parameters:

input_methodstr: Indicate whether you are creating the porous region using Direct coordinates, by using a Text file, or by specifying a Nonrectangular region.
porous_region_namestr: Specify a name for the porous region or use the default value.
wrapper_size_factorfloat
file_namestr: The name and path of the text file containing the porous region definition.
locationstr: Specify how you would like to determine the location of the porous region.
cell_size_p1_p2float: Specify the size of the cells that lie between P1 and P2 of the porous region. P1 is the first point designated for the porous region; P2 is the second point of the porous region - created to the left of P1 in the same plane.
cell_size_p1_p3float: Specify the size of the cells that lie between P1 and P3 of the porous region. P1 is the first point designated for the porous region; P3 is the third point of the porous region - created above P1 in the same plane.
cell_size_p1_p4float: Specify the size of the cells that lie between P1 and P4 of the porous region. P1 is the first point designated for the porous region; P4 is the fourth point of the porous region - created in relation to P1 to essentially define a thickness for the porous region.
buffer_size_ratiofloat: Specify a value for the buffer size ratio. The buffer is created as an extra layer. The thickness is equivalent to the product of the buffer size ratio and the core thickness. The core thickness is the distance between P1 and P4.
p1list[float]
p2list[float]
p3list[float]
p4list[float]
non_rectangular_parametersdict[str, Any]: Defines parameters for creating porous regions with non-rectangular shapes.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_regions(service, rules, command, path=None)#

Bases: PyCommand

Creates regions within a meshing context.

Parameters:

number_of_flow_volumesint: Confirm the number of flow volumes required for the analysis. The system will detect additional regions if they exist, however, it will detect fluid regions only where they are connected to capping surfaces.
retain_dead_region_namebool: If any dead regions are present, you can choose to determine how such regions are named. Voids or dead regions are usually named dead0, dead1, dead2, and so on, and can remain so when this prompt is set to no. When this prompt is set to yes, however, the dead region names will also be prefixed with the original dead region name (usually derived from an adjacent region), such as dead0-fluid:1, dead1-fluid:2, and so on.
mesh_objectstr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_surface_mesh(service, rules, command, path=None)#

Bases: PyCommand

Generates a surface mesh for the given geometry.

Parameters:

cfd_surface_mesh_controlsdict[str, Any]: Controls refinement settings for CFD surface meshing.
separation_requiredbool: Choose whether or not to separate face zones. By default, this is set to No. If you choose to separate zones, specify a Separation Angle. You should separate zones when using Multizone meshing. Separation is needed in case named selections for inlets, outlets, capping, local boundary layers, etc. have not been defined within the CAD model in advance. You should only select Yes if you need to separate faces for capping, boundary conditions, or inflation on specific faces.
separation_anglefloat: Specify a desired angle for determining separation. Assigning a smaller separation angle will produce more zones.
remesh_selection_typestr: Choose how you want to select your surface(s) to remesh (by label or by zone).
remesh_zone_listlist[str]
remesh_label_listlist[str]
surface_mesh_preferencesdict[str, Any]: Controls preferences for generating surface meshes in a shared topology setup.
import_typestr
append_meshbool
cad_faceting_file_namestr
directorystr
patternstr
length_unitstr
tesselation_methodstr
original_zoneslist[str]
execute_share_topologybool: For imported CAD assemblies with multiple parts, use this task to identify and close any problematic gaps and choose whether to join and/or intersect the problematic faces. More…
cad_faceting_controlsdict[str, Any]: Controls parameters for generating surface mesh faceting from CAD geometry.
cad_import_optionsdict[str, Any]: Defines options for importing CAD geometry
share_topology_preferencesdict[str, Any]: Manages preferences for controlling the behavior of shared topology in meshing operations.
preview_size_togglebool: For an imported surface mesh, use this field to visualize those boundaries that already have assigned local sizing controls (and any selected boundaries if applicable).

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_volume_mesh_ftm(service, rules, command, path=None)#

Bases: PyCommand

Generates the volume mesh for a given geometry.

Parameters:

mesh_qualityfloat
orthogonal_qualityfloat: This value sets the threshold for when mesh quality improvements are automatically invoked that employ the orthogonal quality limit, and is recommended to be around 0.04.
enable_parallelbool: Enable this option to perform parallel volume and continuous boundary layer (prism) meshing for fluid region(s). Applicable for poly, hexcore and poly-hexcore volume fill types.
save_volume_meshbool: Select this option to save the volume mesh.
edit_volume_settingsbool: Enable this option to review and/or edit the fill settings for your volume region(s).
region_name_listlist[str]
region_volume_fill_listlist[str]
region_size_listlist[str]
old_region_name_listlist[str]
old_region_volume_fill_listlist[str]
old_region_size_listlist[str]
all_region_name_listlist[str]
all_region_volume_fill_listlist[str]
all_region_size_listlist[str]
fast_robool
ro_ref_sizefloat
max_cell_levelint
max_cell_sizefloat
max_boundary_cell_levelint
max_boundary_cell_sizefloat
ro_curv_switch_angle_criterionfloat
ro_curv_min_anglefloat
ro_curv_max_anglefloat
advanced_optionsbool: Display advanced options that you may want to apply to the task.
spike_removal_anglefloat
dihedral_min_anglefloat
quality_methodstr: Choose from different types of mesh quality controls (aspect ratio, change in size, and so on). Choices include Orthogonal (the default for the workflows) and Enhanced Orthogonal. For more information, see More… .
avoid_hanging_nodesbool: Specify whether or not you want to avoid any potential 1:8 cell transition in the hexcore or polyhexcore region of the volume mesh, replacing any abrupt change in the cell size with tetrahedral or polyhedral cells.
octree_peel_layersint: Specify the number of octree layers to be removed between the boundary and the core. The resulting cavity will be filled with tet cells for hexcore meshes and with poly cells for polyhexcore meshes.
fill_with_size_fieldbool: Determine whether or not you want to use size fields when generating the volume mesh. Generating the volume mesh using size fields can require additional memory as you increase the number of processing cores. This is because the size field is replicated for each core as the size field is not properly distributed. When using size fields, you are limited by the size of the machine. When not using size fields, however, you require less memory and you can use a higher number of cores with limited RAM, leading to a faster mesh generation.
octree_boundary_face_size_ratiofloat: Specify the ratio between the octree face size and the boundary face size. The default is 2.5 such that the octree mesh near the boundary is 2.5 times larger than the boundary mesh.
global_buffer_layersint: Specify the number of buffer layers for the octree volume mesh. If size controls have not been defined previously, then the default is 2, otherwise the default is calculated based on the maximum growth size.
tet_poly_growth_ratefloat: Specify the maximum growth rate for tet and poly cells. By default, this corresponds to a growth rate of 1.2.
thin_volume_meshing_max_aspect_ratiofloat
conformal_prism_splitbool: Since neighboring zones with different numbers of layers will lead to conformal prism layers between them, use this field to determine whether you want to split the boundary layer cells conformally or not. When this option is set to Yes, the prism sides of the two zones will share nodes. This option is only available when stair-stepping is invoked. Note that adjacent regions should have an even ratio of prism layers when using this option.
tet_prism_stairstep_exposed_quadsbool: This option can be used when generating a tetrahedral mesh with prism cells and is set to No by default. Selecting Yes for this option will enable stair-stepping for exposed quadrilateral faces (exposed quads) on prism cells. Stair-stepping will prevent pyramids from being created on these exposed quads, which generally would lead to poor quality in the exposed quad location.
prism_normal_smooth_relaxation_factorfloat: Specify the smoothness factor for normal prism layers. Increasing this value will generate more prism layers especially near sharp corners. Note that this option is only available when Enable Parallel Meshing for Fluids is turned on and when Stairstep is selected for the Post Improvement Method in the Add Boundary Layers task.
show_sub_tasksbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_volume_mesh_wtm(service, rules, command, path=None)#

Bases: PyCommand

Generates the volume mesh for the defined geometry.

Parameters:

solverstr: Specify the target solver for which you want to generate the volume mesh (Fluent or CFX).
volume_fillstr: Specify the type of cell to be used in the volumetric mesh: polyhedra (default), poly-hexcore, hexcore, or tetrahedral.
mesh_fluid_regionsbool: Choose whether to mesh the fluid regions in addition to the solid regions. This is enabled by default, and can be enabled along with the Mesh Solid Regions option, however, both options cannot be turned off at the same time.
mesh_solid_regionsbool: Choose whether to mesh the solid regions in addition to the fluid regions. This is enabled by default, and can be enabled along with the Mesh Fluid Regions option, however, both options cannot be turned off at the same time.
sizing_methodstr: Choose how the cell sizing controls (such as growth rate and the maximum cell length) will be evaluated: either globally or on a region-by-region basis.
volume_fill_controlsdict[str, Any]: Configures parameters for controlling the method and quality of volume mesh generation.
region_based_preferencesbool
re_merge_zonesbool: After separating zones during surface meshing, here, choose to re-merge the zones prior to creating the volume mesh.
parallel_meshingbool: Allows you to employ parallel settings for quicker and more efficient volume meshing. Disable this option if you are interested in only generating the volume mesh in serial mode.
decoupled_parallel_meshingbool: Allows you to employ parallel settings for quicker and more efficient volume meshing. Disable this option if you are interested in only generating the volume mesh in serial mode.
prime_meshingbool
volume_mesh_preferencesdict[str, Any]: Specifies preferences for generating a volume mesh.
prism_preferencesdict[str, Any]: Configures preferences for generating prism layers in a volume mesh.
global_thin_volume_preferencesdict[str, Any]: Defines preferences for handling global thin volume meshing parameters.
invoke_prims_controlstr
offset_method_typestr: Choose the type of offset to determine how the mesh cells closest to the boundary are generated. More…
number_of_layersint: Select the number of boundary layers to be generated.
first_aspect_ratiofloat: Specify the aspect ratio of the first layer of prism cells that are extruded from the base boundary zone.
transition_ratiofloat: Specify the rate at which adjacent elements grow, for the smooth transition offset method.
ratefloat: Specify the rate of growth for the boundary layer.
first_heightfloat: Specify the height of the first layer of cells in the boundary layer.
mesh_objectstr
mesh_dead_regionsbool
body_label_listlist[str]
body_label_body_listlist[str]
prism_layersbool
quad_tet_transitionstr
merge_cell_zonesbool
face_scopedict[str, Any]: Defines the scope of faces for adding boundary layers in part replacement operations.
region_tet_name_listlist[str]
region_tet_max_cell_length_listlist[str]
region_tet_growth_rate_listlist[str]
region_hex_name_listlist[str]
region_hex_max_cell_length_listlist[str]
old_region_tet_max_cell_length_listlist[str]
old_region_tet_growth_rate_listlist[str]
old_region_hex_max_cell_length_listlist[str]
cfd_surface_mesh_controlsdict[str, Any]: Controls refinement settings for CFD surface meshing.
show_solid_fluid_meshedbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class create_zero_thickness_geometry(service, rules, command, path=None)#

Bases: PyCommand

Adds thickness to a mesh.

Parameters:

zero_thickness_namestr: Specify a name for the thickness control or use the default value.
selection_typestr: Choose how you want to make your selection (by object, label, or zone name).
zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
object_selection_listlist[str]: Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
label_selection_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
distancefloat: Specify a value that adds thickness to the selected object. Thickness is applied in the normal direction. Negative values are allowed to preview the opposite/flipped direction. The original face normal will be kept, but you can add thickness in either direction based on a positive or negative value.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class custom_journal_task(service, rules, command, path=None)#

Bases: PyCommand

Executes a custom journal file for meshing operations.

Parameters:

journal_stringstr: Enter one or more journal commands.
python_journalbool
prime_journalbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class define_boundary_layer_controls(service, rules, command, path=None)#

Bases: PyCommand

Configures boundary layer settings for meshing.

Parameters:

add_childbool: Determine whether or not you want to better capture flow in and around the boundary layer of your fluid regions.
prisms_settings_namestr: Specify a name for the boundary layer control or use the default value.
aspect_ratiofloat: Specify the ratio of the prism base length to the prism layer height.
growth_ratefloat: Specify the rate of growth of the boundary layer.
offset_method_typestr: Choose the method that will be used to create the boundary layer, or prism, controls.
last_ratio_percentagefloat: Specify the offset height of the last layer as a percentage of the local base mesh size.
first_heightfloat: Specify the height of the first layer of cells in the boundary layer.
prism_layersint: Specify the number of cell layers you require along the boundary.
region_selection_listlist[str]: Choose one or more regions from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class define_global_sizing(service, rules, command, path=None)#

Bases: PyCommand

Sets the global element sizing controls for meshing.

Parameters:

min_sizefloat
max_sizefloat
growth_ratefloat
size_functionsstr
curvature_normal_anglefloat
cells_per_gapfloat
scope_proximity_tostr
mesherstr
prime_size_control_idslist[int]
reverse_edge_zone_orientationfor_persistentlist[int]
enable_multi_threadingbool
number_of_multi_threadsint

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class define_leakage_threshold(service, rules, command, path=None)#

Bases: PyCommand

Sets the threshold for leakage detection during meshing.

Parameters:

add_childbool: Indicate whether or not you need to define a leakage threshold for one or more regions.
leakage_namestr: Specify a name for the leakage threshold or use the default value.
selection_typestr: Choose how you want to make your selection (by object or by a previously identified region).
dead_regions_listlist[str]: Choose one or more regions from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
region_selection_singlelist[str]: Choose a single region from the list of identified regions below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
dead_regions_sizefloat: The leakage threshold size is based on multiples of two. For example, if leaks are detected at 8 but not at 16 (for example, 2*8), then the threshold size is 16, and any leakage smaller than 16 will be closed.
plane_clipping_valueint: Use the slider to move the clipping plane along the axis of the selected X, Y, or Z direction.
plane_directionstr: Indicates the direction in which the clipping plane faces.
flip_directionbool: Change the orientation of the clipping plane, exposing the mesh on the opposite side.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class describe_geometry(service, rules, command, path=None)#

Bases: PyCommand

Defines the geometric properties and structure for mesh generation.

Parameters:

setup_typestr: Choose whether your geometry represents only a solid body, only a fluid body, or both a solid and fluid body.
capping_requiredbool: Choose whether or not you are going to perform any capping operations, thereby enclosing a fluid region.
wall_to_internalbool: Choose whether or not to change interior fluid-fluid boundaries from type “wall” to “internal”. Only internal boundaries bounded by two fluid regions are converted into internal zone types. If new fluid regions are assigned, this task is executed after the Update Regions task. Internal boundaries that are designated as “baffles” are retained as walls.
invoke_share_topologystr: For CAD assemblies with multiple parts, choose whether or not to identify and close any problematic gaps and whether to join and/or intersect problematic faces. This will add an Apply Share Topology task to your workflow. Note that in situations where you want to use overlapping non-conformal interfaces, you must use the non-conformal option. In all other situations, such as when you have totally disconnected bodies (that is, with no overlap), you should instead elect to choose the Share Topology option even if there is nothing to share.
non_conformalbool: Determine whether or not you want to create non-conformal meshes between the objects in your geometry. Note that in situations where you want to use overlapping non-conformal interfaces, you must use the non-conformal option. In all other situations, such as when you have totally disconnected bodies (that is, with no overlap), you should instead elect to choose the Share Topology option even if there is nothing to share.
multizonebool: Determine whether or not you want to perform multi-zone meshing on your geometry. Selecting Yes will add an Add Multizone Controls task and a Generate Multizone Mesh task to your workflow.
setup_internalslist[str]
setup_internal_typeslist[str]
old_zone_listlist[str]
old_zone_type_listlist[str]
region_listlist[str]
edge_zone_listlist[str]
edge_labelslist[str]
duplicatesbool
fluid_regionslist[str]
improve_surface_mesh_preferencesdict[str, Any]: Defines preferences for improving the quality of a surface mesh.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class describe_geometry_and_flow(service, rules, command, path=None)#

Bases: PyCommand

Defines the geometry and flow properties for meshing.

Parameters:

flow_typestr: Specify the type of flow you want to simulate: external flow, internal flow, or both. The appropriate Standard Options (for example adding an enclosure, adding caps, etc.) will be selected for you, depending on your choice.
geometry_optionsbool: Display standard geometry-based options that you may want to apply to the workflow.
add_enclosurebool: Specify whether you are going to need to add an external flow boundary around your imported geometry. If so, this will add a Create External Flow Boundaries task to the workflow.
close_capsbool: Specify whether or not you will need to cover, or cap, and large holes in order to create an internal fluid flow region. If so, this will add an Enclose Fluid Regions (Capping) task to the workflow.
local_refinement_regionsbool: Specify whether or not you will need to add local refinement in and around the imported geometry. If so, this will add a Create Local Refinement Regions task to the workflow.
describe_geometry_and_flow_optionsdict[str, Any]: Specifies options for defining geometry and flow parameters in meshing operations.
all_task_listlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class describe_overset_features(service, rules, command, path=None)#

Bases: PyCommand

Provides details about the overset meshing features available.

Parameters:

advanced_optionsbool
component_gridbool: Indicate whether you need to add an overset component mesh task to the workflow.
collar_gridbool: Indicate whether you need to add an overset collar mesh task to the workflow
background_meshbool
overset_interfacesbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class diagnostics(service, rules, path)#

Bases: PyMenu

Provides tools to analyze and report issues in the meshing process.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

`close`(service, rules, command[, path])	Closes the diagnostics session for the meshing operation.
`compute`(service, rules, command[, path])	Calculates diagnostic information for the meshing process.
`diag_options`(service, rules, command[, path])	Sets diagnostic options for meshing analysis.
`draw`(service, rules, command[, path])	Visualizes diagnostic information related to the mesh.
`first`(service, rules, command[, path])	Returns the first diagnostic from the diagnostics list.
`histogram`(service, rules, command[, path])	Generates a histogram to analyze data distribution within meshing diagnostics.
`ignore`(service, rules, command[, path])	Sets specified diagnostics to be ignored during the meshing process.
`list`(service, rules, command[, path])	Retrieves a list of diagnostic messages related to meshing.
`mark`(service, rules, command[, path])	Marks diagnostics to indicate specific issues or conditions in the meshing process.
`next`(service, rules, command[, path])	Moves to the next diagnostic issue in the sequence.
`previous`(service, rules, command[, path])	Returns the previous diagnostic entry in the sequence.
`restore`(service, rules, command[, path])	Restores all suppressed diagnostic objects to their original state.
`summary`(service, rules, command[, path])	Provides a summary of diagnostic findings for meshing results.
`update`(service, rules, command[, path])	Updates the diagnostics data for the current meshing operation.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class close(service, rules, command, path=None)#

Bases: PyCommand

Closes the diagnostics session for the meshing operation.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class compute(service, rules, command, path=None)#

Bases: PyCommand

Calculates diagnostic information for the meshing process.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class diag_options(service, rules, command, path=None)#

Bases: PyCommand

Sets diagnostic options for meshing analysis.

Parameters:

optionstr
measurestr
averagefloat
minimumfloat
maximumfloat
mark_range_typestr
mark_minfloat
mark_maxfloat
selectedstr
marked_countint
current_countint
extents_update_boundsbool
extents_x_minfloat
extents_y_minfloat
extents_z_minfloat
extents_x_maxfloat
extents_y_maxfloat
extents_z_maxfloat

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class draw(service, rules, command, path=None)#

Bases: PyCommand

Visualizes diagnostic information related to the mesh.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class first(service, rules, command, path=None)#

Bases: PyCommand

Returns the first diagnostic from the diagnostics list.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class histogram(service, rules, command, path=None)#

Bases: PyCommand

Generates a histogram to analyze data distribution within meshing diagnostics.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class ignore(service, rules, command, path=None)#

Bases: PyCommand

Sets specified diagnostics to be ignored during the meshing process.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class list(service, rules, command, path=None)#

Bases: PyCommand

Retrieves a list of diagnostic messages related to meshing.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class mark(service, rules, command, path=None)#

Bases: PyCommand

Marks diagnostics to indicate specific issues or conditions in the meshing process.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class next(service, rules, command, path=None)#

Bases: PyCommand

Moves to the next diagnostic issue in the sequence.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class previous(service, rules, command, path=None)#

Bases: PyCommand

Returns the previous diagnostic entry in the sequence.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class restore(service, rules, command, path=None)#

Bases: PyCommand

Restores all suppressed diagnostic objects to their original state.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class summary(service, rules, command, path=None)#

Bases: PyCommand

Provides a summary of diagnostic findings for meshing results.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class update(service, rules, command, path=None)#

Bases: PyCommand

Updates the diagnostics data for the current meshing operation.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class extract_edge_features(service, rules, command, path=None)#

Bases: PyCommand

Identifies and extracts edge features from a mesh.

Parameters:

extract_edges_namestr: Specify a name for the edge feature extraction or use the default value.
extract_method_typestr: Choose how the edge features are to be extracted: either by feature angle, intersection loops, or by sharp angle.
selection_typestr: Choose how you want to make your selection (by object, label, or zone name).
object_selection_listlist[str]: Select one or more geometry objects from the list below to apply the edge feature extraction to. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
geom_object_selection_listlist[str]: Select one or more geometry objects from the list below to apply the edge feature extraction to. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_listlist[str]: Select one or more zones from the list below to apply the edge feature extraction to. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
label_selection_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
feature_angle_localint: Specify the minimum angle between the feature edges that should be preserved.
individual_collectivestr: Choose face zone interactivity - individual: considers intersection of face zones within the object(s) selected; collectively: consider intersection of faces only across selected objects.
sharp_angleint: Use the slider to specify the sharp angle (in degrees) that will be used in the feature extraction.
complete_object_selection_listlist[str]: Select one or more geometry objects from the list below to apply the edge feature extraction to. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_geom_object_selection_listlist[str]: Select one or more geometry objects from the list below to apply the edge feature extraction to. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
non_extracted_objectslist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class extrude_volume_mesh(service, rules, command, path=None)#

Bases: PyCommand

Generates a 3D volume mesh by extruding an existing 2D surface mesh.

Parameters:

m_ex_control_namestr

Specify a name for the extrusion or use the default value.

methodstr

Choose whether you want the extrusion to be based on a specified Total Height value, or one based on a specified First Height value. The relationship between the two is illustrated by:

selection_typestr

extend_to_periodic_pairbool

preserve_periodic_infobool

extrude_normal_basedbool

Specify whether the volume extrusion is derived from normal-based faceting or direction-based faceting. When enabled (the default), the volume extrusion is derived on normal-based faceting, such that for each layer, the normal is calculated and smoothing occurs, and is suitable for non-planar surfaces. For planar surfaces, disable this option to use a direction-based approach where the direction is chosen based on the average normal of the entire surface, and is used to extrude all layers.

external_boundary_zone_listlist[str]

Select one or more boundaries. All selected boundaries must share the same plane. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

topology_listlist[str]

reverse_directionbool

total_heightfloat

Specify a value for the total height of the extrusion or use the default value.

first_heightfloat

Specify a value for the height of the first layer of the extrusion or use the default value.

numberof_layersint

Specify the number of extrusion layers.

growth_ratefloat

Specify how the extrusion layers will grow. For example, a value of 1.2 indicates that each successive layer will grow by 20 percent of the previous layer.: More…

volume_mesh_extrusion_preferencesdict[str, Any]

Controls preferences for extruding volume meshes.

zone_locationlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class file(service, rules, path)#

Bases: PyMenu

Handles input and output operations for mesh files.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

`read_case`(service, rules, command[, path])	Reads and processes the data from a case file.
`read_journal`(service, rules, command[, path])	Reads journal data from a specified file.
`read_mesh`(service, rules, command[, path])	Reads mesh data from a specified file.
`start_journal`(service, rules, command[, path])	Begins recording actions to a journal file for documentation or scripting purposes.
`stop_journal`(service, rules, command[, path])	Ends recording of journal actions to the file.
`write_case`(service, rules, command[, path])	Saves case data to a file.
`write_mesh`(service, rules, command[, path])	Writes mesh data to a file.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class read_case(service, rules, command, path=None)#

Bases: PyCommand

Reads and processes the data from a case file.

Parameters:

file_namestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class read_journal(service, rules, command, path=None)#

Bases: PyCommand

Reads journal data from a specified file.

Parameters:

file_namelist[str]
change_directorybool

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class read_mesh(service, rules, command, path=None)#

Bases: PyCommand

Reads mesh data from a specified file.

Parameters:

file_namestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class start_journal(service, rules, command, path=None)#

Bases: PyCommand

Begins recording actions to a journal file for documentation or scripting purposes.

Parameters:

file_namestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class stop_journal(service, rules, command, path=None)#

Bases: PyCommand

Ends recording of journal actions to the file.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class write_case(service, rules, command, path=None)#

Bases: PyCommand

Saves case data to a file.

Parameters:

file_namestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class write_mesh(service, rules, command, path=None)#

Bases: PyCommand

Writes mesh data to a file.

Parameters:

file_namestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class generate_initial_surface_mesh(service, rules, command, path=None)#

Bases: PyCommand

Generates the initial mesh for a surface.

Parameters:

generate_quadsbool
project_on_geometrybool
enable_multi_threadingbool
number_of_multi_threadsint
prism_2d_preferencesdict[str, Any]: Defines preferences for generating 2D surface mesh prisms.
surface_2d_preferencesdict[str, Any]: Manages preferences for generating 2D surface meshes.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class generate_map_mesh(service, rules, command, path=None)#

Bases: PyCommand

Generates a mesh based on a map configuration.

Parameters:

add_childstr
control_namestr
sizing_optionstr
constant_sizefloat
growth_ratefloat
short_side_divisionsint
split_quadsbool
project_on_geometrybool
selection_typestr
face_label_listlist[str]
face_zone_listlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class generate_prism_layers(service, rules, command, path=None)#

Bases: PyCommand

Generates boundary layer elements in the mesh.

Parameters:

generate_prisms_optionbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class generate_surface_mesh(service, rules, command, path=None)#

Bases: PyCommand

Generates the surface mesh for a given geometry.

Parameters:

surface_qualityfloat

This is the target maximum surface mesh quality. The recommended value is between 0.7 and 0.85.

save_surface_meshbool

Select this option to save the surface mesh. Use advanced options to determine whether to save intermediate files or not, and to choose a specific directory to save the mesh.

advanced_optionsbool

Display advanced options that you may want to apply to the task.

save_intermediate_filesbool

Determine whether or not you want to save any intermediate files that are generated during volume meshing. Disabling this option may increase speed and efficiency.

intermediate_file_namestr

By default, files are saved in a temporary folder and later deleted once the session is ended. You can also save files in a specified folder. The prefix for the name of the files are taken from the FMD or STL file name.

separate_surfacebool

Select Yes if you want to have the final surface mesh to be viewed as separated zones.

use_size_field_for_prime_wrapbool

leak_shieldbool

auto_region_between_porousbool

auto_pairingbool

Specify whether or not you want to separate contact pairs between fluids and solids.

merge_wrapper_at_solid_conactsbool

Specify whether or not you want to allow contacts between solid and fluid regions to be merged into the surface mesh wrapper. When enabled, all bounding faces of a fluid region wrap that come into contact with solid regions will be merged into a single zone (using the prefix _contact). Each respective wrapped fluid region will have one _contact zone associated with it.

parallel_serial_optionbool

Specify whether or not you want to perform solid meshing using parallel sessions. Select Yes and indicate the Maximum Number of Sessions. The number of parallel sessions that are used will depend upon the number of solid objects that need to be meshed.

number_of_sessionsint

Indicate the number of parallel sessions that are to be used, depending upon the number of solid objects that need to be meshed.

max_island_faceint

Specify the maximum face count required for isolated areas (islands) to be created during surface mesh generation. Any islands that have a face count smaller than this value will be removed, and only larger islands will remain.

spike_removal_anglefloat

Specify a value for the minimum spike angle for the specified region. A spike angle of 250 degrees is recommended or use the default value. You should not exceed 260 degrees.

dihedral_min_anglefloat

Specify a value for the minimum dihedral angle for the specified region. A dihedral angle of 30 degrees are recommended or use the default value. You should not exceed 30 degrees.

project_on_geometrybool

Determine whether, after surface meshing, Fluent will project the mesh nodes back onto to the original CAD model.

auto_assign_zone_typesbool

Choose whether or not to automatically assign boundary types to zones.

advanced_inner_wrapbool

Choose whether or not to extend or expand the surface mesh into any interior pockets or cavities.

gap_cover_zone_recoverybool

Determine whether or not to keep or remove the zones representing the cap covers. When set to Yes, the zones representing the gap covers are retained, whereas when set to No (the default), the zones for the gap covers are removed.

global_minfloat

Specify a global minimum value for the surface mesh. The default minimum value is calculated based on available target and wrap size controls and bodies of influence.: More…

show_sub_tasksbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class generate_volume_mesh(service, rules, command, path=None)#

Bases: PyCommand

Generates a volume mesh for the fluid domain.

Parameters:

mesh_fluid_domain_optionbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class global_settings(service, rules, path)#

Bases: PyMenu

Manages global parameters and configurations for mesh generation.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

`area_unit`(service, rules[, path])	Parameter area_unit of value type str.
`current_task`(service, rules[, path])	Parameter current_task of value type str.
`enable_clean_cad`(service, rules[, path])	Parameter enable_clean_cad of value type bool.
`enable_complex_meshing`(service, rules[, path])	Parameter enable_complex_meshing of value type bool.
`enable_overset_meshing`(service, rules[, path])	Parameter enable_overset_meshing of value type bool.
`enable_prime_2d_meshing`(service, rules[, path])	Parameter enable_prime_2d_meshing of value type bool.
`enable_prime_meshing`(service, rules[, path])	Parameter enable_prime_meshing of value type bool.
`ftm_region_data`(service, rules, path)	Manages settings for region-based meshing operations in the FTM framework.
`initial_version`(service, rules[, path])	Parameter initial_version of value type str.
`length_unit`(service, rules[, path])	Parameter length_unit of value type str.
`normal_mode`(service, rules[, path])	Parameter normal_mode of value type bool.
`old_size`(service, rules[, path])	Parameter old_size of value type float.
`use_allowed_values`(service, rules[, path])	Parameter use_allowed_values of value type bool.
`utl_enabled`(service, rules[, path])	Parameter utl_enabled of value type bool.
`volume_unit`(service, rules[, path])	Parameter volume_unit of value type str.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class area_unit(service, rules, path=None)#

Bases: PyTextual

Parameter area_unit of value type str.

class current_task(service, rules, path=None)#

Bases: PyTextual

Parameter current_task of value type str.

class enable_clean_cad(service, rules, path=None)#

Bases: PyParameter

Parameter enable_clean_cad of value type bool.

class enable_complex_meshing(service, rules, path=None)#

Bases: PyParameter

Parameter enable_complex_meshing of value type bool.

class enable_overset_meshing(service, rules, path=None)#

Bases: PyParameter

Parameter enable_overset_meshing of value type bool.

class enable_prime_2d_meshing(service, rules, path=None)#

Bases: PyParameter

Parameter enable_prime_2d_meshing of value type bool.

class enable_prime_meshing(service, rules, path=None)#

Bases: PyParameter

Parameter enable_prime_meshing of value type bool.

class ftm_region_data(service, rules, path)#

Bases: PyMenu

Manages settings for region-based meshing operations in the FTM framework.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

`all_overset_name_list`(service, rules[, path])	Parameter all_overset_name_list of value type list[str].
`all_overset_size_list`(service, rules[, path])	Parameter all_overset_size_list of value type list[str].
`all_overset_type_list`(service, rules[, path])	Parameter all_overset_type_list of value type list[str].
`all_overset_volume_fill_list`(service, rules)	Parameter all_overset_volume_fill_list of value type list[str].
`all_region_filter_categories`(service, rules)	Parameter all_region_filter_categories of value type list[str].
`all_region_leakage_size_list`(service, rules)	Parameter all_region_leakage_size_list of value type list[str].
`all_region_linked_construction_surface_list`(...)	Parameter all_region_linked_construction_surface_list of value type list[str].
`all_region_mesh_method_list`(service, rules)	Parameter all_region_mesh_method_list of value type list[str].
`all_region_name_list`(service, rules[, path])	Parameter all_region_name_list of value type list[str].
`all_region_overset_componen_list`(service, rules)	Parameter all_region_overset_componen_list of value type list[str].
`all_region_size_list`(service, rules[, path])	Parameter all_region_size_list of value type list[str].
`all_region_source_list`(service, rules[, path])	Parameter all_region_source_list of value type list[str].
`all_region_type_list`(service, rules[, path])	Parameter all_region_type_list of value type list[str].
`all_region_volume_fill_list`(service, rules)	Parameter all_region_volume_fill_list of value type list[str].

__init__(service, rules, path)#: __init__ method of PyMenu class.

class all_overset_name_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_overset_name_list of value type list[str].

class all_overset_size_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_overset_size_list of value type list[str].

class all_overset_type_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_overset_type_list of value type list[str].

class all_overset_volume_fill_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_overset_volume_fill_list of value type list[str].

class all_region_filter_categories(service, rules, path=None)#

Bases: PyTextual

Parameter all_region_filter_categories of value type list[str].

class all_region_leakage_size_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_region_leakage_size_list of value type list[str].

class all_region_linked_construction_surface_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_region_linked_construction_surface_list of value type list[str].

class all_region_mesh_method_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_region_mesh_method_list of value type list[str].

class all_region_name_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_region_name_list of value type list[str].

class all_region_overset_componen_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_region_overset_componen_list of value type list[str].

class all_region_size_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_region_size_list of value type list[str].

class all_region_source_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_region_source_list of value type list[str].

class all_region_type_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_region_type_list of value type list[str].

class all_region_volume_fill_list(service, rules, path=None)#

Bases: PyTextual

Parameter all_region_volume_fill_list of value type list[str].

class initial_version(service, rules, path=None)#

Bases: PyTextual

Parameter initial_version of value type str.

class length_unit(service, rules, path=None)#

Bases: PyTextual

Parameter length_unit of value type str.

class normal_mode(service, rules, path=None)#

Bases: PyParameter

Parameter normal_mode of value type bool.

class old_size(service, rules, path=None)#

Bases: PyNumerical

Parameter old_size of value type float.

class use_allowed_values(service, rules, path=None)#

Bases: PyParameter

Parameter use_allowed_values of value type bool.

class utl_enabled(service, rules, path=None)#

Bases: PyParameter

Parameter utl_enabled of value type bool.

class volume_unit(service, rules, path=None)#

Bases: PyTextual

Parameter volume_unit of value type str.

class graphics(service, rules, path)#

Bases: PyMenu

Handles graphical representation and visualization of mesh-related data.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

`bounds`(service, rules, path)	Represents the spatial boundaries of a graphical object.
`clipping_plane`(service, rules, command[, path])	Defines a clipping plane for visualizing mesh geometry by cutting through specified regions.
`draw_thin_volume_regions`(service, rules, command)	Depicts thin volume regions in the graphical display.
`get_clipping_zone_i_ds`(service, rules, command)	Retrieves the IDs of clipping zones.
`get_visible_domain_bounds`(service, rules, ...)	Retrieves the bounds of the visible domain in the graphics viewport.
`mark_gaps`(service, rules, command[, path])	Identifies and highlights gaps in the graphical representation of a mesh.
`regions`(service, rules, path)	Defines and manages graphical regions for meshing processes.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class bounds(service, rules, path)#

Bases: PyMenu

Represents the spatial boundaries of a graphical object.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

`bound_x`(service, rules[, path])	Parameter bound_x of value type bool.
`bound_y`(service, rules[, path])	Parameter bound_y of value type bool.
`bound_z`(service, rules[, path])	Parameter bound_z of value type bool.
`delta_value`(service, rules[, path])	Parameter delta_value of value type float.
`reset_bounds`(service, rules, command[, path])	Restores the bounds to their default state.
`selection`(service, rules[, path])	Parameter selection of value type str.
`set_bounds`(service, rules, command[, path])	Defines the range limits for the graphics bounds.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class bound_x(service, rules, path=None)#

Bases: PyParameter

Parameter bound_x of value type bool.

class bound_y(service, rules, path=None)#

Bases: PyParameter

Parameter bound_y of value type bool.

class bound_z(service, rules, path=None)#

Bases: PyParameter

Parameter bound_z of value type bool.

class delta_value(service, rules, path=None)#

Bases: PyNumerical

Parameter delta_value of value type float.

class reset_bounds(service, rules, command, path=None)#

Bases: PyCommand

Restores the bounds to their default state.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class selection(service, rules, path=None)#

Bases: PyTextual

Parameter selection of value type str.

class set_bounds(service, rules, command, path=None)#

Bases: PyCommand

Defines the range limits for the graphics bounds.

Parameters:

valuefloat

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class clipping_plane(service, rules, command, path=None)#

Bases: PyCommand

Defines a clipping plane for visualizing mesh geometry by cutting through specified regions.

Parameters:

insert_clipping_planebool
draw_cell_layerbool
freeze_cell_layerbool
flip_clipping_planebool
point_coordinateslist[float]
plane_normallist[float]
slider_positionint
cut_directionstr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class draw_thin_volume_regions(service, rules, command, path=None)#

Bases: PyCommand

Depicts thin volume regions in the graphical display.

Parameters:

task_instance_namestr

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class get_clipping_zone_i_ds(service, rules, command, path=None)#

Bases: PyCommand

Retrieves the IDs of clipping zones.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class get_visible_domain_bounds(service, rules, command, path=None)#

Bases: PyCommand

Retrieves the bounds of the visible domain in the graphics viewport.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class mark_gaps(service, rules, command, path=None)#

Bases: PyCommand

Identifies and highlights gaps in the graphical representation of a mesh.

Parameters:

gap_distancefloat
gap_distance_connectfloat
min_sizefloat
share_topology_preferencesdict[str, Any]: Manages preferences for controlling the behavior of shared topology in meshing operations.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class regions(service, rules, path)#

Bases: PyMenu

Defines and manages graphical regions for meshing processes.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

`draw_all`(service, rules, command[, path])	Displays all regions in the graphical view.
`draw_dead`(service, rules, command[, path])	Displays dead regions in the graphical view.
`draw_fluid`(service, rules, command[, path])	Displays fluid regions.
`draw_solid`(service, rules, command[, path])	Displays solid regions in the graphic view.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class draw_all(service, rules, command, path=None)#

Bases: PyCommand

Displays all regions in the graphical view.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class draw_dead(service, rules, command, path=None)#

Bases: PyCommand

Displays dead regions in the graphical view.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class draw_fluid(service, rules, command, path=None)#

Bases: PyCommand

Displays fluid regions.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class draw_solid(service, rules, command, path=None)#

Bases: PyCommand

Displays solid regions in the graphic view.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class identify_construction_surfaces(service, rules, command, path=None)#

Bases: PyCommand

Detects and categorizes surfaces used for constructing geometric features.

Parameters:

namestr: Specify a name for the construction surface or use the default value.
creation_methodstr: Choose whether to create the construction surface using an Existing object or zone, a bounding Box, or by using an Offset Surface.
selection_typestr: Choose how you want to make your selection (by object, label, or zone name).
object_selection_singlelist[str]: Choose a single object from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_singlelist[str]: Choose a single zone from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
label_selection_singlelist[str]: Choose a single label from the list below. Use the Filter Text field to provide text and/or regular expressions in filtering the list. The matching list item(s) are automatically displayed in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
object_selection_listlist[str]: Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
label_selection_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
defeaturing_sizefloat: Specify a value that is used to obtain a rough shape of the selected object(s). The larger the value, the more approximate the shape.
offset_heightfloat: Specify the height of the offset construction surface. This is how far from the selected object(s) the rough shape is offset.
pivotdict[str, Any]: Determines the pivot points for identifying construction surfaces in a meshing process.
axisdict[str, Any]: Defines the axis parameters for creating a background mesh in meshing operations.
rotationdict[str, Any]: Defines rotational identification parameters for construction surfaces in meshing processes.
cylinder_objectdict[str, Any]: Defines a cylindrical mesh region for background meshing.
cylinder_methodstr
bounding_box_objectdict[str, Any]: Defines a bounding box for creating a background mesh in the meshing process.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class identify_deviated_faces(service, rules, command, path=None)#

Bases: PyCommand

Detects faces that deviate from specified geometric or dimensional criteria.

Parameters:

display_grid_namestr: Enter a name for the identified deviated faces.
selection_typestr: Specify whether the identification of deviated faces is to be applied to an indicated object or zone.
object_selection_listlist[str]: Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
advanced_optionsbool: Enable this option to automatically calculate the minimum and maximum deviation for the selected object(s) or zone(s).
deviation_min_valuefloat: When Auto Compute is disabled, specify a minimum value for the deviation.
deviation_max_valuefloat: When Auto Compute is disabled, specify a maximum value for the deviation.
overlaystr: Determine how you want the deviated faces to be displayed (either with the mesh or with the geometry).
include_gap_cover_geometrybool: Determine if you want to include any gap covers in the check for deviated faces. If so, the default minimum and maximum deviation range is automatically calculated.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class identify_orphans(service, rules, command, path=None)#

Bases: PyCommand

Identifies orphaned elements or nodes in the mesh.

Parameters:

number_of_orphansstr: Specify the allowable number of orphans to accept in your mesh.
object_selection_listlist[str]: Select one or more mesh objects that you would like to identify any potential orphan faces. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
enable_grid_prioritybool: Controls the ability to prioritize your overset grids (meshes). The priorities of the overset mesh are then carried over into the solver.
donor_priority_methodstr: Determines the location of the overset mesh. Choose how the mesh donor cells are prioritized - either based on the cell size (proportional to the inverse of the cell volume) or based on the boundary distance (proportional to the inverse of the distance to the closest boundary).
overlap_boundariesbool: Determine if you need to account for any overlapping boundaries that may be present in your overset mesh (due to overlapping geometry and boundaries or those sometimes generated by collar meshes). You can improve the overset performance by setting this option to no.
check_overset_interface_intersectionbool: Enabled by default, Fluent checks for any overset interface intersections while identifying orphans. Disable this option to skip the intersection check and increase the speed of identifying orphans.
region_name_listlist[str]
region_size_listlist[str]
old_region_name_listlist[str]
old_region_size_listlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class identify_regions(service, rules, command, path=None)#

Bases: PyCommand

Identifies distinct regions within a mesh based on connectivity.

Parameters:

add_childbool: Determine whether or not you want to specify any fluid or void regions using this task.
material_points_namestr: Specify a name for the region that you want to identify or use the default value.
mpt_method_typestr: Choose how you want to identify the region: using a distinct numerical input of X, Y, and Z coordinates, using the centroid of the selected object, or by using an offset distance relative to the centroid of selected object/zone.
new_region_typestr: Specify the type of region as being fluid, solid, or a void.
link_constructionbool: Keep the default value of no for most cases involving a singular fluid region. If you mean to identify an additional fluid region, choose yes to indicate that the current fluid region is either inside or adjacent to a construction surface(s), in order to properly mesh this fluid region accordingly (that is, using a surface mesh).
selection_typestr: Choose how you want to make your selection (by object, label, or zone name).
zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
label_selection_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
object_selection_listlist[str]: Choose one or more objects (or voids) from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
graphical_selectionbool: Enable this option and select a point in the graphics window to be the center of the region.
show_coordinatesbool: Enable this option when providing numerical inputs for the region location, and you want to view the exact coordinates.
xfloat: The x-coordinate of the center of the region.
yfloat: The y-coordinate of the center of the region.
zfloat: The z-coordinate of the center of the region.
offset_xfloat: The x-coordinate of the offset distance relative to the centroid of the selected object/zone.
offset_yfloat: The y-coordinate of the offset distance relative to the centroid of the selected object/zone.
offset_zfloat: The z-coordinate of the offset distance relative to the centroid of the selected object/zone.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class import_boi_geometry(service, rules, command, path=None)#

Bases: PyCommand

Imports geometry to define a body of influence for meshing.

Parameters:

typestr: Specify whether you are importing CAD geometry file(s) or whether you are specifying surface or volume mesh file(s) to represent bodies of influence for your simulation. The units for length will be the same as those specified in the Import Geometry task.
geometry_file_namestr: The file name of the CAD data to import as a body of influence into the simulation. Supported formats include SpaceClaim (.scdoc), Workbench (.agdb), .pmdb, .CATpart, .prt, .x_t, .sat, .step, and .iges files.
mesh_file_namestr: The mesh file(s) to import into the simulation as a body of influence. Supported file types include *.msh, *.msh.gz, and *.msh.h5.
imported_objectslist[str]
length_unitstr
cad_import_optionsdict[str, Any]: Defines options for importing CAD geometry

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class import_cad_and_part_management(service, rules, command, path=None)#

Bases: PyCommand

Manages CAD imports and organizes parts.

Parameters:

file_loadedbool
fmd_file_namestr: The CAD file to import into the simulation, supporting a variety of formats such as .scdoc, .dsco, .agdb, .fmd, .fmdb, .pmdb, .tgf, and .msh. Basic wildcard patterns like * or ? can be used for
append_file_namestr: The name of the additional CAD file to append to the existing geometry.
appendbool: Enable this field and browse and select additional CAD files. Use the Append button to add the additional CAD components to the bottom of the CAD Model tree upon loading.
length_unitstr: Select a suitable unit for display in the graphics window.
create_object_perstr: Choose whether to create meshing objects by part, or by selectively customizing the portions of the imported CAD geometry to mesh. If you select by part, then meshing objects are automatically created for you once you import the geometry. Refaceting options are available as well for all meshing objects.
file_length_unitstr: Specify the units of length used by this .stl file before loading the CAD file.
file_length_unit_appendstr: Enable this field and browse and select additional CAD files. Use the Append button to add the additional CAD components to the bottom of the CAD Model tree upon loading.
routestr: Provides the recommended route in order to import and load the specified CAD file into this task. The default settings are recommended in most cases. More…
route_appendstr: Enable this field and browse and select additional CAD files. Use the Append button to add the additional CAD components to the bottom of the CAD Model tree upon loading.
jt_lodint: Specify the level of detail that you want to include for this .jt file before loading the CAD file.
jt_lod_appendint: Enable this field and browse and select additional CAD files. Use the Append button to add the additional CAD components to the bottom of the CAD Model tree upon loading.
part_per_bodybool: Enable this option to make all bodies available as individual parts in the CAD Model tree once the CAD file is loaded into the task.
prefix_parent_namebool: This applies the name of the component (or assembly) as a prefix to the individual part names when the geometry is loaded into the task.
remove_empty_partsbool: Enabled by default, this option lets you import your CAD geometry while removing any empty components.
feature_anglefloat: Specify a rotational angle (in degrees) of transformation.
one_zone_perstr: Specify whether to create your meshing zones based on an object, part, body or face. For instance, choosing the face option would create a separate zone for every topological face.
refacetingdict[str, Any]: Controls the refaceting options for CAD geometry during loading.
ignore_solid_namesbool: Enable this option to import your CAD geometry while ignoring the names assigned to solids. Note that binary STL files contain a single solid and may have an associated solid name, whereas ASCII STL files contain one or more solids and each can have a solid name. This option allows to control whether or not to use the name contained in the STL file for naming mesh objects and components.
ignore_solid_names_appendbool: Enable this field and browse and select additional CAD files. Use the Append button to add the additional CAD components to the bottom of the CAD Model tree upon loading.
optionsdict[str, Any]: Defines configuration options for managing parts in a meshing process.
edge_extractionstr: Choose how edges will be extracted from the CAD geometry. Setting this option to auto will extract edges from the CAD geometry when the number of meshing objects is less than 10,000. If this limit is exceeded, then no edges are extracted. When this option is set to yes, then edges are extracted regardless of the number of meshing objects. No edges are extracted when this option is set to no.
contextint
object_settingstr
refacet_optionsdict[str, Any]: Defines options for adjusting the parameters and settings used during the refacetting of mesh parts.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class import_geometry(service, rules, command, path=None)#

Bases: PyCommand

Imports a geometry file for meshing tasks.

Parameters:

import_methodstr
file_formatstr: Indicate whether the imported geometry is a CAD File or a Mesh (either a surface or volume mesh).
import_typestr: When the File Format is set to CAD, use the Import Type field to import a Single File (the default), or Multiple Files. When importing multiple files, the Select File dialog allows you to make multiple selections, as long as the files are in the same directory and are of the same CAD format.
length_unitstr: Select a suitable working unit for the meshing operation, with a min size of the order of 1. The model will be automatically scaled to meters when switching to the solver. It is recommended to select units so that the minimum size is between approximately 0.1 - 10. If the minimum size falls outside of this range, then you should change the units.
mesh_unitstr: Specify the units in which the surface or volume mesh was created in.
use_body_labelsbool: Specify that you want to use any composite body labels that are defined in your imported CAD geometry by choosing Yes. If the imported CAD file does not contain any body labels, then this will automatically be set to No.
import_cad_preferencesdict[str, Any]: Defines preferences and settings for importing CAD geometry.
file_namestr: Select a CAD file to import into your simulation. Supported file types are SpaceClaim (.scdoc) and Workbench (.agdb) files and also .pmdb files. Other supported formats include: *.CATpart, *.prt, *.x_t, *.sat, *.step, and *.iges files).
file_namesstr: Select multiple CAD files to import into your simulation. When importing multiple files, use the browse button (…) to open the Select File dialog that allows you to make multiple selections, as long as the files are in the same directory and are of the same CAD format. Supported file types are SpaceClaim (.scdoc) and Workbench (.agdb) files and also .pmdb files. Other supported formats include: *.CATpart, *.prt, *.x_t, *.sat, *.step, and *.iges files).
mesh_file_namestr: Select a CAD file to import into your simulation. Supported file types are SpaceClaim (.scdoc) and Workbench (.agdb) files and also .pmdb files. Other supported formats include: *.CATpart, *.prt, *.x_t, *.sat, *.step, and *.iges files).
num_partsfloat
append_meshbool
directorystr
patternstr
use_prime_geometry_kernelbool
cad_import_optionsdict[str, Any]: Defines options for importing CAD geometry
refacetingdict[str, Any]: Controls the refaceting options for CAD geometry during loading.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class improve_surface_mesh(service, rules, command, path=None)#

Bases: PyCommand

Optimizes the quality of a surface mesh.

Parameters:

mesh_objectstr
face_quality_limitfloat: Use the specified value to improve the surface mesh. Note that this control can aggressively change your surface mesh when applied.
min_sizefloat
scope_improve_tostr
improve_surface_mesh_preferencesdict[str, Any]: Defines preferences for improving the quality of a surface mesh.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class improve_volume_mesh(service, rules, command, path=None)#

Bases: PyCommand

Enhances the quality of a volume mesh.

Parameters:

quality_methodstr: Choose from several different types of mesh quality controls (skewness, aspect ratio, change in size, and so on). Choices include Orthogonal (the default for the workflows), Enhanced Orthogonal, and Skewness. For more information, see More… .
cell_quality_limitfloat: Use the specified value to improve the volume mesh. Note that this control can aggressively change your volume mesh when applied.
add_multiple_quality_methodsbool: Use this option to specify quality criteria for multiple quality methods.
quality_method_listlist[str]
quality_criteria_listlist[str]
old_quality_method_listlist[str]
old_quality_criteria_listlist[str]
improve_volume_mesh_preferencesdict[str, Any]: Defines preferences for improving volume mesh quality during mesh refinement.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class load_cad_geometry(service, rules, command, path=None)#

Bases: PyCommand

Loads CAD geometry into the meshing environment.

Parameters:

file_namestr
length_unitstr
routestr
use_prime_geometry_kernelbool
faceting_tolerancefloat
create_object_perstr
num_partsfloat
refacetingdict[str, Any]: Controls the refaceting options for CAD geometry during loading.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class manage_zones_ftm(service, rules, command, path=None)#

Bases: PyCommand

Manages and organizes zones within the meshing process.

Parameters:

typestr: Indicate whether you are going to operate on Cell Zones or Face Zones. If your imported CAD geometry contains bodies with multiple body labels, you can also choose Body Labels.
zone_filterstr: Choose the type of zone. For cell zones, choose from Fluid, Solid, or All. For face zones, choose from Internal, Fluid-Fluid, Solid-Fluid, Fluid-Solid, External-Solid, External-Fluid, or External.
size_filterstr: Indicate how you would like to filter the list of zones: All, Less than, More than, or Equal to the indicated value for the Volume (cell zone) or Area (face zone).
areafloat
volumefloat
equal_rangefloat: Specify a percentage range to maintain equivalency for the cell zone volume value or the face zone area value.
zone_or_labelstr: Choose how you want to make your selection (by label or zone name).
label_listlist[str]: Choose from the list of labels, or enter a text string to filter out the list of labels. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
topology_listlist[str]
manage_face_zone_listlist[str]: Choose from the list of face zones, or enter a text string to filter out the list of face zones. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
manage_cell_zone_listlist[str]: Choose from the list of cell zones, or enter a text string to filter out the list of cell zones. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
body_label_listlist[str]: Choose from the list of labels, or enter a text string to filter out the list of labels. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
operationstr: Indicate the operation you wish to perform on the zones. When the task is located prior volume meshing: Separate Zones, Split Cylinders, Split normal to X, Split normal to Y, Split normal to Z, or Extract Edges. When the task is located after volume meshing: Change prefix, Rename, Merge, or Separate Zones. If your imported CAD geometry contains bodies with multiple body labels, you can also choose Merge cells within each body label
operation_namestr: The text string to be applied to this zone operation.
control_namestr: Specify a name for the managed zone control or use the default value.
add_prefix_namestr: The text string to be applied to this zone operation.
face_mergebool: Indicate whether or not you want to merge faces as part of the zone operation.
anglefloat: Specify a value for the separation angle for determining separation. Assigning a smaller separation angle will produce more zones.
zone_listlist[str]
complete_zone_listlist[str]
complete_label_listlist[str]: Choose from the list of labels, or enter a text string to filter out the list of labels. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class mesh_controls_table(service, rules, command, path=None)#

Bases: PyCommand

Retrieves or modifies the table of size controls for meshing.

Parameters:

global_minfloat
global_maxfloat
target_growth_ratefloat
draw_size_controlbool: Enable this field to display the size boxes in the graphics window.
initial_size_controlbool: Enable this field to display the initial size control in the graphics window.
target_size_controlbool: Enable this field to display the target size control in the graphics window.
size_control_intervalfloat: Specify the amount of size control boxes to display.
size_control_parametersdict[str, Any]: Defines parameters for controlling mesh size and refinement within a size controls table.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class modify_mesh_refinement(service, rules, command, path=None)#

Bases: PyCommand

Adjusts the refinement level of a mesh.

Parameters:

mesh_objectstr
remesh_executionstr: Specify whether to just add the current size control to the workflow, or to add the size control and perform a remeshing operation immediately thereafter.
remesh_control_namestr: Provide a name for this specific size control.
local_sizefloat: Specify a value for the local sizing parameter to be applied to the indicated zone.
face_zone_or_labelstr: Specify whether the size control is to be applied to an indicated zone or a label.
remesh_face_zone_listlist[str]: Choose from the list of zones, or enter a text string to filter out the list of face zones. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
remesh_face_label_listlist[str]: Choose from the list of zone labels, or enter a text string to filter out the list of face zone labels. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
sizing_typestr
local_min_sizefloat
local_max_sizefloat
remesh_growth_ratefloat
remesh_curvature_normal_anglefloat
remesh_cells_per_gapfloat
cfd_surface_mesh_controlsdict[str, Any]: Controls refinement settings for CFD surface meshing.
remesh_preferencesdict[str, Any]: Controls the preferences for remeshing operations during mesh refinement.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class part_replacement_options(service, rules, command, path=None)#

Bases: PyCommand

Defines options for replacing parts during meshing operations.

Parameters:

add_part_managementbool: Determine whether or not you will be appending new CAD parts to your original geometry. Answering Yes will add an Import CAD and Part Management task.
add_part_replacementbool
add_local_sizingbool: Determine whether or not you will need to apply local sizing controls. Answering Yes will add an Add Local Sizing for Part Replacement task.
add_boundary_layerbool: Determine whether or not you will need to apply boundary layer (prism controls) to your replacement parts. Answering Yes will add an Add Boundary Layers for Part Replacement task.
add_update_the_volume_meshbool: Use this task to remove the existing volume mesh and to update the volume mesh with your new part replacement changes.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class part_replacement_settings(service, rules, command, path=None)#

Bases: PyCommand

Defines settings for replacing parts in a mesh.

Parameters:

part_replacement_namestr: Enter a name for the part replacement object, or keep the default value.
management_methodstr: Choose whether the part replacement operation will be an Addition, Replacement, or Removal of a part.
creation_methodstr: Choose the approach for handling meshing for the part replacement task: Surface Mesh Based or Volume Mesh Based. The volume mesh based approach defines a separate region for the area of interest surrounding the part replacement. Volume meshing is performed only in this region and thus is much faster than generating the volume mesh in the entire domain. The surface mesh approach requires the remeshing of all volume regions.
old_object_selection_listlist[str]: For part replacement or removal, use this list to pick the original object(s) that you wish to replace or remove. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []).
new_object_selection_listlist[str]: For part replacement or addition, use this list to pick the new object(s) that you wish to replace or add. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []).
advanced_optionsbool: Display advanced options that you may want to apply to the task.
scaling_factorfloat: Specify a factor to change the size of the bounding box surrounding the selected object(s) for part replacement.
mpt_method_typestr: Choose how you are going to determine the location of the region around the replacement part - by using numerical inputs directly, or by using the region around the selected object(s).
graphical_selectionbool: Use this option to have the numerical inputs be automatically filled out based on the centroid of the object(s) selected in the graphics window.
show_coordinatesbool: Use this option to see the exact coordinate values of the current location point.
xfloat: Indicates the x-coordinate of the current point location.
yfloat: Indicates the y-coordinate of the current point location.
zfloat: Indicates the z-coordinate of the current point location.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class prepare_for_volume_meshing(service, rules, command, path=None)#

Bases: PyCommand

Generates necessary configurations and setups required for performing volume meshing.

Parameters:

merge_zones_based_on_labelsbool
soft_target_skewnessfloat
hard_target_skewnessfloat

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class remesh_surface(service, rules, command, path=None)#

Bases: PyCommand

Remeshes a surface to improve mesh quality or meet specific criteria.

Parameters:

remesh_surface_optionbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class separate_contacts(service, rules, command, path=None)#

Bases: PyCommand

Separates contact regions into distinct surfaces.

Parameters:

separate_contacts_optionbool: Use this option to enable or disable the ability to separate any existing contacts between surfaces.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class set_up_rotational_periodic_boundaries(service, rules, command, path=None)#

Bases: PyCommand

Configures periodic boundary conditions for the meshing process.

Parameters:

mesh_objectstr
typestr: Choose the type of periodicity: rotational or translational.
methodstr: Choose the method for how you are going to define the periodic boundary. Automatic requires you to select two zones or labels. Manual requires only one zone or label.
periodicity_anglefloat: Specify the angle at which periodicity occurs.
rotation_axis_origindict[str, Any]: Defines the local coordinate system origin for periodic boundary conditions in meshing tasks.
rotation_axis_directiondict[str, Any]: Defines a vector used to represent local coordinate systems for setting up periodic boundaries in meshing operations.
trans_shiftdict[str, Any]: Defines transformation shifts for setting up periodic boundary conditions in meshing.
selection_typestr: Specify whether the periodic boundary is to be applied to an indicated zone or a label.
zone_listlist[str]: Choose from the list of zones, or enter a text string to filter out the list of face zones. Provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). More…
label_listlist[str]: Choose from the list of zone labels, or enter a text string to filter out the list of face zone labels. Provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). More…
topology_listlist[str]
remesh_boundaries_optionstr: Enable this option to remesh boundaries when there is an asymmetric mesh on the periodic faces.
zone_locationlist[str]
list_all_label_togglebool: View more labels in the table, such as those for fluid-fluid internal boundaries, in addition to external boundaries.
auto_multiple_periodicbool
multiple_optionstr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class setup_size_controls(service, rules, command, path=None)#

Bases: PyCommand

Adds a localized sizing control to the mesh.

Parameters:

local_settings_namestr: Specify a name for the size control or use the default value.
compute_for_solid_onlystr
selection_typestr: Choose how you want to make your selection (by object, label, or zone name).
object_selection_listlist[str]: Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
label_selection_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
zone_locationlist[str]
edge_selection_listlist[str]: Choose one or more edge zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
local_size_control_parametersdict[str, Any]: Defines parameters for controlling local mesh size during part replacement.
value_changedstr
complete_zone_selection_listlist[str]: Choose one or more face zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_label_selection_listlist[str]: Choose one or more labels from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_object_selection_listlist[str]: Choose one or more objects from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
complete_edge_selection_listlist[str]: Choose one or more edge zones from the list below. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class switch_to_solution(service, rules, command, path=None)#

Bases: PyCommand

Changes the context to the solution phase in the meshing workflow.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class transform_volume_mesh(service, rules, command, path=None)#

Bases: PyCommand

Applies a geometric transformation to a volume mesh.

Parameters:

control_namestr: Specify a name for the transformation or use the default value.
typestr: Indicate the type of transformation: translational or rotational
methodstr: By default, the Manual method is utilized, however, when periodics are detected, then Automatic - use existing periodics is the default.
selection_typestr: Indicate the type of transformation: translational or rotational
topo_body_listlist[str]
cell_zone_listlist[str]: Select one or more objects from the list to which you will apply the transformation. Use the Filter Text drop-down to provide text and/or regular expressions in filtering the list (for example, using *, ?, and []). Choose Use Wildcard to provide wildcard expressions in filtering the list. When you use either ? or * in your expression, the matching list item(s) are automatically selected in the list. Use ^, |, and & in your expression to indicate boolean operations for NOT, OR, and AND, respectively. More…
rotation_axis_origindict[str, Any]: Defines the local coordinate system origin for periodic boundary conditions in meshing tasks.
rotation_axis_directiondict[str, Any]: Defines a vector used to represent local coordinate systems for setting up periodic boundaries in meshing operations.
trans_shiftdict[str, Any]: Defines transformation shifts for setting up periodic boundary conditions in meshing.
anglefloat: Specify a value for the angle of rotation for this transformation.
copystr: Indicate whether or not to make a copy of the volume mesh and apply the transformation to the copy.
num_of_copiesint: Specify the number of copies that you want to make for this transformation.
mergestr: Indicate whether or not you want to merge cell and face zones prior to transforming the volume mesh, in order to avoid duplication.
renamebool: Indicate whether or not you want to rename cell and face zones prior to transforming the volume mesh.
merge_boundarieslist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class update_boundaries(service, rules, command, path=None)#

Bases: PyCommand

Updates the boundary definitions of the mesh.

Parameters:

mesh_objectstr
selection_typestr: Choose how boundaries are displayed in the table.
boundary_label_listlist[str]
boundary_label_type_listlist[str]
boundary_zone_listlist[str]
boundary_zone_type_listlist[str]
old_boundary_label_listlist[str]
old_boundary_label_type_listlist[str]
old_boundary_zone_listlist[str]
old_boundary_zone_type_listlist[str]
old_label_zone_listlist[str]
list_all_boundaries_togglebool: View more boundaries in the table, such as fluid-fluid internal boundaries, in addition to external boundaries.
zone_locationlist[str]
topology_listlist[str]
topology_type_listlist[str]
old_topology_listlist[str]
old_topology_type_listlist[str]
topology_body_listlist[str]
boundary_current_listlist[str]
boundary_current_type_listlist[str]
boundary_allowed_type_listlist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class update_region_settings(service, rules, command, path=None)#

Bases: PyCommand

Updates the settings of a specified region.

Parameters:

main_fluid_regionstr: Identify the main fluid region for your simulation.
filter_categorystr: Select how your regions will be displayed in the table. You can choose to view all regions, or specifically identified regions, or only object-based regions.
region_name_listlist[str]
region_mesh_method_listlist[str]
region_type_listlist[str]
region_volume_fill_listlist[str]
region_leakage_size_listlist[str]
region_overset_componen_listlist[str]
old_region_name_listlist[str]
old_region_mesh_method_listlist[str]
old_region_type_listlist[str]
old_region_volume_fill_listlist[str]
old_region_leakage_size_listlist[str]
old_region_overset_componen_listlist[str]
all_region_name_listlist[str]
all_region_mesh_method_listlist[str]
all_region_type_listlist[str]
all_region_volume_fill_listlist[str]
all_region_leakage_size_listlist[str]
all_region_overset_componen_listlist[str]
all_region_linked_construction_surface_listlist[str]
all_region_source_listlist[str]
all_region_filter_categorieslist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class update_regions(service, rules, command, path=None)#

Bases: PyCommand

Updates the defined regions in the mesh.

Parameters:

mesh_objectstr
region_name_listlist[str]
region_type_listlist[str]
old_region_name_listlist[str]
old_region_type_listlist[str]
region_internalslist[str]
region_internal_typeslist[str]
region_current_listlist[str]
region_current_type_listlist[str]
number_of_listed_regionsint

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()#: Create an operation instance.

class update_volume_mesh(service, rules, command, path=None)#

Bases: PyCommand

Updates the volume mesh with the latest changes.

Parameters:

enable_parallelbool: Enable this option to perform parallel volume and continuous boundary layer (prism) meshing for fluid region(s). Applicable for poly, hexcore and poly-hexcore volume fill types.

Returns: