overset_interfaces#

class ansys.fluent.core.solver.tui_231.main_menu.define.overset_interfaces(path, service)#

Bases: TUIMenu

Enters the overset interfaces menu.

Classes:

adapt(path, service)

Enters the overset adaption menu.

cut_control(path, service)

Enters the overset hole cut control menu.

options(path, service)

Enters the overset interface options menu.

Methods:

check(*args, **kwargs)

Checks the integrity of the overset interfaces.

clear(*args, **kwargs)

Clears the domain connectivity of an overset interface.

clear_all(*args, **kwargs)

Clears the domain connectivity of all overset interfaces.

create(*args, **kwargs)

Creates an overset interface.

debug_hole_cut(*args, **kwargs)

Debugging tool to troubleshoot hole cutting of overset interfaces.

delete(*args, **kwargs)

Deletes an overset interface.

delete_all(*args, **kwargs)

Deletes all overset interfaces in the domain.

display_cells(*args, **kwargs)

Displays the overset cells marked using the text command define/overset-interfaces/mark-cells.

fill_dci(*args, **kwargs)

Fill overset domain connectivity information (DCI).

find_all_bounding_cells(*args, **kwargs)

Find bounding cells for all cell centroids.

find_bounding_cell(*args, **kwargs)

Find bounding cell for given cell or search point.

free_dci(*args, **kwargs)

Free overset domain connectivity information (DCI).

grid_priorities(*args, **kwargs)

Allows you to specify grid priorities on background and component meshes, used in the overlap minimization of an overset interface.

intersect(*args, **kwargs)

Executes the hole cutting of an overset interface and establishes the domain connectivity.

intersect_all(*args, **kwargs)

Executes hole cutting for all overset interfaces in the domain.

list(*args, **kwargs)

Lists information about the overset interfaces.

mark_cell_change(*args, **kwargs)

Marks cells that have undergone a specified overset cell type change (from solve,receptor, or dead to any other type) in the last time step.

mark_cells(*args, **kwargs)

Marks the specified overset cells (solve, receptor, donor, orphan, or dead) and fills registers based on the markings.

read_dci_from_case(*args, **kwargs)

Read domain connectivity information (DCI) from case file.

set_mark_bounds(*args, **kwargs)

Allows you to set bounds so that any marking of cells is performed within a spherical region based on a specified origin and radius.

update_from_dci(*args, **kwargs)

Update all overset intrfaces from stored domain connectivity information (DCI).

write_cell_types(*args, **kwargs)

Write overset cell types into file.

write_dci(*args, **kwargs)

Save domain connectivity information (DCI) to a text file.

write_dci_to_case(*args, **kwargs)

Save domain connectivity information (DCI) to case file.
class adapt(path, service)#

Bases: TUIMenu

Enters the overset adaption menu.

Methods:

adapt_mesh(*args, **kwargs)

Marks and adapts the mesh to improve your overset mesh.

mark_adaption(*args, **kwargs)

Marks cells to identify those that can be adapted in order to improve your overset mesh.

Classes:

set(path, service)

Enters the overset adaption set menu.
adapt_mesh(*args, **kwargs)#

Marks and adapts the mesh to improve your overset mesh.

mark_adaption(*args, **kwargs)#

Marks cells to identify those that can be adapted in order to improve your overset mesh.

class set(path, service)#

Bases: TUIMenu

Enters the overset adaption set menu.

Methods:

adaption_sweeps(*args, **kwargs)

Sets the number of rounds of adaption applied during each adaption cycle.

anisotropic(*args, **kwargs)

Enable the option to use anisotropic adaption in prismatic cells.

automatic(*args, **kwargs)

Enable the option to automatically adapt overset meshes during solution update.

buffer_layers(*args, **kwargs)

Sets the number of cell layers marked in addition to the cells marked for orphan adaption.

gap_resolution(*args, **kwargs)

Set the target (minimum) gap resolution used when marking cells for gap adaption.

length_ratio_max(*args, **kwargs)

Sets the length scale ratio threshold used to determine which cells are marked for adaption based on donor-receptor cell size differences.

mark_coarsening(*args, **kwargs)

Enables/disables the option to coarsen the mesh if mesh refinement is no longer needed.

mark_fixed_orphans(*args, **kwargs)

Enables/disables the option to also adapt based on cells that are not actual orphans because they were fixed by accepting neighbor donors.

