meshing.datamodel.meshing_workflow

class ansys.fluent.core.generated.datamodel_261.meshing_workflow.Root(service, rules, path)

Bases: PyMenu

Meshing workflow API.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

application(service, rules, path)	Singleton application.
general(service, rules, path)	Singleton general.
task_object(service, rules, path)	Task objects.

__init__(service, rules, path)

__init__ method of PyMenu class.

class 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)	Command add_2d_boundary_layers.
add_boundary_layers(service, rules, command)	Determine whether or not boundary layers will be added to various portions of the model. Once a boundary layer is defined, global boundary layer settings are determined in the Create Volume Mesh task. Parameters ---------- add_child : str 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_file : str Specify (or browse for) a .pzmcontrol file that contains the boundary (prism) layer specifications. control_name : str Specify a name for the boundary layer control or use the default value. offset_method_type : str Choose the type of offset to determine how the mesh cells closest to the boundary are generated. More... number_of_layers : int Select the number of boundary layers to be generated. first_aspect_ratio : float Specify the aspect ratio of the first layer of prism cells that are extruded from the base boundary zone. transition_ratio : float 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. rate : float Specify the rate of growth for the boundary layer. first_height : float Specify the height of the first layer of cells in the boundary layer. max_layer_height : float face_scope : dict[str, Any] region_scope : list[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_list : list[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_list : list[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_location : list[str] local_prism_preferences : dict[str, Any] zone_list : list[str] region_list : list[str] invalid_added : str complete_region_scope : list[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_list : list[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_list : list[str] complete_bl_region_list : list[str] complete_zone_selection_list : list[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_list : list[str].
add_boundary_layers_for_part_replacement(...)	Determine whether or not boundary layers will be added to your replacement parts for this model. Parameters ---------- add_child : str 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_file : str Specify (or browse for) a .pzmcontrol file that contains the boundary (prism) layer specifications. control_name : str Specify a name for the boundary layer control or use the default value. offset_method_type : str Choose the type of offset to determine how the mesh cells closest to the boundary are generated. More... number_of_layers : int Select the number of boundary layers to be generated. first_aspect_ratio : float Specify the aspect ratio of the first layer of prism cells that are extruded from the base boundary zone. transition_ratio : float 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. rate : float Specify the rate of growth for the boundary layer. first_height : float Specify the height of the first layer of cells in the boundary layer. max_layer_height : float face_scope : dict[str, Any] region_scope : list[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_list : list[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_list : list[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_location : list[str] local_prism_preferences : dict[str, Any] bl_zone_list : list[str] bl_region_list : list[str] complete_region_scope : list[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_list : list[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_list : list[str] complete_bl_region_list : list[str] complete_zone_selection_list : list[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_list : list[str].
add_boundary_type(service, rules, command[, ...])	Create additional boundaries for your simulation. Provide a name, and assign a boundary type to one or more selected zones in your geometry. More... Parameters ---------- mesh_object : str new_boundary_label_name : str Specify a name for the boundary type. new_boundary_type : str Choose a boundary type from the available options. selection_type : str boundary_face_zone_list : list[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_list : list[str] merge : bool Determine whether or not to merge the selected zones (set to yes by default). zone_location : list[str].
add_linear_mesh_pattern(service, rules, command)	Create linear patterns of objects based on one or more CAD parts, greatly simplifying meshing for CAD geometries that require multiple, linearly spaced parts such as in modeling batteries. More... Parameters ---------- child_name : str Specify a name for the mesh pattern or use the default value. object_list : list[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_vector : str 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_direction : dict[str, Any] Specify a name for the mesh pattern or use the default value. pitch : float Specify a value for the pitch, or displacement factor, or use the default value. number_of_units : int Indicate the overall number of instances that the pattern will use. check_overlapping_faces : bool 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_options : dict[str, Any].
add_local_sizing_wtm(service, rules, command)	Apply local sizing controls. Use this task to gain better control over the mesh size distribution, and define specific mesh size controls that operate on specific, localized, portions of the geometry and mesh. Using this task, you can add as many localized size controls to the workflow as you need, depending on the requirements and details of your geometry. More... Parameters ---------- add_child : bool Choose whether or not you want to add local size controls in order to create the surface mesh. boi_control_name : str Provide a name for this specific size control. boi_growth_rate : float Specify the increase in element edge length with each succeeding layer of elements. boi_execution : str 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_using : str boi_size : float 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_layers : int smallest_height : float growth_pattern : str growth_method : str bias_factor : float boi_min_size : float Specify the minimum size of the elements for the surface mesh. boi_max_size : float Specify the maximum size of the elements for the surface mesh. boi_curvature_normal_angle : float 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_gap : float 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_to : str 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_orientation : bool 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_objects : bool boi_zoneor_label : str Choose how you want to select your surface (by label or by zone). boi_face_label_list : list[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_list : list[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_list : list[str] edge_zone_list : list[str] topology_list : list[str] reverse_edge_zone_orientation : bool reverse_edge_zone_list : list[str] boi_patchingtoggle : bool Enable this option to repair any openings that may still exist in the body of influence-based local sizing control. draw_size_control : bool Enable this field to display the size boxes in the graphics window. zone_location : list[str] complete_face_zone_list : list[str] complete_face_label_list : list[str] complete_edge_label_list : list[str] complete_topology_list : list[str] prime_size_control_id : int.
add_multizone_controls(service, rules, command)	Use this task to add multi-zone mesh controls for the selected regions. More... Parameters ---------- control_type : str Determine if you want to define the multi-zone control by selecting regions or edges. multi_z_name : str Enter a name for the multi-zone mesh control, or use the default. mesh_method : str Choose a multi-zone meshing technique: Standard or the Thin volume technique (for only a single layer) fill_with : str Choose a multi-zone meshing fill type: Hex-Pave, Hex-Map, Prism, or Mixed. use_sweep_size : bool Specify the minimum size for the edge-based multizone control. max_sweep_size : float Indicates the maximum value for the sweep size. region_scope : list[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_method : str 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_selection : bool 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_biasing : str 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_list : list[str] label_source_list : list[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_list : list[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_location : list[str] assign_size_using : str 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. intervals : int 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. size : float Specify the minimum size for the edge-based multizone control. smallest_height : float Specify a value for the smallest height for the edge-based multizone control. bias_method : str Select from a choice of patterns that you want to apply to your edge-based multizone control. growth_method : str 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_rate : float Specify a value for the growth rate for the multizone, or use the default value. bias_factor : float 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_selection : list[str] edge_label_list : list[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_controls : dict[str, Any] complete_region_scope : list[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_scope : list[str].
add_shell_boundary_layers(service, rules, ...)	Command add_shell_boundary_layers.
add_thin_volume_meshing_controls(service, ...)	Use this task to add thin volume meshing controls for the selected regions. Parameters ---------- thin_meshing_name : str Enter a name for the thin volume mesh control, or use the default. assign_size_using : str Specify the sizing of the mesh layers to be based on Intervals or based on the Size of the plates. intervals : int Specifies the minimum number of mesh layers to be created within the thin volume mesh. max_number_of_intervals : int Specifies the minimum number of mesh layers to be created within the thin volume mesh. size : float enter the Size of each thin mesh layer or use the default. growth_rate : float 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_overlapping : bool double_biasing : bool 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_imprints : bool 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_plates : bool 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_creation : bool enter the Size of each thin mesh layer or use the default. objects : list[str] region_scope : list[str] Specify the Region(s) where the thin volume meshing controls will be applied. select_source_by : str Choose whether to select the source surfaces by label or by zone. parallel_source : bool Enable this option if you have multiple source zones in parallel that you want to select for thin meshing. label_source_list : list[str] Select the label(s) to use as the source. zone_source_list : list[str] Select the zone(s) to use as the source. topo_source_list : list[str] select_target_by : str Choose whether to select the source surfaces by label or by zone. parallel_target : bool Enable this option if you have multiple target zones in parallel that you want to select for thin meshing, label_target_list : list[str] Select the label(s) to use as the target. zone_target_list : list[str] Select the zone(s) to use as the target. thin_vol_regs : list[str] complete_region_scope : list[str] Specify the Region(s) where the thin volume meshing controls will be applied. complete_label_source_list : list[str] Select the label(s) to use as the source. complete_zone_source_list : list[str] Select the zone(s) to use as the source. complete_topo_source_list : list[str] complete_label_target_list : list[str] Select the label(s) to use as the target. complete_zone_target_list : list[str] Select the zone(s) to use as the target. thin_volume_preferences : dict[str, Any] zone_location : list[str] zone_location_2 : list[str].
add_virtual_topology(service, rules, command)	Command add_virtual_topology.
apply_share_topology(service, rules, command)	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... Parameters ---------- gap_distance : float Specify the maximum distance under which gaps will be removed. Use the Show Marked Gaps button to display such gaps. gap_distance_connect : float 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_size : float interface_select : str 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_labels : list[str] share_topology_preferences : dict[str, Any] improve_surface_mesh_preferences : dict[str, Any] surface_mesh_preferences : dict[str, Any].
axisymmetric_sweep(service, rules, command)	Command axisymmetric_sweep.
capping(service, rules, command[, path])	For solid model geometries where you want to extract a flow volume, use this task to enclose, or cap, any openings in your geometry in order to later calculate your fluid region(s). Assign a name for the capping surface, and designate the type of opening (inlet, outlet, etc.) and assign one or more zones or labels to the capping surface. Create as many caps as required to cover all openings. Choose any advanced options that you want to take effect upon updating the task. More... Parameters ---------- patch_name : str Enter a name for the capping surface. zone_type : str Choose the type of zone to assign to the capping surface (velocity inlet, pressure outlet, etc.). patch_type : str 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_type : str Choose how you want to select your surface (by label or by zone). label_selection_list : list[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_list : list[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_list : list[str] create_patch_preferences : dict[str, Any] object_association : str new_object_name : str patch_object_name : str cap_labels : list[str] zone_location : list[str] complete_zone_selection_list : list[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_list : list[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_list : list[str].
check_mesh(service, rules, command[, path])	Command check_mesh.
check_surface_quality(service, rules, command)	Command check_surface_quality.
check_volume_quality(service, rules, command)	Command check_volume_quality.
choose_mesh_control_options(service, rules, ...)	Pick and choose various means of generating and refining the mesh in your simulation. Determine how you want to create and manage and view your size controls in the workflow. More... Parameters ---------- read_or_create : str Determine whether you want to create new, or use existing mesh size controls or size fields. size_control_file_name : str Browse to specify the location and the name of the size control file (.szcontrol) where your mesh controls are defined. wrap_size_control_file_name : str Browse to specify the location and the name of the size control file (.szcontrol) where your mesh controls are defined. creation_method : str 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_option : str Determine if you would like to use separate tasks or a table to view and work with your mesh controls. global_min : float global_max : float global_growth_rate : float mesh_control_options : dict[str, Any].
close_leakage(service, rules, command[, path])	Command close_leakage.
compute_regions(service, rules, command[, path])	Command compute_regions.
compute_size_fields(service, rules, command)	Command compute_size_fields.
create_collar_mesh(service, rules, command)	Use this task to create an overset collar mesh. You can use various techniques, such as using intersecting objects, using an edge-based approach, or using an existing object.
create_component_mesh(service, rules, command)	Use this task to create an overset component mesh. You can use various techniques, such as using an offset surface, a bounding box, or an existing object.
create_contact_patch(service, rules, command)	This task will create patches in and around any problematic, sharp-angle contact areas (such as between a tire and the road surface) in order to avoid such areas during the meshing process. More... Parameters ---------- contact_patch_name : str Specify a name for the contact patch object, or retain the default name. selection_type : str Choose how you want to make your selection (for instance, by object, zone, or label). zone_selection_list : list[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_location : list[str] object_selection_list : list[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_list : list[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_list : list[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). distance : float Specify the distance of the contact patch geometry from the ground zone, or the thickness of the contact patch. contact_patch_defeaturing_size : float 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_angle : float Specify a value for the angle used to extract feature edges on the contact patch object. patch_hole : bool Indicate whether you want the contact patch object to be filled or not. flip_direction : bool Use this option to switch the direction/orientation of the contact patch.
create_external_flow_boundaries(service, ...)	Create an enclosure, or a bounding box, around the geometry, or use a pre-existing object from the CAD model to represent the enclosure. This enclosure will represent the external flow region, whose bounds can be specified as a ratio of geometry size, or as specific minimum and maximum coordinates. More... Parameters ---------- external_boundaries_name : str Enter a name for the external flow boundary or use the default value. creation_method : str 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_method : str 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_type : str Choose how you want to make your selection (by object, label, or zone name). object_selection_list : list[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_list : list[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_location : list[str] label_selection_list : list[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_single : list[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_single : list[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_single : list[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_name : str bounding_box_object : dict[str, Any] View the extents of the bounding box.
create_gap_cover(service, rules, command[, path])	This task will cover any gaps within a selected object. Recommended with geometries containing noticeable gaps and openings that need to be covered prior to surface meshing. More... Parameters ---------- gap_cover_name : str Specify a name for the gap cover object, or retain the default name. sizing_method : str 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_ratio : float 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_size : float A specified maximum width for the gap. selection_type : str Choose how you want to make your selection (for instance, by object name, zone name, or label name). zone_selection_list : list[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_location : list[str] label_selection_list : list[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_list : list[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_zones : bool 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_factor : float 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_gap : float 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_projection : bool advanced_options : bool Display advanced options that you may want to apply to the task. max_island_face_for_gap_cover : int 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_imprint : bool 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.
create_group(service, rules, command[, path])	Command create_group.
create_leak_shield(service, rules, command)	Command create_leak_shield.
create_local_refinement_regions(service, ...)	Define a more refined region, or body of influence (BOI) when simulating flow within or around your geometry. You can manually create a body of influence using a bounding box or by using an offset surface. This body surrounds the relevant aspects of your geometry, such as the wake region behind a vehicle. More... Parameters ---------- refinement_regions_name : str Enter a name for the body of influence. creation_method : str 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_size : float Specify the cell size for the refinement region mesh. boi_size_name : str selection_type : str Choose how you want to make your selection (by object, label, or zone name). zone_selection_list : list[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_location : list[str] label_selection_list : list[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_list : list[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_single : list[str] object_selection_single : list[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_list : list[str] bounding_box_object : dict[str, Any] View the extents of the bounding box. offset_object : dict[str, Any] These fields contain parameters that define the characteristics of the refinements region (direction, thickness, levels, etc.) cylinder_method : str 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_object : dict[str, Any] axis : dict[str, Any] volume_fill : str cylinder_length : float Specify the Length of the cylinder. geometry_tools_properties : dict[str, Any].
create_mesh_objects(service, rules, command)	Command create_mesh_objects.
create_multizone_mesh(service, rules, command)	Use this task to create a multi-zone mesh for the designated region(s). More... Parameters ---------- orthogonal_quality_limit : float 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_type : str region_scope : list[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_conformal : str 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_factor : float 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_strategy : str re_merge_zones : bool merge_body_labels : bool cfd_surface_mesh_controls : dict[str, Any] body_label_list : list[str] body_label_body_list : list[str] cell_zone_list : list[str] complete_region_scope : list[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.
create_overset_mesh(service, rules, command)	Use this task to create a mesh interface between two or more overset mesh objects. More... Parameters ---------- overset_interfaces_name : str Specify a name for the overset mesh interface or use the default value. object_selection_list : list[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.
create_porous_regions(service, rules, command)	Identify porous regions in your imported geometry so that you can simulate flow through porous media. More... Parameters ---------- input_method : str Indicate whether you are creating the porous region using Direct coordinates, by using a Text file, or by specifying a Nonrectangular region. porous_region_name : str Specify a name for the porous region or use the default value. wrapper_size_factor : float file_name : str Specify the name and location of the text file containing the porous region definition. More... location : str Specify how you would like to determine the location of the porous region. cell_size_p1_p2 : float 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_p3 : float 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_p4 : float 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_ratio : float 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. p1 : list[float] p2 : list[float] p3 : list[float] p4 : list[float] non_rectangular_parameters : dict[str, Any].
create_regions(service, rules, command[, path])	Confirm that Fluent has correctly estimated the number of fluid regions. Fluent will detect additional regions if they exist, however, it will detect fluid regions only where they are connected to capping surfaces. Your geometry may include a solid region only, or it may contain a fluid region within a solid region. More... Parameters ---------- number_of_flow_volumes : int 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_name : bool 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_object : str.
create_surface_mesh(service, rules, command)	Generate a mesh over the surface of the imported CAD geometry, or remesh an imported surface mesh, or use pre-existing size field or size control files. Surface meshes are used to define the computational region or volume for the CFD analysis. Specify and adjust various properties of the computational surface mesh and preview them in the graphics window until you are satisfied that the surface mesh completely and accurately captures the topology of the imported CAD geometry. No gaps or slivers should be present, and you should refine the surface mesh in key areas to ensure that you can capture important physical behavior in your CFD analysis. Choose any advanced options that you want to take effect upon updating the task. More... Parameters ---------- cfd_surface_mesh_controls : dict[str, Any] separation_required : bool 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_angle : float Specify a desired angle for determining separation. Assigning a smaller separation angle will produce more zones. remesh_selection_type : str Choose how you want to select your surface(s) to remesh (by label or by zone). remesh_zone_list : list[str] remesh_label_list : list[str] surface_mesh_preferences : dict[str, Any] import_type : str append_mesh : bool cad_faceting_file_name : str directory : str pattern : str length_unit : str tesselation_method : str original_zones : list[str] execute_share_topology : bool 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_controls : dict[str, Any] cad_import_options : dict[str, Any] share_topology_preferences : dict[str, Any] preview_size_toggle : bool 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).
create_volume_mesh_ftm(service, rules, command)	This task will generate the volume mesh for all the fluid regions. It will generate the cell type based on the selection from the Volume Fill setting in the Update Region Settings task. Boundary layer prisms will also be generated if assigned for the fluid region. Use the Edit Volume Fill Setting option to view previous settings and edit them accordingly prior to creating the volume mesh. Parameters ---------- mesh_quality : float orthogonal_quality : float 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_parallel : bool 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_mesh : bool Select this option to save the volume mesh. edit_volume_settings : bool Enable this option to review and/or edit the fill settings for your volume region(s). region_name_list : list[str] region_volume_fill_list : list[str] region_size_list : list[str] old_region_name_list : list[str] old_region_volume_fill_list : list[str] old_region_size_list : list[str] all_region_name_list : list[str] all_region_volume_fill_list : list[str] all_region_size_list : list[str] fast_ro : bool ro_ref_size : float max_cell_level : int max_cell_size : float max_boundary_cell_level : int max_boundary_cell_size : float ro_curv_switch_angle_criterion : float ro_curv_min_angle : float ro_curv_max_angle : float advanced_options : bool Display advanced options that you may want to apply to the task. spike_removal_angle : float dihedral_min_angle : float quality_method : str 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_nodes : bool 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_layers : int 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_field : bool 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_ratio : float 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_layers : int 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_rate : float 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_ratio : float conformal_prism_split : bool 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_quads : bool 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_factor : float 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_tasks : bool.
create_volume_mesh_wtm(service, rules, command)	Generate a computational mesh for the entire volume within your geometry. As needed, specify and adjust various global properties of the boundary layer and the volume itself to ensure a comprehensive mesh for the entire flow volume. In many cases, the default values will be sufficient. More... Parameters ---------- solver : str Specify the target solver for which you want to generate the volume mesh (Fluent or CFX). volume_fill : str Specify the type of cell to be used in the volumetric mesh: polyhedra (default), poly-hexcore, hexcore, or tetrahedral. mesh_fluid_regions : bool 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_regions : bool 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_method : str 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_controls : dict[str, Any] region_based_preferences : bool re_merge_zones : bool After separating zones during surface meshing, here, choose to re-merge the zones prior to creating the volume mesh. parallel_meshing : bool 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_meshing : bool 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_meshing : bool volume_mesh_preferences : dict[str, Any] prism_preferences : dict[str, Any] Display global settings for your boundary layers. Note that these settings are not applied for Multizone boundary layers global_thin_volume_preferences : dict[str, Any] invoke_prims_control : str offset_method_type : str Choose the type of offset to determine how the mesh cells closest to the boundary are generated. More... number_of_layers : int Select the number of boundary layers to be generated. first_aspect_ratio : float Specify the aspect ratio of the first layer of prism cells that are extruded from the base boundary zone. transition_ratio : float Specify the rate at which adjacent elements grow, for the smooth transition offset method. rate : float Specify the rate of growth for the boundary layer. first_height : float Specify the height of the first layer of cells in the boundary layer. mesh_object : str mesh_dead_regions : bool body_label_list : list[str] body_label_body_list : list[str] prism_layers : bool quad_tet_transition : str merge_cell_zones : bool face_scope : dict[str, Any] region_tet_name_list : list[str] region_tet_max_cell_length_list : list[str] region_tet_growth_rate_list : list[str] region_hex_name_list : list[str] region_hex_max_cell_length_list : list[str] old_region_tet_max_cell_length_list : list[str] old_region_tet_growth_rate_list : list[str] old_region_hex_max_cell_length_list : list[str] cfd_surface_mesh_controls : dict[str, Any] show_solid_fluid_meshed : bool.
create_zero_thickness_geometry(service, ...)	Add thickness to any zero-thickness portions of your geometry (such as baffles or interior walls) where those portions of the geometry are relevant to your simulation. Not all portions of the geometry require a thickness, however, a more refined surface mesh can be generated if all important and relevant aspects of the geometry have a certain thickness. More... Parameters ---------- zero_thickness_name : str Specify a name for the thickness control or use the default value. selection_type : str Choose how you want to make your selection (by object, label, or zone name). zone_selection_list : list[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_location : list[str] object_selection_list : list[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_list : list[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... distance : float 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.
custom_journal_task(service, rules, command)	Customize your workflow using journaling commands. Use a text editor to copy portions of any of your own journal files, and paste them into this task to perform additional meshing refinements. More... Parameters ---------- journal_string : str Enter one or more journal commands. python_journal : bool prime_journal : bool.
define_boundary_layer_controls(service, ...)	Improve how the boundary layer flow along the walls of the geometry is captured using specialized boundary layer elements within the volume mesh (also called prisms or inflation layers). You can use this task to assign different fluid regions to have their own boundary layer controls. For more layers (greater than 3), consider adding 1 layer and performing anisotropic adaption in the solver. More... Parameters ---------- add_child : bool Determine whether or not you want to better capture flow in and around the boundary layer of your fluid regions. prisms_settings_name : str Specify a name for the boundary layer control or use the default value. aspect_ratio : float Specify the ratio of the prism base length to the prism layer height. growth_rate : float Specify the rate of growth of the boundary layer. offset_method_type : str Choose the method that will be used to create the boundary layer, or prism, controls. last_ratio_percentage : float Specify the offset height of the last layer as a percentage of the local base mesh size. first_height : float Specify the height of the first layer of cells in the boundary layer. prism_layers : int Specify the number of cell layers you require along the boundary. region_selection_list : list[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.
define_global_sizing(service, rules, command)	Command define_global_sizing.
define_leakage_threshold(service, rules, command)	Define leakage threshold size to fix any potential leakages that may occur due to any missing, misaligned parts, or small imperfections from the imported geometry. These holes may be larger than any of your initial local size controls, resulting in leaks that need to be closed. Use the Preview Leakages button and associated controls repeatedly to identify holes that need to be closed. Leakages can be closed to a void region or inside an object. More... Parameters ---------- add_child : bool Indicate whether or not you need to define a leakage threshold for one or more regions. leakage_name : str Specify a name for the leakage threshold or use the default value. selection_type : str Choose how you want to make your selection (by object or by a previously identified region). dead_regions_list : list[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_single : list[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_size : float 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_value : int Use the slider to move the clipping plane along the axis of the selected X, Y, or Z direction. plane_direction : str Indicates the direction in which the clipping plane faces. flip_direction : bool Change the orientation of the clipping plane, exposing the mesh on the opposite side.
describe_geometry(service, rules, command[, ...])	Specify the type of geometry you are importing: whether it is a solid model a fluid model, or both. The workflow changes based on your selection. Additionally, for fluid volume extraction, you need to indicate whether or not any openings need to be closed. More... Parameters ---------- setup_type : str Choose whether your geometry represents only a solid body, only a fluid body, or both a solid and fluid body. capping_required : bool Choose whether or not you are going to perform any capping operations, thereby enclosing a fluid region. wall_to_internal : bool 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_topology : str 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_conformal : bool 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. multizone : bool 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_internals : list[str] setup_internal_types : list[str] old_zone_list : list[str] old_zone_type_list : list[str] region_list : list[str] edge_zone_list : list[str] edge_labels : list[str] duplicates : bool fluid_regions : list[str] improve_surface_mesh_preferences : dict[str, Any].
describe_geometry_and_flow(service, rules, ...)	Specify the type of geometry you have and the type of flow you are trying to simulate. You can determine whether the flow is an external flow around an object, or whether it is an internal flow inside an object. For external flows, you can choose to add an enclosure. For internal flows, you can choose to cover large openings to extract the flow region, or rely on automatically detecting and closing any leaks to the outer domain. In either case, you are also able to add refinement regions in and around your geometry. More... Parameters ---------- flow_type : str 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_options : bool Display standard geometry-based options that you may want to apply to the workflow. add_enclosure : bool 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_caps : bool 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_regions : bool 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_options : dict[str, Any] all_task_list : list[str].
describe_overset_features(service, rules, ...)	Use this task to determine if specific overset features are required for your workflow. Depending on your simulation requirements, you may or may not need to add an overset collar mesh and/or an overset component mesh to your overall workflow tasks. Parameters ---------- advanced_options : bool component_grid : bool Indicate whether you need to add an overset component mesh task to the workflow. collar_grid : bool Indicate whether you need to add an overset collar mesh task to the workflow background_mesh : bool overset_interfaces : bool.
diagnostics(service, rules, path)	Singleton diagnostics.
extract_edge_features(service, rules, command)	Fidelity of the geometry can be improved by extracting feature edges. There are three types of feature edges that can be extracted: edges based on an angle; edges based on a sharp-angle; and edges based on intersections. More... Parameters ---------- extract_edges_name : str Specify a name for the edge feature extraction or use the default value. extract_method_type : str Choose how the edge features are to be extracted: either by feature angle, intersection loops, or by sharp angle. selection_type : str Choose how you want to make your selection (by object, label, or zone name). object_selection_list : list[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_list : list[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_list : list[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_location : list[str] label_selection_list : list[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_local : int Specify the minimum angle between the feature edges that should be preserved. individual_collective : str 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_angle : int Use the slider to specify the sharp angle (in degrees) that will be used in the feature extraction. complete_object_selection_list : list[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_list : list[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_objects : list[str].
extrude_volume_mesh(service, rules, command)	Use this task to extend all or parts of your volume mesh beyond the original domain.
file(service, rules, path)	Singleton file.
generate_initial_surface_mesh(service, ...)	Command generate_initial_surface_mesh.
generate_map_mesh(service, rules, command[, ...])	Command generate_map_mesh.
generate_prism_layers(service, rules, command)	Command generate_prism_layers.
generate_surface_mesh(service, rules, command)	This task will close all the leakages to objects and void regions and then generate only the surface mesh. More... Parameters ---------- surface_quality : float This is the target maximum surface mesh quality. The recommended value is between 0.7 and 0.85. save_surface_mesh : bool 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_options : bool Display advanced options that you may want to apply to the task. save_intermediate_files : bool 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_name : str 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_surface : bool Select Yes if you want to have the final surface mesh to be viewed as separated zones. use_size_field_for_prime_wrap : bool leak_shield : bool auto_region_between_porous : bool auto_pairing : bool Specify whether or not you want to separate contact pairs between fluids and solids. merge_wrapper_at_solid_conacts : bool 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_option : bool 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_sessions : int 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_face : int 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_angle : float 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_angle : float 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_geometry : bool Determine whether, after surface meshing, Fluent will project the mesh nodes back onto to the original CAD model. auto_assign_zone_types : bool Choose whether or not to automatically assign boundary types to zones. advanced_inner_wrap : bool Choose whether or not to extend or expand the surface mesh into any interior pockets or cavities. gap_cover_zone_recovery : bool 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_min : float 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_tasks : bool.
generate_volume_mesh(service, rules, command)	Command generate_volume_mesh.
global_settings(service, rules, path)	Singleton global_settings.
graphics(service, rules, path)	Singleton graphics.
identify_construction_surfaces(service, ...)	Identify specific portions of your imported geometry that may exist as some form of construction surface, such as capping surface(s), or cylindrical surface(s) (for identifying moving reference frames, for example). You need to identify such objects within your geometry as being construction surfaces so that Fluent can mange those objects accordingly during the meshing process. More... Parameters ---------- name : str Specify a name for the construction surface or use the default value. creation_method : str Choose whether to create the construction surface using an Existing object or zone, a bounding Box, or by using an Offset Surface. selection_type : str Choose how you want to make your selection (by object, label, or zone name). object_selection_single : list[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_single : list[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_single : list[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_list : list[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_list : list[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_location : list[str] label_selection_list : list[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_size : float 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_height : float Specify the height of the offset construction surface. This is how far from the selected object(s) the rough shape is offset. pivot : dict[str, Any] axis : dict[str, Any] rotation : dict[str, Any] cylinder_object : dict[str, Any] cylinder_method : str bounding_box_object : dict[str, Any] View the extents of the bounding box.
identify_deviated_faces(service, rules, command)	Use this task to identify how the wrapped surface mesh differs from the original geometry. This task can be useful for identifying deviations in the surface mesh in, for example, geometries with sharp angles. Parameters ---------- display_grid_name : str Enter a name for the identified deviated faces. selection_type : str Specify whether the identification of deviated faces is to be applied to an indicated object or zone. object_selection_list : list[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_list : list[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_location : list[str] advanced_options : bool Enable this option to automatically calculate the minimum and maximum deviation for the selected object(s) or zone(s). deviation_min_value : float When Auto Compute is disabled, specify a minimum value for the deviation. deviation_max_value : float When Auto Compute is disabled, specify a maximum value for the deviation. overlay : str Determine how you want the deviated faces to be displayed (either with the mesh or with the geometry). include_gap_cover_geometry : bool 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.
identify_orphans(service, rules, command[, path])	Use this task to isolate and locate any orphan cells in your mesh.
identify_regions(service, rules, command[, path])	Identify specific regions in and around your imported geometry, such as a flow region surrounding a vehicle in an external flow simulation. In this task, you are positioning specific points in the domain where certain regions of interest can be identified and classified for later use in your simulation. More... Parameters ---------- add_child : bool Determine whether or not you want to specify any fluid or void regions using this task. material_points_name : str Specify a name for the region that you want to identify or use the default value. mpt_method_type : str 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_type : str Specify the type of region as being fluid, solid, or a void. link_construction : bool 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_type : str Choose how you want to make your selection (by object, label, or zone name). zone_selection_list : list[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_location : list[str] label_selection_list : list[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_list : list[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_selection : bool Enable this option and select a point in the graphics window to be the center of the region. show_coordinates : bool Enable this option when providing numerical inputs for the region location, and you want to view the exact coordinates. x : float The x-coordinate of the center of the region. y : float The y-coordinate of the center of the region. z : float The z-coordinate of the center of the region. offset_x : float The x-coordinate of the offset distance relative to the centroid of the selected object/zone. offset_y : float The y-coordinate of the offset distance relative to the centroid of the selected object/zone. offset_z : float The z-coordinate of the offset distance relative to the centroid of the selected object/zone.
import_boi_geometry(service, rules, command)	Specify the geometry or mesh file(s) that represent the bodies of influence you wish to import into the workflow. Choose from either a CAD file or a surface or volume mesh. For CAD geometries, choose the appropriate units in which the geometry was created. Browse, or specify the file name(s) and location for the CAD geometry or mesh that you are going to import. It is recommended to select units so that the minimum size is between approximately 0.1 and 10. More... Parameters ---------- type : str 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_name : str Select CAD file(s) to import into your simulation as a body of influence. 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_name : str Select surface or volume mesh file(s) to import into your simulation as a body of influence. Supported file types are: *.msh, *.msh.gz, and *.msh.h5 files). imported_objects : list[str] length_unit : str cad_import_options : dict[str, Any].
import_cad_and_part_management(service, ...)	Import a CAD geometry (.fmd or .stl), then determine how you want to create your meshing objects: by Part (simple, a mesh object will be created for each of the CAD part), or by Custom where you customize the import process (for complicated, multiple part assemblies, etc.). For a customized approach, you can pick and choose the portions of the CAD model that you want to add to your simulation, and adjust any meshing-related settings for individual objects, before converting them into meshing objects. You can further simplify your CAD model and combine parts and assemblies into a single object. To capture features more effectively, you can increase or decrease the faceting resolution, thereby controlling the surface mesh granularity and therefore influencing the simulation time. More... Parameters ---------- file_loaded : bool fmd_file_name : str Select a CAD file to import into your simulation. Standard Ansys file types, among others, are supported, including .scdoc, .dsco, .agdb, .fmd, .fmdb, .fmd, .pmdb, .tgf, and .msh. To quickly import multiple CAD files, you can use basic wildcard expression patterns such as the * or ? wildcards. More... append_file_name : str Enable this option and browse/select another CAD file to append to your original geometry. Specify additional CAD files in the Append File field, and use the Append button to load additional CAD files into the tree, after the original CAD objects. To quickly append multiple CAD files, you can use basic wildcard expression patterns such as the * or ? wildcards. append : bool 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_unit : str Select a suitable unit for display in the graphics window. create_object_per : str 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_unit : str Specify the units of length used by this .stl file before loading the CAD file. file_length_unit_append : str 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. route : str 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_append : str 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_lod : int Specify the level of detail that you want to include for this .jt file before loading the CAD file. jt_lod_append : int 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_body : bool 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_name : bool 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_parts : bool Enabled by default, this option lets you import your CAD geometry while removing any empty components. feature_angle : float Specify a rotational angle (in degrees) of transformation. one_zone_per : str 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. refaceting : dict[str, Any] ignore_solid_names : bool 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_append : bool 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. options : dict[str, Any] edge_extraction : str 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. context : int object_setting : str refacet_options : dict[str, Any].
import_geometry(service, rules, command[, path])	Specify the CAD geometry that you want to work with. Choose from either a CAD file or a surface or volume mesh. Choose the appropriate units in which the geometry or mesh was created. Choose any advanced options (such as faceting controls) that you want to take effect upon import. Browse, or specify the file name and location for the CAD geometry that you are going to import. It is recommended to select units so that the minimum size is between approximately 0.1 and 10. More... Parameters ---------- file_format : str Indicate whether the imported geometry is a CAD File or a Mesh (either a surface or volume mesh). import_type : str 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_unit : str 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_unit : str Specify the units in which the surface or volume mesh was created in. use_body_labels : bool 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_preferences : dict[str, Any] file_name : str 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_names : str 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_name : str 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_parts : float append_mesh : bool directory : str pattern : str cad_import_options : dict[str, Any].
improve_surface_mesh(service, rules, command)	Perform immediate improvements to the quality of the existing surface mesh by adjusting various parameters such as the face quality limit, as well as maximum angle and face skewness. More... Parameters ---------- mesh_object : str face_quality_limit : float Use the specified value to improve the surface mesh. Note that this control can aggressively change your surface mesh when applied. min_size : float scope_improve_to : str improve_surface_mesh_preferences : dict[str, Any].
improve_volume_mesh(service, rules, command)	Perform immediate improvements to the quality of the existing volume mesh by adjusting various parameters such as the cell quality limit, as well as minimum angle and the ability to ignore problematic features. More... Parameters ---------- quality_method : str 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_limit : float Use the specified value to improve the volume mesh. Note that this control can aggressively change your volume mesh when applied. add_multiple_quality_methods : bool Use this option to specify quality criteria for multiple quality methods. quality_method_list : list[str] quality_criteria_list : list[str] old_quality_method_list : list[str] old_quality_criteria_list : list[str] improve_volume_mesh_preferences : dict[str, Any].
load_cad_geometry(service, rules, command[, ...])	Command load_cad_geometry.
manage_zones_ftm(service, rules, command[, path])	Use this task to perform common operations on cell zones or face zones, Prior to generating the volume mesh, you can perform operations such as separating zones, splitting cylindrical regions, or extracting edges. After generating your volume mesh, you can perform operations such as renaming, changing prefixes, and merging zones. Especially useful for complex models with numerous zones. More... Parameters ---------- type : str 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_filter : str 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_filter : str 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). area : float volume : float equal_range : float Specify a percentage range to maintain equivalency for the cell zone volume value or the face zone area value. zone_or_label : str Choose how you want to make your selection (by label or zone name). label_list : list[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_list : list[str] manage_face_zone_list : list[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_list : list[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_list : list[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... operation : str 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_name : str The text string to be applied to this zone operation. control_name : str Specify a name for the managed zone control or use the default value. add_prefix_name : str The text string to be applied to this zone operation. face_merge : bool Indicate whether or not you want to merge faces as part of the zone operation. angle : float Specify a value for the separation angle for determining separation. Assigning a smaller separation angle will produce more zones. zone_list : list[str] complete_zone_list : list[str] complete_label_list : list[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_location : list[str].
mesh_controls_table(service, rules, command)	Review the mesh control settings, such as the Minimum Size, the Maximum Size, and the Growth Rate, as well as a table of common settings. Parameters ---------- global_min : float global_max : float target_growth_rate : float draw_size_control : bool Enable this field to display the size boxes in the graphics window. initial_size_control : bool Enable this field to display the initial size control in the graphics window. target_size_control : bool Enable this field to display the target size control in the graphics window. size_control_interval : float Specify the amount of size control boxes to display. size_control_parameters : dict[str, Any].
modify_mesh_refinement(service, rules, command)	Perform individual modifications to the surface mesh by creating mesh refinement objects and sequences. Assign a name, a remeshing sequence if desired, along with local sizing parameters. Create as many refinement controls as needed in order to modify the surface mesh to your needs. Choose any advanced options that you want to take effect upon updating the task. More... Parameters ---------- mesh_object : str remesh_execution : str 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_name : str Provide a name for this specific size control. local_size : float Specify a value for the local sizing parameter to be applied to the indicated zone. face_zone_or_label : str Specify whether the size control is to be applied to an indicated zone or a label. remesh_face_zone_list : list[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_list : list[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_type : str local_min_size : float local_max_size : float remesh_growth_rate : float remesh_curvature_normal_angle : float remesh_cells_per_gap : float cfd_surface_mesh_controls : dict[str, Any] remesh_preferences : dict[str, Any].
part_replacement_options(service, rules, command)	After creating a volume mesh, use this task to append, add, remove, or replace portions of your original geometry with other CAD parts. By applying localized surface mesh or volume mesh based analyses, you can use this task to quickly update the volume mesh to easily see how geometry changes impact the volume mesh. Parameters ---------- add_part_management : bool 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_replacement : bool add_local_sizing : bool 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_layer : bool 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_mesh : bool Use this task to remove the existing volume mesh and to update the volume mesh with your new part replacement changes.
part_replacement_settings(service, rules, ...)	Use this task to define particular details for the part replacement operation where you can choose to add, remove, or replace one or more portions of your original imported geometry. Parameters ---------- part_replacement_name : str Enter a name for the part replacement object, or keep the default value. management_method : str Choose whether the part replacement operation will be an Addition, Replacement, or Removal of a part. creation_method : str 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_list : list[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_list : list[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_options : bool Display advanced options that you may want to apply to the task. scaling_factor : float Specify a factor to change the size of the bounding box surrounding the selected object(s) for part replacement. mpt_method_type : str 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_selection : bool 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_coordinates : bool Use this option to see the exact coordinate values of the current location point. x : float Indicates the x-coordinate of the current point location. y : float Indicates the y-coordinate of the current point location. z : float Indicates the z-coordinate of the current point location.
prepare_for_volume_meshing(service, rules, ...)	Command prepare_for_volume_meshing.
remesh_surface(service, rules, command[, path])	Command remesh_surface.
separate_contacts(service, rules, command[, ...])	Enable or disable the ability to separate any existing contacts between surfaces. Parameters ---------- separate_contacts_option : bool Use this option to enable or disable the ability to separate any existing contacts between surfaces.
set_up_rotational_periodic_boundaries(...[, ...])	Define boundaries suited for rotational periodicity. The task will remesh a single periodic face to exactly match its reference side, as well as create the corresponding periodic and shadow boundary types for use in the Fluent solver. More... Parameters ---------- mesh_object : str type : str Choose the type of periodicity: rotational or translational. method : str 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_angle : float Specify the angle at which periodicity occurs. rotation_axis_origin : dict[str, Any] The X, Y, and Z components of the origin point for the periodic boundary. rotation_axis_direction : dict[str, Any] The X, Y, and Z components of the vector for the periodic boundary. trans_shift : dict[str, Any] selection_type : str Specify whether the periodic boundary is to be applied to an indicated zone or a label. zone_list : list[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_list : list[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_list : list[str] remesh_boundaries_option : str Enable this option to remesh boundaries when there is an asymmetric mesh on the periodic faces. zone_location : list[str] list_all_label_toggle : bool View more labels in the table, such as those for fluid-fluid internal boundaries, in addition to external boundaries. auto_multiple_periodic : bool multiple_option : str.
setup_size_controls(service, rules, command)	Create individual sizing controls for your mesh. For every size control that you create, it is added to the workflow as a subtask. More... Parameters ---------- local_settings_name : str Specify a name for the size control or use the default value. compute_for_solid_only : str selection_type : str Choose how you want to make your selection (by object, label, or zone name). object_selection_list : list[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_list : list[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_list : list[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_location : list[str] edge_selection_list : list[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_parameters : dict[str, Any] value_changed : str complete_zone_selection_list : list[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_list : list[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_list : list[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_list : list[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.
switch_to_solution(service, rules, command)	Command switch_to_solution.
transform_volume_mesh(service, rules, command)	Use this task to create and apply either a translational or a rotational transformation to the volume mesh (or to one or more copies of the volume mesh).
update_boundaries(service, rules, command[, ...])	Use the table to review a summary of all of your defined boundaries, and their assigned types, and make revisions as needed. Rename a boundary by double-clicking its name in the list and providing another name. Reassign the type for a specific boundary by clicking the type designation and using the drop-down menu that appears. More... Parameters ---------- mesh_object : str selection_type : str Choose how boundaries are displayed in the table. boundary_label_list : list[str] boundary_label_type_list : list[str] boundary_zone_list : list[str] boundary_zone_type_list : list[str] old_boundary_label_list : list[str] old_boundary_label_type_list : list[str] old_boundary_zone_list : list[str] old_boundary_zone_type_list : list[str] old_label_zone_list : list[str] list_all_boundaries_toggle : bool View more boundaries in the table, such as fluid-fluid internal boundaries, in addition to external boundaries. zone_location : list[str] topology_list : list[str] topology_type_list : list[str] old_topology_list : list[str] old_topology_type_list : list[str] topology_body_list : list[str] boundary_current_list : list[str] boundary_current_type_list : list[str] boundary_allowed_type_list : list[str].
update_region_settings(service, rules, command)	Review the settings assigned to the regions in your simulation. Use the table to reassign their extraction techniques, region types, volume meshing cell types, or leakage size settings. More... Parameters ---------- main_fluid_region : str Identify the main fluid region for your simulation. filter_category : str 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_list : list[str] region_mesh_method_list : list[str] region_type_list : list[str] region_volume_fill_list : list[str] region_leakage_size_list : list[str] region_overset_componen_list : list[str] old_region_name_list : list[str] old_region_mesh_method_list : list[str] old_region_type_list : list[str] old_region_volume_fill_list : list[str] old_region_leakage_size_list : list[str] old_region_overset_componen_list : list[str] all_region_name_list : list[str] all_region_mesh_method_list : list[str] all_region_type_list : list[str] all_region_volume_fill_list : list[str] all_region_leakage_size_list : list[str] all_region_overset_componen_list : list[str] all_region_linked_construction_surface_list : list[str] all_region_source_list : list[str] all_region_filter_categories : list[str].
update_regions(service, rules, command[, path])	Use the table to review a summary of all of your defined regions, and their assigned types, and make revisions as needed.
update_volume_mesh(service, rules, command)	Use this task to remove the existing volume mesh and to update the volume mesh with your new part replacement changes. Parameters ---------- enable_parallel : bool 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.
wrap_main(service, rules, command[, path])	Command wrap_main.
write_2d_mesh(service, rules, command[, path])	Command write_2d_mesh.
write_skin(service, rules, command[, path])	Command write_skin.

__init__(service, rules, path)

__init__ method of PyMenu class.

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

Bases: PyCommand

Command add_2d_boundary_layers.

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]

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

Determine whether or not boundary layers will be added to various portions of the model. Once a boundary layer is defined, global boundary layer settings are determined in the Create Volume Mesh task. Parameters ———- add_child : str

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

Specify (or browse for) a .pzmcontrol file that contains the boundary (prism) 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_height : float face_scope : dict[str, Any] region_scope : list[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_location : list[str] local_prism_preferences : dict[str, Any] zone_list : list[str] region_list : list[str] invalid_added : str complete_region_scope : list[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_list : list[str] complete_bl_region_list : list[str] complete_zone_selection_list : list[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_list : list[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

Determine whether or not boundary layers will be added to your replacement parts for this model. Parameters ———- add_child : str

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

Specify (or browse for) a .pzmcontrol file that contains the boundary (prism) 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_height : float face_scope : dict[str, Any] region_scope : list[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_location : list[str] local_prism_preferences : dict[str, Any] bl_zone_list : list[str] bl_region_list : list[str] complete_region_scope : list[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_list : list[str] complete_bl_region_list : list[str] complete_zone_selection_list : list[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_list : list[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

Create additional boundaries for your simulation. Provide a name, and assign a boundary type to one or more selected zones in your geometry. More… Parameters ———- mesh_object : str new_boundary_label_name : str

Specify a name for the boundary type.

new_boundary_typestr

Choose a boundary type from the available options.

selection_type : str boundary_face_zone_list : list[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_list : list[str] merge : bool

Determine whether or not to merge the selected zones (set to yes by default).

zone_location : list[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

Create linear patterns of objects based on one or more CAD parts, greatly simplifying meshing for CAD geometries that require multiple, linearly spaced parts such as in modeling batteries. More… Parameters ———- child_name : str

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]

Specify a name for the mesh pattern or use the default value.

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_options : dict[str, Any]

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

Apply local sizing controls. Use this task to gain better control over the mesh size distribution, and define specific mesh size controls that operate on specific, localized, portions of the geometry and mesh. Using this task, you can add as many localized size controls to the workflow as you need, depending on the requirements and details of your geometry. More… Parameters ———- add_child : bool

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_using : str boi_size : float

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_layers : int smallest_height : float growth_pattern : str growth_method : str bias_factor : float boi_min_size : float

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_objects : bool boi_zoneor_label : str

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_list : list[str] edge_zone_list : list[str] topology_list : list[str] reverse_edge_zone_orientation : bool reverse_edge_zone_list : list[str] boi_patchingtoggle : bool

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_location : list[str] complete_face_zone_list : list[str] complete_face_label_list : list[str] complete_edge_label_list : list[str] complete_topology_list : list[str] prime_size_control_id : int

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

Use this task to add multi-zone mesh controls for the selected regions. More… Parameters ———- control_type : str

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_list : list[str] label_source_list : list[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_location : list[str] assign_size_using : str

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_selection : list[str] edge_label_list : list[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_controls : dict[str, Any] complete_region_scope : list[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_scope : list[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

Command add_shell_boundary_layers.

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]

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

Use this task to add thin volume meshing controls for the selected regions. Parameters ———- thin_meshing_name : str

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_overlapping : bool double_biasing : bool

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.

objects : list[str] region_scope : list[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_list : list[str] select_target_by : str

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_regs : list[str] complete_region_scope : list[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_list : list[str] complete_label_target_list : list[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_preferences : dict[str, Any] zone_location : list[str] zone_location_2 : list[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

Command add_virtual_topology.

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

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… Parameters ———- gap_distance : float

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_size : float interface_select : str

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_labels : list[str] share_topology_preferences : dict[str, Any] improve_surface_mesh_preferences : dict[str, Any] surface_mesh_preferences : dict[str, Any]

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

Command axisymmetric_sweep.

Parameters:

axis_sweep_control_namestr

selection_typestr

sweep_boundary_zone_listlist[str]

topology_listlist[str]

axis_origindict[str, Any]

axis_directiondict[str, Any]

revolution_angle_degfloat

number_of_layersint

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

For solid model geometries where you want to extract a flow volume, use this task to enclose, or cap, any openings in your geometry in order to later calculate your fluid region(s). Assign a name for the capping surface, and designate the type of opening (inlet, outlet, etc.) and assign one or more zones or labels to the capping surface. Create as many caps as required to cover all openings. Choose any advanced options that you want to take effect upon updating the task. More… Parameters ———- patch_name : str

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_list : list[str] create_patch_preferences : dict[str, Any] object_association : str new_object_name : str patch_object_name : str cap_labels : list[str] zone_location : list[str] complete_zone_selection_list : list[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_list : list[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

Command check_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

Command check_surface_quality.

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

Command check_volume_quality.

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

Pick and choose various means of generating and refining the mesh in your simulation. Determine how you want to create and manage and view your size controls in the workflow. More… Parameters ———- read_or_create : str

Determine whether you want to create new, or use existing mesh size controls or size fields.

size_control_file_namestr

Browse to specify the location and the name of the size control file (.szcontrol) where your mesh controls are defined.

wrap_size_control_file_namestr

Browse to specify the location and the name of the size control file (.szcontrol) where your mesh controls are defined.

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_min : float global_max : float global_growth_rate : float mesh_control_options : dict[str, Any]

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

Command close_leakage.

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

Command compute_regions.

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

Command compute_size_fields.

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

Use this task to create an overset collar mesh. You can use various techniques, such as using intersecting objects, using an edge-based approach, or using an existing object.

More…

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_name : str selection_type : str

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_location : list[str] label_selection_list : list[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_list : list[str] bounding_box_object : dict[str, Any] offset_object : dict[str, Any] cylinder_method : str cylinder_object : dict[str, Any] axis : dict[str, Any] volume_fill : str

Specify the type of mesh cell to use to fill the collar mesh. Available options are tetrahedral, hexcore, poly, or poly-hexcore. .

cylinder_length : float geometry_tools_properties : dict[str, Any]

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

Use this task to create an overset component mesh. You can use various techniques, such as using an offset surface, a bounding box, or an existing object.

More…

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_name : str selection_type : str

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_location : list[str] label_selection_list : list[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_list : list[str] bounding_box_object : dict[str, Any]

View the extents of the bounding box.

offset_object : dict[str, Any] cylinder_method : str cylinder_object : dict[str, Any] axis : dict[str, Any] volume_fill : str

Specify the type of mesh cell to use to fill the component mesh. Available options are tetrahedral, hexcore, poly, or poly-hexcore. .

cylinder_length : float geometry_tools_properties : dict[str, Any]

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

This task will create patches in and around any problematic, sharp-angle contact areas (such as between a tire and the road surface) in order to avoid such areas during the meshing process. More… Parameters ———- contact_patch_name : str

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_location : list[str] object_selection_list : list[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

Create an enclosure, or a bounding box, around the geometry, or use a pre-existing object from the CAD model to represent the enclosure. This enclosure will represent the external flow region, whose bounds can be specified as a ratio of geometry size, or as specific minimum and maximum coordinates. More… Parameters ———- external_boundaries_name : str

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_location : list[str] label_selection_list : list[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_name : str bounding_box_object : dict[str, Any]

View the extents of the bounding box.

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

This task will cover any gaps within a selected object. Recommended with geometries containing noticeable gaps and openings that need to be covered prior to surface meshing. More… Parameters ———- gap_cover_name : str

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_location : list[str] label_selection_list : list[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_projection : bool advanced_options : bool

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

Command create_group.

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

Command create_leak_shield.

Parameters:

leak_shield_namestr

use_size_fieldstr

size_field_file_namestr

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

Define a more refined region, or body of influence (BOI) when simulating flow within or around your geometry. You can manually create a body of influence using a bounding box or by using an offset surface. This body surrounds the relevant aspects of your geometry, such as the wake region behind a vehicle. More… Parameters ———- refinement_regions_name : str

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_name : str selection_type : str

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_location : list[str] label_selection_list : list[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_single : list[str] object_selection_single : list[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_list : list[str] bounding_box_object : dict[str, Any]

View the extents of the bounding box.

offset_objectdict[str, Any]

These fields contain parameters that define the characteristics of the refinements region (direction, thickness, levels, etc.)

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_object : dict[str, Any] axis : dict[str, Any] volume_fill : str cylinder_length : float

Specify the Length of the cylinder.

geometry_tools_properties : dict[str, Any]

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

Command create_mesh_objects.

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

Use this task to create a multi-zone mesh for the designated region(s). More… Parameters ———- orthogonal_quality_limit : float

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_type : str region_scope : list[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_strategy : str re_merge_zones : bool merge_body_labels : bool cfd_surface_mesh_controls : dict[str, Any] body_label_list : list[str] body_label_body_list : list[str] cell_zone_list : list[str] complete_region_scope : list[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

Use this task to create a mesh interface between two or more overset mesh objects. More… Parameters ———- overset_interfaces_name : str

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

Identify porous regions in your imported geometry so that you can simulate flow through porous media. More… Parameters ———- input_method : str

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_factor : float file_name : str

Specify the name and location of the text file containing the porous region definition. More…

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.

p1 : list[float] p2 : list[float] p3 : list[float] p4 : list[float] non_rectangular_parameters : dict[str, Any]

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

Confirm that Fluent has correctly estimated the number of fluid regions. Fluent will detect additional regions if they exist, however, it will detect fluid regions only where they are connected to capping surfaces. Your geometry may include a solid region only, or it may contain a fluid region within a solid region. More… Parameters ———- number_of_flow_volumes : int

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_object : str

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

Generate a mesh over the surface of the imported CAD geometry, or remesh an imported surface mesh, or use pre-existing size field or size control files. Surface meshes are used to define the computational region or volume for the CFD analysis. Specify and adjust various properties of the computational surface mesh and preview them in the graphics window until you are satisfied that the surface mesh completely and accurately captures the topology of the imported CAD geometry. No gaps or slivers should be present, and you should refine the surface mesh in key areas to ensure that you can capture important physical behavior in your CFD analysis. Choose any advanced options that you want to take effect upon updating the task. More… Parameters ———- cfd_surface_mesh_controls : dict[str, Any] separation_required : bool

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_list : list[str] remesh_label_list : list[str] surface_mesh_preferences : dict[str, Any] import_type : str append_mesh : bool cad_faceting_file_name : str directory : str pattern : str length_unit : str tesselation_method : str original_zones : list[str] execute_share_topology : bool

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_controls : dict[str, Any] cad_import_options : dict[str, Any] share_topology_preferences : dict[str, Any] preview_size_toggle : bool

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

This task will generate the volume mesh for all the fluid regions. It will generate the cell type based on the selection from the Volume Fill setting in the Update Region Settings task. Boundary layer prisms will also be generated if assigned for the fluid region. Use the Edit Volume Fill Setting option to view previous settings and edit them accordingly prior to creating the volume mesh. Parameters ———- mesh_quality : float orthogonal_quality : float

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_list : list[str] region_volume_fill_list : list[str] region_size_list : list[str] old_region_name_list : list[str] old_region_volume_fill_list : list[str] old_region_size_list : list[str] all_region_name_list : list[str] all_region_volume_fill_list : list[str] all_region_size_list : list[str] fast_ro : bool ro_ref_size : float max_cell_level : int max_cell_size : float max_boundary_cell_level : int max_boundary_cell_size : float ro_curv_switch_angle_criterion : float ro_curv_min_angle : float ro_curv_max_angle : float advanced_options : bool

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

spike_removal_angle : float dihedral_min_angle : float quality_method : str

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_ratio : float conformal_prism_split : bool

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_tasks : bool

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

Generate a computational mesh for the entire volume within your geometry. As needed, specify and adjust various global properties of the boundary layer and the volume itself to ensure a comprehensive mesh for the entire flow volume. In many cases, the default values will be sufficient. More… Parameters ———- solver : str

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_controls : dict[str, Any] region_based_preferences : bool re_merge_zones : bool

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_meshing : bool volume_mesh_preferences : dict[str, Any] prism_preferences : dict[str, Any]

Display global settings for your boundary layers. Note that these settings are not applied for Multizone boundary layers

global_thin_volume_preferences : dict[str, Any] invoke_prims_control : str offset_method_type : str

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_object : str mesh_dead_regions : bool body_label_list : list[str] body_label_body_list : list[str] prism_layers : bool quad_tet_transition : str merge_cell_zones : bool face_scope : dict[str, Any] region_tet_name_list : list[str] region_tet_max_cell_length_list : list[str] region_tet_growth_rate_list : list[str] region_hex_name_list : list[str] region_hex_max_cell_length_list : list[str] old_region_tet_max_cell_length_list : list[str] old_region_tet_growth_rate_list : list[str] old_region_hex_max_cell_length_list : list[str] cfd_surface_mesh_controls : dict[str, Any] show_solid_fluid_meshed : bool

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

Add thickness to any zero-thickness portions of your geometry (such as baffles or interior walls) where those portions of the geometry are relevant to your simulation. Not all portions of the geometry require a thickness, however, a more refined surface mesh can be generated if all important and relevant aspects of the geometry have a certain thickness. More… Parameters ———- zero_thickness_name : str

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_location : list[str] object_selection_list : list[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

Customize your workflow using journaling commands. Use a text editor to copy portions of any of your own journal files, and paste them into this task to perform additional meshing refinements. More… Parameters ———- journal_string : str

Enter one or more journal commands.

python_journal : bool prime_journal : bool

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

Improve how the boundary layer flow along the walls of the geometry is captured using specialized boundary layer elements within the volume mesh (also called prisms or inflation layers). You can use this task to assign different fluid regions to have their own boundary layer controls. For more layers (greater than 3), consider adding 1 layer and performing anisotropic adaption in the solver. More… Parameters ———- add_child : bool

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

Command define_global_sizing.

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

Define leakage threshold size to fix any potential leakages that may occur due to any missing, misaligned parts, or small imperfections from the imported geometry. These holes may be larger than any of your initial local size controls, resulting in leaks that need to be closed. Use the Preview Leakages button and associated controls repeatedly to identify holes that need to be closed. Leakages can be closed to a void region or inside an object. More… Parameters ———- add_child : bool

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

Specify the type of geometry you are importing: whether it is a solid model a fluid model, or both. The workflow changes based on your selection. Additionally, for fluid volume extraction, you need to indicate whether or not any openings need to be closed. More… Parameters ———- setup_type : str

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_internals : list[str] setup_internal_types : list[str] old_zone_list : list[str] old_zone_type_list : list[str] region_list : list[str] edge_zone_list : list[str] edge_labels : list[str] duplicates : bool fluid_regions : list[str] improve_surface_mesh_preferences : dict[str, Any]

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

Specify the type of geometry you have and the type of flow you are trying to simulate. You can determine whether the flow is an external flow around an object, or whether it is an internal flow inside an object. For external flows, you can choose to add an enclosure. For internal flows, you can choose to cover large openings to extract the flow region, or rely on automatically detecting and closing any leaks to the outer domain. In either case, you are also able to add refinement regions in and around your geometry. More… Parameters ———- flow_type : str

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_options : dict[str, Any] all_task_list : list[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

Use this task to determine if specific overset features are required for your workflow. Depending on your simulation requirements, you may or may not need to add an overset collar mesh and/or an overset component mesh to your overall workflow tasks. Parameters ———- advanced_options : bool component_grid : bool

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_mesh : bool overset_interfaces : bool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class diagnostics(service, rules, path)

Bases: PyMenu

Singleton diagnostics.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

close(service, rules, command[, path])	Command close.
compute(service, rules, command[, path])	Command compute.
diag_options(service, rules, command[, path])	Command diag_options.
draw(service, rules, command[, path])	Command draw.
first(service, rules, command[, path])	Command first.
histogram(service, rules, command[, path])	Command histogram.
ignore(service, rules, command[, path])	Command ignore.
list(service, rules, command[, path])	Command list.
mark(service, rules, command[, path])	Command mark.
next(service, rules, command[, path])	Command next.
previous(service, rules, command[, path])	Command previous.
restore(service, rules, command[, path])	Command restore.
summary(service, rules, command[, path])	Command summary.
update(service, rules, command[, path])	Command update.

__init__(service, rules, path)

__init__ method of PyMenu class.

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

Bases: PyCommand

Command close.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

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

Bases: PyCommand

Command compute.

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

Command diag_options.

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

Command draw.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

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

Bases: PyCommand

Command first.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

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

Bases: PyCommand

Command histogram.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

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

Bases: PyCommand

Command ignore.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

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

Bases: PyCommand

Command list.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

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

Bases: PyCommand

Command mark.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

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

Bases: PyCommand

Command next.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

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

Bases: PyCommand

Command previous.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

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

Bases: PyCommand

Command restore.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

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

Bases: PyCommand

Command summary.

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

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

Bases: PyCommand

Command update.

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

Fidelity of the geometry can be improved by extracting feature edges. There are three types of feature edges that can be extracted: edges based on an angle; edges based on a sharp-angle; and edges based on intersections. More… Parameters ———- extract_edges_name : str

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_location : list[str] label_selection_list : list[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_objects : list[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

Use this task to extend all or parts of your volume mesh beyond the original domain.

More…

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_type : str extend_to_periodic_pair : bool preserve_periodic_info : bool extrude_normal_based : bool

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_list : list[str] reverse_direction : bool total_height : float

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_preferences : dict[str, Any] zone_location : list[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class file(service, rules, path)

Bases: PyMenu

Singleton file.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

read_case(service, rules, command[, path])	Command read_case.
read_journal(service, rules, command[, path])	Command read_journal.
read_mesh(service, rules, command[, path])	Command read_mesh.
start_journal(service, rules, command[, path])	Command start_journal.
stop_journal(service, rules, command[, path])	Command stop_journal.
write_case(service, rules, command[, path])	Command write_case.
write_mesh(service, rules, command[, path])	Command write_mesh.

__init__(service, rules, path)

__init__ method of PyMenu class.

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

Bases: PyCommand

Command read_case.

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

Command read_journal.

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

Command read_mesh.

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

Command start_journal.

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

Command stop_journal.

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

Command write_case.

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

Command write_mesh.

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

Command generate_initial_surface_mesh.

Parameters:

generate_quadsbool

project_on_geometrybool

enable_multi_threadingbool

number_of_multi_threadsint

prism_2d_preferencesdict[str, Any]

surface_2d_preferencesdict[str, Any]

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

Command generate_map_mesh.

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

Command generate_prism_layers.

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

This task will close all the leakages to objects and void regions and then generate only the surface mesh. More… Parameters ———- surface_quality : float

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_wrap : bool leak_shield : bool auto_region_between_porous : bool auto_pairing : bool

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_tasks : bool

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

Command generate_volume_mesh.

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

Singleton global_settings.

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)	Singleton ftm_region_data.
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

Singleton ftm_region_data.

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

Singleton graphics.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

bounds(service, rules, path)	Singleton bounds.
clipping_plane(service, rules, command[, path])	Command clipping_plane.
draw_thin_volume_regions(service, rules, command)	Command draw_thin_volume_regions.
get_clipping_zone_i_ds(service, rules, command)	Command get_clipping_zone_i_ds.
get_visible_domain_bounds(service, rules, ...)	Command get_visible_domain_bounds.
mark_gaps(service, rules, command[, path])	Command mark_gaps.
regions(service, rules, path)	Singleton regions.

__init__(service, rules, path)

__init__ method of PyMenu class.

class bounds(service, rules, path)

Bases: PyMenu

Singleton bounds.

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])	Command reset_bounds.
selection(service, rules[, path])	Parameter selection of value type str.
set_bounds(service, rules, command[, path])	Command set_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

Command reset_bounds.

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

Command set_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

Command clipping_plane.

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

Command draw_thin_volume_regions.

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

Command get_clipping_zone_i_ds.

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

Command get_visible_domain_bounds.

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

Command mark_gaps.

Parameters:

gap_distancefloat

gap_distance_connectfloat

min_sizefloat

share_topology_preferencesdict[str, Any]

Returns:

None

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class regions(service, rules, path)

Bases: PyMenu

Singleton regions.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

draw_all(service, rules, command[, path])	Command draw_all.
draw_dead(service, rules, command[, path])	Command draw_dead.
draw_fluid(service, rules, command[, path])	Command draw_fluid.
draw_solid(service, rules, command[, path])	Command draw_solid.

__init__(service, rules, path)

__init__ method of PyMenu class.

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

Bases: PyCommand

Command draw_all.

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

Command draw_dead.

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

Command draw_fluid.

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

Command draw_solid.

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

Identify specific portions of your imported geometry that may exist as some form of construction surface, such as capping surface(s), or cylindrical surface(s) (for identifying moving reference frames, for example). You need to identify such objects within your geometry as being construction surfaces so that Fluent can mange those objects accordingly during the meshing process. More… Parameters ———- name : str

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_location : list[str] label_selection_list : list[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.

pivot : dict[str, Any] axis : dict[str, Any] rotation : dict[str, Any] cylinder_object : dict[str, Any] cylinder_method : str bounding_box_object : dict[str, Any]

View the extents of the bounding box.

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

Use this task to identify how the wrapped surface mesh differs from the original geometry. This task can be useful for identifying deviations in the surface mesh in, for example, geometries with sharp angles. Parameters ———- display_grid_name : str

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_location : list[str] advanced_options : bool

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

Use this task to isolate and locate any orphan cells in your mesh.

More…

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_list : list[str] region_size_list : list[str] old_region_name_list : list[str] old_region_size_list : list[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

Identify specific regions in and around your imported geometry, such as a flow region surrounding a vehicle in an external flow simulation. In this task, you are positioning specific points in the domain where certain regions of interest can be identified and classified for later use in your simulation. More… Parameters ———- add_child : bool

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_location : list[str] label_selection_list : list[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

Specify the geometry or mesh file(s) that represent the bodies of influence you wish to import into the workflow. Choose from either a CAD file or a surface or volume mesh. For CAD geometries, choose the appropriate units in which the geometry was created. Browse, or specify the file name(s) and location for the CAD geometry or mesh that you are going to import. It is recommended to select units so that the minimum size is between approximately 0.1 and 10. More… Parameters ———- type : str

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

Select CAD file(s) to import into your simulation as a body of influence. 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 surface or volume mesh file(s) to import into your simulation as a body of influence. Supported file types are: *.msh, *.msh.gz, and *.msh.h5 files).

imported_objects : list[str] length_unit : str cad_import_options : dict[str, Any]

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

Import a CAD geometry (.fmd or .stl), then determine how you want to create your meshing objects: by Part (simple, a mesh object will be created for each of the CAD part), or by Custom where you customize the import process (for complicated, multiple part assemblies, etc.). For a customized approach, you can pick and choose the portions of the CAD model that you want to add to your simulation, and adjust any meshing-related settings for individual objects, before converting them into meshing objects. You can further simplify your CAD model and combine parts and assemblies into a single object. To capture features more effectively, you can increase or decrease the faceting resolution, thereby controlling the surface mesh granularity and therefore influencing the simulation time. More… Parameters ———- file_loaded : bool fmd_file_name : str

Select a CAD file to import into your simulation. Standard Ansys file types, among others, are supported, including .scdoc, .dsco, .agdb, .fmd, .fmdb, .fmd, .pmdb, .tgf, and .msh. To quickly import multiple CAD files, you can use basic wildcard expression patterns such as the * or ? wildcards. More…

append_file_namestr

Enable this option and browse/select another CAD file to append to your original geometry. Specify additional CAD files in the Append File field, and use the Append button to load additional CAD files into the tree, after the original CAD objects. To quickly append multiple CAD files, you can use basic wildcard expression patterns such as the * or ? wildcards.

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.

refaceting : dict[str, Any] ignore_solid_names : bool

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.

options : dict[str, Any] edge_extraction : str

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.

context : int object_setting : str refacet_options : dict[str, Any]

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

Specify the CAD geometry that you want to work with. Choose from either a CAD file or a surface or volume mesh. Choose the appropriate units in which the geometry or mesh was created. Choose any advanced options (such as faceting controls) that you want to take effect upon import. Browse, or specify the file name and location for the CAD geometry that you are going to import. It is recommended to select units so that the minimum size is between approximately 0.1 and 10. More… Parameters ———- file_format : str

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_preferences : dict[str, Any] file_name : str

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_parts : float append_mesh : bool directory : str pattern : str cad_import_options : dict[str, Any]

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

Perform immediate improvements to the quality of the existing surface mesh by adjusting various parameters such as the face quality limit, as well as maximum angle and face skewness. More… Parameters ———- mesh_object : str face_quality_limit : float

Use the specified value to improve the surface mesh. Note that this control can aggressively change your surface mesh when applied.

min_size : float scope_improve_to : str improve_surface_mesh_preferences : dict[str, Any]

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

Perform immediate improvements to the quality of the existing volume mesh by adjusting various parameters such as the cell quality limit, as well as minimum angle and the ability to ignore problematic features. More… Parameters ———- quality_method : str

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_list : list[str] quality_criteria_list : list[str] old_quality_method_list : list[str] old_quality_criteria_list : list[str] improve_volume_mesh_preferences : dict[str, Any]

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

Command load_cad_geometry.

Parameters:

file_namestr

length_unitstr

routestr

use_prime_geometry_kernelbool

faceting_tolerancefloat

create_object_perstr

num_partsfloat

refacetingdict[str, Any]

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

Use this task to perform common operations on cell zones or face zones, Prior to generating the volume mesh, you can perform operations such as separating zones, splitting cylindrical regions, or extracting edges. After generating your volume mesh, you can perform operations such as renaming, changing prefixes, and merging zones. Especially useful for complex models with numerous zones. More… Parameters ———- type : str

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).

area : float volume : float equal_range : float

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_list : list[str] manage_face_zone_list : list[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_list : list[str] complete_zone_list : list[str] complete_label_list : list[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_location : list[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

Review the mesh control settings, such as the Minimum Size, the Maximum Size, and the Growth Rate, as well as a table of common settings. Parameters ———- global_min : float global_max : float target_growth_rate : float draw_size_control : bool

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_parameters : dict[str, Any]

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

Perform individual modifications to the surface mesh by creating mesh refinement objects and sequences. Assign a name, a remeshing sequence if desired, along with local sizing parameters. Create as many refinement controls as needed in order to modify the surface mesh to your needs. Choose any advanced options that you want to take effect upon updating the task. More… Parameters ———- mesh_object : str remesh_execution : str

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_type : str local_min_size : float local_max_size : float remesh_growth_rate : float remesh_curvature_normal_angle : float remesh_cells_per_gap : float cfd_surface_mesh_controls : dict[str, Any] remesh_preferences : dict[str, Any]

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

After creating a volume mesh, use this task to append, add, remove, or replace portions of your original geometry with other CAD parts. By applying localized surface mesh or volume mesh based analyses, you can use this task to quickly update the volume mesh to easily see how geometry changes impact the volume mesh. Parameters ———- add_part_management : bool

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_replacement : bool add_local_sizing : bool

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

Use this task to define particular details for the part replacement operation where you can choose to add, remove, or replace one or more portions of your original imported geometry. Parameters ———- part_replacement_name : str

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

Command prepare_for_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

Command remesh_surface.

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

Enable or disable the ability to separate any existing contacts between surfaces. Parameters ———- separate_contacts_option : bool

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

Define boundaries suited for rotational periodicity. The task will remesh a single periodic face to exactly match its reference side, as well as create the corresponding periodic and shadow boundary types for use in the Fluent solver. More… Parameters ———- mesh_object : str type : str

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]

The X, Y, and Z components of the origin point for the periodic boundary.

rotation_axis_directiondict[str, Any]

The X, Y, and Z components of the vector for the periodic boundary.

trans_shift : dict[str, Any] selection_type : str

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_list : list[str] remesh_boundaries_option : str

Enable this option to remesh boundaries when there is an asymmetric mesh on the periodic faces.

zone_location : list[str] list_all_label_toggle : bool

View more labels in the table, such as those for fluid-fluid internal boundaries, in addition to external boundaries.

auto_multiple_periodic : bool multiple_option : str

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

Create individual sizing controls for your mesh. For every size control that you create, it is added to the workflow as a subtask. More… Parameters ———- local_settings_name : str

Specify a name for the size control or use the default value.

compute_for_solid_only : str selection_type : str

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_location : list[str] edge_selection_list : list[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_parameters : dict[str, Any] value_changed : str complete_zone_selection_list : list[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

Command switch_to_solution.

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

Use this task to create and apply either a translational or a rotational transformation to the volume mesh (or to one or more copies of the volume mesh).

More…

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_list : list[str] cell_zone_list : list[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]

Specify the coordinates of the rotational origin.

rotation_axis_directiondict[str, Any]

Specify the coordinates of the rotational vector.

trans_shiftdict[str, Any]

Specify the coordinates of the translational shift.

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_boundaries : list[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

Use the table to review a summary of all of your defined boundaries, and their assigned types, and make revisions as needed. Rename a boundary by double-clicking its name in the list and providing another name. Reassign the type for a specific boundary by clicking the type designation and using the drop-down menu that appears. More… Parameters ———- mesh_object : str selection_type : str

Choose how boundaries are displayed in the table.

boundary_label_list : list[str] boundary_label_type_list : list[str] boundary_zone_list : list[str] boundary_zone_type_list : list[str] old_boundary_label_list : list[str] old_boundary_label_type_list : list[str] old_boundary_zone_list : list[str] old_boundary_zone_type_list : list[str] old_label_zone_list : list[str] list_all_boundaries_toggle : bool

View more boundaries in the table, such as fluid-fluid internal boundaries, in addition to external boundaries.

zone_location : list[str] topology_list : list[str] topology_type_list : list[str] old_topology_list : list[str] old_topology_type_list : list[str] topology_body_list : list[str] boundary_current_list : list[str] boundary_current_type_list : list[str] boundary_allowed_type_list : list[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

Review the settings assigned to the regions in your simulation. Use the table to reassign their extraction techniques, region types, volume meshing cell types, or leakage size settings. More… Parameters ———- main_fluid_region : str

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_list : list[str] region_mesh_method_list : list[str] region_type_list : list[str] region_volume_fill_list : list[str] region_leakage_size_list : list[str] region_overset_componen_list : list[str] old_region_name_list : list[str] old_region_mesh_method_list : list[str] old_region_type_list : list[str] old_region_volume_fill_list : list[str] old_region_leakage_size_list : list[str] old_region_overset_componen_list : list[str] all_region_name_list : list[str] all_region_mesh_method_list : list[str] all_region_type_list : list[str] all_region_volume_fill_list : list[str] all_region_leakage_size_list : list[str] all_region_overset_componen_list : list[str] all_region_linked_construction_surface_list : list[str] all_region_source_list : list[str] all_region_filter_categories : list[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

Use the table to review a summary of all of your defined regions, and their assigned types, and make revisions as needed. Rename a region by double-clicking its name in the list and providing another name. Reassign the type for a specific region by clicking the type designation and using the drop-down menu that appears. Dead regions are the same as a void or a pocket in the domain, and are not transferred to the Fluent solver. More… Parameters ———- mesh_object : str region_name_list : list[str] region_type_list : list[str] old_region_name_list : list[str] old_region_type_list : list[str] region_internals : list[str] region_internal_types : list[str] region_current_list : list[str] region_current_type_list : list[str] number_of_listed_regions : int

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

Use this task to remove the existing volume mesh and to update the volume mesh with your new part replacement changes. Parameters ———- enable_parallel : bool

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:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class wrap_main(service, rules, command, path=None)

Bases: PyCommand

Command wrap_main.

Parameters:

wrap_regions_namestr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class write_2d_mesh(service, rules, command, path=None)

Bases: PyCommand

Command write_2d_mesh.

Parameters:

file_namestr

skip_exportbool

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class write_skin(service, rules, command, path=None)

Bases: PyCommand

Command write_skin.

Parameters:

file_namestr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class general(service, rules, path)

Bases: PyMenu

Singleton general.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

create_composite_task(service, rules, command)	Command create_composite_task.
create_new_workflow(service, rules, command)	Command create_new_workflow.
delete_tasks(service, rules, command[, path])	Command delete_tasks.
initialize_workflow(service, rules, command)	Command initialize_workflow.
insert_new_task(service, rules, command[, path])	Command insert_new_task.
load_state(service, rules, command[, path])	Command load_state.
load_workflow(service, rules, command[, path])	Command load_workflow.
reset_workflow(service, rules, command[, path])	Command reset_workflow.
save_workflow(service, rules, command[, path])	Command save_workflow.
workflow(service, rules, path)	Singleton workflow.

__init__(service, rules, path)

__init__ method of PyMenu class.

class create_composite_task(service, rules, command, path=None)

Bases: PyCommand

Command create_composite_task.

Parameters:

list_of_taskslist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class create_new_workflow(service, rules, command, path=None)

Bases: PyCommand

Command create_new_workflow.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class delete_tasks(service, rules, command, path=None)

Bases: PyCommand

Command delete_tasks.

Parameters:

list_of_taskslist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class initialize_workflow(service, rules, command, path=None)

Bases: PyCommand

Command initialize_workflow.

Parameters:

workflow_typestr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class insert_new_task(service, rules, command, path=None)

Bases: PyCommand

Command insert_new_task.

Parameters:

command_namestr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class load_state(service, rules, command, path=None)

Bases: PyCommand

Command load_state.

Parameters:

list_of_rootslist[str]

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class load_workflow(service, rules, command, path=None)

Bases: PyCommand

Command load_workflow.

Parameters:

file_pathstr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class reset_workflow(service, rules, command, path=None)

Bases: PyCommand

Command reset_workflow.

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class save_workflow(service, rules, command, path=None)

Bases: PyCommand

Command save_workflow.

Parameters:

file_pathstr

Returns:

bool

Methods:

create_instance()

Create an operation instance.

create_instance()

Create an operation instance.

class workflow(service, rules, path)

Bases: PyMenu

Singleton workflow.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

current_task(service, rules[, path])	Parameter current_task of value type str.
inactive_task_list(service, rules[, path])	Parameter inactive_task_list of value type list[str].
task_list(service, rules[, path])	Parameter task_list of value type list[str].
workflow_type(service, rules[, path])	Parameter workflow_type of value type str.

__init__(service, rules, path)

__init__ method of PyMenu class.

class current_task(service, rules, path=None)

Bases: PyTextual

Parameter current_task of value type str.

class inactive_task_list(service, rules, path=None)

Bases: PyTextual

Parameter inactive_task_list of value type list[str].

class task_list(service, rules, path=None)

Bases: PyTextual

Parameter task_list of value type list[str].

class workflow_type(service, rules, path=None)

Bases: PyTextual

Parameter workflow_type of value type str.

class task_object(service, rules, path)

Bases: PyMenu

Task objects.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

Classes:

add_2d_boundary_layers(service, rules[, path])
add_boundary_layers(service, rules[, path])
add_boundary_layers_for_part_replacement(...)
add_boundary_type(service, rules[, path])
add_linear_mesh_pattern(service, rules[, path])
add_local_sizing_wtm(service, rules[, path])
add_multizone_controls(service, rules[, path])
add_shell_boundary_layers(service, rules[, path])
add_thin_volume_meshing_controls(service, rules)
add_virtual_topology(service, rules[, path])
apply_share_topology(service, rules[, path])
axisymmetric_sweep(service, rules[, path])
capping(service, rules[, path])
check_mesh(service, rules[, path])
check_surface_quality(service, rules[, path])
check_volume_quality(service, rules[, path])
choose_mesh_control_options(service, rules)
close_leakage(service, rules[, path])
compute_regions(service, rules[, path])
compute_size_fields(service, rules[, path])
create_collar_mesh(service, rules[, path])
create_component_mesh(service, rules[, path])
create_contact_patch(service, rules[, path])
create_external_flow_boundaries(service, rules)
create_gap_cover(service, rules[, path])
create_group(service, rules[, path])
create_leak_shield(service, rules[, path])
create_local_refinement_regions(service, rules)
create_mesh_objects(service, rules[, path])
create_multizone_mesh(service, rules[, path])
create_overset_mesh(service, rules[, path])
create_porous_regions(service, rules[, path])
create_regions(service, rules[, path])
create_surface_mesh(service, rules[, path])
create_volume_mesh_ftm(service, rules[, path])
create_volume_mesh_wtm(service, rules[, path])
create_zero_thickness_geometry(service, rules)
custom_journal_task(service, rules[, path])
define_boundary_layer_controls(service, rules)
define_global_sizing(service, rules[, path])
define_leakage_threshold(service, rules[, path])
describe_geometry(service, rules[, path])
describe_geometry_and_flow(service, rules[, ...])
describe_overset_features(service, rules[, path])
extract_edge_features(service, rules[, path])
extrude_volume_mesh(service, rules[, path])
generate_initial_surface_mesh(service, rules)
generate_map_mesh(service, rules[, path])
generate_prism_layers(service, rules[, path])
generate_surface_mesh(service, rules[, path])
generate_volume_mesh(service, rules[, path])
identify_construction_surfaces(service, rules)
identify_deviated_faces(service, rules[, path])
identify_orphans(service, rules[, path])
identify_regions(service, rules[, path])
import_boi_geometry(service, rules[, path])
import_cad_and_part_management(service, rules)
import_geometry(service, rules[, path])
improve_surface_mesh(service, rules[, path])
improve_volume_mesh(service, rules[, path])
load_cad_geometry(service, rules[, path])
manage_zones_ftm(service, rules[, path])
mesh_controls_table(service, rules[, path])
modify_mesh_refinement(service, rules[, path])
part_replacement_options(service, rules[, path])
part_replacement_settings(service, rules[, path])
prepare_for_volume_meshing(service, rules[, ...])
remesh_surface(service, rules[, path])
separate_contacts(service, rules[, path])
set_up_rotational_periodic_boundaries(...[, ...])
setup_size_controls(service, rules[, path])
switch_to_solution(service, rules[, path])
transform_volume_mesh(service, rules[, path])
update_boundaries(service, rules[, path])
update_region_settings(service, rules[, path])
update_regions(service, rules[, path])
update_volume_mesh(service, rules[, path])
wrap_main(service, rules[, path])
write_2d_mesh(service, rules[, path])
write_skin(service, rules[, path])

__init__(service, rules, path)

__init__ method of PyMenu class.

class add_2d_boundary_layers(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class add_boundary_layers(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class add_boundary_layers_for_part_replacement(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class add_boundary_type(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class add_linear_mesh_pattern(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class add_local_sizing_wtm(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class add_multizone_controls(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class add_shell_boundary_layers(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class add_thin_volume_meshing_controls(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class add_virtual_topology(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class apply_share_topology(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class axisymmetric_sweep(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class capping(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class check_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class check_surface_quality(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class check_volume_quality(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class choose_mesh_control_options(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class close_leakage(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class compute_regions(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class compute_size_fields(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_collar_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_component_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_contact_patch(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_external_flow_boundaries(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_gap_cover(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_group(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_leak_shield(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_local_refinement_regions(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_mesh_objects(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_multizone_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_overset_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_porous_regions(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_regions(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_surface_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_volume_mesh_ftm(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_volume_mesh_wtm(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class create_zero_thickness_geometry(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class custom_journal_task(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class define_boundary_layer_controls(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class define_global_sizing(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class define_leakage_threshold(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class describe_geometry(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class describe_geometry_and_flow(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class describe_overset_features(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class extract_edge_features(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class extrude_volume_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class generate_initial_surface_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class generate_map_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class generate_prism_layers(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class generate_surface_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class generate_volume_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class identify_construction_surfaces(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class identify_deviated_faces(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class identify_orphans(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class identify_regions(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class import_boi_geometry(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class import_cad_and_part_management(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class import_geometry(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class improve_surface_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class improve_volume_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class load_cad_geometry(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class manage_zones_ftm(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class mesh_controls_table(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class modify_mesh_refinement(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class part_replacement_options(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class part_replacement_settings(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class prepare_for_volume_meshing(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class remesh_surface(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class separate_contacts(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class set_up_rotational_periodic_boundaries(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class setup_size_controls(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class switch_to_solution(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class transform_volume_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class update_boundaries(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class update_region_settings(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class update_regions(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class update_volume_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class wrap_main(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class write_2d_mesh(service, rules, path=None)

Bases: PyNamedObjectContainer

.

class write_skin(service, rules, path=None)

Bases: PyNamedObjectContainer

.