define

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

Bases: TUIMenu

Enter the define menu.

Methods:

beta_feature_access(*args, **kwargs)	Enable access to beta features in the interface.
enable_mesh_morpher_optimizer(*args, **kwargs)	Enables the mesh morpher/optimizer.
injections(*args, **kwargs)	Enters the injections menu.
physics(*args, **kwargs)	Manage Physics-regions.
set_unit_system(*args, **kwargs)	Applies a standard set of units to all quantities.
units(*args, **kwargs)	Sets unit conversion factors.

Classes:

boundary_conditions(path, service)	Enters the boundary conditions menu.
curvilinear_coordinate_system(path, service)	Curvilinear Coordinate System.
custom_field_functions(path, service)	Enters the custom field functions menu.
dynamic_mesh(path, service)	Enters the dynamic mesh menu.
gap_model(path, service)	Enters the gap model menu, where you can define one or more gap regions where the flow is blocked or decelerated when face zones move within a specified proximity threshold of each other.
materials(path, service)	Enters the materials menu.
mesh_interfaces(path, service)	Enters the mesh-interfaces menu.
mixing_planes(path, service)	Enters the mixing planes menu.
models(path, service)	Enters the models menu to configure the solver.
named_expressions(path, service)	Enters the named expressions menu.
operating_conditions(path, service)	Enters the define operating conditions menu.
overset_interfaces(path, service)	Enters the overset interfaces menu.
parameters(path, service)	Enters the parameters menu.
periodic_conditions(path, service)	Enters the periodic conditions menu.
phases(path, service)	Enters the phases menu.
profiles(path, service)	Enters the boundary profiles menu.
reference_frames(path, service)	Enters the reference frames menu.
solution_strategy(path, service)	Enters the automatic initialization and case modification strategy menu.
spectral(path, service)	Enter the Spectral menu.
turbo_model(path, service)	Enters the turbo menu.
user_defined(path, service)	Enters the user-defined functions and scalars menu.
virtual_boundary(path, service)	Manage Virtual Boundaries.

beta_feature_access(*args, **kwargs)

Enable access to beta features in the interface.

class boundary_conditions(path, service)

Bases: TUIMenu

Enters the boundary conditions menu.

Classes:

advanced(path, service)	Control settings while doing BC setup.
bc_settings(path, service)	Enters the boundary conditions settings menu.
impedance_data_fitting(path, service)	Enters the impedance data fitting menu, which provides text commands that can be helpful when you are using the impedance boundary condition (IBC).
modify_zones(path, service)	Enters the modify zones menu.
non_reflecting_bc(path, service)	Enters the non-reflecting boundary condition menu.
perforated_walls(path, service)	Enters the perforated walls menu.
rename_zone(path, service)	Enter the menu for renaming cell and face zones based on adjacency, adding suffixes or prefixes to names, and renaming zones based on the Fluent naming conventions.
set(path, service)	Allows you to define one or more settings at single or multiple boundaries/cell zones of a given type at once.

Methods:

axis(*args, **kwargs)	Sets boundary conditions for a zone of this type.
copy_bc(*args, **kwargs)	Copies boundary conditions to other zones.
degassing(*args, **kwargs)	Sets boundary conditions for a zone of this type.
exhaust_fan(*args, **kwargs)	Sets boundary conditions for a zone of this type.
fan(*args, **kwargs)	Sets boundary conditions for a zone of this type.
fluid(*args, **kwargs)	Sets boundary conditions for a zone of this type.
geometry(*args, **kwargs)	Set boundary conditions for a zone of this type.
inlet_vent(*args, **kwargs)	Sets boundary conditions for a zone of this type.
intake_fan(*args, **kwargs)	Sets boundary conditions for a zone of this type.
interface(*args, **kwargs)	Sets boundary conditions for a zone of this type.
interior(*args, **kwargs)	Sets boundary conditions for a zone of this type.
knudsen_number_calculator(*args, **kwargs)	Computes the Knudsen number based on a characteristic physical length and the area-averaged flow quantities along an incoming-flow boundary.
list_zones(*args, **kwargs)	Prints out the types and IDs of all zones in the console window.
mass_flow_inlet(*args, **kwargs)	Sets boundary conditions for a zone of this type.
mass_flow_outlet(*args, **kwargs)	Sets boundary conditions for a zone of this type.
network(*args, **kwargs)	Set boundary conditions for a zone of this type.
network_end(*args, **kwargs)	Set boundary conditions for a zone of this type.
non_overlapping_zone_name(*args, **kwargs)	Displays the name of the non-overlapping zone associated with a specified interface zone.
open_channel_wave_settings(*args, **kwargs)	Opens channel wave input analysis.
openchannel_threads(*args, **kwargs)	Lists open channel group IDs, names, types and variables.
outflow(*args, **kwargs)	Sets boundary conditions for a zone of this type.
outlet_vent(*args, **kwargs)	Sets boundary conditions for a zone of this type.
overset(*args, **kwargs)	Set boundary conditions for a zone of this type.
periodic(*args, **kwargs)	Sets boundary conditions for a zone of this type.
porous_jump(*args, **kwargs)	Sets boundary conditions for a zone of this type.
pressure_far_field(*args, **kwargs)	Sets boundary conditions for a zone of this type.
pressure_inlet(*args, **kwargs)	Sets boundary conditions for a zone of this type.
pressure_outlet(*args, **kwargs)	Sets boundary conditions for a zone of this type.
radiator(*args, **kwargs)	Sets boundary conditions for a zone of this type.
rans_les_interface(*args, **kwargs)	Sets boundary conditions for a zone of this type.
recirculation_inlet(*args, **kwargs)	Sets boundary conditions for a zone of this type.
recirculation_outlet(*args, **kwargs)	Sets boundary conditions for a zone of this type.
shadow(*args, **kwargs)	Sets boundary conditions for a zone of this type.
solid(*args, **kwargs)	Sets boundary conditions for a zone of this type.
symmetry(*args, **kwargs)	Sets boundary conditions for a zone of this type.
target_mass_flow_rate_settings(*args, **kwargs)	Enters the targeted mass flow rate settings menu.
velocity_inlet(*args, **kwargs)	Sets boundary conditions for a zone of this type.
wall(*args, **kwargs)	Sets boundary conditions for a zone of this type.
zone_name(*args, **kwargs)	Gives a zone a new name.
zone_type(*args, **kwargs)	Sets the type for a zone or multiple zones of the same category.

class advanced(path, service)

Bases: TUIMenu

Control settings while doing BC setup.

Methods:

batch_thread_update(*args, **kwargs)	Set batch thread update option.
delay_model_change_update(*args, **kwargs)	Set model change call update.

batch_thread_update(*args, **kwargs)

Set batch thread update option.

delay_model_change_update(*args, **kwargs)

Set model change call update.

axis(*args, **kwargs)

Sets boundary conditions for a zone of this type.

class bc_settings(path, service)

Bases: TUIMenu

Enters the boundary conditions settings menu.

Methods:

mass_flow(*args, **kwargs)	Selects method for setting the mass flow rate.
pressure_outlet(*args, **kwargs)	Sets advanced options for pressure outlet boundaries.

Classes:

pressure_far_field(path, service)

Sets advanced options for pressure far field boundaries.

mass_flow(*args, **kwargs)

Selects method for setting the mass flow rate.

class pressure_far_field(path, service)

Bases: TUIMenu

Sets advanced options for pressure far field boundaries.

Methods:

riemann_invariants_tangency_correction(...)	Enables/disables the Riemann-invariant tangency correction as described in .
type(*args, **kwargs)	Choose pressure-far-field boundary-condition type.

riemann_invariants_tangency_correction(*args, **kwargs)

Enables/disables the Riemann-invariant tangency correction as described in .

type(*args, **kwargs)

Choose pressure-far-field boundary-condition type.

pressure_outlet(*args, **kwargs)

Sets advanced options for pressure outlet boundaries.

copy_bc(*args, **kwargs)

Copies boundary conditions to other zones.

degassing(*args, **kwargs)

Sets boundary conditions for a zone of this type.

exhaust_fan(*args, **kwargs)

Sets boundary conditions for a zone of this type.

fan(*args, **kwargs)

Sets boundary conditions for a zone of this type.

fluid(*args, **kwargs)

Sets boundary conditions for a zone of this type.

geometry(*args, **kwargs)

Set boundary conditions for a zone of this type.

class impedance_data_fitting(path, service)

Bases: TUIMenu

Enters the impedance data fitting menu, which provides text commands that can be helpful when you are using the impedance boundary condition (IBC).

Methods:

absorption_data(*args, **kwargs)	Reads an input file with experimental absorption coefficient data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain.
convergence_tolerance(*args, **kwargs)	Sets the convergence tolerance, which is an accuracy that is used for completing the iterative fitting procedure in the calculations performed from the define/boundary-conditions/impedance-data-fitting/ text command menu.
impedance_data(*args, **kwargs)	Reads an input file with experimental specific impedance data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain.
import_parameters(*args, **kwargs)	Reads a pole / residue file with impedance parameters in the time domain and applies them to a specified boundary condition.
iterations(*args, **kwargs)	Sets the number of internal iterations used for the calculations performed from the define/boundary-conditions/impedance-data-fitting/ text command menu.
reflection_data(*args, **kwargs)	Reads an input file with experimental reflection coefficient data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain.
residue_tolerance(*args, **kwargs)	Sets the residue tolerance, which is the minimum value of residues that are kept in the fitting performed from the define/boundary-conditions/impedance-data-fitting/ text command menu.
verbosity(*args, **kwargs)	Sets the verbosity of the progress messages during the fitting performed from the define/boundary-conditions/impedance-data-fitting/ text command menu.

absorption_data(*args, **kwargs)

Reads an input file with experimental absorption coefficient data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain. The resulting terms are printed in the console, and can be written to a pole / residue file (which can be imported and the impedance parameters applied to a boundary condition using the define/boundary-conditions/impedance-data-fitting/import-parameters text command). You can also write a file with fitted frequency / impedance data, which can be compared to the input data to evaluate how well it fits.

convergence_tolerance(*args, **kwargs)

Sets the convergence tolerance, which is an accuracy that is used for completing the iterative fitting procedure in the calculations performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. By default, the tolerance is set to 1e-6.

impedance_data(*args, **kwargs)

Reads an input file with experimental specific impedance data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain. The resulting terms are printed in the console, and can be written to a pole / residue file (which can be imported and the impedance parameters applied to a boundary condition using the define/boundary-conditions/impedance-data-fitting/import-parameters text command). You can also write a file with fitted frequency / impedance data, which can be compared to the input data to evaluate how well it fits.

import_parameters(*args, **kwargs)

Reads a pole / residue file with impedance parameters in the time domain and applies them to a specified boundary condition.

iterations(*args, **kwargs)

Sets the number of internal iterations used for the calculations performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. By default, the number of iterations is set to 20.

reflection_data(*args, **kwargs)

Reads an input file with experimental reflection coefficient data in the frequency domain and then computes the terms needed for an approximation of the reflection coefficient as a series of poles / residues in the time domain. The resulting terms are printed in the console, and can be written to a pole / residue file (which can be imported and the impedance parameters applied to a boundary condition using the define/boundary-conditions/impedance-data-fitting/import-parameters text command). You can also write a file with fitted frequency / impedance data, which can be compared to the input data to evaluate how well it fits.

residue_tolerance(*args, **kwargs)

Sets the residue tolerance, which is the minimum value of residues that are kept in the fitting performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. This residue check helps to eliminate parasitic poles. By default, the tolerance is set to 1e-6.

verbosity(*args, **kwargs)

Sets the verbosity of the progress messages during the fitting performed from the define/boundary-conditions/impedance-data-fitting/ text command menu. Setting this to 1 results in messages being printed in the console as the fitting calculation progresses. The default value of 0 suppresses this output.

inlet_vent(*args, **kwargs)

Sets boundary conditions for a zone of this type.

intake_fan(*args, **kwargs)

Sets boundary conditions for a zone of this type.

interface(*args, **kwargs)

Sets boundary conditions for a zone of this type.

interior(*args, **kwargs)

Sets boundary conditions for a zone of this type.

knudsen_number_calculator(*args, **kwargs)

Computes the Knudsen number based on a characteristic physical length and the area-averaged flow quantities along an incoming-flow boundary. You can use this information to determine flow regime for selecting the appropriate wall boundary treatment. For details, see .

list_zones(*args, **kwargs)

Prints out the types and IDs of all zones in the console window. You can use your mouse to check a zone ID, following the instructions listed under Zone in the Boundary Conditions Task Page section of the User’s Guide.

mass_flow_inlet(*args, **kwargs)

Sets boundary conditions for a zone of this type.

mass_flow_outlet(*args, **kwargs)

Sets boundary conditions for a zone of this type.

class modify_zones(path, service)

Bases: TUIMenu

Enters the modify zones menu.

Methods:

activate_cell_zone(*args, **kwargs)	Activates cell thread.
append_mesh(*args, **kwargs)	Appends new mesh.
append_mesh_data(*args, **kwargs)	Appends new mesh with data.
change_zone_phase(*args, **kwargs)	Change the realgas phase for a zone.
change_zone_state(*args, **kwargs)	Sets the state (liquid or vapor) for a specific fluid zone.
convert_all_solid_mrf_to_solid_motion(*args, ...)	Converts all solid zones using frame motion to instead use solid motion, copying the motion variable values for origin, axis, and velocities.
copy_mesh_to_mrf_motion(*args, **kwargs)	Copies motion variable values for origin, axis, and velocities from Mesh Motion to Frame Motion.
copy_move_cell_zone(*args, **kwargs)	Creates a copy of a cell zone that is offset from the original either by a translational distance or a rotational angle.
copy_mrf_to_mesh_motion(*args, **kwargs)	Copies motion variable values for origin, axis, and velocities from Frame Motion to Mesh Motion.
create_all_shell_threads(*args, **kwargs)	Marks all finite thickness walls for shell creation.
create_periodic_interface(*args, **kwargs)	Creates a conformal or non-conformal periodic interface.
deactivate_cell_zone(*args, **kwargs)	Deactivates cell thread.
delete_all_shells(*args, **kwargs)	Deletes all shell zones and switches off shell conduction on all the walls.
delete_cell_zone(*args, **kwargs)	Deletes a cell thread.
extrude_face_zone_delta(*args, **kwargs)	Extrudes a face thread a specified distance based on a list of deltas.
extrude_face_zone_para(*args, **kwargs)	Extrudes a face thread a specified distance based on a distance and a list of parametric locations between 0 and 1, for example, 0 0.2 0.4 0.8 1.0.
fuse_face_zones(*args, **kwargs)	Attempts to fuse zones by removing duplicate faces and nodes.
list_zones(*args, **kwargs)	Lists zone IDs, types, kinds, and names.
make_periodic(*args, **kwargs)	Attempts to establish periodic/shadow face zone connectivity.
matching_tolerance(*args, **kwargs)	Sets normalized tolerance used for finding coincident nodes.
merge_zones(*args, **kwargs)	Merges zones of same type and condition into one.
mrf_to_sliding_mesh(*args, **kwargs)	Changes the motion specification from MRF to moving mesh.
orient_face_zone(*args, **kwargs)	Orients the face zone.
recreate_all_shells(*args, **kwargs)	Recreates shells on all the walls that were deleted using the command delete-all-shells.
replace_zone(*args, **kwargs)	Replaces cell zone.
rotate_zone(*args, **kwargs)	Rotates individual cell zones.
scale_zone(*args, **kwargs)	Scales individual cell zones.
sep_cell_zone_mark(*args, **kwargs)	Separates cell zone based on cell marking.
sep_cell_zone_region(*args, **kwargs)	Separates cell zone based on contiguous regions.
sep_face_zone_angle(*args, **kwargs)	Separates face zone based on significant angle.
sep_face_zone_face(*args, **kwargs)	Separates each face in zone into unique zone.
sep_face_zone_mark(*args, **kwargs)	Separates face zone based on cell marking.
sep_face_zone_region(*args, **kwargs)	Separates face zone based on contiguous regions.
slit_face_zone(*args, **kwargs)	Slits two-sided wall into two connected wall zones.
slit_interior_between_diff_solids(*args, ...)	Slits the interior zone between solid zones of differing materials to create a coupled wall.
slit_periodic(*args, **kwargs)	Slits periodic zone into two symmetry zones.
translate_zone(*args, **kwargs)	Translates individual cell zones.
zone_name(*args, **kwargs)	Gives a zone a new name.
zone_type(*args, **kwargs)	Sets the type for a zone or multiple zones of the same category.

activate_cell_zone(*args, **kwargs)

Activates cell thread.

append_mesh(*args, **kwargs)

Appends new mesh.

append_mesh_data(*args, **kwargs)

Appends new mesh with data.

change_zone_phase(*args, **kwargs)

Change the realgas phase for a zone.

change_zone_state(*args, **kwargs)

Sets the state (liquid or vapor) for a specific fluid zone.

convert_all_solid_mrf_to_solid_motion(*args, **kwargs)

Converts all solid zones using frame motion to instead use solid motion, copying the motion variable values for origin, axis, and velocities.

copy_mesh_to_mrf_motion(*args, **kwargs)

Copies motion variable values for origin, axis, and velocities from Mesh Motion to Frame Motion.

copy_move_cell_zone(*args, **kwargs)

Creates a copy of a cell zone that is offset from the original either by a translational distance or a rotational angle. In the copied zone, the bounding face zones are all converted to walls, any existing cell data is initialized to a constant value, and non-conformal interfaces and dynamic zones are not copied; otherwise, the model settings are the same as in the original zone. Note that if you want the copied zone to be connected to existing zones, you must either fuse the boundaries (see ) or set up a non-conformal interface (see ).

copy_mrf_to_mesh_motion(*args, **kwargs)

Copies motion variable values for origin, axis, and velocities from Frame Motion to Mesh Motion.

create_all_shell_threads(*args, **kwargs)

Marks all finite thickness walls for shell creation. Shell zones will be created at the start of the iterations.

create_periodic_interface(*args, **kwargs)

Creates a conformal or non-conformal periodic interface.

deactivate_cell_zone(*args, **kwargs)

Deactivates cell thread.

delete_all_shells(*args, **kwargs)

Deletes all shell zones and switches off shell conduction on all the walls. These zones can be recreated using the command recreate-all-shells.

delete_cell_zone(*args, **kwargs)

Deletes a cell thread.

extrude_face_zone_delta(*args, **kwargs)

Extrudes a face thread a specified distance based on a list of deltas.

extrude_face_zone_para(*args, **kwargs)

Extrudes a face thread a specified distance based on a distance and a list of parametric locations between 0 and 1, for example, 0 0.2 0.4 0.8 1.0.

fuse_face_zones(*args, **kwargs)

Attempts to fuse zones by removing duplicate faces and nodes.

list_zones(*args, **kwargs)

Lists zone IDs, types, kinds, and names.

make_periodic(*args, **kwargs)

Attempts to establish periodic/shadow face zone connectivity.

matching_tolerance(*args, **kwargs)

Sets normalized tolerance used for finding coincident nodes.

merge_zones(*args, **kwargs)

Merges zones of same type and condition into one.

mrf_to_sliding_mesh(*args, **kwargs)

Changes the motion specification from MRF to moving mesh.

orient_face_zone(*args, **kwargs)