mark_gaps(*args, **kwargs)

Enable the option to adapt underresolved gaps.

mark_orphans(*args, **kwargs)

Enables/disables the option to adapt for orphan reduction.

mark_size(*args, **kwargs)

Enables/disables the option to adapt based on donor-receptor cell size differences.

maximum_refinement_level(*args, **kwargs)

Sets the maximum level of refinement during overset adaption, in conjunction with the value set using the mesh/adapt/set/maximum-refinement-level text command (the larger of the two values is used).
adaption_sweeps(*args, **kwargs)#

Sets the number of rounds of adaption applied during each adaption cycle.

anisotropic(*args, **kwargs)#

Enable the option to use anisotropic adaption in prismatic cells.

automatic(*args, **kwargs)#

Enable the option to automatically adapt overset meshes during solution update.

buffer_layers(*args, **kwargs)#

Sets the number of cell layers marked in addition to the cells marked for orphan adaption.

gap_resolution(*args, **kwargs)#

Set the target (minimum) gap resolution used when marking cells for gap adaption.

length_ratio_max(*args, **kwargs)#

Sets the length scale ratio threshold used to determine which cells are marked for adaption based on donor-receptor cell size differences.

mark_coarsening(*args, **kwargs)#

Enables/disables the option to coarsen the mesh if mesh refinement is no longer needed. This option is enabled by default.

mark_fixed_orphans(*args, **kwargs)#

Enables/disables the option to also adapt based on cells that are not actual orphans because they were fixed by accepting neighbor donors. This option is only applied if define/overset-interfaces/adapt/set/mark-orphans? is enabled.

mark_gaps(*args, **kwargs)#

Enable the option to adapt underresolved gaps.

mark_orphans(*args, **kwargs)#

Enables/disables the option to adapt for orphan reduction.

mark_size(*args, **kwargs)#

Enables/disables the option to adapt based on donor-receptor cell size differences.

maximum_refinement_level(*args, **kwargs)#

Sets the maximum level of refinement during overset adaption, in conjunction with the value set using the mesh/adapt/set/maximum-refinement-level text command (the larger of the two values is used).

check(*args, **kwargs)#

Checks the integrity of the overset interfaces. Reports orphan cells and errors in the domain connectivity.

clear(*args, **kwargs)#

Clears the domain connectivity of an overset interface. This text command is only available when define/overset-interfaces/options/expert? is set to yes.

clear_all(*args, **kwargs)#

Clears the domain connectivity of all overset interfaces. This text command is only available when define/overset-interfaces/options/expert? is set to yes.

create(*args, **kwargs)#

Creates an overset interface.

class cut_control(path, service)#

Bases: TUIMenu

Enters the overset hole cut control menu.

Methods:

add(*args, **kwargs)

Adds a hole cut control, so that a boundary zone does not cut specified cell zones.

delete(*args, **kwargs)

Deletes the hole cut control for a boundary zone.

delete_all(*args, **kwargs)

Deletes the hole cut controls for all boundary zones.

list(*args, **kwargs)

Lists the defined hole cut controls.

Classes:

cut_seeds(path, service)

Enters the overset hole cut seeds menu.
add(*args, **kwargs)#

Adds a hole cut control, so that a boundary zone does not cut specified cell zones.

class cut_seeds(path, service)#

Bases: TUIMenu

Enters the overset hole cut seeds menu.

Methods:

add(*args, **kwargs)

Add a hole cut seed.

cut_seeds_for_all_component_zones(*args, ...)

Specifies whether all component zones get cut seeds, which cut pilot holes into the overlapping meshes that will then be enlarged during overlap minimization.

delete(*args, **kwargs)

Delete a hole cut seed.

delete_all(*args, **kwargs)

Delete all hole cut seeds.

list(*args, **kwargs)

List the defined hole cut seeds.
add(*args, **kwargs)#

Add a hole cut seed.

cut_seeds_for_all_component_zones(*args, **kwargs)#

Specifies whether all component zones get cut seeds, which cut pilot holes into the overlapping meshes that will then be enlarged during overlap minimization.

delete(*args, **kwargs)#

Delete a hole cut seed.

delete_all(*args, **kwargs)#

Delete all hole cut seeds.

list(*args, **kwargs)#

List the defined hole cut seeds.

delete(*args, **kwargs)#

Deletes the hole cut control for a boundary zone.