Orients the face zone.

recreate_all_shells(*args, **kwargs)

Recreates shells on all the walls that were deleted using the command delete-all-shells.

replace_zone(*args, **kwargs)

Replaces cell zone.

rotate_zone(*args, **kwargs)

Rotates individual cell zones.

scale_zone(*args, **kwargs)

Scales individual cell zones.

sep_cell_zone_mark(*args, **kwargs)

Separates cell zone based on cell marking.

sep_cell_zone_region(*args, **kwargs)

Separates cell zone based on contiguous regions.

sep_face_zone_angle(*args, **kwargs)

Separates face zone based on significant angle.

sep_face_zone_face(*args, **kwargs)

Separates each face in zone into unique zone.

sep_face_zone_mark(*args, **kwargs)

Separates face zone based on cell marking.

sep_face_zone_region(*args, **kwargs)

Separates face zone based on contiguous regions.

slit_face_zone(*args, **kwargs)

Slits two-sided wall into two connected wall zones.

slit_interior_between_diff_solids(*args, **kwargs)

Slits the interior zone between solid zones of differing materials to create a coupled wall. You will generally be prompted by Fluent if this is necessary.

slit_periodic(*args, **kwargs)

Slits periodic zone into two symmetry zones.

translate_zone(*args, **kwargs)

Translates individual cell zones.

zone_name(*args, **kwargs)

Gives a zone a new name.

zone_type(*args, **kwargs)

Sets the type for a zone or multiple zones of the same category. You will be prompted for the name / ID of the zone to be changed and the new type for that zone. To change multiple zones, you can enter a list (separated by spaces and contained within a pair of parentheses) or use asterisks (*) as wildcards.

network(*args, **kwargs)

Set boundary conditions for a zone of this type.

network_end(*args, **kwargs)

Set boundary conditions for a zone of this type.

non_overlapping_zone_name(*args, **kwargs)

Displays the name of the non-overlapping zone associated with a specified interface zone. This text command is only available after a mesh interface has been created.

class non_reflecting_bc(path, service)

Bases: TUIMenu

Enters the non-reflecting boundary condition menu.

Classes:

general_nrbc(path, service)	Setting for general non-reflecting b.c.
turbo_specific_nrbc(path, service)	Enters the turbo specific nrbc menu.

class general_nrbc(path, service)

Bases: TUIMenu

Setting for general non-reflecting b.c.

Classes:

set(path, service)

Enters the setup menu for general non-reflecting b.c.’s.

class set(path, service)

Bases: TUIMenu

Enters the setup menu for general non-reflecting b.c.’s.

Methods:

relax(*args, **kwargs)	Set NRBC relaxation factor (default value 0.5).
sigma(*args, **kwargs)	Sets NRBC sigma factor (default value 0.15).
sigma2(*args, **kwargs)	Sets NRBC sigma2 factor (default value 5.0).
tangential_source(*args, **kwargs)	Include or not NRBC tangential source (default value #t).
verbosity(*args, **kwargs)	Enables/disables nrbc verbosity scheme output.

relax(*args, **kwargs)

Set NRBC relaxation factor (default value 0.5).

sigma(*args, **kwargs)

Sets NRBC sigma factor (default value 0.15).

sigma2(*args, **kwargs)

Sets NRBC sigma2 factor (default value 5.0).

tangential_source(*args, **kwargs)

Include or not NRBC tangential source (default value #t).

verbosity(*args, **kwargs)

Enables/disables nrbc verbosity scheme output.

class turbo_specific_nrbc(path, service)

Bases: TUIMenu

Enters the turbo specific nrbc menu.

Methods:

enable(*args, **kwargs)	Enables/disables non-reflecting b.c.’s.
initialize(*args, **kwargs)	Initializes non-reflecting b.c.’s.
show_status(*args, **kwargs)	Shows current status of non-reflecting b.c.’s.

Classes:

set(path, service)

Enters the set menu for non-reflecting b.c.

enable(*args, **kwargs)

Enables/disables non-reflecting b.c.’s.

initialize(*args, **kwargs)

Initializes non-reflecting b.c.’s.

class set(path, service)

Bases: TUIMenu

Enters the set menu for non-reflecting b.c. parameters.

Methods:

discretization(*args, **kwargs)	Enables use of higher-order reconstruction at boundaries if available.
under_relaxation(*args, **kwargs)	Sets non-reflecting b.c.
verbosity(*args, **kwargs)	Sets non-reflecting b.c.

discretization(*args, **kwargs)

Enables use of higher-order reconstruction at boundaries if available.

under_relaxation(*args, **kwargs)

Sets non-reflecting b.c. under-relaxation factor.

verbosity(*args, **kwargs)

Sets non-reflecting b.c. verbosity level. 0 : silent, 1 : basic information (default), 2 : detailed information for debugging.

show_status(*args, **kwargs)

Shows current status of non-reflecting b.c.’s.

open_channel_wave_settings(*args, **kwargs)

Opens channel wave input analysis.

openchannel_threads(*args, **kwargs)

Lists open channel group IDs, names, types and variables.

outflow(*args, **kwargs)

Sets boundary conditions for a zone of this type.

outlet_vent(*args, **kwargs)

Sets boundary conditions for a zone of this type.

overset(*args, **kwargs)

Set boundary conditions for a zone of this type.

class perforated_walls(path, service)

Bases: TUIMenu

Enters the perforated walls menu.

Methods:

model_setup(*args, **kwargs)	Sets up the perforated wall model for each effusion surface.
read_input_file(*args, **kwargs)	Reads an input file for perforated walls.

model_setup(*args, **kwargs)

Sets up the perforated wall model for each effusion surface.

read_input_file(*args, **kwargs)

Reads an input file for perforated walls.

periodic(*args, **kwargs)

Sets boundary conditions for a zone of this type.

porous_jump(*args, **kwargs)

Sets boundary conditions for a zone of this type.

pressure_far_field(*args, **kwargs)

Sets boundary conditions for a zone of this type.

pressure_inlet(*args, **kwargs)

Sets boundary conditions for a zone of this type.

pressure_outlet(*args, **kwargs)

Sets boundary conditions for a zone of this type.

radiator(*args, **kwargs)

Sets boundary conditions for a zone of this type.

rans_les_interface(*args, **kwargs)

Sets boundary conditions for a zone of this type.

recirculation_inlet(*args, **kwargs)

Sets boundary conditions for a zone of this type.

recirculation_outlet(*args, **kwargs)

Sets boundary conditions for a zone of this type.

class rename_zone(path, service)

Bases: TUIMenu

Enter the menu for renaming cell and face zones based on adjacency, adding suffixes or prefixes to names, and renaming zones based on the Fluent naming conventions.

Methods:

add_suffix_or_prefix(*args, **kwargs)	Add a suffix or prefix to one or more zones.
rename_by_adjacency(*args, **kwargs)	Append the name of the adjacent cell zone to the specified face zone.
rename_to_default(*args, **kwargs)	Rename a zone to use the Fluent naming convention.

add_suffix_or_prefix(*args, **kwargs)

Add a suffix or prefix to one or more zones.

rename_by_adjacency(*args, **kwargs)

Append the name of the adjacent cell zone to the specified face zone. For example, if fluid is the adjacent cell zone, and you select a face zone named interior, the resulting name of the face zone would be interior-fluid.

rename_to_default(*args, **kwargs)

Rename a zone to use the Fluent naming convention.

class set(path, service)

Bases: TUIMenu

Allows you to define one or more settings at single or multiple boundaries/cell zones of a given type at once. Enter q to exit the define/boundary-conditions/set/<type> command. For a description of the items in this menu, see corresponding define/boundary-conditions/<type>.

Methods:

axis(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
degassing(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
exhaust_fan(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
fan(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
fluid(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
geometry(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
inlet_vent(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
intake_fan(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
interface(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
interior(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
mass_flow_inlet(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
mass_flow_outlet(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
network(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
network_end(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
outflow(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
outlet_vent(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
overset(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
periodic(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
porous_jump(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
pressure_far_field(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
pressure_inlet(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
pressure_outlet(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
radiator(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
rans_les_interface(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
recirculation_inlet(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
recirculation_outlet(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
shadow(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
solid(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
symmetry(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
velocity_inlet(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.
wall(*args, **kwargs)	Set boundary conditions for a zone or multiple zones of this type.

axis(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

degassing(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

exhaust_fan(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

fan(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

fluid(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

geometry(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

inlet_vent(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

intake_fan(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

interface(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

interior(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

mass_flow_inlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

mass_flow_outlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

network(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

network_end(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

outflow(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

outlet_vent(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

overset(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

periodic(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

porous_jump(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

pressure_far_field(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

pressure_inlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

pressure_outlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

radiator(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

rans_les_interface(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

recirculation_inlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

recirculation_outlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

shadow(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

solid(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

symmetry(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

velocity_inlet(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

wall(*args, **kwargs)

Set boundary conditions for a zone or multiple zones of this type.

shadow(*args, **kwargs)

Sets boundary conditions for a zone of this type.

solid(*args, **kwargs)

Sets boundary conditions for a zone of this type.

symmetry(*args, **kwargs)

Sets boundary conditions for a zone of this type.

target_mass_flow_rate_settings(*args, **kwargs)

Enters the targeted mass flow rate settings menu.

velocity_inlet(*args, **kwargs)

Sets boundary conditions for a zone of this type.

wall(*args, **kwargs)

Sets boundary conditions for a zone of this type.

zone_name(*args, **kwargs)

Gives a zone a new name.

zone_type(*args, **kwargs)

Sets the type for a zone or multiple zones of the same category. You will be prompted for the name / ID of the zone to be changed and the new type for that zone. To change multiple zones, you can enter a list (separated by spaces and contained within a pair of parentheses) or use asterisks (*) as wildcards.

class curvilinear_coordinate_system(path, service)

Bases: TUIMenu

Curvilinear Coordinate System.

Methods:

calculation_settings(*args, **kwargs)	Define Settings for curvilinear coordinate system.
delete(*args, **kwargs)	Delete Curvilinear Coordinate System.
display(*args, **kwargs)	Display Curvilinear Coordinate System.
display_settings(*args, **kwargs)	Display settings for Curvilinear Coordinate System.
edit(*args, **kwargs)	Edit an existing curvilinear coordinate system.
new(*args, **kwargs)	Define a new curvilinear coordinate system.

calculation_settings(*args, **kwargs)

Define Settings for curvilinear coordinate system.

delete(*args, **kwargs)

Delete Curvilinear Coordinate System.

display(*args, **kwargs)

Display Curvilinear Coordinate System.

display_settings(*args, **kwargs)

Display settings for Curvilinear Coordinate System.

edit(*args, **kwargs)

Edit an existing curvilinear coordinate system.

new(*args, **kwargs)

Define a new curvilinear coordinate system.

class custom_field_functions(path, service)

Bases: TUIMenu

Enters the custom field functions menu.

Methods:

define(*args, **kwargs)	Defines a custom field function.
delete(*args, **kwargs)	Deletes a custom field function.
example_cff_definitions(*args, **kwargs)	Lists example custom field functions.
list_valid_cell_function_names(*args, **kwargs)	Lists the names of cell functions that can be used in a custom field function.
load(*args, **kwargs)	Loads a custom field function.
save(*args, **kwargs)	Saves a custom field function.

define(*args, **kwargs)

Defines a custom field function.

delete(*args, **kwargs)

Deletes a custom field function.

example_cff_definitions(*args, **kwargs)

Lists example custom field functions.

list_valid_cell_function_names(*args, **kwargs)

Lists the names of cell functions that can be used in a custom field function.

load(*args, **kwargs)

Loads a custom field function.

save(*args, **kwargs)

Saves a custom field function.

class dynamic_mesh(path, service)

Bases: TUIMenu

Enters the dynamic mesh menu.

Classes:

actions(path, service)	Enters the dynamic mesh action menu, where you can initiate manual remeshing (that is, remeshing without running a calculation).
controls(path, service)	Enters the dynamic mesh controls menu.
events(path, service)	Enters the dynamic mesh events menu.
transient_settings(path, service)	Enters the transient dynamic mesh settings menu.
zones(path, service)	Enters the dynamic mesh zones menu.

Methods:

dynamic_mesh(*args, **kwargs)

Enables/disables the dynamic mesh solver.

class actions(path, service)

Bases: TUIMenu

Enters the dynamic mesh action menu, where you can initiate manual remeshing (that is, remeshing without running a calculation).

Methods:

remesh_cell_zone(*args, **kwargs)

Manually remeshes a cell zone with option to remesh adjacent dynamic face zones.

remesh_cell_zone(*args, **kwargs)

Manually remeshes a cell zone with option to remesh adjacent dynamic face zones.

class controls(path, service)

Bases: TUIMenu

Enters the dynamic mesh controls menu. This text command is only available when the define/dynamic-mesh/dynamic-mesh? text command is enabled.

Classes:

contact_parameters(path, service)	Enters the dynamic mesh contact-parameters menu.
implicit_update_parameters(path, service)	Enters the dynamic mesh implicit update menu.
in_cylinder_parameters(path, service)	Enters the dynamic mesh in-cylinder menu.
layering_parameters(path, service)	Enters the dynamic mesh layering menu.
periodic_displacement_parameters(path, service)	Enters the periodic displacement parameters menu.
remeshing_parameters(path, service)	Enters the dynamic mesh remeshing menu to set parameters for all remeshing methods.
six_dof_parameters(path, service)	Enters the dynamic mesh six degrees of freedom (DOF) solver menu.
smoothing_parameters(path, service)	Enters the dynamic mesh smoothing-parameters menu.

Methods:

in_cylinder_output(*args, **kwargs)	Enables/disables in-cylinder output.
layering(*args, **kwargs)	Enables/disables dynamic-layering in quad/hex cell zones.
remeshing(*args, **kwargs)	Enables/disables local remeshing in tri/tet and mixed cell zones.
smoothing(*args, **kwargs)	Enables/disables smoothing in cell zones.
steady_pseudo_time_control(*args, **kwargs)	Enables/disables the pseudo time step control in the graphical user interface.

class contact_parameters(path, service)

Bases: TUIMenu

Enters the dynamic mesh contact-parameters menu. This text command is only available when you enable contact detection using the prompts of the define/dynamic-mesh/dynamic-mesh? text command.

Methods:

contact_face_zones(*args, **kwargs)	Selects face zones involved in contact detection.
contact_method(*args, **kwargs)	Selects the method used for flow control in the contact region.
contact_threshold(*args, **kwargs)	Specifies threshold distance for contact detection.
contact_udf(*args, **kwargs)	Selects the UDF to be invoked when contact is detected.
flow_control(*args, **kwargs)	Enables/disables flow control in the contact region.
render_contact_cells(*args, **kwargs)	Enables/disables the availability of a field variable (contact-cell-mark) that can be used to display contours of cells marked for flow blocking as part of the contact marks method, and allows you to postprocess other field variables on those cells.
update_contact_marks(*args, **kwargs)	Updates which cells are marked in order to block flow in the contact region as part of the contact marks method.
verbosity(*args, **kwargs)	Sets the level of detail printed in the console regarding contact detection.

Classes:

flow_control_parameters(path, service)

Enters the flow control parameters menu, which provides settings related to controlling the flow in the contact region.

contact_face_zones(*args, **kwargs)

Selects face zones involved in contact detection.

contact_method(*args, **kwargs)

Selects the method used for flow control in the contact region. Enter 0 for the contact zones method (which restricts the flow using additional cell zones with porous zone properties) or 1 for the contact marks method (which blocks the flow using zero-mass-flux boundaries).

contact_threshold(*args, **kwargs)

Specifies threshold distance for contact detection.

contact_udf(*args, **kwargs)

Selects the UDF to be invoked when contact is detected.

flow_control(*args, **kwargs)

Enables/disables flow control in the contact region.

class flow_control_parameters(path, service)

Bases: TUIMenu

Enters the flow control parameters menu, which provides settings related to controlling the flow in the contact region.

Methods:

create_flow_control_zone(*args, **kwargs)	Creates a flow control zone as part of the contact zones method.
delete_flow_control_zone(*args, **kwargs)	Deletes a flow control zone as part of the contact zones method.
solution_stabilization(*args, **kwargs)	Enables/disables the performance of additional iterations per time step and the application of solution controls to improve the stability of the solver as part of the contact marks method.

create_flow_control_zone(*args, **kwargs)

Creates a flow control zone as part of the contact zones method.

delete_flow_control_zone(*args, **kwargs)

Deletes a flow control zone as part of the contact zones method.

solution_stabilization(*args, **kwargs)

Enables/disables the performance of additional iterations per time step and the application of solution controls to improve the stability of the solver as part of the contact marks method.

render_contact_cells(*args, **kwargs)

Enables/disables the availability of a field variable (contact-cell-mark) that can be used to display contours of cells marked for flow blocking as part of the contact marks method, and allows you to postprocess other field variables on those cells.

update_contact_marks(*args, **kwargs)

Updates which cells are marked in order to block flow in the contact region as part of the contact marks method.

verbosity(*args, **kwargs)

Sets the level of detail printed in the console regarding contact detection.

class implicit_update_parameters(path, service)

Bases: TUIMenu

Enters the dynamic mesh implicit update menu. This text command is only available when you enable implicit mesh updating using the prompts of the define/dynamic-mesh/dynamic-mesh? text command.

Methods:

motion_relaxation(*args, **kwargs)	Specifies a value (within the range of 0 to 1) for the motion relaxation, which is applied during the implicit mesh update.
residual_criteria(*args, **kwargs)	Specifies the relative residual threshold that is used to check the motion convergence during the implicit mesh update.
update_interval(*args, **kwargs)	Specifies the update interval (that is, the frequency in iterations) at which the mesh is updated within a time step.

motion_relaxation(*args, **kwargs)

Specifies a value (within the range of 0 to 1) for the motion relaxation, which is applied during the implicit mesh update.

residual_criteria(*args, **kwargs)

Specifies the relative residual threshold that is used to check the motion convergence during the implicit mesh update.

update_interval(*args, **kwargs)

Specifies the update interval (that is, the frequency in iterations) at which the mesh is updated within a time step.

in_cylinder_output(*args, **kwargs)

Enables/disables in-cylinder output.

class in_cylinder_parameters(path, service)

Bases: TUIMenu

Enters the dynamic mesh in-cylinder menu.

Methods:

crank_angle_step(*args, **kwargs)	Specifies crank angle step size.
crank_period(*args, **kwargs)	Specifies the crank period.
max_crank_angle_step(*args, **kwargs)	Specifies maximum crank angle step size.
minimum_lift(*args, **kwargs)	Specifies minimum lift for in-cylinder valves.
modify_lift(*args, **kwargs)	Modifies lift curve (shift or scale).
piston_data(*args, **kwargs)	Specifies the crank radius and connecting rod length.
piston_stroke_cutoff(*args, **kwargs)	Specifies the cut off point for in-cylinder piston.
position_starting_mesh(*args, **kwargs)	Moves mesh from top dead center to starting crank angle.
print_plot_lift(*args, **kwargs)	Prints or plot valve lift curve.
starting_crank_angle(*args, **kwargs)	Specifies the initial value for the crank angle.

crank_angle_step(*args, **kwargs)

Specifies crank angle step size.

crank_period(*args, **kwargs)

Specifies the crank period.

max_crank_angle_step(*args, **kwargs)

Specifies maximum crank angle step size.

minimum_lift(*args, **kwargs)

Specifies minimum lift for in-cylinder valves.

modify_lift(*args, **kwargs)

Modifies lift curve (shift or scale).

piston_data(*args, **kwargs)

Specifies the crank radius and connecting rod length.

piston_stroke_cutoff(*args, **kwargs)

Specifies the cut off point for in-cylinder piston.

position_starting_mesh(*args, **kwargs)

Moves mesh from top dead center to starting crank angle.

print_plot_lift(*args, **kwargs)

Prints or plot valve lift curve.

starting_crank_angle(*args, **kwargs)

Specifies the initial value for the crank angle.

layering(*args, **kwargs)

Enables/disables dynamic-layering in quad/hex cell zones.

class layering_parameters(path, service)

Bases: TUIMenu

Enters the dynamic mesh layering menu.

Methods:

collapse_factor(*args, **kwargs)	Sets the factor determining when to collapse dynamic layers.
constant_height(*args, **kwargs)	Enables/disables layering based on constant height, else layering based on constant ratio.
split_factor(*args, **kwargs)	Sets the factor determining when to split dynamic layers.

collapse_factor(*args, **kwargs)

Sets the factor determining when to collapse dynamic layers.

constant_height(*args, **kwargs)

Enables/disables layering based on constant height, else layering based on constant ratio.

split_factor(*args, **kwargs)

Sets the factor determining when to split dynamic layers.

class periodic_displacement_parameters(path, service)

Bases: TUIMenu

Enters the periodic displacement parameters menu.

Methods:

copy_displacement(*args, **kwargs)	Copy Periodic Displacement.
create_displacement(*args, **kwargs)	Create Periodic Displacement.
create_group(*args, **kwargs)	Create Periodic Displacement Group.
delete_all_displacements(*args, **kwargs)	Delete All Periodic Displacements.
delete_all_groups(*args, **kwargs)	Delete All Periodic Displacement Groups.
delete_displacement(*args, **kwargs)	Delete Periodic Displacement.
delete_group(*args, **kwargs)	Delete Periodic Displacement Group.
edit_displacement(*args, **kwargs)	Edit Periodic Displacement.
edit_group(*args, **kwargs)	Edit Periodic Displacement Group.
list_displacements(*args, **kwargs)	List Periodic Displacements.
list_groups(*args, **kwargs)	List Periodic Displacement Groups.
set_active_displacement(*args, **kwargs)	Set Active Periodic Displacement in Group.

copy_displacement(*args, **kwargs)

Copy Periodic Displacement.

create_displacement(*args, **kwargs)

Create Periodic Displacement.

create_group(*args, **kwargs)

Create Periodic Displacement Group.

delete_all_displacements(*args, **kwargs)

Delete All Periodic Displacements.

delete_all_groups(*args, **kwargs)

Delete All Periodic Displacement Groups.

delete_displacement(*args, **kwargs)

Delete Periodic Displacement.

delete_group(*args, **kwargs)

Delete Periodic Displacement Group.

edit_displacement(*args, **kwargs)

Edit Periodic Displacement.

edit_group(*args, **kwargs)

Edit Periodic Displacement Group.

list_displacements(*args, **kwargs)

List Periodic Displacements.

list_groups(*args, **kwargs)

List Periodic Displacement Groups.

set_active_displacement(*args, **kwargs)

Set Active Periodic Displacement in Group.

remeshing(*args, **kwargs)

Enables/disables local remeshing in tri/tet and mixed cell zones.

class remeshing_parameters(path, service)

Bases: TUIMenu

Enters the dynamic mesh remeshing menu to set parameters for all remeshing methods.

Methods:

cell_skew_max(*args, **kwargs)	Sets the cell skewness threshold above which cells will be remeshed.
face_skew_max(*args, **kwargs)	Sets the face skewness threshold above which faces will be remeshed.
length_max(*args, **kwargs)	Sets the length threshold above which cells will be remeshed.
length_min(*args, **kwargs)	Sets the length threshold below which cells will be remeshed.
parallel_remeshing(*args, **kwargs)	Disables/enables parallel remeshing as part of methods-based remeshing..
poly_remeshing(*args, **kwargs)	Enable/disable poly remeshing.
remeshing_after_moving(*args, **kwargs)	Enables a second round of remeshing based on the skewness parameters after the boundary has moved as part of methods-based remeshing.
remeshing_methods(*args, **kwargs)	Enables/disables individual remeshing options as part of methods-based remeshing.
retain_size_distribution(*args, **kwargs)	Enables/disables the use of local size criteria when marking cells for unified remeshing (in an attempt to maintain the initial mesh size distribution even as the mesh moves), rather than marking cells based on the minimum and maximum length scale values of the cell zone in the initial mesh.
size_remesh_interval(*args, **kwargs)	Sets the interval (in time steps) when remeshing based on size is done for methods-based remeshing.
sizing_funct_defaults(*args, **kwargs)	Sets sizing function defaults.
sizing_funct_rate(*args, **kwargs)	Determines how far from the boundary the increase/decrease happens.
sizing_funct_resolution(*args, **kwargs)	Sets the sizing function resolution with respect to shortest boundary.
sizing_funct_variation(*args, **kwargs)	Sets the maximum sizing function increase/decrease in the interior.
sizing_function(*args, **kwargs)	Enables/disables the sizing function as part of methods-based remeshing.
unified_remeshing(*args, **kwargs)	Enables/disables unified remeshing, which specifies that an algorithm is used that combines aspects of a variety of remeshing methods.
zone_remeshing(*args, **kwargs)	Enables/disables the cell zone remeshing method as part of methods-based remeshing.

Classes:

prism_controls(path, service)	Enters the dynamic mesh prism controls menu, which provides text commands that can be useful when you want to modify the algorithm that attempts to retain the size distribution during unified remeshing.
prism_layer_parameters(path, service)	Enters the dynamic mesh prism layer parameters menu, where you can define the parameters of the prism layers as part of methods-based remeshing.
sizing_controls(path, service)	Enters the dynamic mesh sizing controls menu, which provides text commands that can be useful when you want to modify the algorithm that attempts to retain the size distribution during unified remeshing.

cell_skew_max(*args, **kwargs)

Sets the cell skewness threshold above which cells will be remeshed.

face_skew_max(*args, **kwargs)

Sets the face skewness threshold above which faces will be remeshed.

length_max(*args, **kwargs)

Sets the length threshold above which cells will be remeshed.

length_min(*args, **kwargs)

Sets the length threshold below which cells will be remeshed.

parallel_remeshing(*args, **kwargs)

Disables/enables parallel remeshing as part of methods-based remeshing..

poly_remeshing(*args, **kwargs)

Enable/disable poly remeshing.

class prism_controls(path, service)

Bases: TUIMenu

Enters the dynamic mesh prism controls menu, which provides text commands that can be useful when you want to modify the algorithm that attempts to retain the size distribution during unified remeshing. Each prism control definition is applied to one or more boundary zones, and then affects the height distribution and number of layers of the wedge cells in the adjacent boundary layers.

Methods:

add(*args, **kwargs)	Adds a new prism controls definition.
delete(*args, **kwargs)	Deletes an existing prism controls definition.
edit(*args, **kwargs)	Edits an existing prism controls definition.
list(*args, **kwargs)	Prints a list of the existing prism controls definitions in the console.
list_properties(*args, **kwargs)	Prints the properties of an existing prism controls definition of your choice in the console.

add(*args, **kwargs)

Adds a new prism controls definition. After being prompted for a name, you can enter the following to complete the definition: first-height Sets the height of the first layer of wedge cells in the boundary layer adjacent to the specified zones. growth-method Specifies the method used to determine the increase in height of the wedge cell layers beyond the first layer. The only available option is geometric, so that the height of each layer is the height of the previous layer multiplied by the rate. name Specifies the name of the prism controls definition. nlayers Sets the number of layers of wedge cells in the boundary layer adjacent to the specified zones. rate Sets the coefficient for the growth-method used to determine the increase in height of the wedge cell layers beyond the first layer. zones Specifies all of the boundary zones on which this prism controls definition is applied. Enter q when the definition is complete to return to the text command menu.

delete(*args, **kwargs)

Deletes an existing prism controls definition.

edit(*args, **kwargs)

Edits an existing prism controls definition. You can revise the fields listed previously for the define/dynamic-mesh/controls/remeshing-parameters/prism-controls/add text command.

list(*args, **kwargs)

Prints a list of the existing prism controls definitions in the console.

list_properties(*args, **kwargs)

Prints the properties of an existing prism controls definition of your choice in the console.

class prism_layer_parameters(path, service)

Bases: TUIMenu

Enters the dynamic mesh prism layer parameters menu, where you can define the parameters of the prism layers as part of methods-based remeshing.

Methods:

first_height(*args, **kwargs)	Sets the first cell height in the prism layer.
growth_rate(*args, **kwargs)	Sets the geometric growth rate of the prism layer.
number_of_layers(*args, **kwargs)	Sets the number of elements in the prism layer.

first_height(*args, **kwargs)

Sets the first cell height in the prism layer.

growth_rate(*args, **kwargs)

Sets the geometric growth rate of the prism layer.

number_of_layers(*args, **kwargs)

Sets the number of elements in the prism layer.

remeshing_after_moving(*args, **kwargs)

Enables a second round of remeshing based on the skewness parameters after the boundary has moved as part of methods-based remeshing.

remeshing_methods(*args, **kwargs)

Enables/disables individual remeshing options as part of methods-based remeshing.

retain_size_distribution(*args, **kwargs)

Enables/disables the use of local size criteria when marking cells for unified remeshing (in an attempt to maintain the initial mesh size distribution even as the mesh moves), rather than marking cells based on the minimum and maximum length scale values of the cell zone in the initial mesh. Either marking can be overridden if more restrictive values are specified using the define/dynamic-mesh/controls/remeshing-parameters/length-min and define/dynamic-mesh/controls/remeshing-parameters/length-max text commands.

size_remesh_interval(*args, **kwargs)

Sets the interval (in time steps) when remeshing based on size is done for methods-based remeshing.

class sizing_controls(path, service)

Bases: TUIMenu

Enters the dynamic mesh sizing controls menu, which provides text commands that can be useful when you want to modify the algorithm that attempts to retain the size distribution during unified remeshing. Each sizing control definition is applied to one or more boundary zones, and then affects the size of the cells throughout the mesh based on their distance from those boundary zone(s) and your settings in the definition.

Methods:

add(*args, **kwargs)	Adds a new sizing controls definition.
delete(*args, **kwargs)	Deletes an existing sizing controls definition.
edit(*args, **kwargs)	Edits an existing sizing controls definition.
list(*args, **kwargs)	Prints a list of the existing sizing controls definitions in the console.
list_properties(*args, **kwargs)	Prints the properties of an existing sizing controls definition of your choice in the console.

add(*args, **kwargs)

Adds a new sizing controls definition. After being prompted for a name, you can enter the following to complete the definition: growth-rate Sets the growth rate of the sizing controls definition. max-length Sets a maximum length threshold that is used when the type is set to auto or soft. min-length Sets a maximum length threshold that is used when the type is set to auto. motion Determines whether the size control definition affects the remeshing based on whether the mesh undergoes motion: auto specifies that it is applied whether or not there is motion; and static specifies that it is only applied if there is no motion. name Specifies the name of the sizing controls definition. type Specifies how the sizing is affected by the selected boundary zones: auto specifies that the default size distribution (rather than the initial size distribution in your selected boundary zones) is used, along with your specified max-length and min-length values; soft specifies that the maximum length scale of your selected boundary zones is used, along with your specified min-length value; and meshed specifies that the maximum and minimum length scales of your selected boundary zones are used, in order to respect their initial size distribution. This setting is only relevant if you have more than one sizing controls definition. zones Specifies all of the boundary zones on which the sizing controls definition is applied. Enter q when the definition is complete to return to the text command menu.

delete(*args, **kwargs)

Deletes an existing sizing controls definition.

edit(*args, **kwargs)

Edits an existing sizing controls definition. You can revise the fields listed previously for the define/dynamic-mesh/controls/remeshing-parameters/sizing-controls/add text command.

list(*args, **kwargs)

Prints a list of the existing sizing controls definitions in the console.

list_properties(*args, **kwargs)

Prints the properties of an existing sizing controls definition of your choice in the console.

sizing_funct_defaults(*args, **kwargs)

Sets sizing function defaults.

sizing_funct_rate(*args, **kwargs)

Determines how far from the boundary the increase/decrease happens.

sizing_funct_resolution(*args, **kwargs)

Sets the sizing function resolution with respect to shortest boundary.

sizing_funct_variation(*args, **kwargs)

Sets the maximum sizing function increase/decrease in the interior.

sizing_function(*args, **kwargs)

Enables/disables the sizing function as part of methods-based remeshing.

unified_remeshing(*args, **kwargs)

Enables/disables unified remeshing, which specifies that an algorithm is used that combines aspects of a variety of remeshing methods. It is applied to triangular or tetrahedral cells and can produce wedge cells in 3D boundary layer meshes. Unified remeshing simplifies the remeshing setup and can provide increased robustness compared to methods-based remeshing, especially for parallel simulations.

zone_remeshing(*args, **kwargs)

Enables/disables the cell zone remeshing method as part of methods-based remeshing.

class six_dof_parameters(path, service)

Bases: TUIMenu

Enters the dynamic mesh six degrees of freedom (DOF) solver menu.

Methods:

create_properties(*args, **kwargs)	Creates/edits a set of six DOF properties for rigid body motion.
delete_properties(*args, **kwargs)	Deletes a set of six DOF properties for rigid body motion.
list_properties(*args, **kwargs)	Prints summaries of the existing sets of six DOF properties for rigid body motion.
motion_history(*args, **kwargs)	Enables/disables writing position/orientation of six DOF zones to file.
motion_history_file_name(*args, **kwargs)	Specifies the name and location of the six DOF motion history file.
second_order(*args, **kwargs)	Enables/disables the second order six degrees of freedom solver.
x_component_of_gravity(*args, **kwargs)	Specifies x-component of gravity.
y_component_of_gravity(*args, **kwargs)	Specifies y-component of gravity.
z_component_of_gravity(*args, **kwargs)	Specifies z-component of gravity.

create_properties(*args, **kwargs)

Creates/edits a set of six DOF properties for rigid body motion.

delete_properties(*args, **kwargs)

Deletes a set of six DOF properties for rigid body motion.

list_properties(*args, **kwargs)

Prints summaries of the existing sets of six DOF properties for rigid body motion.

motion_history(*args, **kwargs)

Enables/disables writing position/orientation of six DOF zones to file.

motion_history_file_name(*args, **kwargs)

Specifies the name and location of the six DOF motion history file.

second_order(*args, **kwargs)

Enables/disables the second order six degrees of freedom solver.

x_component_of_gravity(*args, **kwargs)

Specifies x-component of gravity.

y_component_of_gravity(*args, **kwargs)

Specifies y-component of gravity.

z_component_of_gravity(*args, **kwargs)

Specifies z-component of gravity.

smoothing(*args, **kwargs)

Enables/disables smoothing in cell zones.

class smoothing_parameters(path, service)

Bases: TUIMenu

Enters the dynamic mesh smoothing-parameters menu.

Methods:

amg_stabilization(*args, **kwargs)	Set the AMG stabilization method for mesh smoothing (FEM).
bnd_node_relaxation(*args, **kwargs)	The boundary node relaxation is used by spring smoothing.
bnd_stiffness_factor(*args, **kwargs)	Sets the stiffness factor for springs connected to boundary nodes.
boundary_distance_method(*args, **kwargs)	Sets the method used to evaluate the boundary distance for the diffusion coefficient calculation, when diffusion-based smoothing is enabled.
constant_factor(*args, **kwargs)	Sets the spring constant relaxation factor.
convergence_tolerance(*args, **kwargs)	Sets the convergence tolerance for spring-based solver.
diffusion_coeff_function(*args, **kwargs)	Specifies whether the diffusion coefficient for diffusion-based smoothing is based on the boundary distance or the cell volume.
diffusion_coeff_parameter(*args, **kwargs)	Sets the diffusion coefficient parameter used for diffusion-based smoothing.
diffusion_fvm(*args, **kwargs)	Answering yes at the prompt changes the diffusion-based smoothing method to the cell-based finite volume approach that was the default in releases prior to Fluent 15.0.
laplace_node_relaxation(*args, **kwargs)	Set the Laplace boundary node relaxation factor.
max_iter(*args, **kwargs)	Set the maximum number of iterations for spring-based solver.
poisson_ratio(*args, **kwargs)	Sets the Poisson’s ratio used for smoothing based on the linearly elastic solid model.
relative_convergence_tolerance(*args, **kwargs)	Sets the relative residual convergence tolerance for smoothing based on diffusion or the linearly elastic solid model.
skew_smooth_all_deforming_boundaries(*args, ...)	Enables/disables skewness smoothing for all deforming dynamic boundary zones.
skew_smooth_cell_skew_max(*args, **kwargs)	Sets the skewness threshold, above which cells will be smoothed using the skewness method.
skew_smooth_face_skew_max(*args, **kwargs)	Sets the skewness threshold, above which faces will be smoothed using the skewness method.
skew_smooth_niter(*args, **kwargs)	Sets the number of skewness-based smoothing cycles.
smooth_from_reference_position(*args, **kwargs)	Enables/disables smoothing from a reference position.
smoothing_method(*args, **kwargs)	Specify the smoothing method used by the dynamic mesh model.
spring_on_all_elements(*args, **kwargs)	Enables/disables spring-based smoothing for all cell shapes; if disabled, the spring-based smoothing is applied based on the setting of the define/dynamic-mesh/controls/smoothing-parameters/spring-on-simplex-shapes? text command.
spring_on_simplex_elements(*args, **kwargs)	Enable/disable spring-based smoothing for tri/tet elements in mixed element zones.
verbosity(*args, **kwargs)	Set the verbosity for spring smoothing.

amg_stabilization(*args, **kwargs)

Set the AMG stabilization method for mesh smoothing (FEM).

bnd_node_relaxation(*args, **kwargs)

The boundary node relaxation is used by spring smoothing. The boundary node relaxation allows you to relax the update of the node positions at deforming boundaries. A value of 0 prevents deforming boundary nodes from moving and a value of 1 indicates no under-relaxation.

bnd_stiffness_factor(*args, **kwargs)

Sets the stiffness factor for springs connected to boundary nodes.

boundary_distance_method(*args, **kwargs)

Sets the method used to evaluate the boundary distance for the diffusion coefficient calculation, when diffusion-based smoothing is enabled.

constant_factor(*args, **kwargs)

Sets the spring constant relaxation factor.

convergence_tolerance(*args, **kwargs)

Sets the convergence tolerance for spring-based solver.

diffusion_coeff_function(*args, **kwargs)

Specifies whether the diffusion coefficient for diffusion-based smoothing is based on the boundary distance or the cell volume.

diffusion_coeff_parameter(*args, **kwargs)

Sets the diffusion coefficient parameter used for diffusion-based smoothing.

diffusion_fvm(*args, **kwargs)

Answering yes at the prompt changes the diffusion-based smoothing method to the cell-based finite volume approach that was the default in releases prior to Fluent 15.0. Answering no at the prompt changes the diffusion-based smoothing method to the default node-based finite element method.

laplace_node_relaxation(*args, **kwargs)

Set the Laplace boundary node relaxation factor.

max_iter(*args, **kwargs)

Set the maximum number of iterations for spring-based solver.

poisson_ratio(*args, **kwargs)

Sets the Poisson’s ratio used for smoothing based on the linearly elastic solid model.

relative_convergence_tolerance(*args, **kwargs)

Sets the relative residual convergence tolerance for smoothing based on diffusion or the linearly elastic solid model.

skew_smooth_all_deforming_boundaries(*args, **kwargs)

Enables/disables skewness smoothing for all deforming dynamic boundary zones. This is enabled by default. If disabled, skewness smoothing is only applied to the deforming dynamic boundary zones that have smoothing explicitly enabled or use local face remeshing.

skew_smooth_cell_skew_max(*args, **kwargs)

Sets the skewness threshold, above which cells will be smoothed using the skewness method.

skew_smooth_face_skew_max(*args, **kwargs)

Sets the skewness threshold, above which faces will be smoothed using the skewness method.

skew_smooth_niter(*args, **kwargs)

Sets the number of skewness-based smoothing cycles.

smooth_from_reference_position(*args, **kwargs)

Enables/disables smoothing from a reference position. Such smoothing may produce greater mesh quality consistency for stationary or moving meshes with periodic or quasi-periodic motion, and is only available when the smoothing method is based on diffusion or the linearly elastic solid model.

smoothing_method(*args, **kwargs)

Specify the smoothing method used by the dynamic mesh model.

spring_on_all_elements(*args, **kwargs)

Enables/disables spring-based smoothing for all cell shapes; if disabled, the spring-based smoothing is applied based on the setting of the define/dynamic-mesh/controls/smoothing-parameters/spring-on-simplex-shapes? text command.

spring_on_simplex_elements(*args, **kwargs)

Enable/disable spring-based smoothing for tri/tet elements in mixed element zones.

verbosity(*args, **kwargs)

Set the verbosity for spring smoothing.

steady_pseudo_time_control(*args, **kwargs)

Enables/disables the pseudo time step control in the graphical user interface.

dynamic_mesh(*args, **kwargs)

Enables/disables the dynamic mesh solver.

class events(path, service)

Bases: TUIMenu

Enters the dynamic mesh events menu.

Methods:

export_event_file(*args, **kwargs)	Exports dynamic mesh events to file.
import_event_file(*args, **kwargs)	Imports dynamic mesh event file.

export_event_file(*args, **kwargs)

Exports dynamic mesh events to file.

import_event_file(*args, **kwargs)

Imports dynamic mesh event file.

class transient_settings(path, service)

Bases: TUIMenu

Enters the transient dynamic mesh settings menu. This text command is only available when you enable dynamic mesh using the prompts of the define/dynamic-mesh/dynamic-mesh? text command. Solver time must also be set to Transient.

Methods:

allow_second_order(*args, **kwargs)	Enables/disables second order transient scheme for dynamic mesh cases.
verbosity(*args, **kwargs)	Enables/disables transient scheme verbosity for dynamic mesh cases.

allow_second_order(*args, **kwargs)

Enables/disables second order transient scheme for dynamic mesh cases.

verbosity(*args, **kwargs)

Enables/disables transient scheme verbosity for dynamic mesh cases.

class zones(path, service)

Bases: TUIMenu

Enters the dynamic mesh zones menu.

Methods:

create(*args, **kwargs)	Create dynamic zone.
delete(*args, **kwargs)	Deletes a dynamic zone.
insert_boundary_layer(*args, **kwargs)	Inserts a new cell zone.
insert_interior_layer(*args, **kwargs)	Inserts a new layer cell zone at a specified location.
list(*args, **kwargs)	Lists the dynamic zones.
remove_boundary_layer(*args, **kwargs)	Removes a cell zone.
remove_interior_layer(*args, **kwargs)	Removes an interior layer cell zone.

create(*args, **kwargs)

Create dynamic zone.

delete(*args, **kwargs)

Deletes a dynamic zone.

insert_boundary_layer(*args, **kwargs)

Inserts a new cell zone.

insert_interior_layer(*args, **kwargs)

Inserts a new layer cell zone at a specified location.

list(*args, **kwargs)

Lists the dynamic zones.

remove_boundary_layer(*args, **kwargs)

Removes a cell zone.

remove_interior_layer(*args, **kwargs)

Removes an interior layer cell zone.

enable_mesh_morpher_optimizer(*args, **kwargs)

Enables the mesh morpher/optimizer. When the mesh morpher/optimizer is enabled, the define/mesh-morpher-optimizer text command becomes available.

class gap_model(path, service)

Bases: TUIMenu

Enters the gap model menu, where you can define one or more gap regions where the flow is blocked or decelerated when face zones move within a specified proximity threshold of each other.

Classes:

advanced_options(path, service)

Enters the advanced options menu for the gap model.

Methods:

create(*args, **kwargs)	Creates a single gap region, so that when selected face zones move within a specified proximity threshold of each other, flow blockage / deceleration is applied to the cells that lie within the threshold.
delete(*args, **kwargs)	Deletes an existing gap region.
delete_all(*args, **kwargs)	Deletes all of the existing gap regions.
edit(*args, **kwargs)	Edits an existing gap region.
enable(*args, **kwargs)	Enables/disables the gap model.
list_gap_cell_zones(*args, **kwargs)	Lists the names of the cell zones that can be excluded for individual gap regions (so that such cells are not marked for flow blockage / deceleration).
list_gap_face_zones(*args, **kwargs)	Lists the names of the face zones that can be used for creating gap regions.
list_gap_regions(*args, **kwargs)	Lists the properties of the gap regions.
render_gap_regions(*args, **kwargs)	Update gap regions for postprocessing.

class advanced_options(path, service)

Bases: TUIMenu

Enters the advanced options menu for the gap model.

Methods:

alternative_marking(*args, **kwargs)	Mark gap regions using an alternative marking algorithm.
cell_check_distance_factor(*args, **kwargs)	Enter value of the cell distance factor.
check_cfl_condition(*args, **kwargs)	Enables/disables the printing of warnings if the time step size is too large based on a Courant (CFL) number automatically determined for your specified solution stability level.
clear_gap_regions(*args, **kwargs)	Clear gap model solution information and marks.
enhanced_data_interpolation(*args, **kwargs)	Enables/disables the use of enhanced data interpolation when updating information in gap regions.
expert(*args, **kwargs)	Enables/disables access to expert-level text commands for the gap model.
extend_gap_regions(*args, **kwargs)	Enables/disables the extending of the gap regions by including additional cells in the vicinity of the gap interfaces during marking.
fill_data_in_gap_regions(*args, **kwargs)	Enables/disables the interpolation of solution data throughout the gap regions.
flow_blocking_stabilization_parameters(...)	Adjust stabilization settings for the sponge layer used for blocked gap regions.
include_coupled_walls(*args, **kwargs)	Include coupled walls in gap face zones.
precise_gap_marking(*args, **kwargs)	Enables/disables the use of a more accurate search algorithm for marking cells in gap regions.
reduce_gap_regions(*args, **kwargs)	Enables/disables a more restrictive algorithm for marking cells in gap regions.
render_flow_modeling_gaps(*args, **kwargs)	Enables/disables the rendering of the solution in the cells of flow-modeling gap regions during postprocessing.
render_gap_interface(*args, **kwargs)	Enables/disables the rendering of the mesh surfaces inside the gap regions when displaying the mesh with contours.
revert_controls_to_default(*args, **kwargs)	Reverts the global gap stabilization level and any related solver settings to the default.
solution_stabilization(*args, **kwargs)	Sets the global solution stabilization level for the gap regions.
sponge_layer(*args, **kwargs)	Allows you to edit the solution stabilization settings for flow-modeling gap regions that have sponge-layer local stabilization enabled.
update_gap_regions(*args, **kwargs)	Update gap regions and gap model solution information.
verbosity(*args, **kwargs)	Sets the verbosity for messages printed in the console related to the gap model.

alternative_marking(*args, **kwargs)

Mark gap regions using an alternative marking algorithm.

cell_check_distance_factor(*args, **kwargs)

Enter value of the cell distance factor.

check_cfl_condition(*args, **kwargs)

Enables/disables the printing of warnings if the time step size is too large based on a Courant (CFL) number automatically determined for your specified solution stability level.

clear_gap_regions(*args, **kwargs)

Clear gap model solution information and marks.

enhanced_data_interpolation(*args, **kwargs)

Enables/disables the use of enhanced data interpolation when updating information in gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command.

expert(*args, **kwargs)

Enables/disables access to expert-level text commands for the gap model.

extend_gap_regions(*args, **kwargs)

Enables/disables the extending of the gap regions by including additional cells in the vicinity of the gap interfaces during marking. This is useful when the default shape of the marked cells is negatively affecting solution stability or convergence behavior.

fill_data_in_gap_regions(*args, **kwargs)

Enables/disables the interpolation of solution data throughout the gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command.

flow_blocking_stabilization_parameters(*args, **kwargs)

Adjust stabilization settings for the sponge layer used for blocked gap regions.

include_coupled_walls(*args, **kwargs)

Include coupled walls in gap face zones.

precise_gap_marking(*args, **kwargs)

Enables/disables the use of a more accurate search algorithm for marking cells in gap regions. Note that it can be costly, particularly for 3D cases or those with a large number of cells inside the gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command.

reduce_gap_regions(*args, **kwargs)

Enables/disables a more restrictive algorithm for marking cells in gap regions. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command.

render_flow_modeling_gaps(*args, **kwargs)

Enables/disables the rendering of the solution in the cells of flow-modeling gap regions during postprocessing. This text command is only available if you have enabled the define/gap-model/advanced-options/expert? text command.

render_gap_interface(*args, **kwargs)

Enables/disables the rendering of the mesh surfaces inside the gap regions when displaying the mesh with contours. Note that the solution is still not rendered inside the flow-blocking gap regions.

revert_controls_to_default(*args, **kwargs)

Reverts the global gap stabilization level and any related solver settings to the default.

solution_stabilization(*args, **kwargs)

Sets the global solution stabilization level for the gap regions.

sponge_layer(*args, **kwargs)

Allows you to edit the solution stabilization settings for flow-modeling gap regions that have sponge-layer local stabilization enabled.

update_gap_regions(*args, **kwargs)

Update gap regions and gap model solution information.

verbosity(*args, **kwargs)

Sets the verbosity for messages printed in the console related to the gap model.

create(*args, **kwargs)

Creates a single gap region, so that when selected face zones move within a specified proximity threshold of each other, flow blockage / deceleration is applied to the cells that lie within the threshold.

delete(*args, **kwargs)

Deletes an existing gap region.

delete_all(*args, **kwargs)

Deletes all of the existing gap regions.

edit(*args, **kwargs)

Edits an existing gap region.

enable(*args, **kwargs)

Enables/disables the gap model.

list_gap_cell_zones(*args, **kwargs)

Lists the names of the cell zones that can be excluded for individual gap regions (so that such cells are not marked for flow blockage / deceleration).

list_gap_face_zones(*args, **kwargs)

Lists the names of the face zones that can be used for creating gap regions.

list_gap_regions(*args, **kwargs)

Lists the properties of the gap regions.

render_gap_regions(*args, **kwargs)

Update gap regions for postprocessing.

injections(*args, **kwargs)

Enters the injections menu. For a description of the items in this menu, see define/models/dpm/injections.

class materials(path, service)

Bases: TUIMenu

Enters the materials menu.

Methods:

change_create(*args, **kwargs)	Changes the properties of a locally-stored material or create a new material.
copy(*args, **kwargs)	Copies a material from the database.
copy_by_formula(*args, **kwargs)	Copies a material from the database by formula.
delete(*args, **kwargs)	Deletes a material from local storage.
list_materials(*args, **kwargs)	Lists all locally-stored materials.
list_properties(*args, **kwargs)	Lists the properties of a locally-stored material.

Classes:

data_base(path, service)

Enters the material database menu.

change_create(*args, **kwargs)

Changes the properties of a locally-stored material or create a new material. Generally, the properties you enter at the prompts will be filtered according to your case and model settings. However, some of the listed properties may not match the selection choice in the Graphics User Interface. Typically, those excessive properties in the Text User Interface will not be used in your simulation.

copy(*args, **kwargs)

Copies a material from the database.

copy_by_formula(*args, **kwargs)

Copies a material from the database by formula.

class data_base(path, service)

Bases: TUIMenu

Enters the material database menu.

Methods:

database_type(*args, **kwargs)	Sets the database type (fluent-database, granta-mds, or user-defined).
edit(*args, **kwargs)	Edits material.
list_materials(*args, **kwargs)	Lists all materials in the database.
list_properties(*args, **kwargs)	Lists the properties of a material in the database.
new(*args, **kwargs)	Defines new material.
save(*args, **kwargs)	Saves user-defined database.

database_type(*args, **kwargs)

Sets the database type (fluent-database, granta-mds, or user-defined).

edit(*args, **kwargs)

Edits material.

list_materials(*args, **kwargs)

Lists all materials in the database.

list_properties(*args, **kwargs)

Lists the properties of a material in the database.

new(*args, **kwargs)

Defines new material.

save(*args, **kwargs)

Saves user-defined database.

delete(*args, **kwargs)

Deletes a material from local storage.

list_materials(*args, **kwargs)

Lists all locally-stored materials.

list_properties(*args, **kwargs)

Lists the properties of a locally-stored material.

class mesh_interfaces(path, service)

Bases: TUIMenu

Enters the mesh-interfaces menu.

Classes:

auto_options(path, service)	Enters the auto-options menu.
mapped_interface_options(path, service)	Enter the mapped-interface-options menu.
non_conformal_interface_numerics(path, service)	Setting non-conformal numerics options.

Methods:

auto_pairing(*args, **kwargs)	Automatically "pairs" some or all of the interface zones, in order to create mesh interfaces.
create(*args, **kwargs)	Creates mesh interfaces.
delete(*args, **kwargs)	Deletes a mesh interface.
delete_all(*args, **kwargs)	Deletes all mesh interfaces.
display(*args, **kwargs)	Displays the specified mesh interface zone.
edit(*args, **kwargs)	Edits attributes of existing mesh interfaces.
enable_si_with_nodes(*args, **kwargs)	Enable sliding interfaces with nodes.
enable_visualization_of_interfaces(*args, ...)	Enables/disables the filling of node coordinates on the zones of mesh interfaces, so that they can be displayed in the graphics window.
enforce_continuity_after_bc(*args, **kwargs)	Enables/disables continuity across the boundary condition interface for contour plots in postprocessing.
enforce_coupled_wall_between_solids(*args, ...)	Enables/disables automatic definition of solid-solid interfaces as coupled walls.
improve_quality(*args, **kwargs)	Checks the quality of all mapped interfaces.
list(*args, **kwargs)	Lists all mesh interfaces.
make_periodic(*args, **kwargs)	Make interface zones periodic.
make_phaselag_from_boundaries(*args, **kwargs)	Make interface zones phase lagged.
make_phaselag_from_periodic(*args, **kwargs)	Convert periodic interface to phase lagged.
non_overlapping_zone_name(*args, **kwargs)	Get non-overlapping zone name from the associated interface zone.
one_to_one_pairing(*args, **kwargs)	Use the default one-to-one interface creation method?.
remove_left_handed_interface_faces(*args, ...)	Removes left-handed faces (which can cause the mesh to be invalid) during mesh interface creation.
transfer_motion_across_interfaces(*args, ...)	Enables/disables the automatic transfer of motion across a mesh interface when only one side is moving as a result of user-defined or system coupling motion.
turbo_create(*args, **kwargs)	Creates a general turbo interface.
verbosity(*args, **kwargs)	Sets the mesh interface verbosity.

class auto_options(path, service)

Bases: TUIMenu

Enters the auto-options menu. This menu is only available when the define/mesh-interfaces/one-to-one-pairing? text command is enabled.

Methods:

keep_empty_interface(*args, **kwargs)	Keep empty interfaces during one-to-one mesh interface creation.
naming_option(*args, **kwargs)	Specifies whether the name of each new one-to-one mesh interface (as well as existing mesh interfaces, if you so desire) has no additional suffix, or a suffix that includes the names of the associated boundary zones, the IDs of the associated boundary zones, or the names of the adjacent cell zones.
pairing_between_different_cell_zones_only(...)	Specifies whether the one-to-one mesh interfaces are only created between different cell zones.
pairing_between_interface_zones_only(*args, ...)	Pairing between interface zones only.
proximity_tolerance(*args, **kwargs)	Sets the tolerance used as part of the automatic grouping of zones to create mesh interfaces when the define/mesh-interfaces/one-to-one-pairing? text command is disabled.
set_default_name_prefix(*args, **kwargs)	Specifies the default interface name prefix used for one-to-one mesh interfaces.
set_one_to_one_pairing_tolerance(*args, **kwargs)	Enables/disables the use of adjustable tolerances to determine which of the selected boundary zones can be paired up to make the mesh interfaces, in order to account for gaps, thin layers, and/or complex geometries.

keep_empty_interface(*args, **kwargs)

Keep empty interfaces during one-to-one mesh interface creation.

naming_option(*args, **kwargs)

Specifies whether the name of each new one-to-one mesh interface (as well as existing mesh interfaces, if you so desire) has no additional suffix, or a suffix that includes the names of the associated boundary zones, the IDs of the associated boundary zones, or the names of the adjacent cell zones.

pairing_between_different_cell_zones_only(*args, **kwargs)

Specifies whether the one-to-one mesh interfaces are only created between different cell zones.

pairing_between_interface_zones_only(*args, **kwargs)

Pairing between interface zones only.

proximity_tolerance(*args, **kwargs)

Sets the tolerance used as part of the automatic grouping of zones to create mesh interfaces when the define/mesh-interfaces/one-to-one-pairing? text command is disabled. The proximity tolerance is defined relative to the edge lengths in the interface zones, and can range from 0 to 1 (representing the minimum and maximum edge lengths, respectively).

set_default_name_prefix(*args, **kwargs)

Specifies the default interface name prefix used for one-to-one mesh interfaces.

set_one_to_one_pairing_tolerance(*args, **kwargs)

Enables/disables the use of adjustable tolerances to determine which of the selected boundary zones can be paired up to make the mesh interfaces, in order to account for gaps, thin layers, and/or complex geometries.

auto_pairing(*args, **kwargs)

Automatically “pairs” some or all of the interface zones, in order to create mesh interfaces. This text command is only available when the define/mesh-interfaces/one-to-one-pairing? text command is disabled.

create(*args, **kwargs)

Creates mesh interfaces.

delete(*args, **kwargs)

Deletes a mesh interface.

delete_all(*args, **kwargs)

Deletes all mesh interfaces.

display(*args, **kwargs)

Displays the specified mesh interface zone.

edit(*args, **kwargs)

Edits attributes of existing mesh interfaces. For one-to-one interfaces, you can edit the name; for many-to-many interfaces, you can edit the interface options and (for a single interface) the name and the list of interface zones assigned to the interface.

enable_si_with_nodes(*args, **kwargs)

Enable sliding interfaces with nodes.

enable_visualization_of_interfaces(*args, **kwargs)

Enables/disables the filling of node coordinates on the zones of mesh interfaces, so that they can be displayed in the graphics window.

enforce_continuity_after_bc(*args, **kwargs)

Enables/disables continuity across the boundary condition interface for contour plots in postprocessing.

enforce_coupled_wall_between_solids(*args, **kwargs)

Enables/disables automatic definition of solid-solid interfaces as coupled walls. By default this option is disabled and ANSYS Fluent creates interior boundaries at solid-solid interfaces.

improve_quality(*args, **kwargs)

Checks the quality of all mapped interfaces. If Fluent finds any mapped interfaces that require improvement it will list them and ask you if you would like to increase the tolerance to improve the interfaces.

list(*args, **kwargs)

Lists all mesh interfaces.

make_periodic(*args, **kwargs)

Make interface zones periodic.

make_phaselag_from_boundaries(*args, **kwargs)

Make interface zones phase lagged.

make_phaselag_from_periodic(*args, **kwargs)

Convert periodic interface to phase lagged.

class mapped_interface_options(path, service)

Bases: TUIMenu

Enter the mapped-interface-options menu.

Methods:

convert_to_mapped_interface(*args, **kwargs)	Convert non-conformal mesh interface to mapped mesh interfaces.
solution_controls(*args, **kwargs)	Specification of mapped frequency and under-relaxation factor for mapped interfaces.
tolerance(*args, **kwargs)	Specification of mapped interface tolerance.

convert_to_mapped_interface(*args, **kwargs)

Convert non-conformal mesh interface to mapped mesh interfaces.

solution_controls(*args, **kwargs)

Specification of mapped frequency and under-relaxation factor for mapped interfaces.

tolerance(*args, **kwargs)

Specification of mapped interface tolerance.

class non_conformal_interface_numerics(path, service)

Bases: TUIMenu

Setting non-conformal numerics options.

Methods:

change_numerics(*args, **kwargs)

Enable modified non-conformal interface numerics.

change_numerics(*args, **kwargs)

Enable modified non-conformal interface numerics.

non_overlapping_zone_name(*args, **kwargs)

Get non-overlapping zone name from the associated interface zone.

one_to_one_pairing(*args, **kwargs)

Use the default one-to-one interface creation method?.

remove_left_handed_interface_faces(*args, **kwargs)

Removes left-handed faces (which can cause the mesh to be invalid) during mesh interface creation.

transfer_motion_across_interfaces(*args, **kwargs)

Enables/disables the automatic transfer of motion across a mesh interface when only one side is moving as a result of user-defined or system coupling motion. You can specify the method by which the motion is transferred: transfer-displacements (the default) interpolates nodal displacement from the active side of the interface to the passive side, and is recommended when there are gaps and/or penetrations in the mesh interface that must be maintained; project-nodes projects the passive nodes onto the faces of active side, and is recommended when the active side includes significant tangential motion (as only the normal displacement is effectively transferred in this method).

turbo_create(*args, **kwargs)

Creates a general turbo interface. This text command is only available if the define/turbo-model/enable-turbo-model? text command is enabled.

verbosity(*args, **kwargs)

Sets the mesh interface verbosity.

class mixing_planes(path, service)

Bases: TUIMenu

Enters the mixing planes menu.

Methods:

create(*args, **kwargs)	Creates a mixing plane.
delete(*args, **kwargs)	Deletes a mixing plane.
list(*args, **kwargs)	Lists defined mixing plane(s).

Classes:

set(path, service)

Sets global parameters relevant to mixing planes.

create(*args, **kwargs)

Creates a mixing plane.

delete(*args, **kwargs)

Deletes a mixing plane.

list(*args, **kwargs)

Lists defined mixing plane(s).

class set(path, service)

Bases: TUIMenu

Sets global parameters relevant to mixing planes.

Methods:

averaging_method(*args, **kwargs)	Sets the mixing plane profile averaging method.
fix_pressure_level(*args, **kwargs)	Sets fixed pressure level using value based on define/reference-pressure-location.
under_relaxation(*args, **kwargs)	Sets mixing plane under-relaxation factor.

Classes:

conserve_swirl(path, service)	Enters the menu to set swirl conservation in mixing plane menu.
conserve_total_enthalpy(path, service)	Enters the menu to set total enthalpy conservation in mixing plane menu.

averaging_method(*args, **kwargs)

Sets the mixing plane profile averaging method.

class conserve_swirl(path, service)

Bases: TUIMenu

Enters the menu to set swirl conservation in mixing plane menu.

Methods:

enable(*args, **kwargs)	Enables/disables swirl conservation in mixing plane.
report_swirl_integration(*args, **kwargs)	Reports swirl integration (Torque) on inflow and outflow zones.
verbosity(*args, **kwargs)	Enables/disables verbosity in swirl conservation calculations.

enable(*args, **kwargs)

Enables/disables swirl conservation in mixing plane.

report_swirl_integration(*args, **kwargs)

Reports swirl integration (Torque) on inflow and outflow zones.

verbosity(*args, **kwargs)

Enables/disables verbosity in swirl conservation calculations.

class conserve_total_enthalpy(path, service)

Bases: TUIMenu

Enters the menu to set total enthalpy conservation in mixing plane menu.

Methods:

enable(*args, **kwargs)	Enables/disables total enthalpy conservation in mixing plane.
verbosity(*args, **kwargs)	Enables/disables verbosity in total-enthalpy conservation calculations.

enable(*args, **kwargs)

Enables/disables total enthalpy conservation in mixing plane.

verbosity(*args, **kwargs)

Enables/disables verbosity in total-enthalpy conservation calculations.

fix_pressure_level(*args, **kwargs)

Sets fixed pressure level using value based on define/reference-pressure-location.

under_relaxation(*args, **kwargs)

Sets mixing plane under-relaxation factor.

class models(path, service)

Bases: TUIMenu

Enters the models menu to configure the solver.

Methods:

ablation(*args, **kwargs)	Enables/disables the ablation model.
addon_module(*args, **kwargs)	Loads addon module.
axisymmetric(*args, **kwargs)	Specifies whether or not the domain is axisymmetric.
battery_model(*args, **kwargs)	Enables the dual potential MSMD battery model.
crevice_model(*args, **kwargs)	Enables/disables the crevice model.
crevice_model_controls(*args, **kwargs)	Enters the crevice model controls menu.
energy(*args, **kwargs)	Enable/disable the energy model.
frozen_flux(*args, **kwargs)	Enables/disables frozen flux formulation for transient flows.
noniterative_time_advance(*args, **kwargs)	Enables/disables noniterative time advancement scheme.
nox(*args, **kwargs)	Enables/disables the NOx model.
potential_and_li_ion_battery(*args, **kwargs)	Enables/disables the electric-potential model.
solidification_melting(*args, **kwargs)	Enables/disables the solidification and melting model.
soot(*args, **kwargs)	Enables/disables the soot model.
steady(*args, **kwargs)	Enables/disables the steady solution model.
swirl(*args, **kwargs)	Enables/disables axisymmetric swirl velocity.
unsteady_1st_order(*args, **kwargs)	Selects the first-order implicit formulation for transient simulations.
unsteady_2nd_order(*args, **kwargs)	Selects the second-order implicit formulation for transient simulations.
unsteady_2nd_order_bounded(*args, **kwargs)	Selects the bounded second-order implicit formulation for transient simulations.
unsteady_global_time(*args, **kwargs)	Selects the explicit transient formulation.
unsteady_structure_euler(*args, **kwargs)	Selects the backward Euler method for the direct time integration of the finite element semi-discrete equation of motion.
unsteady_structure_newmark(*args, **kwargs)	Selects the Newmark method for the direct time integration of the finite element semi-discrete equation of motion.
vbm(*args, **kwargs)	Enable/disable Virtual Blade Model.
virtual_blade_model(*args, **kwargs)	Enter VBM model menu.

Classes:

acoustics(path, service)	Enters the acoustics menu.
cht(path, service)	Enters the cht (conjugate heat transfer) menu.
dpm(path, service)	Enters the dispersed phase model menu.
electrolysis(path, service)	Enter the electrolysis model setup menu.
eulerian_wallfilm(path, service)	Enters the Eulerian wall film model menu.
heat_exchanger(path, service)	Enters the heat exchanger menu.
multiphase(path, service)	Enters the multiphase model menu.
nox_parameters(path, service)	Enters the NOx parameters menu.
optics(path, service)	Enter the optics model menu.
radiation(path, service)	Enters the radiation models menu.
shell_conduction(path, service)	Enters the shell conduction models menu.
solver(path, service)	Enters the menu to select the solver.
soot_parameters(path, service)	Enters the soot parameters menu.
species(path, service)	Enters the species models menu.
structure(path, service)	Enters the structure model menu.
system_coupling_settings(path, service)	Enters the system coupling menu.
two_temperature(path, service)	Enters the Two-Temperature model menu.
viscous(path, service)	Enters the viscous model menu.

ablation(*args, **kwargs)

Enables/disables the ablation model.

class acoustics(path, service)

Bases: TUIMenu

Enters the acoustics menu.

Methods:

acoustic_modal_analysis(*args, **kwargs)	Iterate linear acoustic solver to compute the resonance frequencies and the acoustic modes.
auto_prune(*args, **kwargs)	Enables/disables auto prune of the receiver signal(s) during read-and-compute.
broad_band_noise(*args, **kwargs)	Enables/disables the broadband noise model.
compute_write(*args, **kwargs)	Computes sound pressure.
convective_effects(*args, **kwargs)	Enables/disables the convective effects option.
cylindrical_export(*args, **kwargs)	Enables/disables the export of data in cylindrical coordinates.
display_flow_time(*args, **kwargs)	Enables/disables the display of flow time during read-and-compute.
display_frequencies(*args, **kwargs)	Display resonance frequencies.
export_source_data(*args, **kwargs)	Enables/disables the export of acoustic source data in ASD format during the wave equation model run.
export_source_data_cgns(*args, **kwargs)	Enables/disables the export of acoustic source data in CGNS format.
export_volumetric_sources(*args, **kwargs)	Enables/disables the export of fluid zones.
export_volumetric_sources_cgns(*args, **kwargs)	Enables/disables the export of fluid zones.
ffowcs_williams(*args, **kwargs)	Enables/disables the Ffowcs-Williams-and-Hawkings model.
modal_analysis(*args, **kwargs)	Enable/disable the modal analysis model.
moving_receiver(*args, **kwargs)	Enables/disables the moving receiver option.
off(*args, **kwargs)	Enables/disables the acoustics model.
read_compute_write(*args, **kwargs)	Reads acoustic source data files and computes sound pressure.
receivers(*args, **kwargs)	Sets acoustic receivers.
sources(*args, **kwargs)	Sets acoustic sources.
wave_equation(*args, **kwargs)	Enables/disables the wave equation model.
write_acoustic_signals(*args, **kwargs)	Writes on-the-fly sound pressure.
write_centroid_info(*args, **kwargs)	Writes centroid info.

Classes:

far_field_parameters(path, service)	Enters the menu to specify the far-field density and speed of sound.
sources_fft(path, service)	Enters the acoustic sources fast Fourier transform (FFT) menu, to compute Fourier spectra from acoustic source data (ASD) files, create postprocessing variables for the pressure signals, and write CGNS files of the spectrum data.
sponge_layers(path, service)	Manage sponge layers where density is blended to eliminate reflections from boundary zones.
wave_equation_options(path, service)	Enters the menu to define the acoustics wave equation model options.

acoustic_modal_analysis(*args, **kwargs)

Iterate linear acoustic solver to compute the resonance frequencies and the acoustic modes.

auto_prune(*args, **kwargs)

Enables/disables auto prune of the receiver signal(s) during read-and-compute.

broad_band_noise(*args, **kwargs)

Enables/disables the broadband noise model.

compute_write(*args, **kwargs)

Computes sound pressure.

convective_effects(*args, **kwargs)

Enables/disables the convective effects option.

cylindrical_export(*args, **kwargs)

Enables/disables the export of data in cylindrical coordinates.

display_flow_time(*args, **kwargs)

Enables/disables the display of flow time during read-and-compute.

display_frequencies(*args, **kwargs)

Display resonance frequencies.

export_source_data(*args, **kwargs)

Enables/disables the export of acoustic source data in ASD format during the wave equation model run.

export_source_data_cgns(*args, **kwargs)

Enables/disables the export of acoustic source data in CGNS format.

export_volumetric_sources(*args, **kwargs)

Enables/disables the export of fluid zones.

export_volumetric_sources_cgns(*args, **kwargs)

Enables/disables the export of fluid zones.

class far_field_parameters(path, service)

Bases: TUIMenu

Enters the menu to specify the far-field density and speed of sound. Note that this menu is currently available only with the acoustics wave equation model.

Methods:

far_field_density(*args, **kwargs)	Specifies the far-field density value for the acoustics wave equation model.
far_field_sound_speed(*args, **kwargs)	Specifies the far-field speed of sound value for the acoustics wave equation model.

far_field_density(*args, **kwargs)

Specifies the far-field density value for the acoustics wave equation model.

far_field_sound_speed(*args, **kwargs)

Specifies the far-field speed of sound value for the acoustics wave equation model.

ffowcs_williams(*args, **kwargs)

Enables/disables the Ffowcs-Williams-and-Hawkings model.

modal_analysis(*args, **kwargs)

Enable/disable the modal analysis model.

moving_receiver(*args, **kwargs)

Enables/disables the moving receiver option.

off(*args, **kwargs)

Enables/disables the acoustics model.

read_compute_write(*args, **kwargs)

Reads acoustic source data files and computes sound pressure.

receivers(*args, **kwargs)

Sets acoustic receivers.

sources(*args, **kwargs)

Sets acoustic sources.

class sources_fft(path, service)

Bases: TUIMenu

Enters the acoustic sources fast Fourier transform (FFT) menu, to compute Fourier spectra from acoustic source data (ASD) files, create postprocessing variables for the pressure signals, and write CGNS files of the spectrum data.

Methods:

clean_up_storage_area(*args, **kwargs)	De-allocates memory used to store the pressure histories and their Fourier spectra, as well as any created surface variables for the visualization.
compute_fft_fields(*args, **kwargs)	Computes FFT of the read pressure histories.
read_asd_files(*args, **kwargs)	Reads ASD files to perform FFT of the pressure history field.
write_cgns_files(*args, **kwargs)	Writes surface pressure spectra in CGNS format, which can be used for one-way coupling with Ansys Mechanical in the frequency domain.

Classes:

fft_surface_variables(path, service)

Enters the menu to create surface variables from the computed Fourier spectra for visualization.

clean_up_storage_area(*args, **kwargs)

De-allocates memory used to store the pressure histories and their Fourier spectra, as well as any created surface variables for the visualization.

compute_fft_fields(*args, **kwargs)

Computes FFT of the read pressure histories. The computed spectra replace the pressure histories in memory.

class fft_surface_variables(path, service)

Bases: TUIMenu

Enters the menu to create surface variables from the computed Fourier spectra for visualization.

Methods:

create_constant_width_bands(*args, **kwargs)	Selects up to 20 constant width bands and creates either the surface pressures level (SPL) variables or the PSD of dp/dt variables for them.
create_octave_bands(*args, **kwargs)	Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 17 technical octaves.
create_set_of_modes(*args, **kwargs)	Selects up to 20 individual Fourier modes and create variable pairs for them, containing the real and the imaginary parts of the complex Fourier amplitudes.
create_third_bands(*args, **kwargs)	Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 54 technical thirds.
remove_variables(*args, **kwargs)	Removes all variables created in this menu.

create_constant_width_bands(*args, **kwargs)

Selects up to 20 constant width bands and creates either the surface pressures level (SPL) variables or the PSD of dp/dt variables for them.

create_octave_bands(*args, **kwargs)

Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 17 technical octaves.

create_set_of_modes(*args, **kwargs)

Selects up to 20 individual Fourier modes and create variable pairs for them, containing the real and the imaginary parts of the complex Fourier amplitudes.

create_third_bands(*args, **kwargs)

Creates either the surface pressure level (SPL) variables or the PSD of dp/dt variables for 54 technical thirds.

remove_variables(*args, **kwargs)

Removes all variables created in this menu.

read_asd_files(*args, **kwargs)

Reads ASD files to perform FFT of the pressure history field.

write_cgns_files(*args, **kwargs)

Writes surface pressure spectra in CGNS format, which can be used for one-way coupling with Ansys Mechanical in the frequency domain.

class sponge_layers(path, service)

Bases: TUIMenu

Manage sponge layers where density is blended to eliminate reflections from boundary zones.

Methods:

activate(*args, **kwargs)	Activate a sponge object.
add(*args, **kwargs)	Add a new sponge layer definition.
deactivate(*args, **kwargs)	Deactivate a sponge layer definition.
delete(*args, **kwargs)	Deletes an existing sponge layer definition.
edit(*args, **kwargs)	Edits an existing sponge layer.
list(*args, **kwargs)	Prints a list of the existing sponge layers in the console.
list_active(*args, **kwargs)	List the names of the active sponge layer definitions.
list_properties(*args, **kwargs)	Prints the properties of an existing sponge layer of your choice in the console.

activate(*args, **kwargs)

Activate a sponge object.

add(*args, **kwargs)

Add a new sponge layer definition.

deactivate(*args, **kwargs)

Deactivate a sponge layer definition.

delete(*args, **kwargs)

Deletes an existing sponge layer definition.

edit(*args, **kwargs)

Edits an existing sponge layer. You can revise the fields listed previously for the define/models/acoustics/sponge-layers/add text command.

list(*args, **kwargs)

Prints a list of the existing sponge layers in the console.

list_active(*args, **kwargs)

List the names of the active sponge layer definitions.

list_properties(*args, **kwargs)

Prints the properties of an existing sponge layer of your choice in the console.

wave_equation(*args, **kwargs)

Enables/disables the wave equation model.

class wave_equation_options(path, service)

Bases: TUIMenu

Enters the menu to define the acoustics wave equation model options.

Classes:

basic_shapes(path, service)	Enters the menu to define the geometry of the source mask and sponge layer using the basic shapes, represented by the cell registers of the type "Region".
remote_receivers_options(path, service)	Enters the menu to define remote receivers for the Kirchhoff integral model.

Methods:

remote_receivers(*args, **kwargs)	Enables/disables the Kirchhoff integral model.
source_mask_udf(*args, **kwargs)	Specifies the name of a user-defined function, which defines geometry of the source mask.
sponge_layer_base_level(*args, **kwargs)	Specify artificial viscosity base level applied everywhere.
sponge_layer_factor(*args, **kwargs)	Specifies the factor of the artificial viscosity coefficient.
sponge_layer_udf(*args, **kwargs)	Specifies the name of a user-defined function, which defines geometry of the sponge layer.
time_filter_source(*args, **kwargs)	Enables/disables a time filter for the sound source.

class basic_shapes(path, service)

Bases: TUIMenu

Enters the menu to define the geometry of the source mask and sponge layer using the basic shapes, represented by the cell registers of the type “Region”.

Methods:

add_source_mask_shape(*args, **kwargs)	Adds a basic shape to the definition of the source mask geometry.
add_sponge_layer_shape(*args, **kwargs)	Adds a basic shape to the definition of the sponge layer geometry.
list_region_registers(*args, **kwargs)	List all available cell registers of the type "Region".
list_source_mask_shapes(*args, **kwargs)	List basic shapes, which are currently used in the definition of the source mask geometry.
list_sponge_layer_shapes(*args, **kwargs)	List basic shapes, which are currently used in the definition of the sponge layer geometry.
remove_source_mask_shape(*args, **kwargs)	Remove a basic shape from the definition of the source mask geometry.
remove_sponge_layer_shape(*args, **kwargs)	Remove a basic shape from the definition of the sponge layer geometry.

add_source_mask_shape(*args, **kwargs)

Adds a basic shape to the definition of the source mask geometry.

add_sponge_layer_shape(*args, **kwargs)

Adds a basic shape to the definition of the sponge layer geometry.

list_region_registers(*args, **kwargs)

List all available cell registers of the type “Region”.

list_source_mask_shapes(*args, **kwargs)

List basic shapes, which are currently used in the definition of the source mask geometry.

list_sponge_layer_shapes(*args, **kwargs)

List basic shapes, which are currently used in the definition of the sponge layer geometry.

remove_source_mask_shape(*args, **kwargs)

Remove a basic shape from the definition of the source mask geometry.

remove_sponge_layer_shape(*args, **kwargs)

Remove a basic shape from the definition of the sponge layer geometry.

remote_receivers(*args, **kwargs)

Enables/disables the Kirchhoff integral model.

class remote_receivers_options(path, service)

Bases: TUIMenu

Enters the menu to define remote receivers for the Kirchhoff integral model.

Methods:

integration_surface(*args, **kwargs)	Selects the integration surface for the Kirchhoff model.
write_signals(*args, **kwargs)	Writes the computed receiver signals to the ASCII files.

integration_surface(*args, **kwargs)

Selects the integration surface for the Kirchhoff model.

write_signals(*args, **kwargs)

Writes the computed receiver signals to the ASCII files.

source_mask_udf(*args, **kwargs)

Specifies the name of a user-defined function, which defines geometry of the source mask.

sponge_layer_base_level(*args, **kwargs)

Specify artificial viscosity base level applied everywhere.

sponge_layer_factor(*args, **kwargs)

Specifies the factor of the artificial viscosity coefficient.

sponge_layer_udf(*args, **kwargs)

Specifies the name of a user-defined function, which defines geometry of the sponge layer.

time_filter_source(*args, **kwargs)

Enables/disables a time filter for the sound source.

write_acoustic_signals(*args, **kwargs)

Writes on-the-fly sound pressure.

write_centroid_info(*args, **kwargs)

Writes centroid info.

addon_module(*args, **kwargs)

Loads addon module.

axisymmetric(*args, **kwargs)

Specifies whether or not the domain is axisymmetric.

battery_model(*args, **kwargs)

Enables the dual potential MSMD battery model. For text commands that become available when the battery model is enabled, refer to Battery Model Text Commands.

class cht(path, service)

Bases: TUIMenu

Enters the cht (conjugate heat transfer) menu.

Classes:

explicit_time_averaged_coupling(path, service)

Enters the explicit time averaged thermal coupling menu.

Methods:

implicit_coupling(*args, **kwargs)	Enables the implicit mapping scheme for any fluid-solid pair with a mapped mesh interface (only required for cases set up in version 19.2 or earlier).
read_mi_type_wall(*args, **kwargs)	Read mapped interface data settings from a csv file.
write_mi_type_wall(*args, **kwargs)	Write mapped interface settings to a scv file.

class explicit_time_averaged_coupling(path, service)

Bases: TUIMenu

Enters the explicit time averaged thermal coupling menu.

Methods:

conformal_coupled_walls(*args, **kwargs)	Select fluid-solid coupled walls (without shell) for explicit coupling using time averaged thermal variables.
coupling_controls(*args, **kwargs)	Specify explcit coupling controls.
fuse_explicit_cht_zones(*args, **kwargs)	Fuse slitted conformal coupled walls marked for transient explicit thermal coupling.
mapped_interfaces(*args, **kwargs)	Select fluid-solid mapped interfaces for explicit coupling using time averaged thermal variables.

conformal_coupled_walls(*args, **kwargs)

Select fluid-solid coupled walls (without shell) for explicit coupling using time averaged thermal variables.

coupling_controls(*args, **kwargs)

Specify explcit coupling controls.

fuse_explicit_cht_zones(*args, **kwargs)

Fuse slitted conformal coupled walls marked for transient explicit thermal coupling.

mapped_interfaces(*args, **kwargs)

Select fluid-solid mapped interfaces for explicit coupling using time averaged thermal variables.

implicit_coupling(*args, **kwargs)

Enables the implicit mapping scheme for any fluid-solid pair with a mapped mesh interface (only required for cases set up in version 19.2 or earlier).

read_mi_type_wall(*args, **kwargs)

Read mapped interface data settings from a csv file.

write_mi_type_wall(*args, **kwargs)

Write mapped interface settings to a scv file.

crevice_model(*args, **kwargs)

Enables/disables the crevice model.

crevice_model_controls(*args, **kwargs)

Enters the crevice model controls menu.

class dpm(path, service)

Bases: TUIMenu

Enters the dispersed phase model menu.

Methods:

clear_particles_from_domain(*args, **kwargs)	Removes/keeps all particles currently in the domain.
fill_injection_material_sources(*args, **kwargs)	Initialize the DPM sources corresponding to each material.
injections(*args, **kwargs)	Enters the injections menu.
spray_model(*args, **kwargs)	Enters the spray model menu.
unsteady_tracking(*args, **kwargs)	Enables/disables unsteady particle tracking.
user_defined(*args, **kwargs)	Sets DPM user-defined functions.

Classes:

collisions(path, service)	Enters the DEM collisions menu.
erosion_dynamic_mesh(path, service)	Enters the menu to enable/configure/run the erosion-dynamic mesh interaction.
interaction(path, service)	Sets parameters for coupled discrete phase calculations.
numerics(path, service)	Enters the numerics menu to set numerical solution parameters.
options(path, service)	Enters the options menu to set optional models.
parallel(path, service)	Enters the parallel menu to set parameters for parallel DPM calculations.
splash_options(path, service)	Enters the splash option menu.
stripping_options(path, service)	Enters the stripping options menu.

clear_particles_from_domain(*args, **kwargs)

Removes/keeps all particles currently in the domain.

class collisions(path, service)

Bases: TUIMenu

Enters the DEM collisions menu.

Methods:

collision_mesh(*args, **kwargs)	Input for the collision mesh.
collision_pair_settings(*args, **kwargs)	Supplies settings for collisions to a pair of collision partners.
dem_collisions(*args, **kwargs)	Enables/disables the DEM collision model.
list_all_pair_settings(*args, **kwargs)	For each pair of collision partners, lists the collision laws and their parameters.
max_particle_velocity(*args, **kwargs)	Sets the maximum particle velocity that may arise from collisions.

Classes:

collision_partners(path, service)

Manages collision partners.

collision_mesh(*args, **kwargs)

Input for the collision mesh.

collision_pair_settings(*args, **kwargs)

Supplies settings for collisions to a pair of collision partners. You will be prompted to specify theImpact collision partner and the Target collision partner.

class collision_partners(path, service)

Bases: TUIMenu

Manages collision partners.

Methods:

copy(*args, **kwargs)	Copies a collision partner.
create(*args, **kwargs)	Creates a collision partner.
delete(*args, **kwargs)	Deletes a collision partner.
list(*args, **kwargs)	Lists all known collision partners.
rename(*args, **kwargs)	Renames a collision partner.

copy(*args, **kwargs)

Copies a collision partner.

create(*args, **kwargs)

Creates a collision partner.

delete(*args, **kwargs)

Deletes a collision partner.

list(*args, **kwargs)

Lists all known collision partners.

rename(*args, **kwargs)

Renames a collision partner.

dem_collisions(*args, **kwargs)

Enables/disables the DEM collision model.

list_all_pair_settings(*args, **kwargs)

For each pair of collision partners, lists the collision laws and their parameters.

max_particle_velocity(*args, **kwargs)

Sets the maximum particle velocity that may arise from collisions.

class erosion_dynamic_mesh(path, service)

Bases: TUIMenu

Enters the menu to enable/configure/run the erosion-dynamic mesh interaction.

Methods:

enable_erosion_dynamic_mesh_coupling(*args, ...)	Enables mesh deformation due to wall erosion.
run_simulation(*args, **kwargs)	Performs a coupled erosion-dynamic mesh simulation.

Classes:

general_parameters(path, service)	Enters the menu for setting erosion coupling with dynamic mesh.
run_parameters(path, service)	Manages erosion-dynamic mesh run settings.

enable_erosion_dynamic_mesh_coupling(*args, **kwargs)

Enables mesh deformation due to wall erosion.

class general_parameters(path, service)

Bases: TUIMenu

Enters the menu for setting erosion coupling with dynamic mesh.

Methods:

dynamic_mesh_settings(*args, **kwargs)	Sets parameters for dynamic mesh calculations.
erosion_settings(*args, **kwargs)	Sets parameters for erosion calculations.
participating_walls(*args, **kwargs)	Specifies all participating walls.

dynamic_mesh_settings(*args, **kwargs)

Sets parameters for dynamic mesh calculations.

erosion_settings(*args, **kwargs)

Sets parameters for erosion calculations.

participating_walls(*args, **kwargs)

Specifies all participating walls.

class run_parameters(path, service)

Bases: TUIMenu

Manages erosion-dynamic mesh run settings.

Methods:

autosave_files(*args, **kwargs)	Sets the iteration increment and filename to save data files.
autosave_graphics(*args, **kwargs)	Sets the iteration increment to save graphics files.
flow_simulation_control(*args, **kwargs)	Sets the number of iterations per flow simulation step.
mesh_motion_time_step(*args, **kwargs)	Sets the mesh motion time stepping parameters and method.
simulation_termination(*args, **kwargs)	Sets the total time of erosion.

autosave_files(*args, **kwargs)

Sets the iteration increment and filename to save data files.

autosave_graphics(*args, **kwargs)

Sets the iteration increment to save graphics files.

flow_simulation_control(*args, **kwargs)

Sets the number of iterations per flow simulation step.

mesh_motion_time_step(*args, **kwargs)

Sets the mesh motion time stepping parameters and method.

simulation_termination(*args, **kwargs)

Sets the total time of erosion.

run_simulation(*args, **kwargs)

Performs a coupled erosion-dynamic mesh simulation.

fill_injection_material_sources(*args, **kwargs)

Initialize the DPM sources corresponding to each material.

injections(*args, **kwargs)

Enters the injections menu.

class interaction(path, service)

Bases: TUIMenu

Sets parameters for coupled discrete phase calculations.

Methods:

choice_of_eulerian_phase_for_interaction(...)	Enable/disable the option to choose for every injection the Eulerian phase for the DPM continuous phase interaction.
coupled_calculations(*args, **kwargs)	Selects whether or not to couple continuous and discrete phase calculations.
ddpm_energy_coupling_via_source_term(*args, ...)	Energy coupling in DDPM established via source term.
ddpm_enhanced_inter_phase_exchange(*args, ...)	Enhanced Eulerian inter-phase exchange.
ddpm_iad_particle(*args, **kwargs)	Enable/disable the non-default interfacial area method IA-particle.
dpm_iteration_interval(*args, **kwargs)	Sets the frequency with which the particle trajectory calculations are introduced.
enable_drag_scaling_due_to_flow_blocking(...)	Enable/disable scaling of DPM drag coefficient due to inclusion of DPM volume fraction in continuous flow.
enable_flow_blocking_by_particles(*args, ...)	Enable/disable inclusion of DPM volume fraction in continuous flow.
enable_source_scaling_due_to_flow_blocking(...)	Enable/disable scaling of DPM source terms due to inclusion of DPM volume fraction in continuous flow.
implicit_momentum_coupling(*args, **kwargs)	Enables/disables implicit treatment for the DPM momentum source terms.
implicit_source_term_coupling(*args, **kwargs)	Enables/disables implicit treatment for all DPM source terms.
keep_linearized_dpm_source_terms_constant(...)	Keep linearized DPM source terms constant until the next DPM Update.
linear_growth_of_dpm_source_term(*args, **kwargs)	Enables/disables the linear ramping up of the DPM source terms at every DPM iteration.
linearized_dpm_mixture_fraction_source_terms(...)	Enables/disables linearization of mixture fraction source terms.
linearized_dpm_source_terms(*args, **kwargs)	Enables/disables linearization of source terms for the discrete phase.
linearized_dpm_source_terms_limiter(*args, ...)	Relative limit for DPM source linear coefficient with respect to fluid linear Ap coefficient.
linearized_dpm_species_source_terms(*args, ...)	Perform linearization of species source terms.
max_vf_allowed_for_blocking(*args, **kwargs)	Maximum DPM volume fraction used in continuous flow.
min_vf_threshold_for_dpm_src_scaling(*args, ...)	Minimum DPM volume fraction below which no DPM source scaling is applied.
replace_dpm_mass_source_by_mixture_fraction(...)	When enabled, recalculates the mixture fraction source terms as a function of the primary mixture fraction.
reset_sources_at_timestep(*args, **kwargs)	Enables/disables flush of DPM source terms at beginning of every time step.
underrelaxation_factor(*args, **kwargs)	Sets the under-relaxation factor for the discrete phase sources.
update_dpm_sources_every_flow_iteration(...)	Enables/disables the update of DPM source terms every flow iteration (if this option is not enabled, the terms will be updated every DPM iteration).

choice_of_eulerian_phase_for_interaction(*args, **kwargs)

Enable/disable the option to choose for every injection the Eulerian phase for the DPM continuous phase interaction.

coupled_calculations(*args, **kwargs)

Selects whether or not to couple continuous and discrete phase calculations.

ddpm_energy_coupling_via_source_term(*args, **kwargs)

Energy coupling in DDPM established via source term.

ddpm_enhanced_inter_phase_exchange(*args, **kwargs)

Enhanced Eulerian inter-phase exchange.

ddpm_iad_particle(*args, **kwargs)

Enable/disable the non-default interfacial area method IA-particle.

dpm_iteration_interval(*args, **kwargs)

Sets the frequency with which the particle trajectory calculations are introduced.

enable_drag_scaling_due_to_flow_blocking(*args, **kwargs)

Enable/disable scaling of DPM drag coefficient due to inclusion of DPM volume fraction in continuous flow.

enable_flow_blocking_by_particles(*args, **kwargs)

Enable/disable inclusion of DPM volume fraction in continuous flow.

enable_source_scaling_due_to_flow_blocking(*args, **kwargs)

Enable/disable scaling of DPM source terms due to inclusion of DPM volume fraction in continuous flow.

implicit_momentum_coupling(*args, **kwargs)

Enables/disables implicit treatment for the DPM momentum source terms.

implicit_source_term_coupling(*args, **kwargs)

Enables/disables implicit treatment for all DPM source terms.

keep_linearized_dpm_source_terms_constant(*args, **kwargs)

Keep linearized DPM source terms constant until the next DPM Update.

linear_growth_of_dpm_source_term(*args, **kwargs)

Enables/disables the linear ramping up of the DPM source terms at every DPM iteration.

linearized_dpm_mixture_fraction_source_terms(*args, **kwargs)

Enables/disables linearization of mixture fraction source terms. This command is available only for non- or partially-premixed combustion cases.

linearized_dpm_source_terms(*args, **kwargs)

Enables/disables linearization of source terms for the discrete phase.

linearized_dpm_source_terms_limiter(*args, **kwargs)

Relative limit for DPM source linear coefficient with respect to fluid linear Ap coefficient.

linearized_dpm_species_source_terms(*args, **kwargs)

Perform linearization of species source terms.

max_vf_allowed_for_blocking(*args, **kwargs)

Maximum DPM volume fraction used in continuous flow.

min_vf_threshold_for_dpm_src_scaling(*args, **kwargs)

Minimum DPM volume fraction below which no DPM source scaling is applied.

replace_dpm_mass_source_by_mixture_fraction(*args, **kwargs)

When enabled, recalculates the mixture fraction source terms as a function of the primary mixture fraction. This command is available for non- or partially-premixed combustion cases only.

reset_sources_at_timestep(*args, **kwargs)

Enables/disables flush of DPM source terms at beginning of every time step.

underrelaxation_factor(*args, **kwargs)

Sets the under-relaxation factor for the discrete phase sources.

update_dpm_sources_every_flow_iteration(*args, **kwargs)

Enables/disables the update of DPM source terms every flow iteration (if this option is not enabled, the terms will be updated every DPM iteration).

class numerics(path, service)

Bases: TUIMenu

Enters the numerics menu to set numerical solution parameters.

Methods:

automated_scheme_selection(*args, **kwargs)	Enables/disables the adaptation of integration step length based on a maximum error.
average_DDPM_variables(*args, **kwargs)	Enables/disables mesh node averaging of DDPM quantities.
average_each_step(*args, **kwargs)	Enables/disables mesh node averaging during integration time step.
average_kernel(*args, **kwargs)	Specifies the averaging kernel to use for mesh node averaging.
average_source_terms(*args, **kwargs)	Enables/disables mesh node averaging of DPM source terms.
coupled_heat_mass_update(*args, **kwargs)	Enables/disables coupled heat and mass update.
drag_law(*args, **kwargs)	Sets the drag law.
dynamic_interaction(*args, **kwargs)	Enable/disable dynamic interaction range.
enable_node_based_averaging(*args, **kwargs)	Enables/disables mesh node averaging of DPM quantities.
enhanced_packing_limit_numerics(*args, **kwargs)	Enable enhanced packing limit numerics to avoid exceeding of packing limit for granular phases.
error_control(*args, **kwargs)	Adapts integration step length based on a maximum error.
gaussian_factor(*args, **kwargs)	Specifies the Gaussian constant when using thegaussian kernel for mesh node averaging.
granular_stress_tensor(*args, **kwargs)	Enable granular stress tensor to be considered with solid pressure gradient as collision force.
minimum_liquid_fraction(*args, **kwargs)	A droplet evaporates completely when the remaining mass is below this fraction of the initial droplet mass.
mppic_settings(*args, **kwargs)	Enable PIC and MPPIC to compute DPM and DDPM source terms.
predictor_corrector(*args, **kwargs)	Enable predictor/corrector approach to track particles.
tracking_parameters(*args, **kwargs)	Sets parameters for the (initial) tracking step length.
tracking_scheme(*args, **kwargs)	Specifies a tracking scheme.
tracking_statistics(*args, **kwargs)	Controls the format of the one-line tracking statistics to be printed after every DPM tracking pass.
underrelax_film_height(*args, **kwargs)	Sets the under-relaxation factor for the film height calculation.
vaporization_limiting_factors(*args, **kwargs)	Sets the Vaporization Fractional Change Limits.
verbosity(*args, **kwargs)	Adjust the DPM tracker's verbosity level.

Classes:

high_resolution_tracking(path, service)

Enters the high resolution tracking menu.

automated_scheme_selection(*args, **kwargs)

Enables/disables the adaptation of integration step length based on a maximum error.

average_DDPM_variables(*args, **kwargs)

Enables/disables mesh node averaging of DDPM quantities.

average_each_step(*args, **kwargs)

Enables/disables mesh node averaging during integration time step.

average_kernel(*args, **kwargs)

Specifies the averaging kernel to use for mesh node averaging.

average_source_terms(*args, **kwargs)

Enables/disables mesh node averaging of DPM source terms.

coupled_heat_mass_update(*args, **kwargs)

Enables/disables coupled heat and mass update.

drag_law(*args, **kwargs)

Sets the drag law.

dynamic_interaction(*args, **kwargs)

Enable/disable dynamic interaction range.

enable_node_based_averaging(*args, **kwargs)

Enables/disables mesh node averaging of DPM quantities.

enhanced_packing_limit_numerics(*args, **kwargs)

Enable enhanced packing limit numerics to avoid exceeding of packing limit for granular phases.

error_control(*args, **kwargs)

Adapts integration step length based on a maximum error.

gaussian_factor(*args, **kwargs)

Specifies the Gaussian constant when using thegaussian kernel for mesh node averaging.

granular_stress_tensor(*args, **kwargs)

Enable granular stress tensor to be considered with solid pressure gradient as collision force.

class high_resolution_tracking(path, service)

Bases: TUIMenu

Enters the high resolution tracking menu. See for more information about these options.

Methods:

always_use_face_centroid_with_periodics(...)	When enabled, ANSYS Fluent uses quad face centroids when creating subtets in cases with periodic boundaries.
boundary_layer_tracking(*args, **kwargs)	Enables/disables the calculation of the particle time step that considers both the cell aspect ratio and the particle trajectory.
check_subtet_validity(*args, **kwargs)	When enabled, checks the validity of a subtet when the particle first enters it.
enable_automatic_intersection_tolerance(...)	Enables/disables the automatic calculation of intersection tolerance.
enable_barycentric_intersections(*args, **kwargs)	Enables/disables an alternative method of calculating intersections with cell boundaries.
enable_high_resolution_tracking(*args, **kwargs)	Enables/disables high resolution tracking.
project_wall_film_particles_to_film(*args, ...)	Enables/disables projecting existing particles to Lagrangian wall film to track using high-resolution tracking.
remove_stuck_particles(*args, **kwargs)	Remove particles that are stuck at edges or faces.
set_film_spreading_parameter(*args, **kwargs)	Set the spreading parameter for Lagrangian wallfilm particles.
set_subtet_intersection_tolerance(*args, ...)	Specifies the tolerance used in intersection calculations.
sliding_interface_crossover_fraction(*args, ...)	Specifies the fraction of the distance to the subtet center to move the particle.
use_barycentric_sampling(*args, **kwargs)	When enabled, this option provides improved accuracy and parallel consistency when sampling particles at planes.
use_particle_timestep_for_intersection_tolerance(...)	Enables/disables the use of the particle timestep for the subtet intersection tolerance with axisymmetric grids (default: enabled).
use_quad_face_centroid(*args, **kwargs)	Enables/disables using quad face centroids when creating subtets.
use_velocity_based_error_control(*args, **kwargs)	Enables/disables an alternative method of timestep adaption.

Classes:

barycentric_interpolation(path, service)	Enter the barycentric interpolation menu.
particle_relocation(path, service)	Enter the particle relocation menu.

always_use_face_centroid_with_periodics(*args, **kwargs)

When enabled, ANSYS Fluent uses quad face centroids when creating subtets in cases with periodic boundaries.

class barycentric_interpolation(path, service)

Bases: TUIMenu

Enter the barycentric interpolation menu.

Methods:

enable_transient_variable_interpolation(...)	Enable transient variable interpolation.
interpolate_flow_cp(*args, **kwargs)	Enables/disables the barycentric interpolation of specific heat to the particle position.
interpolate_flow_density(*args, **kwargs)	Enables/disables the barycentric interpolation of the flow density.
interpolate_flow_solution_gradients(*args, ...)	When enabled, flow solution gradients are interpolated to the particle position.
interpolate_flow_viscosity(*args, **kwargs)	Enables/disables the barycentric interpolation of flow viscosity to the particle position.
interpolate_temperature(*args, **kwargs)	Enables/disables the barycentric interpolation of temperature to the particle position.
interpolate_wallfilm_properties(*args, **kwargs)	When enabled, the wall film properties (film height, film mass, and wall shear) are interpolated to the particle position.
nodal_reconstruction_frequency(*args, **kwargs)	Update nodal reconstruction every N'th DPM iteration.
precompute_pdf_species(*args, **kwargs)	When this option is enabled for premixed or non-premixed combustion simulations, the species composition in each cell is precomputed prior to tracking particles.
user_interpolation_function(*args, **kwargs)	Enter user interpolation function.
zero_nodal_velocity_on_walls(*args, **kwargs)	When enabled, sets the velocity at wall nodes to zero.

enable_transient_variable_interpolation(*args, **kwargs)

Enable transient variable interpolation.

interpolate_flow_cp(*args, **kwargs)

Enables/disables the barycentric interpolation of specific heat to the particle position. This option is recommended when the specific heat varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For flows with constant specific heat, this option is unnecessary.

interpolate_flow_density(*args, **kwargs)

Enables/disables the barycentric interpolation of the flow density. This option is recommended when the density varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For constant density flows, this option is unnecessary.

interpolate_flow_solution_gradients(*args, **kwargs)

When enabled, flow solution gradients are interpolated to the particle position. This can be useful when using physical models that depend on these gradients (for example, the thermophoretic force, pressure-gradient force, or virtual mass force). Interpolating the gradients also improves the accuracy and robustness of the trapezoidal numerics scheme, which is the default method for pathlines.

interpolate_flow_viscosity(*args, **kwargs)

Enables/disables the barycentric interpolation of flow viscosity to the particle position. This option is recommended when the flow viscosity varies with position to avoid discontinuities in the interpolated variable at cell boundaries. For flows with constant viscosity, this option is unnecessary.

interpolate_temperature(*args, **kwargs)

Enables/disables the barycentric interpolation of temperature to the particle position. The cell temperature is used by default in calculations of heat transfer to/from the particle.

interpolate_wallfilm_properties(*args, **kwargs)

When enabled, the wall film properties (film height, film mass, and wall shear) are interpolated to the particle position.

nodal_reconstruction_frequency(*args, **kwargs)

Update nodal reconstruction every N’th DPM iteration.

precompute_pdf_species(*args, **kwargs)

When this option is enabled for premixed or non-premixed combustion simulations, the species composition in each cell is precomputed prior to tracking particles. This approach may improve performance for cases with many particles and relatively few cells. By default, this option is set to no, and ANSYS Fluent calculates the species composition during particle tracking. The solution results will be identical for both methods.

user_interpolation_function(*args, **kwargs)

Enter user interpolation function.

zero_nodal_velocity_on_walls(*args, **kwargs)

When enabled, sets the velocity at wall nodes to zero. (By default, the nodal velocities on walls are first reconstructed from cell and face values and then corrected to ensure that there are no velocity components directed towards the walls). This may be useful if you want to consider particle impingement on the walls. Note that enabling this option will more likely produce incomplete particles as some particles may settle on the walls.

boundary_layer_tracking(*args, **kwargs)

Enables/disables the calculation of the particle time step that considers both the cell aspect ratio and the particle trajectory. This method improves the accuracy of the predictions in boundary layer cells, particularly in layers where flow gradients are large.

check_subtet_validity(*args, **kwargs)

When enabled, checks the validity of a subtet when the particle first enters it. If the subtet is found to be degenerate, the tracking algorithm modifies to accommodate it.

enable_automatic_intersection_tolerance(*args, **kwargs)

Enables/disables the automatic calculation of intersection tolerance. By default, the tolerance used in intersection calculations is scaled by the residence time of the particle in the cell to improve robustness. For most cases, the scaled tolerance is sufficient to identify all intersections of the particle trajectory and the subtet faces. You can set the intersection tolerance manually using the set-subtet-intersection-tolerance text command.

enable_barycentric_intersections(*args, **kwargs)

Enables/disables an alternative method of calculating intersections with cell boundaries. Barycentric intersections are linear calculations and are faster than the default intersection algorithm. The default intersection algorithm is second-order for stationary meshes; therefore, using the barycentric intersection may sacrifice accuracy. You must verify that the barycentric intersections provide comparable results to the default intersection method. This option is available only for 3D stationary meshes and the double precision solver.

enable_high_resolution_tracking(*args, **kwargs)

Enables/disables high resolution tracking.

class particle_relocation(path, service)

Bases: TUIMenu

Enter the particle relocation menu.

Methods:

enhanced_cell_relocation_method(*args, **kwargs)	Enable enhanced method of locating particles in cells.
enhanced_wallfilm_location_method(*args, ...)	Enable enhanced method of locating film particles on faces.
load_legacy_particles(*args, **kwargs)	Load particles that were tracked without high-resolution tracking enabled.
overset_relocation_robustness_level(*args, ...)	Set the robustness level for particle relocation in overset meshes.
use_legacy_particle_location_method(*args, ...)	Enable legacy method of locating particles in cells.
wallfilm_relocation_tolerance_scale_factor(...)	Set the relocation tolerance scaling factor for wallfilm particles after remeshing.

enhanced_cell_relocation_method(*args, **kwargs)

Enable enhanced method of locating particles in cells.

enhanced_wallfilm_location_method(*args, **kwargs)

Enable enhanced method of locating film particles on faces.

load_legacy_particles(*args, **kwargs)

Load particles that were tracked without high-resolution tracking enabled.

overset_relocation_robustness_level(*args, **kwargs)

Set the robustness level for particle relocation in overset meshes.

use_legacy_particle_location_method(*args, **kwargs)

Enable legacy method of locating particles in cells.

wallfilm_relocation_tolerance_scale_factor(*args, **kwargs)

Set the relocation tolerance scaling factor for wallfilm particles after remeshing.

project_wall_film_particles_to_film(*args, **kwargs)

Enables/disables projecting existing particles to Lagrangian wall film to track using high-resolution tracking. When reading in a data file that contains wall film particles previously tracked with the existing ANSYS Fluent tracking method, you need to either clear the particles from the domain or project their positions to the wall film surface using the project-wall-film-particles-to-film? text command prior to using the high-resolution tracking method. After tracking the particles for one timestep, this option can be disabled to improve performance.

remove_stuck_particles(*args, **kwargs)

Remove particles that are stuck at edges or faces.

set_film_spreading_parameter(*args, **kwargs)

Set the spreading parameter for Lagrangian wallfilm particles.

set_subtet_intersection_tolerance(*args, **kwargs)

Specifies the tolerance used in intersection calculations. This tolerance will be scaled by the characteristic cell crossing time of the particle if the enable-automatic-intersection-tolerance? text command is enabled. If that option is disabled, the specified tolerance will be used without scaling. The default intersection tolerance is 10-5.

sliding_interface_crossover_fraction(*args, **kwargs)

Specifies the fraction of the distance to the subtet center to move the particle. At non-conformal interfaces, the nodes used for the barycentric interpolation are different on either side of the interface. This may result in incomplete particles due to discontinuities in the variable interpolation. The number of incomplete particles may be reduced by moving the particles slightly off of the sliding interface. Recommended values range between 0 and 0.5.

use_barycentric_sampling(*args, **kwargs)

When enabled, this option provides improved accuracy and parallel consistency when sampling particles at planes. This item is available only with the 3D solver. Using the double-precision solver and bounded planes is recommended.

use_particle_timestep_for_intersection_tolerance(*args, **kwargs)

Enables/disables the use of the particle timestep for the subtet intersection tolerance with axisymmetric grids (default: enabled). If disabled, the tolerance will be calculated in the same manner as non-axisymmetric meshes (a scaled value of the tolerance which is set using the define/models/dpm/numerics/high-resolution-tracking/set-subtet-intersection-tolerance text command).

use_quad_face_centroid(*args, **kwargs)

Enables/disables using quad face centroids when creating subtets. This option changes the way hexahedral cells are decomposed to avoid creating degenerate subtets.

use_velocity_based_error_control(*args, **kwargs)

Enables/disables an alternative method of timestep adaption. By default, ANSYS Fluent uses the half-step method of timestep adaption with particle integration. This alternative method of controlling the integration timestep based upon velocity changes is faster; however, you need to ensure that the accuracy is comparable for your specific application.

minimum_liquid_fraction(*args, **kwargs)

A droplet evaporates completely when the remaining mass is below this fraction of the initial droplet mass.

mppic_settings(*args, **kwargs)

Enable PIC and MPPIC to compute DPM and DDPM source terms.

predictor_corrector(*args, **kwargs)

Enable predictor/corrector approach to track particles.

tracking_parameters(*args, **kwargs)

Sets parameters for the (initial) tracking step length.

tracking_scheme(*args, **kwargs)

Specifies a tracking scheme.

tracking_statistics(*args, **kwargs)

Controls the format of the one-line tracking statistics to be printed after every DPM tracking pass. A value of 0 (the default) prints only fates with non-zero values. A value of 1 prints all fates, including fates with zero values.

underrelax_film_height(*args, **kwargs)

Sets the under-relaxation factor for the film height calculation. The recommended values range between 0.5 (default) and 0.9.

vaporization_limiting_factors(*args, **kwargs)

Sets the Vaporization Fractional Change Limits.

verbosity(*args, **kwargs)

Adjust the DPM tracker’s verbosity level.

class options(path, service)

Bases: TUIMenu

Enters the options menu to set optional models.

Methods:

allow_supercritical_pressure_vaporization(...)	Enforces the switching from vaporization to boiling even if the boiling point is not calculated from the vapor pressure data.
brownian_motion(*args, **kwargs)	Enables/disables Brownian motion of particles.
convective_film_heat_transfer(*args, **kwargs)	Enable/disable convection/conduction film to wall heat transfer model.
current_positions_in_sample_file_format(...)	When enabled, generates a file containing particle current positions (step-by-step history report for unsteady tracking) in the sampling file format.
enable_contour_plots(*args, **kwargs)	Enables computation of mean and/or RMS values of additional discrete phase variables for postprocessing.
ensemble_average(*args, **kwargs)	Ensembles average cloud properties.
erosion_accretion(*args, **kwargs)	Enables/disables erosion/accretion.
include_lwf_particles_in_dpm_concentration(...)	Include LWF particle mass in DPM Concentration.
init_erosion_accretion_rate(*args, **kwargs)	Initializes the erosion/accretion rates with zero.
lowest_volatiles_mass_fraction(*args, **kwargs)	Set the lowest volatiles mass fraction.
maximum_udf_species(*args, **kwargs)	Specifies the maximum number of species that will be accessible from discrete phase model UDFs.
particle_radiation(*args, **kwargs)	Enables/disables particle radiation.
pressure_gradient_force(*args, **kwargs)	Enables/disables inclusion of pressure gradient effects in the particle force balance.
remove_wall_film_temperature_limiter(*args, ...)	Answering yes at the prompt removes the wall temperature limiter for Lagrangian wall-film walls.
saffman_lift_force(*args, **kwargs)	Enables/disables Saffman lift force.
scr_urea_deposition_risk_analysis(*args, ...)	Enters the menu for setting up the risk for solids deposit formation for the Selective Catalytic Reduction (SCR) process.
set_minimum_particle_diameter(*args, **kwargs)	Set the minimum particle diameter.
set_thermolysis_limit(*args, **kwargs)	Sets the limit for the thermolysis model.
stagger_radius(*args, **kwargs)	Specifies the region over which to spatially stagger particles when particle-staggering is enabled for non-atomizer injections.
stagger_spatially_atomizer_injections(*args, ...)	Enables/disables spatial staggering for atomizer and solid-cone injections.
stagger_spatially_standard_injections(*args, ...)	Enables/disables spatial staggering for standard (non-atomizer and non-solid-cone) injections.
stagger_temporally(*args, **kwargs)	Enables/disables temporal staggering.
staggering_factor(*args, **kwargs)
step_report_sig_figures(*args, **kwargs)	Sets significant figures in the step-by-step report.
thermophoretic_force(*args, **kwargs)	Enables/disables thermophoretic force.
track_in_absolute_frame(*args, **kwargs)	Enables/disables tracking in absolute frame.
treat_multicomponent_saturation_temperature_failure(...)	Enables/disables dumping multicomponent particle mass into the continuous phase if the saturation temperature calculation fails.
two_way_coupling(*args, **kwargs)	Enables/disables calculation of DPM sources in TKE equation.
uniform_mass_distribution_for_injections(...)	Specifies a uniform distribution of mass over the cross-section of solid cone and atomizer injections.
use_absolute_pressure_for_vaporization(...)	Determines whether the absolute pressure or constant operating pressure (specified in define/operating-conditions/operating-pressure) will be used in vaporization rates calculations.
vaporization_heat_transfer_averaging(*args, ...)	Enables averaging of the Spalding heat transfer term for the convection/diffusion-controlled model.
vaporization_options(*args, **kwargs)	Sets Vaporization options.
virtual_mass_force(*args, **kwargs)	Enables/disables inclusion of the virtual mass force in the particle force balance.

allow_supercritical_pressure_vaporization(*args, **kwargs)

Enforces the switching from vaporization to boiling even if the boiling point is not calculated from the vapor pressure data. If the pressure in your model is above critical you must retain the default setting (yes). This options is available only if whenPressure Dependent Boiling is enabled in the Physical Models tab of the Discrete Phase Models dialog box. For more details, see .

brownian_motion(*args, **kwargs)

Enables/disables Brownian motion of particles.

convective_film_heat_transfer(*args, **kwargs)

Enable/disable convection/conduction film to wall heat transfer model.

current_positions_in_sample_file_format(*args, **kwargs)

When enabled, generates a file containing particle current positions (step-by-step history report for unsteady tracking) in the sampling file format.

enable_contour_plots(*args, **kwargs)

Enables computation of mean and/or RMS values of additional discrete phase variables for postprocessing.

ensemble_average(*args, **kwargs)

Ensembles average cloud properties.

erosion_accretion(*args, **kwargs)

Enables/disables erosion/accretion.

include_lwf_particles_in_dpm_concentration(*args, **kwargs)

Include LWF particle mass in DPM Concentration.

init_erosion_accretion_rate(*args, **kwargs)

Initializes the erosion/accretion rates with zero.

lowest_volatiles_mass_fraction(*args, **kwargs)

Set the lowest volatiles mass fraction.

maximum_udf_species(*args, **kwargs)

Specifies the maximum number of species that will be accessible from discrete phase model UDFs. Only species with indices up to this value are accessible in discrete phase model UDFs.

particle_radiation(*args, **kwargs)

Enables/disables particle radiation.

pressure_gradient_force(*args, **kwargs)

Enables/disables inclusion of pressure gradient effects in the particle force balance.

remove_wall_film_temperature_limiter(*args, **kwargs)

Answering yes at the prompt removes the wall temperature limiter for Lagrangian wall-film walls. If you enter no (default), two additional prompts will appear in the console allowing you to define the temperature difference above the boiling point and to enable/disable the reporting of the Leidenfrost temperature on the wall faces.

saffman_lift_force(*args, **kwargs)

Enables/disables Saffman lift force.

scr_urea_deposition_risk_analysis(*args, **kwargs)

Enters the menu for setting up the risk for solids deposit formation for the Selective Catalytic Reduction (SCR) process. For more information, see .

set_minimum_particle_diameter(*args, **kwargs)

Set the minimum particle diameter.

set_thermolysis_limit(*args, **kwargs)

Sets the limit for the thermolysis model.

stagger_radius(*args, **kwargs)

Specifies the region over which to spatially stagger particles when particle-staggering is enabled for non-atomizer injections.

stagger_spatially_atomizer_injections(*args, **kwargs)

Enables/disables spatial staggering for atomizer and solid-cone injections.

stagger_spatially_standard_injections(*args, **kwargs)

Enables/disables spatial staggering for standard (non-atomizer and non-solid-cone) injections.

stagger_temporally(*args, **kwargs)

Enables/disables temporal staggering.

staggering_factor(*args, **kwargs)

step_report_sig_figures(*args, **kwargs)

Sets significant figures in the step-by-step report.

thermophoretic_force(*args, **kwargs)

Enables/disables thermophoretic force.

track_in_absolute_frame(*args, **kwargs)

Enables/disables tracking in absolute frame.

treat_multicomponent_saturation_temperature_failure(*args, **kwargs)

Enables/disables dumping multicomponent particle mass into the continuous phase if the saturation temperature calculation fails.

two_way_coupling(*args, **kwargs)

Enables/disables calculation of DPM sources in TKE equation.

uniform_mass_distribution_for_injections(*args, **kwargs)

Specifies a uniform distribution of mass over the cross-section of solid cone and atomizer injections. This can become important when the mesh is smaller than the diameter (or another characteristic size) of the injection.

use_absolute_pressure_for_vaporization(*args, **kwargs)

Determines whether the absolute pressure or constant operating pressure (specified in define/operating-conditions/operating-pressure) will be used in vaporization rates calculations.

vaporization_heat_transfer_averaging(*args, **kwargs)

Enables averaging of the Spalding heat transfer term for the convection/diffusion-controlled model.

vaporization_options(*args, **kwargs)

Sets Vaporization options.

virtual_mass_force(*args, **kwargs)

Enables/disables inclusion of the virtual mass force in the particle force balance.

class parallel(path, service)

Bases: TUIMenu

Enters the parallel menu to set parameters for parallel DPM calculations.

Methods:

enable_workpile(*args, **kwargs)	Turns on/off particle workpile algorithm.
fix_source_term_accumulation_order(*args, ...)	Enforce deterministic order of source term accumulation.
hybrid_2domain(*args, **kwargs)	Enables/disables the use of a second domain for DPM particle tracking.
hybrid_collision_model(*args, **kwargs)	An EXPERIMENTAL feature to allow 'hybrid' DPM parallel tracking with the collision / coalescence model.
hybrid_collision_unidirectional(*args, **kwargs)	A faster, yet potentially somewhat less accurate, modification to the beta feature that allows 'hybrid' DPM parallel tracking with the collision / coalescence model.
hybrid_collision_variant(*args, **kwargs)	Further reduce the residual risk of dead-locks in the experimental feature that allows 'hybrid' DPM parallel tracking with the collision / coalescence model.
hybrid_workpile(*args, **kwargs)	Optimize multi-thread load balancing within each partition in hybrid-parallel DPM tracking.
n_threads(*args, **kwargs)	Sets the number of processors to use for DPM.
report(*args, **kwargs)	Prints particle workpile statistics.
use_hybrid(*args, **kwargs)	Specifies that the calculations are performed using multicore cluster computing or shared-memory machines.
use_message_passing(*args, **kwargs)	Specifies that the calculations are performed using cluster computing or shared-memory machines.
use_shared_memory(*args, **kwargs)	Specifies that the calculations are performed on shared-memory multiprocessor machines.

Classes:

expert(path, service)

Enters the menu for expert DPM parallel text commands.

enable_workpile(*args, **kwargs)

Turns on/off particle workpile algorithm. This option is only available when the define/models/dpm/parallel/use-shared-memory option is selected.

class expert(path, service)

Bases: TUIMenu

Enters the menu for expert DPM parallel text commands.

Methods:

partition_method_hybrid_2domain(*args, **kwargs)

Enables/disables a partitioning method that is more granular and can yield faster calculations (especially for cases that are running on a low to moderate number of processors).

partition_method_hybrid_2domain(*args, **kwargs)

Enables/disables a partitioning method that is more granular and can yield faster calculations (especially for cases that are running on a low to moderate number of processors). This partitioning method is only applied when you use the DPM domain for the hybrid parallel DPM tracking mode (that is, when you have enabled the define/models/dpm/parallel/hybrid-2domain? text command).

fix_source_term_accumulation_order(*args, **kwargs)

Enforce deterministic order of source term accumulation.

hybrid_2domain(*args, **kwargs)

Enables/disables the use of a second domain for DPM particle tracking.

hybrid_collision_model(*args, **kwargs)

An EXPERIMENTAL feature to allow ‘hybrid’ DPM parallel tracking with the collision / coalescence model.

hybrid_collision_unidirectional(*args, **kwargs)

A faster, yet potentially somewhat less accurate, modification to the beta feature that allows ‘hybrid’ DPM parallel tracking with the collision / coalescence model.

hybrid_collision_variant(*args, **kwargs)

Further reduce the residual risk of dead-locks in the experimental feature that allows ‘hybrid’ DPM parallel tracking with the collision / coalescence model.

hybrid_workpile(*args, **kwargs)

Optimize multi-thread load balancing within each partition in hybrid-parallel DPM tracking.

n_threads(*args, **kwargs)

Sets the number of processors to use for DPM. This option is only available when the define/models/dpm/parallel/enable-workpile? option is enabled.

report(*args, **kwargs)

Prints particle workpile statistics. This option is only available when the define/models/dpm/parallel/enable-workpile? option is enabled.

use_hybrid(*args, **kwargs)

Specifies that the calculations are performed using multicore cluster computing or shared-memory machines. This option works in conjunction withopenmpi for a dynamic load balancing without migration of cells.

use_message_passing(*args, **kwargs)

Specifies that the calculations are performed using cluster computing or shared-memory machines. With this option, the compute node processes themselves perform the particle work on their local partitions and particle migration to other compute nodes is implemented using message passing primitives.

use_shared_memory(*args, **kwargs)

Specifies that the calculations are performed on shared-memory multiprocessor machines.

class splash_options(path, service)

Bases: TUIMenu

Enters the splash option menu.

Methods:

orourke_splash_fraction(*args, **kwargs)	Enables/disables the O’Rourke formulation (default for the Lagrangian Wall Film (LWF) model).
splash_pdf_limiting(*args, **kwargs)	Sets the splash pdf limiting method.

orourke_splash_fraction(*args, **kwargs)

Enables/disables the O’Rourke formulation (default for the Lagrangian Wall Film (LWF) model). If the O’Rourke formulation is disabled, the Stanton formulation (default for the Eulerian Wall Film (EWF) model) is used in a simulation.

splash_pdf_limiting(*args, **kwargs)

Sets the splash pdf limiting method. Available methods are: the splash pdf tail limiting (default for the LWF model) and the splash pdf peak limiting (default for the EWF model). For the splash pdf peak limiting, you will be prompted to specify the peak limiting value.

spray_model(*args, **kwargs)

Enters the spray model menu. This command is available only if the breakup model enabled globally.

class stripping_options(path, service)

Bases: TUIMenu

Enters the stripping options menu.

Methods:

diameter_coefficient(*args, **kwargs)	Sets the diameter coefficient ( in in the Theory Guide).
mass_coefficient(*args, **kwargs)	Sets the mass coefficient ( in in the Theory Guide).

diameter_coefficient(*args, **kwargs)

Sets the diameter coefficient ( in in the Theory Guide).

mass_coefficient(*args, **kwargs)

Sets the mass coefficient ( in in the Theory Guide).

unsteady_tracking(*args, **kwargs)

Enables/disables unsteady particle tracking.

user_defined(*args, **kwargs)

Sets DPM user-defined functions.

class electrolysis(path, service)

Bases: TUIMenu

Enter the electrolysis model setup menu.

Classes:

anode_setup(path, service)	Enter the menu for the anode controls.
cathode_setup(path, service)	Enter the menu for the cathode controls.
membrane_setup(path, service)	Specify parameters for electrolyte.

Methods:

electrical_tabs_setup(*args, **kwargs)	Specify settings for the electrical tabs.
model_options(*args, **kwargs)	Specify electrolysis model options.
parameters(*args, **kwargs)	Specify electrolysis model parameters.

class anode_setup(path, service)

Bases: TUIMenu

Enter the menu for the anode controls.

Methods:

catalyst_layer(*args, **kwargs)	Set parameters for the catalyst layer.
current_collector(*args, **kwargs)	Set parameters for the current collector.
electrolyte(*args, **kwargs)	Set parameters for the electrolyte.
flow_channel(*args, **kwargs)	Set parameters for the flow channel.
porous_layer(*args, **kwargs)	Set parameters for the porous layer.

catalyst_layer(*args, **kwargs)

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)

Set parameters for the current collector.

electrolyte(*args, **kwargs)

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)

Set parameters for the flow channel.

porous_layer(*args, **kwargs)

Set parameters for the porous layer.

class cathode_setup(path, service)

Bases: TUIMenu

Enter the menu for the cathode controls.

Methods:

catalyst_layer(*args, **kwargs)	Set parameters for the catalyst layer.
current_collector(*args, **kwargs)	Set parameters for the current collector.
electrolyte(*args, **kwargs)	Set parameters for the electrolyte.
flow_channel(*args, **kwargs)	Set parameters for the flow channel.
porous_layer(*args, **kwargs)	Set parameters for the porous layer.

catalyst_layer(*args, **kwargs)

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)

Set parameters for the current collector.

electrolyte(*args, **kwargs)

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)

Set parameters for the flow channel.

porous_layer(*args, **kwargs)

Set parameters for the porous layer.

electrical_tabs_setup(*args, **kwargs)

Specify settings for the electrical tabs.

class membrane_setup(path, service)

Bases: TUIMenu

Specify parameters for electrolyte.

Methods:

catalyst_layer(*args, **kwargs)	Set parameters for the catalyst layer.
current_collector(*args, **kwargs)	Set parameters for the current collector.
electrolyte(*args, **kwargs)	Set parameters for the electrolyte.
flow_channel(*args, **kwargs)	Set parameters for the flow channel.
porous_layer(*args, **kwargs)	Set parameters for the porous layer.

catalyst_layer(*args, **kwargs)

Set parameters for the catalyst layer.

current_collector(*args, **kwargs)

Set parameters for the current collector.

electrolyte(*args, **kwargs)

Set parameters for the electrolyte.

flow_channel(*args, **kwargs)

Set parameters for the flow channel.

porous_layer(*args, **kwargs)

Set parameters for the porous layer.

model_options(*args, **kwargs)

Specify electrolysis model options.

parameters(*args, **kwargs)

Specify electrolysis model parameters.

energy(*args, **kwargs)

Enable/disable the energy model.

class eulerian_wallfilm(path, service)

Bases: TUIMenu

Enters the Eulerian wall film model menu.

Classes:

coupled_solution(path, service)	Enters the Coupled-Solution menu.
implicit_options(path, service)	Enter Implicit Scheme Option (beta).

Methods:

enable_film_vof_transition_message(*args, ...)	Enable film-VOF transition message.
enable_wallfilm_model(*args, **kwargs)	Enables/disables Eulerian Wall Film Model.
film_material(*args, **kwargs)	Sets Film Material and Properties.
initialize_wallfilm_model(*args, **kwargs)	Initializes Eulerian Wall Film Model.
list_film_walls(*args, **kwargs)	List film walls.
model_options(*args, **kwargs)	Set Eulerian wall film model options.
solution_options(*args, **kwargs)	Sets Eulerian Wall Film Model Solution Options.
solve_wallfilm_equation(*args, **kwargs)	Activates Eulerian Wall Film Equations.

class coupled_solution(path, service)

Bases: TUIMenu

Enters the Coupled-Solution menu.

Methods:

enable_coupled_solution(*args, **kwargs)	Enables/disables the coupled solution method.
enable_curvature_smoothing(*args, **kwargs)	Enables/disables the film curvature smoothing option and sets the smoothing parameters.

enable_coupled_solution(*args, **kwargs)

Enables/disables the coupled solution method.

enable_curvature_smoothing(*args, **kwargs)

Enables/disables the film curvature smoothing option and sets the smoothing parameters.

enable_film_vof_transition_message(*args, **kwargs)

Enable film-VOF transition message.

enable_wallfilm_model(*args, **kwargs)

Enables/disables Eulerian Wall Film Model.

film_material(*args, **kwargs)

Sets Film Material and Properties.

class implicit_options(path, service)

Bases: TUIMenu

Enter Implicit Scheme Option (beta).

Methods:

new_implicit_scheme(*args, **kwargs)	Enable alternative implicit scheme.
relative_error_residual(*args, **kwargs)	Enable relative error residual.

new_implicit_scheme(*args, **kwargs)

Enable alternative implicit scheme.

relative_error_residual(*args, **kwargs)

Enable relative error residual.

initialize_wallfilm_model(*args, **kwargs)

Initializes Eulerian Wall Film Model.

list_film_walls(*args, **kwargs)

List film walls.

model_options(*args, **kwargs)

Set Eulerian wall film model options.

solution_options(*args, **kwargs)

Sets Eulerian Wall Film Model Solution Options.

solve_wallfilm_equation(*args, **kwargs)

Activates Eulerian Wall Film Equations.

frozen_flux(*args, **kwargs)

Enables/disables frozen flux formulation for transient flows.

class heat_exchanger(path, service)

Bases: TUIMenu

Enters the heat exchanger menu.

Classes:

dual_cell_model(path, service)	Enters the dual cell model menu.
macro_model(path, service)	Enters the heat macro-model menu.

class dual_cell_model(path, service)

Bases: TUIMenu

Enters the dual cell model menu.

Methods:

add_heat_exchanger(*args, **kwargs)	Adds heat-exchanger.
alternative_formulation(*args, **kwargs)	Enables/disables alternative formulation for heat transfer calculations.
delete_heat_exchanger(*args, **kwargs)	Deletes heat-exchanger.
heat_exchanger(*args, **kwargs)	Enables/disables the dual cell heat-exchanger model.
modify_heat_exchanger(*args, **kwargs)	Modifies heat-exchanger.
plot_NTU(*args, **kwargs)	Plots NTU vs.
write_NTU(*args, **kwargs)	Writes NTU vs.

add_heat_exchanger(*args, **kwargs)

Adds heat-exchanger.

alternative_formulation(*args, **kwargs)

Enables/disables alternative formulation for heat transfer calculations.

delete_heat_exchanger(*args, **kwargs)

Deletes heat-exchanger.

heat_exchanger(*args, **kwargs)

Enables/disables the dual cell heat-exchanger model.

modify_heat_exchanger(*args, **kwargs)

Modifies heat-exchanger.

plot_NTU(*args, **kwargs)

Plots NTU vs. primary mass flow rate for each auxiliary mass flow rate.

write_NTU(*args, **kwargs)

Writes NTU vs. primary mass flow rate for each auxiliary mass flow rate.

class macro_model(path, service)

Bases: TUIMenu

Enters the heat macro-model menu.

Methods:

delete_heat_exchanger_group(*args, **kwargs)	Deletes heat-exchanger group.
heat_exchanger(*args, **kwargs)	Enables/disables heat-exchanger model.
heat_exchanger_group(*args, **kwargs)	Defines heat-exchanger group.
heat_exchanger_macro_report(*args, **kwargs)	Reports the computed values of heat rejection, outlet temperature, and inlet temperature for the macroscopic cells (macros) in a heat exchanger.
heat_exchanger_model(*args, **kwargs)	Defines heat-exchanger core model.
heat_exchanger_report(*args, **kwargs)	Reports the computed values of total heat rejection, outlet temperature, and inlet temperature for a specified heat-exchanger core.
heat_exchanger_zone(*args, **kwargs)	Specifies the zone that represents the heat exchanger, the dimensions of the heat exchanger, the macro grid, and the coolant direction and properties.
plot_NTU(*args, **kwargs)	Plots NTU vs.
write_NTU(*args, **kwargs)	Writes NTU vs.

delete_heat_exchanger_group(*args, **kwargs)

Deletes heat-exchanger group.

heat_exchanger(*args, **kwargs)

Enables/disables heat-exchanger model.

heat_exchanger_group(*args, **kwargs)

Defines heat-exchanger group.

heat_exchanger_macro_report(*args, **kwargs)

Reports the computed values of heat rejection, outlet temperature, and inlet temperature for the macroscopic cells (macros) in a heat exchanger.

heat_exchanger_model(*args, **kwargs)

Defines heat-exchanger core model.

heat_exchanger_report(*args, **kwargs)

Reports the computed values of total heat rejection, outlet temperature, and inlet temperature for a specified heat-exchanger core.

heat_exchanger_zone(*args, **kwargs)

Specifies the zone that represents the heat exchanger, the dimensions of the heat exchanger, the macro grid, and the coolant direction and properties.

plot_NTU(*args, **kwargs)

Plots NTU vs. primary mass flow rate for each auxiliary mass flow rate.

write_NTU(*args, **kwargs)

Writes NTU vs. primary mass flow rate for each auxiliary mass flow rate.

class multiphase(path, service)

Bases: TUIMenu

Enters the multiphase model menu.

Methods:

body_force_formulation(*args, **kwargs)	Specifies body force formulation.
coupled_level_set(*args, **kwargs)	Enables coupled level set interface tracking method.
interface_modeling_options(*args, **kwargs)	Specifies interface modeling options.
mixture_parameters(*args, **kwargs)	Specifies mixture parameters.
model(*args, **kwargs)	Specifies multiphase model.
number_of_phases(*args, **kwargs)	Specifies the number of phases.
regime_transition_modeling(*args, **kwargs)	Enables the Algebraic Interfacial Area Density (AIAD) model and sets the AIAD secondary continuous phase and the secondary entrained phase.
vof_sub_models(*args, **kwargs)	Enables the Open Channel sub-model and/or the Open Channel Wave Boundary Condition sub-model.
volume_fraction_parameters(*args, **kwargs)	Volume fraction parameters.

Classes:

explicit_expert_options(path, service)	Enters the menu to set explicit VOF expert options.
flow_regime_modeling(path, service)	Flow Regime Modeling.
hybrid_models(path, service)	Enter the menu to select hybrid models.
phases(path, service)	Enter the phases menu.
population_balance(path, service)	Enters the population balance models menu.
sub_models(path, service)	Enter the menu to select sub-models.
wet_steam(path, service)	Enters the wet steam model menu.

body_force_formulation(*args, **kwargs)

Specifies body force formulation.

coupled_level_set(*args, **kwargs)

Enables coupled level set interface tracking method.

class explicit_expert_options(path, service)

Bases: TUIMenu

Enters the menu to set explicit VOF expert options.

Methods:

solve_vof_every_iter(*args, **kwargs)	If you enter yes, the volume fraction equations will be solved every iteration.
sub_time_step_method(*args, **kwargs)	Selects the sub-time step method.

Classes:

volume_fraction_filtering(path, service)

Enters the volume fraction filtering menu.

solve_vof_every_iter(*args, **kwargs)

If you enter yes, the volume fraction equations will be solved every iteration. By default, the volume fraction equations will be solved only once per time step.

sub_time_step_method(*args, **kwargs)

Selects the sub-time step method.

class volume_fraction_filtering(path, service)

Bases: TUIMenu

Enters the volume fraction filtering menu.

Methods:

enable(*args, **kwargs)	Enables/disables the volume fraction filtering treatment.