delete_all(*args, **kwargs)#

Deletes the hole cut controls for all boundary zones.

list(*args, **kwargs)#

Lists the defined hole cut controls.

debug_hole_cut(*args, **kwargs)#

Debugging tool to troubleshoot hole cutting of overset interfaces. This text command is only available when define/overset-interfaces/options/expert? is set to yes.

delete(*args, **kwargs)#

Deletes an overset interface.

delete_all(*args, **kwargs)#

Deletes all overset interfaces in the domain.

display_cells(*args, **kwargs)#

Displays the overset cells marked using the text command define/overset-interfaces/mark-cells.

fill_dci(*args, **kwargs)#

Fill overset domain connectivity information (DCI).

find_all_bounding_cells(*args, **kwargs)#

Find bounding cells for all cell centroids.

find_bounding_cell(*args, **kwargs)#

Find bounding cell for given cell or search point.

free_dci(*args, **kwargs)#

Free overset domain connectivity information (DCI).

grid_priorities(*args, **kwargs)#

Allows you to specify grid priorities on background and component meshes, used in the overlap minimization of an overset interface.

intersect(*args, **kwargs)#

Executes the hole cutting of an overset interface and establishes the domain connectivity. This text command is only available when define/overset-interfaces/options/expert? is set to yes.

intersect_all(*args, **kwargs)#

Executes hole cutting for all overset interfaces in the domain. This text command is only available when define/overset-interfaces/options/expert? is set to yes.

list(*args, **kwargs)#

Lists information about the overset interfaces. The output depends on the overset verbosity setting.

mark_cell_change(*args, **kwargs)#

Marks cells that have undergone a specified overset cell type change (from solve,receptor, or dead to any other type) in the last time step. Adaption registers are automatically filled based on these markings. This text command is only available for unsteady simulations and if define/overset-interfaces/options/expert? is set to yes.

mark_cells(*args, **kwargs)#

Marks the specified overset cells (solve, receptor, donor, orphan, or dead) and fills registers based on the markings. Display the marked cells via the text command define/overset-interfaces/display-cells.

class options(path, service)#

Bases: TUIMenu

Enters the overset interface options menu.

Methods:

auto_create(*args, **kwargs)

Enables the automatic creation of a default overset interface during initialization or mesh motion update.

dead_cell_update(*args, **kwargs)

Enables/disables the updating of dead cells during the solution process, which may be helpful for some moving and dynamic mesh simulations (though at the cost of solver performance).

donor_priority_method(*args, **kwargs)

Allows you to specify whether the cell donor priority used in the overlap minimization of an overset interface is inversely proportional to either the cell size or the distance to the nearest boundary.

expert(*args, **kwargs)

Enables / disables overset-related expert tools.

mesh_interfaces(*args, **kwargs)

Allows the inclusion of non-conformal mesh interfaces inside overset cell zones, as long as the mesh interfaces do not spatially overlap with the cells where the overset interfaces lie.

minimize_overlap(*args, **kwargs)

Allows you to disable overlap minimization during hole cutting.

modified_donor_search(*args, **kwargs)

Enables / disables modified donor search parameters.

modified_hole_cutting(*args, **kwargs)

Enables / disables modified hole cutting parameters.

node_connected_donors(*args, **kwargs)

Allows you to switch between face or node connected donor cells.

overlap_boundaries(*args, **kwargs)

Allows you to disable the detection of overlapping boundaries during hole cutting, in order to reduce the computational expense for cases that do not include such boundaries.

parallel(*args, **kwargs)

Allows you to select the algorithm used for overset parallel processing.

partial_cut_faces(*args, **kwargs)

Enables/disables enhanced hole cutting, where partially overlapping cut faces are decomposed into overlapping and non-overlapping fractions, and only the non-overlapping fractions participate in the hole cutting.

render_receptor_cells(*args, **kwargs)

Allows you to enable visualization of receptor cells in contour and mesh displays.

solve_island_removal(*args, **kwargs)

Sets the method used to control the removal of isolated patches of solve cells.

transient_caching(*args, **kwargs)

Sets the options to control caching of entities in transient overset simulations.

update_before_case_write(*args, **kwargs)

Enables/disables the updating of the overset interfaces before writing a case file in the Common Fluids Format (CFF).

verbosity(*args, **kwargs)

Specifies the level of detail printed in the console about overset interfaces.
auto_create(*args, **kwargs)#

Enables the automatic creation of a default overset interface during initialization or mesh motion update.

dead_cell_update(*args, **kwargs)#

Enables/disables the updating of dead cells during the solution process, which may be helpful for some moving and dynamic mesh simulations (though at the cost of solver performance). You can enter the number of layers of dead cells adjacent to the receptor cells that you want updated, or enter -1 to request that all dead cells are updated. This text command is only available for transient simulations when define/overset-interfaces/options/expert? is set to yes.

donor_priority_method(*args, **kwargs)#

Allows you to specify whether the cell donor priority used in the overlap minimization of an overset interface is inversely proportional to either the cell size or the distance to the nearest boundary.

expert(*args, **kwargs)#

Enables / disables overset-related expert tools.

mesh_interfaces(*args, **kwargs)#

Allows the inclusion of non-conformal mesh interfaces inside overset cell zones, as long as the mesh interfaces do not spatially overlap with the cells where the overset interfaces lie.

minimize_overlap(*args, **kwargs)#

Allows you to disable overlap minimization during hole cutting.

Enables / disables modified donor search parameters. When enabled, these parameters result in a more extended donor search, which can be helpful for meshes with orphans. This text command is only available when define/overset-interfaces/options/expert? is set to yes.

modified_hole_cutting(*args, **kwargs)#

Enables / disables modified hole cutting parameters. When enabled, the parameters used can help avoid dead cell zones that result from a hole cutting failure. This text command is only available when define/overset-interfaces/options/expert? is set to yes.

node_connected_donors(*args, **kwargs)#

Allows you to switch between face or node connected donor cells. This text command is only available when define/overset-interfaces/options/expert? is set to yes.

overlap_boundaries(*args, **kwargs)#

Allows you to disable the detection of overlapping boundaries during hole cutting, in order to reduce the computational expense for cases that do not include such boundaries. When enabled, this text command also allows you to specify which boundary zones should be considered when detecting overlapping boundaries; this can be helpful when the default hole cutting process fails.

parallel(*args, **kwargs)#

Allows you to select the algorithm used for overset parallel processing. You can select from the default cell exchange model or the local cell zone replication model; the cell exchange model should require less memory and may result in faster calculations.

partial_cut_faces(*args, **kwargs)#

Enables/disables enhanced hole cutting, where partially overlapping cut faces are decomposed into overlapping and non-overlapping fractions, and only the non-overlapping fractions participate in the hole cutting. This can help avoid the situation where a region or cell zone is erroneously identified as dead because of leakage during flood filling, even though it has overlapping boundaries that match well. When this text command is disabled, the partially overlapping faces are entirely protected from cutting.

render_receptor_cells(*args, **kwargs)#

Allows you to enable visualization of receptor cells in contour and mesh displays.

solve_island_removal(*args, **kwargs)#

Sets the method used to control the removal of isolated patches of solve cells. This text command is only available when define/overset-interfaces/options/expert? is set to yes.

transient_caching(*args, **kwargs)#

Sets the options to control caching of entities in transient overset simulations. This text command is only available when define/overset-interfaces/options/expert? is set to yes.

update_before_case_write(*args, **kwargs)#

Enables/disables the updating of the overset interfaces before writing a case file in the Common Fluids Format (CFF). This text command is only available when define/overset-interfaces/options/expert? is set to yes.

verbosity(*args, **kwargs)#

Specifies the level of detail printed in the console about overset interfaces.

read_dci_from_case(*args, **kwargs)#

Read domain connectivity information (DCI) from case file.

set_mark_bounds(*args, **kwargs)#

Allows you to set bounds so that any marking of cells is performed within a spherical region based on a specified origin and radius. This can be useful when diagnosing a local problem on a large mesh. This text command is only available if define/overset-interfaces/options/expert? is set to yes. After defining the bounds, you can then mark the cells using the define/overset-interfaces/mark-cell-change or define/overset-interfaces/mark-cells text command. To disable the bounds, enter a radius of 0.

update_from_dci(*args, **kwargs)#

Update all overset intrfaces from stored domain connectivity information (DCI).

write_cell_types(*args, **kwargs)#

Write overset cell types into file.

write_dci(*args, **kwargs)#

Save domain connectivity information (DCI) to a text file.

write_dci_to_case(*args, **kwargs)#

Save domain connectivity information (DCI) to case file.