solver.tui#

class ansys.fluent.core.solver.tui_232.main_menu(service, version, mode, path)#

Bases: TUIMenu

Fluent solver main menu.

Classes:

adjoint(service, version, mode, path)	Adjoint.
define(service, version, mode, path)	Enter the define menu.
display(service, version, mode, path)	Enter the display menu.
file(service, version, mode, path)	Enter the file menu.
icing(service, version, mode, path)	FENSAP-ICE options.
mesh(service, version, mode, path)	Enter the mesh menu.
parallel(service, version, mode, path)	Enter the parallel processing menu.
parametric_study(service, version, mode, path)	Enter the parametric study menu.
plot(service, version, mode, path)	Enter the XY plot menu.
preferences(service, version, mode, path)	Set preferences.
report(service, version, mode, path)	Enter the report menu.
results(service, version, mode, path)	.
server(service, version, mode, path)	Enter the server menu.
setup(service, version, mode, path)	Enter setup menu.
solution(service, version, mode, path)	.
solve(service, version, mode, path)	Enter the solve menu.
surface(service, version, mode, path)	Enter the data surface manipulation menu.
turbo_post(service, version, mode, path)	Enter the turbo menu.
turbo_workflow(service, version, mode, path)	Enter the turbo workflow menu.
views(service, version, mode, path)	.

Methods:

close_fluent(*args, **kwargs)	Exit program.
exit(*args, **kwargs)	Exit program.
print_license_usage(*args, **kwargs)	Print license usage information.
switch_to_meshing_mode(*args, **kwargs)	Switches from the solution mode to the meshing mode.

class adjoint(service, version, mode, path)#

Bases: TUIMenu

Adjoint.

Methods:

controls(*args, **kwargs)	Menu to configure adjoint solver controls.
design_tool(*args, **kwargs)	Enters the design-tool menu.
expert(*args, **kwargs)	Provides text commands that allow you to undo enhancements to the default adjoint solver behavior.
geometry(*args, **kwargs)	Geometry menu.
methods(*args, **kwargs)	Menu to configure adjoint solver settings.
monitors(*args, **kwargs)	Menu to configure monitors for the adjoint solver.
morphing(*args, **kwargs)	Morphing menu.
multi_objective(*args, **kwargs)	Multi-Objective menu.
observable(*args, **kwargs)	Menu to create and configure observables of interest.
optimizer(*args, **kwargs)	Enters the optimizer menu, where you can use a gradient-based optimizer to optimize the geometry to meet multiple goals for multiple observables at multiple operating conditions.
postprocess_options(*args, **kwargs)	Postprocess options.
reporting(*args, **kwargs)	Menu to report sensitivity data from the adjoint solution.
run(*args, **kwargs)	Menu to initialize and compute the adjoint solution.
utilities(*args, **kwargs)	Enters the utilities menu.

controls(*args, **kwargs)#

Menu to configure adjoint solver controls.

design_tool(*args, **kwargs)#

Enters the design-tool menu.

expert(*args, **kwargs)#

Provides text commands that allow you to undo enhancements to the default adjoint solver behavior.

geometry(*args, **kwargs)#

Geometry menu.

methods(*args, **kwargs)#

Menu to configure adjoint solver settings.

monitors(*args, **kwargs)#

Menu to configure monitors for the adjoint solver.

morphing(*args, **kwargs)#

Morphing menu.

multi_objective(*args, **kwargs)#

Multi-Objective menu.

observable(*args, **kwargs)#

Menu to create and configure observables of interest.

optimizer(*args, **kwargs)#

Enters the optimizer menu, where you can use a gradient-based optimizer to optimize the geometry to meet multiple goals for multiple observables at multiple operating conditions.

postprocess_options(*args, **kwargs)#

Postprocess options.

reporting(*args, **kwargs)#

Menu to report sensitivity data from the adjoint solution.

run(*args, **kwargs)#

Menu to initialize and compute the adjoint solution.

utilities(*args, **kwargs)#

Enters the utilities menu.

close_fluent(*args, **kwargs)#

Exit program.

class define(service, version, mode, path)#

Bases: TUIMenu

Enter the define menu.

Methods:

beta_feature_access(*args, **kwargs)	Enable access to beta features in the interface.
boundary_conditions(*args, **kwargs)	Enter the boundary conditions menu.
enable_expressions(*args, **kwargs)	Enable the expressions feature.
enable_mesh_morpher_optimizer(*args, **kwargs)	Enables the mesh morpher/optimizer.
geometry(*args, **kwargs)	Enter Geometry menu.
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:

curvilinear_coordinate_system(service, ...)	Curvilinear Coordinate System.
custom_field_functions(service, version, ...)	Enters the custom field functions menu.
dynamic_mesh(service, version, mode, path)	Enters the dynamic mesh menu.
gap_model(service, version, mode, path)	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(service, version, mode, path)	Enters the materials menu.
mesh_interfaces(service, version, mode, path)	Enters the mesh-interfaces menu.
mixing_planes(service, version, mode, path)	Enters the mixing planes menu.
models(service, version, mode, path)	Enters the models menu to configure the solver.
named_expressions(service, version, mode, path)	Enters the named expressions menu.
operating_conditions(service, version, mode, ...)	Enters the define operating conditions menu.
overset_interfaces(service, version, mode, path)	Enters the overset interfaces menu.
parameters(service, version, mode, path)	Enters the parameters menu.
periodic_conditions(service, version, mode, path)	Enters the periodic conditions menu.
phases(service, version, mode, path)	Enters the phases menu.
profiles(service, version, mode, path)	Enters the boundary profiles menu.
reference_frames(service, version, mode, path)	Enters the reference frames menu.
solution_strategy(service, version, mode, path)	Enters the automatic initialization and case modification strategy menu.
spectral(service, version, mode, path)	Enter the Spectral menu.
turbo_model(service, version, mode, path)	Enters the turbo menu.
user_defined(service, version, mode, path)	Enters the user-defined functions and scalars menu.
virtual_boundary(service, version, mode, path)	Manage Virtual Boundaries.

beta_feature_access(*args, **kwargs)#

Enable access to beta features in the interface.

boundary_conditions(*args, **kwargs)#

Enter the boundary conditions menu.

class curvilinear_coordinate_system(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

Bases: TUIMenu

Enters the dynamic mesh menu.

Classes:

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

Methods:

dynamic_mesh(*args, **kwargs)

Enables/disables the dynamic mesh solver.

class actions(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)	Enters the dynamic mesh contact-parameters menu.
implicit_update_parameters(service, version, ...)	Enters the dynamic mesh implicit update menu.
in_cylinder_parameters(service, version, ...)	Enters the dynamic mesh in-cylinder menu.
layering_parameters(service, version, mode, path)	Enters the dynamic mesh layering menu.
periodic_displacement_parameters(service, ...)	Enters the periodic displacement parameters menu.
remeshing_parameters(service, version, mode, ...)	Enters the dynamic mesh remeshing menu to set parameters for all remeshing methods.
six_dof_parameters(service, version, mode, path)	Enters the dynamic mesh six degrees of freedom (DOF) solver menu.
smoothing_parameters(service, version, mode, ...)	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(service, version, mode, path)#

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(service, version, ...)

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)	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(service, version, ...)	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(service, version, mode, path)	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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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_boundary_layers_with_adjacent_zone(...)	Enable smoothing of boundary layers solely on adjacent zone motion (Radial Basis Function).
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_boundary_layers_with_adjacent_zone(*args, **kwargs)#

Enable smoothing of boundary layers solely on adjacent zone motion (Radial Basis Function).

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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_expressions(*args, **kwargs)#

Enable the expressions feature.

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(service, version, mode, path)#

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(service, version, mode, path)

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(service, version, mode, path)#

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.

geometry(*args, **kwargs)#

Enter Geometry menu.

injections(*args, **kwargs)#

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

class materials(service, version, mode, path)#

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(service, version, mode, path)

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(service, version, mode, path)#

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(service, version, mode, path)#

Bases: TUIMenu

Enters the mesh-interfaces menu.

Classes:

auto_options(service, version, mode, path)	Enters the auto-options menu.
mapped_interface_options(service, version, ...)	Enter the mapped-interface-options menu.
non_conformal_interface_numerics(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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)

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(service, version, mode, path)#

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(service, version, mode, path)	Enters the menu to set swirl conservation in mixing plane menu.
conserve_total_enthalpy(service, version, ...)	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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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

Classes:

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

ablation(*args, **kwargs)#

Enables/disables the ablation model.

class acoustics(service, version, mode, path)#

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(service, version, mode, ...)	Enters the menu to specify the far-field density and speed of sound.
sources_fft(service, version, mode, path)	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(service, version, mode, path)	Manage sponge layers where density is blended to eliminate reflections from boundary zones.
wave_equation_options(service, version, ...)	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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, ...)

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

Bases: TUIMenu

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

Classes:

basic_shapes(service, version, mode, path)	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(service, version, ...)	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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

Bases: TUIMenu

Enters the cht (conjugate heat transfer) menu.

Classes:

explicit_time_averaged_coupling(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(service, version, mode, path)#

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(service, version, mode, path)#

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

clear_particles_from_domain(*args, **kwargs)#

Removes/keeps all particles currently in the domain.

class collisions(service, version, mode, path)#

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(service, version, mode, path)

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)	Enters the menu for setting erosion coupling with dynamic mesh.
run_parameters(service, version, mode, path)	Manages erosion-dynamic mesh run settings.

enable_erosion_dynamic_mesh_coupling(*args, **kwargs)#

Enables mesh deformation due to wall erosion.

class general_parameters(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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.
enhanced_source_term_linearization_enabled(...)	.
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.
second_order_time_accurate_sources_enabled(...)	.
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.

enhanced_source_term_linearization_enabled(*args, **kwargs)#

.

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.

second_order_time_accurate_sources_enabled(*args, **kwargs)#

.

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(service, version, mode, path)#

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.
limit_granular_forces(*args, **kwargs)	Enable limiting of granular forces from solid pressure gradients to avoid particle velocity overshoots.
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.
packed_region_detection_enabled(*args, **kwargs)	Identify cells in packed region to apply limiting of granular forces.
predictor_corrector(*args, **kwargs)	Enable predictor/corrector approach to track particles.
re_randomize_every_iteration(*args, **kwargs)	Determines whether or not the initial particle positions will vary from iteration to iteration.
re_randomize_every_timestep(*args, **kwargs)	Determines whether or not the initial particle positions will vary from time step to time step.
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(service, version, ...)

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(service, version, mode, path)#

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.
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.
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_legacy_particle_location_method(*args, ...)	Enable legacy method of locating particles in cells.
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.
wallfilm_relocation_tolerance(*args, **kwargs)	Set the relocation tolerance for wallfilm particles after remeshing.

Classes:

barycentric_interpolation(service, version, ...)	Enter the barycentric interpolation menu.
particle_relocation(service, version, mode, path)	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(service, version, mode, path)#

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.

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.

class particle_relocation(service, version, mode, path)#

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_legacy_particle_location_method(*args, **kwargs)#

Enable legacy method of locating particles in cells.

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.

wallfilm_relocation_tolerance(*args, **kwargs)#

Set the relocation tolerance for wallfilm particles after remeshing.

limit_granular_forces(*args, **kwargs)#

Enable limiting of granular forces from solid pressure gradients to avoid particle velocity overshoots.

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.

packed_region_detection_enabled(*args, **kwargs)#

Identify cells in packed region to apply limiting of granular forces.

predictor_corrector(*args, **kwargs)#

Enable predictor/corrector approach to track particles.

re_randomize_every_iteration(*args, **kwargs)#

Determines whether or not the initial particle positions will vary from iteration to iteration.

re_randomize_every_timestep(*args, **kwargs)#

Determines whether or not the initial particle positions will vary from time step to time step.

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(service, version, mode, path)#

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.
film_movement(*args, **kwargs)	.
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.

film_movement(*args, **kwargs)#

.

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(service, version, mode, path)#

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(service, version, mode, path)

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(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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_setup(service, version, mode, path)#

Bases: TUIMenu

Enter the electrolysis and H2 pump model setup menu.

Classes:

advanced_setup(service, version, mode, path)	Enter the menu for the advanced controls.
anode_setup(service, version, mode, path)	Enter the menu for the anode controls.
cathode_setup(service, version, mode, path)	Enter the menu for the cathode controls.
membrane_setup(service, version, mode, path)	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 advanced_setup(service, version, mode, path)#

Bases: TUIMenu

Enter the menu for the advanced controls.

Methods:

contact_resistivity(*args, **kwargs)

Set Contact Resistivity.

contact_resistivity(*args, **kwargs)#

Set Contact Resistivity.

class anode_setup(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

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

.

class eulerian_wallfilm(service, version, mode, path)#

Bases: TUIMenu

Enters the Eulerian wall film model menu.

Classes:

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

Methods:

enable_film_nci_support(*args, **kwargs)	Enable wall film fluid-fluid NCI support.
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(service, version, mode, path)#

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_nci_support(*args, **kwargs)#

Enable wall film fluid-fluid NCI support.

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(service, version, mode, path)#

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(service, version, mode, path)#

Bases: TUIMenu

Enters the heat exchanger menu.

Classes:

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

class dual_cell_model(service, version, mode, path)#

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(service, version, mode, path)#

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(service, version, mode, path)#

Bases: TUIMenu

Enters the multiphase model menu.

Methods:

body_force_formulation(*args, **kwargs)	Specifies body force formulation.
boiling_model_options(*args, **kwargs)	Specifies the boiling model options.
coupled_level_set(*args, **kwargs)	Enables coupled level set interface tracking method.
eulerian_parameters(*args, **kwargs)	Specifies Eulerian parameters.
expert_options(*args, **kwargs)	Expert Options.
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(service, version, ...)	Enters the menu to set explicit VOF expert options.
flow_regime_modeling(service, version, mode, ...)	Flow Regime Modeling.
hybrid_models(service, version, mode, path)	Enter the menu to select hybrid models.
population_balance(service, version, mode, path)	Enters the population balance models menu.
sub_models(service, version, mode, path)	Enter the menu to select sub-models.
wet_steam(service, version, mode, path)	Enters the wet steam model menu.

body_force_formulation(*args, **kwargs)#

Specifies body force formulation.

boiling_model_options(*args, **kwargs)#

Specifies the boiling model options. You can choose theRPI boiling model,Non-equilibrium boiling, orCritical heat flux.

coupled_level_set(*args, **kwargs)#

Enables coupled level set interface tracking method.

eulerian_parameters(*args, **kwargs)#

Specifies Eulerian parameters.

expert_options(*args, **kwargs)#

Expert Options.

class explicit_expert_options(service, version, mode, path)#

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(service, version, ...)

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(service, version, mode, path)#

Bases: TUIMenu

Enters the volume fraction filtering menu.

Methods:

enable(*args, **kwargs)	Enables/disables the volume fraction filtering treatment.
filtering_options(*args, **kwargs)	Selects the volume fraction filtering method.
vol_frac_cutoff(*args, **kwargs)	Specifies a cut-off value for the volume fraction filtering.

enable(*args, **kwargs)#

Enables/disables the volume fraction filtering treatment.

filtering_options(*args, **kwargs)#

Selects the volume fraction filtering method. This command becomes available once the define/models/multiphase/explicit-expert-options/volume-fraction-filtering/enable? text option has been set to yes.

vol_frac_cutoff(*args, **kwargs)#

Specifies a cut-off value for the volume fraction filtering. This command becomes available after you select the node averaged cutoff method using the define/models/multiphase/explicit-expert-options/volume-fraction-filtering/filtering-options text command.

class flow_regime_modeling(service, version, mode, path)#

Bases: TUIMenu

Flow Regime Modeling.

Classes:

aiad_parameters(service, version, mode, path)

AIAD parameters.

Methods:

enable(*args, **kwargs)

Enable flow regime modeling framework including phase state and morphology.

class aiad_parameters(service, version, mode, path)#

Bases: TUIMenu

AIAD parameters.

Methods:

critical_vf(*args, **kwargs)	Critical volume fraction for bubbly and droplet flow blending factors.
delta_grad(*args, **kwargs)	Parameter for determining transition width for free surface blending factor.
delta_vf(*args, **kwargs)	Parameter for transition width for bubbly and droplet flow blending factors.
ncells_fs(*args, **kwargs)	Parameter for determining interfacial width.

critical_vf(*args, **kwargs)#

Critical volume fraction for bubbly and droplet flow blending factors.

delta_grad(*args, **kwargs)#

Parameter for determining transition width for free surface blending factor.

delta_vf(*args, **kwargs)#

Parameter for transition width for bubbly and droplet flow blending factors.

ncells_fs(*args, **kwargs)#

Parameter for determining interfacial width.

enable(*args, **kwargs)#

Enable flow regime modeling framework including phase state and morphology.

class hybrid_models(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to select hybrid models.

Methods:

ddpm(*args, **kwargs)	Enable the dense discrete phase model.
multi_fluid_vof(*args, **kwargs)	Enable the multi-fluid VOF model.

ddpm(*args, **kwargs)#

Enable the dense discrete phase model.

multi_fluid_vof(*args, **kwargs)#

Enable the multi-fluid VOF model.

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.

class population_balance(service, version, mode, path)#

Bases: TUIMenu

Enters the population balance models menu.

Classes:

expert(service, version, mode, path)	Enter the expert menu for quadrature-based population balance method.
phenomena(service, version, mode, path)	Enters the phenomena menu for population balance.

Methods:

include_expansion(*args, **kwargs)	Set expansion.
model(*args, **kwargs)	Allows you to select the population balance model and set its parameters.
size_calculator(*args, **kwargs)	Gives you recommendations for appropriate bubble sizes and/or droplet size limits.

class expert(service, version, mode, path)#

Bases: TUIMenu

Enter the expert menu for quadrature-based population balance method.

Classes:

qmom(service, version, mode, path)

.

class qmom(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

inversion_algorithm(*args, **kwargs)	Select the inversion algorithm for quadrature-based population balance method.
print_realizable_moment_warning(*args, **kwargs)	Print the information for realizable moments in the population balance model.
realizable_moments(*args, **kwargs)	Set the population balance model.
retain_qmom_sources_for_low_vof(*args, **kwargs)	Retain qmom source calculation for low secondary phase vof.

inversion_algorithm(*args, **kwargs)#

Select the inversion algorithm for quadrature-based population balance method.

print_realizable_moment_warning(*args, **kwargs)#

Print the information for realizable moments in the population balance model.

realizable_moments(*args, **kwargs)#

Set the population balance model.

retain_qmom_sources_for_low_vof(*args, **kwargs)#

Retain qmom source calculation for low secondary phase vof.

include_expansion(*args, **kwargs)#

Set expansion.

model(*args, **kwargs)#

Allows you to select the population balance model and set its parameters.

class phenomena(service, version, mode, path)#

Bases: TUIMenu

Enters the phenomena menu for population balance.

Methods:

aggregation(*args, **kwargs)	Sets the aggregation kernel.
aggregation_factor(*args, **kwargs)	Specifies a factor that controls the intensity of the selected aggregation kernel.
breakage(*args, **kwargs)	Set the breakage kernel.
breakage_aggregation_vof_cutoff(*args, **kwargs)	Specifies a cutoff limit for the volume fraction values for the breakage and aggregation kernels.
breakage_factor(*args, **kwargs)	Specifies a factor that controls the intensity of the selected breakage kernel.
growth(*args, **kwargs)	Specifies the growth rate.
nucleation(*args, **kwargs)	Specifies the nucleation rate.

aggregation(*args, **kwargs)#

Sets the aggregation kernel.

aggregation_factor(*args, **kwargs)#

Specifies a factor that controls the intensity of the selected aggregation kernel.

breakage(*args, **kwargs)#

Set the breakage kernel.

breakage_aggregation_vof_cutoff(*args, **kwargs)#

Specifies a cutoff limit for the volume fraction values for the breakage and aggregation kernels.

breakage_factor(*args, **kwargs)#

Specifies a factor that controls the intensity of the selected breakage kernel.

growth(*args, **kwargs)#

Specifies the growth rate.

nucleation(*args, **kwargs)#

Specifies the nucleation rate.

size_calculator(*args, **kwargs)#

Gives you recommendations for appropriate bubble sizes and/or droplet size limits.

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. Entering 0 as a phase ID cancels any previous phase selection. Note that you must define the phases in your simulation using the define/phases/ text command prior to using the regime-transition-modeling text command. This option is available only with the Eulerian multiphase model.

class sub_models(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to select sub-models.

Methods:

boiling(*args, **kwargs)

Activate boiling model.

Classes:

boiling_options(service, version, mode, path)

Set boiling options.

boiling(*args, **kwargs)#

Activate boiling model.

class boiling_options(service, version, mode, path)#

Bases: TUIMenu

Set boiling options.

Methods:

nlbf_model(*args, **kwargs)	Set the non-local boundary field correction.
options(*args, **kwargs)	Choose the type of boiling model.

nlbf_model(*args, **kwargs)#

Set the non-local boundary field correction.

options(*args, **kwargs)#

Choose the type of boiling model.

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.

class wet_steam(service, version, mode, path)#

Bases: TUIMenu

Enters the wet steam model menu.

Methods:

compile_user_defined_wetsteam_functions(...)	Compiles user-defined wet steam library.
enable(*args, **kwargs)	Enables/disables the wet steam model.
load_unload_user_defined_wetsteam_library(...)	Loads or unloads user-defined wet steam library.

Classes:

set(service, version, mode, path)

Enters the set menu for setting wet steam model options.

compile_user_defined_wetsteam_functions(*args, **kwargs)#

Compiles user-defined wet steam library.

enable(*args, **kwargs)#

Enables/disables the wet steam model.

load_unload_user_defined_wetsteam_library(*args, **kwargs)#

Loads or unloads user-defined wet steam library.

class set(service, version, mode, path)#

Bases: TUIMenu

Enters the set menu for setting wet steam model options.

Methods:

droplet_growth_rate(*args, **kwargs)	S formulation (default) or Hill.
max_liquid_mass_fraction(*args, **kwargs)	Sets the maximum limit on the condensed liquid-phase mass-fraction to prevent divergence.
rgp_tables(*args, **kwargs)	Sets the RGP (real gas property) table to be used with the Wet Steam model.
stagnation_conditions(*args, **kwargs)	Computes stagnation conditions using either gas phase only, or mixture.
virial_equation(*args, **kwargs)	Sets the equation of state for steam to either Vukalovich formulation (default) or Young formulation.
zonal_phase_change(*args, **kwargs)	Select cell zones where phase change process is active.

droplet_growth_rate(*args, **kwargs)#

S formulation (default) or Hill.

max_liquid_mass_fraction(*args, **kwargs)#

Sets the maximum limit on the condensed liquid-phase mass-fraction to prevent divergence.

rgp_tables(*args, **kwargs)#

Sets the RGP (real gas property) table to be used with the Wet Steam model.

stagnation_conditions(*args, **kwargs)#

Computes stagnation conditions using either gas phase only, or mixture. For details, see .

virial_equation(*args, **kwargs)#

Sets the equation of state for steam to either Vukalovich formulation (default) or Young formulation.

zonal_phase_change(*args, **kwargs)#

Select cell zones where phase change process is active.

noniterative_time_advance(*args, **kwargs)#

Enables/disables noniterative time advancement scheme.

nox(*args, **kwargs)#

Enables/disables the NOx model.

class nox_parameters(service, version, mode, path)#

Bases: TUIMenu

Enters the NOx parameters menu.

Methods:

inlet_diffusion(*args, **kwargs)	Enables/disables inclusion of diffusion at inlets.
nox_chemistry(*args, **kwargs)	Selects NOx chemistry model.
nox_expert(*args, **kwargs)	Selects additional NOx equations.
nox_turbulence_interaction(*args, **kwargs)	Sets NOx turbulence interaction model.

inlet_diffusion(*args, **kwargs)#

Enables/disables inclusion of diffusion at inlets.

nox_chemistry(*args, **kwargs)#

Selects NOx chemistry model.

nox_expert(*args, **kwargs)#

Selects additional NOx equations.

nox_turbulence_interaction(*args, **kwargs)#

Sets NOx turbulence interaction model.

class optics(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

beams(service, version, mode, path)	.
statistics(service, version, mode, path)	.

Methods:

enable(*args, **kwargs)	.
index_of_refraction(*args, **kwargs)	.
report(*args, **kwargs)	.
sampling_iterations(*args, **kwargs)	.
verbosity(*args, **kwargs)	.

class beams(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

add(*args, **kwargs)	Create a new beams object.
copy(*args, **kwargs)	.
delete(*args, **kwargs)	Delete beams object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit beams object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename beams object.

add(*args, **kwargs)#

Create a new beams object.

copy(*args, **kwargs)#

.

delete(*args, **kwargs)#

Delete beams object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit beams object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename beams object.

enable(*args, **kwargs)#

.

index_of_refraction(*args, **kwargs)#

.

report(*args, **kwargs)#

.

sampling_iterations(*args, **kwargs)#

.

class statistics(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

reset_statistics(*args, **kwargs)	.
statistics_controls(*args, **kwargs)	.

reset_statistics(*args, **kwargs)#

.

statistics_controls(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

.

potential_and_li_ion_battery(*args, **kwargs)#

Enables/disables the electric-potential model.

class radiation(service, version, mode, path)#

Bases: TUIMenu

Enters the radiation models menu.

Methods:

apply_full_solar_irradiation(*args, **kwargs)	Enables/disables the application of the complete solar load to the first wavelength band only, reverting to the pre-2019 R1 behavior of the Solar Load and Discrete Ordinates models.
beta_radiation_features(*args, **kwargs)	Enable Radiation Models with Non-Iterative Time Advancement (NITA) as Beta features in FL12.0.
blending_factor(*args, **kwargs)	Sets numeric option for Discrete Ordinate model.
discrete_ordinates(*args, **kwargs)	Enables/disables discrete ordinates radiation model.
discrete_transfer(*args, **kwargs)	Enables/disables discrete transfer radiation model.
do_acceleration(*args, **kwargs)	Enables/disables the acceleration of the discrete ordinates (DO) radiation model calculations.
do_coupling(*args, **kwargs)	Enables/disables DO/energy coupling.
fast_second_order_discrete_ordinate(*args, ...)	Enables/disables the fast-second-order option for Discrete Ordinate Model.
mc_model_parameters(*args, **kwargs)	Specifies Monte Carlo model parameters.
mc_under_relaxation(*args, **kwargs)	Sets the under-relaxation factor for Monte Carlo radiation sources used in the energy equation.
method_partially_specular_wall(*args, **kwargs)	Sets the method for partially specular wall with discrete ordinate model.
montecarlo(*args, **kwargs)	Enables/disables the Monte Carlo radiation model.
non_gray_model_parameters(*args, **kwargs)	Sets parameters for non-gray model.
p1(*args, **kwargs)	Enables/disables P1 radiation model.
radiation_iteration_parameters(*args, **kwargs)	Sets iteration parameters for radiation models.
radiation_model_parameters(*args, **kwargs)	Set parameters for radiation models.
rosseland(*args, **kwargs)	Enables/disables Rosseland radiation model.
s2s(*args, **kwargs)	Enables/disables S2S radiation model.
solar(*args, **kwargs)	Enables/disables solar model.
solar_calculator(*args, **kwargs)	Calculates sun direction and intensity.
solar_irradiation(*args, **kwargs)	Enables/disables the solar irradiation model.
solution_method_for_do_coupling(*args, **kwargs)	Enables/disables the solution method for DO/energy coupling.
target_cells_per_volume_cluster(*args, **kwargs)	Sets the amount of coarsening of the radiation mesh for the Monte Carlo radiation model.
wsggm_cell_based(*args, **kwargs)	Enables/disables WSGGM cell based method.

Classes:

dtrm_parameters(service, version, mode, path)	Enters the dtrm parameters menu.
s2s_parameters(service, version, mode, path)	Enters the S2S parameters menu.
solar_parameters(service, version, mode, path)	Enters the solar parameters menu.

apply_full_solar_irradiation(*args, **kwargs)#

Enables/disables the application of the complete solar load to the first wavelength band only, reverting to the pre-2019 R1 behavior of the Solar Load and Discrete Ordinates models.

beta_radiation_features(*args, **kwargs)#

Enable Radiation Models with Non-Iterative Time Advancement (NITA) as Beta features in FL12.0.

blending_factor(*args, **kwargs)#

Sets numeric option for Discrete Ordinate model. Make sure thatSecond Order Upwind is selected for the Discrete Ordinates spatial discretization for the blending-factor option to appear in the text command list.

discrete_ordinates(*args, **kwargs)#

Enables/disables discrete ordinates radiation model.

discrete_transfer(*args, **kwargs)#

Enables/disables discrete transfer radiation model.

do_acceleration(*args, **kwargs)#

Enables/disables the acceleration of the discrete ordinates (DO) radiation model calculations. Note that this text command is only available when running on Linux in parallel.

do_coupling(*args, **kwargs)#

Enables/disables DO/energy coupling.

class dtrm_parameters(service, version, mode, path)#

Bases: TUIMenu

Enters the dtrm parameters menu.

Methods:

check_ray_file(*args, **kwargs)	Reads DTRM rays file.
controls(*args, **kwargs)	Sets dtrm solution controls.
make_globs(*args, **kwargs)	Makes globs (coarser mesh) for radiation.
ray_trace(*args, **kwargs)	Creates DTRM rays for radiation.

check_ray_file(*args, **kwargs)#

Reads DTRM rays file.

controls(*args, **kwargs)#

Sets dtrm solution controls.

make_globs(*args, **kwargs)#

Makes globs (coarser mesh) for radiation.

ray_trace(*args, **kwargs)#

Creates DTRM rays for radiation.

fast_second_order_discrete_ordinate(*args, **kwargs)#

Enables/disables the fast-second-order option for Discrete Ordinate Model.

mc_model_parameters(*args, **kwargs)#

Specifies Monte Carlo model parameters. This text command is available only when the Monte Carlo model is enabled.

mc_under_relaxation(*args, **kwargs)#

Sets the under-relaxation factor for Monte Carlo radiation sources used in the energy equation.

method_partially_specular_wall(*args, **kwargs)#

Sets the method for partially specular wall with discrete ordinate model.

montecarlo(*args, **kwargs)#

Enables/disables the Monte Carlo radiation model.

non_gray_model_parameters(*args, **kwargs)#

Sets parameters for non-gray model.

p1(*args, **kwargs)#

Enables/disables P1 radiation model.

radiation_iteration_parameters(*args, **kwargs)#

Sets iteration parameters for radiation models.

radiation_model_parameters(*args, **kwargs)#

Set parameters for radiation models.

rosseland(*args, **kwargs)#

Enables/disables Rosseland radiation model.

s2s(*args, **kwargs)#

Enables/disables S2S radiation model.

class s2s_parameters(service, version, mode, path)#

Bases: TUIMenu

Enters the S2S parameters menu.

Methods:

compute_clusters_and_vf_accelerated(*args, ...)	.
compute_fpsc_values(*args, **kwargs)	Computes only fpsc values based on current settings.
compute_vf_accelerated(*args, **kwargs)	.
compute_vf_only(*args, **kwargs)	Computes/writes view factors only.
compute_write_vf(*args, **kwargs)	Computes/writes surface clusters and view factors for S2S radiation model.
enable_mesh_interface_clustering(*args, **kwargs)	Enables surface clusters on mesh interfaces.
non_participating_boundary_zones_temperature(...)	Sets temperature for the non-participating boundary zones.
print_thread_clusters(*args, **kwargs)	Prints the following for all boundary threads: thread-id, number of faces, faces per surface cluster, and the number of surface clusters.
print_zonewise_radiation(*args, **kwargs)	Prints the zonewise incoming radiation, viewfactors, and average temperature.
read_vf_file(*args, **kwargs)	Reads S2S file.
set_global_faces_per_surface_cluster(*args, ...)	Sets global value of faces per surface cluster for all boundary zones.
set_vf_parameters(*args, **kwargs)	Sets the parameters needed for the viewfactor calculations.
split_angle(*args, **kwargs)	Sets split angle for the clustering algorithm.
use_new_cluster_algorithm(*args, **kwargs)	Uses the new surface clustering algorithm.
use_old_cluster_algorithm(*args, **kwargs)	Uses the old surface clustering algorithm.

compute_clusters_and_vf_accelerated(*args, **kwargs)#

.

compute_fpsc_values(*args, **kwargs)#

Computes only fpsc values based on current settings.

compute_vf_accelerated(*args, **kwargs)#

.

compute_vf_only(*args, **kwargs)#

Computes/writes view factors only.

compute_write_vf(*args, **kwargs)#

Computes/writes surface clusters and view factors for S2S radiation model.

enable_mesh_interface_clustering(*args, **kwargs)#

Enables surface clusters on mesh interfaces.

non_participating_boundary_zones_temperature(*args, **kwargs)#

Sets temperature for the non-participating boundary zones.

print_thread_clusters(*args, **kwargs)#

Prints the following for all boundary threads: thread-id, number of faces, faces per surface cluster, and the number of surface clusters.

print_zonewise_radiation(*args, **kwargs)#

Prints the zonewise incoming radiation, viewfactors, and average temperature.

read_vf_file(*args, **kwargs)#

Reads S2S file.

set_global_faces_per_surface_cluster(*args, **kwargs)#

Sets global value of faces per surface cluster for all boundary zones.

set_vf_parameters(*args, **kwargs)#

Sets the parameters needed for the viewfactor calculations.

split_angle(*args, **kwargs)#

Sets split angle for the clustering algorithm.

use_new_cluster_algorithm(*args, **kwargs)#

Uses the new surface clustering algorithm.

use_old_cluster_algorithm(*args, **kwargs)#

Uses the old surface clustering algorithm.

solar(*args, **kwargs)#

Enables/disables solar model.

solar_calculator(*args, **kwargs)#

Calculates sun direction and intensity.

solar_irradiation(*args, **kwargs)#

Enables/disables the solar irradiation model.

class solar_parameters(service, version, mode, path)#

Bases: TUIMenu

Enters the solar parameters menu.

Methods:

autoread_solar_data(*args, **kwargs)	Sets autoread solar data parameters.
autosave_solar_data(*args, **kwargs)	Sets autosave solar data parameters.
ground_reflectivity(*args, **kwargs)	Sets ground reflectivity parameters.
illumination_parameters(*args, **kwargs)	Sets illumination parameters.
iteration_parameters(*args, **kwargs)	Sets update parameters.
quad_tree_parameters(*args, **kwargs)	Sets quad-tree refinement parameters.
scattering_fraction(*args, **kwargs)	Sets scattering fraction parameters.
sol_adjacent_fluidcells(*args, **kwargs)	Sets solar load on for adjacent fluid cells.
sol_camera_pos(*args, **kwargs)	Sets camera position based on sun direction vector.
sol_on_demand(*args, **kwargs)	Sets solar load on demand.
solar_thread_control(*args, **kwargs)	Sets the number of threads to run the solar flux calculation.
sun_direction_vector(*args, **kwargs)	Sets sun direction vector.
use_direction_from_sol_calc(*args, **kwargs)	Sets direction computed from solar calculator.

autoread_solar_data(*args, **kwargs)#

Sets autoread solar data parameters.

autosave_solar_data(*args, **kwargs)#

Sets autosave solar data parameters.

ground_reflectivity(*args, **kwargs)#

Sets ground reflectivity parameters.

illumination_parameters(*args, **kwargs)#

Sets illumination parameters.

iteration_parameters(*args, **kwargs)#

Sets update parameters.

quad_tree_parameters(*args, **kwargs)#

Sets quad-tree refinement parameters.

scattering_fraction(*args, **kwargs)#

Sets scattering fraction parameters.

sol_adjacent_fluidcells(*args, **kwargs)#

Sets solar load on for adjacent fluid cells.

sol_camera_pos(*args, **kwargs)#

Sets camera position based on sun direction vector.

sol_on_demand(*args, **kwargs)#

Sets solar load on demand.

solar_thread_control(*args, **kwargs)#

Sets the number of threads to run the solar flux calculation. This item appears only when running in parallel with nodes located on a separate machine from the one running the host process andSolar Ray Tracing is enabled.

sun_direction_vector(*args, **kwargs)#

Sets sun direction vector.

use_direction_from_sol_calc(*args, **kwargs)#

Sets direction computed from solar calculator.

solution_method_for_do_coupling(*args, **kwargs)#

Enables/disables the solution method for DO/energy coupling.

target_cells_per_volume_cluster(*args, **kwargs)#

Sets the amount of coarsening of the radiation mesh for the Monte Carlo radiation model. A number greater than one implies coarsening, whereas equal to one implies no coarsening.

wsggm_cell_based(*args, **kwargs)#

Enables/disables WSGGM cell based method. Note that when enabled, the wsggm-cell-based option will become available in theAbsorption Coefficient drop-down list in the Create/Edit Materials dialog box.

class shell_conduction(service, version, mode, path)#

Bases: TUIMenu

Enters the shell conduction models menu.

Methods:

enhanced_encapsulation(*args, **kwargs)	Enables/disables an enhanced routine for the encapsulation of coupled walls during mesh partitioning that is enabled by default when shell conduction and/or the surface to surface (S2S) radiation model is used.
multi_layer_shell(*args, **kwargs)	Enables/disables the ability to define multi-layer shell conduction for walls.
read_csv(*args, **kwargs)	Defines the shell conduction settings by reading a CSV file.
save_shell_zones(*args, **kwargs)	Enables the saving of shell zones to case files.
settings(*args, **kwargs)	Enables shell conduction and defines the settings for any wall or group of walls by manually entering the number and properties of the layers.
write_csv(*args, **kwargs)	Writes your saved shell conduction settings to a CSV file.

enhanced_encapsulation(*args, **kwargs)#

Enables/disables an enhanced routine for the encapsulation of coupled walls during mesh partitioning that is enabled by default when shell conduction and/or the surface to surface (S2S) radiation model is used.

multi_layer_shell(*args, **kwargs)#

Enables/disables the ability to define multi-layer shell conduction for walls. Note that the warped-face gradient correction (WFGC) is not supported when multi-layer shells are disabled.

read_csv(*args, **kwargs)#

Defines the shell conduction settings by reading a CSV file.

save_shell_zones(*args, **kwargs)#

Enables the saving of shell zones to case files.

settings(*args, **kwargs)#

Enables shell conduction and defines the settings for any wall or group of walls by manually entering the number and properties of the layers.

write_csv(*args, **kwargs)#

Writes your saved shell conduction settings to a CSV file.

solidification_melting(*args, **kwargs)#

Enables/disables the solidification and melting model.

class solver(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to select the solver.

Methods:

adjust_solver_defaults_based_on_setup(*args, ...)	.
density_based_explicit(*args, **kwargs)	Enables/disables the density-based-explicit solver.
density_based_implicit(*args, **kwargs)	Enables/disables the density-based-implicit solver.
pressure_based(*args, **kwargs)	Enables/disables the pressure-based solver.

adjust_solver_defaults_based_on_setup(*args, **kwargs)#

.

density_based_explicit(*args, **kwargs)#

Enables/disables the density-based-explicit solver.

density_based_implicit(*args, **kwargs)#

Enables/disables the density-based-implicit solver.

pressure_based(*args, **kwargs)#

Enables/disables the pressure-based solver.

soot(*args, **kwargs)#

Enables/disables the soot model.

class soot_parameters(service, version, mode, path)#

Bases: TUIMenu

Enters the soot parameters menu.

Methods:

inlet_diffusion(*args, **kwargs)	Enables/disables inclusion of diffusion at inlets.
modify_schmidt_number(*args, **kwargs)	Changes the turbulent Schmidt number for soot/nuclei equations.
soot_model_parameters(*args, **kwargs)	Selects soot model parameters.
soot_model_udfs(*args, **kwargs)	User defined functions for soot model.
soot_process_parameters(*args, **kwargs)	Selects soot process parameters.
soot_radiation_interaction(*args, **kwargs)	Enables/disables the soot-radiation interaction model.
soot_turbulence_interaction(*args, **kwargs)	Sets soot-turbulence interaction model.

inlet_diffusion(*args, **kwargs)#

Enables/disables inclusion of diffusion at inlets.

modify_schmidt_number(*args, **kwargs)#

Changes the turbulent Schmidt number for soot/nuclei equations.

soot_model_parameters(*args, **kwargs)#

Selects soot model parameters.

soot_model_udfs(*args, **kwargs)#

User defined functions for soot model.

soot_process_parameters(*args, **kwargs)#

Selects soot process parameters.

soot_radiation_interaction(*args, **kwargs)#

Enables/disables the soot-radiation interaction model.

soot_turbulence_interaction(*args, **kwargs)#

Sets soot-turbulence interaction model.

class species(service, version, mode, path)#

Bases: TUIMenu

Enters the species models menu.

Methods:

CHEMKIN_CFD(*args, **kwargs)	Enables/disables the Ansys CHEMKIN-CFD solver.
clear_isat_table(*args, **kwargs)	Clears ISAT table.
coal_calculator(*args, **kwargs)	Sets up coal modeling inputs.
combustion_expert(*args, **kwargs)	Enables import of the CHEMKIN mechanism transport data.
combustion_numerics(*args, **kwargs)	Applies optimal solver settings automatically to provide a faster solution time.
decoupled_detailed_chemistry(*args, **kwargs)	Enables/disables the Decoupled Detailed Chemistry model.
diffusion_energy_source(*args, **kwargs)	Enables/disables diffusion energy source.
electro_chemical_surface_reactions(*args, ...)	Enables/disables electrochemical surface reactions.
epdf_energy(*args, **kwargs)	Enables/disables EPDF energy option.
flamelet_expert(*args, **kwargs)	Sets flamelet expert parameters.
full_tabulation(*args, **kwargs)	Enables/disables building of a full 2-mixture fraction table.
heat_of_surface_reactions(*args, **kwargs)	Enables/disables heat of surface reactions.
ignition_model(*args, **kwargs)	Enables/disables the ignition model.
ignition_model_controls(*args, **kwargs)	Sets ignition model parameters.
import_flamelet_for_restart(*args, **kwargs)	Imports Flamelet File for Restart.
inert_transport_controls(*args, **kwargs)	Sets inert transport model parameters.
inert_transport_model(*args, **kwargs)	Enables/disables the inert transport model.
init_unsteady_flamelet_prob(*args, **kwargs)	Initializes Unsteady Flamelet Probability.
inlet_diffusion(*args, **kwargs)	Enables/disables inclusion of diffusion at inlets.
integration_parameters(*args, **kwargs)	Sets chemistry ODE integrator parameters.
liquid_energy_diffusion(*args, **kwargs)	.
liquid_micro_mixing(*args, **kwargs)	Enables/disables liquid micro mixing.
mass_deposition_source(*args, **kwargs)	Enables/disables mass deposition source due to surface reactions.
mixing_model(*args, **kwargs)	Sets PDF Transport mixing model.
multicomponent_diffusion(*args, **kwargs)	Enables/disables multicomponent diffusion.
non_premixed_combustion(*args, **kwargs)	Enables/disables non-premixed combustion model.
non_premixed_combustion_expert(*args, **kwargs)	Sets PDF expert parameters.
non_premixed_combustion_parameters(*args, ...)	Sets PDF parameters.
off(*args, **kwargs)	Enables/disables solution of species models.
partially_premixed_combustion(*args, **kwargs)	Enables/disables partially premixed combustion model.
partially_premixed_combustion_expert(*args, ...)	Sets PDF expert parameters.
partially_premixed_combustion_grids(*args, ...)	Sets values for the grid distribution for PDF table or flamelet parameter.
partially_premixed_combustion_parameters(...)	Sets PDF parameters.
partially_premixed_properties(*args, **kwargs)	Sets/changes partially-premixed mixture properties.
particle_surface_reactions(*args, **kwargs)	Enables/disables particle surface reactions.
pdf_transport(*args, **kwargs)	Enables/disables the composition PDF transport combustion model.
pdf_transport_expert(*args, **kwargs)	Enables/disables PDF Transport expert user.
premixed_combustion(*args, **kwargs)	Enables/disables premixed combustion model.
premixed_model(*args, **kwargs)	Sets premixed combustion model.
re_calc_par_premix_props(*args, **kwargs)	Re-calculate partially-premixed properties.
reacting_channel_model(*args, **kwargs)	Enables/disables the Reacting Channel Model.
reacting_channel_model_options(*args, **kwargs)	Sets Reacting Channel Model parameters.
reaction_diffusion_balance(*args, **kwargs)	Enables/disables reaction diffusion balance at reacting surface for surface reactions.
reactor_network_model(*args, **kwargs)	Enables/disables the Reactor Network Model.
relax_to_equil(*args, **kwargs)	Enables/disables the Relaxation to Chemical Equilibrium model.
save_gradients(*args, **kwargs)	Enables/disables storage of species mass fraction gradients.
set_multi_regime_fgm(*args, **kwargs)	Set-multi-regim-fgm-parameters.
set_premixed_combustion(*args, **kwargs)	Sets premixed combustion parameters.
set_turb_chem_interaction(*args, **kwargs)	Sets EDC model constants.
spark_model(*args, **kwargs)	Switches between the R15 and R14.5 spark models and sets spark model parameters.
species_migration(*args, **kwargs)	Includes species migration in electric field.
species_transport(*args, **kwargs)	Enables/disables the species transport model.
species_transport_expert(*args, **kwargs)	Sets the convergence acceleration expert parameters.
stiff_chemistry(*args, **kwargs)	Enables/disables stiff chemistry option.
surf_reaction_aggressiveness_factor(*args, ...)	Sets the surface reaction aggressiveness factor.
surf_reaction_netm_params(*args, **kwargs)	Sets the surface reaction parameters for the Non-Equilibrium Thermal Model.
thermal_diffusion(*args, **kwargs)	Enables/disables thermal diffusion.
thickened_flame_model(*args, **kwargs)	Enables/disables the Relaxation to Chemical Equilibrium model.
volumetric_reactions(*args, **kwargs)	Enables/disables volumetric reactions.
wall_surface_reactions(*args, **kwargs)	Enables/disables wall surface reactions.
water_corrosion_pre(*args, **kwargs)	Compute water chemistry and set up corrosion material.

Classes:

CHEMKIN_CFD_parameters(service, version, ...)

Enters the expert CHEMKIN-CFD parameters menu.

CHEMKIN_CFD(*args, **kwargs)#

Enables/disables the Ansys CHEMKIN-CFD solver.

class CHEMKIN_CFD_parameters(service, version, mode, path)#

Bases: TUIMenu

Enters the expert CHEMKIN-CFD parameters menu.

Methods:

add_cell_monitor(*args, **kwargs)	Monitors cell for debug output.
advanced_options(*args, **kwargs)	Sets advanced parameter options.
basic_options(*args, **kwargs)	Sets basic parameter options.
delete_cell_monitors(*args, **kwargs)	Deletes cell monitors.
list_cell_monitors(*args, **kwargs)	Lists cell monitors.

add_cell_monitor(*args, **kwargs)#

Monitors cell for debug output.

advanced_options(*args, **kwargs)#

Sets advanced parameter options.

basic_options(*args, **kwargs)#

Sets basic parameter options.

delete_cell_monitors(*args, **kwargs)#

Deletes cell monitors.

list_cell_monitors(*args, **kwargs)#

Lists cell monitors.

clear_isat_table(*args, **kwargs)#

Clears ISAT table.

coal_calculator(*args, **kwargs)#

Sets up coal modeling inputs.

combustion_expert(*args, **kwargs)#

Enables import of the CHEMKIN mechanism transport data. When this option is enabled, you will be prompted for importing CHEMKIN transport property database when setting your combustion case.

combustion_numerics(*args, **kwargs)#

Applies optimal solver settings automatically to provide a faster solution time. This command is available only for transient non-premixed and partially premixed combustion models.

decoupled_detailed_chemistry(*args, **kwargs)#

Enables/disables the Decoupled Detailed Chemistry model.

diffusion_energy_source(*args, **kwargs)#

Enables/disables diffusion energy source.

electro_chemical_surface_reactions(*args, **kwargs)#

Enables/disables electrochemical surface reactions.

epdf_energy(*args, **kwargs)#

Enables/disables EPDF energy option.

flamelet_expert(*args, **kwargs)#

Sets flamelet expert parameters.

full_tabulation(*args, **kwargs)#

Enables/disables building of a full 2-mixture fraction table.

heat_of_surface_reactions(*args, **kwargs)#

Enables/disables heat of surface reactions.

ignition_model(*args, **kwargs)#

Enables/disables the ignition model.

ignition_model_controls(*args, **kwargs)#

Sets ignition model parameters.

import_flamelet_for_restart(*args, **kwargs)#

Imports Flamelet File for Restart.

inert_transport_controls(*args, **kwargs)#

Sets inert transport model parameters.

inert_transport_model(*args, **kwargs)#

Enables/disables the inert transport model.

init_unsteady_flamelet_prob(*args, **kwargs)#

Initializes Unsteady Flamelet Probability.

inlet_diffusion(*args, **kwargs)#

Enables/disables inclusion of diffusion at inlets.

integration_parameters(*args, **kwargs)#

Sets chemistry ODE integrator parameters. Enables/disables stiff chemistry acceleration methods and set their parameters.

liquid_energy_diffusion(*args, **kwargs)#

.

liquid_micro_mixing(*args, **kwargs)#

Enables/disables liquid micro mixing.

mass_deposition_source(*args, **kwargs)#

Enables/disables mass deposition source due to surface reactions.

mixing_model(*args, **kwargs)#

Sets PDF Transport mixing model.

multicomponent_diffusion(*args, **kwargs)#

Enables/disables multicomponent diffusion.

non_premixed_combustion(*args, **kwargs)#

Enables/disables non-premixed combustion model.

non_premixed_combustion_expert(*args, **kwargs)#

Sets PDF expert parameters.

non_premixed_combustion_parameters(*args, **kwargs)#

Sets PDF parameters.

off(*args, **kwargs)#

Enables/disables solution of species models.

partially_premixed_combustion(*args, **kwargs)#

Enables/disables partially premixed combustion model.

partially_premixed_combustion_expert(*args, **kwargs)#

Sets PDF expert parameters.

partially_premixed_combustion_grids(*args, **kwargs)#

Sets values for the grid distribution for PDF table or flamelet parameter. This text command is available only for partially premixed combustion cases with FGM.

partially_premixed_combustion_parameters(*args, **kwargs)#

Sets PDF parameters.

partially_premixed_properties(*args, **kwargs)#

Sets/changes partially-premixed mixture properties. This command is only available when partially-premixed-combustion? is enabled.

particle_surface_reactions(*args, **kwargs)#

Enables/disables particle surface reactions.

pdf_transport(*args, **kwargs)#

Enables/disables the composition PDF transport combustion model.

pdf_transport_expert(*args, **kwargs)#

Enables/disables PDF Transport expert user.

premixed_combustion(*args, **kwargs)#

Enables/disables premixed combustion model.

premixed_model(*args, **kwargs)#

Sets premixed combustion model.

re_calc_par_premix_props(*args, **kwargs)#

Re-calculate partially-premixed properties.

reacting_channel_model(*args, **kwargs)#

Enables/disables the Reacting Channel Model.

reacting_channel_model_options(*args, **kwargs)#

Sets Reacting Channel Model parameters.

reaction_diffusion_balance(*args, **kwargs)#

Enables/disables reaction diffusion balance at reacting surface for surface reactions.

reactor_network_model(*args, **kwargs)#

Enables/disables the Reactor Network Model.

relax_to_equil(*args, **kwargs)#

Enables/disables the Relaxation to Chemical Equilibrium model.

save_gradients(*args, **kwargs)#

Enables/disables storage of species mass fraction gradients.

set_multi_regime_fgm(*args, **kwargs)#

Set-multi-regim-fgm-parameters.

set_premixed_combustion(*args, **kwargs)#

Sets premixed combustion parameters.

set_turb_chem_interaction(*args, **kwargs)#

Sets EDC model constants.

spark_model(*args, **kwargs)#

Switches between the R15 and R14.5 spark models and sets spark model parameters.

species_migration(*args, **kwargs)#

Includes species migration in electric field. This command is available only when the electrochemical surface reactions are enabled.

species_transport(*args, **kwargs)#

Enables/disables the species transport model.

species_transport_expert(*args, **kwargs)#

Sets the convergence acceleration expert parameters. This command is only available when the species transport model is enabled.

stiff_chemistry(*args, **kwargs)#

Enables/disables stiff chemistry option.

surf_reaction_aggressiveness_factor(*args, **kwargs)#

Sets the surface reaction aggressiveness factor.

surf_reaction_netm_params(*args, **kwargs)#

Sets the surface reaction parameters for the Non-Equilibrium Thermal Model.

thermal_diffusion(*args, **kwargs)#

Enables/disables thermal diffusion.

thickened_flame_model(*args, **kwargs)#

Enables/disables the Relaxation to Chemical Equilibrium model.

volumetric_reactions(*args, **kwargs)#

Enables/disables volumetric reactions.

wall_surface_reactions(*args, **kwargs)#

Enables/disables wall surface reactions.

water_corrosion_pre(*args, **kwargs)#

Compute water chemistry and set up corrosion material.

steady(*args, **kwargs)#

Enables/disables the steady solution model.

class structure(service, version, mode, path)#

Bases: TUIMenu

Enters the structure model menu.

Classes:

controls(service, version, mode, path)	Enters the structure controls menu.
expert(service, version, mode, path)	Enters the structure expert menu.

Methods:

linear_elasticity(*args, **kwargs)	Enables the linear elasticity model.
nonlinear_elasticity(*args, **kwargs)	Enable the nonlinear elasticity model.
structure_off(*args, **kwargs)	Disables the structural model.
thermal_effects(*args, **kwargs)	.

class controls(service, version, mode, path)#

Bases: TUIMenu

Enters the structure controls menu.

Methods:

amg_stabilization(*args, **kwargs)	Sets the algebraic multigrid (AMG) stabilization method for the structural model calculations.
enhanced_strain(*args, **kwargs)	.
max_iter(*args, **kwargs)	Sets the maximum number of iterations for the structural model calculations.
numerical_damping_factor(*args, **kwargs)	Sets the damping factor for the structural model (that is, the amplitude decay factor in in the Theory Guide).
unsteady_damping_rayleigh(*args, **kwargs)	.

amg_stabilization(*args, **kwargs)#

Sets the algebraic multigrid (AMG) stabilization method for the structural model calculations.

enhanced_strain(*args, **kwargs)#

.

max_iter(*args, **kwargs)#

Sets the maximum number of iterations for the structural model calculations.

numerical_damping_factor(*args, **kwargs)#

Sets the damping factor for the structural model (that is, the amplitude decay factor in in the Theory Guide).

unsteady_damping_rayleigh(*args, **kwargs)#

.

class expert(service, version, mode, path)#

Bases: TUIMenu

Enters the structure expert menu.

Methods:

explicit_fsi_force(*args, **kwargs)	Enables/disables an explicit fluid-structure interaction force.
include_pop_in_fsi_force(*args, **kwargs)	Enables/disables the inclusion of operating pressure into the fluid-structure interaction force.
include_viscous_fsi_force(*args, **kwargs)	Enables/disables the inclusion of a viscous fluid-structure interaction force.
starting_t_re_initialization(*args, **kwargs)	.
steady_2way_fsi(*args, **kwargs)	.

explicit_fsi_force(*args, **kwargs)#

Enables/disables an explicit fluid-structure interaction force.

include_pop_in_fsi_force(*args, **kwargs)#

Enables/disables the inclusion of operating pressure into the fluid-structure interaction force.

include_viscous_fsi_force(*args, **kwargs)#

Enables/disables the inclusion of a viscous fluid-structure interaction force.

starting_t_re_initialization(*args, **kwargs)#

.

steady_2way_fsi(*args, **kwargs)#

.

linear_elasticity(*args, **kwargs)#

Enables the linear elasticity model.

nonlinear_elasticity(*args, **kwargs)#

Enable the nonlinear elasticity model.

structure_off(*args, **kwargs)#

Disables the structural model.

thermal_effects(*args, **kwargs)#

.

swirl(*args, **kwargs)#

Enables/disables axisymmetric swirl velocity.

class system_coupling_settings(service, version, mode, path)#

Bases: TUIMenu

Enters the system coupling menu.

Classes:

htc(service, version, mode, path)

Enter the heat transfer coeficient menu.

Methods:

specify_system_coupling_volumetric_cell_zones(...)	Enable/disable volumetric cell zones.
update_rigid_body_mesh_motion_before_mesh_transfer(...)	SC Enable/disable mesh motion.
use_face_or_element_based_data_transfer(...)	Answering yes at the prompt enables Fluent to use element data for mapping surface conservative quantities such as surface forces and heat flows.
user_defined_coupling_variables_via_udm(...)	User defined coupling variables via UDM.

class htc(service, version, mode, path)#

Bases: TUIMenu

Enter the heat transfer coeficient menu.

Classes:

htc_calculation_method(service, version, ...)	Enter the htc calculation menu.
unsteady_statistics(service, version, mode, path)	Enter the unsteady statistics menu.

class htc_calculation_method(service, version, mode, path)#

Bases: TUIMenu

Enter the htc calculation menu.

Methods:

use_tref_in_htc_calculation(*args, **kwargs)	Enable/disable tref in htc computation.
use_wall_function_based_htc(*args, **kwargs)	Enable/disable wall function based htc computation.
use_yplus_based_htc_calculation(*args, **kwargs)	Enable/disable yplus in htc computation.

use_tref_in_htc_calculation(*args, **kwargs)#

Enable/disable tref in htc computation.

use_wall_function_based_htc(*args, **kwargs)#

Enable/disable wall function based htc computation.

use_yplus_based_htc_calculation(*args, **kwargs)#

Enable/disable yplus in htc computation.

class unsteady_statistics(service, version, mode, path)#

Bases: TUIMenu

Enter the unsteady statistics menu.

Methods:

sc_enable_sub_stepping_option_per_coupling_step(...)

Enable/disable sub stepping option per coupling step.

sc_enable_sub_stepping_option_per_coupling_step(*args, **kwargs)#

Enable/disable sub stepping option per coupling step.

specify_system_coupling_volumetric_cell_zones(*args, **kwargs)#

Enable/disable volumetric cell zones.

update_rigid_body_mesh_motion_before_mesh_transfer(*args, **kwargs)#

SC Enable/disable mesh motion.

use_face_or_element_based_data_transfer(*args, **kwargs)#

Answering yes at the prompt enables Fluent to use element data for mapping surface conservative quantities such as surface forces and heat flows.

user_defined_coupling_variables_via_udm(*args, **kwargs)#

User defined coupling variables via UDM.

class two_temperature(service, version, mode, path)#

Bases: TUIMenu

Enters the Two-Temperature model menu.

Methods:

enable(*args, **kwargs)	Enables/disables the Two-Temperature model.
nasa9_enhancement(*args, **kwargs)	Apply nasa9 robustness enhancements in the two-temperature model.
robustness_enhancement(*args, **kwargs)	Enables/disables the robustness enhancement, which is on by default.
set_verbosity(*args, **kwargs)	Specifies the level of detail printed in the console about the Two-Temperature model.

enable(*args, **kwargs)#

Enables/disables the Two-Temperature model.

nasa9_enhancement(*args, **kwargs)#

Apply nasa9 robustness enhancements in the two-temperature model.

robustness_enhancement(*args, **kwargs)#

Enables/disables the robustness enhancement, which is on by default.

set_verbosity(*args, **kwargs)#

Specifies the level of detail printed in the console about the Two-Temperature model. For a verbosity of one, Fluent will print the number of cells that reach the temperature limit, have an excessive temperature change, or get a negative temperature.

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. This text command is only available for unsteady cases that use the density-based solver with the explicit 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. This text command is only available for transient simulations that use the structural model.

unsteady_structure_newmark(*args, **kwargs)#

Selects the Newmark method for the direct time integration of the finite element semi-discrete equation of motion. This text command is only available for transient simulations that use the structural model.

class virtual_blade_model(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

apply(*args, **kwargs)	.
enable(*args, **kwargs)	.
mode(*args, **kwargs)	.

Classes:

rotor(service, version, mode, path)

.

apply(*args, **kwargs)#

.

enable(*args, **kwargs)#

.

mode(*args, **kwargs)#

.

class rotor(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

delete(*args, **kwargs)	Delete rotor object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit rotor object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
new(*args, **kwargs)	Create a new rotor object.
rename(*args, **kwargs)	Rename rotor object.

delete(*args, **kwargs)#

Delete rotor object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit rotor object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

new(*args, **kwargs)#

Create a new rotor object.

rename(*args, **kwargs)#

Rename rotor object.

class viscous(service, version, mode, path)#

Bases: TUIMenu

Enters the viscous model menu.

Methods:

add_intermittency_transition_model(*args, ...)	Enable/disable the intermittency transition model to account for transitional effects.
add_transition_model(*args, **kwargs)	Sets Transition model to account for transitional effects.
buoyancy_effects(*args, **kwargs)	Enable/disable effects of buoyancy on turbulence.
corner_flow_correction(*args, **kwargs)	Enables/disables the corner flow correction.
corner_flow_correction_ccorner(*args, **kwargs)	Sets the strength of the quadratic term of the corner flow correction.
curvature_correction(*args, **kwargs)	Enables/disables the curvature correction.
curvature_correction_ccurv(*args, **kwargs)	Sets the strength of the curvature correction term.
des_limiter_option(*args, **kwargs)	Selects the DES limiter option (none, F1, F2, Delayed DES, or Improved Delayed DES).
detached_eddy_simulation(*args, **kwargs)	Enables/disables detached eddy simulation.
geko(*args, **kwargs)	Enable/disable the GEKO model.
inviscid(*args, **kwargs)	Enables/disables inviscid flow model.
k_kl_w(*args, **kwargs)	Enables/disables the k-kl- turbulence model.
ke1e(*args, **kwargs)	Enable/disable the KE1E turbulence model.
ke_easm(*args, **kwargs)	Enables/disables the EASM - turbulence model.
ke_realizable(*args, **kwargs)	Enables/disables the realizable - turbulence model.
ke_rng(*args, **kwargs)	Enables/disables the RNG - turbulence model.
ke_standard(*args, **kwargs)	Enables/disables the standard - turbulence model.
kw_bsl(*args, **kwargs)	Enables/disables the baseline (BSL) - turbulence model.
kw_buoyancy_effects(*args, **kwargs)	Enable/disable effects of buoyancy on k-omega turbulence model.
kw_easm(*args, **kwargs)	Enables/disables the EASM - turbulence model.
kw_geko(*args, **kwargs)	Enables/disables the generalized - (GEKO) turbulence model.
kw_low_re_correction(*args, **kwargs)	Enables/disables the - low Re option.
kw_shear_correction(*args, **kwargs)	Enables/disables the - shear-flow correction option.
kw_sst(*args, **kwargs)	Enables/disables the SST - turbulence model.
kw_standard(*args, **kwargs)	Enables/disables the standard - turbulence model.
kw_wj_bsl_earsm(*args, **kwargs)	Enable/disable the EASM k-omega turbulence model.
laminar(*args, **kwargs)	Enables/disables laminar flow model.
large_eddy_simulation(*args, **kwargs)	Enables/disables large eddy simulation.
les_dynamic_energy_flux(*args, **kwargs)	Enables/disables the dynamic sub-grid scale turbulent Prandtl Number.
les_dynamic_scalar_flux(*args, **kwargs)	Enables/disables the dynamic sub-grid scale turbulent Schmidt Number.
les_subgrid_dynamic_fvar(*args, **kwargs)	Enables/disables the dynamic subgrid-scale mixture fraction variance model.
les_subgrid_rng(*args, **kwargs)	Enable/disable the RNG subgrid-scale model.
les_subgrid_sigma(*args, **kwargs)	Enable/disable the Sigma subgrid-scale model.
les_subgrid_smagorinsky(*args, **kwargs)	Enables/disables the Smagorinsky-Lilly subgrid-scale model.
les_subgrid_tke(*args, **kwargs)	Enables/disables kinetic energy transport subgrid-scale model.
les_subgrid_vreman(*args, **kwargs)	Enable/disable the Vreman subgrid-scale model.
les_subgrid_wale(*args, **kwargs)	Enables/disables WALE subgrid-scale model.
les_subgrid_wmles(*args, **kwargs)	Enables/disables the WMLES subgrid-scale model.
les_subgrid_wmles_s_minus_omega(*args, **kwargs)	Enables/disables the WMLES - subgrid-scale model.
low_pressure_boundary_slip(*args, **kwargs)	Enables/disables the slip boundary formulation for low-pressure gas systems.
mixing_length(*args, **kwargs)	Enables/disables mixing-length (algebraic) turbulence model.
reynolds_stress_model(*args, **kwargs)	Enables/disables the Reynolds-stress turbulence model.
rng_differential_visc(*args, **kwargs)	Enables/disables the differential-viscosity model.
rng_swirl_model(*args, **kwargs)	Enables/disables swirl corrections for rng-model.
rsm_bsl_based(*args, **kwargs)	Enables/disables the stress-BSL Reynolds stress model.
rsm_linear_pressure_strain(*args, **kwargs)	Enables/disables the linear pressure-strain model in RSM.
rsm_omega_based(*args, **kwargs)	Enables/disables the stress-omega Reynolds stress model.
rsm_or_earsm_geko_option(*args, **kwargs)	Enables/disables the RSM version of the GEKO model.
rsm_solve_tke(*args, **kwargs)	Enables/disables the solution of T.K.E.
rsm_ssg_pressure_strain(*args, **kwargs)	Enables/disables quadratic pressure-strain model in RSM.
rsm_wall_echo(*args, **kwargs)	Enables/disables wall-echo effects in RSM model.
sa_alternate_prod(*args, **kwargs)	Enables/disables strain/vorticity production in Spalart-Allmaras model.
sa_damping(*args, **kwargs)	Enables/disables full low-Reynolds number form of Spalart-Allmaras model.
sa_enhanced_wall_treatment(*args, **kwargs)	Enables/disables the enhanced wall treatment for the Spalart-Allmaras model.
sas(*args, **kwargs)	Enables/disables Scale-Adaptive Simulation (SAS) in combination with the SST - turbulence model.
spalart_allmaras(*args, **kwargs)	Enables/disables Spalart-Allmaras turbulence model.
trans_sst_roughness_correlation(*args, **kwargs)	Enables/disables the Transition-SST roughness correlation option.
transition_sst(*args, **kwargs)	Enables/disables the transition SST turbulence model.
turb_buoyancy_effects(*args, **kwargs)	Enables/disables effects of buoyancy on turbulence.
turb_compressibility(*args, **kwargs)	Enables/disables the compressibility correction option.
user_defined(*args, **kwargs)	Selects user-defined functions to define the turbulent viscosity and the turbulent Prandtl and Schmidt numbers.
user_defined_transition(*args, **kwargs)	Sets user-defined transition correlations.
v2f(*args, **kwargs)	Enables/disables V2F turbulence model.
zero_equation_hvac(*args, **kwargs)	Enables/disables zero-equation HVAC turbulence model.

Classes:

geko_options(service, version, mode, path)	Enters the GEKO model menu..
les_model_options(service, version, mode, path)	Enter the LES model options menu.
multiphase_turbulence(service, version, ...)	Enters the multiphase turbulence menu.
near_wall_treatment(service, version, mode, path)	Enters the near wall treatment menu.
transition_model_options(service, version, ...)	Enters the transition model options menu.
turbulence_expert(service, version, mode, path)	Enters the turbulence expert menu.

add_intermittency_transition_model(*args, **kwargs)#

Enable/disable the intermittency transition model to account for transitional effects.

add_transition_model(*args, **kwargs)#

Sets Transition model to account for transitional effects. The default is none, however you can select gamma-algebraic or gamma-transport-eqn. After a transition model has been enabled, you have additional options in the submenu transition-model-options.

buoyancy_effects(*args, **kwargs)#

Enable/disable effects of buoyancy on turbulence.

corner_flow_correction(*args, **kwargs)#

Enables/disables the corner flow correction.

corner_flow_correction_ccorner(*args, **kwargs)#

Sets the strength of the quadratic term of the corner flow correction. The default value is 1. This is available after the corner-flow-correction? option is enabled.

curvature_correction(*args, **kwargs)#

Enables/disables the curvature correction.

curvature_correction_ccurv(*args, **kwargs)#

Sets the strength of the curvature correction term. The default value is 1. This is available after the curvature-correction? option is enabled.

des_limiter_option(*args, **kwargs)#

Selects the DES limiter option (none, F1, F2, Delayed DES, or Improved Delayed DES).

detached_eddy_simulation(*args, **kwargs)#

Enables/disables detached eddy simulation.

geko(*args, **kwargs)#

Enable/disable the GEKO model.

class geko_options(service, version, mode, path)#

Bases: TUIMenu

Enters the GEKO model menu..

Methods:

blending_function(*args, **kwargs)	Sets the blending function, which deactivatescmix and cjet inside boundary layers.
cbf_lam(*args, **kwargs)	Setscbf_lam, a part of the blending function and shields the laminar boundary layer.
cbf_tur(*args, **kwargs)	Setscbf_tur, a factor for the main blending factor, controlling the thickness of the layer near walls.
cjet(*args, **kwargs)	Setscjet, the parameter to optimize free shear layer mixing (optimize free jets independent of mixing layer).
cjet_aux(*args, **kwargs)	Setscjet_aux, which allows fine-tuning of the parameter to optimize free jets.
cmix(*args, **kwargs)	Setscmix, the parameter to optimize strength of mixing in free shear flows.
cnw(*args, **kwargs)	Setscnw, the parameter to optimize flow in non-equilibrium near wall regions.
cnw_sub(*args, **kwargs)	Setscnw_sub, which allows the adjustment of log-layer and cf.
creal(*args, **kwargs)	Setscreal, a realizability limiter that ensures positive normal stresses in the entire domain.
csep(*args, **kwargs)	Setscsep, the parameter to optimize flow separation from smooth surfaces.
geko_defaults(*args, **kwargs)	Restores the defaults of all GEKO parameters.
wall_distance_free(*args, **kwargs)	Enables/disables the wall distance free version of the GEKO model.

blending_function(*args, **kwargs)#

Sets the blending function, which deactivatescmix and cjet inside boundary layers.

cbf_lam(*args, **kwargs)#

Setscbf_lam, a part of the blending function and shields the laminar boundary layer.

cbf_tur(*args, **kwargs)#

Setscbf_tur, a factor for the main blending factor, controlling the thickness of the layer near walls.

cjet(*args, **kwargs)#

Setscjet, the parameter to optimize free shear layer mixing (optimize free jets independent of mixing layer).

cjet_aux(*args, **kwargs)#

Setscjet_aux, which allows fine-tuning of the parameter to optimize free jets.

cmix(*args, **kwargs)#

Setscmix, the parameter to optimize strength of mixing in free shear flows.

cnw(*args, **kwargs)#

Setscnw, the parameter to optimize flow in non-equilibrium near wall regions.

cnw_sub(*args, **kwargs)#

Setscnw_sub, which allows the adjustment of log-layer and cf.

creal(*args, **kwargs)#

Setscreal, a realizability limiter that ensures positive normal stresses in the entire domain.

csep(*args, **kwargs)#

Setscsep, the parameter to optimize flow separation from smooth surfaces.

geko_defaults(*args, **kwargs)#

Restores the defaults of all GEKO parameters.

wall_distance_free(*args, **kwargs)#

Enables/disables the wall distance free version of the GEKO model.

inviscid(*args, **kwargs)#

Enables/disables inviscid flow model.

k_kl_w(*args, **kwargs)#

Enables/disables the k-kl- turbulence model.

ke1e(*args, **kwargs)#

Enable/disable the KE1E turbulence model.

ke_easm(*args, **kwargs)#

Enables/disables the EASM - turbulence model.

ke_realizable(*args, **kwargs)#

Enables/disables the realizable - turbulence model.

ke_rng(*args, **kwargs)#

Enables/disables the RNG - turbulence model.

ke_standard(*args, **kwargs)#

Enables/disables the standard - turbulence model.

kw_bsl(*args, **kwargs)#

Enables/disables the baseline (BSL) - turbulence model.

kw_buoyancy_effects(*args, **kwargs)#

Enable/disable effects of buoyancy on k-omega turbulence model.

kw_easm(*args, **kwargs)#

Enables/disables the EASM - turbulence model.

kw_geko(*args, **kwargs)#

Enables/disables the generalized - (GEKO) turbulence model.

kw_low_re_correction(*args, **kwargs)#

Enables/disables the - low Re option.

kw_shear_correction(*args, **kwargs)#

Enables/disables the - shear-flow correction option. This text command is only available for the standard - model and the stress-omega RSM model.

kw_sst(*args, **kwargs)#

Enables/disables the SST - turbulence model.

kw_standard(*args, **kwargs)#

Enables/disables the standard - turbulence model.

kw_wj_bsl_earsm(*args, **kwargs)#

Enable/disable the EASM k-omega turbulence model.

laminar(*args, **kwargs)#

Enables/disables laminar flow model.

large_eddy_simulation(*args, **kwargs)#

Enables/disables large eddy simulation.

les_dynamic_energy_flux(*args, **kwargs)#

Enables/disables the dynamic sub-grid scale turbulent Prandtl Number.

les_dynamic_scalar_flux(*args, **kwargs)#

Enables/disables the dynamic sub-grid scale turbulent Schmidt Number.

class les_model_options(service, version, mode, path)#

Bases: TUIMenu

Enter the LES model options menu.

Methods:

csigma(*args, **kwargs)	.
cvreman(*args, **kwargs)	.
cw1(*args, **kwargs)	.
cw2(*args, **kwargs)	.
wall_model(*args, **kwargs)	.

csigma(*args, **kwargs)#

.

cvreman(*args, **kwargs)#

.

cw1(*args, **kwargs)#

.

cw2(*args, **kwargs)#

.

wall_model(*args, **kwargs)#

.

les_subgrid_dynamic_fvar(*args, **kwargs)#

Enables/disables the dynamic subgrid-scale mixture fraction variance model.

les_subgrid_rng(*args, **kwargs)#

Enable/disable the RNG subgrid-scale model.

les_subgrid_sigma(*args, **kwargs)#

Enable/disable the Sigma subgrid-scale model.

les_subgrid_smagorinsky(*args, **kwargs)#

Enables/disables the Smagorinsky-Lilly subgrid-scale model.

les_subgrid_tke(*args, **kwargs)#

Enables/disables kinetic energy transport subgrid-scale model.

les_subgrid_vreman(*args, **kwargs)#

Enable/disable the Vreman subgrid-scale model.

les_subgrid_wale(*args, **kwargs)#

Enables/disables WALE subgrid-scale model.

les_subgrid_wmles(*args, **kwargs)#

Enables/disables the WMLES subgrid-scale model.

les_subgrid_wmles_s_minus_omega(*args, **kwargs)#

Enables/disables the WMLES - subgrid-scale model.

low_pressure_boundary_slip(*args, **kwargs)#

Enables/disables the slip boundary formulation for low-pressure gas systems.

mixing_length(*args, **kwargs)#

Enables/disables mixing-length (algebraic) turbulence model.

class multiphase_turbulence(service, version, mode, path)#

Bases: TUIMenu

Enters the multiphase turbulence menu.

Methods:

multiphase_options(*args, **kwargs)	Enables/disables multiphase options.
rsm_multiphase_models(*args, **kwargs)	Selects Reynolds Stress multiphase model.
subgrid_turbulence_contribution_aiad(*args, ...)	.
turbulence_multiphase_models(*args, **kwargs)	Selects - multiphase model.

multiphase_options(*args, **kwargs)#

Enables/disables multiphase options.

rsm_multiphase_models(*args, **kwargs)#

Selects Reynolds Stress multiphase model.

subgrid_turbulence_contribution_aiad(*args, **kwargs)#

.

turbulence_multiphase_models(*args, **kwargs)#

Selects - multiphase model.

class near_wall_treatment(service, version, mode, path)#

Bases: TUIMenu

Enters the near wall treatment menu.

Methods:

enhanced_wall_treatment(*args, **kwargs)	Enables/disables enhanced wall functions.
menter_lechner(*args, **kwargs)	Enables/disables the Menter-Lechner near-wall treatment.
non_equilibrium_wall_fn(*args, **kwargs)	Enables/disables non-equilibrium wall functions.
scalable_wall_functions(*args, **kwargs)	Enables/disables scalable wall functions.
user_defined_wall_functions(*args, **kwargs)	Enables/disables user-defined wall functions.
wall_omega_treatment(*args, **kwargs)	.
werner_wengle_wall_fn(*args, **kwargs)	Enables/disables Werner-Wengle wall functions.
wf_pressure_gradient_effects(*args, **kwargs)	Enables/disables wall function pressure- gradient effects.
wf_thermal_effects(*args, **kwargs)	Enables/disables wall function thermal effects.

enhanced_wall_treatment(*args, **kwargs)#

Enables/disables enhanced wall functions.

menter_lechner(*args, **kwargs)#

Enables/disables the Menter-Lechner near-wall treatment.

non_equilibrium_wall_fn(*args, **kwargs)#

Enables/disables non-equilibrium wall functions.

scalable_wall_functions(*args, **kwargs)#

Enables/disables scalable wall functions.

user_defined_wall_functions(*args, **kwargs)#

Enables/disables user-defined wall functions.

wall_omega_treatment(*args, **kwargs)#

.

werner_wengle_wall_fn(*args, **kwargs)#

Enables/disables Werner-Wengle wall functions.

wf_pressure_gradient_effects(*args, **kwargs)#

Enables/disables wall function pressure- gradient effects.

wf_thermal_effects(*args, **kwargs)#

Enables/disables wall function thermal effects.

reynolds_stress_model(*args, **kwargs)#

Enables/disables the Reynolds-stress turbulence model.

rng_differential_visc(*args, **kwargs)#

Enables/disables the differential-viscosity model.

rng_swirl_model(*args, **kwargs)#

Enables/disables swirl corrections for rng-model.

rsm_bsl_based(*args, **kwargs)#

Enables/disables the stress-BSL Reynolds stress model.

rsm_linear_pressure_strain(*args, **kwargs)#

Enables/disables the linear pressure-strain model in RSM.

rsm_omega_based(*args, **kwargs)#

Enables/disables the stress-omega Reynolds stress model.

rsm_or_earsm_geko_option(*args, **kwargs)#

Enables/disables the RSM version of the GEKO model.

rsm_solve_tke(*args, **kwargs)#

Enables/disables the solution of T.K.E. in RSM model.

rsm_ssg_pressure_strain(*args, **kwargs)#

Enables/disables quadratic pressure-strain model in RSM.

rsm_wall_echo(*args, **kwargs)#

Enables/disables wall-echo effects in RSM model.

sa_alternate_prod(*args, **kwargs)#

Enables/disables strain/vorticity production in Spalart-Allmaras model.

sa_damping(*args, **kwargs)#

Enables/disables full low-Reynolds number form of Spalart-Allmaras model. This option is only available if your response wasno to sa-enhanced-wall-treatment?.

sa_enhanced_wall_treatment(*args, **kwargs)#

Enables/disables the enhanced wall treatment for the Spalart-Allmaras model. If disabled, no smooth blending between the viscous sublayer and the log-law formulation is employed, as was done in versions previous to Fluent 14.

sas(*args, **kwargs)#

Enables/disables Scale-Adaptive Simulation (SAS) in combination with the SST - turbulence model.

spalart_allmaras(*args, **kwargs)#

Enables/disables Spalart-Allmaras turbulence model.

trans_sst_roughness_correlation(*args, **kwargs)#

Enables/disables the Transition-SST roughness correlation option.

class transition_model_options(service, version, mode, path)#

Bases: TUIMenu

Enters the transition model options menu.

Methods:

capg_hightu(*args, **kwargs)	Sets the algebraic transition model coefficient CAPG_HIGHTU.
capg_lowtu(*args, **kwargs)	Sets the algebraic transition model coefficient CAPG_LOWTU.
cbubble_c1(*args, **kwargs)	Sets the algebraic transition model coefficient CBUBBLE_C1.
cbubble_c2(*args, **kwargs)	Sets the algebraic transition model coefficient CBUBBLE_C2.
cfpg_hightu(*args, **kwargs)	Sets the algebraic transition model coefficient CFPG_HIGHTU.
cfpg_lowtu(*args, **kwargs)	Sets the algebraic transition model coefficient CFPG_LOWTU.
clambda_scale(*args, **kwargs)	Sets the algebraic transition model coefficient CLAMBDA_SCALE.
critical_reynolds_number_correlation(*args, ...)	Sets the critical Reynolds number correlation.
crossflow_transition(*args, **kwargs)	Enables/disables the effects of crossflow instability.
ctu_hightu(*args, **kwargs)	Sets the algebraic transition model coefficient CTU_HIGHTU.
ctu_lowtu(*args, **kwargs)	Sets the algebraic transition model coefficient CTU_LOWTU.
rec_c1(*args, **kwargs)	Sets the algebraic transition model coefficient REC_C1.
rec_c2(*args, **kwargs)	Sets the algebraic transition model coefficient REC_C2.
rec_max(*args, **kwargs)	Sets the algebraic transition model coefficient REC_MAX.
rv1_switch(*args, **kwargs)	Sets the algebraic transition model coefficient RV1_SWITCH.

capg_hightu(*args, **kwargs)#

Sets the algebraic transition model coefficient CAPG_HIGHTU.

capg_lowtu(*args, **kwargs)#

Sets the algebraic transition model coefficient CAPG_LOWTU.

cbubble_c1(*args, **kwargs)#

Sets the algebraic transition model coefficient CBUBBLE_C1.

cbubble_c2(*args, **kwargs)#

Sets the algebraic transition model coefficient CBUBBLE_C2.

cfpg_hightu(*args, **kwargs)#

Sets the algebraic transition model coefficient CFPG_HIGHTU.

cfpg_lowtu(*args, **kwargs)#

Sets the algebraic transition model coefficient CFPG_LOWTU.

clambda_scale(*args, **kwargs)#

Sets the algebraic transition model coefficient CLAMBDA_SCALE.

critical_reynolds_number_correlation(*args, **kwargs)#

Sets the critical Reynolds number correlation.

crossflow_transition(*args, **kwargs)#

Enables/disables the effects of crossflow instability.

ctu_hightu(*args, **kwargs)#

Sets the algebraic transition model coefficient CTU_HIGHTU.

ctu_lowtu(*args, **kwargs)#

Sets the algebraic transition model coefficient CTU_LOWTU.

rec_c1(*args, **kwargs)#

Sets the algebraic transition model coefficient REC_C1.

rec_c2(*args, **kwargs)#

Sets the algebraic transition model coefficient REC_C2.

rec_max(*args, **kwargs)#

Sets the algebraic transition model coefficient REC_MAX.

rv1_switch(*args, **kwargs)#

Sets the algebraic transition model coefficient RV1_SWITCH.

transition_sst(*args, **kwargs)#

Enables/disables the transition SST turbulence model.

turb_buoyancy_effects(*args, **kwargs)#

Enables/disables effects of buoyancy on turbulence.

turb_compressibility(*args, **kwargs)#

Enables/disables the compressibility correction option.

class turbulence_expert(service, version, mode, path)#

Bases: TUIMenu

Enters the turbulence expert menu.

Methods:

curvature_correction_coefficient(*args, **kwargs)	Set the strength of the curvature correction term.
kato_launder_model(*args, **kwargs)	Enables/disables Kato-Launder modification.
kw_add_des(*args, **kwargs)	Enables/disables Detached Eddy Simulation (DES) in combination with the currently selected BSL - model or transition SST model.
kw_add_sas(*args, **kwargs)	Enables/disables Scale-Adaptive Simulation (SAS) in combination with the currently selected -based URANS turbulence model.
kw_vorticity_based_production(*args, **kwargs)	Enables/disables vorticity-based production.
low_re_ke(*args, **kwargs)	Enables/disables the low-Re - turbulence model.
low_re_ke_index(*args, **kwargs)	Specifies which low-Reynolds-number - model is to be used.
non_newtonian_modification(*args, **kwargs)	Enables/disables non-Newtonian modification for Lam-Bremhorst model.
production_limiter(*args, **kwargs)	Enables/disables Production Limiter modification.
restore_sst_v61(*args, **kwargs)	Enables/disables SST formulation of v6.1.
rke_cmu_rotation_term(*args, **kwargs)	Modifies the definition for the realizable - model.
sbes_les_subgrid_dynamic_fvar(*args, **kwargs)	.
sbes_sdes_hybrid_model(*args, **kwargs)	Selects the hybrid model, to specify whether you want to apply the Shielded Detached Eddy Simulation (SDES) model, Stress-Blended Eddy Simulation (SBES), or SBES with a user-defined function.
sbes_sgs_option(*args, **kwargs)	Selects the subgrid-scale model for the LES portion of your Stress-Blended Eddy Simulation (SBES).
sbes_update_interval_k_omega(*args, **kwargs)	Sets the number of time steps between updates of the k-ω part of the SBES model.
thermal_p_function(*args, **kwargs)	Enables/disables Jayatilleke P function.
turb_add_sbes_sdes(*args, **kwargs)	Enables/disables the Stress-Blended Eddy Simulation (SBES) model or Shielded Detached Eddy Simulation (SDES) model.
turb_non_newtonian(*args, **kwargs)	Enables/disables turbulence for non-Newtonian fluids.
turb_pk_compressible(*args, **kwargs)	Enables/disables turbulent production due to compressible divergence.
turbulence_damping(*args, **kwargs)	Enables/disables turbulence damping and sets turbulence damping parameters.

curvature_correction_coefficient(*args, **kwargs)#

Set the strength of the curvature correction term. The default value is 1.

kato_launder_model(*args, **kwargs)#

Enables/disables Kato-Launder modification.

kw_add_des(*args, **kwargs)#

Enables/disables Detached Eddy Simulation (DES) in combination with the currently selected BSL - model or transition SST model. This text command is only available for transient cases.

kw_add_sas(*args, **kwargs)#

Enables/disables Scale-Adaptive Simulation (SAS) in combination with the currently selected -based URANS turbulence model. This text command is only available for transient cases.

kw_vorticity_based_production(*args, **kwargs)#

Enables/disables vorticity-based production.

low_re_ke(*args, **kwargs)#

Enables/disables the low-Re - turbulence model.

low_re_ke_index(*args, **kwargs)#

Specifies which low-Reynolds-number - model is to be used. Six models are available: Index Model 0 Abid 1 Lam-Bremhorst 2 Launder-Sharma 3 Yang-Shih 4 Abe-Kondoh-Nagano 5 Chang-Hsieh-Chen Contact your Ansys, Inc. technical support engineer for more details.

non_newtonian_modification(*args, **kwargs)#

Enables/disables non-Newtonian modification for Lam-Bremhorst model.

production_limiter(*args, **kwargs)#

Enables/disables Production Limiter modification.

restore_sst_v61(*args, **kwargs)#

Enables/disables SST formulation of v6.1.

rke_cmu_rotation_term(*args, **kwargs)#

Modifies the definition for the realizable - model.

sbes_les_subgrid_dynamic_fvar(*args, **kwargs)#

.

sbes_sdes_hybrid_model(*args, **kwargs)#

Selects the hybrid model, to specify whether you want to apply the Shielded Detached Eddy Simulation (SDES) model, Stress-Blended Eddy Simulation (SBES), or SBES with a user-defined function.

sbes_sgs_option(*args, **kwargs)#

Selects the subgrid-scale model for the LES portion of your Stress-Blended Eddy Simulation (SBES).

sbes_update_interval_k_omega(*args, **kwargs)#

Sets the number of time steps between updates of the k-ω part of the SBES model.

thermal_p_function(*args, **kwargs)#

Enables/disables Jayatilleke P function.

turb_add_sbes_sdes(*args, **kwargs)#

Enables/disables the Stress-Blended Eddy Simulation (SBES) model or Shielded Detached Eddy Simulation (SDES) model.

turb_non_newtonian(*args, **kwargs)#

Enables/disables turbulence for non-Newtonian fluids.

turb_pk_compressible(*args, **kwargs)#

Enables/disables turbulent production due to compressible divergence.

turbulence_damping(*args, **kwargs)#

Enables/disables turbulence damping and sets turbulence damping parameters.

user_defined(*args, **kwargs)#

Selects user-defined functions to define the turbulent viscosity and the turbulent Prandtl and Schmidt numbers.

user_defined_transition(*args, **kwargs)#

Sets user-defined transition correlations.

v2f(*args, **kwargs)#

Enables/disables V2F turbulence model.

zero_equation_hvac(*args, **kwargs)#

Enables/disables zero-equation HVAC turbulence model.

class named_expressions(service, version, mode, path)#

Bases: TUIMenu

Enters the named expressions menu.

Methods:

add(*args, **kwargs)	Creates a new named expression.
compute(*args, **kwargs)	Computes and prints the value of an expression.
copy(*args, **kwargs)	Allows you to copy an existing named expression.
delete(*args, **kwargs)	Allows you to delete a named expression, as long as it is not in use.
edit(*args, **kwargs)	Allows you to edit the definition of a named expression.
export_to_tsv(*args, **kwargs)	Export one or more named expressions to a file in TSV format.
import_from_tsv(*args, **kwargs)	Import one or more named expressions saved in TSV format.
list(*args, **kwargs)	Lists all of the currently defined named expressions.
list_properties(*args, **kwargs)	Lists the definition of a named expression.

add(*args, **kwargs)#

Creates a new named expression.

compute(*args, **kwargs)#

Computes and prints the value of an expression. This is only available for expressions that evaluate to a single value.

copy(*args, **kwargs)#

Allows you to copy an existing named expression.

delete(*args, **kwargs)#

Allows you to delete a named expression, as long as it is not in use.

edit(*args, **kwargs)#

Allows you to edit the definition of a named expression.

export_to_tsv(*args, **kwargs)#

Export one or more named expressions to a file in TSV format.

import_from_tsv(*args, **kwargs)#

Import one or more named expressions saved in TSV format.

list(*args, **kwargs)#

Lists all of the currently defined named expressions.

list_properties(*args, **kwargs)#

Lists the definition of a named expression.

class operating_conditions(service, version, mode, path)#

Bases: TUIMenu

Enters the define operating conditions menu.

Methods:

gravity(*args, **kwargs)	Sets gravitational acceleration.
gravity_mrf_behavior(*args, **kwargs)	.
operating_density(*args, **kwargs)	Multiphase flow Operating Density menu.
operating_pressure(*args, **kwargs)	Sets the operating pressure.
operating_temperature(*args, **kwargs)	Sets the operating temperature for Boussinesq.
reference_pressure_location(*args, **kwargs)	Sets a location that determines the reference pressure cell or cells (depending on the selected reference pressure method).
reference_pressure_method(*args, **kwargs)	Specifies the method used for adjusting the gauge pressure field after each iteration to keep it from floating: the method can assume that all of the cell zones are connected by internal boundary zones (such as interior zones), or can account for connected and disconnected cell zones.
set_state(*args, **kwargs)	Selects state for real gas EOS subcritical condition.
use_inlet_temperature_for_operating_density(...)	Uses inlet temperature to calculate operating density.
used_ref_pressure_location(*args, **kwargs)	Prints the coordinates of the reference pressure cell or cells (depending on the selected reference pressure method).

gravity(*args, **kwargs)#

Sets gravitational acceleration.

gravity_mrf_behavior(*args, **kwargs)#

.

operating_density(*args, **kwargs)#

Multiphase flow Operating Density menu.

operating_pressure(*args, **kwargs)#

Sets the operating pressure.

operating_temperature(*args, **kwargs)#

Sets the operating temperature for Boussinesq.

reference_pressure_location(*args, **kwargs)#

Sets a location that determines the reference pressure cell or cells (depending on the selected reference pressure method). The pressure value in such cells can be used to adjust the gauge pressure field after each iteration to keep it from floating.

reference_pressure_method(*args, **kwargs)#

Specifies the method used for adjusting the gauge pressure field after each iteration to keep it from floating: the method can assume that all of the cell zones are connected by internal boundary zones (such as interior zones), or can account for connected and disconnected cell zones. Such adjustment is only allowed for incompressible flows, and will be limited partially or entirely by the presence of a pressure boundary.

set_state(*args, **kwargs)#

Selects state for real gas EOS subcritical condition.

use_inlet_temperature_for_operating_density(*args, **kwargs)#

Uses inlet temperature to calculate operating density.

used_ref_pressure_location(*args, **kwargs)#

Prints the coordinates of the reference pressure cell or cells (depending on the selected reference pressure method). The pressure value in such cells can be used to adjust the gauge pressure field after each iteration to keep it from floating.

class overset_interfaces(service, version, mode, path)#

Bases: TUIMenu

Enters the overset interfaces menu.

Classes:

adapt(service, version, mode, path)	Enters the overset adaption menu.
cut_control(service, version, mode, path)	Enters the overset hole cut control menu.
options(service, version, mode, path)	Enters the overset interface options menu.

Methods:

check(*args, **kwargs)	Checks the integrity of the overset interfaces.
clear(*args, **kwargs)	Clears the domain connectivity of an overset interface.
clear_all(*args, **kwargs)	Clears the domain connectivity of all overset interfaces.
create(*args, **kwargs)	Creates an overset interface.
debug_hole_cut(*args, **kwargs)	Debugging tool to troubleshoot hole cutting of overset interfaces.
delete(*args, **kwargs)	Deletes an overset interface.
delete_all(*args, **kwargs)	Deletes all overset interfaces in the domain.
display_cells(*args, **kwargs)	Displays the overset cells marked using the text command define/overset-interfaces/mark-cells.
fill_dci(*args, **kwargs)	Fill overset domain connectivity information (DCI).
find_all_bounding_cells(*args, **kwargs)	Find bounding cells for all cell centroids.
find_bounding_cell(*args, **kwargs)	Find bounding cell for given cell or search point.
free_dci(*args, **kwargs)	Free overset domain connectivity information (DCI).
grid_priorities(*args, **kwargs)	Allows you to specify grid priorities on background and component meshes, used in the overlap minimization of an overset interface.
intersect(*args, **kwargs)	Executes the hole cutting of an overset interface and establishes the domain connectivity.
intersect_all(*args, **kwargs)	Executes hole cutting for all overset interfaces in the domain.
list(*args, **kwargs)	Lists information about the overset interfaces.
mark_cell_change(*args, **kwargs)	Marks cells that have undergone a specified overset cell type change (from solve,receptor, or dead to any other type) in the last time step.
mark_cells(*args, **kwargs)	Marks the specified overset cells (solve, receptor, donor, orphan, or dead) and fills registers based on the markings.
read_dci_from_case(*args, **kwargs)	Read domain connectivity information (DCI) from case file.
set_mark_bounds(*args, **kwargs)	Allows you to set bounds so that any marking of cells is performed within a spherical region based on a specified origin and radius.
update_from_dci(*args, **kwargs)	Update all overset intrfaces from stored domain connectivity information (DCI).
write_cell_types(*args, **kwargs)	Write overset cell types into file.
write_dci(*args, **kwargs)	Save domain connectivity information (DCI) to a text file.
write_dci_to_case(*args, **kwargs)	Save domain connectivity information (DCI) to case file.

class adapt(service, version, mode, path)#

Bases: TUIMenu

Enters the overset adaption menu.

Methods:

adapt_mesh(*args, **kwargs)	Marks and adapts the mesh to improve your overset mesh.
mark_adaption(*args, **kwargs)	Marks cells to identify those that can be adapted in order to improve your overset mesh.

Classes:

set(service, version, mode, path)

Enters the overset adaption set menu.

adapt_mesh(*args, **kwargs)#

Marks and adapts the mesh to improve your overset mesh.

mark_adaption(*args, **kwargs)#

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

class set(service, version, mode, path)#

Bases: TUIMenu

Enters the overset adaption set menu.

Methods:

adaption_sweeps(*args, **kwargs)	Sets the number of rounds of adaption applied during each adaption cycle.
automatic(*args, **kwargs)	Enable the option to automatically adapt overset meshes during solution update.
buffer_layers(*args, **kwargs)	Sets the number of cell layers marked in addition to the cells marked for orphan adaption.
gap_resolution(*args, **kwargs)	Set the target (minimum) gap resolution used when marking cells for gap adaption.
length_ratio_max(*args, **kwargs)	Sets the length scale ratio threshold used to determine which cells are marked for adaption based on donor-receptor cell size differences.
mark_coarsening(*args, **kwargs)	Enables/disables the option to coarsen the mesh if mesh refinement is no longer needed.
mark_fixed_orphans(*args, **kwargs)	Enables/disables the option to also adapt based on cells that are not actual orphans because they were fixed by accepting neighbor donors.
mark_gaps(*args, **kwargs)	Enable the option to adapt underresolved gaps.
mark_orphans(*args, **kwargs)	Enables/disables the option to adapt for orphan reduction.
mark_size(*args, **kwargs)	Enables/disables the option to adapt based on donor-receptor cell size differences.
maximum_refinement_level(*args, **kwargs)	Sets the maximum level of refinement during overset adaption, in conjunction with the value set using the mesh/adapt/set/maximum-refinement-level text command (the larger of the two values is used).
prismatic(*args, **kwargs)	Enable the option to use anisotropic adaption in prismatic cells.

adaption_sweeps(*args, **kwargs)#

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

automatic(*args, **kwargs)#

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

buffer_layers(*args, **kwargs)#

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

gap_resolution(*args, **kwargs)#

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

length_ratio_max(*args, **kwargs)#

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

mark_coarsening(*args, **kwargs)#

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

mark_fixed_orphans(*args, **kwargs)#

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

mark_gaps(*args, **kwargs)#

Enable the option to adapt underresolved gaps.

mark_orphans(*args, **kwargs)#

Enables/disables the option to adapt for orphan reduction.

mark_size(*args, **kwargs)#

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

maximum_refinement_level(*args, **kwargs)#

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

prismatic(*args, **kwargs)#

Enable the option to use anisotropic adaption in prismatic cells.

check(*args, **kwargs)#

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

clear(*args, **kwargs)#

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

clear_all(*args, **kwargs)#

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

create(*args, **kwargs)#

Creates an overset interface.

class cut_control(service, version, mode, path)#

Bases: TUIMenu

Enters the overset hole cut control menu.

Methods:

add(*args, **kwargs)	Adds a hole cut control, so that a boundary zone does not cut specified cell zones.
delete(*args, **kwargs)	Deletes the hole cut control for a boundary zone.
delete_all(*args, **kwargs)	Deletes the hole cut controls for all boundary zones.
list(*args, **kwargs)	Lists the defined hole cut controls.

Classes:

cut_seeds(service, version, mode, path)

Enters the overset hole cut seeds menu.

add(*args, **kwargs)#

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

class cut_seeds(service, version, mode, path)#

Bases: TUIMenu

Enters the overset hole cut seeds menu.

Methods:

add(*args, **kwargs)	Add a hole cut seed.
cut_seeds_for_all_component_zones(*args, ...)	Specifies whether all component zones get cut seeds, which cut pilot holes into the overlapping meshes that will then be enlarged during overlap minimization.
delete(*args, **kwargs)	Delete a hole cut seed.
delete_all(*args, **kwargs)	Delete all hole cut seeds.
list(*args, **kwargs)	List the defined hole cut seeds.

add(*args, **kwargs)#

Add a hole cut seed.

cut_seeds_for_all_component_zones(*args, **kwargs)#

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

delete(*args, **kwargs)#

Delete a hole cut seed.

delete_all(*args, **kwargs)#

Delete all hole cut seeds.

list(*args, **kwargs)#

List the defined hole cut seeds.

delete(*args, **kwargs)#

Deletes the hole cut control for a boundary zone.

delete_all(*args, **kwargs)#

Deletes the hole cut controls for all boundary zones.

list(*args, **kwargs)#

Lists the defined hole cut controls.

debug_hole_cut(*args, **kwargs)#

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

delete(*args, **kwargs)#

Deletes an overset interface.

delete_all(*args, **kwargs)#

Deletes all overset interfaces in the domain.

display_cells(*args, **kwargs)#

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

fill_dci(*args, **kwargs)#

Fill overset domain connectivity information (DCI).

find_all_bounding_cells(*args, **kwargs)#

Find bounding cells for all cell centroids.

find_bounding_cell(*args, **kwargs)#

Find bounding cell for given cell or search point.

free_dci(*args, **kwargs)#

Free overset domain connectivity information (DCI).

grid_priorities(*args, **kwargs)#

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

intersect(*args, **kwargs)#

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

intersect_all(*args, **kwargs)#

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

list(*args, **kwargs)#

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

mark_cell_change(*args, **kwargs)#

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

mark_cells(*args, **kwargs)#

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

class options(service, version, mode, path)#

Bases: TUIMenu

Enters the overset interface options menu.

Methods:

auto_create(*args, **kwargs)	Enables the automatic creation of a default overset interface during initialization or mesh motion update.
dead_cell_update(*args, **kwargs)	Enables/disables the updating of dead cells during the solution process, which may be helpful for some moving and dynamic mesh simulations (though at the cost of solver performance).
donor_priority_method(*args, **kwargs)	Allows you to specify whether the cell donor priority used in the overlap minimization of an overset interface is inversely proportional to either the cell size or the distance to the nearest boundary.
expert(*args, **kwargs)	Enables / disables overset-related expert tools.
mesh_interfaces(*args, **kwargs)	Allows the inclusion of non-conformal mesh interfaces inside overset cell zones, as long as the mesh interfaces do not spatially overlap with the cells where the overset interfaces lie.
minimize_overlap(*args, **kwargs)	Allows you to disable overlap minimization during hole cutting.
modified_donor_search(*args, **kwargs)	Enables / disables modified donor search parameters.
modified_hole_cutting(*args, **kwargs)	Enables / disables modified hole cutting parameters.
node_connected_donors(*args, **kwargs)	Allows you to switch between face or node connected donor cells.
overlap_boundaries(*args, **kwargs)	Allows you to disable the detection of overlapping boundaries during hole cutting, in order to reduce the computational expense for cases that do not include such boundaries.
parallel(*args, **kwargs)	Allows you to select the algorithm used for overset parallel processing.
partial_cut_faces(*args, **kwargs)	Enables/disables enhanced hole cutting, where partially overlapping cut faces are decomposed into overlapping and non-overlapping fractions, and only the non-overlapping fractions participate in the hole cutting.
render_receptor_cells(*args, **kwargs)	Allows you to enable visualization of receptor cells in contour and mesh displays.
solve_island_removal(*args, **kwargs)	Sets the method used to control the removal of isolated patches of solve cells.
transient_caching(*args, **kwargs)	Sets the options to control caching of entities in transient overset simulations.
update_before_case_write(*args, **kwargs)	Enables/disables the updating of the overset interfaces before writing a case file in the Common Fluids Format (CFF).
verbosity(*args, **kwargs)	Specifies the level of detail printed in the console about overset interfaces.

auto_create(*args, **kwargs)#

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

dead_cell_update(*args, **kwargs)#

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

donor_priority_method(*args, **kwargs)#

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

expert(*args, **kwargs)#

Enables / disables overset-related expert tools.

mesh_interfaces(*args, **kwargs)#

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

minimize_overlap(*args, **kwargs)#

Allows you to disable overlap minimization during hole cutting.

modified_donor_search(*args, **kwargs)#

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

modified_hole_cutting(*args, **kwargs)#

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

node_connected_donors(*args, **kwargs)#

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

overlap_boundaries(*args, **kwargs)#

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

parallel(*args, **kwargs)#

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

partial_cut_faces(*args, **kwargs)#

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

render_receptor_cells(*args, **kwargs)#

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

solve_island_removal(*args, **kwargs)#

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

transient_caching(*args, **kwargs)#

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

update_before_case_write(*args, **kwargs)#

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

verbosity(*args, **kwargs)#

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

read_dci_from_case(*args, **kwargs)#

Read domain connectivity information (DCI) from case file.

set_mark_bounds(*args, **kwargs)#

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

update_from_dci(*args, **kwargs)#

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

write_cell_types(*args, **kwargs)#

Write overset cell types into file.

write_dci(*args, **kwargs)#

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

write_dci_to_case(*args, **kwargs)#

Save domain connectivity information (DCI) to case file.

class parameters(service, version, mode, path)#

Bases: TUIMenu

Enters the parameters menu.

Methods:

enable_in_TUI(*args, **kwargs)

Enables/disables parameters in the text user interface.

Classes:

input_parameters(service, version, mode, path)	Enters the input-parameters menu.
list_parameters(service, version, mode, path)	Enter list-param menu.
output_parameters(service, version, mode, path)	Enters the output-parameters menu.

enable_in_TUI(*args, **kwargs)#

Enables/disables parameters in the text user interface.

class input_parameters(service, version, mode, path)#

Bases: TUIMenu

Enters the input-parameters menu.

Classes:

advance(service, version, mode, path)

Define custom variable to use input parameter.

Methods:

delete(*args, **kwargs)	Deletes an input parameter.
edit(*args, **kwargs)	Edits an input parameter.

class advance(service, version, mode, path)#

Bases: TUIMenu

Define custom variable to use input parameter.

Methods:

delete(*args, **kwargs)	Delete selected custom-input-parameters.
list(*args, **kwargs)	List of custom-input-parameters.
use_in(*args, **kwargs)	Use input parameter in solver-udf or in scheme-procedure.

delete(*args, **kwargs)#

Delete selected custom-input-parameters.

list(*args, **kwargs)#

List of custom-input-parameters.

use_in(*args, **kwargs)#

Use input parameter in solver-udf or in scheme-procedure.

delete(*args, **kwargs)#

Deletes an input parameter.

edit(*args, **kwargs)#

Edits an input parameter.

class list_parameters(service, version, mode, path)#

Bases: TUIMenu

Enter list-param menu.

Methods:

input_parameters(*args, **kwargs)	List all input parameters.
output_parameters(*args, **kwargs)	List all output parameters.

input_parameters(*args, **kwargs)#

List all input parameters.

output_parameters(*args, **kwargs)#

List all output parameters.

class output_parameters(service, version, mode, path)#

Bases: TUIMenu

Enters the output-parameters menu.

Methods:

create(*args, **kwargs)	Creates an output parameter.
delete(*args, **kwargs)	Deletes an output parameter.
edit(*args, **kwargs)	Edits an output parameter.
print_all_to_console(*args, **kwargs)	Displays all parameter values in the console.
print_to_console(*args, **kwargs)	Displays parameter value in the console.
rename(*args, **kwargs)	Renames an output parameter.
write_all_to_file(*args, **kwargs)	Writes all parameter values to file.
write_to_file(*args, **kwargs)	Writes parameter value to file.

create(*args, **kwargs)#

Creates an output parameter.

delete(*args, **kwargs)#

Deletes an output parameter.

edit(*args, **kwargs)#

Edits an output parameter.

print_all_to_console(*args, **kwargs)#

Displays all parameter values in the console.

print_to_console(*args, **kwargs)#

Displays parameter value in the console.

rename(*args, **kwargs)#

Renames an output parameter.

write_all_to_file(*args, **kwargs)#

Writes all parameter values to file.

write_to_file(*args, **kwargs)#

Writes parameter value to file.

class periodic_conditions(service, version, mode, path)#

Bases: TUIMenu

Enters the periodic conditions menu.

Methods:

massflow_rate_specification(*args, **kwargs)	Enables/disables specification of mass flow rate at the periodic boundary.
pressure_gradient_specification(*args, **kwargs)	Enables/disables specification of pressure gradient at the periodic boundary.

massflow_rate_specification(*args, **kwargs)#

Enables/disables specification of mass flow rate at the periodic boundary.

pressure_gradient_specification(*args, **kwargs)#

Enables/disables specification of pressure gradient at the periodic boundary.

class phases(service, version, mode, path)#

Bases: TUIMenu

Enters the phases menu.

Classes:

iac_expert(service, version, mode, path)	Enters the IAC expert setting menu.
set_domain_properties(service, version, ...)	Enters the menu to set phase domain properties.

Methods:

interaction_domain(*args, **kwargs)	Enter the menu to set interaction domain properties.
phase_domain(*args, **kwargs)	Enter the menu to set phase domain properties.

class iac_expert(service, version, mode, path)#

Bases: TUIMenu

Enters the IAC expert setting menu.

Methods:

hibiki_ishii_model(*args, **kwargs)	Sets Hibiki-Ishii model coefficients.
iac_pseudo_time_step(*args, **kwargs)	Set iac pseudo-time.
ishii_kim_model(*args, **kwargs)	Sets Ishii-Kim model coefficients.
yao_morel_model(*args, **kwargs)	Sets Yao-Morel model coefficients.

hibiki_ishii_model(*args, **kwargs)#

Sets Hibiki-Ishii model coefficients.

iac_pseudo_time_step(*args, **kwargs)#

Set iac pseudo-time.

ishii_kim_model(*args, **kwargs)#

Sets Ishii-Kim model coefficients.

yao_morel_model(*args, **kwargs)#

Sets Yao-Morel model coefficients.

interaction_domain(*args, **kwargs)#

Enter the menu to set interaction domain properties.

phase_domain(*args, **kwargs)#

Enter the menu to set phase domain properties.

class set_domain_properties(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set phase domain properties.

Methods:

change_phases_names(*args, **kwargs)	Allows you to change the names of all the phases in your simulation.
phase_domains(*args, **kwargs)	Enters the menu to select a specific phase.

Classes:

interaction_domain(service, version, mode, path)

Enters the menu to set the interaction domain properties.

change_phases_names(*args, **kwargs)#

Allows you to change the names of all the phases in your simulation.

class interaction_domain(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set the interaction domain properties.

Classes:

forces(service, version, mode, path)	Enters the menu to set interfacial forces models.
heat_mass_reactions(service, version, mode, path)	Enters the menu to set heat, mass-transfer, and reaction models.
interfacial_area(service, version, mode, path)	Enters the menu to set interfacial area models.
model_transition(service, version, mode, path)	Enters the menu to set model transition mechanisms.
numerics(service, version, mode, path)	Enters the menu to set numerics models.

class forces(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set interfacial forces models.

Classes:

cavitation(service, version, mode, path)	Enter the menu to set cavitation models.
interphase_discretization(service, version, ...)	Enter the menu to set interphase discretization models.
interphase_viscous_dissipation(service, ...)	Enter the menu to set interphase viscous dissipation related models.
lift(service, version, mode, path)	Enters the menu to set the lift force.
surface_tension(service, version, mode, path)	Enters the menu to set surface tension models.
virtual_mass(service, version, mode, path)	Enters the menu to set virtual mass models.

Methods:

drag(*args, **kwargs)	Specifies the drag function, drag modification, and drag factor for each pair of phases.
heat_coeff(*args, **kwargs)	Specify the heat transfer coefficient function between each pair of phases.
interfacial_area(*args, **kwargs)	Set the interfacial area parameters for each pair of phases.
mass_transfer(*args, **kwargs)	Specify the mass transfer mechanisms.
model_transition(*args, **kwargs)	Set the model transition mechanism.
reactions(*args, **kwargs)	Define multiple heterogeneous reactions and stoichiometry.
restitution(*args, **kwargs)	Specifies the restitution coefficient for collisions between each pair of granular phases, and for collisions between particles of the same granular phase.
slip_velocity(*args, **kwargs)	Specifies the slip velocity function for each secondary phase with respect to the primary phase.
turbulence_interaction(*args, **kwargs)	Specifies the turbulence interaction model for each primary-secondary phase pair.
turbulent_dispersion(*args, **kwargs)	Specifies the turbulent dispersion model for each primary-secondary phase pair.
wall_lubrication(*args, **kwargs)	Specifies the wall lubrication model for each primary-secondary phase pair.

class cavitation(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set cavitation models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

drag(*args, **kwargs)#

Specifies the drag function, drag modification, and drag factor for each pair of phases. This command is available only with the Eulerian and Mixture multiphase models.

heat_coeff(*args, **kwargs)#

Specify the heat transfer coefficient function between each pair of phases.

interfacial_area(*args, **kwargs)#

Set the interfacial area parameters for each pair of phases.

class interphase_discretization(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set interphase discretization models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class interphase_viscous_dissipation(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set interphase viscous dissipation related models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class lift(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set the lift force. This item is available only with the Eulerian multiphase model.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	Specifies the lift function for each pair of phases.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Enables/disables the Shaver-Podowski lift correction.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

Specifies the lift function for each pair of phases.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Enables/disables the Shaver-Podowski lift correction.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

mass_transfer(*args, **kwargs)#

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)#

Set the model transition mechanism.

reactions(*args, **kwargs)#

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)#

Specifies the restitution coefficient for collisions between each pair of granular phases, and for collisions between particles of the same granular phase. This command is available only for multiphase flows with two or more granular phases.

slip_velocity(*args, **kwargs)#

Specifies the slip velocity function for each secondary phase with respect to the primary phase. This command is available only for the Mixture multiphase model.

class surface_tension(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set surface tension models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enables/disables the treatment of the contact angle specification at the porous jump boundary.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Selects the surface tension model.
sfc_modeling(*args, **kwargs)	Allows you to include the effects of surface tension along the fluid-fluid interface.
sfc_tension_coeff(*args, **kwargs)	Specifies the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enables/disables the specification for a wall adhesion angle.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enables/disables the treatment of the contact angle specification at the porous jump boundary. This command is available only for the VOF multiphase model with the continuum surface stress model option and when sfc-modeling? is enabled.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Selects the surface tension model. You can choose between the continuum surface force and continuum surface stress methods. This item is available only when sfc-modeling? is enabled.

sfc_modeling(*args, **kwargs)#

Allows you to include the effects of surface tension along the fluid-fluid interface. This option is only available for the VOF and Eulerian multiphase models.

sfc_tension_coeff(*args, **kwargs)#

Specifies the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enables/disables the specification for a wall adhesion angle. This item is available only whensfc-modeling? is enabled.

turbulence_interaction(*args, **kwargs)#

Specifies the turbulence interaction model for each primary-secondary phase pair. This command is available only with the Eulerian multiphase model.

turbulent_dispersion(*args, **kwargs)#

Specifies the turbulent dispersion model for each primary-secondary phase pair. This command is available only with the Eulerian multiphase model.

class virtual_mass(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set virtual mass models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Allows you to include the virtual mass force effect that occurs when a secondary phase accelerates relative to the primary phase.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specifies the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enables/disables the implicit method for the virtual mass force.
vmass_implicit_options(*args, **kwargs)	Specifies what form of the implicit method to use (default, option-2, or option-3).
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Allows you to include the virtual mass force effect that occurs when a secondary phase accelerates relative to the primary phase. This command is available only with the Eulerian multiphase model.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specifies the virtual mass coefficient for each pair of phases. This option is available only ifvirtual-mass? is enabled.

vmass_implicit(*args, **kwargs)#

Enables/disables the implicit method for the virtual mass force. This option can improve convergence in some cases. This option is available only if virtual-mass? is enabled.

vmass_implicit_options(*args, **kwargs)#

Specifies what form of the implicit method to use (default, option-2, or option-3). default models the entire virtual mass force while option-2 and option-3 model truncated expressions which may further improve convergence. This option is available only if vmass-implicit? is enabled.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

wall_lubrication(*args, **kwargs)#

Specifies the wall lubrication model for each primary-secondary phase pair. This command is available only with the Eulerian multiphase model.

class heat_mass_reactions(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set heat, mass-transfer, and reaction models.

Classes:

cavitation(service, version, mode, path)	Enters the menu to set cavitation models.
interphase_discretization(service, version, ...)	Enter the menu to set interphase discretization models.
interphase_viscous_dissipation(service, ...)	Enter the menu to set interphase viscous dissipation related models.
lift(service, version, mode, path)	Enter the menu to set lift models.
surface_tension(service, version, mode, path)	Enter the menu to set surface tension models.
virtual_mass(service, version, mode, path)	Enter the menu to set virtual mass models.

Methods:

drag(*args, **kwargs)	Specify the drag function for each pair of phases.
heat_coeff(*args, **kwargs)	Species the heat transfer coefficient function between each pair of phases (constant-htc, nusselt-number, ranz-marshall, hughmark, tomiyama, fixed-to-sat-temp, two-resistance, or user-defined).
interfacial_area(*args, **kwargs)	Set the interfacial area parameters for each pair of phases.
mass_transfer(*args, **kwargs)	Specify the mass transfer mechanisms.
model_transition(*args, **kwargs)	Set the model transition mechanism.
reactions(*args, **kwargs)	Allows you to define multiple heterogeneous reactions and stoichiometry.
restitution(*args, **kwargs)	Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.
slip_velocity(*args, **kwargs)	Specify the slip velocity function for each secondary phase with respect to the primary phase.
turbulence_interaction(*args, **kwargs)	Specify the turbulence interaction model for each primary-secondary phase pair.
turbulent_dispersion(*args, **kwargs)	Specify the turbulent dispersion model for each primary-secondary phase pair.
wall_lubrication(*args, **kwargs)	Specify the wall lubrication model for each primary-secondary phase pair.

class cavitation(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set cavitation models. This option is available only for the Mixture multiphase model with the Singhal-et-al cavitation model enabled via solve/set/advanced/singhal-et-al-cavitation-model.

Methods:

cavitation(*args, **kwargs)	Sets the vaporization pressure, surface tension coefficient, and non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Sets the vaporization pressure, surface tension coefficient, and non-condensable gas mass fraction. This command is available only when cavitation? is enabled.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

drag(*args, **kwargs)#

Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor.

heat_coeff(*args, **kwargs)#

Species the heat transfer coefficient function between each pair of phases (constant-htc, nusselt-number, ranz-marshall, hughmark, tomiyama, fixed-to-sat-temp, two-resistance, or user-defined). This command is enable only with the Eulerian multiphase model.

interfacial_area(*args, **kwargs)#

Set the interfacial area parameters for each pair of phases.

class interphase_discretization(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set interphase discretization models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class interphase_viscous_dissipation(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set interphase viscous dissipation related models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class lift(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set lift models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

mass_transfer(*args, **kwargs)#

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)#

Set the model transition mechanism.

reactions(*args, **kwargs)#

Allows you to define multiple heterogeneous reactions and stoichiometry. This option is available only with the species model.

restitution(*args, **kwargs)#

Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.

slip_velocity(*args, **kwargs)#

Specify the slip velocity function for each secondary phase with respect to the primary phase.

class surface_tension(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set surface tension models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

turbulence_interaction(*args, **kwargs)#

Specify the turbulence interaction model for each primary-secondary phase pair.

turbulent_dispersion(*args, **kwargs)#

Specify the turbulent dispersion model for each primary-secondary phase pair.

class virtual_mass(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set virtual mass models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

wall_lubrication(*args, **kwargs)#

Specify the wall lubrication model for each primary-secondary phase pair.

class interfacial_area(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set interfacial area models. This menu is available only for the Mixture and Eulerian multiphase models.

Classes:

cavitation(service, version, mode, path)	Enter the menu to set cavitation models.
interphase_discretization(service, version, ...)	Enter the menu to set interphase discretization models.
interphase_viscous_dissipation(service, ...)	Enter the menu to set interphase viscous dissipation related models.
lift(service, version, mode, path)	Enter the menu to set lift models.
surface_tension(service, version, mode, path)	Enter the menu to set surface tension models.
virtual_mass(service, version, mode, path)	Enter the menu to set virtual mass models.

Methods:

drag(*args, **kwargs)	Specify the drag function for each pair of phases.
heat_coeff(*args, **kwargs)	Specify the heat transfer coefficient function between each pair of phases.
interfacial_area(*args, **kwargs)	Specifies the interfacial area model for each pair of phases.
mass_transfer(*args, **kwargs)	Specify the mass transfer mechanisms.
model_transition(*args, **kwargs)	Set the model transition mechanism.
reactions(*args, **kwargs)	Define multiple heterogeneous reactions and stoichiometry.
restitution(*args, **kwargs)	Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.
slip_velocity(*args, **kwargs)	Specify the slip velocity function for each secondary phase with respect to the primary phase.
turbulence_interaction(*args, **kwargs)	Specify the turbulence interaction model for each primary-secondary phase pair.
turbulent_dispersion(*args, **kwargs)	Specify the turbulent dispersion model for each primary-secondary phase pair.
wall_lubrication(*args, **kwargs)	Specify the wall lubrication model for each primary-secondary phase pair.

class cavitation(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set cavitation models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

drag(*args, **kwargs)#

Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor.

heat_coeff(*args, **kwargs)#

Specify the heat transfer coefficient function between each pair of phases.

interfacial_area(*args, **kwargs)#

Specifies the interfacial area model for each pair of phases.

class interphase_discretization(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set interphase discretization models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class interphase_viscous_dissipation(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set interphase viscous dissipation related models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class lift(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set lift models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

mass_transfer(*args, **kwargs)#

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)#

Set the model transition mechanism.

reactions(*args, **kwargs)#

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)#

Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.

slip_velocity(*args, **kwargs)#

Specify the slip velocity function for each secondary phase with respect to the primary phase.

class surface_tension(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set surface tension models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

turbulence_interaction(*args, **kwargs)#

Specify the turbulence interaction model for each primary-secondary phase pair.

turbulent_dispersion(*args, **kwargs)#

Specify the turbulent dispersion model for each primary-secondary phase pair.

class virtual_mass(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set virtual mass models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

wall_lubrication(*args, **kwargs)#

Specify the wall lubrication model for each primary-secondary phase pair.

class model_transition(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set model transition mechanisms.

Classes:

cavitation(service, version, mode, path)	Enter the menu to set cavitation models.
interphase_discretization(service, version, ...)	Enter the menu to set interphase discretization models.
interphase_viscous_dissipation(service, ...)	Enter the menu to set interphase viscous dissipation related models.
lift(service, version, mode, path)	Enter the menu to set lift models.
surface_tension(service, version, mode, path)	Enter the menu to set surface tension models.
virtual_mass(service, version, mode, path)	Enter the menu to set virtual mass models.

Methods:

drag(*args, **kwargs)	Specify the drag function for each pair of phases.
heat_coeff(*args, **kwargs)	Specify the heat transfer coefficient function between each pair of phases.
interfacial_area(*args, **kwargs)	Set the interfacial area parameters for each pair of phases.
mass_transfer(*args, **kwargs)	Specify the mass transfer mechanisms.
model_transition(*args, **kwargs)	Sets the VOF-to-DPM model transition mechanism.
reactions(*args, **kwargs)	Define multiple heterogeneous reactions and stoichiometry.
restitution(*args, **kwargs)	Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.
slip_velocity(*args, **kwargs)	Specify the slip velocity function for each secondary phase with respect to the primary phase.
turbulence_interaction(*args, **kwargs)	Specify the turbulence interaction model for each primary-secondary phase pair.
turbulent_dispersion(*args, **kwargs)	Specify the turbulent dispersion model for each primary-secondary phase pair.
wall_lubrication(*args, **kwargs)	Specify the wall lubrication model for each primary-secondary phase pair.

class cavitation(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set cavitation models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

drag(*args, **kwargs)#

Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor.

heat_coeff(*args, **kwargs)#

Specify the heat transfer coefficient function between each pair of phases.

interfacial_area(*args, **kwargs)#

Set the interfacial area parameters for each pair of phases.

class interphase_discretization(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set interphase discretization models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class interphase_viscous_dissipation(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set interphase viscous dissipation related models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class lift(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set lift models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

mass_transfer(*args, **kwargs)#

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)#

Sets the VOF-to-DPM model transition mechanism.

reactions(*args, **kwargs)#

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)#

Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.

slip_velocity(*args, **kwargs)#

Specify the slip velocity function for each secondary phase with respect to the primary phase.

class surface_tension(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set surface tension models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

turbulence_interaction(*args, **kwargs)#

Specify the turbulence interaction model for each primary-secondary phase pair.

turbulent_dispersion(*args, **kwargs)#

Specify the turbulent dispersion model for each primary-secondary phase pair.

class virtual_mass(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set virtual mass models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

wall_lubrication(*args, **kwargs)#

Specify the wall lubrication model for each primary-secondary phase pair.

class numerics(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set numerics models. This menu is available for multiphase models with the sharp-dispersed and phase localized discretization interface modeling options (set in define/models/multiphase/interface-modeling-options).

Classes:

cavitation(service, version, mode, path)	Enter the menu to set cavitation models.
interphase_discretization(service, version, ...)	Enters the menu to set interphase discretization models.
interphase_viscous_dissipation(service, ...)	Enter the menu to set interphase viscous dissipation related models.
lift(service, version, mode, path)	Enter the menu to set lift models.
surface_tension(service, version, mode, path)	Enter the menu to set surface tension models.
virtual_mass(service, version, mode, path)	Enter the menu to set virtual mass models.

Methods:

drag(*args, **kwargs)	Specify the drag function for each pair of phases.
heat_coeff(*args, **kwargs)	Specify the heat transfer coefficient function between each pair of phases.
interfacial_area(*args, **kwargs)	Set the interfacial area parameters for each pair of phases.
mass_transfer(*args, **kwargs)	Specify the mass transfer mechanisms.
model_transition(*args, **kwargs)	Set the model transition mechanism.
reactions(*args, **kwargs)	Define multiple heterogeneous reactions and stoichiometry.
restitution(*args, **kwargs)	Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.
slip_velocity(*args, **kwargs)	Specify the slip velocity function for each secondary phase with respect to the primary phase.
turbulence_interaction(*args, **kwargs)	Specify the turbulence interaction model for each primary-secondary phase pair.
turbulent_dispersion(*args, **kwargs)	Specify the turbulent dispersion model for each primary-secondary phase pair.
wall_lubrication(*args, **kwargs)	Specify the wall lubrication model for each primary-secondary phase pair.

class cavitation(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set cavitation models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

drag(*args, **kwargs)#

Specify the drag function for each pair of phases. It also enables drag modification and allow specifying the drag factor.

heat_coeff(*args, **kwargs)#

Specify the heat transfer coefficient function between each pair of phases.

interfacial_area(*args, **kwargs)#

Set the interfacial area parameters for each pair of phases.

class interphase_discretization(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set interphase discretization models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enables/disables phase localized compressive scheme.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specifies the slope limiter to set a specific discretization scheme for each phase pair.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enables/disables phase localized compressive scheme.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specifies the slope limiter to set a specific discretization scheme for each phase pair. A value of 0 corresponds to first order upwind, a value of 1 corresponds to second order upwind, a value of 2 applies the compressive scheme, and a value between 0 and 2 corresponds to a blended scheme. This option is available only wheninterphase-discr? is enabled.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class interphase_viscous_dissipation(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set interphase viscous dissipation related models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

class lift(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set lift models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

mass_transfer(*args, **kwargs)#

Specify the mass transfer mechanisms.

model_transition(*args, **kwargs)#

Set the model transition mechanism.

reactions(*args, **kwargs)#

Define multiple heterogeneous reactions and stoichiometry.

restitution(*args, **kwargs)#

Specify the restitution coefficient for collisions between each pair of granular phases and for collisions between particles of the same granular phase.

slip_velocity(*args, **kwargs)#

Specify the slip velocity function for each secondary phase with respect to the primary phase.

class surface_tension(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set surface tension models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

turbulence_interaction(*args, **kwargs)#

Specify the turbulence interaction model for each primary-secondary phase pair.

turbulent_dispersion(*args, **kwargs)#

Specify the turbulent dispersion model for each primary-secondary phase pair.

class virtual_mass(service, version, mode, path)#

Bases: TUIMenu

Enter the menu to set virtual mass models.

Methods:

cavitation(*args, **kwargs)	Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.
interphase_discr(*args, **kwargs)	Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.
interphase_visc_disp(*args, **kwargs)	Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.
jump_adhesion(*args, **kwargs)	Enable the treatment of the contact angle specification at the porous jump boundary?.
lift(*args, **kwargs)	.
lift_montoya(*args, **kwargs)	Include the Montoya correction for Lift.
lift_shaver_podowski(*args, **kwargs)	Include the Shaver-Podowski correction for Lift.
sfc_model_type(*args, **kwargs)	Select the surface tension model.
sfc_modeling(*args, **kwargs)	Include the effects of surface tension along the fluid-fluid interface?.
sfc_tension_coeff(*args, **kwargs)	Specify the surface tension coefficient for each pair of phases.
slope_limiter(*args, **kwargs)	Specify the slope limiter to set a specific discretization scheme.
virtual_mass(*args, **kwargs)	Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.
visc_disp_factor(*args, **kwargs)	Set the dissipation intensity.
vmass_coeff(*args, **kwargs)	Specify the virtual mass coefficient for each pair of phases.
vmass_implicit(*args, **kwargs)	Enable the implicit method for the virtual mass force?.
vmass_implicit_options(*args, **kwargs)	Select the virtual mass implicit option.
wall_adhesion(*args, **kwargs)	Enable the specification for a wall adhesion angle?.

cavitation(*args, **kwargs)#

Set the vaporization pressure, the surface tension coefficient, and the non-condensable gas mass fraction.

interphase_discr(*args, **kwargs)#

Enable the phase localized compressive discretization scheme where the degree of diffusion/sharpness is controlled through the value of the slope limiters?.

interphase_visc_disp(*args, **kwargs)#

Enable the interfacial viscous dissipation method, which introduces an artificial viscous damping term in the momentum equation?.

jump_adhesion(*args, **kwargs)#

Enable the treatment of the contact angle specification at the porous jump boundary?.

lift(*args, **kwargs)#

.

lift_montoya(*args, **kwargs)#

Include the Montoya correction for Lift.

lift_shaver_podowski(*args, **kwargs)#

Include the Shaver-Podowski correction for Lift.

sfc_model_type(*args, **kwargs)#

Select the surface tension model.

sfc_modeling(*args, **kwargs)#

Include the effects of surface tension along the fluid-fluid interface?.

sfc_tension_coeff(*args, **kwargs)#

Specify the surface tension coefficient for each pair of phases.

slope_limiter(*args, **kwargs)#

Specify the slope limiter to set a specific discretization scheme. 0: first order upwind, 1: second order reconstruction bounded by the global minimum/maximum of the volume fraction, 2: compressive. Value between 0 and 2: blended scheme.

virtual_mass(*args, **kwargs)#

Include the virtual mass force that is present when a secondary phase accelerates relative to the primary phase?.

visc_disp_factor(*args, **kwargs)#

Set the dissipation intensity.

vmass_coeff(*args, **kwargs)#

Specify the virtual mass coefficient for each pair of phases.

vmass_implicit(*args, **kwargs)#

Enable the implicit method for the virtual mass force?.

vmass_implicit_options(*args, **kwargs)#

Select the virtual mass implicit option.

wall_adhesion(*args, **kwargs)#

Enable the specification for a wall adhesion angle?.

wall_lubrication(*args, **kwargs)#

Specify the wall lubrication model for each primary-secondary phase pair.

phase_domains(*args, **kwargs)#

Enters the menu to select a specific phase.

physics(*args, **kwargs)#

Manage Physics-regions.

class profiles(service, version, mode, path)#

Bases: TUIMenu

Enters the boundary profiles menu.

Methods:

delete(*args, **kwargs)	Deletes a profile.
delete_all(*args, **kwargs)	Deletes all boundary-profiles.
display_profile_point_cloud_data(*args, **kwargs)	Display Profile Point Cloud Data.
display_profile_surface(*args, **kwargs)	Display the profile as a surface (this option is only available if the specified profile contains node-connectivity data).
interpolation_method(*args, **kwargs)	Chooses the method for interpolation of profiles.
link_profile_to_reference_frame(*args, **kwargs)	Attaches a profile to a reference frame so that the profile will rotate according to the reference frame.
list_profile_fields(*args, **kwargs)	Lists the fields of a particular profile.
list_profile_parameters(*args, **kwargs)	List the parameters of a particular profile.
list_profiles(*args, **kwargs)	Lists all profiles.
morphing(*args, **kwargs)	Enables/disables profile morphing options in Orient Profile panel.
orient_profile(*args, **kwargs)	Re-orient an existing profile.
overlay_profile_point_cloud_data(*args, **kwargs)	Overlay Profile Point Cloud Data.
overlay_profile_surface(*args, **kwargs)	Overlay Profile Surface.
replicate_profile(*args, **kwargs)	Replicate Profile.
set_preference_profile_point_cloud_data(...)	Set Preference Profile Point Cloud Data e.g., Point marker symbol,size,color.
update_interval(*args, **kwargs)	Sets interval between updates of dynamic profiles.

delete(*args, **kwargs)#

Deletes a profile.

delete_all(*args, **kwargs)#

Deletes all boundary-profiles.

display_profile_point_cloud_data(*args, **kwargs)#

Display Profile Point Cloud Data.

display_profile_surface(*args, **kwargs)#

Display the profile as a surface (this option is only available if the specified profile contains node-connectivity data).

interpolation_method(*args, **kwargs)#

Chooses the method for interpolation of profiles.

link_profile_to_reference_frame(*args, **kwargs)#

Attaches a profile to a reference frame so that the profile will rotate according to the reference frame.

list_profile_fields(*args, **kwargs)#

Lists the fields of a particular profile.

list_profile_parameters(*args, **kwargs)#

List the parameters of a particular profile.

list_profiles(*args, **kwargs)#

Lists all profiles.

morphing(*args, **kwargs)#

Enables/disables profile morphing options in Orient Profile panel.

orient_profile(*args, **kwargs)#

Re-orient an existing profile.

overlay_profile_point_cloud_data(*args, **kwargs)#

Overlay Profile Point Cloud Data.

overlay_profile_surface(*args, **kwargs)#

Overlay Profile Surface.

replicate_profile(*args, **kwargs)#

Replicate Profile.

set_preference_profile_point_cloud_data(*args, **kwargs)#

Set Preference Profile Point Cloud Data e.g., Point marker symbol,size,color.

update_interval(*args, **kwargs)#

Sets interval between updates of dynamic profiles.

class reference_frames(service, version, mode, path)#

Bases: TUIMenu

Enters the reference frames menu.

Methods:

add(*args, **kwargs)	Creates a new reference frame.
delete(*args, **kwargs)	Deletes the reference frame you specify.
display(*args, **kwargs)	Displays the reference frame you specify.
display_edit(*args, **kwargs)	Display and edit reference frame from graphics.
edit(*args, **kwargs)	Allows you to edit a reference frame.
hide(*args, **kwargs)	Removes the specified reference frame from the graphics window.
list(*args, **kwargs)	Lists all of the reference frames.
list_properties(*args, **kwargs)	Lists the properties of the reference frame you specify.

add(*args, **kwargs)#

Creates a new reference frame.

delete(*args, **kwargs)#

Deletes the reference frame you specify.

display(*args, **kwargs)#

Displays the reference frame you specify.

display_edit(*args, **kwargs)#

Display and edit reference frame from graphics.

edit(*args, **kwargs)#

Allows you to edit a reference frame.

hide(*args, **kwargs)#

Removes the specified reference frame from the graphics window.

list(*args, **kwargs)#

Lists all of the reference frames.

list_properties(*args, **kwargs)#

Lists the properties of the reference frame you specify.

set_unit_system(*args, **kwargs)#

Applies a standard set of units to all quantities. The options include default,si, british, andcgs.

class solution_strategy(service, version, mode, path)#

Bases: TUIMenu

Enters the automatic initialization and case modification strategy menu.

Methods:

add_edit_modification(*args, **kwargs)	Define a single case modification.
automatic_initialization(*args, **kwargs)	Defines how the case is to be automatically initialized.
continue_strategy_execution(*args, **kwargs)	Continues execution of the currently defined automatic initialization and case modification strategy.
copy_modification(*args, **kwargs)	Copy a single case modification.
delete_modification(*args, **kwargs)	Delete a single case modification.
disable_modification(*args, **kwargs)	Disable a single defined case modification.
enable_modification(*args, **kwargs)	Enable a single defined case modification.
enable_strategy(*args, **kwargs)	Enables/disables automatic initialization and case modification.
execute_strategy(*args, **kwargs)	Executes the currently defined automatic initialization and case modification strategy.
export_modifications(*args, **kwargs)	Export all case modifications to a tsv file.
import_modifications(*args, **kwargs)	Import a list of case modifications from a tsv file.

Classes:

automatic_case_modification(service, ...)

Enters the automatic case modification menu.

add_edit_modification(*args, **kwargs)#

Define a single case modification.

class automatic_case_modification(service, version, mode, path)#

Bases: TUIMenu

Enters the automatic case modification menu.

Methods:

before_init_modification(*args, **kwargs)	Specifies modification to be performed before initialization.
modifications(*args, **kwargs)	Specifies modifications to be performed during solution.
original_settings(*args, **kwargs)	Specifies modification to be performed after initialization to restore to original settings.

before_init_modification(*args, **kwargs)#

Specifies modification to be performed before initialization.

modifications(*args, **kwargs)#

Specifies modifications to be performed during solution.

original_settings(*args, **kwargs)#

Specifies modification to be performed after initialization to restore to original settings.

automatic_initialization(*args, **kwargs)#

Defines how the case is to be automatically initialized.

continue_strategy_execution(*args, **kwargs)#

Continues execution of the currently defined automatic initialization and case modification strategy.

copy_modification(*args, **kwargs)#

Copy a single case modification.

delete_modification(*args, **kwargs)#

Delete a single case modification.

disable_modification(*args, **kwargs)#

Disable a single defined case modification.

enable_modification(*args, **kwargs)#

Enable a single defined case modification.

enable_strategy(*args, **kwargs)#

Enables/disables automatic initialization and case modification.

execute_strategy(*args, **kwargs)#

Executes the currently defined automatic initialization and case modification strategy.

export_modifications(*args, **kwargs)#

Export all case modifications to a tsv file.

import_modifications(*args, **kwargs)#

Import a list of case modifications from a tsv file.

class spectral(service, version, mode, path)#

Bases: TUIMenu

Enter the Spectral menu.

Methods:

calculate_fourier_coefficients(*args, **kwargs)	Calculates Fourier coefficient data.
calculate_harmonic_exports(*args, **kwargs)	Calculates Harmonic Export data.
delete_fourier_coefficients(*args, **kwargs)	Deletes Fourier coefficient data.
delete_harmonic_exports(*args, **kwargs)	Deletes Harmonic Export data.

calculate_fourier_coefficients(*args, **kwargs)#

Calculates Fourier coefficient data.

calculate_harmonic_exports(*args, **kwargs)#

Calculates Harmonic Export data.

delete_fourier_coefficients(*args, **kwargs)#

Deletes Fourier coefficient data.

delete_harmonic_exports(*args, **kwargs)#

Deletes Harmonic Export data.

class turbo_model(service, version, mode, path)#

Bases: TUIMenu

Enters the turbo menu.

Methods:

append_graphics_spectral_content(*args, **kwargs)	Define post-processing related spectral content.
append_phaselag_spectral_content(*args, **kwargs)	Define phaselag related spectral content.
blade_flutter_row(*args, **kwargs)	Define the periodic displacement row.
create_graphics_spectral_content(*args, **kwargs)	Define post-processing related spectral content.
create_phaselag_spectral_content(*args, **kwargs)	Define phaselag related spectral content.
create_turbomachine_description(*args, **kwargs)	Define turbomachine description.
delete_graphics_spectral_content(*args, **kwargs)	Delete post-processing related spectral content.
delete_phaselag_spectral_content(*args, **kwargs)	Delete phaselag related spectral content.
delete_turbomachine_description(*args, **kwargs)	Delete turbomachine description.
enable_turbo_model(*args, **kwargs)	Enables/disables turbo model menu.
graphics_extra_settings(*args, **kwargs)	Define phaselag related extra settings.
list_graphics_spectral_content(*args, **kwargs)	List post-processing related spectral content.
list_phaselag_state(*args, **kwargs)	List all phaselag related case settings.
list_turbomachine_description(*args, **kwargs)	List turbomachine description.
make_phaselag_from_boundaries(*args, **kwargs)	Make interface zones phase lagged.
make_phaselag_from_periodic(*args, **kwargs)	Convert periodic interface to phase lagged.
phaselag_extra_settings(*args, **kwargs)	Define phaselag related extra settings.
separate_nonoverlapping_interface_boundary(...)	Split a general turbo interface non-overlapping zone.
turbo_create(*args, **kwargs)	Creates a general turbo interface.
turbo_interface_check(*args, **kwargs)	Check General Turbo Interface and Phase-lag.

Classes:

blade_flutter_harmonics(service, version, ...)	Enters the blade flutter harmonics options menu.
general_turbo_interface_settings(service, ...)	Enters the General Turbo Interface options menu.
legacy_models(service, version, mode, path)	Enter Legacy Turbo Model Menu.
turbo_topology(service, version, mode, path)	Enters the turbo topology menu.

append_graphics_spectral_content(*args, **kwargs)#

Define post-processing related spectral content.

append_phaselag_spectral_content(*args, **kwargs)#

Define phaselag related spectral content.

class blade_flutter_harmonics(service, version, mode, path)#

Bases: TUIMenu

Enters the blade flutter harmonics options menu.

Methods:

enable_harmonic_exports(*args, **kwargs)	Calculates/Deletes flutter harmonic export data.
write_aerodamping_vs_nodal_diameter(*args, ...)	Reads report definition file and Writes influence coefficient aerodynamic damping values vs nodal diameter.
write_harmonic_exports(*args, **kwargs)	Writes harmonic export data.

enable_harmonic_exports(*args, **kwargs)#

Calculates/Deletes flutter harmonic export data.

write_aerodamping_vs_nodal_diameter(*args, **kwargs)#

Reads report definition file and Writes influence coefficient aerodynamic damping values vs nodal diameter.

write_harmonic_exports(*args, **kwargs)#

Writes harmonic export data.

blade_flutter_row(*args, **kwargs)#

Define the periodic displacement row.

create_graphics_spectral_content(*args, **kwargs)#

Define post-processing related spectral content.

create_phaselag_spectral_content(*args, **kwargs)#

Define phaselag related spectral content.

create_turbomachine_description(*args, **kwargs)#

Define turbomachine description.

delete_graphics_spectral_content(*args, **kwargs)#

Delete post-processing related spectral content.

delete_phaselag_spectral_content(*args, **kwargs)#

Delete phaselag related spectral content.

delete_turbomachine_description(*args, **kwargs)#

Delete turbomachine description.

enable_turbo_model(*args, **kwargs)#

Enables/disables turbo model menu.

class general_turbo_interface_settings(service, version, mode, path)#

Bases: TUIMenu

Enters the General Turbo Interface options menu.

Methods:

expert(*args, **kwargs)

Set the expert parameters for turbo interfaces.

Classes:

mixing_plane_model_settings(service, ...)

Defines settings for the mixing plane model.

expert(*args, **kwargs)#

Set the expert parameters for turbo interfaces.

class mixing_plane_model_settings(service, version, mode, path)#

Bases: TUIMenu

Defines settings for the mixing plane model.

Methods:

averaging_method(*args, **kwargs)	Set the averaging method for the mixing.
bands_type(*args, **kwargs)	Specifies the averaging bands for mixing as fixed or variable width.
list_mixing_planes(*args, **kwargs)	List the settings of mixing planes in the case.
mixing_set_constraint(*args, **kwargs)	To set the mixing of primitive or total variable approach.

Classes:

number_of_bands(service, version, mode, path)

Sets the number of bands to be used for mixing.

averaging_method(*args, **kwargs)#

Set the averaging method for the mixing.

bands_type(*args, **kwargs)#

Specifies the averaging bands for mixing as fixed or variable width.

list_mixing_planes(*args, **kwargs)#

List the settings of mixing planes in the case.

mixing_set_constraint(*args, **kwargs)#

To set the mixing of primitive or total variable approach.

class number_of_bands(service, version, mode, path)#

Bases: TUIMenu

Sets the number of bands to be used for mixing.

Methods:

set_all_interfaces(*args, **kwargs)	Set number of band to be used for mixing.
set_specific_interface(*args, **kwargs)	Set number of band to be used for mixing.

set_all_interfaces(*args, **kwargs)#

Set number of band to be used for mixing.

set_specific_interface(*args, **kwargs)#

Set number of band to be used for mixing.

graphics_extra_settings(*args, **kwargs)#

Define phaselag related extra settings.

class legacy_models(service, version, mode, path)#

Bases: TUIMenu

Enter Legacy Turbo Model Menu.

Classes:

legacy_mixing_plane(service, version, mode, path)

Enter the legacy mixing planes menu.

class legacy_mixing_plane(service, version, mode, path)#

Bases: TUIMenu

Enter the legacy mixing planes menu.

Methods:

create(*args, **kwargs)	Create a mixing plane.
delete(*args, **kwargs)	Delete a mixing plane.
list(*args, **kwargs)	List defined mixing plane(s).
mixing_plane_gui(*args, **kwargs)	GUI for setting up legacy mixing plane model.

Classes:

set(service, version, mode, path)

Enter the mixing plane set menu.

create(*args, **kwargs)#

Create a mixing plane.

delete(*args, **kwargs)#

Delete a mixing plane.

list(*args, **kwargs)#

List defined mixing plane(s).

mixing_plane_gui(*args, **kwargs)#

GUI for setting up legacy mixing plane model.

class set(service, version, mode, path)#

Bases: TUIMenu

Enter the mixing plane set menu.

Methods:

averaging_method(*args, **kwargs)	Set mixing plane profile averaging method.
fix_pressure_level(*args, **kwargs)	Set fix pressure level using define/reference-pressure-location.
under_relaxation(*args, **kwargs)	Set mixing plane under-relaxation factor.

Classes:

conserve_swirl(service, version, mode, path)	Enter the mixing plane conserve-swirl menu.
conserve_total_enthalpy(service, version, ...)	Enter the menu to set total enthalpy conservation in mixing plane menu.

averaging_method(*args, **kwargs)#

Set mixing plane profile averaging method.

class conserve_swirl(service, version, mode, path)#

Bases: TUIMenu

Enter the mixing plane conserve-swirl menu.

Methods:

enable(*args, **kwargs)	Enable/disable swirl conservation in mixing plane.
report_swirl_integration(*args, **kwargs)	Report swirl integration (torque) on inflow and outflow zones.
verbosity(*args, **kwargs)	Enable/disable verbosity in swirl conservation calculations.

enable(*args, **kwargs)#

Enable/disable swirl conservation in mixing plane.

report_swirl_integration(*args, **kwargs)#

Report swirl integration (torque) on inflow and outflow zones.

verbosity(*args, **kwargs)#

Enable/disable verbosity in swirl conservation calculations.

class conserve_total_enthalpy(service, version, mode, path)#

Bases: TUIMenu

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

Methods:

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

enable(*args, **kwargs)#

Enable/disable total enthalpy conservation in mixing plane.

verbosity(*args, **kwargs)#

Enable/disable verbosity in total-enthalpy conservation calculations.

fix_pressure_level(*args, **kwargs)#

Set fix pressure level using define/reference-pressure-location.

under_relaxation(*args, **kwargs)#

Set mixing plane under-relaxation factor.

list_graphics_spectral_content(*args, **kwargs)#

List post-processing related spectral content.

list_phaselag_state(*args, **kwargs)#

List all phaselag related case settings.

list_turbomachine_description(*args, **kwargs)#

List turbomachine description.

make_phaselag_from_boundaries(*args, **kwargs)#

Make interface zones phase lagged.

make_phaselag_from_periodic(*args, **kwargs)#

Convert periodic interface to phase lagged.

phaselag_extra_settings(*args, **kwargs)#

Define phaselag related extra settings.

separate_nonoverlapping_interface_boundary(*args, **kwargs)#

Split a general turbo interface non-overlapping zone.

turbo_create(*args, **kwargs)#

Creates a general turbo interface.

turbo_interface_check(*args, **kwargs)#

Check General Turbo Interface and Phase-lag.

class turbo_topology(service, version, mode, path)#

Bases: TUIMenu

Enters the turbo topology menu.

Methods:

define_topology(*args, **kwargs)	Defines a turbo topology.
delete(*args, **kwargs)	Deletes a previously created turbo topology.
mesh_method(*args, **kwargs)	Sets turbo structured mesh generation method.
projection_method(*args, **kwargs)	Sets 2D projection method.
search_method(*args, **kwargs)	Sets search method for a topology.

define_topology(*args, **kwargs)#

Defines a turbo topology.

delete(*args, **kwargs)#

Deletes a previously created turbo topology.

mesh_method(*args, **kwargs)#

Sets turbo structured mesh generation method.

projection_method(*args, **kwargs)#

Sets 2D projection method.

search_method(*args, **kwargs)#

Sets search method for a topology.

units(*args, **kwargs)#

Sets unit conversion factors.

class user_defined(service, version, mode, path)#

Bases: TUIMenu

Enters the user-defined functions and scalars menu.

Methods:

auto_compile_compiled_udfs(*args, **kwargs)	For this Fluent session, specify whether to allow auto-compilation of compiled UDF when a case file (or settings file) is read.
compile_customized_addon_module(*args, **kwargs)	Compile customized addon module?.
compiled_functions(*args, **kwargs)	Opens user-defined function library.
enable_udf_on_gpu(*args, **kwargs)	Compile UDFs with OpenCL support.
execute_on_demand(*args, **kwargs)	Executes UDFs on demand.
fan_model(*args, **kwargs)	Configures user-defined fan model.
function_hooks(*args, **kwargs)	Hooks up user-defined functions.
interpreted_functions(*args, **kwargs)	Loads interpreted user-defined functions.
one_D_coupling(*args, **kwargs)	Load 1D library.
use_built_in_compiler(*args, **kwargs)	Enables/disables the use of a built-in compiler (Clang) when the define/user-defined/compiled-functions text command is used.
use_contributed_cpp(*args, **kwargs)	Enable/disable use of cpp from the Fluent.Inc/contrib directory.
use_zone_based_udm(*args, **kwargs)	Zone based user-defined memory.
user_defined_memory(*args, **kwargs)	Allocates user-defined memory.
user_defined_node_memory(*args, **kwargs)	Allocate user-defined node memory.
user_defined_scalars(*args, **kwargs)	Defines user-defined scalars.

Classes:

real_gas_models(service, version, mode, path)

Enters the real-gas menu to enable/configure real gas model.

auto_compile_compiled_udfs(*args, **kwargs)#

For this Fluent session, specify whether to allow auto-compilation of compiled UDF when a case file (or settings file) is read.

compile_customized_addon_module(*args, **kwargs)#

Compile customized addon module?.

compiled_functions(*args, **kwargs)#

Opens user-defined function library.

enable_udf_on_gpu(*args, **kwargs)#

Compile UDFs with OpenCL support.

execute_on_demand(*args, **kwargs)#

Executes UDFs on demand.

fan_model(*args, **kwargs)#

Configures user-defined fan model.

function_hooks(*args, **kwargs)#

Hooks up user-defined functions.

interpreted_functions(*args, **kwargs)#

Loads interpreted user-defined functions.

one_D_coupling(*args, **kwargs)#

Load 1D library.

class real_gas_models(service, version, mode, path)#

Bases: TUIMenu

Enters the real-gas menu to enable/configure real gas model.

Methods:

nist_multispecies_real_gas_model(*args, **kwargs)	Loads the NIST real-gas library.
nist_real_gas_model(*args, **kwargs)	Loads the NIST real-gas library.
nist_settings(*args, **kwargs)	Specifies the name and the location for the REFPROP library and fluid files.
set_state(*args, **kwargs)	Selects the state for NIST real gas model.
user_defined_multispecies_real_gas_model(...)	Loads a user-defined multispecies real-gas library.
user_defined_real_gas_model(*args, **kwargs)	Loads the user-defined real-gas library.

nist_multispecies_real_gas_model(*args, **kwargs)#

Loads the NIST real-gas library.

nist_real_gas_model(*args, **kwargs)#

Loads the NIST real-gas library.

nist_settings(*args, **kwargs)#

Specifies the name and the location for the REFPROP library and fluid files.

set_state(*args, **kwargs)#

Selects the state for NIST real gas model.

user_defined_multispecies_real_gas_model(*args, **kwargs)#

Loads a user-defined multispecies real-gas library.

user_defined_real_gas_model(*args, **kwargs)#

Loads the user-defined real-gas library.

use_built_in_compiler(*args, **kwargs)#

Enables/disables the use of a built-in compiler (Clang) when the define/user-defined/compiled-functions text command is used. This text command / compiler is available for Windows only, and is provided as part of the ANSYS Fluent installation. It is recommended that you enable this text command when the compiler you installed on your machine is an older version that is no longer supported. Note that the built-in compiler is used automatically if Fluent determines that you have not installed Microsoft Visual Studio or Clang on your computer, whether this text command is enabled or not.

use_contributed_cpp(*args, **kwargs)#

Enable/disable use of cpp from the Fluent.Inc/contrib directory.

use_zone_based_udm(*args, **kwargs)#

Zone based user-defined memory.

user_defined_memory(*args, **kwargs)#

Allocates user-defined memory.

user_defined_node_memory(*args, **kwargs)#

Allocate user-defined node memory.

user_defined_scalars(*args, **kwargs)#

Defines user-defined scalars.

class virtual_boundary(service, version, mode, path)#

Bases: TUIMenu

Manage Virtual Boundaries.

Methods:

boundary_interface(*args, **kwargs)	Create a Boundary Interface.
hole_geometry(*args, **kwargs)	Create a Hole Geometry template.

boundary_interface(*args, **kwargs)#

Create a Boundary Interface.

hole_geometry(*args, **kwargs)#

Create a Hole Geometry template.

class display(service, version, mode, path)#

Bases: TUIMenu

Enter the display menu.

Methods:

add_custom_vector(*args, **kwargs)	Adds new custom vector definition.
annotate(*args, **kwargs)	Add a text annotation string to the active graphics window.
clear_annotations(*args, **kwargs)	Removes all annotations and attachment lines from the active graphics window.
close_window(*args, **kwargs)	Close a "user" graphics window.
close_window_by_name(*args, **kwargs)	Close a reserved graphics window (windows used for residuals, report plots, and animation definitions).
contour(*args, **kwargs)	Prompts for a scalar field and minimum and maximum values, and then displays a contour plot.
display_custom_vector(*args, **kwargs)	Displays custom vector.
graphics_window_layout(*args, **kwargs)	Arranges the graphics window layout.
grid(*args, **kwargs)	Display the mesh.
grid_outline(*args, **kwargs)	Display the mesh boundaries.
hsf_file(*args, **kwargs)	Loads an HSF file for viewing.
mesh(*args, **kwargs)	Displays the entire mesh.
mesh_outline(*args, **kwargs)	Displays the mesh boundaries.
mesh_partition_boundary(*args, **kwargs)	Displays mesh partition boundaries.
multigrid_coarsening(*args, **kwargs)	Displays a coarse mesh level from the last multigrid coarsening.
open_window(*args, **kwargs)	Opens a graphics window.
profile(*args, **kwargs)	Displays profiles of a flow variable.
re_render(*args, **kwargs)	Re-renders the last contour, profile, or vector plot with updated surfaces, meshed, lights, colormap, rendering options, and so on, without recalculating the contour data.
re_scale(*args, **kwargs)	Re-renders the last contour, profile, or vector plot with updated scale, surfaces, meshes, lights, colormap, rendering options, and so on, but without recalculating the field data.
reacting_channel_curves(*args, **kwargs)	Plots the reacting channel variables.
save_picture(*args, **kwargs)	Generate a "hardcopy" of the active window.
set_list_tree_separator(*args, **kwargs)	Set the separator character for list tree.
set_window(*args, **kwargs)	Sets a "user" graphics window to be the active window.
set_window_by_name(*args, **kwargs)	Sets the specified graphics window as active.
surface_cells(*args, **kwargs)	Draws the cells on the specified surfaces.
surface_mesh(*args, **kwargs)	Draws the mesh defined by the specified surfaces.
switch_to_post_processing_volume(*args, **kwargs)	Switch to post processing volume.
switch_to_primary_volume(*args, **kwargs)	Switch to primary volume.
transient_post_processing(*args, **kwargs)	Enter transient postprocessing menu.
update_layout(*args, **kwargs)	Update the fluent layout.
vector(*args, **kwargs)	Displays vectors of a space vector variable.
velocity_vector(*args, **kwargs)	Prompts for a scalar field by which to color the vectors, the minimum and maximum values, and the scale factor, and then draws the velocity vectors.
zone_mesh(*args, **kwargs)	Draws the mesh defined by specified face zones.

Classes:

define(service, version, mode, path)	Enter Display define menu.
display_states(service, version, mode, path)	Enter the display state manipulation menu.
embedded_windows(service, version, mode, path)	Enter the embedded window menu.
flamelet_data(service, version, mode, path)	Displays flamelet data.
objects(service, version, mode, path)	Enter to add, edit, delete or display graphics objects.
particle_tracks(service, version, mode, path)	Enters the particle tracks menu.
path_lines(service, version, mode, path)	Enters the pathlines menu.
pdf_data(service, version, mode, path)	Enters the PDF data menu.
raytracer(service, version, mode, path)	.
set(service, version, mode, path)	Enter the set menu to set display parameters.
surface(service, version, mode, path)	Enters the data surface-manipulation menu.
update_scene(service, version, mode, path)	Enter the scene options menu.
view_sync(service, version, mode, path)	Synchronize window views.
views(service, version, mode, path)	.

add_custom_vector(*args, **kwargs)#

Adds new custom vector definition.

annotate(*args, **kwargs)#

Add a text annotation string to the active graphics window.

clear_annotations(*args, **kwargs)#

Removes all annotations and attachment lines from the active graphics window.

close_window(*args, **kwargs)#

Close a “user” graphics window. User windows are specified by number (1-50), with the associated number corresponding to the order, left-to-right, that the windows were created in.

close_window_by_name(*args, **kwargs)#

Close a reserved graphics window (windows used for residuals, report plots, and animation definitions).

contour(*args, **kwargs)#

Prompts for a scalar field and minimum and maximum values, and then displays a contour plot.

class define(service, version, mode, path)#

Bases: TUIMenu

Enter Display define menu.

Classes:

material(service, version, mode, path)

Add, Edit, Remove materials in case file.

class material(service, version, mode, path)#

Bases: TUIMenu

Add, Edit, Remove materials in case file.

Methods:

copy(*args, **kwargs)	Copy to new material.
delete(*args, **kwargs)	Remove material.
edit(*args, **kwargs)	Edit material.
new(*args, **kwargs)	Create new material.

copy(*args, **kwargs)#

Copy to new material.

delete(*args, **kwargs)#

Remove material.

edit(*args, **kwargs)#

Edit material.

new(*args, **kwargs)#

Create new material.

display_custom_vector(*args, **kwargs)#

Displays custom vector.

class display_states(service, version, mode, path)#

Bases: TUIMenu

Enter the display state manipulation menu.

Methods:

apply(*args, **kwargs)	Apply a display state to the active window.
copy(*args, **kwargs)	Create a new display state with settings copied from an existing display state.
create(*args, **kwargs)	Create a new display state.
delete(*args, **kwargs)	Delete a display state.
edit(*args, **kwargs)	Edit a particular display state setting.
list(*args, **kwargs)	Print the names of the available display states to the console.
read(*args, **kwargs)	Read display states from a file.
use_active(*args, **kwargs)	Update an existing display state's settings to match those of the active graphics window.
write(*args, **kwargs)	Write display states to a file.

apply(*args, **kwargs)#

Apply a display state to the active window.

copy(*args, **kwargs)#

Create a new display state with settings copied from an existing display state.

create(*args, **kwargs)#

Create a new display state.

delete(*args, **kwargs)#

Delete a display state.

edit(*args, **kwargs)#

Edit a particular display state setting.

list(*args, **kwargs)#

Print the names of the available display states to the console.

read(*args, **kwargs)#

Read display states from a file.

use_active(*args, **kwargs)#

Update an existing display state’s settings to match those of the active graphics window.

write(*args, **kwargs)#

Write display states to a file.

class embedded_windows(service, version, mode, path)#

Bases: TUIMenu

Enter the embedded window menu.

Methods:

close(*args, **kwargs)	Close an embedded window.
close_all(*args, **kwargs)	Close all the embedded windows within the specified parent window.
embed_in(*args, **kwargs)	Specify a window to embed and a parent window to receive the embedded window.
move_out(*args, **kwargs)	Move an embedded window out of the parent window, returning the embedded window to a non-embedded state.
move_out_all(*args, **kwargs)	Move all the embedded windows out of the specified parent window.
update_dimensions(*args, **kwargs)	Update the embedded windows dimensions.

close(*args, **kwargs)#

Close an embedded window.

close_all(*args, **kwargs)#

Close all the embedded windows within the specified parent window.

embed_in(*args, **kwargs)#

Specify a window to embed and a parent window to receive the embedded window.

move_out(*args, **kwargs)#

Move an embedded window out of the parent window, returning the embedded window to a non-embedded state.

move_out_all(*args, **kwargs)#

Move all the embedded windows out of the specified parent window.

update_dimensions(*args, **kwargs)#

Update the embedded windows dimensions.

class flamelet_data(service, version, mode, path)#

Bases: TUIMenu

Displays flamelet data.

Methods:

carpet_plot(*args, **kwargs)	Enables/disables display of carpet plot of a property.
draw_number_box(*args, **kwargs)	Enables/disables display of the numbers box.
plot_1d_slice(*args, **kwargs)	Enables/disables plot of the 1D-slice.
write_to_file(*args, **kwargs)	Enables/disables writing the 1D-slice to file instead of plot.

carpet_plot(*args, **kwargs)#

Enables/disables display of carpet plot of a property.

draw_number_box(*args, **kwargs)#

Enables/disables display of the numbers box.

plot_1d_slice(*args, **kwargs)#

Enables/disables plot of the 1D-slice.

write_to_file(*args, **kwargs)#

Enables/disables writing the 1D-slice to file instead of plot.

graphics_window_layout(*args, **kwargs)#

Arranges the graphics window layout.

grid(*args, **kwargs)#

Display the mesh.

grid_outline(*args, **kwargs)#

Display the mesh boundaries.

hsf_file(*args, **kwargs)#

Loads an HSF file for viewing.

mesh(*args, **kwargs)#

Displays the entire mesh. For 3D, you will be asked to confirm that you really want to draw the entire mesh (not just themesh-outline).

mesh_outline(*args, **kwargs)#

Displays the mesh boundaries.

mesh_partition_boundary(*args, **kwargs)#

Displays mesh partition boundaries.

multigrid_coarsening(*args, **kwargs)#

Displays a coarse mesh level from the last multigrid coarsening.

class objects(service, version, mode, path)#

Bases: TUIMenu

Enter to add, edit, delete or display graphics objects.

Methods:

add_to_graphics(*args, **kwargs)	Add graphics object to existing graphics.
copy(*args, **kwargs)	Copy graphics object.
create(*args, **kwargs)	Create new graphics object.
delete(*args, **kwargs)	Delete graphics object.
display(*args, **kwargs)	Display graphics object.
edit(*args, **kwargs)	Edit graphics object.

add_to_graphics(*args, **kwargs)#

Add graphics object to existing graphics.

copy(*args, **kwargs)#

Copy graphics object.

create(*args, **kwargs)#

Create new graphics object.

delete(*args, **kwargs)#

Delete graphics object.

display(*args, **kwargs)#

Display graphics object.

edit(*args, **kwargs)#

Edit graphics object.

open_window(*args, **kwargs)#

Opens a graphics window.

class particle_tracks(service, version, mode, path)#

Bases: TUIMenu

Enters the particle tracks menu.

Methods:

particle_tracks(*args, **kwargs)	Calculates and displays particle tracks from defined injections.
plot_write_xy_plot(*args, **kwargs)	Plots or writes an XY plot of particle tracks.

particle_tracks(*args, **kwargs)#

Calculates and displays particle tracks from defined injections.

plot_write_xy_plot(*args, **kwargs)#

Plots or writes an XY plot of particle tracks.

class path_lines(service, version, mode, path)#

Bases: TUIMenu

Enters the pathlines menu.

Methods:

path_lines(*args, **kwargs)	Displays pathlines from a surface.
plot_write_xy_plot(*args, **kwargs)	Plots or writes an XY plot of pathlines.
write_to_files(*args, **kwargs)	Writes pathlines to a file.

path_lines(*args, **kwargs)#

Displays pathlines from a surface.

plot_write_xy_plot(*args, **kwargs)#

Plots or writes an XY plot of pathlines.

write_to_files(*args, **kwargs)#

Writes pathlines to a file.

class pdf_data(service, version, mode, path)#

Bases: TUIMenu

Enters the PDF data menu.

Methods:

carpet_plot(*args, **kwargs)	Enables/disables the display of a carpet plot of a property.
draw_number_box(*args, **kwargs)	Enables/disables the display of the numbers box.
plot_1d_slice(*args, **kwargs)	Enables/disables a plot of the 1D-slice.
write_to_file(*args, **kwargs)	Enables/disables writing the 1D-slice to file instead of plot.

carpet_plot(*args, **kwargs)#

Enables/disables the display of a carpet plot of a property.

draw_number_box(*args, **kwargs)#

Enables/disables the display of the numbers box.

plot_1d_slice(*args, **kwargs)#

Enables/disables a plot of the 1D-slice.

write_to_file(*args, **kwargs)#

Enables/disables writing the 1D-slice to file instead of plot.

profile(*args, **kwargs)#

Displays profiles of a flow variable.

class raytracer(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

background(service, version, mode, path)	.
rendering(service, version, mode, path)	.

Methods:

display_live_preview(*args, **kwargs)

.

class background(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

backplate_color(*args, **kwargs)	.
backplate_image(*args, **kwargs)	.
environment_image(*args, **kwargs)	.
hide_environment_keep_effects(*args, **kwargs)	.
latitude(*args, **kwargs)	.
longitude(*args, **kwargs)	.
show_backplate(*args, **kwargs)	.
view_zoom(*args, **kwargs)	.

backplate_color(*args, **kwargs)#

.

backplate_image(*args, **kwargs)#

.

environment_image(*args, **kwargs)#

.

hide_environment_keep_effects(*args, **kwargs)#

.

latitude(*args, **kwargs)#

.

longitude(*args, **kwargs)#

.

show_backplate(*args, **kwargs)#

.

view_zoom(*args, **kwargs)#

.

display_live_preview(*args, **kwargs)#

.

class rendering(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

denoiser(*args, **kwargs)	.
max_rendering_timeout(*args, **kwargs)	.
quality(*args, **kwargs)	.
thread_count(*args, **kwargs)	.

denoiser(*args, **kwargs)#

.

max_rendering_timeout(*args, **kwargs)#

.

quality(*args, **kwargs)#

.

thread_count(*args, **kwargs)#

.

re_render(*args, **kwargs)#

Re-renders the last contour, profile, or vector plot with updated surfaces, meshed, lights, colormap, rendering options, and so on, without recalculating the contour data.

re_scale(*args, **kwargs)#

Re-renders the last contour, profile, or vector plot with updated scale, surfaces, meshes, lights, colormap, rendering options, and so on, but without recalculating the field data.

reacting_channel_curves(*args, **kwargs)#

Plots the reacting channel variables.

save_picture(*args, **kwargs)#

Generate a “hardcopy” of the active window.

class set(service, version, mode, path)#

Bases: TUIMenu

Enter the set menu to set display parameters.

Methods:

color_map(*args, **kwargs)	Enters the color map menu, which contains names of predefined and user-defined (in the Colormap Editor panel) colormaps that can be selected.
duplicate_node_display(*args, **kwargs)	Set flag to remove duplicate nodes in mesh display.
element_shrink(*args, **kwargs)	Sets shrinkage of both faces and cells.
filled_grid(*args, **kwargs)	Enable/disable the filled mesh option.
filled_mesh(*args, **kwargs)	Determines whether the meshes are drawn as wireframe or solid.
grid_level(*args, **kwargs)	Set coarse mesh level to be drawn.
grid_partitions(*args, **kwargs)	Enable/disable drawing of the mesh partition boundaries.
grid_surfaces(*args, **kwargs)	Set surface IDs to be drawn as mesh.
grid_zones(*args, **kwargs)	Set zone IDs to be drawn as mesh.
line_weight(*args, **kwargs)	Set the line-weight factor for the window.
marker_size(*args, **kwargs)	Sets the size of markers used to represent points.
marker_symbol(*args, **kwargs)	Sets the type of markers used to represent points.
mesh_display_configuration(*args, **kwargs)	Changes the default mesh display.
mesh_level(*args, **kwargs)	Sets coarse mesh level to be drawn.
mesh_partitions(*args, **kwargs)	Enables/disables option to draw mesh partition boundaries.
mesh_surfaces(*args, **kwargs)	Sets surface IDs to be drawn as meshes.
mesh_zones(*args, **kwargs)	Sets zone IDs to be drawn as meshes.
mirror_zones(*args, **kwargs)	Sets the zones about which the domain is mirrored (symmetry planes).
n_stream_func(*args, **kwargs)	Sets number of iterations used in computing stream function.
nodewt_based_interp(*args, **kwargs)	Disables/enables the use of node weights for node-based gradients in postprocessing.
overlays(*args, **kwargs)	Enable/disable overlays.
periodic_instancing(*args, **kwargs)	Sets the number of periodic repetitions.
periodic_repeats(*args, **kwargs)	Sets the number of periodic repetitions.
proximity_zones(*args, **kwargs)	Sets zones to be used for boundary cell distance and boundary proximity.
render_mesh(*args, **kwargs)	Enables/disables rendering the mesh on top of contours, vectors, and so on.
reset_graphics(*args, **kwargs)	Reset the graphics system.
zero_angle_dir(*args, **kwargs)	Sets the vector having zero angular coordinates.

Classes:

colors(service, version, mode, path)	Enter the color options menu.
contours(service, version, mode, path)	Enters the contour options menu.
lights(service, version, mode, path)	Enter the lights menu.
particle_tracks(service, version, mode, path)	Enters the particle-tracks menu to set parameters for display of particle tracks.
path_lines(service, version, mode, path)	Sets parameters for display of pathlines.
picture(service, version, mode, path)	Enter the hardcopy/save-picture options menu.
rendering_options(service, version, mode, path)	Enter the rendering options menu.
titles(service, version, mode, path)	Set problem title.
velocity_vectors(service, version, mode, path)	Enters the menu to set parameters for display of velocity vectors.
windows(service, version, mode, path)	.

color_map(*args, **kwargs)#

Enters the color map menu, which contains names of predefined and user-defined (in the Colormap Editor panel) colormaps that can be selected. It prompts you for the name of the colormap to be used.

class colors(service, version, mode, path)#

Bases: TUIMenu

Enter the color options menu.

Methods:

automatic_skip(*args, **kwargs)	Determine whether to skip labels in the colopmap scale automatically.
axis_faces(*args, **kwargs)	Set the color of axisymmetric faces.
background(*args, **kwargs)	Set the background (window) color.
color_by_type(*args, **kwargs)	Determine whether to color meshes by type or by surface (ID).
far_field_faces(*args, **kwargs)	Set the color of far field faces.
foreground(*args, **kwargs)	Set the foreground (text and window frame) color.
free_surface_faces(*args, **kwargs)	Set the color of free-surface faces.
graphics_color_theme(*args, **kwargs)	Enter the graphics color theme menu.
grid_inlet(*args, **kwargs)	Set the color of inlet faces.
grid_interior(*args, **kwargs)	Set the color of interior faces.
highlight_color(*args, **kwargs)	Set highlight color.
inlet_faces(*args, **kwargs)	Set the color of inlet faces.
interface_faces(*args, **kwargs)	Set the color of mesh Interfaces.
interior_faces(*args, **kwargs)	Set the color of interior faces.
internal_faces(*args, **kwargs)	Set the color of internal interface faces.
list(*args, **kwargs)	List available colors.
outlet_faces(*args, **kwargs)	Set the color of outlet faces.
overset_faces(*args, **kwargs)	Set the color of overset faces.
periodic_faces(*args, **kwargs)	Set the color of periodic faces.
rans_les_interface_faces(*args, **kwargs)	Set the color of RANS/LES interface faces.
reset_colors(*args, **kwargs)	Reset individual mesh surface colors to the defaults.
reset_user_colors(*args, **kwargs)	Reset all user colors.
show_user_colors(*args, **kwargs)	List currently defined user colors.
skip_label(*args, **kwargs)	Set the number of labels to be skipped in the colopmap scale.
surface(*args, **kwargs)	Set the color of surfaces.
symmetry_faces(*args, **kwargs)	Set the color of symmetric faces.
traction_faces(*args, **kwargs)	Set the color of traction faces.
user_color(*args, **kwargs)	Explicitly set color of display zone.
wall_faces(*args, **kwargs)	Set the color of wall faces.

Classes:

by_surface(service, version, mode, path)	Enter the surface(s) color and material assignment menu.
by_type(service, version, mode, path)	Enter the zone type color and material assignment menu.

automatic_skip(*args, **kwargs)#

Determine whether to skip labels in the colopmap scale automatically.

axis_faces(*args, **kwargs)#

Set the color of axisymmetric faces.

background(*args, **kwargs)#

Set the background (window) color.

class by_surface(service, version, mode, path)#

Bases: TUIMenu

Enter the surface(s) color and material assignment menu.

Methods:

list_surfaces_by_color(*args, **kwargs)	To list the surfaces by its color.
list_surfaces_by_material(*args, **kwargs)	To list the surfaces by its material.
reset(*args, **kwargs)	To reset colors and/or materials to the defaults.
surfaces(*args, **kwargs)	Select the surface(s) to specify colors and/or materials.
use_inherent_material_color(*args, **kwargs)	Use inherent material color for surfaces.

list_surfaces_by_color(*args, **kwargs)#

To list the surfaces by its color.

list_surfaces_by_material(*args, **kwargs)#

To list the surfaces by its material.

reset(*args, **kwargs)#

To reset colors and/or materials to the defaults.

surfaces(*args, **kwargs)#

Select the surface(s) to specify colors and/or materials.

use_inherent_material_color(*args, **kwargs)#

Use inherent material color for surfaces.

class by_type(service, version, mode, path)#

Bases: TUIMenu

Enter the zone type color and material assignment menu.

Methods:

only_list_case_boundaries(*args, **kwargs)	Only list the boundary types that are assigned in this case.
reset(*args, **kwargs)	To reset colors and/or materials to the defaults.
use_inherent_material_color(*args, **kwargs)	Use inherent material color for boundary zones.

Classes:

type_name(service, version, mode, path)

Select the boundary type to specify colors and/or materials.

only_list_case_boundaries(*args, **kwargs)#

Only list the boundary types that are assigned in this case.

reset(*args, **kwargs)#

To reset colors and/or materials to the defaults.

class type_name(service, version, mode, path)#

Bases: TUIMenu

Select the boundary type to specify colors and/or materials.

Methods:

axis(*args, **kwargs)	Set the material and/or color for the selected boundary type.
far_field(*args, **kwargs)	Set the material and/or color for the selected boundary type.
free_surface(*args, **kwargs)	Set the material and/or color for the selected boundary type.
inlet(*args, **kwargs)	Set the material and/or color for the selected boundary type.
interface(*args, **kwargs)	Set the material and/or color for the selected boundary type.
interior(*args, **kwargs)	Set the material and/or color for the selected boundary type.
internal(*args, **kwargs)	Set the material and/or color for the selected boundary type.
outlet(*args, **kwargs)	Set the material and/or color for the selected boundary type.
overset(*args, **kwargs)	Set the material and/or color for the selected boundary type.
periodic(*args, **kwargs)	Set the material and/or color for the selected boundary type.
rans_les_interface(*args, **kwargs)	Set the material and/or color for the selected boundary type.
surface(*args, **kwargs)	Set the material and/or color for the selected boundary type.
symmetry(*args, **kwargs)	Set the material and/or color for the selected boundary type.
traction(*args, **kwargs)	Set the material and/or color for the selected boundary type.
wall(*args, **kwargs)	Set the material and/or color for the selected boundary type.

axis(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

far_field(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

free_surface(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

inlet(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

interface(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

interior(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

internal(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

outlet(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

overset(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

periodic(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

rans_les_interface(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

surface(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

symmetry(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

traction(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

wall(*args, **kwargs)#

Set the material and/or color for the selected boundary type.

use_inherent_material_color(*args, **kwargs)#

Use inherent material color for boundary zones.

color_by_type(*args, **kwargs)#

Determine whether to color meshes by type or by surface (ID).

far_field_faces(*args, **kwargs)#

Set the color of far field faces.

foreground(*args, **kwargs)#

Set the foreground (text and window frame) color.

free_surface_faces(*args, **kwargs)#

Set the color of free-surface faces.

graphics_color_theme(*args, **kwargs)#

Enter the graphics color theme menu.

grid_inlet(*args, **kwargs)#

Set the color of inlet faces.

grid_interior(*args, **kwargs)#

Set the color of interior faces.

highlight_color(*args, **kwargs)#

Set highlight color.

inlet_faces(*args, **kwargs)#

Set the color of inlet faces.

interface_faces(*args, **kwargs)#

Set the color of mesh Interfaces.

interior_faces(*args, **kwargs)#

Set the color of interior faces.

internal_faces(*args, **kwargs)#

Set the color of internal interface faces.

list(*args, **kwargs)#

List available colors.

outlet_faces(*args, **kwargs)#

Set the color of outlet faces.

overset_faces(*args, **kwargs)#

Set the color of overset faces.

periodic_faces(*args, **kwargs)#

Set the color of periodic faces.

rans_les_interface_faces(*args, **kwargs)#

Set the color of RANS/LES interface faces.

reset_colors(*args, **kwargs)#

Reset individual mesh surface colors to the defaults.

reset_user_colors(*args, **kwargs)#

Reset all user colors.

show_user_colors(*args, **kwargs)#

List currently defined user colors.

skip_label(*args, **kwargs)#

Set the number of labels to be skipped in the colopmap scale.

surface(*args, **kwargs)#

Set the color of surfaces.

symmetry_faces(*args, **kwargs)#

Set the color of symmetric faces.

traction_faces(*args, **kwargs)#

Set the color of traction faces.

user_color(*args, **kwargs)#

Explicitly set color of display zone.

wall_faces(*args, **kwargs)#

Set the color of wall faces.

class contours(service, version, mode, path)#

Bases: TUIMenu

Enters the contour options menu.

Methods:

auto_range(*args, **kwargs)	Enables/disables auto-computation of the contour range.
clip_to_range(*args, **kwargs)	Turns the clip to range option for filled contours on/off.
coloring(*args, **kwargs)	Specifies whether contours are displayed in bands or with smooth transitions.
filled_contours(*args, **kwargs)	Turns the filled contours option on/off (deselects line-contours?).
global_range(*args, **kwargs)	Turns the global range for contours on/off.
line_contours(*args, **kwargs)	Turns the line contours option on/off (deselects filled-contours?).
log_scale(*args, **kwargs)	Specifies a decimal or logarithmic color scale for contours.
n_contour(*args, **kwargs)	Sets the number of contour levels.
node_values(*args, **kwargs)	Sets the option to use scalar field at nodes when computing the contours.
render_mesh(*args, **kwargs)	Determines whether or not to render the mesh on top of contours, vectors, and so on.
surfaces(*args, **kwargs)	Sets the surfaces on which contours are drawn.

auto_range(*args, **kwargs)#

Enables/disables auto-computation of the contour range.

clip_to_range(*args, **kwargs)#

Turns the clip to range option for filled contours on/off.

coloring(*args, **kwargs)#

Specifies whether contours are displayed in bands or with smooth transitions. Note that you can only display smooth contours if node-values are enabled.

filled_contours(*args, **kwargs)#

Turns the filled contours option on/off (deselects line-contours?).

global_range(*args, **kwargs)#

Turns the global range for contours on/off.

line_contours(*args, **kwargs)#

Turns the line contours option on/off (deselects filled-contours?).

log_scale(*args, **kwargs)#

Specifies a decimal or logarithmic color scale for contours.

n_contour(*args, **kwargs)#

Sets the number of contour levels.

node_values(*args, **kwargs)#

Sets the option to use scalar field at nodes when computing the contours.

render_mesh(*args, **kwargs)#

Determines whether or not to render the mesh on top of contours, vectors, and so on.

surfaces(*args, **kwargs)#

Sets the surfaces on which contours are drawn. You can include a wildcard (*) within the surface names.

duplicate_node_display(*args, **kwargs)#

Set flag to remove duplicate nodes in mesh display.

element_shrink(*args, **kwargs)#

Sets shrinkage of both faces and cells. A value of zero indicates no shrinkage, while a value of one will shrink each face or cell to a point.

filled_grid(*args, **kwargs)#

Enable/disable the filled mesh option.

filled_mesh(*args, **kwargs)#

Determines whether the meshes are drawn as wireframe or solid.

grid_level(*args, **kwargs)#

Set coarse mesh level to be drawn.

grid_partitions(*args, **kwargs)#

Enable/disable drawing of the mesh partition boundaries.

grid_surfaces(*args, **kwargs)#

Set surface IDs to be drawn as mesh.

grid_zones(*args, **kwargs)#

Set zone IDs to be drawn as mesh.

class lights(service, version, mode, path)#

Bases: TUIMenu

Enter the lights menu.

Methods:

headlight_on(*args, **kwargs)	Turn the light that moves with the camera on or off.
lighting_interpolation(*args, **kwargs)	Set lighting interpolation method.
lights_on(*args, **kwargs)	Turn all active lighting on/off.
set_ambient_color(*args, **kwargs)	Set the ambient light color for the scene.
set_light(*args, **kwargs)	Add or modify a directional, colored light.

headlight_on(*args, **kwargs)#

Turn the light that moves with the camera on or off.

lighting_interpolation(*args, **kwargs)#

Set lighting interpolation method.

lights_on(*args, **kwargs)#

Turn all active lighting on/off.

set_ambient_color(*args, **kwargs)#

Set the ambient light color for the scene.

set_light(*args, **kwargs)#

Add or modify a directional, colored light.

line_weight(*args, **kwargs)#

Set the line-weight factor for the window.

marker_size(*args, **kwargs)#

Sets the size of markers used to represent points.

marker_symbol(*args, **kwargs)#

Sets the type of markers used to represent points.

mesh_display_configuration(*args, **kwargs)#

Changes the default mesh display. If set tomeshing, it draws the mesh on edges and faces of the outline surfaces, colored by their zone ID with lighting enabled. If set tosolution, it draws the mesh on edges and faces of the outline surfaces, colored by their zone type with lighting enabled. If set to post-processing, it draws the object outline with lighting disabled. If set toclassic, it draws the mesh on all edges of the outline surfaces. This only applies for 3D cases.

mesh_level(*args, **kwargs)#

Sets coarse mesh level to be drawn.

mesh_partitions(*args, **kwargs)#

Enables/disables option to draw mesh partition boundaries.

mesh_surfaces(*args, **kwargs)#

Sets surface IDs to be drawn as meshes. You can include a wildcard (*) within the surface names.

mesh_zones(*args, **kwargs)#

Sets zone IDs to be drawn as meshes.

mirror_zones(*args, **kwargs)#

Sets the zones about which the domain is mirrored (symmetry planes).

n_stream_func(*args, **kwargs)#

Sets number of iterations used in computing stream function.

nodewt_based_interp(*args, **kwargs)#

Disables/enables the use of node weights for node-based gradients in postprocessing.

overlays(*args, **kwargs)#

Enable/disable overlays.

class particle_tracks(service, version, mode, path)#

Bases: TUIMenu

Enters the particle-tracks menu to set parameters for display of particle tracks.

Methods:

arrow_scale(*args, **kwargs)	Sets the scale factor for arrows drawn on particle tracks.
arrow_space(*args, **kwargs)	Sets the spacing factor for arrows drawn on particle tracks.
coarsen_factor(*args, **kwargs)	Sets the coarsening factor for particle tracks.
display(*args, **kwargs)	Determines whether particle tracks shall be displayed or only tracked.
history_filename(*args, **kwargs)	Specifies the name of the particle history file.
line_width(*args, **kwargs)	Sets the width for particle track.
marker_size(*args, **kwargs)	Sets the size of markers used to represent particle tracks.
particle_skip(*args, **kwargs)	Specifies how many particle tracks should be displayed.
radius(*args, **kwargs)	Sets the radius for particle track (ribbon/cylinder only) cross-section.
report_default_variables(*args, **kwargs)	Sets the report variables to default.
report_to(*args, **kwargs)	Specifies the destination for the report (console, file, none).
report_type(*args, **kwargs)	Sets the report type for particle tracks.
report_variables(*args, **kwargs)	Sets the report variables.
sphere_attrib(*args, **kwargs)	Specifies the size and number of slices to be used in drawing spheres.
style(*args, **kwargs)	Sets the display style for particle track (line/ribbon/cylinder/sphere).
track_single_particle_stream(*args, **kwargs)	Specifies the stream ID to be tracked.
twist_factor(*args, **kwargs)	Sets the scale factor for twisting (ribbons only).

Classes:

filter_settings(service, version, mode, path)	Set filter for particle display.
sphere_settings(service, version, mode, path)	Provide sphere specific input.
vector_settings(service, version, mode, path)	Set vector specific input.

arrow_scale(*args, **kwargs)#

Sets the scale factor for arrows drawn on particle tracks.

arrow_space(*args, **kwargs)#

Sets the spacing factor for arrows drawn on particle tracks.

coarsen_factor(*args, **kwargs)#

Sets the coarsening factor for particle tracks.

display(*args, **kwargs)#

Determines whether particle tracks shall be displayed or only tracked.

class filter_settings(service, version, mode, path)#

Bases: TUIMenu

Set filter for particle display.

Methods:

enable_filtering(*args, **kwargs)	Specifies whether particle display is filtered.
filter_variable(*args, **kwargs)	Selects a variable used for filtering of particles.
inside(*args, **kwargs)	Specifies whether filter variable must be inside min/max to be displayed (else outside min/max).
maximum(*args, **kwargs)	Specifies the upper bound for the filter variable.
minimum(*args, **kwargs)	Specifies the lower bound for the filter variable.

enable_filtering(*args, **kwargs)#

Specifies whether particle display is filtered.

filter_variable(*args, **kwargs)#

Selects a variable used for filtering of particles.

inside(*args, **kwargs)#

Specifies whether filter variable must be inside min/max to be displayed (else outside min/max).

maximum(*args, **kwargs)#

Specifies the upper bound for the filter variable.

minimum(*args, **kwargs)#

Specifies the lower bound for the filter variable.

history_filename(*args, **kwargs)#

Specifies the name of the particle history file.

line_width(*args, **kwargs)#

Sets the width for particle track.

marker_size(*args, **kwargs)#

Sets the size of markers used to represent particle tracks.

particle_skip(*args, **kwargs)#

Specifies how many particle tracks should be displayed.

radius(*args, **kwargs)#

Sets the radius for particle track (ribbon/cylinder only) cross-section.

report_default_variables(*args, **kwargs)#

Sets the report variables to default.

report_to(*args, **kwargs)#

Specifies the destination for the report (console, file, none).

report_type(*args, **kwargs)#

Sets the report type for particle tracks.

report_variables(*args, **kwargs)#

Sets the report variables.

sphere_attrib(*args, **kwargs)#

Specifies the size and number of slices to be used in drawing spheres.

class sphere_settings(service, version, mode, path)#

Bases: TUIMenu

Provide sphere specific input.

Methods:

auto_range(*args, **kwargs)	Specifies whether displayed spheres should include auto range of variable to size spheres.
diameter(*args, **kwargs)	Diameter of the spheres whenvary-diameter is disabled.
maximum(*args, **kwargs)	Sets the maximum value of the sphere to be displayed.
minimum(*args, **kwargs)	Sets the minimum value of the sphere to be displayed.
scale_factor(*args, **kwargs)	Specifies a scale factor to enlarge/reduce the size of spheres.
size_variable(*args, **kwargs)	Selects a particle variable to size the spheres.
smooth_parameter(*args, **kwargs)	Specifies number of slices to be used in drawing spheres.
vary_diameter(*args, **kwargs)	Specifies whether the spheres can vary with another variable.

auto_range(*args, **kwargs)#

Specifies whether displayed spheres should include auto range of variable to size spheres.

diameter(*args, **kwargs)#

Diameter of the spheres whenvary-diameter is disabled.

maximum(*args, **kwargs)#

Sets the maximum value of the sphere to be displayed.

minimum(*args, **kwargs)#

Sets the minimum value of the sphere to be displayed.

scale_factor(*args, **kwargs)#

Specifies a scale factor to enlarge/reduce the size of spheres.

size_variable(*args, **kwargs)#

Selects a particle variable to size the spheres.

smooth_parameter(*args, **kwargs)#

Specifies number of slices to be used in drawing spheres.

vary_diameter(*args, **kwargs)#

Specifies whether the spheres can vary with another variable.

style(*args, **kwargs)#

Sets the display style for particle track (line/ribbon/cylinder/sphere).

track_single_particle_stream(*args, **kwargs)#

Specifies the stream ID to be tracked.

twist_factor(*args, **kwargs)#

Sets the scale factor for twisting (ribbons only).

class vector_settings(service, version, mode, path)#

Bases: TUIMenu

Set vector specific input.

Methods:

color_variable(*args, **kwargs)	Specifies whether the vectors should be colored by variable specified in /display/particle-track/particle-track (if false use a constant color).
constant_color(*args, **kwargs)	Specifies a constant color for the vectors.
length_to_head_ratio(*args, **kwargs)	Specifies ratio of length to head for vectors and length to diameter for cylinders.
length_variable(*args, **kwargs)	Specifies whether the displayed vectors have length varying with another variable.
scale_factor(*args, **kwargs)	Specifies a scale factor to enlarge/reduce the length of vectors.
style(*args, **kwargs)	Enables and sets the display style for particle vectors (none/vector/centered-vector/centered-cylinder).
vector_length(*args, **kwargs)	Specifies the length of constant vectors.
vector_length_variable(*args, **kwargs)	Selects a particle variable to specify the length of vectors.
vector_variable(*args, **kwargs)	Selects a particle vector function to specify vector direction.

color_variable(*args, **kwargs)#

Specifies whether the vectors should be colored by variable specified in /display/particle-track/particle-track (if false use a constant color).

constant_color(*args, **kwargs)#

Specifies a constant color for the vectors.

length_to_head_ratio(*args, **kwargs)#

Specifies ratio of length to head for vectors and length to diameter for cylinders.

length_variable(*args, **kwargs)#

Specifies whether the displayed vectors have length varying with another variable.

scale_factor(*args, **kwargs)#

Specifies a scale factor to enlarge/reduce the length of vectors.

style(*args, **kwargs)#

Enables and sets the display style for particle vectors (none/vector/centered-vector/centered-cylinder).

vector_length(*args, **kwargs)#

Specifies the length of constant vectors.

vector_length_variable(*args, **kwargs)#

Selects a particle variable to specify the length of vectors.

vector_variable(*args, **kwargs)#

Selects a particle vector function to specify vector direction.

class path_lines(service, version, mode, path)#

Bases: TUIMenu

Sets parameters for display of pathlines.

Methods:

arrow_scale(*args, **kwargs)	Sets the scale factor for arrows drawn on pathlines.
arrow_space(*args, **kwargs)	Sets the spacing factor for arrows drawn on pathlines.
display_steps(*args, **kwargs)	Sets the display stepping for pathlines.
error_control(*args, **kwargs)	Sets error control during pathline computation.
line_width(*args, **kwargs)	Sets the width for pathlines.
marker_size(*args, **kwargs)	Sets the marker size for particle drawing.
maximum_error(*args, **kwargs)	Sets the maximum error allowed while computing the pathlines.
maximum_steps(*args, **kwargs)	Sets the maximum number of steps to take for pathlines.
radius(*args, **kwargs)	Sets the radius for pathline (ribbons/cylinder only) cross-section.
relative_pathlines(*args, **kwargs)	Enables/disables the tracking of pathlines in a relative coordinate system.
reverse(*args, **kwargs)	Sets direction of path tracking.
sphere_attrib(*args, **kwargs)	Specifies the size and number of slices to be used in drawing spheres.
step_size(*args, **kwargs)	Sets the step length between particle positions for pathlines.
style(*args, **kwargs)	Selects the pathline style (line, point, ribbon, triangle, cylinder).
track_in_phase(*args, **kwargs)	Selects the phase in which particle pathlines will be computed (Multiphase Eulerian Model only).
twist_factor(*args, **kwargs)	Sets the scale factor for twisting (ribbons only).

arrow_scale(*args, **kwargs)#

Sets the scale factor for arrows drawn on pathlines.

arrow_space(*args, **kwargs)#

Sets the spacing factor for arrows drawn on pathlines.

display_steps(*args, **kwargs)#

Sets the display stepping for pathlines.

error_control(*args, **kwargs)#

Sets error control during pathline computation.

line_width(*args, **kwargs)#

Sets the width for pathlines.

marker_size(*args, **kwargs)#

Sets the marker size for particle drawing.

maximum_error(*args, **kwargs)#

Sets the maximum error allowed while computing the pathlines.

maximum_steps(*args, **kwargs)#

Sets the maximum number of steps to take for pathlines.

radius(*args, **kwargs)#

Sets the radius for pathline (ribbons/cylinder only) cross-section.

relative_pathlines(*args, **kwargs)#

Enables/disables the tracking of pathlines in a relative coordinate system.

reverse(*args, **kwargs)#

Sets direction of path tracking.

sphere_attrib(*args, **kwargs)#

Specifies the size and number of slices to be used in drawing spheres.

step_size(*args, **kwargs)#

Sets the step length between particle positions for pathlines.

style(*args, **kwargs)#

Selects the pathline style (line, point, ribbon, triangle, cylinder).

track_in_phase(*args, **kwargs)#

Selects the phase in which particle pathlines will be computed (Multiphase Eulerian Model only).

twist_factor(*args, **kwargs)#

Sets the scale factor for twisting (ribbons only).

periodic_instancing(*args, **kwargs)#

Sets the number of periodic repetitions.

periodic_repeats(*args, **kwargs)#

Sets the number of periodic repetitions.

class picture(service, version, mode, path)#

Bases: TUIMenu

Enter the hardcopy/save-picture options menu.

Classes:

color_mode(service, version, mode, path)	Enter the hardcopy color mode menu.
driver(service, version, mode, path)	Enter the set hardcopy driver menu.

Methods:

dpi(*args, **kwargs)	Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height.
invert_background(*args, **kwargs)	Use a white background when the picture is saved.
jpeg_hardcopy_quality(*args, **kwargs)	To set jpeg hardcopy quality.
landscape(*args, **kwargs)	Plot hardcopies in landscape or portrait orientation.
preview(*args, **kwargs)	Display a preview image of a hardcopy.
raytracer_image(*args, **kwargs)	Enable raytracering rendering.
set_standard_resolution(*args, **kwargs)	Select from pre-defined resolution list.
use_window_resolution(*args, **kwargs)	Use the currently active window's resolution for hardcopy (ignores the x-resolution and y-resolution in this case).
x_resolution(*args, **kwargs)	Set the width of raster-formatted images in pixels (0 implies current window size).
y_resolution(*args, **kwargs)	Set the height of raster-formatted images in pixels (0 implies current window size).

class color_mode(service, version, mode, path)#

Bases: TUIMenu

Enter the hardcopy color mode menu.

Methods:

color(*args, **kwargs)	Plot hardcopies in color.
gray_scale(*args, **kwargs)	Convert color to grayscale for hardcopy.
list(*args, **kwargs)	Display the current hardcopy color mode.
mono_chrome(*args, **kwargs)	Convert color to monochrome (black and white) for hardcopy.

color(*args, **kwargs)#

Plot hardcopies in color.

gray_scale(*args, **kwargs)#

Convert color to grayscale for hardcopy.

list(*args, **kwargs)#

Display the current hardcopy color mode.

mono_chrome(*args, **kwargs)#

Convert color to monochrome (black and white) for hardcopy.

dpi(*args, **kwargs)#

Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height.

class driver(service, version, mode, path)#

Bases: TUIMenu

Enter the set hardcopy driver menu.

Methods:

avz(*args, **kwargs)	Use AVZ output for hardcopies.
dump_window(*args, **kwargs)	Set the command used to dump the graphics window to a file.
eps(*args, **kwargs)	Produce encapsulated PostScript (EPS) output for hardcopies.
glb(*args, **kwargs)	Use GLB output for hardcopies.
hsf(*args, **kwargs)	Use HSF output for hardcopies.
jpeg(*args, **kwargs)	Produce JPEG output for hardcopies.
list(*args, **kwargs)	List the current hardcopy driver.
options(*args, **kwargs)	Set the hardcopy options.
png(*args, **kwargs)	Use PNG output for hardcopies.
post_script(*args, **kwargs)	Produce PostScript output for hardcopies.
ppm(*args, **kwargs)	Produce PPM output for hardcopies.
tiff(*args, **kwargs)	Use TIFF output for hardcopies.
vrml(*args, **kwargs)	Use VRML output for hardcopies.

Classes:

post_format(service, version, mode, path)

Enter the PostScript driver format menu.

avz(*args, **kwargs)#

Use AVZ output for hardcopies.

dump_window(*args, **kwargs)#

Set the command used to dump the graphics window to a file.

eps(*args, **kwargs)#

Produce encapsulated PostScript (EPS) output for hardcopies.

glb(*args, **kwargs)#

Use GLB output for hardcopies.

hsf(*args, **kwargs)#

Use HSF output for hardcopies.

jpeg(*args, **kwargs)#

Produce JPEG output for hardcopies.

list(*args, **kwargs)#

List the current hardcopy driver.

options(*args, **kwargs)#

Set the hardcopy options. Available options are: “no gamma correction”, disables gamma correction of colors, “physical size = (width,height)”, where width and height are the actual measurements of the printable area of the page in centimeters. “subscreen = (left,right,bottom,top)”, where left,right, bottom, and top are numbers in [-1,1] describing a subwindow on the page in which to place the hardcopy. The options may be combined by separating them with commas.

png(*args, **kwargs)#

Use PNG output for hardcopies.

class post_format(service, version, mode, path)#

Bases: TUIMenu

Enter the PostScript driver format menu.

Methods:

fast_raster(*args, **kwargs)	Use the new raster format.
raster(*args, **kwargs)	Use the original raster format.
rle_raster(*args, **kwargs)	Use the run-length encoded raster format.
vector(*args, **kwargs)	Use vector format.

fast_raster(*args, **kwargs)#

Use the new raster format.

raster(*args, **kwargs)#

Use the original raster format.

rle_raster(*args, **kwargs)#

Use the run-length encoded raster format.

vector(*args, **kwargs)#

Use vector format.

post_script(*args, **kwargs)#

Produce PostScript output for hardcopies.

ppm(*args, **kwargs)#

Produce PPM output for hardcopies.

tiff(*args, **kwargs)#

Use TIFF output for hardcopies.

vrml(*args, **kwargs)#

Use VRML output for hardcopies.

invert_background(*args, **kwargs)#

Use a white background when the picture is saved.

jpeg_hardcopy_quality(*args, **kwargs)#

To set jpeg hardcopy quality.

landscape(*args, **kwargs)#

Plot hardcopies in landscape or portrait orientation.

preview(*args, **kwargs)#

Display a preview image of a hardcopy.

raytracer_image(*args, **kwargs)#

Enable raytracering rendering.

set_standard_resolution(*args, **kwargs)#

Select from pre-defined resolution list.

use_window_resolution(*args, **kwargs)#

Use the currently active window’s resolution for hardcopy (ignores the x-resolution and y-resolution in this case).

x_resolution(*args, **kwargs)#

Set the width of raster-formatted images in pixels (0 implies current window size).

y_resolution(*args, **kwargs)#

Set the height of raster-formatted images in pixels (0 implies current window size).

proximity_zones(*args, **kwargs)#

Sets zones to be used for boundary cell distance and boundary proximity.

render_mesh(*args, **kwargs)#

Enables/disables rendering the mesh on top of contours, vectors, and so on.

class rendering_options(service, version, mode, path)#

Bases: TUIMenu

Enter the rendering options menu.

Methods:

animation_option(*args, **kwargs)	Using Wireframe / All option during animation.
auto_spin(*args, **kwargs)	Enable/disable mouse view rotations to continue to spin the display after the button is released.
color_map_alignment(*args, **kwargs)	Set the color bar alignment.
device_info(*args, **kwargs)	List information for the graphics device.
double_buffering(*args, **kwargs)	Enable/disable double-buffering.
driver(*args, **kwargs)	Change the current graphics driver.
face_displacement(*args, **kwargs)	Set face displacement value in Z-buffer units along the Camera Z-axis.
help_text_color(*args, **kwargs)	Set the color of screen help text.
hidden_line_method(*args, **kwargs)	Specify the method to perform hidden line rendering.
hidden_lines(*args, **kwargs)	Enable/disable hidden line removal.
hidden_surface_method(*args, **kwargs)	Specify the method to perform hidden line and hidden surface rendering.
hidden_surfaces(*args, **kwargs)	Enable/disable hidden surface removal.
outer_face_cull(*args, **kwargs)	Enable/disable discarding outer faces during display.
set_rendering_options(*args, **kwargs)	Set the rendering options.
show_colormap(*args, **kwargs)	Enable/Disable colormap.
surface_edge_visibility(*args, **kwargs)	Set edge visibility flags for surfaces.

animation_option(*args, **kwargs)#

Using Wireframe / All option during animation.

auto_spin(*args, **kwargs)#

Enable/disable mouse view rotations to continue to spin the display after the button is released.

color_map_alignment(*args, **kwargs)#

Set the color bar alignment.

device_info(*args, **kwargs)#

List information for the graphics device.

double_buffering(*args, **kwargs)#

Enable/disable double-buffering.

driver(*args, **kwargs)#

Change the current graphics driver.

face_displacement(*args, **kwargs)#

Set face displacement value in Z-buffer units along the Camera Z-axis.

help_text_color(*args, **kwargs)#

Set the color of screen help text.

hidden_line_method(*args, **kwargs)#

Specify the method to perform hidden line rendering.

hidden_lines(*args, **kwargs)#

Enable/disable hidden line removal.

hidden_surface_method(*args, **kwargs)#

Specify the method to perform hidden line and hidden surface rendering.

hidden_surfaces(*args, **kwargs)#

Enable/disable hidden surface removal.

outer_face_cull(*args, **kwargs)#

Enable/disable discarding outer faces during display.

set_rendering_options(*args, **kwargs)#

Set the rendering options.

show_colormap(*args, **kwargs)#

Enable/Disable colormap.

surface_edge_visibility(*args, **kwargs)#

Set edge visibility flags for surfaces.

reset_graphics(*args, **kwargs)#

Reset the graphics system.

class titles(service, version, mode, path)#

Bases: TUIMenu

Set problem title.

Methods:

left_bottom(*args, **kwargs)	Set the title text for left bottom in title segment.
left_top(*args, **kwargs)	Set the title text for left top in title segment.
right_bottom(*args, **kwargs)	Set the title text for right bottom in title segment.
right_middle(*args, **kwargs)	Set the title text for right middle in title segment.
right_top(*args, **kwargs)	Set the title text for right top in title segment.

left_bottom(*args, **kwargs)#

Set the title text for left bottom in title segment.

left_top(*args, **kwargs)#

Set the title text for left top in title segment.

right_bottom(*args, **kwargs)#

Set the title text for right bottom in title segment.

right_middle(*args, **kwargs)#

Set the title text for right middle in title segment.

right_top(*args, **kwargs)#

Set the title text for right top in title segment.

class velocity_vectors(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to set parameters for display of velocity vectors.

Methods:

auto_scale(*args, **kwargs)	Auto-scales all vectors so that vector overlap is minimal.
color(*args, **kwargs)	Sets the color of all velocity vectors to the color specified.
color_levels(*args, **kwargs)	Sets the number of colors used from the colormap.
component_x(*args, **kwargs)	Sets the option to use only the component of the velocity vectors during display.
component_y(*args, **kwargs)	Sets the option to use only the component of the velocity vectors during display.
component_z(*args, **kwargs)	Sets the option to use only the component of the velocity vectors during display.
constant_length(*args, **kwargs)	Sets the option to draw velocity vectors of constant length.
global_range(*args, **kwargs)	Turns global range for vectors on/off.
in_plane(*args, **kwargs)	Toggles the display of velocity vector components in the plane of the surface selected for display.
log_scale(*args, **kwargs)	Toggles whether color scale is logarithmic or linear.
node_values(*args, **kwargs)	Enables/disables the plotting of node values.
relative(*args, **kwargs)	Toggles the display of relative velocity vectors.
render_mesh(*args, **kwargs)	Enables/disables rendering the mesh on top of contours, vectors, and so on.
scale(*args, **kwargs)	Sets the value by which the vector length will be scaled.
scale_head(*args, **kwargs)	Sets the value by which the vector head will be scaled.
style(*args, **kwargs)	Specifies the vector style that will be used when the vectors are displayed.
surfaces(*args, **kwargs)	Sets surfaces on which vectors are drawn.

auto_scale(*args, **kwargs)#

Auto-scales all vectors so that vector overlap is minimal.

color(*args, **kwargs)#

Sets the color of all velocity vectors to the color specified. The color scale is ignored. This is useful when overlaying a vector plot over a contour plot.

color_levels(*args, **kwargs)#

Sets the number of colors used from the colormap.

component_x(*args, **kwargs)#

Sets the option to use only the component of the velocity vectors during display.

component_y(*args, **kwargs)#

Sets the option to use only the component of the velocity vectors during display.

component_z(*args, **kwargs)#

Sets the option to use only the component of the velocity vectors during display.

constant_length(*args, **kwargs)#

Sets the option to draw velocity vectors of constant length. This shows only the direction of the velocity vectors.

global_range(*args, **kwargs)#

Turns global range for vectors on/off.

in_plane(*args, **kwargs)#

Toggles the display of velocity vector components in the plane of the surface selected for display.

log_scale(*args, **kwargs)#

Toggles whether color scale is logarithmic or linear.

node_values(*args, **kwargs)#

Enables/disables the plotting of node values. Cell values will be plotted if “no”.

relative(*args, **kwargs)#

Toggles the display of relative velocity vectors.

render_mesh(*args, **kwargs)#

Enables/disables rendering the mesh on top of contours, vectors, and so on.

scale(*args, **kwargs)#

Sets the value by which the vector length will be scaled.

scale_head(*args, **kwargs)#

Sets the value by which the vector head will be scaled.

style(*args, **kwargs)#

Specifies the vector style that will be used when the vectors are displayed. You can choose from:3d arrow,3d arrowhead, cone,filled-arrow, arrow,harpoon, or headless.

surfaces(*args, **kwargs)#

Sets surfaces on which vectors are drawn. You can include a wildcard (*) within the surface names.

class windows(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

aspect_ratio(*args, **kwargs)	Sets the aspect ratio of the active window.
logo(*args, **kwargs)	.
logo_color(*args, **kwargs)	.
ruler(*args, **kwargs)	Turns the ruler on/off.

Classes:

axes(service, version, mode, path)	Enters the axes window options menu.
main(service, version, mode, path)	Enters the main view window options menu.
scale(service, version, mode, path)	Enters the color scale window options menu.
text(service, version, mode, path)	Enters the text window options menu.
video(service, version, mode, path)	Contains options for modifying a video.
xy(service, version, mode, path)	Enters the XY plot window options menu.

aspect_ratio(*args, **kwargs)#

Sets the aspect ratio of the active window.

class axes(service, version, mode, path)#

Bases: TUIMenu

Enters the axes window options menu.

Methods:

border(*args, **kwargs)	Sets whether or not to draw a border around the axes window.
bottom(*args, **kwargs)	Sets the bottom boundary of the axes window.
clear(*args, **kwargs)	Sets the transparency of the axes window.
left(*args, **kwargs)	Sets the left boundary of the axes window.
right(*args, **kwargs)	Sets the right boundary of the axes window.
top(*args, **kwargs)	Sets the top boundary of the axes window.
visible(*args, **kwargs)	Controls the visibility of the axes window.

border(*args, **kwargs)#

Sets whether or not to draw a border around the axes window.

bottom(*args, **kwargs)#

Sets the bottom boundary of the axes window.

clear(*args, **kwargs)#

Sets the transparency of the axes window.

left(*args, **kwargs)#

Sets the left boundary of the axes window.

right(*args, **kwargs)#

Sets the right boundary of the axes window.

top(*args, **kwargs)#

Sets the top boundary of the axes window.

visible(*args, **kwargs)#

Controls the visibility of the axes window.

logo(*args, **kwargs)#

.

logo_color(*args, **kwargs)#

.

class main(service, version, mode, path)#

Bases: TUIMenu

Enters the main view window options menu.

Methods:

border(*args, **kwargs)	Sets whether or not to draw a border around the main viewing window.
bottom(*args, **kwargs)	Sets the bottom boundary of the main viewing window.
left(*args, **kwargs)	Sets the left boundary of the main viewing window.
right(*args, **kwargs)	Sets the right boundary of the main viewing window.
top(*args, **kwargs)	Sets the top boundary of the main viewing window.
visible(*args, **kwargs)	Controls the visibility of the main viewing window.

border(*args, **kwargs)#

Sets whether or not to draw a border around the main viewing window.

bottom(*args, **kwargs)#

Sets the bottom boundary of the main viewing window.

left(*args, **kwargs)#

Sets the left boundary of the main viewing window.

right(*args, **kwargs)#

Sets the right boundary of the main viewing window.

top(*args, **kwargs)#

Sets the top boundary of the main viewing window.

visible(*args, **kwargs)#

Controls the visibility of the main viewing window.

ruler(*args, **kwargs)#

Turns the ruler on/off. Note that if you are running Fluent in 3D, then the view must be set toorthographic.

class scale(service, version, mode, path)#

Bases: TUIMenu

Enters the color scale window options menu.

Methods:

border(*args, **kwargs)	Sets whether or not to draw a border around the color scale window.
bottom(*args, **kwargs)	Sets the bottom boundary of the color scale window.
clear(*args, **kwargs)	Sets the transparency of the color scale window.
font_size(*args, **kwargs)	Sets the font size of the color scale window.
format(*args, **kwargs)	Sets the number format of the color scale window (for example, percentage0.2e).
left(*args, **kwargs)	Sets the left boundary of the color scale window.
margin(*args, **kwargs)	Sets the margin of the color scale window.
right(*args, **kwargs)	Sets the right boundary of the color scale window.
top(*args, **kwargs)	Sets the top boundary of the color scale window.
visible(*args, **kwargs)	Controls the visibility of the color scale window.

border(*args, **kwargs)#

Sets whether or not to draw a border around the color scale window.

bottom(*args, **kwargs)#

Sets the bottom boundary of the color scale window.

clear(*args, **kwargs)#

Sets the transparency of the color scale window.

font_size(*args, **kwargs)#

Sets the font size of the color scale window.

format(*args, **kwargs)#

Sets the number format of the color scale window (for example, percentage0.2e).

left(*args, **kwargs)#

Sets the left boundary of the color scale window.

margin(*args, **kwargs)#

Sets the margin of the color scale window.

right(*args, **kwargs)#

Sets the right boundary of the color scale window.

top(*args, **kwargs)#

Sets the top boundary of the color scale window.

visible(*args, **kwargs)#

Controls the visibility of the color scale window.

class text(service, version, mode, path)#

Bases: TUIMenu

Enters the text window options menu.

Methods:

alignment(*args, **kwargs)	.
application(*args, **kwargs)	Shows or hides the application name in the picture.
border(*args, **kwargs)	Sets whether or not to draw a border around the text window.
bottom(*args, **kwargs)	Sets the bottom boundary of the text window.
clear(*args, **kwargs)	Enables/disables the transparency of the text window.
company(*args, **kwargs)	Shows or hides the company name in the picture.
date(*args, **kwargs)	Shows or hides the date in the picture.
left(*args, **kwargs)	Sets the left boundary of the text window.
right(*args, **kwargs)	Sets the right boundary of the text window.
top(*args, **kwargs)	Sets the top boundary of the text window.
visible(*args, **kwargs)	Controls the visibility of the text window.

alignment(*args, **kwargs)#

.

application(*args, **kwargs)#

Shows or hides the application name in the picture.

border(*args, **kwargs)#

Sets whether or not to draw a border around the text window.

bottom(*args, **kwargs)#

Sets the bottom boundary of the text window.

clear(*args, **kwargs)#

Enables/disables the transparency of the text window.

company(*args, **kwargs)#

Shows or hides the company name in the picture.

date(*args, **kwargs)#

Shows or hides the date in the picture.

left(*args, **kwargs)#

Sets the left boundary of the text window.

right(*args, **kwargs)#

Sets the right boundary of the text window.

top(*args, **kwargs)#

Sets the top boundary of the text window.

visible(*args, **kwargs)#

Controls the visibility of the text window.

class video(service, version, mode, path)#

Bases: TUIMenu

Contains options for modifying a video. This menu is not relevant for the meshing mode.

Methods:

background(*args, **kwargs)	Sets the background color of the graphics window.
color_filter(*args, **kwargs)	Sets the video color filter.
foreground(*args, **kwargs)	Sets the foreground (text) color of the graphics window.
on(*args, **kwargs)	Enables or disables the video picture settings.
pixel_size(*args, **kwargs)	Sets the window size in pixels.

background(*args, **kwargs)#

Sets the background color of the graphics window. The color is specified as a string of three comma-separated numbers between 0 and 1, representing red, green, and blue. For example, to change the background from black (default) to gray, you would enter “.5,.5,.5” after selecting the background command.

color_filter(*args, **kwargs)#

Sets the video color filter. For example, to change the color filter from its default setting to PAL video with a saturation of 80percentage and a brightness of 90percentage, you would enter “video=pal,sat=.8,gain=.9” after selecting the color-filter command.

foreground(*args, **kwargs)#

Sets the foreground (text) color of the graphics window. The color is specified as a string of three comma-separated numbers between 0 and 1, representing red, green, and blue. For example, to change the foreground from white (default) to gray, you would enter “.5,.5,.5” after selecting the foreground command.

on(*args, **kwargs)#

Enables or disables the video picture settings.

pixel_size(*args, **kwargs)#

Sets the window size in pixels.

class xy(service, version, mode, path)#

Bases: TUIMenu

Enters the XY plot window options menu.

Methods:

border(*args, **kwargs)	Sets whether or not to draw a border around the XY plot window.
bottom(*args, **kwargs)	Sets the bottom boundary of the XY plot window.
left(*args, **kwargs)	Sets the left boundary of the XY plot window.
right(*args, **kwargs)	Sets the right boundary of the XY plot window.
top(*args, **kwargs)	Sets the top boundary of the XY plot window.
visible(*args, **kwargs)	Controls the visibility of the XY plot window.

border(*args, **kwargs)#

Sets whether or not to draw a border around the XY plot window.

bottom(*args, **kwargs)#

Sets the bottom boundary of the XY plot window.

left(*args, **kwargs)#

Sets the left boundary of the XY plot window.

right(*args, **kwargs)#

Sets the right boundary of the XY plot window.

top(*args, **kwargs)#

Sets the top boundary of the XY plot window.

visible(*args, **kwargs)#

Controls the visibility of the XY plot window.

zero_angle_dir(*args, **kwargs)#

Sets the vector having zero angular coordinates.

set_list_tree_separator(*args, **kwargs)#

Set the separator character for list tree.

set_window(*args, **kwargs)#

Sets a “user” graphics window to be the active window. User windows are specified by number (1-50), with the associated number corresponding to the order, left-to-right, that the windows were created in.

set_window_by_name(*args, **kwargs)#

Sets the specified graphics window as active. The graphics windows specified using this command are “reserved” windows, that is, residual monitors, report plots, and animation definitions. The name will match the name you provided when creating the object (report plots and animation definitions).

class surface(service, version, mode, path)#

Bases: TUIMenu

Enters the data surface-manipulation menu. For a description of the items in this menu, see surface/.

Methods:

circle_slice(*args, **kwargs)	Extract a circular slice.
closest_point_search(*args, **kwargs)	Enable the point surface algorithm to look for the nearest point instead of reporting a creation failure.
cone_slice(*args, **kwargs)	Extract a cone slice.
create_imprint_surface(*args, **kwargs)	Imprint surface.
delete_surface(*args, **kwargs)	Remove a defined data surface.
edit_surface(*args, **kwargs)	Edit a defined data surface.
ellipsoid_slice(*args, **kwargs)	Extract a ellipsoid slice.
expression_volume(*args, **kwargs)	Create volume with boolean expression.
group_surfaces(*args, **kwargs)	Group a set of surfaces.
imprint_surface(*args, **kwargs)	Imprint surface.
iso_clip(*args, **kwargs)	Clip a data surface (surface, curve, or point) between two iso-values.
iso_clip_multiple(*args, **kwargs)	Clip a data surface (surface, curve, or point) between two iso-values.
iso_surface(*args, **kwargs)	Extract an iso-surface (surface, curve, or point) from the curent data field.
line_slice(*args, **kwargs)	Extract a linear slice.
line_surface(*args, **kwargs)	Define a "line" surface by specifying the two endpoint coordinates.
list_surfaces(*args, **kwargs)	List the number of facets in the defined surfaces.
mouse_line(*args, **kwargs)	Define a line surface using the mouse to select two points.
mouse_plane(*args, **kwargs)	Define a plane surface using the mouse to select three points.
mouse_rake(*args, **kwargs)	Define a "rake" surface using the mouse to select the end points.
multiple_iso_surfaces(*args, **kwargs)	Create multiple iso-surfaces from the data field at specified spacing.
multiple_plane_surfaces(*args, **kwargs)	Create multiple plane surfaces at specified spacing.
multiple_zone_surfaces(*args, **kwargs)	Create multiple data surfaces at a time.
partition_surface(*args, **kwargs)	Define a data surface on mesh faces on the partition boundary.
plane(*args, **kwargs)	Create a plane given 3 points bounded by the domain.
plane_bounded(*args, **kwargs)	Create a bounded surface.
plane_point_n_normal(*args, **kwargs)	Create a plane from a point and normal.
plane_slice(*args, **kwargs)	Extract a planar slice.
plane_surf_aligned(*args, **kwargs)	Create a plane aligned to a surface.
plane_surface(*args, **kwargs)	Create a plane from a coordinate plane, point and normal, or three points.
plane_view_plane_align(*args, **kwargs)	Create a plane aligned to a view-plane.
point_array(*args, **kwargs)	Extract a rectangular array of data points.
point_surface(*args, **kwargs)	Define a "point" surface by specifying the coordinates.
quadric_slice(*args, **kwargs)	Extract a quadric slice.
rake_surface(*args, **kwargs)	Define a "rake" surface by specifying the end points.
rename_surface(*args, **kwargs)	Rename a defined data surface.
rendering_priority(*args, **kwargs)	Define Priority for given surface id.
reset_zone_surfaces(*args, **kwargs)	Reset case surface list.
sphere_slice(*args, **kwargs)	Extract a spherical slice.
structural_point_surface(*args, **kwargs)	Define a "structural point" surface by specifying the coordinates.
surface_cells(*args, **kwargs)	Extract all cells intersected by a data surface.
transform_surface(*args, **kwargs)	Transform surface.
ungroup_surface(*args, **kwargs)	Ungroup the surface(if grouped).
zone_surface(*args, **kwargs)	Define a data surface on a mesh zone.

Classes:

post_processing_volume(service, version, ...)	Enter post-processing volume menu.
query(service, version, mode, path)	Enter surface query menu.

circle_slice(*args, **kwargs)#

Extract a circular slice.

closest_point_search(*args, **kwargs)#

Enable the point surface algorithm to look for the nearest point instead of reporting a creation failure.

cone_slice(*args, **kwargs)#

Extract a cone slice.

create_imprint_surface(*args, **kwargs)#

Imprint surface.

delete_surface(*args, **kwargs)#

Remove a defined data surface.

edit_surface(*args, **kwargs)#

Edit a defined data surface.

ellipsoid_slice(*args, **kwargs)#

Extract a ellipsoid slice.

expression_volume(*args, **kwargs)#

Create volume with boolean expression.

group_surfaces(*args, **kwargs)#

Group a set of surfaces.

imprint_surface(*args, **kwargs)#

Imprint surface.

iso_clip(*args, **kwargs)#

Clip a data surface (surface, curve, or point) between two iso-values.

iso_clip_multiple(*args, **kwargs)#

Clip a data surface (surface, curve, or point) between two iso-values.

iso_surface(*args, **kwargs)#

Extract an iso-surface (surface, curve, or point) from the curent data field.

line_slice(*args, **kwargs)#

Extract a linear slice.

line_surface(*args, **kwargs)#

Define a “line” surface by specifying the two endpoint coordinates.

list_surfaces(*args, **kwargs)#

List the number of facets in the defined surfaces.

mouse_line(*args, **kwargs)#

Define a line surface using the mouse to select two points.

mouse_plane(*args, **kwargs)#

Define a plane surface using the mouse to select three points.

mouse_rake(*args, **kwargs)#

Define a “rake” surface using the mouse to select the end points.

multiple_iso_surfaces(*args, **kwargs)#

Create multiple iso-surfaces from the data field at specified spacing.

multiple_plane_surfaces(*args, **kwargs)#

Create multiple plane surfaces at specified spacing.

multiple_zone_surfaces(*args, **kwargs)#

Create multiple data surfaces at a time.

partition_surface(*args, **kwargs)#

Define a data surface on mesh faces on the partition boundary.

plane(*args, **kwargs)#

Create a plane given 3 points bounded by the domain.

plane_bounded(*args, **kwargs)#

Create a bounded surface.

plane_point_n_normal(*args, **kwargs)#

Create a plane from a point and normal.

plane_slice(*args, **kwargs)#

Extract a planar slice.

plane_surf_aligned(*args, **kwargs)#

Create a plane aligned to a surface.

plane_surface(*args, **kwargs)#

Create a plane from a coordinate plane, point and normal, or three points.

plane_view_plane_align(*args, **kwargs)#

Create a plane aligned to a view-plane.

point_array(*args, **kwargs)#

Extract a rectangular array of data points.

point_surface(*args, **kwargs)#

Define a “point” surface by specifying the coordinates.

class post_processing_volume(service, version, mode, path)#

Bases: TUIMenu

Enter post-processing volume menu.

Methods:

create_from_file(*args, **kwargs)	Read post-processing mesh from file.
create_octree(*args, **kwargs)	Create post-processing octree mesh based on current case.

create_from_file(*args, **kwargs)#

Read post-processing mesh from file.

create_octree(*args, **kwargs)#

Create post-processing octree mesh based on current case.

quadric_slice(*args, **kwargs)#

Extract a quadric slice.

class query(service, version, mode, path)#

Bases: TUIMenu

Enter surface query menu.

Methods:

delete_query(*args, **kwargs)	Delete saved query.
list_named_selection(*args, **kwargs)	List named selection of surface type.
list_queries(*args, **kwargs)	List all saved queries.
list_surfaces(*args, **kwargs)	List surfaces.
named_surface_list(*args, **kwargs)	Create named list of surfaces.

delete_query(*args, **kwargs)#

Delete saved query.

list_named_selection(*args, **kwargs)#

List named selection of surface type.

list_queries(*args, **kwargs)#

List all saved queries.

list_surfaces(*args, **kwargs)#

List surfaces.

named_surface_list(*args, **kwargs)#

Create named list of surfaces.

rake_surface(*args, **kwargs)#

Define a “rake” surface by specifying the end points.

rename_surface(*args, **kwargs)#

Rename a defined data surface.

rendering_priority(*args, **kwargs)#

Define Priority for given surface id.

reset_zone_surfaces(*args, **kwargs)#

Reset case surface list.

sphere_slice(*args, **kwargs)#

Extract a spherical slice.

structural_point_surface(*args, **kwargs)#

Define a “structural point” surface by specifying the coordinates.

surface_cells(*args, **kwargs)#

Extract all cells intersected by a data surface.

transform_surface(*args, **kwargs)#

Transform surface.

ungroup_surface(*args, **kwargs)#

Ungroup the surface(if grouped).

zone_surface(*args, **kwargs)#

Define a data surface on a mesh zone.

surface_cells(*args, **kwargs)#

Draws the cells on the specified surfaces. You can include a wildcard (*) within the surface names.

surface_mesh(*args, **kwargs)#

Draws the mesh defined by the specified surfaces. You can include a wildcard (*) within the surface names.

switch_to_post_processing_volume(*args, **kwargs)#

Switch to post processing volume.

switch_to_primary_volume(*args, **kwargs)#

Switch to primary volume.

transient_post_processing(*args, **kwargs)#

Enter transient postprocessing menu.

update_layout(*args, **kwargs)#

Update the fluent layout.

class update_scene(service, version, mode, path)#

Bases: TUIMenu

Enter the scene options menu.

Methods:

delete(*args, **kwargs)	Delete selected geometries.
display(*args, **kwargs)	Display selected geometries.
draw_frame(*args, **kwargs)	Enable/disable drawing of the bounding frame.
iso_sweep(*args, **kwargs)	Change iso-sweep values.
overlays(*args, **kwargs)	Enable/disable the overlays option.
pathline(*args, **kwargs)	Change pathline attributes.
select_geometry(*args, **kwargs)	Select geometry to be updated.
set_frame(*args, **kwargs)	Change frame options.
time(*args, **kwargs)	Change time-step value.
transform(*args, **kwargs)	Apply transformation matrix on selected geometries.

delete(*args, **kwargs)#

Delete selected geometries.

display(*args, **kwargs)#

Display selected geometries.

draw_frame(*args, **kwargs)#

Enable/disable drawing of the bounding frame.

iso_sweep(*args, **kwargs)#

Change iso-sweep values.

overlays(*args, **kwargs)#

Enable/disable the overlays option.

pathline(*args, **kwargs)#

Change pathline attributes.

select_geometry(*args, **kwargs)#

Select geometry to be updated.

set_frame(*args, **kwargs)#

Change frame options.

time(*args, **kwargs)#

Change time-step value.

transform(*args, **kwargs)#

Apply transformation matrix on selected geometries.

vector(*args, **kwargs)#

Displays vectors of a space vector variable.

velocity_vector(*args, **kwargs)#

Prompts for a scalar field by which to color the vectors, the minimum and maximum values, and the scale factor, and then draws the velocity vectors.

class view_sync(service, version, mode, path)#

Bases: TUIMenu

Synchronize window views.

Methods:

add(*args, **kwargs)	Add list of window ids for synchronization.
add_all(*args, **kwargs)	Synchronize all windows.
list(*args, **kwargs)	Print window ids of open windows.
remove(*args, **kwargs)	Remove list of window ids from synchronization.
remove_all(*args, **kwargs)	Unsynchronize all windows.
start(*args, **kwargs)	Start view synchronization.
stop(*args, **kwargs)	Stop view synchronization.

add(*args, **kwargs)#

Add list of window ids for synchronization.

add_all(*args, **kwargs)#

Synchronize all windows.

list(*args, **kwargs)#

Print window ids of open windows.

remove(*args, **kwargs)#

Remove list of window ids from synchronization.

remove_all(*args, **kwargs)#

Unsynchronize all windows.

start(*args, **kwargs)#

Start view synchronization.

stop(*args, **kwargs)#

Stop view synchronization.

class views(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

auto_scale(*args, **kwargs)	Scales and centers the current scene without changing its orientation.
default_view(*args, **kwargs)	Resets the view to front and center.
delete_view(*args, **kwargs)	Deletes a particular view from the list of stored views.
last_view(*args, **kwargs)	Returns to the camera position before the last manipulation.
list_views(*args, **kwargs)	Lists all predefined and saved views.
next_view(*args, **kwargs)	.
read_views(*args, **kwargs)	Reads views from an external view file.
restore_view(*args, **kwargs)	Sets the current view to one of the stored views.
save_view(*args, **kwargs)	Saves the currently displayed view into the list of stored views.
write_views(*args, **kwargs)	Writes views to an external view file.

Classes:

camera(service, version, mode, path)	Contains commands to set the camera options.
display_states(service, version, mode, path)	.

auto_scale(*args, **kwargs)#

Scales and centers the current scene without changing its orientation.

class camera(service, version, mode, path)#

Bases: TUIMenu

Contains commands to set the camera options.

Methods:

dolly_camera(*args, **kwargs)	Enables you to move the camera left, right, up, down, in, and out.
field(*args, **kwargs)	Enables you to set the field of view (width and height) of the scene.
orbit_camera(*args, **kwargs)	Enables you to move the camera around the target.
pan_camera(*args, **kwargs)	Gives you the effect of sweeping the camera across the scene.
position(*args, **kwargs)	Sets the camera position.
projection(*args, **kwargs)	Lets you switch between perspective and orthographic views.
roll_camera(*args, **kwargs)	Lets you adjust the camera up-vector.
target(*args, **kwargs)	Sets the point the camera will look at.
up_vector(*args, **kwargs)	Sets the camera up-vector.
zoom_camera(*args, **kwargs)	Adjusts the camera’s field of view.

dolly_camera(*args, **kwargs)#

Enables you to move the camera left, right, up, down, in, and out.

field(*args, **kwargs)#

Enables you to set the field of view (width and height) of the scene.

orbit_camera(*args, **kwargs)#

Enables you to move the camera around the target. Gives the effect of circling around the target.

pan_camera(*args, **kwargs)#

Gives you the effect of sweeping the camera across the scene. The camera remains at its position but its target changes.

position(*args, **kwargs)#

Sets the camera position.

projection(*args, **kwargs)#

Lets you switch between perspective and orthographic views.

roll_camera(*args, **kwargs)#

Lets you adjust the camera up-vector.

target(*args, **kwargs)#

Sets the point the camera will look at.

up_vector(*args, **kwargs)#

Sets the camera up-vector.

zoom_camera(*args, **kwargs)#

Adjusts the camera’s field of view. This operation is similar to dollying the camera in or out of the scene. Dollying causes objects in front to move past you. Zooming changes the perspective effect in the scene (and can be disconcerting).

default_view(*args, **kwargs)#

Resets the view to front and center.

delete_view(*args, **kwargs)#

Deletes a particular view from the list of stored views.

class display_states(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

copy(*args, **kwargs)	.
delete(*args, **kwargs)	Delete display-states object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit display-states object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
new(*args, **kwargs)	Create a new display-states object.
read(*args, **kwargs)	.
rename(*args, **kwargs)	Rename display-states object.
restore_state(*args, **kwargs)	.
use_active(*args, **kwargs)	.
write(*args, **kwargs)	.

copy(*args, **kwargs)#

.

delete(*args, **kwargs)#

Delete display-states object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit display-states object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

new(*args, **kwargs)#

Create a new display-states object.

read(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename display-states object.

restore_state(*args, **kwargs)#

.

use_active(*args, **kwargs)#

.

write(*args, **kwargs)#

.

last_view(*args, **kwargs)#

Returns to the camera position before the last manipulation.

list_views(*args, **kwargs)#

Lists all predefined and saved views.

next_view(*args, **kwargs)#

.

read_views(*args, **kwargs)#

Reads views from an external view file.

restore_view(*args, **kwargs)#

Sets the current view to one of the stored views.

save_view(*args, **kwargs)#

Saves the currently displayed view into the list of stored views.

write_views(*args, **kwargs)#

Writes views to an external view file.

zone_mesh(*args, **kwargs)#

Draws the mesh defined by specified face zones. Zone names can be indicated using wildcards (*).

exit(*args, **kwargs)#

Exit program.

class file(service, version, mode, path)#

Bases: TUIMenu

Enter the file menu.

Methods:

async_optimize(*args, **kwargs)	Chooses whether to optimize file I/O using scratch disks and asynchronous operations.
binary_legacy_files(*args, **kwargs)	.
cff_files(*args, **kwargs)	.
close_without_save(*args, **kwargs)	Exits ANSYS Fluent without saving data in Workbench.
confirm_overwrite(*args, **kwargs)	.
convert_hanging_nodes_during_read(*args, ...)	.
data_file_options(*args, **kwargs)	Sets derived quantities to be written in data file.
define_macro(*args, **kwargs)	Saves input to a named macro.
execute_macro(*args, **kwargs)	Runs a previously defined macro.
export_to_cfd_post(*args, **kwargs)	Exports data files that are compatible with CFD-Post and EnSight (that is, .cdat and .cst files) and opens CFD-Post, if desired.
load_act_tool(*args, **kwargs)	Load ACT Start Page.
read_case(*args, **kwargs)	Read a case file.
read_case_data(*args, **kwargs)	Reads a case and a data file.
read_case_info(*args, **kwargs)	Read basic case info.
read_case_settings(*args, **kwargs)	Read a case file while skipping mesh elements.
read_data(*args, **kwargs)	Reads a data file.
read_field_functions(*args, **kwargs)	Reads custom field function definitions from a file.
read_injections(*args, **kwargs)	Reads all DPM injections from a file.
read_isat_table(*args, **kwargs)	Reads ISAT Table.
read_journal(*args, **kwargs)	Read a journal file.
read_macros(*args, **kwargs)	Reads macro definitions from a file.
read_pdf(*args, **kwargs)	Reads a PDF file.
read_profile(*args, **kwargs)	Reads boundary profile data.
read_rays(*args, **kwargs)	Reads a ray file.
read_settings(*args, **kwargs)	Reads and sets boundary conditions from a specified file.
read_surface_clusters(*args, **kwargs)	Reads surface clusters from a file.
read_transient_table(*args, **kwargs)	Reads table of transient boundary profile data.
read_viewfactors(*args, **kwargs)	Reads view factors from a file.
reload_setup(*args, **kwargs)	Discards any changes in the current ANSYS Fluent in Workbench session and removes any corresponding data from the Solution cell.
replace_mesh(*args, **kwargs)	Replaces the mesh with a new one while preserving settings.
set_batch_options(*args, **kwargs)	Sets the batch options.
set_err_on_inval_cmd(*args, **kwargs)	Set whether to abort journal replay on invalid command.
set_idle_timeout(*args, **kwargs)	Set the idle timeout.
set_target_reference_frame_for_write_profiles(...)	Set reference frame options, which will be used for position transformation during writing of profiles.
set_tui_version(*args, **kwargs)	Set the version of the TUI commands.
show_configuration(*args, **kwargs)	.
single_precision_coordinates(*args, **kwargs)	Specifies whether the nodal coordinates should be written in single precision (rather than the default double precision).
start_journal(*args, **kwargs)	.
start_transcript(*args, **kwargs)	.
stop_journal(*args, **kwargs)	.
stop_macro(*args, **kwargs)	Stops recording input to a macro.
stop_transcript(*args, **kwargs)	.
sync_workbench(*args, **kwargs)	Directly updates Workbench with the most recent Fluent changes.
write_boundary_mesh(*args, **kwargs)	Writes the boundary mesh to a file.
write_case(*args, **kwargs)	Write a case file.
write_case_data(*args, **kwargs)	Writes a case and a data file.
write_circumferential_averaged_profile(...)	Write surface data as a boundary profile file.
write_cleanup_script(*args, **kwargs)	Writes the cleanup-script-file for ANSYS Fluent.
write_currently_defined_profiles(*args, **kwargs)	Write currently defined profiles.
write_data(*args, **kwargs)	Writes a data file.
write_fan_profile(*args, **kwargs)	Computes radial profiles for a fan zone and writes them to a profile file.
write_field_functions(*args, **kwargs)	Writes the currently defined custom field functions to a file.
write_flamelet(*args, **kwargs)	Writes a flamelet file.
write_gpu_restart(*args, **kwargs)	Write gpuapp restart case and data files.
write_injections(*args, **kwargs)	Writes out selected DPM injections to a file.
write_isat_table(*args, **kwargs)	Writes ISAT Table.
write_macros(*args, **kwargs)	Writes the currently defined macros to a file.
write_merge_profiles(*args, **kwargs)	Writes a .csv file with the selected surfaces consolidated into one set of data points.
write_pdat(*args, **kwargs)	Enables / disables the attempt to save .pdat files.
write_pdf(*args, **kwargs)	Writes a pdf file.
write_profile(*args, **kwargs)	Writes surface data as a boundary profile file.
write_selected_defined_profiles(*args, **kwargs)	Set profile names, only these profile names which will be used during writing of *.csv profiles.
write_settings(*args, **kwargs)	Writes out current boundary conditions in use.

Classes:

auto_save(service, version, mode, path)	Enters the auto save menu.
cffio_options(service, version, mode, path)	Enters the cffio options menu, which provides options for the I/O of case and data files in the Common Fluids Format (CFF).
em_mapping(service, version, mode, path)	Enters the electromagnetic loss mapping menu.
export(service, version, mode, path)	Enter the export menu.
fsi(service, version, mode, path)	Enters the fluid-structure interaction menu.
import_(service, version, mode, path)	Enter the import menu.
interpolate(service, version, mode, path)	Interpolates data to/from another grid.
parametric_project(service, version, mode, path)	Enter to open, save, archive parametric project.
project_beta(service, version, mode, path)	Enter to create new project, open project, save and archive project.
solution_files(service, version, mode, path)	Enters the solution files menu.
table_manager(service, version, mode, path)	Enters the table file manager menu.
transient_export(service, version, mode, path)	Enter the export menu.

async_optimize(*args, **kwargs)#

Chooses whether to optimize file I/O using scratch disks and asynchronous operations.

class auto_save(service, version, mode, path)#

Bases: TUIMenu

Enters the auto save menu.

Methods:

append_file_name_with(*args, **kwargs)	Sets the suffix for auto-saved files.
case_frequency(*args, **kwargs)	Specifies the frequency (in iterations, time steps, or flow time) with which case files are saved.
data_frequency(*args, **kwargs)	Specifies the frequency (in iterations, time steps, or flow time) with which data files are saved.
max_files(*args, **kwargs)	Sets the maximum number of files.
retain_most_recent_files(*args, **kwargs)	Sets autosave to retain the 5 most recent files.
root_name(*args, **kwargs)	Specifies the root name for the files that are saved.
save_data_file_every(*args, **kwargs)	Specifies the type and frequency of the data file to be saved.

append_file_name_with(*args, **kwargs)#

Sets the suffix for auto-saved files. The file name can be appended by flow-time, time-step value, or by user-specified flags in file name.

case_frequency(*args, **kwargs)#

Specifies the frequency (in iterations, time steps, or flow time) with which case files are saved.

data_frequency(*args, **kwargs)#

Specifies the frequency (in iterations, time steps, or flow time) with which data files are saved.

max_files(*args, **kwargs)#

Sets the maximum number of files. Once the maximum is reached, files will be erased as new files are written.

retain_most_recent_files(*args, **kwargs)#

Sets autosave to retain the 5 most recent files.

root_name(*args, **kwargs)#

Specifies the root name for the files that are saved.

save_data_file_every(*args, **kwargs)#

Specifies the type and frequency of the data file to be saved.

binary_legacy_files(*args, **kwargs)#

.

cff_files(*args, **kwargs)#

.

class cffio_options(service, version, mode, path)#

Bases: TUIMenu

Enters the cffio options menu, which provides options for the I/O of case and data files in the Common Fluids Format (CFF).

Methods:

compression_level(*args, **kwargs)	Sets the compression level for CFF files.
io_mode(*args, **kwargs)	Sets the I/O mode for writing CFF files.
single_precision_data(*args, **kwargs)	Specifies whether the double-precision solver saves single-precision data when writing CFF data files, in order to reduce the size of the files.

compression_level(*args, **kwargs)#

Sets the compression level for CFF files. The compression level can be set between 0 and 9 with 0 being least compression (fastest) and 9 being highest compression (slowest).

io_mode(*args, **kwargs)#

Sets the I/O mode for writing CFF files. 1. HOST: I/O is done serially by the host process. 2. NODE0: I/O is done serially by the node 0 process. 3. PARALLEL INDEPENDENT: I/O is done in parallel using the independent mode of MPI I/O. 4. PARALLEL COLLECTIVE: I/O is done in parallel using the collective mode of MPI I/O.

single_precision_data(*args, **kwargs)#

Specifies whether the double-precision solver saves single-precision data when writing CFF data files, in order to reduce the size of the files.

close_without_save(*args, **kwargs)#

Exits ANSYS Fluent without saving data in Workbench. This command is only available when running ANSYS Fluent in Workbench.

confirm_overwrite(*args, **kwargs)#

.

convert_hanging_nodes_during_read(*args, **kwargs)#

.

data_file_options(*args, **kwargs)#

Sets derived quantities to be written in data file.

define_macro(*args, **kwargs)#

Saves input to a named macro.

class em_mapping(service, version, mode, path)#

Bases: TUIMenu

Enters the electromagnetic loss mapping menu.

Methods:

maintain_loss_on_initialization(*args, **kwargs)	Maintains the loss data provided by Maxwell even if solution is initialized.
remove_loss_only(*args, **kwargs)	Removes the loss data provided by Maxwell and keeps all other solution data.
surface_energy_source(*args, **kwargs)	Loss data provided by Ansoft will be assigned to Fluent for selected wall zones.
volumetric_energy_source(*args, **kwargs)	Loss data provided by Ansoft will be assigned to Fluent for selected cell zones.

maintain_loss_on_initialization(*args, **kwargs)#

Maintains the loss data provided by Maxwell even if solution is initialized.

remove_loss_only(*args, **kwargs)#

Removes the loss data provided by Maxwell and keeps all other solution data.

surface_energy_source(*args, **kwargs)#

Loss data provided by Ansoft will be assigned to Fluent for selected wall zones.

volumetric_energy_source(*args, **kwargs)#

Loss data provided by Ansoft will be assigned to Fluent for selected cell zones.

execute_macro(*args, **kwargs)#

Runs a previously defined macro.

class export(service, version, mode, path)#

Bases: TUIMenu

Enter the export menu.

Methods:

abaqus(*args, **kwargs)	Writes an ABAQUS file.
ascii(*args, **kwargs)	Writes an ASCII file.
avs(*args, **kwargs)	Writes an AVS UCD file.
cdat_for_cfd_post__and__ensight(*args, **kwargs)	Write a CDAT for CFD-Post & EnSight file.
cgns(*args, **kwargs)	Write a CGNS file.
common_fluids_format_post(*args, **kwargs)	Writes common fluids format files (.cas.post and .dat.post) for mesh and data, respectively.
custom_heat_flux(*args, **kwargs)	Writes a generic file for heat transfer.
dx(*args, **kwargs)	Writes an IBM Data Explorer format file.
ensight(*args, **kwargs)	Writes EnSight geometry, velocity, and scalar files.
ensight_dvs(*args, **kwargs)	Write post-processing data (geometry, velocity and scalars) for cell and face zones using EnSight Dynamic Visualization Store Interface.
ensight_dvs_surfaces(*args, **kwargs)	Write post-processing data (geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface.
ensight_dvs_volume(*args, **kwargs)	Write post-processing data (geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface.
ensight_gold(*args, **kwargs)	Writes EnSight Gold geometry, velocity, and scalar files.
ensight_gold_parallel_surfaces(*args, **kwargs)	Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise.
ensight_gold_parallel_volume(*args, **kwargs)	Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise.
fast_mesh(*args, **kwargs)	Writes FAST/Plot3D unstructured mesh file.
fast_scalar(*args, **kwargs)	Writes FAST/Plot3D unstructured scalar function file.
fast_solution(*args, **kwargs)	Writes FAST/Plot3D unstructured solution file.
fast_velocity(*args, **kwargs)	Writes FAST/Plot3D unstructured vector function file.
fieldview(*args, **kwargs)	Writes FIELDVIEW case and data files.
fieldview_data(*args, **kwargs)	Writes FIELDVIEW case and data files.
fieldview_unstruct(*args, **kwargs)	Writes FIELDVIEW unstructured combined file.
fieldview_unstruct_data(*args, **kwargs)	Writes FIELDVIEW unstructured results-only file.
fieldview_unstruct_mesh(*args, **kwargs)	Writes FIELDVIEW unstructured mesh-only file.
fieldview_unstruct_surfaces(*args, **kwargs)	Writes FIELDVIEW unstructured file for surfaces.
gambit(*args, **kwargs)	Writes GAMBIT neutral file.
icemcfd_for_icepak(*args, **kwargs)	Writes a binary ICEM CFD domain file.
ideas(*args, **kwargs)	Writes an I-deas universal file.
mechanical_apdl(*args, **kwargs)	.
mechanical_apdl_input(*args, **kwargs)	Writes a Mechanical APDL Input file.
nastran(*args, **kwargs)	Write a NASTRAN file.
particle_history_data(*args, **kwargs)	Exports particle-history data.
patran_neutral(*args, **kwargs)	Writes a PATRAN neutral file.
patran_nodal(*args, **kwargs)	Writes a PATRAN nodal results file.
system_coupling_definition_file_settings(...)	Enters the system coupling file (.scp) menu.
taitherm(*args, **kwargs)	Exports TAITherm file.
tecplot(*args, **kwargs)	Writes a Tecplot+3DV format file.

Classes:

settings(service, version, mode, path)

Enter the export settings menu.

abaqus(*args, **kwargs)#

Writes an ABAQUS file.

ascii(*args, **kwargs)#

Writes an ASCII file.

avs(*args, **kwargs)#

Writes an AVS UCD file.

cdat_for_cfd_post__and__ensight(*args, **kwargs)#

Write a CDAT for CFD-Post & EnSight file.

cgns(*args, **kwargs)#

Write a CGNS file.

common_fluids_format_post(*args, **kwargs)#

Writes common fluids format files (.cas.post and .dat.post) for mesh and data, respectively. These files are saved in the hierarchical data format.

custom_heat_flux(*args, **kwargs)#

Writes a generic file for heat transfer.

dx(*args, **kwargs)#

Writes an IBM Data Explorer format file.

ensight(*args, **kwargs)#

Writes EnSight geometry, velocity, and scalar files.

ensight_dvs(*args, **kwargs)#

Write post-processing data (geometry, velocity and scalars) for cell and face zones using EnSight Dynamic Visualization Store Interface.

ensight_dvs_surfaces(*args, **kwargs)#

Write post-processing data (geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface.

ensight_dvs_volume(*args, **kwargs)#

Write post-processing data (geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface.

ensight_gold(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files.

ensight_gold_parallel_surfaces(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise.

ensight_gold_parallel_volume(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise.

fast_mesh(*args, **kwargs)#

Writes FAST/Plot3D unstructured mesh file.

fast_scalar(*args, **kwargs)#

Writes FAST/Plot3D unstructured scalar function file.

fast_solution(*args, **kwargs)#

Writes FAST/Plot3D unstructured solution file.

fast_velocity(*args, **kwargs)#

Writes FAST/Plot3D unstructured vector function file.

fieldview(*args, **kwargs)#

Writes FIELDVIEW case and data files.

fieldview_data(*args, **kwargs)#

Writes FIELDVIEW case and data files.

fieldview_unstruct(*args, **kwargs)#

Writes FIELDVIEW unstructured combined file.

fieldview_unstruct_data(*args, **kwargs)#

Writes FIELDVIEW unstructured results-only file.

fieldview_unstruct_mesh(*args, **kwargs)#

Writes FIELDVIEW unstructured mesh-only file.

fieldview_unstruct_surfaces(*args, **kwargs)#

Writes FIELDVIEW unstructured file for surfaces. You are prompted to select either [1], [2] or [3] to write either mesh-only, results-only, or combined for surfaces (respectively).

gambit(*args, **kwargs)#

Writes GAMBIT neutral file.

icemcfd_for_icepak(*args, **kwargs)#

Writes a binary ICEM CFD domain file.

ideas(*args, **kwargs)#

Writes an I-deas universal file.

mechanical_apdl(*args, **kwargs)#

.

mechanical_apdl_input(*args, **kwargs)#

Writes a Mechanical APDL Input file.

nastran(*args, **kwargs)#

Write a NASTRAN file.

particle_history_data(*args, **kwargs)#

Exports particle-history data.

patran_neutral(*args, **kwargs)#

Writes a PATRAN neutral file.

patran_nodal(*args, **kwargs)#

Writes a PATRAN nodal results file.

class settings(service, version, mode, path)#

Bases: TUIMenu

Enter the export settings menu.

Methods:

cgns_mesh_type(*args, **kwargs)	Set CGNS NGON mode.
cgns_polyhedral_cpu_threads(*args, **kwargs)	Set CGNS NGON CPU threads.
set_cgns_export_filetype(*args, **kwargs)	Select HDF5 or ADF as file format for CGNS.

cgns_mesh_type(*args, **kwargs)#

Set CGNS NGON mode.

cgns_polyhedral_cpu_threads(*args, **kwargs)#

Set CGNS NGON CPU threads.

set_cgns_export_filetype(*args, **kwargs)#

Select HDF5 or ADF as file format for CGNS.

system_coupling_definition_file_settings(*args, **kwargs)#

Enters the system coupling file (.scp) menu.

taitherm(*args, **kwargs)#

Exports TAITherm file.

tecplot(*args, **kwargs)#

Writes a Tecplot+3DV format file.

export_to_cfd_post(*args, **kwargs)#

Exports data files that are compatible with CFD-Post and EnSight (that is, .cdat and .cst files) and opens CFD-Post, if desired.

class fsi(service, version, mode, path)#

Bases: TUIMenu

Enters the fluid-structure interaction menu.

Methods:

conserve_force(*args, **kwargs)	Conserve the forces for linear line, tri and tet elements.
display_fsi_mesh(*args, **kwargs)	Displays the mesh for a fluid-structure interaction.
read_fsi_mesh(*args, **kwargs)	Reads an FEM mesh for one-way data mapping from ANSYS Fluent.
write_fsi_mesh(*args, **kwargs)	Writes a fluid-structure interaction mesh file.

conserve_force(*args, **kwargs)#

Conserve the forces for linear line, tri and tet elements.

display_fsi_mesh(*args, **kwargs)#

Displays the mesh for a fluid-structure interaction.

read_fsi_mesh(*args, **kwargs)#

Reads an FEM mesh for one-way data mapping from ANSYS Fluent.

write_fsi_mesh(*args, **kwargs)#

Writes a fluid-structure interaction mesh file.

class import_(service, version, mode, path)#

Bases: TUIMenu

Enter the import menu.

Classes:

abaqus(service, version, mode, path)	Enter the Abaqus menu.
cfx(service, version, mode, path)	Enter the CFX menu.
cgns(service, version, mode, path)	Enter the CGNS menu.
lstc(service, version, mode, path)	Enter the LSTC menu.
mechanical_apdl(service, version, mode, path)	Enter the Mechanical APDL menu.
nastran(service, version, mode, path)	Enter the NASTRAN menu.
partition(service, version, mode, path)	Enter the partition menu.
patran(service, version, mode, path)	Enter the PATRAN menu.
plot3d(service, version, mode, path)	Enter the PLOT3D menu.
tecplot(service, version, mode, path)	Enter the Tecplot menu.

Methods:

chemkin_mechanism(*args, **kwargs)	Read a CHEMKIN mechanism file.
chemkin_report_each_line(*args, **kwargs)	Enable/disable reporting after reading each line.
ensight(*args, **kwargs)	Read an Ensight file as a case file.
fidap(*args, **kwargs)	Read a FIDAP neutral file as a case file.
flamelet(*args, **kwargs)	Import a flamelet file.
fluent4_case(*args, **kwargs)	Read a formatted Fluent 4 case file.
fmu_file(*args, **kwargs)	Read a FMU file.
gambit(*args, **kwargs)	Read a GAMBIT neutral file as a case file.
hypermesh(*args, **kwargs)	Read a HYPERMESH file as a case file.
ideas_universal(*args, **kwargs)	Read an IDEAS Universal file as a case file.
marc_post(*args, **kwargs)	Read a MARC POST file as a case file.
prebfc_structured(*args, **kwargs)	Read a formatted preBFC structured mesh (grid) file.
ptc_mechanica(*args, **kwargs)	Read a PTC Mechanica file as a case file.

class abaqus(service, version, mode, path)#

Bases: TUIMenu

Enter the Abaqus menu.

Methods:

fil(*args, **kwargs)	Read an Abaqus .fil result file as a case file.
input(*args, **kwargs)	Read an Abaqus Input file as a case file.
odb(*args, **kwargs)	Read an Abaqus odb file as a case file.

fil(*args, **kwargs)#

Read an Abaqus .fil result file as a case file.

input(*args, **kwargs)#

Read an Abaqus Input file as a case file.

odb(*args, **kwargs)#

Read an Abaqus odb file as a case file.

class cfx(service, version, mode, path)#

Bases: TUIMenu

Enter the CFX menu.

Methods:

definition(*args, **kwargs)	Read a CFX definition file as a case file.
result(*args, **kwargs)	Read a CFX result file as a case file.

definition(*args, **kwargs)#

Read a CFX definition file as a case file.

result(*args, **kwargs)#

Read a CFX result file as a case file.

class cgns(service, version, mode, path)#

Bases: TUIMenu

Enter the CGNS menu.

Methods:

data(*args, **kwargs)	Read data from CGNS file.
mesh(*args, **kwargs)	Read a CGNS file as a case file.
mesh_data(*args, **kwargs)	Read a CGNS file as a case file.

data(*args, **kwargs)#

Read data from CGNS file.

mesh(*args, **kwargs)#

Read a CGNS file as a case file.

mesh_data(*args, **kwargs)#

Read a CGNS file as a case file.

chemkin_mechanism(*args, **kwargs)#

Read a CHEMKIN mechanism file.

chemkin_report_each_line(*args, **kwargs)#

Enable/disable reporting after reading each line.

ensight(*args, **kwargs)#

Read an Ensight file as a case file.

fidap(*args, **kwargs)#

Read a FIDAP neutral file as a case file.

flamelet(*args, **kwargs)#

Import a flamelet file.

fluent4_case(*args, **kwargs)#

Read a formatted Fluent 4 case file.

fmu_file(*args, **kwargs)#

Read a FMU file.

gambit(*args, **kwargs)#

Read a GAMBIT neutral file as a case file.

hypermesh(*args, **kwargs)#

Read a HYPERMESH file as a case file.

ideas_universal(*args, **kwargs)#

Read an IDEAS Universal file as a case file.

class lstc(service, version, mode, path)#

Bases: TUIMenu

Enter the LSTC menu.

Methods:

input(*args, **kwargs)	Read an LSTC input file as a case file.
state(*args, **kwargs)	Read an LSTC result file as a case file.

input(*args, **kwargs)#

Read an LSTC input file as a case file.

state(*args, **kwargs)#

Read an LSTC result file as a case file.

marc_post(*args, **kwargs)#

Read a MARC POST file as a case file.

class mechanical_apdl(service, version, mode, path)#

Bases: TUIMenu

Enter the Mechanical APDL menu.

Methods:

input(*args, **kwargs)	Read an Mechanical APDL file as a case file.
result(*args, **kwargs)	Read an Mechanical APDL result file as a case file.

input(*args, **kwargs)#

Read an Mechanical APDL file as a case file.

result(*args, **kwargs)#

Read an Mechanical APDL result file as a case file.

class nastran(service, version, mode, path)#

Bases: TUIMenu

Enter the NASTRAN menu.

Methods:

bulkdata(*args, **kwargs)	Read a NASTRAN file as a case file.
output2(*args, **kwargs)	Read a NASTRAN op2 file as a case file.

bulkdata(*args, **kwargs)#

Read a NASTRAN file as a case file.

output2(*args, **kwargs)#

Read a NASTRAN op2 file as a case file.

class partition(service, version, mode, path)#

Bases: TUIMenu

Enter the partition menu.

Methods:

metis(*args, **kwargs)	Read and partition a Fluent 5 case file.
metis_zone(*args, **kwargs)	Read and partition a Fluent 5 case file.

metis(*args, **kwargs)#

Read and partition a Fluent 5 case file.

metis_zone(*args, **kwargs)#

Read and partition a Fluent 5 case file.

class patran(service, version, mode, path)#

Bases: TUIMenu

Enter the PATRAN menu.

Methods:

neutral(*args, **kwargs)

Read a PATRAN Neutral file (zones defined by named components) as a case file.

neutral(*args, **kwargs)#

Read a PATRAN Neutral file (zones defined by named components) as a case file.

class plot3d(service, version, mode, path)#

Bases: TUIMenu

Enter the PLOT3D menu.

Methods:

mesh(*args, **kwargs)

Read a PLOT3D file as a case file.

mesh(*args, **kwargs)#

Read a PLOT3D file as a case file.

prebfc_structured(*args, **kwargs)#

Read a formatted preBFC structured mesh (grid) file.

ptc_mechanica(*args, **kwargs)#

Read a PTC Mechanica file as a case file.

class tecplot(service, version, mode, path)#

Bases: TUIMenu

Enter the Tecplot menu.

Methods:

mesh(*args, **kwargs)

Read a Tecplot binary file as a case file.

mesh(*args, **kwargs)#

Read a Tecplot binary file as a case file.

class interpolate(service, version, mode, path)#

Bases: TUIMenu

Interpolates data to/from another grid.

Methods:

read_data(*args, **kwargs)	Reads and interpolates data.
write_data(*args, **kwargs)	Writes data for interpolation.
zone_selection(*args, **kwargs)	Defines a list of cell zone IDs.

read_data(*args, **kwargs)#

Reads and interpolates data.

write_data(*args, **kwargs)#

Writes data for interpolation.

zone_selection(*args, **kwargs)#

Defines a list of cell zone IDs. If specified, interpolation data will be read/written for these cell zones only.

load_act_tool(*args, **kwargs)#

Load ACT Start Page.

class parametric_project(service, version, mode, path)#

Bases: TUIMenu

Enter to open, save, archive parametric project.

Methods:

archive(*args, **kwargs)	Archive Project.
open(*args, **kwargs)	Open project.
save(*args, **kwargs)	Save Project.
save_a_copy(*args, **kwargs)	Save a Copy.
save_as(*args, **kwargs)	Save As Project.

archive(*args, **kwargs)#

Archive Project.

open(*args, **kwargs)#

Open project.

save(*args, **kwargs)#

Save Project.

save_a_copy(*args, **kwargs)#

Save a Copy.

save_as(*args, **kwargs)#

Save As Project.

class project_beta(service, version, mode, path)#

Bases: TUIMenu

Enter to create new project, open project, save and archive project.

Methods:

archive(*args, **kwargs)	Archive Project.
new(*args, **kwargs)	Create New Project.
open(*args, **kwargs)	Open project.
save(*args, **kwargs)	Save Project.
save_as(*args, **kwargs)	Save As Project.
save_as_copy(*args, **kwargs)	Save As Copy.

archive(*args, **kwargs)#

Archive Project.

new(*args, **kwargs)#

Create New Project.

open(*args, **kwargs)#

Open project.

save(*args, **kwargs)#

Save Project.

save_as(*args, **kwargs)#

Save As Project.

save_as_copy(*args, **kwargs)#

Save As Copy.

read_case(*args, **kwargs)#

Read a case file.

read_case_data(*args, **kwargs)#

Reads a case and a data file.

read_case_info(*args, **kwargs)#

Read basic case info.

read_case_settings(*args, **kwargs)#

Read a case file while skipping mesh elements.

read_data(*args, **kwargs)#

Reads a data file.

read_field_functions(*args, **kwargs)#

Reads custom field function definitions from a file.

read_injections(*args, **kwargs)#

Reads all DPM injections from a file.

read_isat_table(*args, **kwargs)#

Reads ISAT Table.

read_journal(*args, **kwargs)#

Read a journal file.

read_macros(*args, **kwargs)#

Reads macro definitions from a file.

read_pdf(*args, **kwargs)#

Reads a PDF file.

read_profile(*args, **kwargs)#

Reads boundary profile data.

read_rays(*args, **kwargs)#

Reads a ray file.

read_settings(*args, **kwargs)#

Reads and sets boundary conditions from a specified file.

read_surface_clusters(*args, **kwargs)#

Reads surface clusters from a file.

read_transient_table(*args, **kwargs)#

Reads table of transient boundary profile data.

read_viewfactors(*args, **kwargs)#

Reads view factors from a file.

reload_setup(*args, **kwargs)#

Discards any changes in the current ANSYS Fluent in Workbench session and removes any corresponding data from the Solution cell. This command is only available when running ANSYS Fluent in Workbench.

replace_mesh(*args, **kwargs)#

Replaces the mesh with a new one while preserving settings.

set_batch_options(*args, **kwargs)#

Sets the batch options.

set_err_on_inval_cmd(*args, **kwargs)#

Set whether to abort journal replay on invalid command.

set_idle_timeout(*args, **kwargs)#

Set the idle timeout.

set_target_reference_frame_for_write_profiles(*args, **kwargs)#

Set reference frame options, which will be used for position transformation during writing of profiles.

set_tui_version(*args, **kwargs)#

Set the version of the TUI commands.

show_configuration(*args, **kwargs)#

.

single_precision_coordinates(*args, **kwargs)#

Specifies whether the nodal coordinates should be written in single precision (rather than the default double precision). This text command is only available in the single-precision version of ANSYS Fluent.

class solution_files(service, version, mode, path)#

Bases: TUIMenu

Enters the solution files menu.

Methods:

delete_solution(*args, **kwargs)	Deletes solution files.
load_solution(*args, **kwargs)	Loads a solution file.
print_solution_files(*args, **kwargs)	Prints a list of available solution files.

delete_solution(*args, **kwargs)#

Deletes solution files.

load_solution(*args, **kwargs)#

Loads a solution file.

print_solution_files(*args, **kwargs)#

Prints a list of available solution files.

start_journal(*args, **kwargs)#

.

start_transcript(*args, **kwargs)#

.

stop_journal(*args, **kwargs)#

.

stop_macro(*args, **kwargs)#

Stops recording input to a macro.

stop_transcript(*args, **kwargs)#

.

sync_workbench(*args, **kwargs)#

Directly updates Workbench with the most recent Fluent changes. This command is only available when running ANSYS Fluent in Workbench.

class table_manager(service, version, mode, path)#

Bases: TUIMenu

Enters the table file manager menu.

Methods:

delete(*args, **kwargs)	Deletes a table from local storage.
list_matrix_data(*args, **kwargs)	Lists the data of a “matrix” type locally-stored table.
list_properties(*args, **kwargs)	Lists the properties of a locally-stored table.
list_tables(*args, **kwargs)	Lists all locally-stored tables.
read_matrix_data_file(*args, **kwargs)	Imports a “matrix” type table from a file into local storage.
read_rgp_file(*args, **kwargs)	Imports a set of Real Gas Property (RGP) tables from a file into local storage.
rename(*args, **kwargs)	Renames a locally-stored table.
store_in_case_file(*args, **kwargs)	Sets the persistence mode for RGP tables (embedded in case file or rely on external file).

delete(*args, **kwargs)#

Deletes a table from local storage.

list_matrix_data(*args, **kwargs)#

Lists the data of a “matrix” type locally-stored table.

list_properties(*args, **kwargs)#

Lists the properties of a locally-stored table.

list_tables(*args, **kwargs)#

Lists all locally-stored tables.

read_matrix_data_file(*args, **kwargs)#

Imports a “matrix” type table from a file into local storage.

read_rgp_file(*args, **kwargs)#

Imports a set of Real Gas Property (RGP) tables from a file into local storage.

rename(*args, **kwargs)#

Renames a locally-stored table.

store_in_case_file(*args, **kwargs)#

Sets the persistence mode for RGP tables (embedded in case file or rely on external file).

class transient_export(service, version, mode, path)#

Bases: TUIMenu

Enter the export menu.

Methods:

abaqus(*args, **kwargs)	Writes an ABAQUS file.
ascii(*args, **kwargs)	Writes an ASCII file.
avs(*args, **kwargs)	Writes an AVS UCD file.
cdat_for_cfd_post__and__ensight(*args, **kwargs)	Write a CDAT for CFD-Post & EnSight file.
cgns(*args, **kwargs)	Writes a CGNS file.
common_fluids_format_post(*args, **kwargs)	Write an CFF Post-Only file.
delete(*args, **kwargs)	Deletes transient exports.
dx(*args, **kwargs)	Writes an IBM Data Explorer format file.
edit(*args, **kwargs)	Edits transient exports.
ensight_dvs(*args, **kwargs)	Write post-processing data (geometry, velocity and scalars) for cell and face zones using EnSight Dynamic Visualization Store Interface.
ensight_dvs_surfaces(*args, **kwargs)	Write post-processing data (geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface.
ensight_dvs_volume(*args, **kwargs)	Write post-processing data (geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface.
ensight_gold_from_existing_files(*args, **kwargs)	Writes EnSight Gold files using ANSYS Fluent case files.
ensight_gold_parallel_surfaces(*args, **kwargs)	Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise.
ensight_gold_parallel_volume(*args, **kwargs)	Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise.
ensight_gold_transient(*args, **kwargs)	Writes EnSight Gold geometry, velocity, and scalar files.
fast(*args, **kwargs)	Writes a FAST/Plot3D unstructured mesh velocity scalar file.
fast_solution(*args, **kwargs)	Writes a FAST/Plot3D unstructured solution file.
fieldview_unstruct(*args, **kwargs)	Writes a FIELDVIEW unstructured combined file.
fieldview_unstruct_data(*args, **kwargs)	Writes a FIELDVIEW unstructured results only file.
fieldview_unstruct_mesh(*args, **kwargs)	Writes a FIELDVIEW unstructured mesh only file.
fieldview_unstruct_surfaces(*args, **kwargs)	Writes FIELDVIEW unstructured combined file for surfaces.
ideas(*args, **kwargs)	Writes an I-deas universal file.
mechanical_apdl_input(*args, **kwargs)	Writes a Mechanical APDL input file.
nastran(*args, **kwargs)	Writes a NASTRAN file.
particle_history_data(*args, **kwargs)	Sets up an automatic particle-history data export.
patran_neutral(*args, **kwargs)	Writes a PATRAN neutral file.
taitherm(*args, **kwargs)	Writes a TAITherm file.
tecplot(*args, **kwargs)	Write a Tecplot+3DV format file.

Classes:

settings(service, version, mode, path)

Enters the automatic export settings menu.

abaqus(*args, **kwargs)#

Writes an ABAQUS file.

ascii(*args, **kwargs)#

Writes an ASCII file.

avs(*args, **kwargs)#

Writes an AVS UCD file.

cdat_for_cfd_post__and__ensight(*args, **kwargs)#

Write a CDAT for CFD-Post & EnSight file.

cgns(*args, **kwargs)#

Writes a CGNS file.

common_fluids_format_post(*args, **kwargs)#

Write an CFF Post-Only file.

delete(*args, **kwargs)#

Deletes transient exports.

dx(*args, **kwargs)#

Writes an IBM Data Explorer format file.

edit(*args, **kwargs)#

Edits transient exports.

ensight_dvs(*args, **kwargs)#

Write post-processing data (geometry, velocity and scalars) for cell and face zones using EnSight Dynamic Visualization Store Interface.

ensight_dvs_surfaces(*args, **kwargs)#

Write post-processing data (geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface.

ensight_dvs_volume(*args, **kwargs)#

Write post-processing data (geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface.

ensight_gold_from_existing_files(*args, **kwargs)#

Writes EnSight Gold files using ANSYS Fluent case files.

ensight_gold_parallel_surfaces(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise.

ensight_gold_parallel_volume(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise.

ensight_gold_transient(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files.

fast(*args, **kwargs)#

Writes a FAST/Plot3D unstructured mesh velocity scalar file.

fast_solution(*args, **kwargs)#

Writes a FAST/Plot3D unstructured solution file.

fieldview_unstruct(*args, **kwargs)#

Writes a FIELDVIEW unstructured combined file.

fieldview_unstruct_data(*args, **kwargs)#

Writes a FIELDVIEW unstructured results only file.

fieldview_unstruct_mesh(*args, **kwargs)#

Writes a FIELDVIEW unstructured mesh only file.

fieldview_unstruct_surfaces(*args, **kwargs)#

Writes FIELDVIEW unstructured combined file for surfaces.

ideas(*args, **kwargs)#

Writes an I-deas universal file.

mechanical_apdl_input(*args, **kwargs)#

Writes a Mechanical APDL input file.

nastran(*args, **kwargs)#

Writes a NASTRAN file.

particle_history_data(*args, **kwargs)#

Sets up an automatic particle-history data export.

patran_neutral(*args, **kwargs)#

Writes a PATRAN neutral file.

class settings(service, version, mode, path)#

Bases: TUIMenu

Enters the automatic export settings menu.

Methods:

cfd_post_compatible(*args, **kwargs)

Specifies when case files are written with the .cdat and .cst files exported for Ansys CFD-Post.

cfd_post_compatible(*args, **kwargs)#

Specifies when case files are written with the .cdat and .cst files exported for Ansys CFD-Post. Note that this setting is ignored if the Write Case File Every Time option is enabled in the Automatic Export dialog box, which is always the case starting in Release 2021 R1.

taitherm(*args, **kwargs)#

Writes a TAITherm file.

tecplot(*args, **kwargs)#

Write a Tecplot+3DV format file.

write_boundary_mesh(*args, **kwargs)#

Writes the boundary mesh to a file.

write_case(*args, **kwargs)#

Write a case file.

write_case_data(*args, **kwargs)#

Writes a case and a data file.

write_circumferential_averaged_profile(*args, **kwargs)#

Write surface data as a boundary profile file. To use *.csv format specify filename with .csv suffix.

write_cleanup_script(*args, **kwargs)#

Writes the cleanup-script-file for ANSYS Fluent.

write_currently_defined_profiles(*args, **kwargs)#

Write currently defined profiles. To use *.csv format specify filename with .csv suffix.

write_data(*args, **kwargs)#

Writes a data file.

write_fan_profile(*args, **kwargs)#

Computes radial profiles for a fan zone and writes them to a profile file.

write_field_functions(*args, **kwargs)#

Writes the currently defined custom field functions to a file.

write_flamelet(*args, **kwargs)#

Writes a flamelet file.

write_gpu_restart(*args, **kwargs)#

Write gpuapp restart case and data files.

write_injections(*args, **kwargs)#

Writes out selected DPM injections to a file.

write_isat_table(*args, **kwargs)#

Writes ISAT Table.

write_macros(*args, **kwargs)#

Writes the currently defined macros to a file.

write_merge_profiles(*args, **kwargs)#

Writes a .csv file with the selected surfaces consolidated into one set of data points.

write_pdat(*args, **kwargs)#

Enables / disables the attempt to save .pdat files. Note that this text command is no longer supported.

write_pdf(*args, **kwargs)#

Writes a pdf file.

write_profile(*args, **kwargs)#

Writes surface data as a boundary profile file.

write_selected_defined_profiles(*args, **kwargs)#

Set profile names, only these profile names which will be used during writing of *.csv profiles.

write_settings(*args, **kwargs)#

Writes out current boundary conditions in use.

class icing(service, version, mode, path)#

Bases: TUIMenu

FENSAP-ICE options.

Methods:

drop(*args, **kwargs)	Droplet impingement menu.
file(*args, **kwargs)	File menu.
flow(*args, **kwargs)	Flow solver menu.
ice(*args, **kwargs)	Ice accretion menu.
multishot(*args, **kwargs)	Multi-shot accretion menu.
settings(*args, **kwargs)	Global settings menu.

drop(*args, **kwargs)#

Droplet impingement menu.

file(*args, **kwargs)#

File menu.

flow(*args, **kwargs)#

Flow solver menu.

ice(*args, **kwargs)#

Ice accretion menu.

multishot(*args, **kwargs)#

Multi-shot accretion menu.

settings(*args, **kwargs)#

Global settings menu.

class mesh(service, version, mode, path)#

Bases: TUIMenu

Enter the mesh menu.

Classes:

adapt(service, version, mode, path)	Enters the mesh adaption menu.
anisotropic_adaption(service, version, mode, ...)	Enter the anisotropic adaption menu.
geometry(service, version, mode, path)	Enter the auxiliary geometry menu.
modify_zones(service, version, mode, path)	Enters the zone modification menu.
polyhedra(service, version, mode, path)	Enters the polyhedra menu.
reorder(service, version, mode, path)	Reorders domain menu.
repair_improve(service, version, mode, path)	Enter the repair and improve quality menu.
surface_mesh(service, version, mode, path)	Enters the Surface Mesh menu.

Methods:

adjacency(*args, **kwargs)	Views and renames face zones adjacent to selected cell zones.
check(*args, **kwargs)	Performs various mesh consistency checks and displays a report in the console that lists the domain extents, the volume statistics, the face area statistics, and any warnings, as well as details about the various checks and mesh failures (depending on the setting specified for mesh/check-verbosity).
check_before_solve(*args, **kwargs)	The default value for mesh/check-before-solve is “no”.
check_verbosity(*args, **kwargs)	Sets the level of details that will be added to the mesh check report generated by mesh/check.
enhanced_orthogonal_quality(*args, **kwargs)	Enables / disables an enhanced definition when calculating the orthogonal quality.
memory_usage(*args, **kwargs)	Reports solver memory use.
mesh_info(*args, **kwargs)	Prints zone information size.
quality(*args, **kwargs)	Displays information about the quality of the mesh in the console, including the minimum orthogonal quality and the maximum aspect ratio.
redistribute_boundary_layer(*args, **kwargs)	Redistributes the nodes in a boundary layer zone to achieve a desired growth rate after anisotropic adaption.
replace(*args, **kwargs)	.
rotate(*args, **kwargs)	Rotates the mesh.
scale(*args, **kwargs)	Prompts for the scaling factors in each of the active Cartesian coordinate directions.
show_periodic_shadow_zones(*args, **kwargs)	.
size_info(*args, **kwargs)	Prints mesh size.
smooth_mesh(*args, **kwargs)	Smooths the mesh using quality-based, Laplacian, or skewness methods.
swap_mesh_faces(*args, **kwargs)	Swaps mesh faces.
translate(*args, **kwargs)	Prompts for the translation offset in each of the active Cartesian coordinate directions.
wall_distance_method(*args, **kwargs)	.

class adapt(service, version, mode, path)#

Bases: TUIMenu

Enters the mesh adaption menu.

Methods:

adapt_mesh(*args, **kwargs)	Performs manual adaption on the mesh according to the methods and settings that you specified.
anisotropic_adaption(*args, **kwargs)	Applies legacy anisotropic adaption to refine the boundary layers or registers.
coarsening_criteria(*args, **kwargs)	Allows you to provide an expression for the coarsening criterion.
display_adaption_cells(*args, **kwargs)	Displays the cells that are marked for adaption in the graphics window.
free_hierarchy(*args, **kwargs)	Deletes the defined adaption hierarchy.
list_adaption_cells(*args, **kwargs)	Prints the number of cells marked for refinement, coarsening, and both to the console.
manual_coarsening_criteria(*args, **kwargs)	.
manual_refinement_criteria(*args, **kwargs)	.
refinement_criteria(*args, **kwargs)	Allows you to provide an expression for the refinement criterion.

Classes:

cell_registers(service, version, mode, path)	Enters the cell registers menu.
geometry(service, version, mode, path)	Enters the geometry menu.
manage_criteria(service, version, mode, path)	Enters the manage criteria menu, which provides text commands for managing automatic adaption criteria.
multi_layer_refinement(service, version, ...)	Enter the multiple boundary layer refinement menu.
profile(service, version, mode, path)	Enters the profile menu.
set(service, version, mode, path)	Enters the set menu.

adapt_mesh(*args, **kwargs)#

Performs manual adaption on the mesh according to the methods and settings that you specified.

anisotropic_adaption(*args, **kwargs)#

Applies legacy anisotropic adaption to refine the boundary layers or registers. Cells will be split in the normal direction to the boundary face. Note that this text command is only available for 3D cases that have the adaption method set to hanging node.

class cell_registers(service, version, mode, path)#

Bases: TUIMenu

Enters the cell registers menu.

Methods:

adapt(*args, **kwargs)	Adapt cell register objects.
add(*args, **kwargs)	Add a new object.
apply_poor_mesh_numerics(*args, **kwargs)	Applies poor mesh numerics to the mesh of a cell register.
coarsen(*args, **kwargs)	Coarsen the mesh based on a cell register.
delete(*args, **kwargs)	Deletes a cell register.
display(*args, **kwargs)	Displays a cell register.
edit(*args, **kwargs)	Edit an object.
list(*args, **kwargs)	Lists all of the currently defined cell registers.
list_properties(*args, **kwargs)	Lists the properties of a cell register.
refine(*args, **kwargs)	Refine the mesh based on a cell register.

adapt(*args, **kwargs)#

Adapt cell register objects.

add(*args, **kwargs)#

Add a new object.

apply_poor_mesh_numerics(*args, **kwargs)#

Applies poor mesh numerics to the mesh of a cell register.

coarsen(*args, **kwargs)#

Coarsen the mesh based on a cell register.

delete(*args, **kwargs)#

Deletes a cell register.

display(*args, **kwargs)#

Displays a cell register.

edit(*args, **kwargs)#

Edit an object.

list(*args, **kwargs)#

Lists all of the currently defined cell registers.

list_properties(*args, **kwargs)#

Lists the properties of a cell register.

refine(*args, **kwargs)#

Refine the mesh based on a cell register.

coarsening_criteria(*args, **kwargs)#

Allows you to provide an expression for the coarsening criterion.

display_adaption_cells(*args, **kwargs)#

Displays the cells that are marked for adaption in the graphics window.

free_hierarchy(*args, **kwargs)#

Deletes the defined adaption hierarchy.

class geometry(service, version, mode, path)#

Bases: TUIMenu

Enters the geometry menu. Note that this text command menu is not available unless the adaption method is set to hanging node.

Classes:

manage(service, version, mode, path)

Manage geometry-based adaption.

Methods:

reconstruct_geometry(*args, **kwargs)	Enables/disables geometry-based adaption.
set_geometry_controls(*args, **kwargs)	Sets geometry controls for wall zones.

class manage(service, version, mode, path)#

Bases: TUIMenu

Manage geometry-based adaption.

Methods:

add(*args, **kwargs)	Add a new object.
delete(*args, **kwargs)	Delete an object.
edit(*args, **kwargs)	Edit an object.
list(*args, **kwargs)	List objects.
list_properties(*args, **kwargs)	List properties of an object.

add(*args, **kwargs)#

Add a new object.

delete(*args, **kwargs)#

Delete an object.

edit(*args, **kwargs)#

Edit an object.

list(*args, **kwargs)#

List objects.

list_properties(*args, **kwargs)#

List properties of an object.

reconstruct_geometry(*args, **kwargs)#

Enables/disables geometry-based adaption.

set_geometry_controls(*args, **kwargs)#

Sets geometry controls for wall zones.

list_adaption_cells(*args, **kwargs)#

Prints the number of cells marked for refinement, coarsening, and both to the console.

class manage_criteria(service, version, mode, path)#

Bases: TUIMenu

Enters the manage criteria menu, which provides text commands for managing automatic adaption criteria.

Methods:

add(*args, **kwargs)	Adds a new automatic adaption criterion.
delete(*args, **kwargs)	Deletes an existing automatic adaption criterion.
edit(*args, **kwargs)	Edits an existing automatic adaption criterion.
list(*args, **kwargs)	Lists all the existing automatic adaption criteria.
list_properties(*args, **kwargs)	Lists the properties of an existing automatic adaption criterion.

add(*args, **kwargs)#

Adds a new automatic adaption criterion.

delete(*args, **kwargs)#

Deletes an existing automatic adaption criterion.

edit(*args, **kwargs)#

Edits an existing automatic adaption criterion.

list(*args, **kwargs)#

Lists all the existing automatic adaption criteria.

list_properties(*args, **kwargs)#

Lists the properties of an existing automatic adaption criterion.

manual_coarsening_criteria(*args, **kwargs)#

.

manual_refinement_criteria(*args, **kwargs)#

.

class multi_layer_refinement(service, version, mode, path)#

Bases: TUIMenu

Enter the multiple boundary layer refinement menu.

Methods:

boundary_zones(*args, **kwargs)	Specify boundary zones for refinement.
layer_count(*args, **kwargs)	Specify the layer count for refinement.
parameters(*args, **kwargs)	Specify parameters for multiple boundary layer refinement.
refine_mesh(*args, **kwargs)	Refine the mesh for multiple boundary layers.

boundary_zones(*args, **kwargs)#

Specify boundary zones for refinement.

layer_count(*args, **kwargs)#

Specify the layer count for refinement.

parameters(*args, **kwargs)#

Specify parameters for multiple boundary layer refinement.

refine_mesh(*args, **kwargs)#

Refine the mesh for multiple boundary layers.

class profile(service, version, mode, path)#

Bases: TUIMenu

Enters the profile menu.

Methods:

clear(*args, **kwargs)	Clears the adaption profiling counters.
disable(*args, **kwargs)	Disables adaption profiling.
enable(*args, **kwargs)	Enables adaption profiling.
print(*args, **kwargs)	Prints adaption profiling results.

clear(*args, **kwargs)#

Clears the adaption profiling counters.

disable(*args, **kwargs)#

Disables adaption profiling.

enable(*args, **kwargs)#

Enables adaption profiling.

print(*args, **kwargs)#

Prints adaption profiling results.

refinement_criteria(*args, **kwargs)#

Allows you to provide an expression for the refinement criterion.

class set(service, version, mode, path)#

Bases: TUIMenu

Enters the set menu.

Methods:

additional_refinement_layers(*args, **kwargs)	Allows you to specify additional refinement layers (this is an advanced control).
cell_zones(*args, **kwargs)	Sets cell zones to be used for marking adaption.
display_settings(*args, **kwargs)	Sets the graphics display options for the refinement, coarsening, and common cells.
dynamic_adaption(*args, **kwargs)	.
dynamic_adaption_frequency(*args, **kwargs)	.
encapsulate_children(*args, **kwargs)	.
maximum_cell_count(*args, **kwargs)	Sets an approximate limit to the total cell count of the mesh during adaption.
maximum_refinement_level(*args, **kwargs)	Controls the number of levels of refinement used to split cells during the adaption.
method(*args, **kwargs)	Sets the adaption method.
minimum_cell_quality(*args, **kwargs)	Sets the minimum value allowed for the orthogonal quality of cells during adaption.
minimum_cell_volume(*args, **kwargs)	Set limit on the minimum volume of cells in the mesh.
minimum_edge_length(*args, **kwargs)	Sets an approximate limit to the edge length for cells that are considered for refinement.
overset_adapt_dead_cells(*args, **kwargs)	Enables/disables the adaption of dead cells in overset meshes.
prismatic_adaption(*args, **kwargs)	.
prismatic_boundary_zones(*args, **kwargs)	.
prismatic_split_ratio(*args, **kwargs)	.
verbosity(*args, **kwargs)	Allows you set how much information about the adaption is printed to the console.

additional_refinement_layers(*args, **kwargs)#

Allows you to specify additional refinement layers (this is an advanced control).

cell_zones(*args, **kwargs)#

Sets cell zones to be used for marking adaption. An empty list specifies that all zones are considered for adaption.

display_settings(*args, **kwargs)#

Sets the graphics display options for the refinement, coarsening, and common cells.

dynamic_adaption(*args, **kwargs)#

.

dynamic_adaption_frequency(*args, **kwargs)#

.

encapsulate_children(*args, **kwargs)#

.

maximum_cell_count(*args, **kwargs)#

Sets an approximate limit to the total cell count of the mesh during adaption. Fluent uses this value to determine when to stop marking cells for refinement. A value of zero places no limits on the number of cells.

maximum_refinement_level(*args, **kwargs)#

Controls the number of levels of refinement used to split cells during the adaption.

method(*args, **kwargs)#

Sets the adaption method.

minimum_cell_quality(*args, **kwargs)#

Sets the minimum value allowed for the orthogonal quality of cells during adaption. If your solution diverges, you may find that using a higher minimum quality value resolves the issue. This text command is only available with the PUMA 3D adaption method.

minimum_cell_volume(*args, **kwargs)#

Set limit on the minimum volume of cells in the mesh.

minimum_edge_length(*args, **kwargs)#

Sets an approximate limit to the edge length for cells that are considered for refinement. Even if a cell is marked for refinement, it will not be refined if (for 3D) its volume is less than the cube of this field or (for 2D) its area is less than the square of this field. The default value of zero places no limits on the size of cells that are refined.

overset_adapt_dead_cells(*args, **kwargs)#

Enables/disables the adaption of dead cells in overset meshes.

prismatic_adaption(*args, **kwargs)#

.

prismatic_boundary_zones(*args, **kwargs)#

.

prismatic_split_ratio(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

Allows you set how much information about the adaption is printed to the console.

adjacency(*args, **kwargs)#

Views and renames face zones adjacent to selected cell zones.

class anisotropic_adaption(service, version, mode, path)#

Bases: TUIMenu

Enter the anisotropic adaption menu.

Methods:

adapt_mesh(*args, **kwargs)	.
fixed_zones(*args, **kwargs)	.
iterations(*args, **kwargs)	.

Classes:

indicator(service, version, mode, path)	.
operations(service, version, mode, path)	Enter the anisotropic adaption operations menu.
target(service, version, mode, path)	.

adapt_mesh(*args, **kwargs)#

.

fixed_zones(*args, **kwargs)#

.

class indicator(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

indicator_type(*args, **kwargs)	.
multi_scalar_fn(*args, **kwargs)	.
single_scalar_fn(*args, **kwargs)	.

indicator_type(*args, **kwargs)#

.

multi_scalar_fn(*args, **kwargs)#

.

single_scalar_fn(*args, **kwargs)#

.

iterations(*args, **kwargs)#

.

class operations(service, version, mode, path)#

Bases: TUIMenu

Enter the anisotropic adaption operations menu.

Methods:

coarsen(*args, **kwargs)	.
move(*args, **kwargs)	.
refine(*args, **kwargs)	.
swap(*args, **kwargs)	.

coarsen(*args, **kwargs)#

.

move(*args, **kwargs)#

.

refine(*args, **kwargs)#

.

swap(*args, **kwargs)#

.

class target(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

factor_of_cells(*args, **kwargs)	.
number_of_cells(*args, **kwargs)	.
target_type(*args, **kwargs)	.

factor_of_cells(*args, **kwargs)#

.

number_of_cells(*args, **kwargs)#

.

target_type(*args, **kwargs)#

.

check(*args, **kwargs)#

Performs various mesh consistency checks and displays a report in the console that lists the domain extents, the volume statistics, the face area statistics, and any warnings, as well as details about the various checks and mesh failures (depending on the setting specified for mesh/check-verbosity).

check_before_solve(*args, **kwargs)#

The default value for mesh/check-before-solve is “no”. If mesh/check-before-solve is set to “yes”, a mesh check operation will be invoked prior to starting solver. If grid check fails, solver will be interrupted, and relevant information will be printed in the Fluent console.

check_verbosity(*args, **kwargs)#

Sets the level of details that will be added to the mesh check report generated by mesh/check. A value of 0 (the default) notes when checks are being performed, but does not list them individually. A value of 1 lists the individual checks as they are performed. A value of 2 enables the availability of additional mesh field variables, lists the individual checks as they are performed, and provides additional details (for example, the location of the problem, the affected cells). The check-verbosity text command can also be used to set the level of detail displayed in the mesh quality report generated by mesh/quality. A value of 0 (the default) or 1 lists the minimum orthogonal quality and the maximum aspect ratio. A value of 2 adds information about the zones that contain the cells with the lowest quality, and additional metrics such as the maximum cell squish index and the minimum expansion ratio.

enhanced_orthogonal_quality(*args, **kwargs)#

Enables / disables an enhanced definition when calculating the orthogonal quality. When enabled, the orthogonal quality is defined using a variety quality measures, including: the orthogonality of a face relative to a vector between the face and cell centroids; a metric that detects poor cell shape at a local edge (such as twisting and/or concavity); and the variation of normals between the faces that can be constructed from the cell face. This enhanced definition is optimal for evaluating thin prism cells.

class geometry(service, version, mode, path)#

Bases: TUIMenu

Enter the auxiliary geometry menu.

Methods:

add(*args, **kwargs)	Add a new object.
delete(*args, **kwargs)	Delete an object.
display(*args, **kwargs)	Display geometry.
display_options(*args, **kwargs)	Display options.
edit(*args, **kwargs)	Edit an object.
list(*args, **kwargs)	List objects.
list_properties(*args, **kwargs)	List properties of an object.

add(*args, **kwargs)#

Add a new object.

delete(*args, **kwargs)#

Delete an object.

display(*args, **kwargs)#

Display geometry.

display_options(*args, **kwargs)#

Display options.

edit(*args, **kwargs)#

Edit an object.

list(*args, **kwargs)#

List objects.

list_properties(*args, **kwargs)#

List properties of an object.

memory_usage(*args, **kwargs)#

Reports solver memory use.

mesh_info(*args, **kwargs)#

Prints zone information size.

class modify_zones(service, version, mode, path)#

Bases: TUIMenu

Enters the zone modification menu. For a description of the items in this menu, see define/boundary-conditions/modify-zones.

Methods:

activate_cell_zone(*args, **kwargs)	Activate a cell thread.
append_mesh(*args, **kwargs)	Append new mesh.
append_mesh_data(*args, **kwargs)	Append new mesh with data.
change_zone_phase(*args, **kwargs)	Change the realgas phase for a zone.
change_zone_state(*args, **kwargs)	Change the realgas material state for a zone.
convert_all_solid_mrf_to_solid_motion(*args, ...)	Change all solid zones motion specification from MRF to solid motion.
copy_mesh_to_mrf_motion(*args, **kwargs)	Copy motion variable values for origin, axis and velocities from Mesh Motion to Frame Motion.
copy_move_cell_zone(*args, **kwargs)	Copy and translate or rotate a cell zone.
copy_mrf_to_mesh_motion(*args, **kwargs)	Copy motion variable values for origin, axis and velocities from Frame Motion to Mesh Motion.
create_all_shell_threads(*args, **kwargs)	Mark all finite thickness wall for shell creation.
create_periodic_interface(*args, **kwargs)	Create a conformal or non-conformal periodic interface.
deactivate_cell_zone(*args, **kwargs)	Deactivate cell thread.
delete_all_shells(*args, **kwargs)	Delete all shell zones and switch off shell conduction on all the walls.
delete_cell_zone(*args, **kwargs)	Delete a cell thread.
extrude_face_zone_delta(*args, **kwargs)	Extrude a face thread a specified distance based on a list of deltas.
extrude_face_zone_para(*args, **kwargs)	Extrude a face thread a specified distance based on a distance and a list of parametric locations between 0 and 1 (eg.
fuse_face_zones(*args, **kwargs)	Attempt to fuse zones by removing duplicate faces and nodes.
list_zones(*args, **kwargs)	List zone IDs, types, kinds, and names.
make_periodic(*args, **kwargs)	Attempt to establish conformal periodic face zone connectivity.
matching_tolerance(*args, **kwargs)	.
merge_zones(*args, **kwargs)	Merge zones of the same type and condition into one.
mrf_to_sliding_mesh(*args, **kwargs)	Change motion specification from MRF to moving mesh.
orient_face_zone(*args, **kwargs)	Orient the face zone.
recreate_all_shells(*args, **kwargs)	Create shell on all the walls where which were deleted using the command delete-all-shells.
replace_zone(*args, **kwargs)	Replace a cell zone.
rotate_zone(*args, **kwargs)	Rotate nodal coordinates of input cell zones.
scale_zone(*args, **kwargs)	Scale nodal coordinates of input cell zones.
sep_cell_zone_mark(*args, **kwargs)	Separate a cell zone based on cell marking.
sep_cell_zone_region(*args, **kwargs)	Separate a cell zone based on contiguous regions.
sep_face_zone_angle(*args, **kwargs)	Separate a face zone based on significant angle.
sep_face_zone_face(*args, **kwargs)	Separate each face in a zone into unique zone.
sep_face_zone_mark(*args, **kwargs)	Separate a face zone based on cell marking.
sep_face_zone_region(*args, **kwargs)	Separate a face zone based on contiguous regions.
slit_face_zone(*args, **kwargs)	Slit a two-sided wall into two connected wall zones.
slit_interior_between_diff_solids(*args, ...)	Slit interior created between different solids into coupled walls.
slit_periodic(*args, **kwargs)	Slit a periodic zone into two symmetry zones.
translate_zone(*args, **kwargs)	Translate nodal coordinates of input cell zones.
zone_name(*args, **kwargs)	Give a zone a new name.
zone_type(*args, **kwargs)	Set a zone's type.

activate_cell_zone(*args, **kwargs)#

Activate a cell thread.

append_mesh(*args, **kwargs)#

Append new mesh.

append_mesh_data(*args, **kwargs)#

Append new mesh with data.

change_zone_phase(*args, **kwargs)#

Change the realgas phase for a zone.

change_zone_state(*args, **kwargs)#

Change the realgas material state for a zone.

convert_all_solid_mrf_to_solid_motion(*args, **kwargs)#

Change all solid zones motion specification from MRF to solid motion.

copy_mesh_to_mrf_motion(*args, **kwargs)#

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

copy_move_cell_zone(*args, **kwargs)#

Copy and translate or rotate a cell zone.

copy_mrf_to_mesh_motion(*args, **kwargs)#

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

create_all_shell_threads(*args, **kwargs)#

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

create_periodic_interface(*args, **kwargs)#

Create a conformal or non-conformal periodic interface.

deactivate_cell_zone(*args, **kwargs)#

Deactivate cell thread.

delete_all_shells(*args, **kwargs)#

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

delete_cell_zone(*args, **kwargs)#

Delete a cell thread.

extrude_face_zone_delta(*args, **kwargs)#

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

extrude_face_zone_para(*args, **kwargs)#

Extrude a face thread a specified distance based on a distance and a list of parametric locations between 0 and 1 (eg. 0 0.2 0.4 0.8 1.0).

fuse_face_zones(*args, **kwargs)#

Attempt to fuse zones by removing duplicate faces and nodes.

list_zones(*args, **kwargs)#

List zone IDs, types, kinds, and names.

make_periodic(*args, **kwargs)#

Attempt to establish conformal periodic face zone connectivity.

matching_tolerance(*args, **kwargs)#

.

merge_zones(*args, **kwargs)#

Merge zones of the same type and condition into one.

mrf_to_sliding_mesh(*args, **kwargs)#

Change motion specification from MRF to moving mesh.

orient_face_zone(*args, **kwargs)#

Orient the face zone.

recreate_all_shells(*args, **kwargs)#

Create shell on all the walls where which were deleted using the command delete-all-shells.

replace_zone(*args, **kwargs)#

Replace a cell zone.

rotate_zone(*args, **kwargs)#

Rotate nodal coordinates of input cell zones.

scale_zone(*args, **kwargs)#

Scale nodal coordinates of input cell zones.

sep_cell_zone_mark(*args, **kwargs)#

Separate a cell zone based on cell marking.

sep_cell_zone_region(*args, **kwargs)#

Separate a cell zone based on contiguous regions.

sep_face_zone_angle(*args, **kwargs)#

Separate a face zone based on significant angle.

sep_face_zone_face(*args, **kwargs)#

Separate each face in a zone into unique zone.

sep_face_zone_mark(*args, **kwargs)#

Separate a face zone based on cell marking.

sep_face_zone_region(*args, **kwargs)#

Separate a face zone based on contiguous regions.

slit_face_zone(*args, **kwargs)#

Slit a two-sided wall into two connected wall zones.

slit_interior_between_diff_solids(*args, **kwargs)#

Slit interior created between different solids into coupled walls.

slit_periodic(*args, **kwargs)#

Slit a periodic zone into two symmetry zones.

translate_zone(*args, **kwargs)#

Translate nodal coordinates of input cell zones.

zone_name(*args, **kwargs)#

Give a zone a new name.

zone_type(*args, **kwargs)#

Set a zone’s type.

class polyhedra(service, version, mode, path)#

Bases: TUIMenu

Enters the polyhedra menu.

Methods:

convert_domain(*args, **kwargs)	Converts the entire domain to polyhedra cells.
convert_hanging_nodes(*args, **kwargs)	Converts cells with hanging nodes/edges to polyhedra.
convert_hanging_nodes_zones(*args, **kwargs)	Convert selected cell zones with hanging nodes and faces to polyhedra.
convert_skewed_cells(*args, **kwargs)	Converts skewed cells to polyhedra.

Classes:

options(service, version, mode, path)

Enters the polyhedra options menu.

convert_domain(*args, **kwargs)#

Converts the entire domain to polyhedra cells.

convert_hanging_nodes(*args, **kwargs)#

Converts cells with hanging nodes/edges to polyhedra.

convert_hanging_nodes_zones(*args, **kwargs)#

Convert selected cell zones with hanging nodes and faces to polyhedra. The selected cell zones cannot be connected to other zones.

convert_skewed_cells(*args, **kwargs)#

Converts skewed cells to polyhedra.

class options(service, version, mode, path)#

Bases: TUIMenu

Enters the polyhedra options menu.

Methods:

migrate_and_reorder(*args, **kwargs)	Enables / disables the migration of newly created partitions to the compute-nodes and the reordering of the domain as part of polyhedra conversion.
preserve_boundary_layer(*args, **kwargs)	Specifies whether boundary layer cells will be preserved when the domain is converted to polyhedra.
preserve_interior_zones(*args, **kwargs)	Enables the preservation of surfaces (that is, manifold zones of type interior) during the conversion of the domain to polyhedra.

migrate_and_reorder(*args, **kwargs)#

Enables / disables the migration of newly created partitions to the compute-nodes and the reordering of the domain as part of polyhedra conversion. This is disabled by default, because it requires significant additional memory; when disabled, it is recommended that you save the case file after conversion, read it in a new Fluent session (so that the new / stored partitions become active), and then manually reorder using the mesh/reorder/reorder-domain text command. If you want to run the calculation in the current Fluent session you can enable the migrate-and-reorder? text command prior to conversion, but you must ensure that no more than half of the available memory of your system is currently used.

preserve_boundary_layer(*args, **kwargs)#

Specifies whether boundary layer cells will be preserved when the domain is converted to polyhedra. When the value is set to 0 (default) ANSYS Fluent checks for high aspect ratio cells at the boundary layer and if any are found, Fluent asks if you want to preserve the boundary layer. When the value is set to 1, the boundary layer cells are never preserved; when it is set to 2, the boundary layer cells are always preserved (regardless of the aspect ratio of the boundary layer cells).

preserve_interior_zones(*args, **kwargs)#

Enables the preservation of surfaces (that is, manifold zones of type interior) during the conversion of the domain to polyhedra. Note that only those zones with a name that includes the string you specify will be preserved.

quality(*args, **kwargs)#

Displays information about the quality of the mesh in the console, including the minimum orthogonal quality and the maximum aspect ratio. The level of detail displayed depends on the setting specified for mesh/check-verbosity.

redistribute_boundary_layer(*args, **kwargs)#

Redistributes the nodes in a boundary layer zone to achieve a desired growth rate after anisotropic adaption.

class reorder(service, version, mode, path)#

Bases: TUIMenu

Reorders domain menu.

Methods:

band_width(*args, **kwargs)	Prints cell bandwidth.
reorder_domain(*args, **kwargs)	Reorders cells and faces using the reverse Cuthill-McKee algorithm.
reorder_zones(*args, **kwargs)	Reorders zones by partition, type, and ID.

band_width(*args, **kwargs)#

Prints cell bandwidth.

reorder_domain(*args, **kwargs)#

Reorders cells and faces using the reverse Cuthill-McKee algorithm. Note that you must save a new case file (and a data file, if data exists) after reordering with this text command, as well as recreate any ray files and/or surface cluster information.

reorder_zones(*args, **kwargs)#

Reorders zones by partition, type, and ID.

class repair_improve(service, version, mode, path)#

Bases: TUIMenu

Enter the repair and improve quality menu.

Methods:

allow_repair_at_boundaries(*args, **kwargs)	Allows the adjustment of the positions of nodes on boundaries as part of the mesh repairs performed by the mesh/repair-improve/repair text command.
improve_quality(*args, **kwargs)	Improves poor quality cells in the mesh, if possible.
include_local_polyhedra_conversion_in_repair(...)	Enables/disables the local conversion of degenerate cells into polyhedra based on skewness criteria as part of the mesh repairs performed by the mesh/repair-improve/repair text command.
repair(*args, **kwargs)	Repairs mesh problems identified by the mesh check, if possible.
repair_face_handedness(*args, **kwargs)	Modifies cell centroids to repair meshes that contain left-handed faces without face node order problems.
repair_face_node_order(*args, **kwargs)	Modifies face nodes to repair faces with improper face node order and, therefore, eliminates any resulting left-handed faces.
repair_periodic(*args, **kwargs)	Modifies the mesh to enforce a rotational angle or translational distance for periodic boundaries.
repair_wall_distance(*args, **kwargs)	Corrects wall distance at very high aspect ratio hexahedral/polyhedral cells.
report_poor_elements(*args, **kwargs)	Reports invalid and poor quality elements.

allow_repair_at_boundaries(*args, **kwargs)#

Allows the adjustment of the positions of nodes on boundaries as part of the mesh repairs performed by the mesh/repair-improve/repair text command.

improve_quality(*args, **kwargs)#

Improves poor quality cells in the mesh, if possible.

include_local_polyhedra_conversion_in_repair(*args, **kwargs)#

Enables/disables the local conversion of degenerate cells into polyhedra based on skewness criteria as part of the mesh repairs performed by the mesh/repair-improve/repair text command.

repair(*args, **kwargs)#

Repairs mesh problems identified by the mesh check, if possible. The repairs include fixing cells that have the wrong node order, the wrong face handedness, faces that are small or nonexistent, or very poor quality. Only interior nodes are repositioned by default; boundary nodes may be repositioned if the mesh/repair-improve/allow-repair-at-boundaries text command is enabled. Note that highly skewed cells may be converted into polyhedra, depending on whether the mesh/repair-improve/include-local-polyhedra-conversion-in-repair text command is enabled.

repair_face_handedness(*args, **kwargs)#

Modifies cell centroids to repair meshes that contain left-handed faces without face node order problems.

repair_face_node_order(*args, **kwargs)#

Modifies face nodes to repair faces with improper face node order and, therefore, eliminates any resulting left-handed faces.

repair_periodic(*args, **kwargs)#

Modifies the mesh to enforce a rotational angle or translational distance for periodic boundaries. For translationally periodic boundaries, the command computes an average translation distance and adjusts the node coordinates on the shadow face zone to match this distance. For rotationally periodic boundaries, the command prompts for an angle and adjusts the node coordinates on the shadow face zone using this angle and the defined rotational axis for the cell zone.

repair_wall_distance(*args, **kwargs)#

Corrects wall distance at very high aspect ratio hexahedral/polyhedral cells.

report_poor_elements(*args, **kwargs)#

Reports invalid and poor quality elements.

replace(*args, **kwargs)#

.

rotate(*args, **kwargs)#

Rotates the mesh.

scale(*args, **kwargs)#

Prompts for the scaling factors in each of the active Cartesian coordinate directions.

show_periodic_shadow_zones(*args, **kwargs)#

.

size_info(*args, **kwargs)#

Prints mesh size.

smooth_mesh(*args, **kwargs)#

Smooths the mesh using quality-based, Laplacian, or skewness methods.

class surface_mesh(service, version, mode, path)#

Bases: TUIMenu

Enters the Surface Mesh menu.

Methods:

delete(*args, **kwargs)	Deletes surface mesh.
display(*args, **kwargs)	Displays surface meshes.
read(*args, **kwargs)	Reads surface meshes.

delete(*args, **kwargs)#

Deletes surface mesh.

display(*args, **kwargs)#

Displays surface meshes.

read(*args, **kwargs)#

Reads surface meshes.

swap_mesh_faces(*args, **kwargs)#

Swaps mesh faces.

translate(*args, **kwargs)#

Prompts for the translation offset in each of the active Cartesian coordinate directions.

wall_distance_method(*args, **kwargs)#

.

class parallel(service, version, mode, path)#

Bases: TUIMenu

Enter the parallel processing menu.

Methods:

bandwidth(*args, **kwargs)	Shows network bandwidth.
check(*args, **kwargs)	Performs checks of various factors that affect parallel performance.
check_verbosity(*args, **kwargs)	Sets verbosity output of the parallel check.
latency(*args, **kwargs)	Shows network latency.
show_connectivity(*args, **kwargs)	Prints the network connectivity for the selected compute node.
thread_number_control(*args, **kwargs)	.

Classes:

gpgpu(service, version, mode, path)	Enters the GPGPU menu.
load_balance(service, version, mode, path)	Enters the load balancing parameters menu.
multidomain(service, version, mode, path)	Enters the multidomain architecture menu.
network(service, version, mode, path)	.
partition(service, version, mode, path)	Enters the partition domain menu.
set(service, version, mode, path)	Enters the set parallel parameters menu.
timer(service, version, mode, path)	Enters the timer menu.

bandwidth(*args, **kwargs)#

Shows network bandwidth.

check(*args, **kwargs)#

Performs checks of various factors that affect parallel performance.

check_verbosity(*args, **kwargs)#

Sets verbosity output of the parallel check. Higher verbosity corresponds to more detailed information.

class gpgpu(service, version, mode, path)#

Bases: TUIMenu

Enters the GPGPU menu.

Methods:

select(*args, **kwargs)	Selects which GPGPUs to use for AMG acceleration.
show(*args, **kwargs)	Lists the available GPGPUs.

select(*args, **kwargs)#

Selects which GPGPUs to use for AMG acceleration.

show(*args, **kwargs)#

Lists the available GPGPUs. GPGPUs selected for use are indicated by the presence of an asterisk (*).

latency(*args, **kwargs)#

Shows network latency.

class load_balance(service, version, mode, path)#

Bases: TUIMenu

Enters the load balancing parameters menu.

Methods:

dynamic_mesh(*args, **kwargs)	Uses load balancing for dynamic mesh?.
mesh_adaption(*args, **kwargs)	Uses load balancing for mesh adaption?.
physical_models(*args, **kwargs)	Uses physical-models load balancing?.

dynamic_mesh(*args, **kwargs)#

Uses load balancing for dynamic mesh?.

mesh_adaption(*args, **kwargs)#

Uses load balancing for mesh adaption?.

physical_models(*args, **kwargs)#

Uses physical-models load balancing?.

class multidomain(service, version, mode, path)#

Bases: TUIMenu

Enters the multidomain architecture menu.

Classes:

conjugate_heat_transfer(service, version, ...)	Enters the conjugate heat transfer menu.
solve(service, version, mode, path)	.

class conjugate_heat_transfer(service, version, mode, path)#

Bases: TUIMenu

Enters the conjugate heat transfer menu.

Methods:

enabled(*args, **kwargs)

.

Classes:

set(service, version, mode, path)

Enters the set menu for loosely coupled conjugate heat transfer.

enabled(*args, **kwargs)#

.

class set(service, version, mode, path)#

Bases: TUIMenu

Enters the set menu for loosely coupled conjugate heat transfer.

Methods:

coupling(*args, **kwargs)	Specifies when the fluid and solid zone calculations are coupled, either at a defined time period or number of fluid time steps.
helper_session(*args, **kwargs)	.

Classes:

helper_session_setup(service, version, mode, ...)

.

coupling(*args, **kwargs)#

Specifies when the fluid and solid zone calculations are coupled, either at a defined time period or number of fluid time steps.

helper_session(*args, **kwargs)#

.

class helper_session_setup(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

host_name(*args, **kwargs)	.
process_count(*args, **kwargs)	.

host_name(*args, **kwargs)#

.

process_count(*args, **kwargs)#

.

class solve(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

dual_time_iterate(*args, **kwargs)	.
iterate(*args, **kwargs)	.

dual_time_iterate(*args, **kwargs)#

.

iterate(*args, **kwargs)#

.

class network(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

kill_all_nodes(*args, **kwargs)	.
kill_node(*args, **kwargs)	.
load_hosts(*args, **kwargs)	.
save_hosts(*args, **kwargs)	.
shell_script_path(*args, **kwargs)	.
spawn_node(*args, **kwargs)	.

kill_all_nodes(*args, **kwargs)#

.

kill_node(*args, **kwargs)#

.

load_hosts(*args, **kwargs)#

.

save_hosts(*args, **kwargs)#

.

shell_script_path(*args, **kwargs)#

.

spawn_node(*args, **kwargs)#

.

class partition(service, version, mode, path)#

Bases: TUIMenu

Enters the partition domain menu.

Classes:

automatic(service, version, mode, path)	.
set(service, version, mode, path)	Enters the set partition parameters menu.

Methods:

combine_partition(*args, **kwargs)	Merges every N partitions.
merge_clusters(*args, **kwargs)	Calls the optimizer that attempts to decrease the number of interfaces by eliminating orphan cell clusters.
method(*args, **kwargs)	Sets the partition method.
print_active_partitions(*args, **kwargs)	Prints active partition information (parallel solver).
print_partitions(*args, **kwargs)	.
print_stored_partitions(*args, **kwargs)	Prints stored partition information (parallel solver).
reorder_partitions(*args, **kwargs)	Reorders partitions.
reorder_partitions_to_architecture(*args, ...)	Reorders partitions to architecture.
smooth_partition(*args, **kwargs)	Calls the optimizer that attempts to minimize the number of interfaces by modifying the partition boundaries to reduce surface area.
use_stored_partitions(*args, **kwargs)	Uses this partitioning.

class automatic(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

across_zones(*args, **kwargs)	.
load_vector(*args, **kwargs)	.
method(*args, **kwargs)	.
pre_test(*args, **kwargs)	.
use_case_file_method(*args, **kwargs)	.

across_zones(*args, **kwargs)#

.

load_vector(*args, **kwargs)#

.

method(*args, **kwargs)#

.

pre_test(*args, **kwargs)#

.

use_case_file_method(*args, **kwargs)#

.

combine_partition(*args, **kwargs)#

Merges every N partitions.

merge_clusters(*args, **kwargs)#

Calls the optimizer that attempts to decrease the number of interfaces by eliminating orphan cell clusters. (An orphan cluster is a group of connected cells such that each member has at least one face that is part of an interface boundary.).

method(*args, **kwargs)#

Sets the partition method.

print_active_partitions(*args, **kwargs)#

Prints active partition information (parallel solver).

print_partitions(*args, **kwargs)#

.

print_stored_partitions(*args, **kwargs)#

Prints stored partition information (parallel solver).

reorder_partitions(*args, **kwargs)#

Reorders partitions.

reorder_partitions_to_architecture(*args, **kwargs)#

Reorders partitions to architecture.

class set(service, version, mode, path)#

Bases: TUIMenu

Enters the set partition parameters menu.

Methods:

across_zones(*args, **kwargs)	Allows partitions to cross zone boundaries (the default).
all_off(*args, **kwargs)	Disables all optimizations.
all_on(*args, **kwargs)	Enables all optimizations.
cell_function(*args, **kwargs)	Sets cell function.
dpm_load_balancing(*args, **kwargs)	Enables / disables dynamic load balancing for discrete phase model cases that use a second domain for DPM particle tracking (that is, cases for which you have enabled the define/models/dpm/parallel/hybrid-2domain? text command).
face_area_as_weights(*args, **kwargs)	Uses face area as connection weights.
fluid_solid_rebalance_after_read_case(*args, ...)	.
isat_weight(*args, **kwargs)	Sets ISAT weight.
laplace_smoothing(*args, **kwargs)	.
layering(*args, **kwargs)	.
load_distribution(*args, **kwargs)	Sets the number of cells desired for each partition.
merge(*args, **kwargs)	Toggles the optimizer that attempts to decrease the number of interfaces by eliminating orphan cell clusters.
model_weighted_partition(*args, **kwargs)	Enables / disables model-weighted partitioning.
nfaces_as_weights(*args, **kwargs)	Uses number of faces as weights.
origin(*args, **kwargs)	Sets the , , and coordinate of the origin used by those partitioning functions that require a radial distance.
particle_weight(*args, **kwargs)	Sets DPM particle weight.
pre_test(*args, **kwargs)	Enables the operation that determines the best coordinate-splitting direction.
print_verbosity(*args, **kwargs)	.
smooth(*args, **kwargs)	Toggles the optimizer that attempts to minimize the number of interfaces by modifying the partition boundaries to reduce surface area.
solid_thread_weight(*args, **kwargs)	Uses solid thread weights.
stretched_mesh_enhancement(*args, **kwargs)	.
vof_free_surface_weight(*args, **kwargs)	Sets VOF free surface weight.

Classes:

partition_origin_vector(service, version, ...)

.

across_zones(*args, **kwargs)#

Allows partitions to cross zone boundaries (the default). If turned off, it will restrict partitioning to within each cell zone. This is recommended only when cells in different zones require significantly different amounts of computation during the solution phase; for example, if the domain contains both solid and fluid zones.

all_off(*args, **kwargs)#

Disables all optimizations.

all_on(*args, **kwargs)#

Enables all optimizations.

cell_function(*args, **kwargs)#

Sets cell function.

dpm_load_balancing(*args, **kwargs)#

Enables / disables dynamic load balancing for discrete phase model cases that use a second domain for DPM particle tracking (that is, cases for which you have enabled the define/models/dpm/parallel/hybrid-2domain? text command).

face_area_as_weights(*args, **kwargs)#

Uses face area as connection weights.

fluid_solid_rebalance_after_read_case(*args, **kwargs)#

.

isat_weight(*args, **kwargs)#

Sets ISAT weight.

laplace_smoothing(*args, **kwargs)#

.

layering(*args, **kwargs)#

.

load_distribution(*args, **kwargs)#

Sets the number of cells desired for each partition. This is useful, for example, when computing on multiple machines with significantly different performance characteristics. If left unset, each partition will contain an approximately equal number of cells. Normalized relative values may be used for the entries.

merge(*args, **kwargs)#

Toggles the optimizer that attempts to decrease the number of interfaces by eliminating orphan cell clusters.

model_weighted_partition(*args, **kwargs)#

Enables / disables model-weighted partitioning. This option works with the METIS partitioning method, and specifies that Fluent automatically calculates the weighting based on the cell count and the models and attributes specified as weights (using the parallel/partition/set/isat-weight text command, for example).

nfaces_as_weights(*args, **kwargs)#

Uses number of faces as weights.

origin(*args, **kwargs)#

Sets the , , and coordinate of the origin used by those partitioning functions that require a radial distance. By default, the origin is set to (0, 0, 0).

particle_weight(*args, **kwargs)#

Sets DPM particle weight.

class partition_origin_vector(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

edit(*args, **kwargs)	Edit partition-origin-vector object.
list_properties(*args, **kwargs)	.
number_of_objects(*args, **kwargs)	Set number of objects for partition-origin-vector.

edit(*args, **kwargs)#

Edit partition-origin-vector object.

list_properties(*args, **kwargs)#

.

number_of_objects(*args, **kwargs)#

Set number of objects for partition-origin-vector.

pre_test(*args, **kwargs)#

Enables the operation that determines the best coordinate-splitting direction.

print_verbosity(*args, **kwargs)#

.

smooth(*args, **kwargs)#

Toggles the optimizer that attempts to minimize the number of interfaces by modifying the partition boundaries to reduce surface area.

solid_thread_weight(*args, **kwargs)#

Uses solid thread weights.

stretched_mesh_enhancement(*args, **kwargs)#

.

vof_free_surface_weight(*args, **kwargs)#

Sets VOF free surface weight.

smooth_partition(*args, **kwargs)#

Calls the optimizer that attempts to minimize the number of interfaces by modifying the partition boundaries to reduce surface area.

use_stored_partitions(*args, **kwargs)#

Uses this partitioning.

class set(service, version, mode, path)#

Bases: TUIMenu

Enters the set parallel parameters menu.

Methods:

fast_io(*args, **kwargs)	.
partition_mask(*args, **kwargs)	Sets partition mask.
time_out(*args, **kwargs)	Sets spawn time-out in seconds.
verbosity(*args, **kwargs)	Sets the parallel verbosity.

fast_io(*args, **kwargs)#

.

partition_mask(*args, **kwargs)#

Sets partition mask.

time_out(*args, **kwargs)#

Sets spawn time-out in seconds.

verbosity(*args, **kwargs)#

Sets the parallel verbosity.

show_connectivity(*args, **kwargs)#

Prints the network connectivity for the selected compute node.

thread_number_control(*args, **kwargs)#

.

class timer(service, version, mode, path)#

Bases: TUIMenu

Enters the timer menu.

Methods:

reset(*args, **kwargs)	Adjusts domain timers.
usage(*args, **kwargs)	Prints performance statistics in the console window.

reset(*args, **kwargs)#

Adjusts domain timers.

usage(*args, **kwargs)#

Prints performance statistics in the console window.

class parametric_study(service, version, mode, path)#

Bases: TUIMenu

Enter the parametric study menu.

Methods:

case_settings_changed(*args, **kwargs)	Check if case settings are changed.
delete_study(*args, **kwargs)	Delete Study.
duplicate_study(*args, **kwargs)	Duplicate Parametric Study.
export_design_table(*args, **kwargs)	Export Design Point Table.
import_design_table(*args, **kwargs)	Import Design Point Table.
initialize(*args, **kwargs)	Start Parametric Study.
list_studies(*args, **kwargs)	List Studies.
rename_study(*args, **kwargs)	Rename Study.
set_as_current_study(*args, **kwargs)	Set As Current Study.
use_base_data(*args, **kwargs)	Use Base Data.

Classes:

design_points(service, version, mode, path)	Enter the design points menu.
study(service, version, mode, path)	Enter the study menu.
update(service, version, mode, path)	Enter the update menu.

case_settings_changed(*args, **kwargs)#

Check if case settings are changed.

delete_study(*args, **kwargs)#

Delete Study.

class design_points(service, version, mode, path)#

Bases: TUIMenu

Enter the design points menu.

Methods:

add(*args, **kwargs)	Add new design point.
clear_data_and_edit_values(*args, **kwargs)	Clear Generated Data.
delete(*args, **kwargs)	Delete Design Point.
duplicate(*args, **kwargs)	Duplicate Design Point.
load_case_data_for_current_dp(*args, **kwargs)	Loads relevant case/data file for current design point.
save_journals(*args, **kwargs)	Save Journals.

Classes:

auto_create(service, version, mode, path)	Enter the auto-crate design points menu.
concurrent(service, version, mode, path)	Enter the concurrent design points menu.
print_to_console(service, version, mode, path)	Enter the design points print menu.
set(service, version, mode, path)	Enter the design points Set menu.
table(service, version, mode, path)	Enter the design point table menu.

add(*args, **kwargs)#

Add new design point.

class auto_create(service, version, mode, path)#

Bases: TUIMenu

Enter the auto-crate design points menu.

Methods:

create_design_points(*args, **kwargs)	Create design points automatically.
export_designs(*args, **kwargs)	Export designs by writing a JSON file.
get_number_of_designs(*args, **kwargs)	Get number of designs.
go_to_optislang(*args, **kwargs)	Open the optiSLang project.
list_current_settings(*args, **kwargs)	List current settings for auto-create design points.
open_designs_in_optislang_postprocessor(...)	Export designs into JSON and open this JSON into optiSLang Postprocessor.
set_parameter_as_active_or_inactive(*args, ...)	Set the parameter as Active or Inactive.

create_design_points(*args, **kwargs)#

Create design points automatically.

export_designs(*args, **kwargs)#

Export designs by writing a JSON file.

get_number_of_designs(*args, **kwargs)#

Get number of designs.

go_to_optislang(*args, **kwargs)#

Open the optiSLang project.

list_current_settings(*args, **kwargs)#

List current settings for auto-create design points.

open_designs_in_optislang_postprocessor(*args, **kwargs)#

Export designs into JSON and open this JSON into optiSLang Postprocessor.

set_parameter_as_active_or_inactive(*args, **kwargs)#

Set the parameter as Active or Inactive.

clear_data_and_edit_values(*args, **kwargs)#

Clear Generated Data.

class concurrent(service, version, mode, path)#

Bases: TUIMenu

Enter the concurrent design points menu.

Methods:

abort_all_design_points(*args, **kwargs)	Interrupt All Design Points.
abort_design_point(*args, **kwargs)	Interrupt Design Point.
refresh_status(*args, **kwargs)	Refresh Status.

abort_all_design_points(*args, **kwargs)#

Interrupt All Design Points.

abort_design_point(*args, **kwargs)#

Interrupt Design Point.

refresh_status(*args, **kwargs)#

Refresh Status.

delete(*args, **kwargs)#

Delete Design Point.

duplicate(*args, **kwargs)#

Duplicate Design Point.

load_case_data_for_current_dp(*args, **kwargs)#

Loads relevant case/data file for current design point.

class print_to_console(service, version, mode, path)#

Bases: TUIMenu

Enter the design points print menu.

Methods:

capture_simulation_report_data(*args, **kwargs)	Print Capture Simulation Report Data option for Design Point.
current_dp(*args, **kwargs)	Print Name of Current Design Point.
input_parameters_of_dp(*args, **kwargs)	Print Input Parameter Values of Current Design Point.
output_parameters_of_dp(*args, **kwargs)	Print Output Parameter Values of Design Point.
status_of_all_dps(*args, **kwargs)	Print Statuses of all Design Points.
status_of_dp(*args, **kwargs)	Print Status of given DP.
write_data(*args, **kwargs)	Print WriteData option for Design Point.

capture_simulation_report_data(*args, **kwargs)#

Print Capture Simulation Report Data option for Design Point.

current_dp(*args, **kwargs)#

Print Name of Current Design Point.

input_parameters_of_dp(*args, **kwargs)#

Print Input Parameter Values of Current Design Point.

output_parameters_of_dp(*args, **kwargs)#

Print Output Parameter Values of Design Point.

status_of_all_dps(*args, **kwargs)#

Print Statuses of all Design Points.

status_of_dp(*args, **kwargs)#

Print Status of given DP.

write_data(*args, **kwargs)#

Print WriteData option for Design Point.

save_journals(*args, **kwargs)#

Save Journals.

class set(service, version, mode, path)#

Bases: TUIMenu

Enter the design points Set menu.

Methods:

capture_simulation_report_data(*args, **kwargs)	Set Capture Simulation Report Data option for Design Point.
current_dp(*args, **kwargs)	Set current design point.
input_parameters_of_dp(*args, **kwargs)	Set Input Parameter Values of Design Point.
write_data(*args, **kwargs)	Set WriteData option for Design Point.

capture_simulation_report_data(*args, **kwargs)#

Set Capture Simulation Report Data option for Design Point.

current_dp(*args, **kwargs)#

Set current design point.

input_parameters_of_dp(*args, **kwargs)#

Set Input Parameter Values of Design Point.

write_data(*args, **kwargs)#

Set WriteData option for Design Point.

class table(service, version, mode, path)#

Bases: TUIMenu

Enter the design point table menu.

Methods:

export_design_table(*args, **kwargs)	Export Design Points Table.
import_design_table(*args, **kwargs)	Import Design Points Table.

export_design_table(*args, **kwargs)#

Export Design Points Table.

import_design_table(*args, **kwargs)#

Import Design Points Table.

duplicate_study(*args, **kwargs)#

Duplicate Parametric Study.

export_design_table(*args, **kwargs)#

Export Design Point Table.

import_design_table(*args, **kwargs)#

Import Design Point Table.

initialize(*args, **kwargs)#

Start Parametric Study.

list_studies(*args, **kwargs)#

List Studies.

rename_study(*args, **kwargs)#

Rename Study.

set_as_current_study(*args, **kwargs)#

Set As Current Study.

class study(service, version, mode, path)#

Bases: TUIMenu

Enter the study menu.

Methods:

delete(*args, **kwargs)	Delete Study.
duplicate(*args, **kwargs)	Duplicate Parametric Study.
initialize(*args, **kwargs)	Start Parametric Study.
list(*args, **kwargs)	List Studies.
rename(*args, **kwargs)	Rename Study.
set_as_current(*args, **kwargs)	Set As Current Study.
use_base_data(*args, **kwargs)	Use Base Data to Initialize a Design Point.
use_data_of_previous_dp(*args, **kwargs)	Use Data of Previous Updated Design Point.

delete(*args, **kwargs)#

Delete Study.

duplicate(*args, **kwargs)#

Duplicate Parametric Study.

initialize(*args, **kwargs)#

Start Parametric Study.

list(*args, **kwargs)#

List Studies.

rename(*args, **kwargs)#

Rename Study.

set_as_current(*args, **kwargs)#

Set As Current Study.

use_base_data(*args, **kwargs)#

Use Base Data to Initialize a Design Point.

use_data_of_previous_dp(*args, **kwargs)#

Use Data of Previous Updated Design Point.

class update(service, version, mode, path)#

Bases: TUIMenu

Enter the update menu.

Methods:

auto_update_mesh_morphs(*args, **kwargs)	Enable Auto Mesh Morphing Update.
print_update_method(*args, **kwargs)	Print update method.
set_update_method(*args, **kwargs)	Set update method.
update_all(*args, **kwargs)	Update All Design Points.
update_current(*args, **kwargs)	Update Current Design Point.
update_selected_design_points(*args, **kwargs)	Update Selected Design Points.

Classes:

concurrent(service, version, mode, path)

Enter Concurrent Update menu.

auto_update_mesh_morphs(*args, **kwargs)#

Enable Auto Mesh Morphing Update.

class concurrent(service, version, mode, path)#

Bases: TUIMenu

Enter Concurrent Update menu.

Methods:

delete_endpoint(*args, **kwargs)	Delete endpoint.
register_new_endpoint(*args, **kwargs)	Register a new endpoint.

Classes:

licensing(service, version, mode, path)	Enter Concurrent Licensing menu.
print_to_console(service, version, mode, path)	Print to console concurrent options.
set(service, version, mode, path)	Set concurrent update options.

delete_endpoint(*args, **kwargs)#

Delete endpoint.

class licensing(service, version, mode, path)#

Bases: TUIMenu

Enter Concurrent Licensing menu.

Classes:

print_to_console(service, version, mode, path)	Print Concurrent Licensing Settings.
set(service, version, mode, path)	Enter Concurrent Licensing Menu.

class print_to_console(service, version, mode, path)#

Bases: TUIMenu

Print Concurrent Licensing Settings.

Methods:

license_type(*args, **kwargs)	License Type.
optislang_license_count(*args, **kwargs)	OptiSLang License Count.
optislang_license_type(*args, **kwargs)	OptiSLang License Type.

license_type(*args, **kwargs)#

License Type.

optislang_license_count(*args, **kwargs)#

OptiSLang License Count.

optislang_license_type(*args, **kwargs)#

OptiSLang License Type.

class set(service, version, mode, path)#

Bases: TUIMenu

Enter Concurrent Licensing Menu.

Methods:

license_type(*args, **kwargs)	License Type.
optislang_license_count(*args, **kwargs)	OptiSLang License Count.
optislang_license_type(*args, **kwargs)	OptiSLang License Type.

license_type(*args, **kwargs)#

License Type.

optislang_license_count(*args, **kwargs)#

OptiSLang License Count.

optislang_license_type(*args, **kwargs)#

OptiSLang License Type.

class print_to_console(service, version, mode, path)#

Bases: TUIMenu

Print to console concurrent options.

Methods:

current_endpoint(*args, **kwargs)	Get the current endpoint.
current_queue(*args, **kwargs)	Get the current queue.
number_of_concurrent_dps(*args, **kwargs)	Print Number of Concurrent Design Points.
number_of_cores_per_dp(*args, **kwargs)	Get Number of Cores per Design Point.
registered_endpoints(*args, **kwargs)	List registered endpoints.

current_endpoint(*args, **kwargs)#

Get the current endpoint.

current_queue(*args, **kwargs)#

Get the current queue.

number_of_concurrent_dps(*args, **kwargs)#

Print Number of Concurrent Design Points.

number_of_cores_per_dp(*args, **kwargs)#

Get Number of Cores per Design Point.

registered_endpoints(*args, **kwargs)#

List registered endpoints.

register_new_endpoint(*args, **kwargs)#

Register a new endpoint.

class set(service, version, mode, path)#

Bases: TUIMenu

Set concurrent update options.

Methods:

current_endpoint(*args, **kwargs)	Set the current endpoint.
current_queue(*args, **kwargs)	Set the current queue.
number_of_concurrent_dps(*args, **kwargs)	Set Number of Concurrent Design Points.
number_of_cores_per_dp(*args, **kwargs)	Set Number of Cores per Design Point.

current_endpoint(*args, **kwargs)#

Set the current endpoint.

current_queue(*args, **kwargs)#

Set the current queue.

number_of_concurrent_dps(*args, **kwargs)#

Set Number of Concurrent Design Points.

number_of_cores_per_dp(*args, **kwargs)#

Set Number of Cores per Design Point.

print_update_method(*args, **kwargs)#

Print update method.

set_update_method(*args, **kwargs)#

Set update method.

update_all(*args, **kwargs)#

Update All Design Points.

update_current(*args, **kwargs)#

Update Current Design Point.

update_selected_design_points(*args, **kwargs)#

Update Selected Design Points.

use_base_data(*args, **kwargs)#

Use Base Data.

class plot(service, version, mode, path)#

Bases: TUIMenu

Enter the XY plot menu.

Classes:

ansys_sound_analysis(service, version, mode, ...)	Enter the Ansys sound analysis menu.
cumulative_plot(service, version, mode, path)	Plot the development of force, force coefficient, moment, or moment coefficient across the specified wall zones.
flamelet_curves(service, version, mode, path)	Enters the flamelet curves menu.
vrx_sound_analysis(service, version, mode, path)	Ansys Sound analysis and specification.

Methods:

change_fft_ref_pressure(*args, **kwargs)	Changes reference acoustic pressure.
circum_avg_axial(*args, **kwargs)	Computes iso-axial band surfaces and plots data vs.
circum_avg_radial(*args, **kwargs)	Computes iso-radial band surfaces and plots data vs.
datasources(*args, **kwargs)	Enters the menu for creating and modifying plots containing multiple data sources.
display_profile_data(*args, **kwargs)	Plots profile data.
fft(*args, **kwargs)	Plots fast Fourier transform (FFT) of file data.
fft_set(*args, **kwargs)	Enter the menu to set histogram plot parameters.
file(*args, **kwargs)	Plots data from an external file.
file_list(*args, **kwargs)	Plots data from multiple external files.
file_set(*args, **kwargs)	Sets file plot parameters.
histogram(*args, **kwargs)	Plots a histogram of the specified solution variable using the defined range and number of intervals.
histogram_set(*args, **kwargs)	Sets histogram plot parameters.
label_alignment(*args, **kwargs)	Set the orientation of XY plot axis labels as either horizontal or axis-aligned.
plot(*args, **kwargs)	Plots solution on surfaces.
plot_direction(*args, **kwargs)	Sets plot direction for XY plot.
residuals(*args, **kwargs)	Contains commands that allow you to select the variables for which you want to display XY plots of residual histories in the active graphics window.
residuals_set(*args, **kwargs)	Sets residual plot parameters.
set_boundary_val_off(*args, **kwargs)	Disables the use of boundary face values when node values are disabled in solution XY plots.
solution(*args, **kwargs)	Plots solution on surfaces and/or zones.
solution_set(*args, **kwargs)	Sets solution plot parameters.

class ansys_sound_analysis(service, version, mode, path)#

Bases: TUIMenu

Enter the Ansys sound analysis menu.

Methods:

print_indicators(*args, **kwargs)	Read in a pressure signal or spectrum file, then optionally read in a frequency response function (FRF) or transfer function file, before printing the acoustics indicators.
write_files(*args, **kwargs)	Read in a pressure signal or spectrum file, then optionally read in a frequency response function (FRF) or transfer function file, before writing a WAV, output pressure, and/or acoustic indicators file.

print_indicators(*args, **kwargs)#

Read in a pressure signal or spectrum file, then optionally read in a frequency response function (FRF) or transfer function file, before printing the acoustics indicators.

write_files(*args, **kwargs)#

Read in a pressure signal or spectrum file, then optionally read in a frequency response function (FRF) or transfer function file, before writing a WAV, output pressure, and/or acoustic indicators file.

change_fft_ref_pressure(*args, **kwargs)#

Changes reference acoustic pressure.

circum_avg_axial(*args, **kwargs)#

Computes iso-axial band surfaces and plots data vs. axial coordinate on them.

circum_avg_radial(*args, **kwargs)#

Computes iso-radial band surfaces and plots data vs. radius on them.

class cumulative_plot(service, version, mode, path)#

Bases: TUIMenu

Plot the development of force, force coefficient, moment, or moment coefficient across the specified wall zones.

Methods:

add(*args, **kwargs)	Create a new cumulative plot.
axes(*args, **kwargs)	Set axes options of an object.
curves(*args, **kwargs)	Set curves options of an object.
delete(*args, **kwargs)	Delete an existing cumulative plot object.
edit(*args, **kwargs)	Edit an existing cumulative plot object.
list(*args, **kwargs)	Print the names of the existing cumulative plot objects to the console.
list_properties(*args, **kwargs)	Print the properties of the specified cumulative plot object to the console.
plot(*args, **kwargs)	Plot a cumulative plot in the graphics window.
print(*args, **kwargs)	Print the value of a cumulative plot to the console.
write(*args, **kwargs)	Write a cumulative plot to a file.

add(*args, **kwargs)#

Create a new cumulative plot.

axes(*args, **kwargs)#

Set axes options of an object.

curves(*args, **kwargs)#

Set curves options of an object.

delete(*args, **kwargs)#

Delete an existing cumulative plot object.

edit(*args, **kwargs)#

Edit an existing cumulative plot object.

list(*args, **kwargs)#

Print the names of the existing cumulative plot objects to the console.

list_properties(*args, **kwargs)#

Print the properties of the specified cumulative plot object to the console.

plot(*args, **kwargs)#

Plot a cumulative plot in the graphics window.

print(*args, **kwargs)#

Print the value of a cumulative plot to the console.

write(*args, **kwargs)#

Write a cumulative plot to a file.

datasources(*args, **kwargs)#

Enters the menu for creating and modifying plots containing multiple data sources.

display_profile_data(*args, **kwargs)#

Plots profile data.

fft(*args, **kwargs)#

Plots fast Fourier transform (FFT) of file data. If you respond yes to Acoustic Analysis?, then additional Y axis functions are made available.

fft_set(*args, **kwargs)#

Enter the menu to set histogram plot parameters.

file(*args, **kwargs)#

Plots data from an external file.

file_list(*args, **kwargs)#

Plots data from multiple external files.

file_set(*args, **kwargs)#

Sets file plot parameters.

class flamelet_curves(service, version, mode, path)#

Bases: TUIMenu

Enters the flamelet curves menu.

Methods:

plot_curves(*args, **kwargs)	Plots of a curve property.
write_to_file(*args, **kwargs)	Writes curve to a file instead of plot.

plot_curves(*args, **kwargs)#

Plots of a curve property.

write_to_file(*args, **kwargs)#

Writes curve to a file instead of plot.

histogram(*args, **kwargs)#

Plots a histogram of the specified solution variable using the defined range and number of intervals.

histogram_set(*args, **kwargs)#

Sets histogram plot parameters. Sub-menu items are the same as file-set/ above.

label_alignment(*args, **kwargs)#

Set the orientation of XY plot axis labels as either horizontal or axis-aligned.

plot(*args, **kwargs)#

Plots solution on surfaces.

plot_direction(*args, **kwargs)#

Sets plot direction for XY plot.

residuals(*args, **kwargs)#

Contains commands that allow you to select the variables for which you want to display XY plots of residual histories in the active graphics window.

residuals_set(*args, **kwargs)#

Sets residual plot parameters. Sub-menu items are the same as file-set/ above.

set_boundary_val_off(*args, **kwargs)#

Disables the use of boundary face values when node values are disabled in solution XY plots. This option is disabled by default, that is, boundary face values are used when node values are disabled.

solution(*args, **kwargs)#

Plots solution on surfaces and/or zones. Zone and surface names can be indicated using a wildcard (*).

solution_set(*args, **kwargs)#

Sets solution plot parameters. Sub-menu items are the same as file-set/ above.

class vrx_sound_analysis(service, version, mode, path)#

Bases: TUIMenu

Ansys Sound analysis and specification.

Methods:

print_indicators(*args, **kwargs)	Print Ansys Sound indicators.
write_files(*args, **kwargs)	Write Ansys Sound out files.

print_indicators(*args, **kwargs)#

Print Ansys Sound indicators.

write_files(*args, **kwargs)#

Write Ansys Sound out files.

class preferences(service, version, mode, path)#

Bases: TUIMenu

Set preferences.

Classes:

appearance(service, version, mode, path)	.
general(service, version, mode, path)	.
gpuapp(service, version, mode, path)	.
graphics(service, version, mode, path)	.
mat_pro_app(service, version, mode, path)	.
meshing_workflow(service, version, mode, path)	.
navigation(service, version, mode, path)	.
parametric_study(service, version, mode, path)	.
simulation(service, version, mode, path)	.
turbo_workflow(service, version, mode, path)	.

class appearance(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

ansys_logo(service, version, mode, path)	.
charts(service, version, mode, path)	.
selections(service, version, mode, path)	.

Methods:

application_font_size(*args, **kwargs)	.
axis_triad(*args, **kwargs)	.
color_theme(*args, **kwargs)	.
completer(*args, **kwargs)	.
custom_title_bar(*args, **kwargs)	.
default_view(*args, **kwargs)	.
graphics_background_color1(*args, **kwargs)	.
graphics_background_color2(*args, **kwargs)	.
graphics_background_style(*args, **kwargs)	.
graphics_color_theme(*args, **kwargs)	.
graphics_default_manual_face_color(*args, ...)	.
graphics_default_manual_node_color(*args, ...)	.
graphics_edge_color(*args, **kwargs)	.
graphics_foreground_color(*args, **kwargs)	.
graphics_partition_boundary_color(*args, ...)	.
graphics_surface_color(*args, **kwargs)	.
graphics_title_window_framecolor(*args, **kwargs)	.
graphics_view(*args, **kwargs)	.
graphics_wall_face_color(*args, **kwargs)	.
group_by_tree_view(*args, **kwargs)	.
model_color_scheme(*args, **kwargs)	.
number_of_files_recently_used(*args, **kwargs)	.
number_of_pastel_colors(*args, **kwargs)	.
pastel_color_saturation(*args, **kwargs)	.
pastel_color_value(*args, **kwargs)	.
quick_property_view(*args, **kwargs)	.
ruler(*args, **kwargs)	.
show_enabled_models(*args, **kwargs)	.
show_interface_children_zone(*args, **kwargs)	.
show_model_edges(*args, **kwargs)	.
solution_mode_edge_color_in_meshing_mode(...)	.
surface_emissivity(*args, **kwargs)	.
surface_specularity(*args, **kwargs)	.
surface_specularity_for_contours(*args, **kwargs)	.
titles(*args, **kwargs)	.
titles_border_offset(*args, **kwargs)	.

class ansys_logo(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

color(*args, **kwargs)	.
visible(*args, **kwargs)	.

color(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

application_font_size(*args, **kwargs)#

.

axis_triad(*args, **kwargs)#

.

class charts(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

curve_colors(*args, **kwargs)	.
enable_open_glfor_modern_plots(*args, **kwargs)	.
legend_alignment(*args, **kwargs)	.
legend_visibility(*args, **kwargs)	.
modern_plots_enabled(*args, **kwargs)	.
modern_plots_points_threshold(*args, **kwargs)	.
plots_behavior(*args, **kwargs)	.
print_plot_data(*args, **kwargs)	.
print_residuals_data(*args, **kwargs)	.
threshold(*args, **kwargs)	.
tooltip_interpolation(*args, **kwargs)	.

Classes:

font(service, version, mode, path)	.
text_color(service, version, mode, path)	.

curve_colors(*args, **kwargs)#

.

enable_open_glfor_modern_plots(*args, **kwargs)#

.

class font(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

axes(*args, **kwargs)	.
axes_titles(*args, **kwargs)	.
legend(*args, **kwargs)	.
title(*args, **kwargs)	.

axes(*args, **kwargs)#

.

axes_titles(*args, **kwargs)#

.

legend(*args, **kwargs)#

.

title(*args, **kwargs)#

.

legend_alignment(*args, **kwargs)#

.

legend_visibility(*args, **kwargs)#

.

modern_plots_enabled(*args, **kwargs)#

.

modern_plots_points_threshold(*args, **kwargs)#

.

plots_behavior(*args, **kwargs)#

.

print_plot_data(*args, **kwargs)#

.

print_residuals_data(*args, **kwargs)#

.

class text_color(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

axes(*args, **kwargs)	.
axes_titles(*args, **kwargs)	.
legend(*args, **kwargs)	.
title(*args, **kwargs)	.

axes(*args, **kwargs)#

.

axes_titles(*args, **kwargs)#

.

legend(*args, **kwargs)#

.

title(*args, **kwargs)#

.

threshold(*args, **kwargs)#

.

tooltip_interpolation(*args, **kwargs)#

.

color_theme(*args, **kwargs)#

.

completer(*args, **kwargs)#

.

custom_title_bar(*args, **kwargs)#

.

default_view(*args, **kwargs)#

.

graphics_background_color1(*args, **kwargs)#

.

graphics_background_color2(*args, **kwargs)#

.

graphics_background_style(*args, **kwargs)#

.

graphics_color_theme(*args, **kwargs)#

.

graphics_default_manual_face_color(*args, **kwargs)#

.

graphics_default_manual_node_color(*args, **kwargs)#

.

graphics_edge_color(*args, **kwargs)#

.

graphics_foreground_color(*args, **kwargs)#

.

graphics_partition_boundary_color(*args, **kwargs)#

.

graphics_surface_color(*args, **kwargs)#

.

graphics_title_window_framecolor(*args, **kwargs)#

.

graphics_view(*args, **kwargs)#

.

graphics_wall_face_color(*args, **kwargs)#

.

group_by_tree_view(*args, **kwargs)#

.

model_color_scheme(*args, **kwargs)#

.

number_of_files_recently_used(*args, **kwargs)#

.

number_of_pastel_colors(*args, **kwargs)#

.

pastel_color_saturation(*args, **kwargs)#

.

pastel_color_value(*args, **kwargs)#

.

quick_property_view(*args, **kwargs)#

.

ruler(*args, **kwargs)#

.

class selections(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

general_displacement(*args, **kwargs)	.
highlight_edge_color(*args, **kwargs)	.
highlight_edge_weight(*args, **kwargs)	.
highlight_face_color(*args, **kwargs)	.
highlight_gloss(*args, **kwargs)	.
highlight_specular_component(*args, **kwargs)	.
highlight_transparency(*args, **kwargs)	.
mouse_hover_probe_values_enabled(*args, **kwargs)	.
mouse_over_highlight_enabled(*args, **kwargs)	.
probe_tooltip_hide_delay_timer(*args, **kwargs)	.
probe_tooltip_show_delay_timer(*args, **kwargs)	.

general_displacement(*args, **kwargs)#

.

highlight_edge_color(*args, **kwargs)#

.

highlight_edge_weight(*args, **kwargs)#

.

highlight_face_color(*args, **kwargs)#

.

highlight_gloss(*args, **kwargs)#

.

highlight_specular_component(*args, **kwargs)#

.

highlight_transparency(*args, **kwargs)#

.

mouse_hover_probe_values_enabled(*args, **kwargs)#

.

mouse_over_highlight_enabled(*args, **kwargs)#

.

probe_tooltip_hide_delay_timer(*args, **kwargs)#

.

probe_tooltip_show_delay_timer(*args, **kwargs)#

.

show_enabled_models(*args, **kwargs)#

.

show_interface_children_zone(*args, **kwargs)#

.

show_model_edges(*args, **kwargs)#

.

solution_mode_edge_color_in_meshing_mode(*args, **kwargs)#

.

surface_emissivity(*args, **kwargs)#

.

surface_specularity(*args, **kwargs)#

.

surface_specularity_for_contours(*args, **kwargs)#

.

titles(*args, **kwargs)#

.

titles_border_offset(*args, **kwargs)#

.

class general(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

advanced_partition(*args, **kwargs)	.
automatic_transcript(*args, **kwargs)	.
default_ioformat(*args, **kwargs)	.
dock_editor(*args, **kwargs)	.
flow_model(*args, **kwargs)	.
idle_timeout(*args, **kwargs)	.
import_physics_volume_definitions(*args, ...)	.
initial_physics_volume_definitions(*args, ...)	.
key_behavioral_changes_message(*args, **kwargs)	.
qaservice_message(*args, **kwargs)	.
skip_creation_of_groups_pointing_to_single_entity(...)	.
utlcreate_physics_on_mode_change(*args, **kwargs)	.
utlmode(*args, **kwargs)	.

advanced_partition(*args, **kwargs)#

.

automatic_transcript(*args, **kwargs)#

.

default_ioformat(*args, **kwargs)#

.

dock_editor(*args, **kwargs)#

.

flow_model(*args, **kwargs)#

.

idle_timeout(*args, **kwargs)#

.

import_physics_volume_definitions(*args, **kwargs)#

.

initial_physics_volume_definitions(*args, **kwargs)#

.

key_behavioral_changes_message(*args, **kwargs)#

.

qaservice_message(*args, **kwargs)#

.

skip_creation_of_groups_pointing_to_single_entity(*args, **kwargs)#

.

utlcreate_physics_on_mode_change(*args, **kwargs)#

.

utlmode(*args, **kwargs)#

.

class gpuapp(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

alpha_features(*args, **kwargs)

.

alpha_features(*args, **kwargs)#

.

class graphics(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

animation_option(*args, **kwargs)	.
backface_cull(*args, **kwargs)	.
double_buffering(*args, **kwargs)	.
enable_non_object_based_workflow(*args, **kwargs)	.
event_poll_interval(*args, **kwargs)	.
event_poll_timeout(*args, **kwargs)	.
force_key_frame_animation_markers_to_off(...)	.
graphics_window_line_width(*args, **kwargs)	.
graphics_window_point_symbol(*args, **kwargs)	.
hidden_surface_removal_method(*args, **kwargs)	.
higher_resolution_graphics_window_line_width(...)	.
lower_resolution_graphics_window_line_width(...)	.
marker_drawing_mode(*args, **kwargs)	.
max_graphics_text_size(*args, **kwargs)	.
min_graphics_text_size(*args, **kwargs)	.
plot_legend_margin(*args, **kwargs)	.
point_tool_size(*args, **kwargs)	.
remove_partition_lines(*args, **kwargs)	.
remove_partition_lines_tolerance(*args, **kwargs)	.
rotation_centerpoint_visible(*args, **kwargs)	.
scroll_wheel_event_end_timer(*args, **kwargs)	.
set_camera_normal_to_surface_increments(...)	.
show_hidden_lines(*args, **kwargs)	.
show_hidden_surfaces(*args, **kwargs)	.
surface_general_displacement(*args, **kwargs)	.
switch_to_open_glfor_remote_visualization(...)	.
test_use_external_function(*args, **kwargs)	.
text_window_line_width(*args, **kwargs)	.

Classes:

boundary_markers(service, version, mode, path)	.
colormap_settings(service, version, mode, path)	.
embedded_windows(service, version, mode, path)	.
export_video_settings(service, version, ...)	.
graphics_effects(service, version, mode, path)	.
hardcopy_settings(service, version, mode, path)	.
lighting(service, version, mode, path)	.
manage_hoops_memory(service, version, mode, path)	.
material_effects(service, version, mode, path)	.
meshing_mode(service, version, mode, path)	.
performance(service, version, mode, path)	.
transparency(service, version, mode, path)	.
vector_settings(service, version, mode, path)	.

animation_option(*args, **kwargs)#

.

backface_cull(*args, **kwargs)#

.

class boundary_markers(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

color_option(*args, **kwargs)	.
enabled(*args, **kwargs)	.
exclude_from_bounding(*args, **kwargs)	.
inlet_color(*args, **kwargs)	.
marker_fraction(*args, **kwargs)	.
marker_size_limiting_scale_multiplier(*args, ...)	.
markers_limit(*args, **kwargs)	.
outlet_color(*args, **kwargs)	.
scale_marker(*args, **kwargs)	.
show_inlet_markers(*args, **kwargs)	.
show_outlet_markers(*args, **kwargs)	.

color_option(*args, **kwargs)#

.

enabled(*args, **kwargs)#

.

exclude_from_bounding(*args, **kwargs)#

.

inlet_color(*args, **kwargs)#

.

marker_fraction(*args, **kwargs)#

.

marker_size_limiting_scale_multiplier(*args, **kwargs)#

.

markers_limit(*args, **kwargs)#

.

outlet_color(*args, **kwargs)#

.

scale_marker(*args, **kwargs)#

.

show_inlet_markers(*args, **kwargs)#

.

show_outlet_markers(*args, **kwargs)#

.

class colormap_settings(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

alignment(*args, **kwargs)	.
aspect_ratio_when_horizontal(*args, **kwargs)	.
aspect_ratio_when_vertical(*args, **kwargs)	.
auto_refit_on_resize(*args, **kwargs)	.
automatic_resize(*args, **kwargs)	.
border_style(*args, **kwargs)	.
colormap(*args, **kwargs)	.
isolines_position_offset(*args, **kwargs)	.
labels(*args, **kwargs)	.
levels(*args, **kwargs)	.
log_scale(*args, **kwargs)	.
major_length_to_screen_ratio_when_horizontal(...)	.
major_length_to_screen_ratio_when_vertical(...)	.
margin_from_edge_to_screen_ratio(*args, **kwargs)	.
max_size_scale_factor(*args, **kwargs)	.
min_size_scale_factor(*args, **kwargs)	.
number_format_precision(*args, **kwargs)	.
number_format_type(*args, **kwargs)	.
preserve_aspect_ratio_for_hardcopy(*args, ...)	.
show_colormap(*args, **kwargs)	.
skip_value(*args, **kwargs)	.
text_behavior(*args, **kwargs)	.
text_font_automatic_horizontal_size(*args, ...)	.
text_font_automatic_size(*args, **kwargs)	.
text_font_automatic_units(*args, **kwargs)	.
text_font_automatic_vertical_size(*args, ...)	.
text_font_fixed_horizontal_size(*args, **kwargs)	.
text_font_fixed_size(*args, **kwargs)	.
text_font_fixed_units(*args, **kwargs)	.
text_font_fixed_vertical_size(*args, **kwargs)	.
text_font_name(*args, **kwargs)	.
text_truncation_limit_for_horizontal_colormaps(...)	.
text_truncation_limit_for_vertical_colormaps(...)	.
type(*args, **kwargs)	.
use_no_sub_windows(*args, **kwargs)	.

alignment(*args, **kwargs)#

.

aspect_ratio_when_horizontal(*args, **kwargs)#

.

aspect_ratio_when_vertical(*args, **kwargs)#

.

auto_refit_on_resize(*args, **kwargs)#

.

automatic_resize(*args, **kwargs)#

.

border_style(*args, **kwargs)#

.

colormap(*args, **kwargs)#

.

isolines_position_offset(*args, **kwargs)#

.

labels(*args, **kwargs)#

.

levels(*args, **kwargs)#

.

log_scale(*args, **kwargs)#

.

major_length_to_screen_ratio_when_horizontal(*args, **kwargs)#

.

major_length_to_screen_ratio_when_vertical(*args, **kwargs)#

.

margin_from_edge_to_screen_ratio(*args, **kwargs)#

.

max_size_scale_factor(*args, **kwargs)#

.

min_size_scale_factor(*args, **kwargs)#

.

number_format_precision(*args, **kwargs)#

.

number_format_type(*args, **kwargs)#

.

preserve_aspect_ratio_for_hardcopy(*args, **kwargs)#

.

show_colormap(*args, **kwargs)#

.

skip_value(*args, **kwargs)#

.

text_behavior(*args, **kwargs)#

.

text_font_automatic_horizontal_size(*args, **kwargs)#

.

text_font_automatic_size(*args, **kwargs)#

.

text_font_automatic_units(*args, **kwargs)#

.

text_font_automatic_vertical_size(*args, **kwargs)#

.

text_font_fixed_horizontal_size(*args, **kwargs)#

.

text_font_fixed_size(*args, **kwargs)#

.

text_font_fixed_units(*args, **kwargs)#

.

text_font_fixed_vertical_size(*args, **kwargs)#

.

text_font_name(*args, **kwargs)#

.

text_truncation_limit_for_horizontal_colormaps(*args, **kwargs)#

.

text_truncation_limit_for_vertical_colormaps(*args, **kwargs)#

.

type(*args, **kwargs)#

.

use_no_sub_windows(*args, **kwargs)#

.

double_buffering(*args, **kwargs)#

.

class embedded_windows(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

default_embedded_mesh_windows_view(*args, ...)	.
default_embedded_windows_view(*args, **kwargs)	.
save_embedded_window_layout(*args, **kwargs)	.
show_border_for_embedded_window(*args, **kwargs)	.

default_embedded_mesh_windows_view(*args, **kwargs)#

.

default_embedded_windows_view(*args, **kwargs)#

.

save_embedded_window_layout(*args, **kwargs)#

.

show_border_for_embedded_window(*args, **kwargs)#

.

enable_non_object_based_workflow(*args, **kwargs)#

.

event_poll_interval(*args, **kwargs)#

.

event_poll_timeout(*args, **kwargs)#

.

class export_video_settings(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

advanced_video_quality_options(service, ...)

.

Methods:

video_format(*args, **kwargs)	.
video_fps(*args, **kwargs)	.
video_quality(*args, **kwargs)	.
video_resoution_x(*args, **kwargs)	.
video_resoution_y(*args, **kwargs)	.
video_scale(*args, **kwargs)	.
video_smooth_scaling(*args, **kwargs)	.
video_use_frame_resolution(*args, **kwargs)	.

class advanced_video_quality_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

bit_rate_quality(*args, **kwargs)	.
bitrate(*args, **kwargs)	.
compression_method(*args, **kwargs)	.
enable_h264(*args, **kwargs)	.

bit_rate_quality(*args, **kwargs)#

.

bitrate(*args, **kwargs)#

.

compression_method(*args, **kwargs)#

.

enable_h264(*args, **kwargs)#

.

video_format(*args, **kwargs)#

.

video_fps(*args, **kwargs)#

.

video_quality(*args, **kwargs)#

.

video_resoution_x(*args, **kwargs)#

.

video_resoution_y(*args, **kwargs)#

.

video_scale(*args, **kwargs)#

.

video_smooth_scaling(*args, **kwargs)#

.

video_use_frame_resolution(*args, **kwargs)#

.

force_key_frame_animation_markers_to_off(*args, **kwargs)#

.

class graphics_effects(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

ambient_occlusion_enabled(*args, **kwargs)	.
ambient_occlusion_quality(*args, **kwargs)	.
ambient_occlusion_strength(*args, **kwargs)	.
anti_aliasing(*args, **kwargs)	.
bloom_blur(*args, **kwargs)	.
bloom_enabled(*args, **kwargs)	.
bloom_strength(*args, **kwargs)	.
grid_color(*args, **kwargs)	.
grid_plane_count(*args, **kwargs)	.
grid_plane_enabled(*args, **kwargs)	.
grid_plane_offset(*args, **kwargs)	.
grid_plane_size_factor(*args, **kwargs)	.
plane_direction(*args, **kwargs)	.
reflections_enabled(*args, **kwargs)	.
shadow_map_enabled(*args, **kwargs)	.
show_edge_reflections(*args, **kwargs)	.
show_marker_reflections(*args, **kwargs)	.
simple_shadows_enabled(*args, **kwargs)	.
update_after_mouse_release(*args, **kwargs)	.

ambient_occlusion_enabled(*args, **kwargs)#

.

ambient_occlusion_quality(*args, **kwargs)#

.

ambient_occlusion_strength(*args, **kwargs)#

.

anti_aliasing(*args, **kwargs)#

.

bloom_blur(*args, **kwargs)#

.

bloom_enabled(*args, **kwargs)#

.

bloom_strength(*args, **kwargs)#

.

grid_color(*args, **kwargs)#

.

grid_plane_count(*args, **kwargs)#

.

grid_plane_enabled(*args, **kwargs)#

.

grid_plane_offset(*args, **kwargs)#

.

grid_plane_size_factor(*args, **kwargs)#

.

plane_direction(*args, **kwargs)#

.

reflections_enabled(*args, **kwargs)#

.

shadow_map_enabled(*args, **kwargs)#

.

show_edge_reflections(*args, **kwargs)#

.

show_marker_reflections(*args, **kwargs)#

.

simple_shadows_enabled(*args, **kwargs)#

.

update_after_mouse_release(*args, **kwargs)#

.

graphics_window_line_width(*args, **kwargs)#

.

graphics_window_point_symbol(*args, **kwargs)#

.

class hardcopy_settings(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

export_edges_for_avz(*args, **kwargs)	.
hardcopy_driver(*args, **kwargs)	.
hardcopy_line_width(*args, **kwargs)	.
hardware_image_accel(*args, **kwargs)	.
post_script_permission_override(*args, **kwargs)	.
save_embedded_hardcopies_separately(*args, ...)	.
save_embedded_windows_in_hardcopy(*args, ...)	.
transparent_embedded_windows(*args, **kwargs)	.

export_edges_for_avz(*args, **kwargs)#

.

hardcopy_driver(*args, **kwargs)#

.

hardcopy_line_width(*args, **kwargs)#

.

hardware_image_accel(*args, **kwargs)#

.

post_script_permission_override(*args, **kwargs)#

.

save_embedded_hardcopies_separately(*args, **kwargs)#

.

save_embedded_windows_in_hardcopy(*args, **kwargs)#

.

transparent_embedded_windows(*args, **kwargs)#

.

hidden_surface_removal_method(*args, **kwargs)#

.

higher_resolution_graphics_window_line_width(*args, **kwargs)#

.

class lighting(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

ambient_light_intensity(*args, **kwargs)	.
headlight(*args, **kwargs)	.
headlight_intensity(*args, **kwargs)	.
lighting_method(*args, **kwargs)	.

ambient_light_intensity(*args, **kwargs)#

.

headlight(*args, **kwargs)#

.

headlight_intensity(*args, **kwargs)#

.

lighting_method(*args, **kwargs)#

.

lower_resolution_graphics_window_line_width(*args, **kwargs)#

.

class manage_hoops_memory(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

enabled(*args, **kwargs)	.
hsfimport_limit(*args, **kwargs)	.

enabled(*args, **kwargs)#

.

hsfimport_limit(*args, **kwargs)#

.

marker_drawing_mode(*args, **kwargs)#

.

class material_effects(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

decimation_filter(*args, **kwargs)	.
parameterization_source(*args, **kwargs)	.
tiling_style(*args, **kwargs)	.

decimation_filter(*args, **kwargs)#

.

parameterization_source(*args, **kwargs)#

.

tiling_style(*args, **kwargs)#

.

max_graphics_text_size(*args, **kwargs)#

.

class meshing_mode(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

graphics_window_display_timeout(*args, **kwargs)	.
graphics_window_display_timeout_value(*args, ...)	.

graphics_window_display_timeout(*args, **kwargs)#

.

graphics_window_display_timeout_value(*args, **kwargs)#

.

min_graphics_text_size(*args, **kwargs)#

.

class performance(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

fast_display_mode(service, version, mode, path)	.
minimum_frame_rate(service, version, mode, path)	.

Methods:

optimize_for(*args, **kwargs)	.
ratio_of_target_frame_rate_to_classify_heavy_geometry(...)	.
ratio_of_target_frame_rate_to_declassify_heavy_geometry(...)	.

class fast_display_mode(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

culling(*args, **kwargs)	.
faces_shown(*args, **kwargs)	.
markers_decimation(*args, **kwargs)	.
nodes_shown(*args, **kwargs)	.
perimeter_edges_shown(*args, **kwargs)	.
silhouette_shown(*args, **kwargs)	.
status(*args, **kwargs)	.
transparency(*args, **kwargs)	.

culling(*args, **kwargs)#

.

faces_shown(*args, **kwargs)#

.

markers_decimation(*args, **kwargs)#

.

nodes_shown(*args, **kwargs)#

.

perimeter_edges_shown(*args, **kwargs)#

.

silhouette_shown(*args, **kwargs)#

.

status(*args, **kwargs)#

.

transparency(*args, **kwargs)#

.

class minimum_frame_rate(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

dynamic_adjustment(*args, **kwargs)	.
enabled(*args, **kwargs)	.
fixed_culling_value(*args, **kwargs)	.
maximum_culling_threshold(*args, **kwargs)	.
minimum_culling_threshold(*args, **kwargs)	.
target_fps(*args, **kwargs)	.

dynamic_adjustment(*args, **kwargs)#

.

enabled(*args, **kwargs)#

.

fixed_culling_value(*args, **kwargs)#

.

maximum_culling_threshold(*args, **kwargs)#

.

minimum_culling_threshold(*args, **kwargs)#

.

target_fps(*args, **kwargs)#

.

optimize_for(*args, **kwargs)#

.

ratio_of_target_frame_rate_to_classify_heavy_geometry(*args, **kwargs)#

.

ratio_of_target_frame_rate_to_declassify_heavy_geometry(*args, **kwargs)#

.

plot_legend_margin(*args, **kwargs)#

.

point_tool_size(*args, **kwargs)#

.

remove_partition_lines(*args, **kwargs)#

.

remove_partition_lines_tolerance(*args, **kwargs)#

.

rotation_centerpoint_visible(*args, **kwargs)#

.

scroll_wheel_event_end_timer(*args, **kwargs)#

.

set_camera_normal_to_surface_increments(*args, **kwargs)#

.

show_hidden_lines(*args, **kwargs)#

.

show_hidden_surfaces(*args, **kwargs)#

.

surface_general_displacement(*args, **kwargs)#

.

switch_to_open_glfor_remote_visualization(*args, **kwargs)#

.

test_use_external_function(*args, **kwargs)#

.

text_window_line_width(*args, **kwargs)#

.

class transparency(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

algorithm_for_modern_drivers(*args, **kwargs)	.
depth_peeling_layers(*args, **kwargs)	.
depth_peeling_preference(*args, **kwargs)	.
quick_moves(*args, **kwargs)	.
zsort_options(*args, **kwargs)	.

algorithm_for_modern_drivers(*args, **kwargs)#

.

depth_peeling_layers(*args, **kwargs)#

.

depth_peeling_preference(*args, **kwargs)#

.

quick_moves(*args, **kwargs)#

.

zsort_options(*args, **kwargs)#

.

class vector_settings(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

arrow3_dradius1_factor(*args, **kwargs)	.
arrow3_dradius2_factor(*args, **kwargs)	.
arrowhead3_dradius1_factor(*args, **kwargs)	.
line_arrow3_dperpendicular_radius(*args, ...)	.

arrow3_dradius1_factor(*args, **kwargs)#

.

arrow3_dradius2_factor(*args, **kwargs)#

.

arrowhead3_dradius1_factor(*args, **kwargs)#

.

line_arrow3_dperpendicular_radius(*args, **kwargs)#

.

class mat_pro_app(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

beta_features(*args, **kwargs)	.
focus(*args, **kwargs)	.
mesh_naming(*args, **kwargs)	.
warning(*args, **kwargs)	.

Classes:

check_expression(service, version, mode, path)

.

beta_features(*args, **kwargs)#

.

class check_expression(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

cdot(*args, **kwargs)	.
coordinates(*args, **kwargs)	.
dvv(*args, **kwargs)	.
edot(*args, **kwargs)	.
gdot(*args, **kwargs)	.
giesekus(*args, **kwargs)	.
pressure(*args, **kwargs)	.
species(*args, **kwargs)	.
temperature(*args, **kwargs)	.
time(*args, **kwargs)	.
velocities(*args, **kwargs)	.
vorticity(*args, **kwargs)	.

cdot(*args, **kwargs)#

.

coordinates(*args, **kwargs)#

.

dvv(*args, **kwargs)#

.

edot(*args, **kwargs)#

.

gdot(*args, **kwargs)#

.

giesekus(*args, **kwargs)#

.

pressure(*args, **kwargs)#

.

species(*args, **kwargs)#

.

temperature(*args, **kwargs)#

.

time(*args, **kwargs)#

.

velocities(*args, **kwargs)#

.

vorticity(*args, **kwargs)#

.

focus(*args, **kwargs)#

.

mesh_naming(*args, **kwargs)#

.

warning(*args, **kwargs)#

.

class meshing_workflow(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

checkpointing_option(*args, **kwargs)	.
save_checkpoint_files(*args, **kwargs)	.
temp_folder(*args, **kwargs)	.
templates_folder(*args, **kwargs)	.
verbosity(*args, **kwargs)	.

Classes:

draw_settings(service, version, mode, path)

.

checkpointing_option(*args, **kwargs)#

.

class draw_settings(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

auto_draw(*args, **kwargs)	.
face_zone_limit(*args, **kwargs)	.
facet_limit(*args, **kwargs)	.

auto_draw(*args, **kwargs)#

.

face_zone_limit(*args, **kwargs)#

.

facet_limit(*args, **kwargs)#

.

save_checkpoint_files(*args, **kwargs)#

.

temp_folder(*args, **kwargs)#

.

templates_folder(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

.

class navigation(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

mouse_mapping(service, version, mode, path)

.

class mouse_mapping(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

additional(service, version, mode, path)	.
basic(service, version, mode, path)	.

Methods:

mousemaptheme(*args, **kwargs)

.

class additional(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

ctrllmbclick(*args, **kwargs)	.
ctrllmbdrag(*args, **kwargs)	.
ctrlmmbclick(*args, **kwargs)	.
ctrlmmbdrag(*args, **kwargs)	.
ctrlrmbclick(*args, **kwargs)	.
ctrlrmbdrag(*args, **kwargs)	.
mouseprobe(*args, **kwargs)	.
mousewheel(*args, **kwargs)	.
mousewheelsensitivity(*args, **kwargs)	.
reversewheeldirection(*args, **kwargs)	.
shiftlmbclick(*args, **kwargs)	.
shiftlmbdrag(*args, **kwargs)	.
shiftmmbclick(*args, **kwargs)	.
shiftmmbdrag(*args, **kwargs)	.
shiftrmbclick(*args, **kwargs)	.
shiftrmbdrag(*args, **kwargs)	.

ctrllmbclick(*args, **kwargs)#

.

ctrllmbdrag(*args, **kwargs)#

.

ctrlmmbclick(*args, **kwargs)#

.

ctrlmmbdrag(*args, **kwargs)#

.

ctrlrmbclick(*args, **kwargs)#

.

ctrlrmbdrag(*args, **kwargs)#

.

mouseprobe(*args, **kwargs)#

.

mousewheel(*args, **kwargs)#

.

mousewheelsensitivity(*args, **kwargs)#

.

reversewheeldirection(*args, **kwargs)#

.

shiftlmbclick(*args, **kwargs)#

.

shiftlmbdrag(*args, **kwargs)#

.

shiftmmbclick(*args, **kwargs)#

.

shiftmmbdrag(*args, **kwargs)#

.

shiftrmbclick(*args, **kwargs)#

.

shiftrmbdrag(*args, **kwargs)#

.

class basic(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

lmb(*args, **kwargs)	.
lmbclick(*args, **kwargs)	.
mmb(*args, **kwargs)	.
mmbclick(*args, **kwargs)	.
rmb(*args, **kwargs)	.
rmbclick(*args, **kwargs)	.

lmb(*args, **kwargs)#

.

lmbclick(*args, **kwargs)#

.

mmb(*args, **kwargs)#

.

mmbclick(*args, **kwargs)#

.

rmb(*args, **kwargs)#

.

rmbclick(*args, **kwargs)#

.

mousemaptheme(*args, **kwargs)#

.

class parametric_study(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

layout_options(service, version, mode, path)	.
update_options(service, version, mode, path)	.

class layout_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

current_case_parameters(*args, **kwargs)	.
parametric_study_tree(*args, **kwargs)	.

current_case_parameters(*args, **kwargs)#

.

parametric_study_tree(*args, **kwargs)#

.

class update_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

auto_refresh_time(*args, **kwargs)	.
capture_sim_report_data(*args, **kwargs)	.
enable_auto_refresh(*args, **kwargs)	.
save_project_after_dpupdate(*args, **kwargs)	.
write_data(*args, **kwargs)	.

auto_refresh_time(*args, **kwargs)#

.

capture_sim_report_data(*args, **kwargs)#

.

enable_auto_refresh(*args, **kwargs)#

.

save_project_after_dpupdate(*args, **kwargs)#

.

write_data(*args, **kwargs)#

.

class simulation(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

flow_model(*args, **kwargs)	.
local_residual_scaling(*args, **kwargs)	.
pdf_combustion_robust_numerics(*args, **kwargs)	.

Classes:

report_definitions(service, version, mode, path)

.

flow_model(*args, **kwargs)#

.

local_residual_scaling(*args, **kwargs)#

.

pdf_combustion_robust_numerics(*args, **kwargs)#

.

class report_definitions(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

automatic_plot_file(*args, **kwargs)	.
report_plot_history_data_size(*args, **kwargs)	.

automatic_plot_file(*args, **kwargs)#

.

report_plot_history_data_size(*args, **kwargs)#

.

class turbo_workflow(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

checkpointing_option(*args, **kwargs)	.
save_checkpoint_files(*args, **kwargs)	.

Classes:

face_zone_settings(service, version, mode, path)	.
graphics_settings(service, version, mode, path)	.

checkpointing_option(*args, **kwargs)#

.

class face_zone_settings(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

blade_region(*args, **kwargs)	.
fzsearch_order(*args, **kwargs)	.
hub_region(*args, **kwargs)	.
inlet_region(*args, **kwargs)	.
interior_region(*args, **kwargs)	.
outlet_region(*args, **kwargs)	.
periodic1_region(*args, **kwargs)	.
periodic2_region(*args, **kwargs)	.
shroud_region(*args, **kwargs)	.
symmetry_region(*args, **kwargs)	.
tip1_region(*args, **kwargs)	.
tip2_region(*args, **kwargs)	.

blade_region(*args, **kwargs)#

.

fzsearch_order(*args, **kwargs)#

.

hub_region(*args, **kwargs)#

.

inlet_region(*args, **kwargs)#

.

interior_region(*args, **kwargs)#

.

outlet_region(*args, **kwargs)#

.

periodic1_region(*args, **kwargs)#

.

periodic2_region(*args, **kwargs)#

.

shroud_region(*args, **kwargs)#

.

symmetry_region(*args, **kwargs)#

.

tip1_region(*args, **kwargs)#

.

tip2_region(*args, **kwargs)#

.

class graphics_settings(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

auto_draw(*args, **kwargs)

.

auto_draw(*args, **kwargs)#

.

save_checkpoint_files(*args, **kwargs)#

.

print_license_usage(*args, **kwargs)#

Print license usage information.

class report(service, version, mode, path)#

Bases: TUIMenu

Enter the report menu.

Methods:

aero_optical_distortions(*args, **kwargs)	.
dpm_extended_summary(*args, **kwargs)	Create an extended discrete phase summary report of the discrete phase injection(s).
dpm_sample(*args, **kwargs)	Samples trajectories at boundaries and lines/planes.
dpm_sample_output_udf(*args, **kwargs)	Allows you to hook a previously loaded DEFINE_DPM_OUTPUT UDF for file format specification for sampling of trajectories and VOF-to-DPM lump conversion transcripts.
dpm_sample_sort_file(*args, **kwargs)	Enables/disables writing of sorted DPM sample files.
dpm_summary(*args, **kwargs)	Prints discrete phase summary report.
dpm_zone_summaries_per_injection(*args, **kwargs)	Enables/disables calculation of the escaped mass per injection.
element_mass_flow(*args, **kwargs)	Prints list of element flow rate at inlets and outlets.
mphase_summary(*args, **kwargs)	Prints summary report for a multiphase case setup.
particle_summary(*args, **kwargs)	Prints summary report for all current particles.
path_line_summary(*args, **kwargs)	Prints pathline summary report.
print_histogram(*args, **kwargs)	Prints a histogram of a scalar quantity.
projected_surface_area(*args, **kwargs)	Computes the area of the projection of selected surfaces along the , , or axis.
species_mass_flow(*args, **kwargs)	Prints list of species mass flow rate at inlets and outlets.
summary(*args, **kwargs)	Prints the current settings for physical models, boundary conditions, material properties, and solution parameters.
surface_integrals(*args, **kwargs)	Enters the surface integral menu.
uds_flow(*args, **kwargs)	Prints list of user-defined scalar flow rate at boundaries.
volume_integrals(*args, **kwargs)	Enters the volume integral menu.

Classes:

dpm_histogram(service, version, mode, path)	Enters the DPM histogram menu.
efficiency(service, version, mode, path)	Enter the menu for efficiency computations.
fluxes(service, version, mode, path)	Enters the fluxes menu.
forces(service, version, mode, path)	Enters the forces menu.
heat_exchanger(service, version, mode, path)	Enters the heat exchanger menu.
icing(service, version, mode, path)	Icing reports menu.
modified_setting(service, version, mode, path)	Enter the modified settings menu.
population_balance(service, version, mode, path)	Population Balance menu.
reference_values(service, version, mode, path)	Enters the reference value menu.
simulation_reports(service, version, mode, path)	Enter the simulation reports menu.
system(service, version, mode, path)	Enters the system menu.
virtual_blade_model(service, version, mode, path)	VBM reports menu.

aero_optical_distortions(*args, **kwargs)#

.

dpm_extended_summary(*args, **kwargs)#

Create an extended discrete phase summary report of the discrete phase injection(s). You can choose whether you want to save the extended report to a file or print it in the console window. For unsteady tracking, you will be asked whether you want to include in-domain particle/tracks in the report. You will be also prompted whether you want to select a single injection for the summary report. By default, all injections are included. The output depends on whether you have enabled the report/dpm-zone-summaries-per-injection? text command, in which case additional information is printed for escaped particles, such as per-injection data. Note that, for unsteady particle tracking, it is necessary to enable the report/dpm-zone-summaries-per-injection? text command before any particle parcels are injected into the domain.

class dpm_histogram(service, version, mode, path)#

Bases: TUIMenu

Enters the DPM histogram menu.

Methods:

compute_sample(*args, **kwargs)	Computes the minimum/maximum of a sample variable.
delete_sample(*args, **kwargs)	Deletes a sample from the loaded sample list.
list_samples(*args, **kwargs)	Shows all samples in a loaded sample list.
pick_sample_to_reduce(*args, **kwargs)	Select a sample to be reduced.
plot_sample(*args, **kwargs)	Plots a histogram of a loaded sample.
prep_dpm_sample_cont_plot_exprs(*args, **kwargs)	Prepare named expressions from data in a DPM sample file (collected at a cut plane surface) for contour plotting.
read_sample(*args, **kwargs)	Reads a sample file and adds it to the sample list.
reduce_picked_sample(*args, **kwargs)	Reduce a sample as specified by the data reduction parameters.
write_sample(*args, **kwargs)	Write a histogram of a loaded sample into a file.

Classes:

set(service, version, mode, path)	Enters the settings menu for the histogram.
setup_reduction(service, version, mode, path)	Set up the sample data reduction by specifying all relevant options and setting parameters as desired.

compute_sample(*args, **kwargs)#

Computes the minimum/maximum of a sample variable.

delete_sample(*args, **kwargs)#

Deletes a sample from the loaded sample list.

list_samples(*args, **kwargs)#

Shows all samples in a loaded sample list.

pick_sample_to_reduce(*args, **kwargs)#

Select a sample to be reduced.

plot_sample(*args, **kwargs)#

Plots a histogram of a loaded sample.

prep_dpm_sample_cont_plot_exprs(*args, **kwargs)#

Prepare named expressions from data in a DPM sample file (collected at a cut plane surface) for contour plotting.

read_sample(*args, **kwargs)#

Reads a sample file and adds it to the sample list.

reduce_picked_sample(*args, **kwargs)#

Reduce a sample as specified by the data reduction parameters. This command is available only after you selected the sample using the pick-sample-to-reduce text command.

class set(service, version, mode, path)#

Bases: TUIMenu

Enters the settings menu for the histogram.

Methods:

auto_range(*args, **kwargs)	Automatically computes the range of the sampling variable for histogram plots.
correlation(*args, **kwargs)	Computes the correlation of the sampling variable with another variable.
cumulation_curve(*args, **kwargs)	Computes a cumulative curve for the sampling variable or correlation variable when correlation? is specified.
diameter_statistics(*args, **kwargs)	Computes the Rosin Rammler parameters, Sauter, and other mean diameters.
histogram_mode(*args, **kwargs)	Uses bars for the histogram plot or xy-style.
logarithmic(*args, **kwargs)	Enables/disables the use of logarithmic scaling on the abscissa of the histogram.
maximum(*args, **kwargs)	Specifies the maximum value of the x-axis variable for histogram plots.
minimum(*args, **kwargs)	Specifies the minimum value of the x-axis variable for histogram plots.
number_of_bins(*args, **kwargs)	Specifies the number of bins.
percentage(*args, **kwargs)	Uses percentages of bins to be computed.
variable_power_3(*args, **kwargs)	Use the cubic of the cumulation variable during computation of the cumulative curve.
weighting(*args, **kwargs)	Uses weighting with additional variables when sorting data into samples.

auto_range(*args, **kwargs)#

Automatically computes the range of the sampling variable for histogram plots.

correlation(*args, **kwargs)#

Computes the correlation of the sampling variable with another variable.

cumulation_curve(*args, **kwargs)#

Computes a cumulative curve for the sampling variable or correlation variable when correlation? is specified.

diameter_statistics(*args, **kwargs)#

Computes the Rosin Rammler parameters, Sauter, and other mean diameters.

histogram_mode(*args, **kwargs)#

Uses bars for the histogram plot or xy-style.

logarithmic(*args, **kwargs)#

Enables/disables the use of logarithmic scaling on the abscissa of the histogram.

maximum(*args, **kwargs)#

Specifies the maximum value of the x-axis variable for histogram plots.

minimum(*args, **kwargs)#

Specifies the minimum value of the x-axis variable for histogram plots.

number_of_bins(*args, **kwargs)#

Specifies the number of bins.

percentage(*args, **kwargs)#

Uses percentages of bins to be computed.

variable_power_3(*args, **kwargs)#

Use the cubic of the cumulation variable during computation of the cumulative curve. When the particle mass was not sampled, the diameter can be used instead.

weighting(*args, **kwargs)#

Uses weighting with additional variables when sorting data into samples.

class setup_reduction(service, version, mode, path)#

Bases: TUIMenu

Set up the sample data reduction by specifying all relevant options and setting parameters as desired.

Methods:

all_variables_number_of_bins(*args, **kwargs)	Set the number of bins to be used for ALL variables in the data reduction.
list_settings(*args, **kwargs)	List all user inputs for the sample picked for data reduction.
logarithmic(*args, **kwargs)	Switch on or off logarithmic scaling to be used for a specific variable in the data reduction.
make_steady_from_unsteady_file(*args, **kwargs)	Specify whether the unsteady sample is to be reduced into a steady-state injection file.
maximum(*args, **kwargs)	Set the maximum value of the range to be considered for a specific variable in the data reduction.
minimum(*args, **kwargs)	Set the minimum value of the range to be considered for a specific variable in the data reduction.
number_of_bins(*args, **kwargs)	Set the number of bins to be used for a specific variable in the data reduction.
reset_min_and_max(*args, **kwargs)	Reset the min and max values of the range to be considered for a specific variable in the data reduction.
use_weighting(*args, **kwargs)	Specify whether to use any weighting in the averaging that is done in each bin in the data reduction.
weighting_variable(*args, **kwargs)	Choose the weighting variable for the averaging in each bin in the data reduction.

all_variables_number_of_bins(*args, **kwargs)#

Set the number of bins to be used for ALL variables in the data reduction.

list_settings(*args, **kwargs)#

List all user inputs for the sample picked for data reduction.

logarithmic(*args, **kwargs)#

Switch on or off logarithmic scaling to be used for a specific variable in the data reduction.

make_steady_from_unsteady_file(*args, **kwargs)#

Specify whether the unsteady sample is to be reduced into a steady-state injection file.

maximum(*args, **kwargs)#

Set the maximum value of the range to be considered for a specific variable in the data reduction.

minimum(*args, **kwargs)#

Set the minimum value of the range to be considered for a specific variable in the data reduction.

number_of_bins(*args, **kwargs)#

Set the number of bins to be used for a specific variable in the data reduction.

reset_min_and_max(*args, **kwargs)#

Reset the min and max values of the range to be considered for a specific variable in the data reduction.

use_weighting(*args, **kwargs)#

Specify whether to use any weighting in the averaging that is done in each bin in the data reduction.

weighting_variable(*args, **kwargs)#

Choose the weighting variable for the averaging in each bin in the data reduction.

write_sample(*args, **kwargs)#

Write a histogram of a loaded sample into a file.

dpm_sample(*args, **kwargs)#

Samples trajectories at boundaries and lines/planes.

dpm_sample_output_udf(*args, **kwargs)#

Allows you to hook a previously loaded DEFINE_DPM_OUTPUT UDF for file format specification for sampling of trajectories and VOF-to-DPM lump conversion transcripts.

dpm_sample_sort_file(*args, **kwargs)#

Enables/disables writing of sorted DPM sample files.

dpm_summary(*args, **kwargs)#

Prints discrete phase summary report.

dpm_zone_summaries_per_injection(*args, **kwargs)#

Enables/disables calculation of the escaped mass per injection. Note that for unsteady particle tracking, if you want to report the mass of escaped particles per injection, this text command must be enabled before any particles are injected into the domain.

class efficiency(service, version, mode, path)#

Bases: TUIMenu

Enter the menu for efficiency computations.

Methods:

isentropic(*args, **kwargs)	Calculate isentropic efficiency.
polytropic(*args, **kwargs)	Calculate polytropic efficiency.
use_in_turbo_report(*args, **kwargs)	Use this general method instead of constant Cp-based to compute efficiency with Turbo Report tool.

isentropic(*args, **kwargs)#

Calculate isentropic efficiency.

polytropic(*args, **kwargs)#

Calculate polytropic efficiency.

use_in_turbo_report(*args, **kwargs)#

Use this general method instead of constant Cp-based to compute efficiency with Turbo Report tool.

element_mass_flow(*args, **kwargs)#

Prints list of element flow rate at inlets and outlets. This reports the mass flow rates of all chemical elements (in kg/s) flowing through the simulation boundaries.

class fluxes(service, version, mode, path)#

Bases: TUIMenu

Enters the fluxes menu.

Methods:

electric_current(*args, **kwargs)	.
film_heat_transfer(*args, **kwargs)	Prints wall film heat transfer rate at boundaries.
film_mass_flow(*args, **kwargs)	Prints wall film mass flow rate at boundaries.
heat_transfer(*args, **kwargs)	Prints heat transfer rate at boundaries.
heat_transfer_sensible(*args, **kwargs)	Prints the sensible heat transfer rate at the boundaries.
mass_flow(*args, **kwargs)	Prints mass flow rate at inlets and outlets.
pressure_work(*args, **kwargs)	Prints the pressure work rate at the boundaries.
rad_heat_trans(*args, **kwargs)	Prints radiation heat transfer rate at boundaries.
viscous_work(*args, **kwargs)	Prints the viscous work rate at the boundaries.

electric_current(*args, **kwargs)#

.

film_heat_transfer(*args, **kwargs)#

Prints wall film heat transfer rate at boundaries. This text command is only available when you enable the Eulerian wall film model.

film_mass_flow(*args, **kwargs)#

Prints wall film mass flow rate at boundaries. This text command is only available when you enable the Eulerian wall film model.

heat_transfer(*args, **kwargs)#

Prints heat transfer rate at boundaries.

heat_transfer_sensible(*args, **kwargs)#

Prints the sensible heat transfer rate at the boundaries.

mass_flow(*args, **kwargs)#

Prints mass flow rate at inlets and outlets.

pressure_work(*args, **kwargs)#

Prints the pressure work rate at the boundaries. This text command is only available when the energy equation is enabled, the absolute velocity formulation is selected, and zone motion is enabled for a fluid cell zone.

rad_heat_trans(*args, **kwargs)#

Prints radiation heat transfer rate at boundaries.

viscous_work(*args, **kwargs)#

Prints the viscous work rate at the boundaries. This text command is only available when the energy equation is enabled and the pressure-based solver is selected.

class forces(service, version, mode, path)#

Bases: TUIMenu

Enters the forces menu.

Methods:

pressure_center(*args, **kwargs)	Prints the center of pressure on wall zones.
wall_forces(*args, **kwargs)	Computes the forces along the specified force vector for all wall zones.
wall_moments(*args, **kwargs)	Computes the moments about the specified moment center for all wall zones.

pressure_center(*args, **kwargs)#

Prints the center of pressure on wall zones.

wall_forces(*args, **kwargs)#

Computes the forces along the specified force vector for all wall zones.

wall_moments(*args, **kwargs)#

Computes the moments about the specified moment center for all wall zones.

class heat_exchanger(service, version, mode, path)#

Bases: TUIMenu

Enters the heat exchanger menu.

Methods:

computed_heat_rejection(*args, **kwargs)	Prints total heat rejection.
inlet_temperature(*args, **kwargs)	Prints inlet temperature.
mass_flow_rate(*args, **kwargs)	Prints mass flow rate.
outlet_temperature(*args, **kwargs)	Prints outlet temperature.
specific_heat(*args, **kwargs)	Prints fluid’s specific heat.

computed_heat_rejection(*args, **kwargs)#

Prints total heat rejection.

inlet_temperature(*args, **kwargs)#

Prints inlet temperature.

mass_flow_rate(*args, **kwargs)#

Prints mass flow rate.

outlet_temperature(*args, **kwargs)#

Prints outlet temperature.

specific_heat(*args, **kwargs)#

Prints fluid’s specific heat.

class icing(service, version, mode, path)#

Bases: TUIMenu

Icing reports menu.

Methods:

energy_of_ice_formation(*args, **kwargs)	Print Energy of Ice Formation.
energy_of_water_impinged(*args, **kwargs)	Print Energy of Water Impingement.
icing_energy_of_conduction(*args, **kwargs)	Print Energy of Conduction.
mass_of_ice(*args, **kwargs)	Print Mass of Ice Accretion.
mass_of_water_impinged(*args, **kwargs)	Print Mass of Water Impingement.
particles_crystals_collection_eff(*args, ...)	Print Crystals Collection Efficiency.
particles_droplets_collection_eff(*args, ...)	Print Droplets Collection Efficiency.

energy_of_ice_formation(*args, **kwargs)#

Print Energy of Ice Formation.

energy_of_water_impinged(*args, **kwargs)#

Print Energy of Water Impingement.

icing_energy_of_conduction(*args, **kwargs)#

Print Energy of Conduction.

mass_of_ice(*args, **kwargs)#

Print Mass of Ice Accretion.

mass_of_water_impinged(*args, **kwargs)#

Print Mass of Water Impingement.

particles_crystals_collection_eff(*args, **kwargs)#

Print Crystals Collection Efficiency.

particles_droplets_collection_eff(*args, **kwargs)#

Print Droplets Collection Efficiency.

class modified_setting(service, version, mode, path)#

Bases: TUIMenu

Enter the modified settings menu.

Methods:

modified_setting(*args, **kwargs)	Specify which areas of setup will be checked for non-default settings for generating the Modified Settings Summary table.
write_user_setting(*args, **kwargs)	Write the contents of the Modified Settings Summary table to a file.

modified_setting(*args, **kwargs)#

Specify which areas of setup will be checked for non-default settings for generating the Modified Settings Summary table. The table is displayed tabbed with the graphics window.

write_user_setting(*args, **kwargs)#

Write the contents of the Modified Settings Summary table to a file.

mphase_summary(*args, **kwargs)#

Prints summary report for a multiphase case setup.

particle_summary(*args, **kwargs)#

Prints summary report for all current particles.

path_line_summary(*args, **kwargs)#

Prints pathline summary report.

class population_balance(service, version, mode, path)#

Bases: TUIMenu

Population Balance menu.

Methods:

moments(*args, **kwargs)	Set moments for population balance.
number_density(*args, **kwargs)	Set number density functions.

moments(*args, **kwargs)#

Set moments for population balance.

number_density(*args, **kwargs)#

Set number density functions.

print_histogram(*args, **kwargs)#

Prints a histogram of a scalar quantity.

projected_surface_area(*args, **kwargs)#

Computes the area of the projection of selected surfaces along the , , or axis.

class reference_values(service, version, mode, path)#

Bases: TUIMenu

Enters the reference value menu.

Methods:

area(*args, **kwargs)	Sets reference area for normalization.
density(*args, **kwargs)	Sets reference density for normalization.
depth(*args, **kwargs)	Sets reference depth for volume calculation.
enthalpy(*args, **kwargs)	Sets reference enthalpy for enthalpy damping and normalization.
length(*args, **kwargs)	Sets reference length for normalization.
list(*args, **kwargs)	Lists current reference values.
pressure(*args, **kwargs)	Sets reference pressure for normalization.
temperature(*args, **kwargs)	Sets reference temperature for normalization.
velocity(*args, **kwargs)	Sets reference velocity for normalization.
viscosity(*args, **kwargs)	Sets reference viscosity for normalization.
yplus(*args, **kwargs)	Sets reference yplus for calculation of Yplus Based Heat Transfer Coefficient.
zone(*args, **kwargs)	Sets reference zone.

Classes:

compute(service, version, mode, path)

Computes reference values from zone boundary conditions.

area(*args, **kwargs)#

Sets reference area for normalization.

class compute(service, version, mode, path)#

Bases: TUIMenu

Computes reference values from zone boundary conditions.

Methods:

axis(*args, **kwargs)	Compute reference values from a zone of this type.
degassing(*args, **kwargs)	Compute reference values from a zone of this type.
dummy_entry(*args, **kwargs)	.
exhaust_fan(*args, **kwargs)	Compute reference values from a zone of this type.
fan(*args, **kwargs)	Compute reference values from a zone of this type.
fluid(*args, **kwargs)	Compute reference values from a zone of this type.
geometry(*args, **kwargs)	Compute reference values from a zone of this type.
inlet_vent(*args, **kwargs)	Compute reference values from a zone of this type.
intake_fan(*args, **kwargs)	Compute reference values from a zone of this type.
interface(*args, **kwargs)	Compute reference values from a zone of this type.
interior(*args, **kwargs)	Compute reference values from a zone of this type.
mass_flow_inlet(*args, **kwargs)	Compute reference values from a zone of this type.
mass_flow_outlet(*args, **kwargs)	Compute reference values from a zone of this type.
network(*args, **kwargs)	Compute reference values from a zone of this type.
network_end(*args, **kwargs)	Compute reference values from a zone of this type.
outflow(*args, **kwargs)	Compute reference values from a zone of this type.
outlet_vent(*args, **kwargs)	Compute reference values from a zone of this type.
overset(*args, **kwargs)	Compute reference values from a zone of this type.
periodic(*args, **kwargs)	Compute reference values from a zone of this type.
porous_jump(*args, **kwargs)	Compute reference values from a zone of this type.
pressure_far_field(*args, **kwargs)	Compute reference values from a zone of this type.
pressure_inlet(*args, **kwargs)	Compute reference values from a zone of this type.
pressure_outlet(*args, **kwargs)	Compute reference values from a zone of this type.
radiator(*args, **kwargs)	Compute reference values from a zone of this type.
rans_les_interface(*args, **kwargs)	Compute reference values from a zone of this type.
recirculation_inlet(*args, **kwargs)	Compute reference values from a zone of this type.
recirculation_outlet(*args, **kwargs)	Compute reference values from a zone of this type.
shadow(*args, **kwargs)	Compute reference values from a zone of this type.
solid(*args, **kwargs)	Compute reference values from a zone of this type.
symmetry(*args, **kwargs)	Compute reference values from a zone of this type.
velocity_inlet(*args, **kwargs)	Compute reference values from a zone of this type.
wall(*args, **kwargs)	Compute reference values from a zone of this type.

axis(*args, **kwargs)#

Compute reference values from a zone of this type.

degassing(*args, **kwargs)#

Compute reference values from a zone of this type.

dummy_entry(*args, **kwargs)#

.

exhaust_fan(*args, **kwargs)#

Compute reference values from a zone of this type.

fan(*args, **kwargs)#

Compute reference values from a zone of this type.

fluid(*args, **kwargs)#

Compute reference values from a zone of this type.

geometry(*args, **kwargs)#

Compute reference values from a zone of this type.

inlet_vent(*args, **kwargs)#

Compute reference values from a zone of this type.

intake_fan(*args, **kwargs)#

Compute reference values from a zone of this type.

interface(*args, **kwargs)#

Compute reference values from a zone of this type.

interior(*args, **kwargs)#

Compute reference values from a zone of this type.

mass_flow_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

mass_flow_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

network(*args, **kwargs)#

Compute reference values from a zone of this type.

network_end(*args, **kwargs)#

Compute reference values from a zone of this type.

outflow(*args, **kwargs)#

Compute reference values from a zone of this type.

outlet_vent(*args, **kwargs)#

Compute reference values from a zone of this type.

overset(*args, **kwargs)#

Compute reference values from a zone of this type.

periodic(*args, **kwargs)#

Compute reference values from a zone of this type.

porous_jump(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_far_field(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

radiator(*args, **kwargs)#

Compute reference values from a zone of this type.

rans_les_interface(*args, **kwargs)#

Compute reference values from a zone of this type.

recirculation_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

recirculation_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

shadow(*args, **kwargs)#

Compute reference values from a zone of this type.

solid(*args, **kwargs)#

Compute reference values from a zone of this type.

symmetry(*args, **kwargs)#

Compute reference values from a zone of this type.

velocity_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

wall(*args, **kwargs)#

Compute reference values from a zone of this type.

density(*args, **kwargs)#

Sets reference density for normalization.

depth(*args, **kwargs)#

Sets reference depth for volume calculation.

enthalpy(*args, **kwargs)#

Sets reference enthalpy for enthalpy damping and normalization.

length(*args, **kwargs)#

Sets reference length for normalization.

list(*args, **kwargs)#

Lists current reference values.

pressure(*args, **kwargs)#

Sets reference pressure for normalization.

temperature(*args, **kwargs)#

Sets reference temperature for normalization.

velocity(*args, **kwargs)#

Sets reference velocity for normalization.

viscosity(*args, **kwargs)#

Sets reference viscosity for normalization.

yplus(*args, **kwargs)#

Sets reference yplus for calculation of Yplus Based Heat Transfer Coefficient.

zone(*args, **kwargs)#

Sets reference zone.

class simulation_reports(service, version, mode, path)#

Bases: TUIMenu

Enter the simulation reports menu.

Methods:

delete_simulation_report(*args, **kwargs)	Delete the provided simulation report.
duplicate_simulation_report(*args, **kwargs)	Duplicate a report and all of its settings to a new report.
export_simulation_report_as_html(*args, **kwargs)	Export the provided simulation report as HTML.
export_simulation_report_as_pdf(*args, **kwargs)	Export the provided simulation report as a PDF file.
export_simulation_report_as_pptx(*args, **kwargs)	Export the provided simulation report as a PPT file.
generate_simulation_report(*args, **kwargs)	Generate a new simulation report or regenerate an existing simulation report with the provided name.
list_simulation_reports(*args, **kwargs)	List all report names.
read_simulation_report_template_file(*args, ...)	Read a JSON template file with existing Simulation Report settings.
rename_simulation_report(*args, **kwargs)	Rename a report which has already been generated.
reset_report_to_defaults(*args, **kwargs)	Reset all report settings to default for the provided simulation report.
view_simulation_report(*args, **kwargs)	View a simulation report that has already been generated.
write_report_names_to_file(*args, **kwargs)	Write the list of currently generated report names to a txt file.
write_simulation_report_template_file(*args, ...)	Write a JSON template file with this case's Simulation Report settings.

Classes:

parametric_study(service, version, mode, path)

Enter the parametric study menu.

delete_simulation_report(*args, **kwargs)#

Delete the provided simulation report.

duplicate_simulation_report(*args, **kwargs)#

Duplicate a report and all of its settings to a new report.

export_simulation_report_as_html(*args, **kwargs)#

Export the provided simulation report as HTML.

export_simulation_report_as_pdf(*args, **kwargs)#

Export the provided simulation report as a PDF file.

export_simulation_report_as_pptx(*args, **kwargs)#

Export the provided simulation report as a PPT file.

generate_simulation_report(*args, **kwargs)#

Generate a new simulation report or regenerate an existing simulation report with the provided name.

list_simulation_reports(*args, **kwargs)#

List all report names.

class parametric_study(service, version, mode, path)#

Bases: TUIMenu

Enter the parametric study menu.

Methods:

generate_design_point_report(*args, **kwargs)	Generate a simulation report for an updated design point.
generate_parametric_report(*args, **kwargs)	Generate a parametric report for your study.

generate_design_point_report(*args, **kwargs)#

Generate a simulation report for an updated design point.

generate_parametric_report(*args, **kwargs)#

Generate a parametric report for your study.

read_simulation_report_template_file(*args, **kwargs)#

Read a JSON template file with existing Simulation Report settings.

rename_simulation_report(*args, **kwargs)#

Rename a report which has already been generated.

reset_report_to_defaults(*args, **kwargs)#

Reset all report settings to default for the provided simulation report.

view_simulation_report(*args, **kwargs)#

View a simulation report that has already been generated. In batch mode this will print the report’s URL.

write_report_names_to_file(*args, **kwargs)#

Write the list of currently generated report names to a txt file.

write_simulation_report_template_file(*args, **kwargs)#

Write a JSON template file with this case’s Simulation Report settings.

species_mass_flow(*args, **kwargs)#

Prints list of species mass flow rate at inlets and outlets. This reports the mass flow rates of all species (in kg/s) flowing through the simulation boundaries.

summary(*args, **kwargs)#

Prints the current settings for physical models, boundary conditions, material properties, and solution parameters.

surface_integrals(*args, **kwargs)#

Enters the surface integral menu.

class system(service, version, mode, path)#

Bases: TUIMenu

Enters the system menu.

Methods:

gpgpu_stats(*args, **kwargs)	Prints information about installed general purpose graphical processing units.
proc_stats(*args, **kwargs)	Prints ANSYS Fluent process information.
sys_stats(*args, **kwargs)	System information.
time_stats(*args, **kwargs)	Timer information.

gpgpu_stats(*args, **kwargs)#

Prints information about installed general purpose graphical processing units.

proc_stats(*args, **kwargs)#

Prints ANSYS Fluent process information. This is used to report the memory usage of each of the ANSYS Fluent processes.

sys_stats(*args, **kwargs)#

System information. This is used to report the CPU configuration of the machines where ANSYS Fluent processes have been spawned.

time_stats(*args, **kwargs)#

Timer information. This is used to report CPU timings for user and kernel processes and detailed solver timings.

uds_flow(*args, **kwargs)#

Prints list of user-defined scalar flow rate at boundaries.

class virtual_blade_model(service, version, mode, path)#

Bases: TUIMenu

VBM reports menu.

Methods:

rotor_pitch_moment(*args, **kwargs)	Print Rotor Pitch-Moment.
rotor_power(*args, **kwargs)	Print Rotor Power.
rotor_roll_moment(*args, **kwargs)	Print Rotor Roll-Moment.
rotor_thrust(*args, **kwargs)	Print Rotor Thrust.
rotor_torque(*args, **kwargs)	Print Rotor Torque.

rotor_pitch_moment(*args, **kwargs)#

Print Rotor Pitch-Moment.

rotor_power(*args, **kwargs)#

Print Rotor Power.

rotor_roll_moment(*args, **kwargs)#

Print Rotor Roll-Moment.

rotor_thrust(*args, **kwargs)#

Print Rotor Thrust.

rotor_torque(*args, **kwargs)#

Print Rotor Torque.

volume_integrals(*args, **kwargs)#

Enters the volume integral menu.

class results(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

animations(service, version, mode, path)	.
graphics(service, version, mode, path)	.
plot(service, version, mode, path)	.
report(service, version, mode, path)	.
scene(service, version, mode, path)	.
surfaces(service, version, mode, path)	.

class animations(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

playback(service, version, mode, path)

.

class playback(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

read_animation(*args, **kwargs)	.
stored_view(*args, **kwargs)	.
write_animation(*args, **kwargs)	.

Classes:

set_custom_frames(service, version, mode, path)	.
video(service, version, mode, path)	.

read_animation(*args, **kwargs)#

.

class set_custom_frames(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

end_frame(*args, **kwargs)	.
increment(*args, **kwargs)	.
start_frame(*args, **kwargs)	.

end_frame(*args, **kwargs)#

.

increment(*args, **kwargs)#

.

start_frame(*args, **kwargs)#

.

stored_view(*args, **kwargs)#

.

class video(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

advance_quality(service, version, mode, path)

.

Methods:

format(*args, **kwargs)	.
fps(*args, **kwargs)	.
height(*args, **kwargs)	.
name(*args, **kwargs)	.
quality(*args, **kwargs)	.
scale(*args, **kwargs)	.
set_standard_resolution(*args, **kwargs)	.
use_original_resolution(*args, **kwargs)	.
width(*args, **kwargs)	.

class advance_quality(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

bitrate(*args, **kwargs)	.
bitrate_scale(*args, **kwargs)	.
compression_method(*args, **kwargs)	.
enable_h264(*args, **kwargs)	.
keyframe(*args, **kwargs)	.

bitrate(*args, **kwargs)#

.

bitrate_scale(*args, **kwargs)#

.

compression_method(*args, **kwargs)#

.

enable_h264(*args, **kwargs)#

.

keyframe(*args, **kwargs)#

.

format(*args, **kwargs)#

.

fps(*args, **kwargs)#

.

height(*args, **kwargs)#

.

name(*args, **kwargs)#

.

quality(*args, **kwargs)#

.

scale(*args, **kwargs)#

.

set_standard_resolution(*args, **kwargs)#

.

use_original_resolution(*args, **kwargs)#

.

width(*args, **kwargs)#

.

write_animation(*args, **kwargs)#

.

class graphics(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

colors(service, version, mode, path)	.
contour(service, version, mode, path)	.
contours(service, version, mode, path)	.
lic(service, version, mode, path)	.
lights(service, version, mode, path)	.
mesh(service, version, mode, path)	.
olic(service, version, mode, path)	.
particle_track(service, version, mode, path)	.
particle_tracks(service, version, mode, path)	.
pathline(service, version, mode, path)	.
picture(service, version, mode, path)	.
raytracing_options(service, version, mode, path)	.
vector(service, version, mode, path)	.
views(service, version, mode, path)	.
windows(service, version, mode, path)	.

class colors(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

automatic_skip(*args, **kwargs)	.
axis_faces(*args, **kwargs)	.
background(*args, **kwargs)	.
color_by_type(*args, **kwargs)	.
far_field_faces(*args, **kwargs)	.
foreground(*args, **kwargs)	.
free_surface_faces(*args, **kwargs)	.
inlet_faces(*args, **kwargs)	.
interface_faces(*args, **kwargs)	.
interior_faces(*args, **kwargs)	.
internal_faces(*args, **kwargs)	.
list_colors(*args, **kwargs)	.
outlet_faces(*args, **kwargs)	.
overset_faces(*args, **kwargs)	.
periodic_faces(*args, **kwargs)	.
rans_les_interface_faces(*args, **kwargs)	.
reset_colors(*args, **kwargs)	.
skip_label(*args, **kwargs)	.
surface(*args, **kwargs)	.
symmetry_faces(*args, **kwargs)	.
traction_faces(*args, **kwargs)	.
wall_faces(*args, **kwargs)	.

Classes:

by_surface(service, version, mode, path)	.
by_type(service, version, mode, path)	.

automatic_skip(*args, **kwargs)#

.

axis_faces(*args, **kwargs)#

.

background(*args, **kwargs)#

.

class by_surface(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

list_surfaces_by_color(*args, **kwargs)	.
list_surfaces_by_material(*args, **kwargs)	.
reset(*args, **kwargs)	.
use_inherent_material_color(*args, **kwargs)	.

list_surfaces_by_color(*args, **kwargs)#

.

list_surfaces_by_material(*args, **kwargs)#

.

reset(*args, **kwargs)#

.

use_inherent_material_color(*args, **kwargs)#

.

class by_type(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

only_list_case_boundaries(*args, **kwargs)	.
reset(*args, **kwargs)	.
use_inherent_material_color(*args, **kwargs)	.

only_list_case_boundaries(*args, **kwargs)#

.

reset(*args, **kwargs)#

.

use_inherent_material_color(*args, **kwargs)#

.

color_by_type(*args, **kwargs)#

.

far_field_faces(*args, **kwargs)#

.

foreground(*args, **kwargs)#

.

free_surface_faces(*args, **kwargs)#

.

inlet_faces(*args, **kwargs)#

.

interface_faces(*args, **kwargs)#

.

interior_faces(*args, **kwargs)#

.

internal_faces(*args, **kwargs)#

.

list_colors(*args, **kwargs)#

.

outlet_faces(*args, **kwargs)#

.

overset_faces(*args, **kwargs)#

.

periodic_faces(*args, **kwargs)#

.

rans_les_interface_faces(*args, **kwargs)#

.

reset_colors(*args, **kwargs)#

.

skip_label(*args, **kwargs)#

.

surface(*args, **kwargs)#

.

symmetry_faces(*args, **kwargs)#

.

traction_faces(*args, **kwargs)#

.

wall_faces(*args, **kwargs)#

.

class contour(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

add_to_graphics(*args, **kwargs)	.
clear_history(*args, **kwargs)	.
copy(*args, **kwargs)	.
create(*args, **kwargs)	Create a new contour object.
delete(*args, **kwargs)	Delete contour object.
display(*args, **kwargs)	.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit contour object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename contour object.

add_to_graphics(*args, **kwargs)#

.

clear_history(*args, **kwargs)#

.

copy(*args, **kwargs)#

.

create(*args, **kwargs)#

Create a new contour object.

delete(*args, **kwargs)#

Delete contour object.

display(*args, **kwargs)#

.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit contour object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename contour object.

class contours(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

auto_scale(*args, **kwargs)	.
clip_to_range(*args, **kwargs)	.
filled_contours(*args, **kwargs)	.
global_range(*args, **kwargs)	.
line_contours(*args, **kwargs)	.
log_scale(*args, **kwargs)	.
n_contour(*args, **kwargs)	.
node_values(*args, **kwargs)	.
render_mesh(*args, **kwargs)	.
surfaces(*args, **kwargs)	.

Classes:

coloring(service, version, mode, path)

.

auto_scale(*args, **kwargs)#

.

clip_to_range(*args, **kwargs)#

.

class coloring(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

banded_coloring(*args, **kwargs)	.
number_of_bands(*args, **kwargs)	.

banded_coloring(*args, **kwargs)#

.

number_of_bands(*args, **kwargs)#

.

filled_contours(*args, **kwargs)#

.

global_range(*args, **kwargs)#

.

line_contours(*args, **kwargs)#

.

log_scale(*args, **kwargs)#

.

n_contour(*args, **kwargs)#

.

node_values(*args, **kwargs)#

.

render_mesh(*args, **kwargs)#

.

surfaces(*args, **kwargs)#

.

class lic(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

add_to_graphics(*args, **kwargs)	.
clear_history(*args, **kwargs)	.
copy(*args, **kwargs)	.
create(*args, **kwargs)	Create a new lic object.
delete(*args, **kwargs)	Delete lic object.
display(*args, **kwargs)	.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit lic object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename lic object.

add_to_graphics(*args, **kwargs)#

.

clear_history(*args, **kwargs)#

.

copy(*args, **kwargs)#

.

create(*args, **kwargs)#

Create a new lic object.

delete(*args, **kwargs)#

Delete lic object.

display(*args, **kwargs)#

.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit lic object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename lic object.

class lights(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

ambient_color(*args, **kwargs)	.
headlight_setting(*args, **kwargs)	.
lighting_interpolation(*args, **kwargs)	.
lights_on(*args, **kwargs)	.
set_light(*args, **kwargs)	.

ambient_color(*args, **kwargs)#

.

headlight_setting(*args, **kwargs)#

.

lighting_interpolation(*args, **kwargs)#

.

lights_on(*args, **kwargs)#

.

set_light(*args, **kwargs)#

.

class mesh(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

add_to_graphics(*args, **kwargs)	.
clear_history(*args, **kwargs)	.
copy(*args, **kwargs)	.
create(*args, **kwargs)	Create a new mesh object.
delete(*args, **kwargs)	Delete mesh object.
display(*args, **kwargs)	.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit mesh object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename mesh object.

add_to_graphics(*args, **kwargs)#

.

clear_history(*args, **kwargs)#

.

copy(*args, **kwargs)#

.

create(*args, **kwargs)#

Create a new mesh object.

delete(*args, **kwargs)#

Delete mesh object.

display(*args, **kwargs)#

.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit mesh object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename mesh object.

class olic(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

add_to_graphics(*args, **kwargs)	.
clear_history(*args, **kwargs)	.
copy(*args, **kwargs)	.
create(*args, **kwargs)	Create a new olic object.
delete(*args, **kwargs)	Delete olic object.
display(*args, **kwargs)	.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit olic object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename olic object.

add_to_graphics(*args, **kwargs)#

.

clear_history(*args, **kwargs)#

.

copy(*args, **kwargs)#

.

create(*args, **kwargs)#

Create a new olic object.

delete(*args, **kwargs)#

Delete olic object.

display(*args, **kwargs)#

.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit olic object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename olic object.

class particle_track(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

add_to_graphics(*args, **kwargs)	.
clear_history(*args, **kwargs)	.
copy(*args, **kwargs)	.
create(*args, **kwargs)	Create a new particle-track object.
delete(*args, **kwargs)	Delete particle-track object.
display(*args, **kwargs)	.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit particle-track object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename particle-track object.

add_to_graphics(*args, **kwargs)#

.

clear_history(*args, **kwargs)#

.

copy(*args, **kwargs)#

.

create(*args, **kwargs)#

Create a new particle-track object.

delete(*args, **kwargs)#

Delete particle-track object.

display(*args, **kwargs)#

.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit particle-track object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename particle-track object.

class particle_tracks(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

arrow_scale(*args, **kwargs)	.
arrow_space(*args, **kwargs)	.
coarsen_factor(*args, **kwargs)	.
display(*args, **kwargs)	.
history_filename(*args, **kwargs)	.
line_width(*args, **kwargs)	.
report_default_variables(*args, **kwargs)	.
track_single_particle_stream(*args, **kwargs)	.

arrow_scale(*args, **kwargs)#

.

arrow_space(*args, **kwargs)#

.

coarsen_factor(*args, **kwargs)#

.

display(*args, **kwargs)#

.

history_filename(*args, **kwargs)#

.

line_width(*args, **kwargs)#

.

report_default_variables(*args, **kwargs)#

.

track_single_particle_stream(*args, **kwargs)#

.

class pathline(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

add_to_graphics(*args, **kwargs)	.
clear_history(*args, **kwargs)	.
copy(*args, **kwargs)	.
create(*args, **kwargs)	Create a new pathline object.
delete(*args, **kwargs)	Delete pathline object.
display(*args, **kwargs)	.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit pathline object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename pathline object.

add_to_graphics(*args, **kwargs)#

.

clear_history(*args, **kwargs)#

.

copy(*args, **kwargs)#

.

create(*args, **kwargs)#

Create a new pathline object.

delete(*args, **kwargs)#

Delete pathline object.

display(*args, **kwargs)#

.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit pathline object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename pathline object.

class picture(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

color_mode(*args, **kwargs)	.
dpi(*args, **kwargs)	.
invert_background(*args, **kwargs)	.
jpeg_hardcopy_quality(*args, **kwargs)	.
landscape(*args, **kwargs)	.
list_color_mode(*args, **kwargs)	.
preview(*args, **kwargs)	.
raytracer_image(*args, **kwargs)	.
save_picture(*args, **kwargs)	.
standard_resolution(*args, **kwargs)	.
use_window_resolution(*args, **kwargs)	.
x_resolution(*args, **kwargs)	.
y_resolution(*args, **kwargs)	.

Classes:

driver_options(service, version, mode, path)

.

color_mode(*args, **kwargs)#

.

dpi(*args, **kwargs)#

.

class driver_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

current_driver(*args, **kwargs)	.
hardcopy_format(*args, **kwargs)	.
hardcopy_options(*args, **kwargs)	.
post_format(*args, **kwargs)	.
window_dump_cmd(*args, **kwargs)	.

current_driver(*args, **kwargs)#

.

hardcopy_format(*args, **kwargs)#

.

hardcopy_options(*args, **kwargs)#

.

post_format(*args, **kwargs)#

.

window_dump_cmd(*args, **kwargs)#

.

invert_background(*args, **kwargs)#

.

jpeg_hardcopy_quality(*args, **kwargs)#

.

landscape(*args, **kwargs)#

.

list_color_mode(*args, **kwargs)#

.

preview(*args, **kwargs)#

.

raytracer_image(*args, **kwargs)#

.

save_picture(*args, **kwargs)#

.

standard_resolution(*args, **kwargs)#

.

use_window_resolution(*args, **kwargs)#

.

x_resolution(*args, **kwargs)#

.

y_resolution(*args, **kwargs)#

.

class raytracing_options(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

background(service, version, mode, path)	.
rendering(service, version, mode, path)	.

Methods:

display_live_preview(*args, **kwargs)

.

class background(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

backplate_color(*args, **kwargs)	.
backplate_image(*args, **kwargs)	.
environment_image(*args, **kwargs)	.
hide_environment_keep_effects(*args, **kwargs)	.
latitude(*args, **kwargs)	.
longitude(*args, **kwargs)	.
show_backplate(*args, **kwargs)	.
view_zoom(*args, **kwargs)	.

backplate_color(*args, **kwargs)#

.

backplate_image(*args, **kwargs)#

.

environment_image(*args, **kwargs)#

.

hide_environment_keep_effects(*args, **kwargs)#

.

latitude(*args, **kwargs)#

.

longitude(*args, **kwargs)#

.

show_backplate(*args, **kwargs)#

.

view_zoom(*args, **kwargs)#

.

display_live_preview(*args, **kwargs)#

.

class rendering(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

denoiser(*args, **kwargs)	.
max_rendering_timeout(*args, **kwargs)	.
quality(*args, **kwargs)	.
thread_count(*args, **kwargs)	.

denoiser(*args, **kwargs)#

.

max_rendering_timeout(*args, **kwargs)#

.

quality(*args, **kwargs)#

.

thread_count(*args, **kwargs)#

.

class vector(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

add_to_graphics(*args, **kwargs)	.
clear_history(*args, **kwargs)	.
copy(*args, **kwargs)	.
create(*args, **kwargs)	Create a new vector object.
delete(*args, **kwargs)	Delete vector object.
display(*args, **kwargs)	.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit vector object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename vector object.

add_to_graphics(*args, **kwargs)#

.

clear_history(*args, **kwargs)#

.

copy(*args, **kwargs)#

.

create(*args, **kwargs)#

Create a new vector object.

delete(*args, **kwargs)#

Delete vector object.

display(*args, **kwargs)#

.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit vector object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename vector object.

class views(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

auto_scale(*args, **kwargs)	.
delete_view(*args, **kwargs)	.
last_view(*args, **kwargs)	.
list_views(*args, **kwargs)	.
next_view(*args, **kwargs)	.
read_views(*args, **kwargs)	.
reset_to_default_view(*args, **kwargs)	.
restore_view(*args, **kwargs)	.
save_view(*args, **kwargs)	.
write_views(*args, **kwargs)	.

Classes:

camera(service, version, mode, path)	.
display_states(service, version, mode, path)	.

auto_scale(*args, **kwargs)#

.

class camera(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

dolly(*args, **kwargs)	.
field(*args, **kwargs)	.
orbit(*args, **kwargs)	.
pan(*args, **kwargs)	.
position(*args, **kwargs)	.
projection(*args, **kwargs)	.
roll(*args, **kwargs)	.
target(*args, **kwargs)	.
up_vector(*args, **kwargs)	.
zoom(*args, **kwargs)	.

dolly(*args, **kwargs)#

.

field(*args, **kwargs)#

.

orbit(*args, **kwargs)#

.

pan(*args, **kwargs)#

.

position(*args, **kwargs)#

.

projection(*args, **kwargs)#

.

roll(*args, **kwargs)#

.

target(*args, **kwargs)#

.

up_vector(*args, **kwargs)#

.

zoom(*args, **kwargs)#

.

delete_view(*args, **kwargs)#

.

class display_states(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

copy(*args, **kwargs)	.
create(*args, **kwargs)	Create a new display-states object.
delete(*args, **kwargs)	Delete display-states object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit display-states object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
read(*args, **kwargs)	.
rename(*args, **kwargs)	Rename display-states object.
restore_state(*args, **kwargs)	.
use_active(*args, **kwargs)	.
write(*args, **kwargs)	.

copy(*args, **kwargs)#

.

create(*args, **kwargs)#

Create a new display-states object.

delete(*args, **kwargs)#

Delete display-states object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit display-states object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

read(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename display-states object.

restore_state(*args, **kwargs)#

.

use_active(*args, **kwargs)#

.

write(*args, **kwargs)#

.

last_view(*args, **kwargs)#

.

list_views(*args, **kwargs)#

.

next_view(*args, **kwargs)#

.

read_views(*args, **kwargs)#

.

reset_to_default_view(*args, **kwargs)#

.

restore_view(*args, **kwargs)#

.

save_view(*args, **kwargs)#

.

write_views(*args, **kwargs)#

.

class windows(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

aspect_ratio(*args, **kwargs)	.
logo(*args, **kwargs)	.
logo_color(*args, **kwargs)	.
ruler(*args, **kwargs)	.

Classes:

axes(service, version, mode, path)	.
main(service, version, mode, path)	.
scale(service, version, mode, path)	.
text(service, version, mode, path)	.
video(service, version, mode, path)	.
xy(service, version, mode, path)	.

aspect_ratio(*args, **kwargs)#

.

class axes(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)	.
bottom(*args, **kwargs)	.
clear(*args, **kwargs)	.
left(*args, **kwargs)	.
right(*args, **kwargs)	.
top(*args, **kwargs)	.
visible(*args, **kwargs)	.

border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

clear(*args, **kwargs)#

.

left(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

logo(*args, **kwargs)#

.

logo_color(*args, **kwargs)#

.

class main(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)	.
bottom(*args, **kwargs)	.
left(*args, **kwargs)	.
right(*args, **kwargs)	.
top(*args, **kwargs)	.
visible(*args, **kwargs)	.

border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

left(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

ruler(*args, **kwargs)#

.

class scale(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)	.
bottom(*args, **kwargs)	.
clear(*args, **kwargs)	.
font_size(*args, **kwargs)	.
format(*args, **kwargs)	.
left(*args, **kwargs)	.
margin(*args, **kwargs)	.
right(*args, **kwargs)	.
top(*args, **kwargs)	.
visible(*args, **kwargs)	.

border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

clear(*args, **kwargs)#

.

font_size(*args, **kwargs)#

.

format(*args, **kwargs)#

.

left(*args, **kwargs)#

.

margin(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

class text(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

alignment(*args, **kwargs)	.
application(*args, **kwargs)	.
border(*args, **kwargs)	.
bottom(*args, **kwargs)	.
clear(*args, **kwargs)	.
company(*args, **kwargs)	.
date(*args, **kwargs)	.
left(*args, **kwargs)	.
right(*args, **kwargs)	.
top(*args, **kwargs)	.
visible(*args, **kwargs)	.

alignment(*args, **kwargs)#

.

application(*args, **kwargs)#

.

border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

clear(*args, **kwargs)#

.

company(*args, **kwargs)#

.

date(*args, **kwargs)#

.

left(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

class video(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

background(*args, **kwargs)	.
color_filter(*args, **kwargs)	.
foreground(*args, **kwargs)	.
on(*args, **kwargs)	.

Classes:

pixel_size(service, version, mode, path)

.

background(*args, **kwargs)#

.

color_filter(*args, **kwargs)#

.

foreground(*args, **kwargs)#

.

on(*args, **kwargs)#

.

class pixel_size(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

height(*args, **kwargs)	.
margin(*args, **kwargs)	.
width(*args, **kwargs)	.

height(*args, **kwargs)#

.

margin(*args, **kwargs)#

.

width(*args, **kwargs)#

.

class xy(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)	.
bottom(*args, **kwargs)	.
left(*args, **kwargs)	.
right(*args, **kwargs)	.
top(*args, **kwargs)	.
visible(*args, **kwargs)	.

border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

left(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

class plot(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

xy_plot(service, version, mode, path)

.

class xy_plot(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

add_to_graphics(*args, **kwargs)	.
clear_history(*args, **kwargs)	.
copy(*args, **kwargs)	.
create(*args, **kwargs)	Create a new xy-plot object.
delete(*args, **kwargs)	Delete xy-plot object.
display(*args, **kwargs)	.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit xy-plot object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename xy-plot object.

add_to_graphics(*args, **kwargs)#

.

clear_history(*args, **kwargs)#

.

copy(*args, **kwargs)#

.

create(*args, **kwargs)#

Create a new xy-plot object.

delete(*args, **kwargs)#

Delete xy-plot object.

display(*args, **kwargs)#

.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit xy-plot object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename xy-plot object.

class report(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

aero_optical_distortions(*args, **kwargs)	.
forces(*args, **kwargs)	.
mphase_summary(*args, **kwargs)	.
particle_summary(*args, **kwargs)	.
path_line_summary(*args, **kwargs)	.
projected_surface_area(*args, **kwargs)	.
summary(*args, **kwargs)	.
surface_integrals(*args, **kwargs)	.
volume_integrals(*args, **kwargs)	.

Classes:

discrete_phase(service, version, mode, path)	.
flow(service, version, mode, path)	.
fluxes(service, version, mode, path)	.
heat_exchange(service, version, mode, path)	.
histogram(service, version, mode, path)	.
modified_setting_options(service, version, ...)	.
population_balance(service, version, mode, path)	.
simulation_reports(service, version, mode, path)	.
system(service, version, mode, path)	.

aero_optical_distortions(*args, **kwargs)#

.

class discrete_phase(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

extended_summary(*args, **kwargs)	.
summary(*args, **kwargs)	.
zone_summaries_per_injection(*args, **kwargs)	.

Classes:

histogram(service, version, mode, path)	.
sample_trajectories(service, version, mode, path)	.

extended_summary(*args, **kwargs)#

.

class histogram(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

compute_sample(*args, **kwargs)	.
delete_sample(*args, **kwargs)	.
dpm_sample_contour_plots(*args, **kwargs)	.
list_samples(*args, **kwargs)	.
read_sample_file(*args, **kwargs)	.

Classes:

histogram_options(service, version, mode, path)	.
histogram_parameters(service, version, mode, ...)	.
plot_write_sample(service, version, mode, path)	.
reduction(service, version, mode, path)	.

compute_sample(*args, **kwargs)#

.

delete_sample(*args, **kwargs)#

.

dpm_sample_contour_plots(*args, **kwargs)#

.

class histogram_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

auto_range(*args, **kwargs)	.
correlation(*args, **kwargs)	.
cumulation_curve(*args, **kwargs)	.
diameter_statistics(*args, **kwargs)	.
histogram_mode(*args, **kwargs)	.
logarithmic(*args, **kwargs)	.
percentage(*args, **kwargs)	.
variable_power_3(*args, **kwargs)	.
weighting(*args, **kwargs)	.

auto_range(*args, **kwargs)#

.

correlation(*args, **kwargs)#

.

cumulation_curve(*args, **kwargs)#

.

diameter_statistics(*args, **kwargs)#

.

histogram_mode(*args, **kwargs)#

.

logarithmic(*args, **kwargs)#

.

percentage(*args, **kwargs)#

.

variable_power_3(*args, **kwargs)#

.

weighting(*args, **kwargs)#

.

class histogram_parameters(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

division_val(*args, **kwargs)	.
maximum_val(*args, **kwargs)	.
minimum_val(*args, **kwargs)	.

division_val(*args, **kwargs)#

.

maximum_val(*args, **kwargs)#

.

minimum_val(*args, **kwargs)#

.

list_samples(*args, **kwargs)#

.

class plot_write_sample(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

plot_sample(*args, **kwargs)	.
write_sample(*args, **kwargs)	.

plot_sample(*args, **kwargs)#

.

write_sample(*args, **kwargs)#

.

read_sample_file(*args, **kwargs)#

.

class reduction(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

pick_sample_to_reduce(*args, **kwargs)	.
reduce_picked_sample(*args, **kwargs)	.

Classes:

setup_reduction(service, version, mode, path)

.

pick_sample_to_reduce(*args, **kwargs)#

.

reduce_picked_sample(*args, **kwargs)#

.

class setup_reduction(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

all_variables_number_of_bins(*args, **kwargs)	.
list_settings(*args, **kwargs)	.
make_steady_from_unsteady_file(*args, **kwargs)	.
number_of_bins(*args, **kwargs)	.
reset_min_and_max(*args, **kwargs)	.
set_maximum(*args, **kwargs)	.
set_minimum(*args, **kwargs)	.
use_logarithmic(*args, **kwargs)	.
use_weighting(*args, **kwargs)	.
weighting_variable(*args, **kwargs)	.

all_variables_number_of_bins(*args, **kwargs)#

.

list_settings(*args, **kwargs)#

.

make_steady_from_unsteady_file(*args, **kwargs)#

.

number_of_bins(*args, **kwargs)#

.

reset_min_and_max(*args, **kwargs)#

.

set_maximum(*args, **kwargs)#

.

set_minimum(*args, **kwargs)#

.

use_logarithmic(*args, **kwargs)#

.

use_weighting(*args, **kwargs)#

.

weighting_variable(*args, **kwargs)#

.

class sample_trajectories(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

sample(*args, **kwargs)	.
sort_sample_files(*args, **kwargs)	.
user_defined_functions(*args, **kwargs)	.

sample(*args, **kwargs)#

.

sort_sample_files(*args, **kwargs)#

.

user_defined_functions(*args, **kwargs)#

.

summary(*args, **kwargs)#

.

zone_summaries_per_injection(*args, **kwargs)#

.

class flow(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

element_mass_flow(*args, **kwargs)	.
species_mass_flow(*args, **kwargs)	.
uds_flow(*args, **kwargs)	.

element_mass_flow(*args, **kwargs)#

.

species_mass_flow(*args, **kwargs)#

.

uds_flow(*args, **kwargs)#

.

class fluxes(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

electric_current(*args, **kwargs)	.
film_heat_transfer(*args, **kwargs)	.
film_mass_flow(*args, **kwargs)	.
heat_transfer(*args, **kwargs)	.
heat_transfer_sensible(*args, **kwargs)	.
mass_flow(*args, **kwargs)	.
pressure_work(*args, **kwargs)	.
rad_heat_trans(*args, **kwargs)	.
viscous_work(*args, **kwargs)	.

electric_current(*args, **kwargs)#

.

film_heat_transfer(*args, **kwargs)#

.

film_mass_flow(*args, **kwargs)#

.

heat_transfer(*args, **kwargs)#

.

heat_transfer_sensible(*args, **kwargs)#

.

mass_flow(*args, **kwargs)#

.

pressure_work(*args, **kwargs)#

.

rad_heat_trans(*args, **kwargs)#

.

viscous_work(*args, **kwargs)#

.

forces(*args, **kwargs)#

.

class heat_exchange(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

computed_heat_rejection(*args, **kwargs)	.
inlet_temperature(*args, **kwargs)	.
mass_flow_rate(*args, **kwargs)	.
outlet_temperature(*args, **kwargs)	.
specific_heat(*args, **kwargs)	.

computed_heat_rejection(*args, **kwargs)#

.

inlet_temperature(*args, **kwargs)#

.

mass_flow_rate(*args, **kwargs)#

.

outlet_temperature(*args, **kwargs)#

.

specific_heat(*args, **kwargs)#

.

class histogram(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

print(*args, **kwargs)	.
write(*args, **kwargs)	.

print(*args, **kwargs)#

.

write(*args, **kwargs)#

.

class modified_setting_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

modified_setting(*args, **kwargs)	.
write_user_setting(*args, **kwargs)	.

modified_setting(*args, **kwargs)#

.

write_user_setting(*args, **kwargs)#

.

mphase_summary(*args, **kwargs)#

.

particle_summary(*args, **kwargs)#

.

path_line_summary(*args, **kwargs)#

.

class population_balance(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

moments(*args, **kwargs)	.
number_density(*args, **kwargs)	.

moments(*args, **kwargs)#

.

number_density(*args, **kwargs)#

.

projected_surface_area(*args, **kwargs)#

.

class simulation_reports(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

delete_simulation_report(*args, **kwargs)	.
duplicate_simulation_report(*args, **kwargs)	.
export_simulation_report_as_html(*args, **kwargs)	.
export_simulation_report_as_pdf(*args, **kwargs)	.
export_simulation_report_as_pptx(*args, **kwargs)	.
generate_simulation_report(*args, **kwargs)	.
list_simulation_reports(*args, **kwargs)	.
read_simulation_report_template_file(*args, ...)	.
rename_simulation_report(*args, **kwargs)	.
reset_report_to_defaults(*args, **kwargs)	.
view_simulation_report(*args, **kwargs)	.
write_simulation_report_names_to_file(*args, ...)	.
write_simulation_report_template_file(*args, ...)	.

delete_simulation_report(*args, **kwargs)#

.

duplicate_simulation_report(*args, **kwargs)#

.

export_simulation_report_as_html(*args, **kwargs)#

.

export_simulation_report_as_pdf(*args, **kwargs)#

.

export_simulation_report_as_pptx(*args, **kwargs)#

.

generate_simulation_report(*args, **kwargs)#

.

list_simulation_reports(*args, **kwargs)#

.

read_simulation_report_template_file(*args, **kwargs)#

.

rename_simulation_report(*args, **kwargs)#

.

reset_report_to_defaults(*args, **kwargs)#

.

view_simulation_report(*args, **kwargs)#

.

write_simulation_report_names_to_file(*args, **kwargs)#

.

write_simulation_report_template_file(*args, **kwargs)#

.

summary(*args, **kwargs)#

.

surface_integrals(*args, **kwargs)#

.

class system(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

gpgpu_statistics(*args, **kwargs)	.
proc_statistics(*args, **kwargs)	.
sys_statistics(*args, **kwargs)	.
time_statistics(*args, **kwargs)	.

gpgpu_statistics(*args, **kwargs)#

.

proc_statistics(*args, **kwargs)#

.

sys_statistics(*args, **kwargs)#

.

time_statistics(*args, **kwargs)#

.

volume_integrals(*args, **kwargs)#

.

class scene(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

add_to_graphics(*args, **kwargs)	.
clear_history(*args, **kwargs)	.
copy(*args, **kwargs)	.
create(*args, **kwargs)	Create a new scene object.
delete(*args, **kwargs)	Delete scene object.
display(*args, **kwargs)	.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit scene object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename scene object.

add_to_graphics(*args, **kwargs)#

.

clear_history(*args, **kwargs)#

.

copy(*args, **kwargs)#

.

create(*args, **kwargs)#

Create a new scene object.

delete(*args, **kwargs)#

Delete scene object.

display(*args, **kwargs)#

.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit scene object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename scene object.

class surfaces(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

iso_surface(service, version, mode, path)	.
line_surface(service, version, mode, path)	.
plane_surface(service, version, mode, path)	.
point_surface(service, version, mode, path)	.
rake_surface(service, version, mode, path)	.

class iso_surface(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new iso-surface object.
delete(*args, **kwargs)	Delete iso-surface object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit iso-surface object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename iso-surface object.

create(*args, **kwargs)#

Create a new iso-surface object.

delete(*args, **kwargs)#

Delete iso-surface object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit iso-surface object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename iso-surface object.

class line_surface(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new line-surface object.
delete(*args, **kwargs)	Delete line-surface object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit line-surface object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename line-surface object.

create(*args, **kwargs)#

Create a new line-surface object.

delete(*args, **kwargs)#

Delete line-surface object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit line-surface object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename line-surface object.

class plane_surface(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new plane-surface object.
delete(*args, **kwargs)	Delete plane-surface object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit plane-surface object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename plane-surface object.

create(*args, **kwargs)#

Create a new plane-surface object.

delete(*args, **kwargs)#

Delete plane-surface object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit plane-surface object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename plane-surface object.

class point_surface(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new point-surface object.
delete(*args, **kwargs)	Delete point-surface object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit point-surface object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename point-surface object.

create(*args, **kwargs)#

Create a new point-surface object.

delete(*args, **kwargs)#

Delete point-surface object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit point-surface object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename point-surface object.

class rake_surface(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new rake-surface object.
delete(*args, **kwargs)	Delete rake-surface object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit rake-surface object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename rake-surface object.

create(*args, **kwargs)#

Create a new rake-surface object.

delete(*args, **kwargs)#

Delete rake-surface object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit rake-surface object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename rake-surface object.

class server(service, version, mode, path)#

Bases: TUIMenu

Enter the server menu.

Methods:

print_connected_clients(*args, **kwargs)	Prints the name of the connected client and its IP address to the console.
print_server_address(*args, **kwargs)	Prints the host address and port number of the server to the console.
print_web_server_info(*args, **kwargs)	.
shutdown_server(*args, **kwargs)	Shuts-down the server and disconnects the connected client.
start_client(*args, **kwargs)	Start the ANSYS Fluent remote visualization client.
start_server(*args, **kwargs)	Starts the server for the ANSYS Fluent remote visualization client.
start_web_server(*args, **kwargs)	.
stop_web_server(*args, **kwargs)	.
write_or_reset_server_info(*args, **kwargs)	Allows you to create a new server_info.txt file (with any name you specify), which resets the password for connecting to this server session.

print_connected_clients(*args, **kwargs)#

Prints the name of the connected client and its IP address to the console.

print_server_address(*args, **kwargs)#

Prints the host address and port number of the server to the console.

print_web_server_info(*args, **kwargs)#

.

shutdown_server(*args, **kwargs)#

Shuts-down the server and disconnects the connected client.

start_client(*args, **kwargs)#

Start the ANSYS Fluent remote visualization client.

start_server(*args, **kwargs)#

Starts the server for the ANSYS Fluent remote visualization client.

start_web_server(*args, **kwargs)#

.

stop_web_server(*args, **kwargs)#

.

write_or_reset_server_info(*args, **kwargs)#

Allows you to create a new server_info.txt file (with any name you specify), which resets the password for connecting to this server session. It does not restart the server.

class setup(service, version, mode, path)#

Bases: TUIMenu

Enter setup menu.

Classes:

boundary_conditions(service, version, mode, path)

Enter the boudary conditions menu.

class boundary_conditions(service, version, mode, path)#

Bases: TUIMenu

Enter the boudary conditions menu.

Methods:

axis(*args, **kwargs)	Set boundary conditions for a zone of this type.
degassing(*args, **kwargs)	Set boundary conditions for a zone of this type.
exhaust_fan(*args, **kwargs)	Set boundary conditions for a zone of this type.
fan(*args, **kwargs)	Set boundary conditions for a zone of this type.
fluid(*args, **kwargs)	Set boundary conditions for a zone of this type.
geometry(*args, **kwargs)	Set boundary conditions for a zone of this type.
inlet_vent(*args, **kwargs)	Set boundary conditions for a zone of this type.
intake_fan(*args, **kwargs)	Set boundary conditions for a zone of this type.
interface(*args, **kwargs)	Set boundary conditions for a zone of this type.
interior(*args, **kwargs)	Set boundary conditions for a zone of this type.
mass_flow_inlet(*args, **kwargs)	Set boundary conditions for a zone of this type.
mass_flow_outlet(*args, **kwargs)	Set 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.
outflow(*args, **kwargs)	Set boundary conditions for a zone of this type.
outlet_vent(*args, **kwargs)	Set boundary conditions for a zone of this type.
overset(*args, **kwargs)	Set boundary conditions for a zone of this type.
periodic(*args, **kwargs)	Set boundary conditions for a zone of this type.
porous_jump(*args, **kwargs)	Set boundary conditions for a zone of this type.
pressure_far_field(*args, **kwargs)	Set boundary conditions for a zone of this type.
pressure_inlet(*args, **kwargs)	Set boundary conditions for a zone of this type.
pressure_outlet(*args, **kwargs)	Set boundary conditions for a zone of this type.
radiator(*args, **kwargs)	Set boundary conditions for a zone of this type.
rans_les_interface(*args, **kwargs)	Set boundary conditions for a zone of this type.
recirculation_inlet(*args, **kwargs)	Set boundary conditions for a zone of this type.
recirculation_outlet(*args, **kwargs)	Set boundary conditions for a zone of this type.
shadow(*args, **kwargs)	Set boundary conditions for a zone of this type.
solid(*args, **kwargs)	Set boundary conditions for a zone of this type.
symmetry(*args, **kwargs)	Set boundary conditions for a zone of this type.
velocity_inlet(*args, **kwargs)	Set boundary conditions for a zone of this type.
wall(*args, **kwargs)	Set boundary conditions for a zone of this type.

Classes:

query(service, version, mode, path)

Enter zone query menu.

axis(*args, **kwargs)#

Set boundary conditions for a zone of this type.

degassing(*args, **kwargs)#

Set boundary conditions for a zone of this type.

exhaust_fan(*args, **kwargs)#

Set boundary conditions for a zone of this type.

fan(*args, **kwargs)#

Set boundary conditions for a zone of this type.

fluid(*args, **kwargs)#

Set boundary conditions for a zone of this type.

geometry(*args, **kwargs)#

Set boundary conditions for a zone of this type.

inlet_vent(*args, **kwargs)#

Set boundary conditions for a zone of this type.

intake_fan(*args, **kwargs)#

Set boundary conditions for a zone of this type.

interface(*args, **kwargs)#

Set boundary conditions for a zone of this type.

interior(*args, **kwargs)#

Set boundary conditions for a zone of this type.

mass_flow_inlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

mass_flow_outlet(*args, **kwargs)#

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

outflow(*args, **kwargs)#

Set boundary conditions for a zone of this type.

outlet_vent(*args, **kwargs)#

Set boundary conditions for a zone of this type.

overset(*args, **kwargs)#

Set boundary conditions for a zone of this type.

periodic(*args, **kwargs)#

Set boundary conditions for a zone of this type.

porous_jump(*args, **kwargs)#

Set boundary conditions for a zone of this type.

pressure_far_field(*args, **kwargs)#

Set boundary conditions for a zone of this type.

pressure_inlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

pressure_outlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

class query(service, version, mode, path)#

Bases: TUIMenu

Enter zone query menu.

Methods:

axis(*args, **kwargs)	Show boundary conditions for a zone of this type.
degassing(*args, **kwargs)	Show boundary conditions for a zone of this type.
delete_query(*args, **kwargs)	Delete saved query.
exhaust_fan(*args, **kwargs)	Show boundary conditions for a zone of this type.
fan(*args, **kwargs)	Show boundary conditions for a zone of this type.
fluid(*args, **kwargs)	Show boundary conditions for a zone of this type.
geometry(*args, **kwargs)	Show boundary conditions for a zone of this type.
inlet_vent(*args, **kwargs)	Show boundary conditions for a zone of this type.
intake_fan(*args, **kwargs)	Show boundary conditions for a zone of this type.
interface(*args, **kwargs)	Show boundary conditions for a zone of this type.
interior(*args, **kwargs)	Show boundary conditions for a zone of this type.
list_boundary_conditions(*args, **kwargs)	List boundary conditions.
list_cell_zone_conditions(*args, **kwargs)	List cell zone conditions.
list_named_selection(*args, **kwargs)	List named selection of zone type.
list_queries(*args, **kwargs)	List all saved queries.
mass_flow_inlet(*args, **kwargs)	Show boundary conditions for a zone of this type.
mass_flow_outlet(*args, **kwargs)	Show boundary conditions for a zone of this type.
named_zone_list(*args, **kwargs)	Create named list of zones.
network(*args, **kwargs)	Show boundary conditions for a zone of this type.
network_end(*args, **kwargs)	Show boundary conditions for a zone of this type.
outflow(*args, **kwargs)	Show boundary conditions for a zone of this type.
outlet_vent(*args, **kwargs)	Show boundary conditions for a zone of this type.
overset(*args, **kwargs)	Show boundary conditions for a zone of this type.
periodic(*args, **kwargs)	Show boundary conditions for a zone of this type.
porous_jump(*args, **kwargs)	Show boundary conditions for a zone of this type.
pressure_far_field(*args, **kwargs)	Show boundary conditions for a zone of this type.
pressure_inlet(*args, **kwargs)	Show boundary conditions for a zone of this type.
pressure_outlet(*args, **kwargs)	Show boundary conditions for a zone of this type.
radiator(*args, **kwargs)	Show boundary conditions for a zone of this type.
rans_les_interface(*args, **kwargs)	Show boundary conditions for a zone of this type.
recirculation_inlet(*args, **kwargs)	Show boundary conditions for a zone of this type.
recirculation_outlet(*args, **kwargs)	Show boundary conditions for a zone of this type.
shadow(*args, **kwargs)	Show boundary conditions for a zone of this type.
solid(*args, **kwargs)	Show boundary conditions for a zone of this type.
symmetry(*args, **kwargs)	Show boundary conditions for a zone of this type.
velocity_inlet(*args, **kwargs)	Show boundary conditions for a zone of this type.
wall(*args, **kwargs)	Show boundary conditions for a zone of this type.

axis(*args, **kwargs)#

Show boundary conditions for a zone of this type.

degassing(*args, **kwargs)#

Show boundary conditions for a zone of this type.

delete_query(*args, **kwargs)#

Delete saved query.

exhaust_fan(*args, **kwargs)#

Show boundary conditions for a zone of this type.

fan(*args, **kwargs)#

Show boundary conditions for a zone of this type.

fluid(*args, **kwargs)#

Show boundary conditions for a zone of this type.

geometry(*args, **kwargs)#

Show boundary conditions for a zone of this type.

inlet_vent(*args, **kwargs)#

Show boundary conditions for a zone of this type.

intake_fan(*args, **kwargs)#

Show boundary conditions for a zone of this type.

interface(*args, **kwargs)#

Show boundary conditions for a zone of this type.

interior(*args, **kwargs)#

Show boundary conditions for a zone of this type.

list_boundary_conditions(*args, **kwargs)#

List boundary conditions.

list_cell_zone_conditions(*args, **kwargs)#

List cell zone conditions.

list_named_selection(*args, **kwargs)#

List named selection of zone type.

list_queries(*args, **kwargs)#

List all saved queries.

mass_flow_inlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

mass_flow_outlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

named_zone_list(*args, **kwargs)#

Create named list of zones.

network(*args, **kwargs)#

Show boundary conditions for a zone of this type.

network_end(*args, **kwargs)#

Show boundary conditions for a zone of this type.

outflow(*args, **kwargs)#

Show boundary conditions for a zone of this type.

outlet_vent(*args, **kwargs)#

Show boundary conditions for a zone of this type.

overset(*args, **kwargs)#

Show boundary conditions for a zone of this type.

periodic(*args, **kwargs)#

Show boundary conditions for a zone of this type.

porous_jump(*args, **kwargs)#

Show boundary conditions for a zone of this type.

pressure_far_field(*args, **kwargs)#

Show boundary conditions for a zone of this type.

pressure_inlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

pressure_outlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

radiator(*args, **kwargs)#

Show boundary conditions for a zone of this type.

rans_les_interface(*args, **kwargs)#

Show boundary conditions for a zone of this type.

recirculation_inlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

recirculation_outlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

shadow(*args, **kwargs)#

Show boundary conditions for a zone of this type.

solid(*args, **kwargs)#

Show boundary conditions for a zone of this type.

symmetry(*args, **kwargs)#

Show boundary conditions for a zone of this type.

velocity_inlet(*args, **kwargs)#

Show boundary conditions for a zone of this type.

wall(*args, **kwargs)#

Show boundary conditions for a zone of this type.

radiator(*args, **kwargs)#

Set boundary conditions for a zone of this type.

rans_les_interface(*args, **kwargs)#

Set boundary conditions for a zone of this type.

recirculation_inlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

recirculation_outlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

shadow(*args, **kwargs)#

Set boundary conditions for a zone of this type.

solid(*args, **kwargs)#

Set boundary conditions for a zone of this type.

symmetry(*args, **kwargs)#

Set boundary conditions for a zone of this type.

velocity_inlet(*args, **kwargs)#

Set boundary conditions for a zone of this type.

wall(*args, **kwargs)#

Set boundary conditions for a zone of this type.

class solution(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

calculation_activity(service, version, mode, ...)	.
cell_registers(service, version, mode, path)	.
controls(service, version, mode, path)	.
initialization(service, version, mode, path)	.
methods(service, version, mode, path)	.
monitor(service, version, mode, path)	.
report_definitions(service, version, mode, path)	.
run_calculation(service, version, mode, path)	.

class calculation_activity(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

continue_strategy_execution(*args, **kwargs)	.
copy_modification(*args, **kwargs)	.
delete_modification(*args, **kwargs)	.
disable_modification(*args, **kwargs)	.
enable_modification(*args, **kwargs)	.
enable_strategy(*args, **kwargs)	.
export_modifications(*args, **kwargs)	.
import_modifications(*args, **kwargs)	.

Classes:

execute_commands(service, version, mode, path)	.
poor_mesh_numerics(service, version, mode, path)	.
solution_animations(service, version, mode, path)	.

continue_strategy_execution(*args, **kwargs)#

.

copy_modification(*args, **kwargs)#

.

delete_modification(*args, **kwargs)#

.

disable_modification(*args, **kwargs)#

.

enable_modification(*args, **kwargs)#

.

enable_strategy(*args, **kwargs)#

.

class execute_commands(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

copy(*args, **kwargs)	.
delete(*args, **kwargs)	.
disable(*args, **kwargs)	.
enable(*args, **kwargs)	.
export(*args, **kwargs)	.
import_(*args, **kwargs)	.

copy(*args, **kwargs)#

.

delete(*args, **kwargs)#

.

disable(*args, **kwargs)#

.

enable(*args, **kwargs)#

.

export(*args, **kwargs)#

.

import_(*args, **kwargs)#

.

export_modifications(*args, **kwargs)#

.

import_modifications(*args, **kwargs)#

.

class poor_mesh_numerics(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

register_based(service, version, mode, path)

.

class register_based(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Add a new definition for poor mesh numerics.
delete(*args, **kwargs)	Delete a definition for poor mesh numerics.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit a definition for poor mesh numerics.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename register-based object.
set(*args, **kwargs)	.

create(*args, **kwargs)#

Add a new definition for poor mesh numerics.

delete(*args, **kwargs)#

Delete a definition for poor mesh numerics.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit a definition for poor mesh numerics.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename register-based object.

set(*args, **kwargs)#

.

class solution_animations(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

add_to_graphics(*args, **kwargs)	.
clear_history(*args, **kwargs)	.
copy(*args, **kwargs)	.
create(*args, **kwargs)	Create a new solution-animations object.
delete(*args, **kwargs)	Delete solution-animations object.
display(*args, **kwargs)	.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit solution-animations object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename solution-animations object.

add_to_graphics(*args, **kwargs)#

.

clear_history(*args, **kwargs)#

.

copy(*args, **kwargs)#

.

create(*args, **kwargs)#

Create a new solution-animations object.

delete(*args, **kwargs)#

Delete solution-animations object.

display(*args, **kwargs)#

.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit solution-animations object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename solution-animations object.

class cell_registers(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new cell-registers object.
delete(*args, **kwargs)	Delete cell-registers object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit cell-registers object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename cell-registers object.

create(*args, **kwargs)#

Create a new cell-registers object.

delete(*args, **kwargs)#

Delete cell-registers object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit cell-registers object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename cell-registers object.

class controls(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

acoustics_wave_eqn_controls(service, ...)	.
advanced(service, version, mode, path)	.
contact_solution_controls(service, version, ...)	.
equations(service, version, mode, path)	.
limits(service, version, mode, path)	.
p_v_controls(service, version, mode, path)	.
pseudo_time_explicit_relaxation_factor(...)	.
pseudo_time_method_local_time_step(service, ...)	.
relaxation_factor(service, version, mode, path)	.
under_relaxation(service, version, mode, path)	.

Methods:

courant_number(*args, **kwargs)	.
reset_amg_controls(*args, **kwargs)	.
reset_limits(*args, **kwargs)	.
reset_multi_stage_parameters(*args, **kwargs)	.
reset_pseudo_time_method_equations(*args, ...)	.
reset_pseudo_time_method_generic(*args, **kwargs)	.
reset_pseudo_time_method_relaxations(*args, ...)	.
reset_pseudo_time_method_scale_factors(...)	.
reset_solution_controls(*args, **kwargs)	.

class acoustics_wave_eqn_controls(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

expert(service, version, mode, path)

.

Methods:

max_iter_per_timestep_count(*args, **kwargs)	.
relative_convergence_criterion(*args, **kwargs)	.

class expert(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

explicit_relaxation_factor(*args, **kwargs)	.
under_relaxation_factor(*args, **kwargs)	.

explicit_relaxation_factor(*args, **kwargs)#

.

under_relaxation_factor(*args, **kwargs)#

.

max_iter_per_timestep_count(*args, **kwargs)#

.

relative_convergence_criterion(*args, **kwargs)#

.

class advanced(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

anisotropic_solid_heat_transfer(service, ...)	.
correction_tolerance(service, version, mode, ...)	.
expert(service, version, mode, path)	.
fast_transient_settings(service, version, ...)	.
multi_grid(service, version, mode, path)	.
multi_stage(service, version, mode, path)	.

Methods:

relaxation_method(*args, **kwargs)

.

class anisotropic_solid_heat_transfer(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

flux(*args, **kwargs)	.
gradient(*args, **kwargs)	.

flux(*args, **kwargs)#

.

gradient(*args, **kwargs)#

.

class correction_tolerance(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new correction-tolerance object.
delete(*args, **kwargs)	Delete correction-tolerance object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit correction-tolerance object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename correction-tolerance object.

create(*args, **kwargs)#

Create a new correction-tolerance object.

delete(*args, **kwargs)#

Delete correction-tolerance object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit correction-tolerance object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename correction-tolerance object.

class expert(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

pseudo_time_method_usage(service, version, ...)	.
spatial_discretization_limiter(service, ...)	.

class pseudo_time_method_usage(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

global_dt(service, version, mode, path)	.
local_dt(service, version, mode, path)	.

class global_dt(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new global-dt object.
delete(*args, **kwargs)	Delete global-dt object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit global-dt object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename global-dt object.

create(*args, **kwargs)#

Create a new global-dt object.

delete(*args, **kwargs)#

Delete global-dt object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit global-dt object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename global-dt object.

class local_dt(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new local-dt object.
delete(*args, **kwargs)	Delete local-dt object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit local-dt object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename local-dt object.

create(*args, **kwargs)#

Create a new local-dt object.

delete(*args, **kwargs)#

Delete local-dt object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit local-dt object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename local-dt object.

class spatial_discretization_limiter(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

cell_to_limiting(*args, **kwargs)	.
limiter_filter(*args, **kwargs)	.
limiter_type(*args, **kwargs)	.

cell_to_limiting(*args, **kwargs)#

.

limiter_filter(*args, **kwargs)#

.

limiter_type(*args, **kwargs)#

.

class fast_transient_settings(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

runge_kutta(service, version, mode, path)

.

class runge_kutta(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

default_multi_stage(*args, **kwargs)	.
two_stage(*args, **kwargs)	.

default_multi_stage(*args, **kwargs)#

.

two_stage(*args, **kwargs)#

.

class multi_grid(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

amg_controls(service, version, mode, path)	.
amg_gpgpu_options(service, version, mode, path)	.
fas_mg_controls(service, version, mode, path)	.
mg_controls(service, version, mode, path)	.

class amg_controls(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

coupled_parameters(service, version, mode, path)	.
flexible_cycle_parameters(service, version, ...)	.
options(service, version, mode, path)	.
scalar_parameters(service, version, mode, path)	.

class coupled_parameters(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

coarsening_parameters(service, version, ...)	.
fixed_cycle_parameters(service, version, ...)	.

Methods:

smoother_type(*args, **kwargs)

.

class coarsening_parameters(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

aggressive_coarsening(*args, **kwargs)	.
coarsen_by_interval(*args, **kwargs)	.
conservative_coarsening(*args, **kwargs)	.
laplace_coarsening(*args, **kwargs)	.
max_coarse_levels(*args, **kwargs)	.

aggressive_coarsening(*args, **kwargs)#

.

coarsen_by_interval(*args, **kwargs)#

.

conservative_coarsening(*args, **kwargs)#

.

laplace_coarsening(*args, **kwargs)#

.

max_coarse_levels(*args, **kwargs)#

.

class fixed_cycle_parameters(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

max_cycle(*args, **kwargs)	.
post_sweeps(*args, **kwargs)	.
pre_sweeps(*args, **kwargs)	.

max_cycle(*args, **kwargs)#

.

post_sweeps(*args, **kwargs)#

.

pre_sweeps(*args, **kwargs)#

.

smoother_type(*args, **kwargs)#

.

class flexible_cycle_parameters(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

max_coarse_relaxations(*args, **kwargs)	.
max_fine_relaxations(*args, **kwargs)	.

max_coarse_relaxations(*args, **kwargs)#

.

max_fine_relaxations(*args, **kwargs)#

.

class options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

verbosity(*args, **kwargs)

.

verbosity(*args, **kwargs)#

.

class scalar_parameters(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

coarsening_parameters(service, version, ...)	.
fixed_cycle_parameters(service, version, ...)	.

Methods:

smoother_type(*args, **kwargs)

.

class coarsening_parameters(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

aggressive_coarsening(*args, **kwargs)	.
coarsen_by_interval(*args, **kwargs)	.
conservative_coarsening(*args, **kwargs)	.
laplace_coarsening(*args, **kwargs)	.
max_coarse_levels(*args, **kwargs)	.

aggressive_coarsening(*args, **kwargs)#

.

coarsen_by_interval(*args, **kwargs)#

.

conservative_coarsening(*args, **kwargs)#

.

laplace_coarsening(*args, **kwargs)#

.

max_coarse_levels(*args, **kwargs)#

.

class fixed_cycle_parameters(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

max_cycle(*args, **kwargs)	.
post_sweeps(*args, **kwargs)	.
pre_sweeps(*args, **kwargs)	.

max_cycle(*args, **kwargs)#

.

post_sweeps(*args, **kwargs)#

.

pre_sweeps(*args, **kwargs)#

.

smoother_type(*args, **kwargs)#

.

class amg_gpgpu_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new amg-gpgpu-options object.
delete(*args, **kwargs)	Delete amg-gpgpu-options object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit amg-gpgpu-options object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename amg-gpgpu-options object.

create(*args, **kwargs)#

Create a new amg-gpgpu-options object.

delete(*args, **kwargs)#

Delete amg-gpgpu-options object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit amg-gpgpu-options object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename amg-gpgpu-options object.

class fas_mg_controls(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

coarsening_parameters(service, version, ...)	.
fixed_cycle_parameters(service, version, ...)	.
options(service, version, mode, path)	.
relaxation_factor(service, version, mode, path)	.

class coarsening_parameters(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

coarsen_by_interval(*args, **kwargs)	.
max_coarse_levels(*args, **kwargs)	.

coarsen_by_interval(*args, **kwargs)#

.

max_coarse_levels(*args, **kwargs)#

.

class fixed_cycle_parameters(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

post_sweeps(*args, **kwargs)	.
pre_sweeps(*args, **kwargs)	.

post_sweeps(*args, **kwargs)#

.

pre_sweeps(*args, **kwargs)#

.

class options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

verbosity(*args, **kwargs)

.

verbosity(*args, **kwargs)#

.

class relaxation_factor(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

correction_reduction(*args, **kwargs)	.
correction_smoothing(*args, **kwargs)	.
courant_number_reduction(*args, **kwargs)	.
species_correction_reduction(*args, **kwargs)	.

correction_reduction(*args, **kwargs)#

.

correction_smoothing(*args, **kwargs)#

.

courant_number_reduction(*args, **kwargs)#

.

species_correction_reduction(*args, **kwargs)#

.

class mg_controls(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new mg-controls object.
delete(*args, **kwargs)	Delete mg-controls object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit mg-controls object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename mg-controls object.

create(*args, **kwargs)#

Create a new mg-controls object.

delete(*args, **kwargs)#

Delete mg-controls object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit mg-controls object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename mg-controls object.

class multi_stage(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

edit(*args, **kwargs)	Edit multi-stage object.
list_properties(*args, **kwargs)	.
number_of_objects(*args, **kwargs)	Set number of objects for multi-stage.

edit(*args, **kwargs)#

Edit multi-stage object.

list_properties(*args, **kwargs)#

.

number_of_objects(*args, **kwargs)#

Set number of objects for multi-stage.

relaxation_method(*args, **kwargs)#

.

class contact_solution_controls(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

amg(service, version, mode, path)	.
methods(service, version, mode, path)	.
miscellaneous(service, version, mode, path)	.
models(service, version, mode, path)	.
parameters(service, version, mode, path)	.
spatial(service, version, mode, path)	.
transient(service, version, mode, path)	.

Methods:

set_settings_to_default(*args, **kwargs)	.
solution_stabilization(*args, **kwargs)	.
verbosity(*args, **kwargs)	.

class amg(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

coarsen_rate(*args, **kwargs)	.
enforce_laplace_coarsening(*args, **kwargs)	.
increase_pre_sweeps(*args, **kwargs)	.
pre_sweeps(*args, **kwargs)	.
specify_coarsening_rate(*args, **kwargs)	.

coarsen_rate(*args, **kwargs)#

.

enforce_laplace_coarsening(*args, **kwargs)#

.

increase_pre_sweeps(*args, **kwargs)#

.

pre_sweeps(*args, **kwargs)#

.

specify_coarsening_rate(*args, **kwargs)#

.

class methods(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

gradient_controls(*args, **kwargs)	.
pv_coupling_controls(*args, **kwargs)	.
pv_coupling_method(*args, **kwargs)	.
specify_gradient_method(*args, **kwargs)	.

gradient_controls(*args, **kwargs)#

.

pv_coupling_controls(*args, **kwargs)#

.

pv_coupling_method(*args, **kwargs)#

.

specify_gradient_method(*args, **kwargs)#

.

class miscellaneous(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

compute_statistics(*args, **kwargs)	.
statistics_level(*args, **kwargs)	.

compute_statistics(*args, **kwargs)#

.

statistics_level(*args, **kwargs)#

.

class models(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

model_ramping(*args, **kwargs)	.
ramp_flow(*args, **kwargs)	.
ramp_scalars(*args, **kwargs)	.
ramp_turbulence(*args, **kwargs)	.

model_ramping(*args, **kwargs)#

.

ramp_flow(*args, **kwargs)#

.

ramp_scalars(*args, **kwargs)#

.

ramp_turbulence(*args, **kwargs)#

.

class parameters(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

extrapolation_method(*args, **kwargs)	.
iter_count(*args, **kwargs)	.
persistence_fixed_duration(*args, **kwargs)	.
persistence_fixed_time_steps(*args, **kwargs)	.
solution_stabilization_persistence(*args, ...)	.

extrapolation_method(*args, **kwargs)#

.

iter_count(*args, **kwargs)#

.

persistence_fixed_duration(*args, **kwargs)#

.

persistence_fixed_time_steps(*args, **kwargs)#

.

solution_stabilization_persistence(*args, **kwargs)#

.

set_settings_to_default(*args, **kwargs)#

.

solution_stabilization(*args, **kwargs)#

.

class spatial(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

first_to_second_order_blending(*args, **kwargs)	.
first_to_second_order_blending_list(*args, ...)	.
flow_skew_diffusion_exclude(*args, **kwargs)	.
rhie_chow_flux_specify(*args, **kwargs)	.
rhie_chow_method(*args, **kwargs)	.
scalars_skew_diffusion_exclude(*args, **kwargs)	.
scheme(*args, **kwargs)	.

first_to_second_order_blending(*args, **kwargs)#

.

first_to_second_order_blending_list(*args, **kwargs)#

.

flow_skew_diffusion_exclude(*args, **kwargs)#

.

rhie_chow_flux_specify(*args, **kwargs)#

.

rhie_chow_method(*args, **kwargs)#

.

scalars_skew_diffusion_exclude(*args, **kwargs)#

.

scheme(*args, **kwargs)#

.

class transient(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

time_scale_modification_factor(*args, **kwargs)	.
time_scale_modification_method(*args, **kwargs)	.
transient_parameters_specify(*args, **kwargs)	.
transient_scheme(*args, **kwargs)	.

time_scale_modification_factor(*args, **kwargs)#

.

time_scale_modification_method(*args, **kwargs)#

.

transient_parameters_specify(*args, **kwargs)#

.

transient_scheme(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

.

courant_number(*args, **kwargs)#

.

class equations(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new equations object.
delete(*args, **kwargs)	Delete equations object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit equations object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename equations object.

create(*args, **kwargs)#

Create a new equations object.

delete(*args, **kwargs)#

Delete equations object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit equations object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename equations object.

class limits(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

max_pressure(*args, **kwargs)	.
max_temperature(*args, **kwargs)	.
max_turb_visc_ratio(*args, **kwargs)	.
min_des_epsilon(*args, **kwargs)	.
min_des_omega(*args, **kwargs)	.
min_des_tke(*args, **kwargs)	.
min_elliptic_relax_func(*args, **kwargs)	.
min_epsilon(*args, **kwargs)	.
min_lam_tke(*args, **kwargs)	.
min_omega(*args, **kwargs)	.
min_pressure(*args, **kwargs)	.
min_temperature(*args, **kwargs)	.
min_tke(*args, **kwargs)	.
min_v2f_epsilon(*args, **kwargs)	.
min_v2f_tke(*args, **kwargs)	.
min_vel_var_scale(*args, **kwargs)	.
min_vol_frac_for_matrix_sol(*args, **kwargs)	.
positivity_rate(*args, **kwargs)	.

max_pressure(*args, **kwargs)#

.

max_temperature(*args, **kwargs)#

.

max_turb_visc_ratio(*args, **kwargs)#

.

min_des_epsilon(*args, **kwargs)#

.

min_des_omega(*args, **kwargs)#

.

min_des_tke(*args, **kwargs)#

.

min_elliptic_relax_func(*args, **kwargs)#

.

min_epsilon(*args, **kwargs)#

.

min_lam_tke(*args, **kwargs)#

.

min_omega(*args, **kwargs)#

.

min_pressure(*args, **kwargs)#

.

min_temperature(*args, **kwargs)#

.

min_tke(*args, **kwargs)#

.

min_v2f_epsilon(*args, **kwargs)#

.

min_v2f_tke(*args, **kwargs)#

.

min_vel_var_scale(*args, **kwargs)#

.

min_vol_frac_for_matrix_sol(*args, **kwargs)#

.

positivity_rate(*args, **kwargs)#

.

class p_v_controls(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

explicit_momentum_under_relaxation(*args, ...)	.
explicit_pressure_under_relaxation(*args, ...)	.
explicit_volume_fraction_under_relaxation(...)	.
flow_courant_number(*args, **kwargs)	.
neighbor_correction_itr_count(*args, **kwargs)	.
skewness_correction_itr_count(*args, **kwargs)	.
skewness_neighbor_coupling(*args, **kwargs)	.
vof_correction_itr_count(*args, **kwargs)	.
volume_fraction_courant_number(*args, **kwargs)	.

explicit_momentum_under_relaxation(*args, **kwargs)#

.

explicit_pressure_under_relaxation(*args, **kwargs)#

.

explicit_volume_fraction_under_relaxation(*args, **kwargs)#

.

flow_courant_number(*args, **kwargs)#

.

neighbor_correction_itr_count(*args, **kwargs)#

.

skewness_correction_itr_count(*args, **kwargs)#

.

skewness_neighbor_coupling(*args, **kwargs)#

.

vof_correction_itr_count(*args, **kwargs)#

.

volume_fraction_courant_number(*args, **kwargs)#

.

class pseudo_time_explicit_relaxation_factor(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

global_dt_pseudo_relax(service, version, ...)	.
local_dt_dualts_relax(service, version, ...)	.

class global_dt_pseudo_relax(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new global-dt-pseudo-relax object.
delete(*args, **kwargs)	Delete global-dt-pseudo-relax object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit global-dt-pseudo-relax object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename global-dt-pseudo-relax object.

create(*args, **kwargs)#

Create a new global-dt-pseudo-relax object.

delete(*args, **kwargs)#

Delete global-dt-pseudo-relax object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit global-dt-pseudo-relax object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename global-dt-pseudo-relax object.

class local_dt_dualts_relax(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new local-dt-dualts-relax object.
delete(*args, **kwargs)	Delete local-dt-dualts-relax object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit local-dt-dualts-relax object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename local-dt-dualts-relax object.

create(*args, **kwargs)#

Create a new local-dt-dualts-relax object.

delete(*args, **kwargs)#

Delete local-dt-dualts-relax object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit local-dt-dualts-relax object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename local-dt-dualts-relax object.

class pseudo_time_method_local_time_step(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

pseudo_time_courant_number(*args, **kwargs)	.
pseudo_time_step_method_solid_zone(*args, ...)	.
time_step_size_scale_factor(*args, **kwargs)	.

pseudo_time_courant_number(*args, **kwargs)#

.

pseudo_time_step_method_solid_zone(*args, **kwargs)#

.

time_step_size_scale_factor(*args, **kwargs)#

.

class relaxation_factor(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new relaxation-factor object.
delete(*args, **kwargs)	Delete relaxation-factor object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit relaxation-factor object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename relaxation-factor object.

create(*args, **kwargs)#

Create a new relaxation-factor object.

delete(*args, **kwargs)#

Delete relaxation-factor object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit relaxation-factor object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename relaxation-factor object.

reset_amg_controls(*args, **kwargs)#

.

reset_limits(*args, **kwargs)#

.

reset_multi_stage_parameters(*args, **kwargs)#

.

reset_pseudo_time_method_equations(*args, **kwargs)#

.

reset_pseudo_time_method_generic(*args, **kwargs)#

.

reset_pseudo_time_method_relaxations(*args, **kwargs)#

.

reset_pseudo_time_method_scale_factors(*args, **kwargs)#

.

reset_solution_controls(*args, **kwargs)#

.

class under_relaxation(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new under-relaxation object.
delete(*args, **kwargs)	Delete under-relaxation object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit under-relaxation object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename under-relaxation object.

create(*args, **kwargs)#

Create a new under-relaxation object.

delete(*args, **kwargs)#

Delete under-relaxation object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit under-relaxation object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename under-relaxation object.

class initialization(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

compute_defaults(*args, **kwargs)	.
dpm_reset(*args, **kwargs)	.
fmg_initialize(*args, **kwargs)	.
hybrid_initialize(*args, **kwargs)	.
init_acoustics_options(*args, **kwargs)	.
init_flow_statistics(*args, **kwargs)	.
init_turb_vel_fluctuations(*args, **kwargs)	.
initialization_type(*args, **kwargs)	.
initialize(*args, **kwargs)	.
levelset_auto_init(*args, **kwargs)	.
list_defaults(*args, **kwargs)	.
lwf_reset(*args, **kwargs)	.
reference_frame(*args, **kwargs)	.
show_iterations_sampled(*args, **kwargs)	.
show_time_sampled(*args, **kwargs)	.
standard_initialize(*args, **kwargs)	.

Classes:

defaults(service, version, mode, path)	.
fmg_initialization(service, version, mode, path)	.
fmg_options(service, version, mode, path)	.
hybrid_init_options(service, version, mode, path)	.
localized_turb_init(service, version, mode, path)	.
open_channel_auto_init(service, version, ...)	.
patch(service, version, mode, path)	.

compute_defaults(*args, **kwargs)#

.

class defaults(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new defaults object.
delete(*args, **kwargs)	Delete defaults object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit defaults object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename defaults object.

create(*args, **kwargs)#

Create a new defaults object.

delete(*args, **kwargs)#

Delete defaults object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit defaults object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename defaults object.

dpm_reset(*args, **kwargs)#

.

class fmg_initialization(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

customize_fmg_initialization(*args, **kwargs)	.
enable_fmg_verbose(*args, **kwargs)	.
fmg_courant_number(*args, **kwargs)	.

customize_fmg_initialization(*args, **kwargs)#

.

enable_fmg_verbose(*args, **kwargs)#

.

fmg_courant_number(*args, **kwargs)#

.

fmg_initialize(*args, **kwargs)#

.

class fmg_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

reset_to_defaults(*args, **kwargs)	.
set_turbulent_viscosity_ratio(*args, **kwargs)	.
species_reactions(*args, **kwargs)	.
viscous_terms(*args, **kwargs)	.

reset_to_defaults(*args, **kwargs)#

.

set_turbulent_viscosity_ratio(*args, **kwargs)#

.

species_reactions(*args, **kwargs)#

.

viscous_terms(*args, **kwargs)#

.

class hybrid_init_options(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

general_settings(service, version, mode, path)	.
species_setting(service, version, mode, path)	.
turbulent_setting(service, version, mode, path)	.

class general_settings(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

const_velocity(*args, **kwargs)	.
explicit_urf(*args, **kwargs)	.
external_aero(*args, **kwargs)	.
initial_pressure(*args, **kwargs)	.
iter_count(*args, **kwargs)	.
reference_frame(*args, **kwargs)	.

const_velocity(*args, **kwargs)#

.

explicit_urf(*args, **kwargs)#

.

external_aero(*args, **kwargs)#

.

initial_pressure(*args, **kwargs)#

.

iter_count(*args, **kwargs)#

.

reference_frame(*args, **kwargs)#

.

class species_setting(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

species(service, version, mode, path)

.

Methods:

user_specified_species(*args, **kwargs)

.

class species(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new species object.
delete(*args, **kwargs)	Delete species object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit species object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename species object.

create(*args, **kwargs)#

Create a new species object.

delete(*args, **kwargs)#

Delete species object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit species object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename species object.

user_specified_species(*args, **kwargs)#

.

class turbulent_setting(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

averaged_turbulent_parameters(*args, **kwargs)	.
turbulent_intensity(*args, **kwargs)	.
viscosity_ratio(*args, **kwargs)	.

averaged_turbulent_parameters(*args, **kwargs)#

.

turbulent_intensity(*args, **kwargs)#

.

viscosity_ratio(*args, **kwargs)#

.

hybrid_initialize(*args, **kwargs)#

.

init_acoustics_options(*args, **kwargs)#

.

init_flow_statistics(*args, **kwargs)#

.

init_turb_vel_fluctuations(*args, **kwargs)#

.

initialization_type(*args, **kwargs)#

.

initialize(*args, **kwargs)#

.

levelset_auto_init(*args, **kwargs)#

.

list_defaults(*args, **kwargs)#

.

class localized_turb_init(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

enabled(*args, **kwargs)	.
turbulent_intensity(*args, **kwargs)	.
turbulent_viscosity_ratio(*args, **kwargs)	.

enabled(*args, **kwargs)#

.

turbulent_intensity(*args, **kwargs)#

.

turbulent_viscosity_ratio(*args, **kwargs)#

.

lwf_reset(*args, **kwargs)#

.

class open_channel_auto_init(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

boundary_thread(*args, **kwargs)	.
flat_init(*args, **kwargs)	.
wavy_surface_init(*args, **kwargs)	.

boundary_thread(*args, **kwargs)#

.

flat_init(*args, **kwargs)#

.

wavy_surface_init(*args, **kwargs)#

.

class patch(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

calculate_patch(*args, **kwargs)

.

Classes:

vof_smooth_options(service, version, mode, path)

.

calculate_patch(*args, **kwargs)#

.

class vof_smooth_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

execute_smoothing(*args, **kwargs)	.
patch_reconstructed_interface(*args, **kwargs)	.
smoothing_relaxation_factor(*args, **kwargs)	.
use_volumetric_smoothing(*args, **kwargs)	.

execute_smoothing(*args, **kwargs)#

.

patch_reconstructed_interface(*args, **kwargs)#

.

smoothing_relaxation_factor(*args, **kwargs)#

.

use_volumetric_smoothing(*args, **kwargs)#

.

reference_frame(*args, **kwargs)#

.

show_iterations_sampled(*args, **kwargs)#

.

show_time_sampled(*args, **kwargs)#

.

standard_initialize(*args, **kwargs)#

.

class methods(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

accelerated_non_iterative_time_marching(...)	.
frozen_flux(*args, **kwargs)	.
gradient_scheme(*args, **kwargs)	.
nita(*args, **kwargs)	.
reduced_rank_extrapolation(*args, **kwargs)	.
set_solution_methods_to_default(*args, **kwargs)	.
unsteady_1st_order(*args, **kwargs)	.
unsteady_2nd_order(*args, **kwargs)	.
unsteady_2nd_order_bounded(*args, **kwargs)	.
unsteady_global_time(*args, **kwargs)	.

Classes:

convergence_acceleration_for_stretched_meshes(...)	.
discretization_scheme(service, version, ...)	.
expert(service, version, mode, path)	.
flux_type(service, version, mode, path)	.
high_order_term_relaxation(service, version, ...)	.
multiphase_numerics(service, version, mode, path)	.
nb_gradient_boundary_option(service, ...)	.
nita_expert_controls(service, version, mode, ...)	.
overset(service, version, mode, path)	.
p_v_coupling(service, version, mode, path)	.
phase_based_vof_discretization(service, ...)	.
pseudo_time_method(service, version, mode, path)	.
reduced_rank_extrapolation_options(service, ...)	.
residual_smoothing(service, version, mode, path)	.
vof_numerics(service, version, mode, path)	.
warped_face_gradient_correction(service, ...)	.

accelerated_non_iterative_time_marching(*args, **kwargs)#

.

class convergence_acceleration_for_stretched_meshes(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

casm_cutoff_multiplier(*args, **kwargs)	.
convergence_acceleration_type(*args, **kwargs)	.

casm_cutoff_multiplier(*args, **kwargs)#

.

convergence_acceleration_type(*args, **kwargs)#

.

class discretization_scheme(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new discretization-scheme object.
delete(*args, **kwargs)	Delete discretization-scheme object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit discretization-scheme object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename discretization-scheme object.

create(*args, **kwargs)#

Create a new discretization-scheme object.

delete(*args, **kwargs)#

Delete discretization-scheme object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit discretization-scheme object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename discretization-scheme object.

class expert(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

numerics_dbns(service, version, mode, path)	.
numerics_pbns(service, version, mode, path)	.

Methods:

reaction_source_term_relaxation_factor(...)	.
reactions(*args, **kwargs)	.

class numerics_dbns(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

first_to_second_order_blending_dbns(*args, ...)

.

first_to_second_order_blending_dbns(*args, **kwargs)#

.

class numerics_pbns(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

alternate_diffusion_for_porous_region_solids(...)	.
disable_rhie_chow_flux(*args, **kwargs)	.
first_to_second_order_blending(*args, **kwargs)	.
implicit_bodyforce_treatment(*args, **kwargs)	.
physical_velocity_formulation(*args, **kwargs)	.
presto_pressure_scheme(*args, **kwargs)	.
velocity_formulation(*args, **kwargs)	.

alternate_diffusion_for_porous_region_solids(*args, **kwargs)#

.

disable_rhie_chow_flux(*args, **kwargs)#

.

first_to_second_order_blending(*args, **kwargs)#

.

implicit_bodyforce_treatment(*args, **kwargs)#

.

physical_velocity_formulation(*args, **kwargs)#

.

presto_pressure_scheme(*args, **kwargs)#

.

velocity_formulation(*args, **kwargs)#

.

reaction_source_term_relaxation_factor(*args, **kwargs)#

.

reactions(*args, **kwargs)#

.

class flux_type(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

dbns_cases(service, version, mode, path)	.
pbns_cases(service, version, mode, path)	.

class dbns_cases(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

flux_type(*args, **kwargs)

.

flux_type(*args, **kwargs)#

.

class pbns_cases(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

flux_auto_select(*args, **kwargs)	.
flux_type(*args, **kwargs)	.

flux_auto_select(*args, **kwargs)#

.

flux_type(*args, **kwargs)#

.

frozen_flux(*args, **kwargs)#

.

gradient_scheme(*args, **kwargs)#

.

class high_order_term_relaxation(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

enable(*args, **kwargs)

.

Classes:

options(service, version, mode, path)

.

enable(*args, **kwargs)#

.

class options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

relaxation_factor(*args, **kwargs)	.
select_variables(*args, **kwargs)	.
type(*args, **kwargs)	.

relaxation_factor(*args, **kwargs)#

.

select_variables(*args, **kwargs)#

.

type(*args, **kwargs)#

.

class multiphase_numerics(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

advanced_stability_controls(service, ...)	.
boiling_parameters(service, version, mode, path)	.
compressible_flow(service, version, mode, path)	.
default_controls(service, version, mode, path)	.
face_pressure_controls(service, version, ...)	.
heat_mass_transfer(service, version, mode, path)	.
porous_media(service, version, mode, path)	.
solution_stabilization(service, version, ...)	.
viscous_flow(service, version, mode, path)	.

class advanced_stability_controls(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

anti_diffusion(service, version, mode, path)	.
equation_order(service, version, mode, path)	.
hybrid_nita(service, version, mode, path)	.
p_v_coupling(service, version, mode, path)	.
pseudo_transient(service, version, mode, path)	.

class anti_diffusion(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

enable_dynamic_strength(*args, **kwargs)	.
set_dynamic_strength_exponent(*args, **kwargs)	.
set_maximum_dynamic_strength(*args, **kwargs)	.

enable_dynamic_strength(*args, **kwargs)#

.

set_dynamic_strength_exponent(*args, **kwargs)#

.

set_maximum_dynamic_strength(*args, **kwargs)#

.

class equation_order(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

solve_exp_vof_at_end(*args, **kwargs)	.
solve_flow_last(*args, **kwargs)	.

solve_exp_vof_at_end(*args, **kwargs)#

.

solve_flow_last(*args, **kwargs)#

.

class hybrid_nita(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

initial_outer_iterations(service, version, ...)	.
instability_detector(service, version, mode, ...)	.

Methods:

outer_iterations(*args, **kwargs)

.

class initial_outer_iterations(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

initial_outer_iter(*args, **kwargs)	.
initial_time_steps(*args, **kwargs)	.

initial_outer_iter(*args, **kwargs)#

.

initial_time_steps(*args, **kwargs)#

.

class instability_detector(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

enable_instability_detector(*args, **kwargs)	.
set_cfl_limit(*args, **kwargs)	.
set_cfl_type(*args, **kwargs)	.
set_velocity_limit(*args, **kwargs)	.
unstable_event_outer_iterations(*args, **kwargs)	.

enable_instability_detector(*args, **kwargs)#

.

set_cfl_limit(*args, **kwargs)#

.

set_cfl_type(*args, **kwargs)#

.

set_velocity_limit(*args, **kwargs)#

.

unstable_event_outer_iterations(*args, **kwargs)#

.

outer_iterations(*args, **kwargs)#

.

class p_v_coupling(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

coupled_vof(service, version, mode, path)	.
rhie_chow_flux(service, version, mode, path)	.
skewness_correction(service, version, mode, path)	.

class coupled_vof(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

blended_treatment_for_buoyancy_forces(*args, ...)	.
buoyancy_force_linearization(*args, **kwargs)	.

blended_treatment_for_buoyancy_forces(*args, **kwargs)#

.

buoyancy_force_linearization(*args, **kwargs)#

.

class rhie_chow_flux(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

low_order_rhie_chow(*args, **kwargs)

.

low_order_rhie_chow(*args, **kwargs)#

.

class skewness_correction(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

limit_pressure_correction_gradient(*args, ...)

.

limit_pressure_correction_gradient(*args, **kwargs)#

.

class pseudo_transient(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

auto_dt_advanced_controls(service, version, ...)

.

Methods:

false_time_step_linearization(*args, **kwargs)	.
num_of_density_smoothing(*args, **kwargs)	.
smoothed_density_stabilization_method(*args, ...)	.

class auto_dt_advanced_controls(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

dt_factor_max(*args, **kwargs)	.
dt_factor_min(*args, **kwargs)	.
dt_init_limit(*args, **kwargs)	.
dt_max(*args, **kwargs)	.
enable(*args, **kwargs)	.
max_velocity_ratio(*args, **kwargs)	.

dt_factor_max(*args, **kwargs)#

.

dt_factor_min(*args, **kwargs)#

.

dt_init_limit(*args, **kwargs)#

.

dt_max(*args, **kwargs)#

.

enable(*args, **kwargs)#

.

max_velocity_ratio(*args, **kwargs)#

.

false_time_step_linearization(*args, **kwargs)#

.

num_of_density_smoothing(*args, **kwargs)#

.

smoothed_density_stabilization_method(*args, **kwargs)#

.

class boiling_parameters(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

liquid_vof_factor(*args, **kwargs)	.
thin_film(*args, **kwargs)	.

liquid_vof_factor(*args, **kwargs)#

.

thin_film(*args, **kwargs)#

.

class compressible_flow(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

alternate_bc_formulation(*args, **kwargs)	.
analytical_thermodynamic_derivatives(*args, ...)	.
enhanced_numerics(*args, **kwargs)	.

alternate_bc_formulation(*args, **kwargs)#

.

analytical_thermodynamic_derivatives(*args, **kwargs)#

.

enhanced_numerics(*args, **kwargs)#

.

class default_controls(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

recommended_defaults_for_existing_cases(...)

.

Classes:

revert_to_pre_r20_point_1_default_settings(...)

.

recommended_defaults_for_existing_cases(*args, **kwargs)#

.

class revert_to_pre_r20_point_1_default_settings(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

old_default_of_operating_density_method(...)	.
old_default_of_volume_fraction_smoothing(...)	.
old_variant_of_pesto_for_cases_using_structured_mesh(...)	.

old_default_of_operating_density_method(*args, **kwargs)#

.

old_default_of_volume_fraction_smoothing(*args, **kwargs)#

.

old_variant_of_pesto_for_cases_using_structured_mesh(*args, **kwargs)#

.

class face_pressure_controls(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

face_pressure_options(service, version, ...)

.

class face_pressure_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

exclude_transient_term_in_face_pressure_calc(...)	.
face_pressure_calculation_method(*args, **kwargs)	.
pressure_corr_grad(*args, **kwargs)	.

exclude_transient_term_in_face_pressure_calc(*args, **kwargs)#

.

face_pressure_calculation_method(*args, **kwargs)#

.

pressure_corr_grad(*args, **kwargs)#

.

class heat_mass_transfer(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

alternative_energy_treatment(*args, **kwargs)

.

Classes:

area_density(service, version, mode, path)	.
boiling(service, version, mode, path)	.
cavitation(service, version, mode, path)	.
evaporation_condensation(service, version, ...)	.

alternative_energy_treatment(*args, **kwargs)#

.

class area_density(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

ia_grad_sym(*args, **kwargs)	.
vof_min_seeding(*args, **kwargs)	.

ia_grad_sym(*args, **kwargs)#

.

vof_min_seeding(*args, **kwargs)#

.

class boiling(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

heat_flux_relaxation_factor(*args, **kwargs)	.
show_expert_options(*args, **kwargs)	.
two_resistance_boiling_framework(*args, **kwargs)	.

heat_flux_relaxation_factor(*args, **kwargs)#

.

show_expert_options(*args, **kwargs)#

.

two_resistance_boiling_framework(*args, **kwargs)#

.

class cavitation(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

display_clipped_pressure(*args, **kwargs)	.
max_vapor_pressure_ratio(*args, **kwargs)	.
min_vapor_pressure(*args, **kwargs)	.
old_treatment_for_turbulent_diffusion(*args, ...)	.
schnerr_cond_coeff(*args, **kwargs)	.
schnerr_evap_coeff(*args, **kwargs)	.
turbulent_diffusion(*args, **kwargs)	.

display_clipped_pressure(*args, **kwargs)#

.

max_vapor_pressure_ratio(*args, **kwargs)#

.

min_vapor_pressure(*args, **kwargs)#

.

old_treatment_for_turbulent_diffusion(*args, **kwargs)#

.

schnerr_cond_coeff(*args, **kwargs)#

.

schnerr_evap_coeff(*args, **kwargs)#

.

turbulent_diffusion(*args, **kwargs)#

.

class evaporation_condensation(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

ia_norm_min_limit(*args, **kwargs)	.
max_rel_humidity(*args, **kwargs)	.
vof_from_max_limit(*args, **kwargs)	.
vof_from_min_limit(*args, **kwargs)	.
vof_to_max_limit(*args, **kwargs)	.
vof_to_min_limit(*args, **kwargs)	.

ia_norm_min_limit(*args, **kwargs)#

.

max_rel_humidity(*args, **kwargs)#

.

vof_from_max_limit(*args, **kwargs)#

.

vof_from_min_limit(*args, **kwargs)#

.

vof_to_max_limit(*args, **kwargs)#

.

vof_to_min_limit(*args, **kwargs)#

.

class porous_media(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

capillary_pressure_as_diffusion(*args, **kwargs)	.
relative_permeability(*args, **kwargs)	.

capillary_pressure_as_diffusion(*args, **kwargs)#

.

relative_permeability(*args, **kwargs)#

.

class solution_stabilization(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

additional_stabilization_controls(service, ...)	.
velocity_limiting_treatment(service, ...)	.

Methods:

execute_additional_stability_controls(*args, ...)	.
execute_advanced_stabilization(*args, **kwargs)	.
execute_settings_optimization(*args, **kwargs)	.

class additional_stabilization_controls(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

blended_compressive_scheme(*args, **kwargs)	.
pseudo_time_stabilization(*args, **kwargs)	.

blended_compressive_scheme(*args, **kwargs)#

.

pseudo_time_stabilization(*args, **kwargs)#

.

execute_additional_stability_controls(*args, **kwargs)#

.

execute_advanced_stabilization(*args, **kwargs)#

.

execute_settings_optimization(*args, **kwargs)#

.

class velocity_limiting_treatment(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

enable_velocity_limiting(*args, **kwargs)	.
set_damping_strength(*args, **kwargs)	.
set_velocity_cutoff(*args, **kwargs)	.
verbosity(*args, **kwargs)	.

Classes:

set_damping_strengths(service, version, ...)	.
set_velocity_and_vof_cutoffs(service, ...)	.

enable_velocity_limiting(*args, **kwargs)#

.

set_damping_strength(*args, **kwargs)#

.

class set_damping_strengths(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new set-damping-strengths object.
delete(*args, **kwargs)	Delete set-damping-strengths object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit set-damping-strengths object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename set-damping-strengths object.

create(*args, **kwargs)#

Create a new set-damping-strengths object.

delete(*args, **kwargs)#

Delete set-damping-strengths object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit set-damping-strengths object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename set-damping-strengths object.

class set_velocity_and_vof_cutoffs(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new set-velocity-and-vof-cutoffs object.
delete(*args, **kwargs)	Delete set-velocity-and-vof-cutoffs object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit set-velocity-and-vof-cutoffs object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename set-velocity-and-vof-cutoffs object.

create(*args, **kwargs)#

Create a new set-velocity-and-vof-cutoffs object.

delete(*args, **kwargs)#

Delete set-velocity-and-vof-cutoffs object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit set-velocity-and-vof-cutoffs object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename set-velocity-and-vof-cutoffs object.

set_velocity_cutoff(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

.

class viscous_flow(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

density_func_expo(*args, **kwargs)	.
density_ratio_cutoff(*args, **kwargs)	.
turb_visc_based_damping(*args, **kwargs)	.
viscosity_averaging(*args, **kwargs)	.

Classes:

interfacial_artificial_viscosity(service, ...)

.

density_func_expo(*args, **kwargs)#

.

density_ratio_cutoff(*args, **kwargs)#

.

class interfacial_artificial_viscosity(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

boundry_treatment(*args, **kwargs)	.
density_func_options(*args, **kwargs)	.
exponent_density_func(*args, **kwargs)	.
exponent_smoothing_func(*args, **kwargs)	.
n_smooth_for_interfacial_regims(*args, **kwargs)	.
near_wall_treatment(*args, **kwargs)	.
sm_relax_factor(*args, **kwargs)	.
viscous_func_options(*args, **kwargs)	.

boundry_treatment(*args, **kwargs)#

.

density_func_options(*args, **kwargs)#

.

exponent_density_func(*args, **kwargs)#

.

exponent_smoothing_func(*args, **kwargs)#

.

n_smooth_for_interfacial_regims(*args, **kwargs)#

.

near_wall_treatment(*args, **kwargs)#

.

sm_relax_factor(*args, **kwargs)#

.

viscous_func_options(*args, **kwargs)#

.

turb_visc_based_damping(*args, **kwargs)#

.

viscosity_averaging(*args, **kwargs)#

.

class nb_gradient_boundary_option(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

nb_gradient(*args, **kwargs)	.
nb_gradient_dbns(*args, **kwargs)	.

nb_gradient(*args, **kwargs)#

.

nb_gradient_dbns(*args, **kwargs)#

.

nita(*args, **kwargs)#

.

class nita_expert_controls(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

hybrid_nita_settings(service, version, mode, ...)

.

Methods:

skewness_neighbor_coupling(*args, **kwargs)	.
verbosity(*args, **kwargs)	.

class hybrid_nita_settings(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

multi_phase_setting(service, version, mode, path)

.

Methods:

single_phase_setting(*args, **kwargs)

.

class multi_phase_setting(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

enable(*args, **kwargs)	.
options(*args, **kwargs)	.

enable(*args, **kwargs)#

.

options(*args, **kwargs)#

.

single_phase_setting(*args, **kwargs)#

.

skewness_neighbor_coupling(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

.

class overset(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

expert(service, version, mode, path)

.

Methods:

high_order_pressure(*args, **kwargs)	.
interpolation_method(*args, **kwargs)	.
orphan_cell_treatment(*args, **kwargs)	.

class expert(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

hybrid_mode_selection(*args, **kwargs)	.
mass_flux_correction_method(*args, **kwargs)	.

hybrid_mode_selection(*args, **kwargs)#

.

mass_flux_correction_method(*args, **kwargs)#

.

high_order_pressure(*args, **kwargs)#

.

interpolation_method(*args, **kwargs)#

.

orphan_cell_treatment(*args, **kwargs)#

.

class p_v_coupling(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

coupled_form(*args, **kwargs)	.
flow_scheme(*args, **kwargs)	.
solve_n_phase(*args, **kwargs)	.

coupled_form(*args, **kwargs)#

.

flow_scheme(*args, **kwargs)#

.

solve_n_phase(*args, **kwargs)#

.

class phase_based_vof_discretization(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new phase-based-vof-discretization object.
delete(*args, **kwargs)	Delete phase-based-vof-discretization object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit phase-based-vof-discretization object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename phase-based-vof-discretization object.

create(*args, **kwargs)#

Create a new phase-based-vof-discretization object.

delete(*args, **kwargs)#

Delete phase-based-vof-discretization object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit phase-based-vof-discretization object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename phase-based-vof-discretization object.

class pseudo_time_method(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

convergence_acceleration_for_stretched_meshes(...)	.
formulation(service, version, mode, path)	.

Methods:

relaxation_bounds(*args, **kwargs)	.
relaxation_method(*args, **kwargs)	.

class convergence_acceleration_for_stretched_meshes(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

casm_cutoff_multiplier(*args, **kwargs)	.
convergence_acceleration_type(*args, **kwargs)	.

casm_cutoff_multiplier(*args, **kwargs)#

.

convergence_acceleration_type(*args, **kwargs)#

.

class formulation(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

coupled_solver(*args, **kwargs)	.
density_based_solver(*args, **kwargs)	.
segregated_solver(*args, **kwargs)	.

coupled_solver(*args, **kwargs)#

.

density_based_solver(*args, **kwargs)#

.

segregated_solver(*args, **kwargs)#

.

relaxation_bounds(*args, **kwargs)#

.

relaxation_method(*args, **kwargs)#

.

reduced_rank_extrapolation(*args, **kwargs)#

.

class reduced_rank_extrapolation_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

skip_iter_count(*args, **kwargs)	.
subspace_size(*args, **kwargs)	.

skip_iter_count(*args, **kwargs)#

.

subspace_size(*args, **kwargs)#

.

class residual_smoothing(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

residual_smoothing_factor(*args, **kwargs)	.
residual_smoothing_iter_count(*args, **kwargs)	.

residual_smoothing_factor(*args, **kwargs)#

.

residual_smoothing_iter_count(*args, **kwargs)#

.

set_solution_methods_to_default(*args, **kwargs)#

.

unsteady_1st_order(*args, **kwargs)#

.

unsteady_2nd_order(*args, **kwargs)#

.

unsteady_2nd_order_bounded(*args, **kwargs)#

.

unsteady_global_time(*args, **kwargs)#

.

class vof_numerics(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

force_treatment_of_unsteady_rc(*args, **kwargs)	.
high_order_rc(*args, **kwargs)	.
high_order_rc_hybrid_treatment(*args, **kwargs)	.
new_framework_for_vof_specific_node_based_treatment(...)	.
unstructured_var_presto_scheme(*args, **kwargs)	.

force_treatment_of_unsteady_rc(*args, **kwargs)#

.

high_order_rc(*args, **kwargs)#

.

high_order_rc_hybrid_treatment(*args, **kwargs)#

.

new_framework_for_vof_specific_node_based_treatment(*args, **kwargs)#

.

unstructured_var_presto_scheme(*args, **kwargs)#

.

class warped_face_gradient_correction(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

enable(*args, **kwargs)	.
turbulence_options(*args, **kwargs)	.

enable(*args, **kwargs)#

.

turbulence_options(*args, **kwargs)#

.

class monitor(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

convergence_conditions(service, version, ...)	.
report_files(service, version, mode, path)	.
report_plots(service, version, mode, path)	.

class convergence_conditions(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

check_for(*args, **kwargs)	.
condition(*args, **kwargs)	.
frequency(*args, **kwargs)	.

Classes:

convergence_reports(service, version, mode, path)

.

check_for(*args, **kwargs)#

.

condition(*args, **kwargs)#

.

class convergence_reports(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new convergence-reports object.
delete(*args, **kwargs)	Delete convergence-reports object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit convergence-reports object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename convergence-reports object.

create(*args, **kwargs)#

Create a new convergence-reports object.

delete(*args, **kwargs)#

Delete convergence-reports object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit convergence-reports object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename convergence-reports object.

frequency(*args, **kwargs)#

.

class report_files(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new report-files object.
delete(*args, **kwargs)	Delete report-files object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit report-files object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename report-files object.

create(*args, **kwargs)#

Create a new report-files object.

delete(*args, **kwargs)#

Delete report-files object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit report-files object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename report-files object.

class report_plots(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new report-plots object.
delete(*args, **kwargs)	Delete report-plots object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit report-plots object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename report-plots object.

create(*args, **kwargs)#

Create a new report-plots object.

delete(*args, **kwargs)#

Delete report-plots object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit report-plots object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename report-plots object.

class report_definitions(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

aeromechanics(service, version, mode, path)	.
custom(service, version, mode, path)	.
drag(service, version, mode, path)	.
expression(service, version, mode, path)	.
flux(service, version, mode, path)	.
force(service, version, mode, path)	.
icing(service, version, mode, path)	.
injection(service, version, mode, path)	.
lift(service, version, mode, path)	.
mesh(service, version, mode, path)	.
moment(service, version, mode, path)	.
single_val_expression(service, version, ...)	.
surface(service, version, mode, path)	.
user_defined(service, version, mode, path)	.
volume(service, version, mode, path)	.

Methods:

compute(*args, **kwargs)	.
copy(*args, **kwargs)	.
list(*args, **kwargs)	.

class aeromechanics(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new aeromechanics object.
delete(*args, **kwargs)	Delete aeromechanics object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit aeromechanics object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename aeromechanics object.

create(*args, **kwargs)#

Create a new aeromechanics object.

delete(*args, **kwargs)#

Delete aeromechanics object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit aeromechanics object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename aeromechanics object.

compute(*args, **kwargs)#

.

copy(*args, **kwargs)#

.

class custom(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new custom object.
delete(*args, **kwargs)	Delete custom object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit custom object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename custom object.

create(*args, **kwargs)#

Create a new custom object.

delete(*args, **kwargs)#

Delete custom object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit custom object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename custom object.

class drag(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new drag object.
delete(*args, **kwargs)	Delete drag object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit drag object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename drag object.

create(*args, **kwargs)#

Create a new drag object.

delete(*args, **kwargs)#

Delete drag object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit drag object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename drag object.

class expression(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new expression object.
delete(*args, **kwargs)	Delete expression object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit expression object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename expression object.

create(*args, **kwargs)#

Create a new expression object.

delete(*args, **kwargs)#

Delete expression object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit expression object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename expression object.

class flux(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new flux object.
delete(*args, **kwargs)	Delete flux object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit flux object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename flux object.

create(*args, **kwargs)#

Create a new flux object.

delete(*args, **kwargs)#

Delete flux object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit flux object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename flux object.

class force(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new force object.
delete(*args, **kwargs)	Delete force object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit force object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename force object.

create(*args, **kwargs)#

Create a new force object.

delete(*args, **kwargs)#

Delete force object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit force object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename force object.

class icing(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new icing object.
delete(*args, **kwargs)	Delete icing object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit icing object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename icing object.

create(*args, **kwargs)#

Create a new icing object.

delete(*args, **kwargs)#

Delete icing object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit icing object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename icing object.

class injection(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new injection object.
delete(*args, **kwargs)	Delete injection object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit injection object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename injection object.

create(*args, **kwargs)#

Create a new injection object.

delete(*args, **kwargs)#

Delete injection object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit injection object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename injection object.

class lift(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new lift object.
delete(*args, **kwargs)	Delete lift object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit lift object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename lift object.

create(*args, **kwargs)#

Create a new lift object.

delete(*args, **kwargs)#

Delete lift object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit lift object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename lift object.

list(*args, **kwargs)#

.

class mesh(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new mesh object.
delete(*args, **kwargs)	Delete mesh object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit mesh object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename mesh object.

create(*args, **kwargs)#

Create a new mesh object.

delete(*args, **kwargs)#

Delete mesh object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit mesh object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename mesh object.

class moment(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new moment object.
delete(*args, **kwargs)	Delete moment object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit moment object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename moment object.

create(*args, **kwargs)#

Create a new moment object.

delete(*args, **kwargs)#

Delete moment object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit moment object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename moment object.

class single_val_expression(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new single-val-expression object.
delete(*args, **kwargs)	Delete single-val-expression object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit single-val-expression object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename single-val-expression object.

create(*args, **kwargs)#

Create a new single-val-expression object.

delete(*args, **kwargs)#

Delete single-val-expression object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit single-val-expression object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename single-val-expression object.

class surface(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new surface object.
delete(*args, **kwargs)	Delete surface object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit surface object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename surface object.

create(*args, **kwargs)#

Create a new surface object.

delete(*args, **kwargs)#

Delete surface object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit surface object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename surface object.

class user_defined(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new user-defined object.
delete(*args, **kwargs)	Delete user-defined object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit user-defined object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename user-defined object.

create(*args, **kwargs)#

Create a new user-defined object.

delete(*args, **kwargs)#

Delete user-defined object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit user-defined object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename user-defined object.

class volume(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new volume object.
delete(*args, **kwargs)	Delete volume object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit volume object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename volume object.

create(*args, **kwargs)#

Create a new volume object.

delete(*args, **kwargs)#

Delete volume object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit volume object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename volume object.

class run_calculation(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

adaptive_time_stepping(service, version, ...)	.
cfl_based_adaptive_time_stepping(service, ...)	.
data_sampling(service, version, mode, path)	.
data_sampling_options(service, version, ...)	.
pseudo_time_settings(service, version, mode, ...)	.
transient_controls(service, version, mode, path)	.

Methods:

calculate(*args, **kwargs)	.
dual_time_iterate(*args, **kwargs)	.
interrupt(*args, **kwargs)	.
iter_count(*args, **kwargs)	.
iterate(*args, **kwargs)	.
reporting_interval(*args, **kwargs)	.
residual_verbosity(*args, **kwargs)	.
time_step_count(*args, **kwargs)	.

class adaptive_time_stepping(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

enabled(*args, **kwargs)	.
error_tolerance(*args, **kwargs)	.
fixed_time_step_count(*args, **kwargs)	.
max_step_change_factor(*args, **kwargs)	.
max_time_step(*args, **kwargs)	.
min_step_change_factor(*args, **kwargs)	.
min_time_step(*args, **kwargs)	.
time_end(*args, **kwargs)	.
user_defined_timestep(*args, **kwargs)	.

enabled(*args, **kwargs)#

.

error_tolerance(*args, **kwargs)#

.

fixed_time_step_count(*args, **kwargs)#

.

max_step_change_factor(*args, **kwargs)#

.

max_time_step(*args, **kwargs)#

.

min_step_change_factor(*args, **kwargs)#

.

min_time_step(*args, **kwargs)#

.

time_end(*args, **kwargs)#

.

user_defined_timestep(*args, **kwargs)#

.

calculate(*args, **kwargs)#

.

class cfl_based_adaptive_time_stepping(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

desired_cfl(*args, **kwargs)	.
enalbled(*args, **kwargs)	.
initial_time_step(*args, **kwargs)	.
max_fixed_time_step(*args, **kwargs)	.
max_step_change_factor(*args, **kwargs)	.
max_time_step(*args, **kwargs)	.
min_step_change_factor(*args, **kwargs)	.
min_time_step(*args, **kwargs)	.
time_end(*args, **kwargs)	.
update_interval_time_step_size(*args, **kwargs)	.
user_defined_timestep(*args, **kwargs)	.

desired_cfl(*args, **kwargs)#

.

enalbled(*args, **kwargs)#

.

initial_time_step(*args, **kwargs)#

.

max_fixed_time_step(*args, **kwargs)#

.

max_step_change_factor(*args, **kwargs)#

.

max_time_step(*args, **kwargs)#

.

min_step_change_factor(*args, **kwargs)#

.

min_time_step(*args, **kwargs)#

.

time_end(*args, **kwargs)#

.

update_interval_time_step_size(*args, **kwargs)#

.

user_defined_timestep(*args, **kwargs)#

.

class data_sampling(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

data_sampling(*args, **kwargs)	.
force_statistics(*args, **kwargs)	.
sampling_interval(*args, **kwargs)	.
save_cff_unsteady_statistics(*args, **kwargs)	.
species_list(*args, **kwargs)	.
statistics_heat_flux(*args, **kwargs)	.
statistics_mixture_fraction(*args, **kwargs)	.
statistics_reaction_progress(*args, **kwargs)	.
statistics_shear_stress(*args, **kwargs)	.
time_statistics_dpm(*args, **kwargs)	.
udf_cf_names(*args, **kwargs)	.
wall_statistics(*args, **kwargs)	.

data_sampling(*args, **kwargs)#

.

force_statistics(*args, **kwargs)#

.

sampling_interval(*args, **kwargs)#

.

save_cff_unsteady_statistics(*args, **kwargs)#

.

species_list(*args, **kwargs)#

.

statistics_heat_flux(*args, **kwargs)#

.

statistics_mixture_fraction(*args, **kwargs)#

.

statistics_reaction_progress(*args, **kwargs)#

.

statistics_shear_stress(*args, **kwargs)#

.

time_statistics_dpm(*args, **kwargs)#

.

udf_cf_names(*args, **kwargs)#

.

wall_statistics(*args, **kwargs)#

.

class data_sampling_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

list_datasets(*args, **kwargs)	.
remove_dataset(*args, **kwargs)	.

list_datasets(*args, **kwargs)#

.

remove_dataset(*args, **kwargs)#

.

dual_time_iterate(*args, **kwargs)#

.

interrupt(*args, **kwargs)#

.

iter_count(*args, **kwargs)#

.

iterate(*args, **kwargs)#

.

class pseudo_time_settings(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

time_step_method(service, version, mode, path)

.

Methods:

verbosity(*args, **kwargs)

.

class time_step_method(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

auto_time_size_calc_solid_zone(*args, **kwargs)	.
length_scale(*args, **kwargs)	.
length_scale_methods(*args, **kwargs)	.
pseudo_time_step_size(*args, **kwargs)	.
time_solid_scale_factor(*args, **kwargs)	.
time_step_method(*args, **kwargs)	.
time_step_size_for_solid_zone(*args, **kwargs)	.
time_step_size_scale_factor(*args, **kwargs)	.

auto_time_size_calc_solid_zone(*args, **kwargs)#

.

length_scale(*args, **kwargs)#

.

length_scale_methods(*args, **kwargs)#

.

pseudo_time_step_size(*args, **kwargs)#

.

time_solid_scale_factor(*args, **kwargs)#

.

time_step_method(*args, **kwargs)#

.

time_step_size_for_solid_zone(*args, **kwargs)#

.

time_step_size_scale_factor(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

.

reporting_interval(*args, **kwargs)#

.

residual_verbosity(*args, **kwargs)#

.

time_step_count(*args, **kwargs)#

.

class transient_controls(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

cfl_based_time_stepping(service, version, ...)	.
error_based_time_stepping(service, version, ...)	.
extrapolate_eqn_vars(service, version, mode, ...)	.
fixed_periodic(service, version, mode, path)	.
mp_specific_time_stepping(service, version, ...)	.
multiphase_specific_time_constraints(...)	.
solid_time_step_size(service, version, mode, ...)	.

Methods:

cfl_type(*args, **kwargs)	.
control_time_step_size_variation(*args, **kwargs)	.
duration_specification_method(*args, **kwargs)	.
extrapolate_vars(*args, **kwargs)	.
incremental_time(*args, **kwargs)	.
max_flow_time(*args, **kwargs)	.
max_iter_per_time_step(*args, **kwargs)	.
method(*args, **kwargs)	.
predict_next(*args, **kwargs)	.
rotating_mesh_flow_predictor(*args, **kwargs)	.
solution_status(*args, **kwargs)	.
specified_time_step(*args, **kwargs)	.
time_step_count(*args, **kwargs)	.
time_step_size(*args, **kwargs)	.
time_step_size_for_acoustic_export(*args, ...)	.
total_time(*args, **kwargs)	.
total_time_step_count(*args, **kwargs)	.
type(*args, **kwargs)	.
udf_hook(*args, **kwargs)	.
undo_timestep(*args, **kwargs)	.
use_average_cfl(*args, **kwargs)	.

class cfl_based_time_stepping(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

courant_number(*args, **kwargs)	.
fixed_time_step_size(*args, **kwargs)	.
initial_time_step_size(*args, **kwargs)	.
max_step_change_factor(*args, **kwargs)	.
max_time_step_size(*args, **kwargs)	.
min_step_change_factor(*args, **kwargs)	.
min_time_step_size(*args, **kwargs)	.
update_interval(*args, **kwargs)	.

courant_number(*args, **kwargs)#

.

fixed_time_step_size(*args, **kwargs)#

.

initial_time_step_size(*args, **kwargs)#

.

max_step_change_factor(*args, **kwargs)#

.

max_time_step_size(*args, **kwargs)#

.

min_step_change_factor(*args, **kwargs)#

.

min_time_step_size(*args, **kwargs)#

.

update_interval(*args, **kwargs)#

.

cfl_type(*args, **kwargs)#

.

control_time_step_size_variation(*args, **kwargs)#

.

duration_specification_method(*args, **kwargs)#

.

class error_based_time_stepping(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

error_tolerance(*args, **kwargs)	.
fixed_time_step_size(*args, **kwargs)	.
initial_time_step_size(*args, **kwargs)	.
max_step_change_factor(*args, **kwargs)	.
max_time_step_size(*args, **kwargs)	.
min_step_change_factor(*args, **kwargs)	.
min_time_step_size(*args, **kwargs)	.
update_interval(*args, **kwargs)	.

error_tolerance(*args, **kwargs)#

.

fixed_time_step_size(*args, **kwargs)#

.

initial_time_step_size(*args, **kwargs)#

.

max_step_change_factor(*args, **kwargs)#

.

max_time_step_size(*args, **kwargs)#

.

min_step_change_factor(*args, **kwargs)#

.

min_time_step_size(*args, **kwargs)#

.

update_interval(*args, **kwargs)#

.

class extrapolate_eqn_vars(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

create(*args, **kwargs)	Create a new extrapolate-eqn-vars object.
delete(*args, **kwargs)	Delete extrapolate-eqn-vars object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit extrapolate-eqn-vars object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
rename(*args, **kwargs)	Rename extrapolate-eqn-vars object.

create(*args, **kwargs)#

Create a new extrapolate-eqn-vars object.

delete(*args, **kwargs)#

Delete extrapolate-eqn-vars object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit extrapolate-eqn-vars object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename extrapolate-eqn-vars object.

extrapolate_vars(*args, **kwargs)#

.

class fixed_periodic(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

fixed_periodic(*args, **kwargs)	.
fixed_periodic_type(*args, **kwargs)	.
fixed_periodic_type_value(*args, **kwargs)	.
times_step_periods(*args, **kwargs)	.
total_period_run(*args, **kwargs)	.

fixed_periodic(*args, **kwargs)#

.

fixed_periodic_type(*args, **kwargs)#

.

fixed_periodic_type_value(*args, **kwargs)#

.

times_step_periods(*args, **kwargs)#

.

total_period_run(*args, **kwargs)#

.

incremental_time(*args, **kwargs)#

.

max_flow_time(*args, **kwargs)#

.

max_iter_per_time_step(*args, **kwargs)#

.

method(*args, **kwargs)#

.

class mp_specific_time_stepping(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

enabled(*args, **kwargs)	.
fixed_time_step_size(*args, **kwargs)	.
global_courant_number(*args, **kwargs)	.
initial_time_step_size(*args, **kwargs)	.
max_step_change_factor(*args, **kwargs)	.
max_time_step_size(*args, **kwargs)	.
min_step_change_factor(*args, **kwargs)	.
min_time_step_size(*args, **kwargs)	.
update_interval(*args, **kwargs)	.

enabled(*args, **kwargs)#

.

fixed_time_step_size(*args, **kwargs)#

.

global_courant_number(*args, **kwargs)#

.

initial_time_step_size(*args, **kwargs)#

.

max_step_change_factor(*args, **kwargs)#

.

max_time_step_size(*args, **kwargs)#

.

min_step_change_factor(*args, **kwargs)#

.

min_time_step_size(*args, **kwargs)#

.

update_interval(*args, **kwargs)#

.

class multiphase_specific_time_constraints(service, version, mode, path)#

Bases: TUIMenu

.

Classes:

moving_mesh_cfl_constraint(service, version, ...)	.
time_scale_options(service, version, mode, path)	.

Methods:

physics_based_constraint(*args, **kwargs)	.
verbosity(*args, **kwargs)	.

class moving_mesh_cfl_constraint(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

mesh_courant_number(*args, **kwargs)	.
moving_mesh_constraint(*args, **kwargs)	.

mesh_courant_number(*args, **kwargs)#

.

moving_mesh_constraint(*args, **kwargs)#

.

physics_based_constraint(*args, **kwargs)#

.

class time_scale_options(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

acoustic_scale(*args, **kwargs)	.
gravity_scale(*args, **kwargs)	.
surface_tension_scale(*args, **kwargs)	.
viscous_scale(*args, **kwargs)	.

acoustic_scale(*args, **kwargs)#

.

gravity_scale(*args, **kwargs)#

.

surface_tension_scale(*args, **kwargs)#

.

viscous_scale(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

.

predict_next(*args, **kwargs)#

.

rotating_mesh_flow_predictor(*args, **kwargs)#

.

class solid_time_step_size(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

choose_auto_time_stepping(*args, **kwargs)	.
enable_solid_time_step(*args, **kwargs)	.
time_step_size(*args, **kwargs)	.

choose_auto_time_stepping(*args, **kwargs)#

.

enable_solid_time_step(*args, **kwargs)#

.

time_step_size(*args, **kwargs)#

.

solution_status(*args, **kwargs)#

.

specified_time_step(*args, **kwargs)#

.

time_step_count(*args, **kwargs)#

.

time_step_size(*args, **kwargs)#

.

time_step_size_for_acoustic_export(*args, **kwargs)#

.

total_time(*args, **kwargs)#

.

total_time_step_count(*args, **kwargs)#

.

type(*args, **kwargs)#

.

udf_hook(*args, **kwargs)#

.

undo_timestep(*args, **kwargs)#

.

use_average_cfl(*args, **kwargs)#

.

class solve(service, version, mode, path)#

Bases: TUIMenu

Enter the solve menu.

Classes:

animate(service, version, mode, path)	Enters the animation menu.
cell_register_operations(service, version, ...)	Enters the cell register operations menu.
cell_registers(service, version, mode, path)	Enters the cell registers menu.
execute_commands(service, version, mode, path)	Enters the execute commands menu.
initialize(service, version, mode, path)	Enters the flow initialization menu.
monitors(service, version, mode, path)	Sets solution monitors.
report_definitions(service, version, mode, path)	Enters the report definitions menu.
report_files(service, version, mode, path)	Enters the report files menu.
report_plots(service, version, mode, path)	Enters the report plots menu.
set(service, version, mode, path)	Enters the set solution parameters menu.

Methods:

convergence_conditions(*args, **kwargs)	Enters the convergence conditions menu.
dpm_update(*args, **kwargs)	Updates discrete phase source terms.
dual_time_iterate(*args, **kwargs)	Performs unsteady iterations for a specified number of time steps.
iterate(*args, **kwargs)	Performs a specified number of iterations.
iterate_steady_2way_fsi(*args, **kwargs)	Perform a specified number of steps.
max_iterations_per_time_step(*args, **kwargs)	Set maximum iterations per time step for transient case.
mesh_motion(*args, **kwargs)	Performs mesh motion.
multistage_time_iterate(*args, **kwargs)	Perform unsteady iterations.
patch(*args, **kwargs)	Patches a value for a flow variable in the domain.
update_physical_time(*args, **kwargs)	Advances the unsteady solution to the next physical time level.

class animate(service, version, mode, path)#

Bases: TUIMenu

Enters the animation menu.

Classes:

define(service, version, mode, path)	Enters the animation definition menu.
inverse_dft(service, version, mode, path)	Reconstruct DFT signal.
objects(service, version, mode, path)	Enters the object manipulation menu.
playback(service, version, mode, path)	Enters the animation playback menu.
pulse(service, version, mode, path)	Enter the pulse animation menu (only available when one or more particle track or pathline graphics objects are defined).

class define(service, version, mode, path)#

Bases: TUIMenu

Enters the animation definition menu.

Methods:

define_monitor(*args, **kwargs)	Defines new animation.
edit_monitor(*args, **kwargs)	Changes animation monitor attributes.

define_monitor(*args, **kwargs)#

Defines new animation.

edit_monitor(*args, **kwargs)#

Changes animation monitor attributes.

class inverse_dft(service, version, mode, path)#

Bases: TUIMenu

Reconstruct DFT signal.

Methods:

run(*args, **kwargs)	Make inverse DFT recontruction.
set(*args, **kwargs)	Set reconstruction parameters.

run(*args, **kwargs)#

Make inverse DFT recontruction.

set(*args, **kwargs)#

Set reconstruction parameters.

class objects(service, version, mode, path)#

Bases: TUIMenu

Enters the object manipulation menu.

Methods:

clear_history(*args, **kwargs)	Clears solution animation object history.
copy(*args, **kwargs)	Copies solution animation object.
create(*args, **kwargs)	Creates new solution animation object.
delete(*args, **kwargs)	Deletes solution animation object.
edit(*args, **kwargs)	Edits solution animation object.
get_window_id(*args, **kwargs)	Get animation object window id.

clear_history(*args, **kwargs)#

Clears solution animation object history.

copy(*args, **kwargs)#

Copies solution animation object.

create(*args, **kwargs)#

Creates new solution animation object.

delete(*args, **kwargs)#

Deletes solution animation object.

edit(*args, **kwargs)#

Edits solution animation object.

get_window_id(*args, **kwargs)#

Get animation object window id.

class playback(service, version, mode, path)#

Bases: TUIMenu

Enters the animation playback menu.

Methods:

delete(*args, **kwargs)	Deletes animation sequence.
play(*args, **kwargs)	Plays the selected animation.
read(*args, **kwargs)	Reads new animation from file or already defined animations.
set_custom_frames(*args, **kwargs)	Specify a custom start frame, increment, and end frame for video export.
stored_view(*args, **kwargs)	Plays the 3D animation sequence using the view stored in the sequence.
write(*args, **kwargs)	Writes animation sequence to the file.

Classes:

video(service, version, mode, path)

Enters the video menu.

delete(*args, **kwargs)#

Deletes animation sequence.

play(*args, **kwargs)#

Plays the selected animation.

read(*args, **kwargs)#

Reads new animation from file or already defined animations.

set_custom_frames(*args, **kwargs)#

Specify a custom start frame, increment, and end frame for video export.

stored_view(*args, **kwargs)#

Plays the 3D animation sequence using the view stored in the sequence.

class video(service, version, mode, path)#

Bases: TUIMenu

Enters the video menu.

Classes:

advance_quality(service, version, mode, path)

Advance Quality setting.

Methods:

format(*args, **kwargs)	Specifies what format the video file will be written in (MP4 | AVI | FLV | MOV | MPEG).
fps(*args, **kwargs)	Sets the target frames per second (FPS) for the saved video file.
height(*args, **kwargs)	Set the height for exporting video file.
name(*args, **kwargs)	Sets the name of the saved video file.
quality(*args, **kwargs)	Set quality for exporting video file.
scale(*args, **kwargs)	Expands or collapses the resolution based on this scaling factor.
set_standard_resolution(*args, **kwargs)	Select from pre-defined resolution list.
use_original_resolution(*args, **kwargs)	Controls whether the resolution of the saved video file matches that of the images used to create it.
width(*args, **kwargs)	Set the width for exporting video file.

class advance_quality(service, version, mode, path)#

Bases: TUIMenu

Advance Quality setting.

Methods:

bitrate(*args, **kwargs)	Set video bitrate(kbits/sec) for exporting video file.
bitrate_scale(*args, **kwargs)	Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000.
compression_method(*args, **kwargs)	Compression methode for Microsoft AVI movie.
enable_h264(*args, **kwargs)	H264 encoding flag.
keyframe(*args, **kwargs)	Set video keyframe rate for exporting video file.

bitrate(*args, **kwargs)#

Set video bitrate(kbits/sec) for exporting video file.

bitrate_scale(*args, **kwargs)#

Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000.

compression_method(*args, **kwargs)#

Compression methode for Microsoft AVI movie.

enable_h264(*args, **kwargs)#

H264 encoding flag.

keyframe(*args, **kwargs)#

Set video keyframe rate for exporting video file.

format(*args, **kwargs)#

Specifies what format the video file will be written in (MP4 | AVI | FLV | MOV | MPEG).

fps(*args, **kwargs)#

Sets the target frames per second (FPS) for the saved video file.

height(*args, **kwargs)#

Set the height for exporting video file.

name(*args, **kwargs)#

Sets the name of the saved video file.

quality(*args, **kwargs)#

Set quality for exporting video file.

scale(*args, **kwargs)#

Expands or collapses the resolution based on this scaling factor.

set_standard_resolution(*args, **kwargs)#

Select from pre-defined resolution list.

use_original_resolution(*args, **kwargs)#

Controls whether the resolution of the saved video file matches that of the images used to create it.

width(*args, **kwargs)#

Set the width for exporting video file.

write(*args, **kwargs)#

Writes animation sequence to the file.

class pulse(service, version, mode, path)#

Bases: TUIMenu

Enter the pulse animation menu (only available when one or more particle track or pathline graphics objects are defined).

Classes:

hardcopy(service, version, mode, path)	Hardcopy options menu.
video(service, version, mode, path)	Enter the video window options menu.

Methods:

pulse_mode(*args, **kwargs)	Set whether the pulse is a single pulse or continuous.
write(*args, **kwargs)	Select a pathline or particle track graphics object, specify whether you want to write a video file or picture files, and enter the destination directory for the files.

class hardcopy(service, version, mode, path)#

Bases: TUIMenu

Hardcopy options menu.

Classes:

color_mode(service, version, mode, path)	Enter the hardcopy color mode menu.
driver(service, version, mode, path)	Enter the set hardcopy driver menu.

Methods:

dpi(*args, **kwargs)	Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height.
invert_background(*args, **kwargs)	Use a white background when the picture is saved.
jpeg_hardcopy_quality(*args, **kwargs)	To set jpeg hardcopy quality.
landscape(*args, **kwargs)	Plot hardcopies in landscape or portrait orientation.
preview(*args, **kwargs)	Display a preview image of a hardcopy.
raytracer_image(*args, **kwargs)	Enable raytracering rendering.
set_standard_resolution(*args, **kwargs)	Select from pre-defined resolution list.
use_window_resolution(*args, **kwargs)	Use the currently active window's resolution for hardcopy (ignores the x-resolution and y-resolution in this case).
x_resolution(*args, **kwargs)	Set the width of raster-formatted images in pixels (0 implies current window size).
y_resolution(*args, **kwargs)	Set the height of raster-formatted images in pixels (0 implies current window size).

class color_mode(service, version, mode, path)#

Bases: TUIMenu

Enter the hardcopy color mode menu.

Methods:

color(*args, **kwargs)	Plot hardcopies in color.
gray_scale(*args, **kwargs)	Convert color to grayscale for hardcopy.
list(*args, **kwargs)	Display the current hardcopy color mode.
mono_chrome(*args, **kwargs)	Convert color to monochrome (black and white) for hardcopy.

color(*args, **kwargs)#

Plot hardcopies in color.

gray_scale(*args, **kwargs)#

Convert color to grayscale for hardcopy.

list(*args, **kwargs)#

Display the current hardcopy color mode.

mono_chrome(*args, **kwargs)#

Convert color to monochrome (black and white) for hardcopy.

dpi(*args, **kwargs)#

Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height.

class driver(service, version, mode, path)#

Bases: TUIMenu

Enter the set hardcopy driver menu.

Methods:

avz(*args, **kwargs)	Use AVZ output for hardcopies.
dump_window(*args, **kwargs)	Set the command used to dump the graphics window to a file.
eps(*args, **kwargs)	Produce encapsulated PostScript (EPS) output for hardcopies.
glb(*args, **kwargs)	Use GLB output for hardcopies.
hsf(*args, **kwargs)	Use HSF output for hardcopies.
jpeg(*args, **kwargs)	Produce JPEG output for hardcopies.
list(*args, **kwargs)	List the current hardcopy driver.
options(*args, **kwargs)	Set the hardcopy options.
png(*args, **kwargs)	Use PNG output for hardcopies.
post_script(*args, **kwargs)	Produce PostScript output for hardcopies.
ppm(*args, **kwargs)	Produce PPM output for hardcopies.
tiff(*args, **kwargs)	Use TIFF output for hardcopies.
vrml(*args, **kwargs)	Use VRML output for hardcopies.

Classes:

post_format(service, version, mode, path)

Enter the PostScript driver format menu.

avz(*args, **kwargs)#

Use AVZ output for hardcopies.

dump_window(*args, **kwargs)#

Set the command used to dump the graphics window to a file.

eps(*args, **kwargs)#

Produce encapsulated PostScript (EPS) output for hardcopies.

glb(*args, **kwargs)#

Use GLB output for hardcopies.

hsf(*args, **kwargs)#

Use HSF output for hardcopies.

jpeg(*args, **kwargs)#

Produce JPEG output for hardcopies.

list(*args, **kwargs)#

List the current hardcopy driver.

options(*args, **kwargs)#

Set the hardcopy options. Available options are: “no gamma correction”, disables gamma correction of colors, “physical size = (width,height)”, where width and height are the actual measurements of the printable area of the page in centimeters. “subscreen = (left,right,bottom,top)”, where left,right, bottom, and top are numbers in [-1,1] describing a subwindow on the page in which to place the hardcopy. The options may be combined by separating them with commas.

png(*args, **kwargs)#

Use PNG output for hardcopies.

class post_format(service, version, mode, path)#

Bases: TUIMenu

Enter the PostScript driver format menu.

Methods:

fast_raster(*args, **kwargs)	Use the new raster format.
raster(*args, **kwargs)	Use the original raster format.
rle_raster(*args, **kwargs)	Use the run-length encoded raster format.
vector(*args, **kwargs)	Use vector format.

fast_raster(*args, **kwargs)#

Use the new raster format.

raster(*args, **kwargs)#

Use the original raster format.

rle_raster(*args, **kwargs)#

Use the run-length encoded raster format.

vector(*args, **kwargs)#

Use vector format.

post_script(*args, **kwargs)#

Produce PostScript output for hardcopies.

ppm(*args, **kwargs)#

Produce PPM output for hardcopies.

tiff(*args, **kwargs)#

Use TIFF output for hardcopies.

vrml(*args, **kwargs)#

Use VRML output for hardcopies.

invert_background(*args, **kwargs)#

Use a white background when the picture is saved.

jpeg_hardcopy_quality(*args, **kwargs)#

To set jpeg hardcopy quality.

landscape(*args, **kwargs)#

Plot hardcopies in landscape or portrait orientation.

preview(*args, **kwargs)#

Display a preview image of a hardcopy.

raytracer_image(*args, **kwargs)#

Enable raytracering rendering.

set_standard_resolution(*args, **kwargs)#

Select from pre-defined resolution list.

use_window_resolution(*args, **kwargs)#

Use the currently active window’s resolution for hardcopy (ignores the x-resolution and y-resolution in this case).

x_resolution(*args, **kwargs)#

Set the width of raster-formatted images in pixels (0 implies current window size).

y_resolution(*args, **kwargs)#

Set the height of raster-formatted images in pixels (0 implies current window size).

pulse_mode(*args, **kwargs)#

Set whether the pulse is a single pulse or continuous.

class video(service, version, mode, path)#

Bases: TUIMenu

Enter the video window options menu.

Classes:

advance_quality(service, version, mode, path)

Advance Quality setting.

Methods:

format(*args, **kwargs)	Set format for exporting video file.
fps(*args, **kwargs)	Set the Frame Per Sec(FPS) for exporting video file.
height(*args, **kwargs)	Set the height for exporting video file.
name(*args, **kwargs)	Exporting video file name.
quality(*args, **kwargs)	Set quality for exporting video file.
scale(*args, **kwargs)	Set scale by which video resolution will expand.
set_standard_resolution(*args, **kwargs)	Select from pre-defined resolution list.
use_original_resolution(*args, **kwargs)	Enable original resolution.
width(*args, **kwargs)	Set the width for exporting video file.

class advance_quality(service, version, mode, path)#

Bases: TUIMenu

Advance Quality setting.

Methods:

bitrate(*args, **kwargs)	Set video bitrate(kbits/sec) for exporting video file.
bitrate_scale(*args, **kwargs)	Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000.
compression_method(*args, **kwargs)	Compression methode for Microsoft AVI movie.
enable_h264(*args, **kwargs)	H264 encoding flag.
keyframe(*args, **kwargs)	Set video keyframe rate for exporting video file.

bitrate(*args, **kwargs)#

Set video bitrate(kbits/sec) for exporting video file.

bitrate_scale(*args, **kwargs)#

Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000.

compression_method(*args, **kwargs)#

Compression methode for Microsoft AVI movie.

enable_h264(*args, **kwargs)#

H264 encoding flag.

keyframe(*args, **kwargs)#

Set video keyframe rate for exporting video file.

format(*args, **kwargs)#

Set format for exporting video file.

fps(*args, **kwargs)#

Set the Frame Per Sec(FPS) for exporting video file.

height(*args, **kwargs)#

Set the height for exporting video file.

name(*args, **kwargs)#

Exporting video file name.

quality(*args, **kwargs)#

Set quality for exporting video file.

scale(*args, **kwargs)#

Set scale by which video resolution will expand.

set_standard_resolution(*args, **kwargs)#

Select from pre-defined resolution list.

use_original_resolution(*args, **kwargs)#

Enable original resolution.

width(*args, **kwargs)#

Set the width for exporting video file.

write(*args, **kwargs)#

Select a pathline or particle track graphics object, specify whether you want to write a video file or picture files, and enter the destination directory for the files. Continuous pulse animations result in a 5 second video. Single pulse animations run for a full cycle.

class cell_register_operations(service, version, mode, path)#

Bases: TUIMenu

Enters the cell register operations menu.

Methods:

add(*args, **kwargs)	Creates a new cell register operation.
delete(*args, **kwargs)	Deletes a cell register operation.
edit(*args, **kwargs)	Edits an existing cell register operation.
list(*args, **kwargs)	Lists the currently defined cell register operations.
list_properties(*args, **kwargs)	Lists the properties of a report register operation.

add(*args, **kwargs)#

Creates a new cell register operation.

delete(*args, **kwargs)#

Deletes a cell register operation.

edit(*args, **kwargs)#

Edits an existing cell register operation.

list(*args, **kwargs)#

Lists the currently defined cell register operations.

list_properties(*args, **kwargs)#

Lists the properties of a report register operation.

class cell_registers(service, version, mode, path)#

Bases: TUIMenu

Enters the cell registers menu.

Methods:

adapt(*args, **kwargs)	Adapt cell register objects.
add(*args, **kwargs)	Add a new object.
apply_poor_mesh_numerics(*args, **kwargs)	Applies poor mesh numerics to the mesh of a cell register.
coarsen(*args, **kwargs)	Coarsen the mesh based on a cell register.
delete(*args, **kwargs)	Deletes a cell register.
display(*args, **kwargs)	Displays a cell register.
edit(*args, **kwargs)	Edit an object.
list(*args, **kwargs)	Lists all of the currently defined cell registers.
list_properties(*args, **kwargs)	Lists the properties of a cell register.
refine(*args, **kwargs)	Refine the mesh based on a cell register.

adapt(*args, **kwargs)#

Adapt cell register objects.

add(*args, **kwargs)#

Add a new object.

apply_poor_mesh_numerics(*args, **kwargs)#

Applies poor mesh numerics to the mesh of a cell register.

coarsen(*args, **kwargs)#

Coarsen the mesh based on a cell register.

delete(*args, **kwargs)#

Deletes a cell register.

display(*args, **kwargs)#

Displays a cell register.

edit(*args, **kwargs)#

Edit an object.

list(*args, **kwargs)#

Lists all of the currently defined cell registers.

list_properties(*args, **kwargs)#

Lists the properties of a cell register.

refine(*args, **kwargs)#

Refine the mesh based on a cell register.

convergence_conditions(*args, **kwargs)#

Enters the convergence conditions menu.

dpm_update(*args, **kwargs)#

Updates discrete phase source terms.

dual_time_iterate(*args, **kwargs)#

Performs unsteady iterations for a specified number of time steps.

class execute_commands(service, version, mode, path)#

Bases: TUIMenu

Enters the execute commands menu.

Methods:

add_edit(*args, **kwargs)	Adds or edits execute commands.
copy(*args, **kwargs)	Copy an execute-command.
delete(*args, **kwargs)	Delete an execute-command.
disable(*args, **kwargs)	Disables an execute command.
enable(*args, **kwargs)	Enables an execute command.
export(*args, **kwargs)	Export execute-commands to a TSV file.
import_(*args, **kwargs)	Import execute-commands from a TSV file.

add_edit(*args, **kwargs)#

Adds or edits execute commands.

copy(*args, **kwargs)#

Copy an execute-command.

delete(*args, **kwargs)#

Delete an execute-command.

disable(*args, **kwargs)#

Disables an execute command.

enable(*args, **kwargs)#

Enables an execute command.

export(*args, **kwargs)#

Export execute-commands to a TSV file.

import_(*args, **kwargs)#

Import execute-commands from a TSV file.

class initialize(service, version, mode, path)#

Bases: TUIMenu

Enters the flow initialization menu.

Classes:

compute_defaults(service, version, mode, path)	Enters the compute default values menu.
mp_localized_turb_init(service, version, ...)	Enters the menu for localized turbulent flow initialization.
set_fmg_options(service, version, mode, path)	Enter the full-multigrid option menu.
set_hyb_initialization(service, version, ...)	Enters the hybrid initialization menu.
vof_patch_smooth_options(service, version, ...)	Enters the vof patch/smooth options menu.

Methods:

dpm_reset(*args, **kwargs)	Resets discrete phase source terms to zero.
fmg_initialization(*args, **kwargs)	Initializes using the full-multigrid initialization (FMG).
hyb_initialization(*args, **kwargs)	Initializes using the hybrid initialization method.
init_acoustics_options(*args, **kwargs)	Specifies the number of timesteps for ramping of sound sources and re-initializes the acoustics wave equation solution.
init_flow_statistics(*args, **kwargs)	Initializes unsteady statistics.
init_instantaneous_vel(*args, **kwargs)	Initialize unsteady velocity.
init_turb_vel_fluctuations(*args, **kwargs)	Initializes instantaneous velocity field out of steady state RANS results, for use before enabling a scale resolving simulation such as LES.
initialize_flow(*args, **kwargs)	Initializes the flow field with the current default values.
levelset_auto_init(*args, **kwargs)	Levelset function automatic initialization.
list_defaults(*args, **kwargs)	Lists default values.
lwf_initialization(*args, **kwargs)	Deletes wall film particles and initializes wall film variables to zero.
open_channel_auto_init(*args, **kwargs)	Opens channel automatic initialization.
reference_frame(*args, **kwargs)	Sets reference frame to absolute or relative.
repair_wall_distance(*args, **kwargs)	Corrects wall distance at very high aspect ratio hexahedral/polyhedral cells.
set_defaults(*args, **kwargs)	Sets default initial values.
set_fmg_initialization(*args, **kwargs)	Enters the set full-multigrid for initialization menu.
show_iterations_sampled(*args, **kwargs)	Displays the number of iterations covered by the data sampled for steady statistics.
show_time_sampled(*args, **kwargs)	Displays the amount of simulated time covered by the data sampled for unsteady statistics.

class compute_defaults(service, version, mode, path)#

Bases: TUIMenu

Enters the compute default values menu.

Methods:

all_zones(*args, **kwargs)	Initializes the flow field with the default values.
axis(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
degassing(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
dummy_entry(*args, **kwargs)	.
exhaust_fan(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
fan(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
fluid(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
geometry(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
inlet_vent(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
intake_fan(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
interface(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
interior(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
mass_flow_inlet(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
mass_flow_outlet(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
network(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
network_end(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
outflow(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
outlet_vent(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
overset(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
periodic(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
porous_jump(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
pressure_far_field(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
pressure_inlet(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
pressure_outlet(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
radiator(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
rans_les_interface(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
recirculation_inlet(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
recirculation_outlet(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
shadow(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
solid(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
symmetry(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
velocity_inlet(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.
wall(*args, **kwargs)	Compute flow-initialization defaults from a zone of this type.

all_zones(*args, **kwargs)#

Initializes the flow field with the default values.

axis(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

degassing(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

dummy_entry(*args, **kwargs)#

.

exhaust_fan(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

fan(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

fluid(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

geometry(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

inlet_vent(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

intake_fan(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

interface(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

interior(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

mass_flow_inlet(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

mass_flow_outlet(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

network(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

network_end(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

outflow(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

outlet_vent(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

overset(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

periodic(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

porous_jump(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

pressure_far_field(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

pressure_inlet(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

pressure_outlet(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

radiator(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

rans_les_interface(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

recirculation_inlet(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

recirculation_outlet(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

shadow(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

solid(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

symmetry(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

velocity_inlet(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

wall(*args, **kwargs)#

Compute flow-initialization defaults from a zone of this type.

dpm_reset(*args, **kwargs)#

Resets discrete phase source terms to zero.

fmg_initialization(*args, **kwargs)#

Initializes using the full-multigrid initialization (FMG).

hyb_initialization(*args, **kwargs)#

Initializes using the hybrid initialization method.

init_acoustics_options(*args, **kwargs)#

Specifies the number of timesteps for ramping of sound sources and re-initializes the acoustics wave equation solution. For the initialized acoustics solution, Fluent reports the current state of the sound sources ramping.

init_flow_statistics(*args, **kwargs)#

Initializes unsteady statistics.

init_instantaneous_vel(*args, **kwargs)#

Initialize unsteady velocity.

init_turb_vel_fluctuations(*args, **kwargs)#

Initializes instantaneous velocity field out of steady state RANS results, for use before enabling a scale resolving simulation such as LES.

initialize_flow(*args, **kwargs)#

Initializes the flow field with the current default values.

levelset_auto_init(*args, **kwargs)#

Levelset function automatic initialization.

list_defaults(*args, **kwargs)#

Lists default values.

lwf_initialization(*args, **kwargs)#

Deletes wall film particles and initializes wall film variables to zero. This option is available only with the wall-film DPM boundary condition.

class mp_localized_turb_init(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for localized turbulent flow initialization.

Methods:

enable(*args, **kwargs)	Enables/disables localized initialization of turbulent flow variables.
turb_init_parameters(*args, **kwargs)	Sets values for the turbulent intensity and turbulent viscosity ratio for localized initialization.

enable(*args, **kwargs)#

Enables/disables localized initialization of turbulent flow variables.

turb_init_parameters(*args, **kwargs)#

Sets values for the turbulent intensity and turbulent viscosity ratio for localized initialization.

open_channel_auto_init(*args, **kwargs)#

Opens channel automatic initialization.

reference_frame(*args, **kwargs)#

Sets reference frame to absolute or relative.

repair_wall_distance(*args, **kwargs)#

Corrects wall distance at very high aspect ratio hexahedral/polyhedral cells.

set_defaults(*args, **kwargs)#

Sets default initial values.

set_fmg_initialization(*args, **kwargs)#

Enters the set full-multigrid for initialization menu. Initial values for each variable can be set within this menu.

class set_fmg_options(service, version, mode, path)#

Bases: TUIMenu

Enter the full-multigrid option menu.

Methods:

reset_to_defaults(*args, **kwargs)	.
set_turbulent_viscosity_ratio(*args, **kwargs)	.
species_reactions(*args, **kwargs)	.
viscous_terms(*args, **kwargs)	.

reset_to_defaults(*args, **kwargs)#

.

set_turbulent_viscosity_ratio(*args, **kwargs)#

.

species_reactions(*args, **kwargs)#

.

viscous_terms(*args, **kwargs)#

.

class set_hyb_initialization(service, version, mode, path)#

Bases: TUIMenu

Enters the hybrid initialization menu.

Methods:

general_settings(*args, **kwargs)	Enters the general settings menu.
species_settings(*args, **kwargs)	Enters the species-settings menu.
turbulent_settings(*args, **kwargs)	Enter the turbulent settings menu.

general_settings(*args, **kwargs)#

Enters the general settings menu.

species_settings(*args, **kwargs)#

Enters the species-settings menu.

turbulent_settings(*args, **kwargs)#

Enter the turbulent settings menu.

show_iterations_sampled(*args, **kwargs)#

Displays the number of iterations covered by the data sampled for steady statistics.

show_time_sampled(*args, **kwargs)#

Displays the amount of simulated time covered by the data sampled for unsteady statistics.

class vof_patch_smooth_options(service, version, mode, path)#

Bases: TUIMenu

Enters the vof patch/smooth options menu.

Methods:

execute_smoothing(*args, **kwargs)	Execute volumetric smoothing for volume fraction.
set_options(*args, **kwargs)	Sets options for patching and smoothing volume fraction.

execute_smoothing(*args, **kwargs)#

Execute volumetric smoothing for volume fraction.

set_options(*args, **kwargs)#

Sets options for patching and smoothing volume fraction.

iterate(*args, **kwargs)#

Performs a specified number of iterations. This option is still available during transient simulations, since it can be used to add more iterations to the same time step after interrupting iterations within a time step.

iterate_steady_2way_fsi(*args, **kwargs)#

Perform a specified number of steps.

max_iterations_per_time_step(*args, **kwargs)#

Set maximum iterations per time step for transient case.

mesh_motion(*args, **kwargs)#

Performs mesh motion.

class monitors(service, version, mode, path)#

Bases: TUIMenu

Sets solution monitors.

Classes:

convergence(service, version, mode, path)	Enter the convergence menu to add surface, volume, drag, lift and moment monitors to convergence criteria.
force(service, version, mode, path)	Enter the force monitors menu.
residual(service, version, mode, path)	Enters the residual monitors menu.
statistic(service, version, mode, path)	Enter the statistic monitors menu.
surface(service, version, mode, path)	Enter the surface menu to set integrated scalar quantities on surface(s) monitors.
volume(service, version, mode, path)	Enter the volume menu to set integrated scalar quantities on volume(s) monitors.

Methods:

set_average_over(*args, **kwargs)

Set the average over input for monitors.

class convergence(service, version, mode, path)#

Bases: TUIMenu

Enter the convergence menu to add surface, volume, drag, lift and moment monitors to convergence criteria.

Methods:

add_edit(*args, **kwargs)	Add or edit convergence criterion for surface, volume, drag, lift and moment monitors.
average_over_last_n_iterations_timesteps(...)	Option to average over previous values for checking convergence.
condition(*args, **kwargs)	Option to stop the calculations.
delete(*args, **kwargs)	Delete a monitor from convergence criteria.
frequency(*args, **kwargs)	To set how often convergence checks are done with respect to iterations or time steps.
list(*args, **kwargs)	List defined convergence criteria for monitors.

add_edit(*args, **kwargs)#

Add or edit convergence criterion for surface, volume, drag, lift and moment monitors.

average_over_last_n_iterations_timesteps(*args, **kwargs)#

Option to average over previous values for checking convergence.

condition(*args, **kwargs)#

Option to stop the calculations. All convergence conditions are met or any convergence condition is met.

delete(*args, **kwargs)#

Delete a monitor from convergence criteria.

frequency(*args, **kwargs)#

To set how often convergence checks are done with respect to iterations or time steps.

list(*args, **kwargs)#

List defined convergence criteria for monitors.

class force(service, version, mode, path)#

Bases: TUIMenu

Enter the force monitors menu.

Methods:

clear_all_monitors_data(*args, **kwargs)	Clear all monitoring data.
clear_drag_monitor_data(*args, **kwargs)	Clear the drag monitoring data.
clear_lift_monitor_data(*args, **kwargs)	Clear the lift monitoring data.
clear_moment_monitor_data(*args, **kwargs)	Clear the moment monitoring data.
clear_monitors(*args, **kwargs)	Clear all or specified monitor data.
delete_monitors(*args, **kwargs)	Delete the specified monitor.
drag_coefficient(*args, **kwargs)	Set variables for monitoring the drag coefficient.
lift_coefficient(*args, **kwargs)	Set variables for monitoring the lift coefficient.
list_monitors(*args, **kwargs)	List defined force monitors.
moment_coefficient(*args, **kwargs)	Set variables for monitoring the moment coefficient.
monitor_unsteady_iters(*args, **kwargs)	Specify whether monitors are updated every iteration or every time step for transient calculations.
set_drag_monitor(*args, **kwargs)	Set variables for monitoring the drag coefficient.
set_lift_monitor(*args, **kwargs)	Set variables for monitoring the lift coefficient.
set_moment_monitor(*args, **kwargs)	Set variables for monitoring the moment coefficient.
unscaled(*args, **kwargs)	Specify whether unscaled values are desired.

clear_all_monitors_data(*args, **kwargs)#

Clear all monitoring data.

clear_drag_monitor_data(*args, **kwargs)#

Clear the drag monitoring data.

clear_lift_monitor_data(*args, **kwargs)#

Clear the lift monitoring data.

clear_moment_monitor_data(*args, **kwargs)#

Clear the moment monitoring data.

clear_monitors(*args, **kwargs)#

Clear all or specified monitor data.

delete_monitors(*args, **kwargs)#

Delete the specified monitor.

drag_coefficient(*args, **kwargs)#

Set variables for monitoring the drag coefficient.

lift_coefficient(*args, **kwargs)#

Set variables for monitoring the lift coefficient.

list_monitors(*args, **kwargs)#

List defined force monitors.

moment_coefficient(*args, **kwargs)#

Set variables for monitoring the moment coefficient.

monitor_unsteady_iters(*args, **kwargs)#

Specify whether monitors are updated every iteration or every time step for transient calculations.

set_drag_monitor(*args, **kwargs)#

Set variables for monitoring the drag coefficient.

set_lift_monitor(*args, **kwargs)#

Set variables for monitoring the lift coefficient.

set_moment_monitor(*args, **kwargs)#

Set variables for monitoring the moment coefficient.

unscaled(*args, **kwargs)#

Specify whether unscaled values are desired.

class residual(service, version, mode, path)#

Bases: TUIMenu

Enters the residual monitors menu.

Methods:

check_convergence(*args, **kwargs)	Chooses which currently monitored residuals should be checked for convergence.
convergence_criteria(*args, **kwargs)	Sets convergence criteria for residuals that are currently being both monitored and checked.
criterion_type(*args, **kwargs)	Sets convergence criterion type.
enhanced_continuity_residual(*args, **kwargs)	Enables/disables an enhanced formulation for the local scaling of the continuity residuals with the pressure-based solver, so that the absolute mass flow rate at each cell is used.
monitor(*args, **kwargs)	Chooses which residuals to monitor as printed and/or plotted output.
n_display(*args, **kwargs)	Sets the number of most recent residuals to display in plots.
n_maximize_norms(*args, **kwargs)	Sets the number of iterations through which normalization factors will be maximized.
n_save(*args, **kwargs)	Sets number of residuals to be saved with data.
normalization_factors(*args, **kwargs)	Sets normalization factors for currently monitored residuals (if normalize? is set to yes).
normalize(*args, **kwargs)	Chooses whether to normalize residuals in printed and plotted output.
plot(*args, **kwargs)	Chooses whether residuals will be plotted during iteration.
print(*args, **kwargs)	Chooses whether residuals will be printed during iteration.
re_normalize(*args, **kwargs)	Re-normalize residuals by maximum values.
relative_conv_criteria(*args, **kwargs)	Sets relative convergence criteria for residuals that are currently being both monitored and checked.
reset(*args, **kwargs)	Chooses whether to delete the residual history and reset iteration counter to 1.
scale_by_coefficient(*args, **kwargs)	Chooses whether to scale residuals by coefficient sum in printed and plotted output.
window(*args, **kwargs)	Specifies window in which residuals will be plotted during iteration.

check_convergence(*args, **kwargs)#

Chooses which currently monitored residuals should be checked for convergence.

convergence_criteria(*args, **kwargs)#

Sets convergence criteria for residuals that are currently being both monitored and checked.

criterion_type(*args, **kwargs)#

Sets convergence criterion type.

enhanced_continuity_residual(*args, **kwargs)#

Enables/disables an enhanced formulation for the local scaling of the continuity residuals with the pressure-based solver, so that the absolute mass flow rate at each cell is used. This text command is only available when the computing of the local scale is enabled through the solve/monitors/residual/scale-by-coefficient? text command.

monitor(*args, **kwargs)#

Chooses which residuals to monitor as printed and/or plotted output.

n_display(*args, **kwargs)#

Sets the number of most recent residuals to display in plots.

n_maximize_norms(*args, **kwargs)#

Sets the number of iterations through which normalization factors will be maximized.

n_save(*args, **kwargs)#

Sets number of residuals to be saved with data. History is automatically compacted when buffer becomes full.

normalization_factors(*args, **kwargs)#

Sets normalization factors for currently monitored residuals (if normalize? is set to yes).

normalize(*args, **kwargs)#

Chooses whether to normalize residuals in printed and plotted output.

plot(*args, **kwargs)#

Chooses whether residuals will be plotted during iteration.

print(*args, **kwargs)#

Chooses whether residuals will be printed during iteration.

re_normalize(*args, **kwargs)#

Re-normalize residuals by maximum values.

relative_conv_criteria(*args, **kwargs)#

Sets relative convergence criteria for residuals that are currently being both monitored and checked.

reset(*args, **kwargs)#

Chooses whether to delete the residual history and reset iteration counter to 1.

scale_by_coefficient(*args, **kwargs)#

Chooses whether to scale residuals by coefficient sum in printed and plotted output.

window(*args, **kwargs)#

Specifies window in which residuals will be plotted during iteration.

set_average_over(*args, **kwargs)#

Set the average over input for monitors.

class statistic(service, version, mode, path)#

Bases: TUIMenu

Enter the statistic monitors menu.

Methods:

file_basename(*args, **kwargs)	Specify the file basename and extension.
monitors(*args, **kwargs)	Choose which statistics to monitor as printed and/or plotted output.
plot(*args, **kwargs)	Enable/disable plotting of statistics during iteration.
print(*args, **kwargs)	Enable/disable printing of statistics during iteration.
window(*args, **kwargs)	Specify first window in which statistics will be plotted during iteration.
write(*args, **kwargs)	Enable/disable writing of statistics during iteration.
x_axis(*args, **kwargs)	Choose what quantity to use on the abscissa in the plot and in the data written to files.

file_basename(*args, **kwargs)#

Specify the file basename and extension. The name of the individual monitor will be insterted automatically.

monitors(*args, **kwargs)#

Choose which statistics to monitor as printed and/or plotted output.

plot(*args, **kwargs)#

Enable/disable plotting of statistics during iteration.

print(*args, **kwargs)#

Enable/disable printing of statistics during iteration.

window(*args, **kwargs)#

Specify first window in which statistics will be plotted during iteration. Multiple statistics are plotted in separate windows, beginning with this one.

write(*args, **kwargs)#

Enable/disable writing of statistics during iteration.

x_axis(*args, **kwargs)#

Choose what quantity to use on the abscissa in the plot and in the data written to files.

class surface(service, version, mode, path)#

Bases: TUIMenu

Enter the surface menu to set integrated scalar quantities on surface(s) monitors.

Methods:

clear_data(*args, **kwargs)	Clear current surface monitor data.
clear_monitors(*args, **kwargs)	Remove all defined surface monitors.
list_monitors(*args, **kwargs)	List defined surface monitors.
set_monitor(*args, **kwargs)	Define or modify a surface monitor.

Classes:

curves(service, version, mode, path)

Enter the curves menu.

clear_data(*args, **kwargs)#

Clear current surface monitor data.

clear_monitors(*args, **kwargs)#

Remove all defined surface monitors.

class curves(service, version, mode, path)#

Bases: TUIMenu

Enter the curves menu.

Methods:

lines(*args, **kwargs)	Set lines parameters for surface monitors.
markers(*args, **kwargs)	Set markers parameters for surface monitors.

lines(*args, **kwargs)#

Set lines parameters for surface monitors.

markers(*args, **kwargs)#

Set markers parameters for surface monitors.

list_monitors(*args, **kwargs)#

List defined surface monitors.

set_monitor(*args, **kwargs)#

Define or modify a surface monitor.

class volume(service, version, mode, path)#

Bases: TUIMenu

Enter the volume menu to set integrated scalar quantities on volume(s) monitors.

Methods:

clear_data(*args, **kwargs)	Clear current volume monitor data.
clear_monitors(*args, **kwargs)	Remove all defined volume monitors.
list_monitors(*args, **kwargs)	List defined volume monitors.
set_monitor(*args, **kwargs)	Define or modify a volume monitor.

clear_data(*args, **kwargs)#

Clear current volume monitor data.

clear_monitors(*args, **kwargs)#

Remove all defined volume monitors.

list_monitors(*args, **kwargs)#

List defined volume monitors.

set_monitor(*args, **kwargs)#

Define or modify a volume monitor.

multistage_time_iterate(*args, **kwargs)#

Perform unsteady iterations.

patch(*args, **kwargs)#

Patches a value for a flow variable in the domain. You can either provide a numerical value, which you can enter directly, or you can enter an expression, which must be entered within quotation marks.

class report_definitions(service, version, mode, path)#

Bases: TUIMenu

Enters the report definitions menu.

Methods:

add(*args, **kwargs)	Add a new object.
compute(*args, **kwargs)	Computes selected report definition.
convert_monitors_to_report_defns(*args, **kwargs)	Converts all monitors to Report Definitions and create new Report Sets/Plot Sets if required.
copy(*args, **kwargs)	Creates a copy of a report definition.
delete(*args, **kwargs)	Deletes a report definition.
delete_all(*args, **kwargs)	Deletes all of the report definition objects.
edit(*args, **kwargs)	Edits a report definition.
list(*args, **kwargs)	Lists all defined report definitions.
list_properties(*args, **kwargs)	Lists the properties of a report definition.
rename(*args, **kwargs)	Renames a report definition.

add(*args, **kwargs)#

Add a new object.

compute(*args, **kwargs)#

Computes selected report definition.

convert_monitors_to_report_defns(*args, **kwargs)#

Converts all monitors to Report Definitions and create new Report Sets/Plot Sets if required.

copy(*args, **kwargs)#

Creates a copy of a report definition.

delete(*args, **kwargs)#

Deletes a report definition.

delete_all(*args, **kwargs)#

Deletes all of the report definition objects.

edit(*args, **kwargs)#

Edits a report definition.

list(*args, **kwargs)#

Lists all defined report definitions.

list_properties(*args, **kwargs)#

Lists the properties of a report definition.

rename(*args, **kwargs)#

Renames a report definition.

class report_files(service, version, mode, path)#

Bases: TUIMenu

Enters the report files menu.

Methods:

add(*args, **kwargs)	Creates a report file.
clear_data(*args, **kwargs)	Clears the data associated with a report file.
delete(*args, **kwargs)	Deletes a report file object.
delete_all(*args, **kwargs)	Deletes all of the report file objects.
edit(*args, **kwargs)	Edits a report file.
list(*args, **kwargs)	Lists all defined report files.
list_properties(*args, **kwargs)	Lists the properties of a report file.

add(*args, **kwargs)#

Creates a report file.

clear_data(*args, **kwargs)#

Clears the data associated with a report file.

delete(*args, **kwargs)#

Deletes a report file object.

delete_all(*args, **kwargs)#

Deletes all of the report file objects.

edit(*args, **kwargs)#

Edits a report file.

list(*args, **kwargs)#

Lists all defined report files.

list_properties(*args, **kwargs)#

Lists the properties of a report file.

class report_plots(service, version, mode, path)#

Bases: TUIMenu

Enters the report plots menu.

Methods:

add(*args, **kwargs)	Creates a report plot.
axes(*args, **kwargs)	Defines the axes for a report plot.
clear_data(*args, **kwargs)	Clears the data associated with a report plot.
curves(*args, **kwargs)	Defines the curves for a report plot.
delete(*args, **kwargs)	Deletes a report plot object.
delete_all(*args, **kwargs)	Deletes all of the report plot objects.
edit(*args, **kwargs)	Edits a report plot.
get_window_id(*args, **kwargs)	Get report-plot object window id.
list(*args, **kwargs)	Lists all defined report plots.
list_properties(*args, **kwargs)	Lists the properties of a report plot.
plot(*args, **kwargs)	Plots the specified report plot.

add(*args, **kwargs)#

Creates a report plot.

axes(*args, **kwargs)#

Defines the axes for a report plot.

clear_data(*args, **kwargs)#

Clears the data associated with a report plot.

curves(*args, **kwargs)#

Defines the curves for a report plot.

delete(*args, **kwargs)#

Deletes a report plot object.

delete_all(*args, **kwargs)#

Deletes all of the report plot objects.

edit(*args, **kwargs)#

Edits a report plot.

get_window_id(*args, **kwargs)#

Get report-plot object window id.

list(*args, **kwargs)#

Lists all defined report plots.

list_properties(*args, **kwargs)#

Lists the properties of a report plot.

plot(*args, **kwargs)#

Plots the specified report plot.

class set(service, version, mode, path)#

Bases: TUIMenu

Enters the set solution parameters menu.

Methods:

accelerated_non_iterative_time_marching(...)	Enables a modified NITA scheme and other setting changes that can speed up the simulation.
adaptive_time_stepping(*args, **kwargs)	Set Error-based adaptive time-stepping parameters.
bc_pressure_extrapolations(*args, **kwargs)	Sets pressure extrapolations schemes on boundaries.
cfl_based_adaptive_time_stepping(*args, **kwargs)	Set CFL-based adaptive time-stepping parameters.
convergence_acceleration_for_stretched_meshes(...)	Enables convergence acceleration for stretched meshes to improve the convergence of the implicit density based solver on meshes with high cell stretching.
correction_tolerance(*args, **kwargs)	Enters the correction tolerance menu.
coupled_vof_expert(*args, **kwargs)	Set coupled vof expert controls.
courant_number(*args, **kwargs)	Sets the fine-grid Courant number (time step factor).
data_sampling(*args, **kwargs)	Enables data sampling for steady or unsteady flow statistics.
disable_reconstruction(*args, **kwargs)	Completely disables reconstruction, resulting in totally first-order accuracy.
discretization_scheme(*args, **kwargs)	Enters the discretization scheme menu.
enable_output_dp_dt(*args, **kwargs)	Controls whether the output field variabledp-dt will be available for transient simulation postprocessing.
equation_ordering(*args, **kwargs)	Sets the order in which the model equations are solved, which can affect the convergence speed when you are using the pressure-based solver.
equations(*args, **kwargs)	Selects the equations to be solved.
expert(*args, **kwargs)	Sets expert options.
flow_warnings(*args, **kwargs)	Specifies whether or not to print warning messages when reversed flow occurs at inlets and outlets, and when mass-flow inlets develop supersonic regions.
flux_type(*args, **kwargs)	Enter the flux type.
gradient_scheme(*args, **kwargs)	Sets gradient options.
heterogeneous_stiff_chemistry(*args, **kwargs)	Sets the heterogeneous stiff-chemistry solver.
limiter_warnings(*args, **kwargs)	Specifies whether or not to print warning messages when quantities are being limited.
limits(*args, **kwargs)	Sets solver limits for various solution variables, in order to improve the stability of the solution.
lock_solid_temperature(*args, **kwargs)	Specifies whether you want to lock (or “freeze”) the temperature values for all the cells in solid zones (including those to which you have a hooked an energy source through a UDF) and in walls that have shell conduction enabled, so that the values do not change during further solver iterations.
material_property_warnings(*args, **kwargs)	Control the display of material property warning diagnostics: 0 - off (no messages) 1 - messages per material 2 - messages per material and per property.
max_corrections(*args, **kwargs)	Enters the max-corrections menu.
moving_mesh_numerics(*args, **kwargs)	Transient options for sliding, moving, and/or dynamic mesh.
mp_mfluid_aniso_drag(*args, **kwargs)	Sets anisotropic drag parameters for the Eulerian multiphase model.
mp_reference_density(*args, **kwargs)	Sets the reference density method for the Eulerian multiphase model.
multi_grid_amg(*args, **kwargs)	Sets the parameters that govern the algebraic multigrid procedure.
multi_grid_controls(*args, **kwargs)	Sets multigrid parameters and termination criteria.
multi_grid_fas(*args, **kwargs)	Sets the parameters that control the FAS multigrid solver.
multi_stage(*args, **kwargs)	Sets the multi-stage coefficients and the dissipation and viscous evaluation stages.
nb_gradient_boundary_option(*args, **kwargs)	Switches between the modified treatment of node-based gradients at boundary cells and the legacy treatment (R14.5.7 and earlier).
number_of_iterations(*args, **kwargs)	Sets the number of iterations for a steady-state simulation without starting the calculation.
numerical_beach_controls(*args, **kwargs)	Sets damping function in flow direction.
numerics(*args, **kwargs)	Sets numerics options.
open_channel_controls(*args, **kwargs)	For flows that do not transition from sub-critical to super-critical, or vice-versa, you can speed-up the solution calculation by updating the frequency of Froude number during run time.
p_v_controls(*args, **kwargs)	Sets pressure-velocity controls.
p_v_controls_advanced(*args, **kwargs)	Set advanced pressure-velocity coupling controls.
p_v_coupling(*args, **kwargs)	Selects which pressure-velocity coupling scheme is to be used.
phase_based_vof_discretization(*args, **kwargs)	Sets phase based slope limiter for VOF compressive scheme.
pseudo_relaxation_factor(*args, **kwargs)	For backward compatibility, pseudo relaxation factor menu.
pseudo_transient(*args, **kwargs)	For backward compatibility, pseudo transient (global time-step) formulation setup.
pseudo_transient_expert(*args, **kwargs)	For backward compatibility, pseudo transient expert usage control.
reactions(*args, **kwargs)	Enables the species reaction sources and sets relaxation factor.
reduced_rank_extrapolation(*args, **kwargs)	Enable Reduced Rank Extrapolation method to accelerate solution time.
reduced_rank_extrapolation_options(*args, ...)	Reduced Rank Extrapolation options.
relaxation_factor(*args, **kwargs)	Enters the relaxation-factor menu.
relaxation_method(*args, **kwargs)	Sets the solver relaxation method.
reporting_interval(*args, **kwargs)	Sets the number of iterations for which convergence monitors are reported.
residual_smoothing(*args, **kwargs)	Sets the implicit residual smoothing parameters.
residual_tolerance(*args, **kwargs)	Enters the residual tolerance menu.
residual_verbosity(*args, **kwargs)	Sets the amount of residual information to be printed.
second_order_time_options(*args, **kwargs)	Enables / disables the variable time step size formulation for second-order implicit transient formulations.
set_all_species_together(*args, **kwargs)	Sets all species discretizations and URFs together.
set_controls_to_default(*args, **kwargs)	Sets controls to default values.
set_solution_methods_to_default(*args, **kwargs)	Sets the solution methods to the default settings.
set_solution_steering(*args, **kwargs)	Sets solution steering parameters.
slope_limiter_set(*args, **kwargs)	Selects a new Fluent solver slope limiter.
solution_steering(*args, **kwargs)	Enables solution steering for the density-based solver.
stiff_chemistry(*args, **kwargs)	Sets solver options for stiff chemistry solutions.
surface_tension(*args, **kwargs)	Sets surface-tension calculation options.
surface_tension_expert(*args, **kwargs)	Set surface-tension expert options.
time_step(*args, **kwargs)	Set the time step.
under_relaxation(*args, **kwargs)	Enters the under-relaxation menu, which allows you to set the under-relaxation factor for each equation that is being solved in a segregated manner.
variable_time_stepping(*args, **kwargs)	Set Multiphase-Specific Adaptive time stepping parameters.
vof_explicit_controls(*args, **kwargs)	Sets the sub time step calculation method for VOF calculations.
vof_numerics(*args, **kwargs)	Sets VOF numeric options.

Classes:

acoustics_wave_equation_controls(service, ...)	Enters the menu to specify parameters of the acoustics wave equation solver.
advanced(service, version, mode, path)	Enters the advanced settings menu.
amg_options(service, version, mode, path)	Enters the AMG options menu.
contact_solution_controls(service, version, ...)	Solver controls for contact marks method.
data_sampling_options(service, version, ...)	Enter the menu for specifying quantities and zones for steady and unsteady flow statistics.
divergence_prevention(service, version, ...)	Enters the divergence prevention menu.
enhanced_les_numerics(service, version, ...)	Enter enhanced LES options menu.
fast_transient_settings(service, version, ...)	Enters the fast transient settings menu.
high_order_term_relaxation(service, version, ...)	Enter High Order Relaxation Menu.
high_speed_numerics(service, version, mode, path)	Enter high-speed-numerics menu.
multiphase_numerics(service, version, mode, path)	Sets multiphase numerics options.
nita_expert_controls(service, version, mode, ...)	Enters the NITA expert control menu.
open_channel_wave_options(service, version, ...)	Sets buffer layer height, verbosity, and open channel wave theory formulation.
overset(service, version, mode, path)	Specifies overset meshing solver options.
poor_mesh_numerics(service, version, mode, path)	Enters the poor mesh numerics menu.
previous_defaults(service, version, mode, path)	Provides text commands that allow you to undo enhancements to the default solver behavior.
pseudo_time_method(service, version, mode, path)	Enters the pseudo time method menu.
slope_limiter_menu(service, version, mode, path)	.
transient_controls(service, version, mode, path)	Enters the transient controls menu, which allows you to define settings related to time advancement for transient flow calculations.
warped_face_gradient_correction(service, ...)	Enters the warped-face gradient correction menu.

accelerated_non_iterative_time_marching(*args, **kwargs)#

Enables a modified NITA scheme and other setting changes that can speed up the simulation. This option is only available with the Large Eddy Simulation (LES) turbulence model, and is intended for unreacting flow simulations that use a constant-density fluid.

class acoustics_wave_equation_controls(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to specify parameters of the acoustics wave equation solver.

Classes:

expert(service, version, mode, path)

Enters the menu to specify the expert parameters.

Methods:

max_iterations_per_timestep(*args, **kwargs)	.
relative_convergence_criterion(*args, **kwargs)	.

class expert(service, version, mode, path)#

Bases: TUIMenu

Enters the menu to specify the expert parameters.

Methods:

explicit_relaxation_factor(*args, **kwargs)	Specifies the explicit relaxation factor.
under_relaxation_factor(*args, **kwargs)	Specifies the implicit under-relaxation factor.

explicit_relaxation_factor(*args, **kwargs)#

Specifies the explicit relaxation factor. Should be used only with bad meshes, when iterations do not converge.

under_relaxation_factor(*args, **kwargs)#

Specifies the implicit under-relaxation factor. Should be used only with bad meshes, when the AMG linear solver does not converge.

max_iterations_per_timestep(*args, **kwargs)#

.

relative_convergence_criterion(*args, **kwargs)#

.

adaptive_time_stepping(*args, **kwargs)#

Set Error-based adaptive time-stepping parameters.

class advanced(service, version, mode, path)#

Bases: TUIMenu

Enters the advanced settings menu.

Methods:

alternate_wall_temp_formulation(*args, **kwargs)	Enables/disables an alternate formulation for wall temperatures.
anisotropic_heat_flux(*args, **kwargs)	Select the heat flux calculation methods.
bcd_boundedness(*args, **kwargs)	Specifies the BCD scheme parameter, which controls the boundedness strength of the BCD scheme in the pressure-based solver, as described in .
bcd_scheme_type(*args, **kwargs)	BCD scheme type (standard or tunable).
bcd_weights_freeze(*args, **kwargs)	Enables/disables freezing of weighting coefficients of the central differencing and the upwind components of the BCD scheme.
correction_form(*args, **kwargs)
energy_numerical_noise_filter(*args, **kwargs)	Enables/disables a filter to eliminate non-physical numerical noise in the energy field.
energy_reconstruction_gradient_limiting(...)	Enable limiting of reconstruction gradient for the energy equation.
explicit_under_relaxation_value(*args, **kwargs)	Explicit under-relaxation value.
linearized_mass_transfer_udf(*args, **kwargs)	Enables/disables the use of a linearized mass transfer user-defined function (that is, the DEFINE_LINEARIZED_MASS_TRANSFER macro), as opposed to a mass transfer user-defined function (that is, the DEFINE_MASS_TRANSFER macro).
retain_cell_residuals(*args, **kwargs)	Enables/disables the retention of cell residuals for postprocessing.
retain_temporary_solver_mem(*args, **kwargs)	Enables/disables the retention of temporary solver memory, which retains gradient data and makes some advanced options available for postprocessing.
show_all_discretization_schemes(*args, **kwargs)	Enables/disables the availability of all applicable discretization schemes.
singhal_et_al_cavitation_model(*args, **kwargs)	Enables/disables the availability of the Singhal et al. cavitation model option, which can then be enabled in the Multiphase Model dialog box or by using the following text command: define/phases/set-domain-properties/interaction-domain/heat-mass-reaction/cavitation/cavitation?.
skewness_correction_enhanced(*args, **kwargs)	Enable enhanced skewness correction scheme.
volume_flux_for_single_phase(*args, **kwargs)	Enable/disable volume flux formulation for single phase flows.

Classes:

anisotropic_solid_heat_transfer(service, ...)	.
non_reflecting_boundary_treatment(service, ...)	Enter non reflecting boundary treatment using minimal pressure reflection approach menu.
secondary_gradient_limiting(service, ...)	Enters the secondary gradient limiting menu.
turbomachinery_specific_numerics(service, ...)	Enter turbomachinery specific numerics menu.

alternate_wall_temp_formulation(*args, **kwargs)#

Enables/disables an alternate formulation for wall temperatures.

anisotropic_heat_flux(*args, **kwargs)#

Select the heat flux calculation methods.

class anisotropic_solid_heat_transfer(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

flux(*args, **kwargs)	.
gradient(*args, **kwargs)	.

flux(*args, **kwargs)#

.

gradient(*args, **kwargs)#

.

bcd_boundedness(*args, **kwargs)#

Specifies the BCD scheme parameter, which controls the boundedness strength of the BCD scheme in the pressure-based solver, as described in .

bcd_scheme_type(*args, **kwargs)#

BCD scheme type (standard or tunable).

bcd_weights_freeze(*args, **kwargs)#

Enables/disables freezing of weighting coefficients of the central differencing and the upwind components of the BCD scheme. This dialog command requires the iteration number, after which the BCD scheme weights are to be frozen at each timestep. Freezing the BCD weighting coefficients may help to improve convergence of the timestep iterations as described in .

correction_form(*args, **kwargs)#

energy_numerical_noise_filter(*args, **kwargs)#

Enables/disables a filter to eliminate non-physical numerical noise in the energy field. Numerical noise can appear in solution fields where large variations in specific heat or combustion with phase change are present. Using the energy equation numerical noise filter increases robustness, but may make the solution slightly more diffusive. This text command is only available with the pressure-based solver.

energy_reconstruction_gradient_limiting(*args, **kwargs)#

Enable limiting of reconstruction gradient for the energy equation.

explicit_under_relaxation_value(*args, **kwargs)#

Explicit under-relaxation value.

linearized_mass_transfer_udf(*args, **kwargs)#

Enables/disables the use of a linearized mass transfer user-defined function (that is, the DEFINE_LINEARIZED_MASS_TRANSFER macro), as opposed to a mass transfer user-defined function (that is, the DEFINE_MASS_TRANSFER macro).

class non_reflecting_boundary_treatment(service, version, mode, path)#

Bases: TUIMenu

Enter non reflecting boundary treatment using minimal pressure reflection approach menu.

Methods:

pressure_inlet(*args, **kwargs)	Enabling the use of minimal pressure reflection treatment.
pressure_outlet(*args, **kwargs)	Enabling the use of minimal pressure reflection treatment.
velocity_inlet(*args, **kwargs)	Enabling the use of minimal pressure reflection treatment.

pressure_inlet(*args, **kwargs)#

Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment.

pressure_outlet(*args, **kwargs)#

Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment.

velocity_inlet(*args, **kwargs)#

Enabling the use of minimal pressure reflection treatment. This treatment will minimize pressure wave reflections from the boundaries on which this option is active, but not necessarily fully eliminating them. The reflections would be of an acceptable limit in order to not contaminate the solution, the simulation will gain from the robustness of the new algorithm compared to traditional non-reflecting boundary condition treatment.

retain_cell_residuals(*args, **kwargs)#

Enables/disables the retention of cell residuals for postprocessing.

retain_temporary_solver_mem(*args, **kwargs)#

Enables/disables the retention of temporary solver memory, which retains gradient data and makes some advanced options available for postprocessing.

class secondary_gradient_limiting(service, version, mode, path)#

Bases: TUIMenu

Enters the secondary gradient limiting menu. This menu is only available when the define/models/solver/pressure-based text command is enabled.

Methods:

energy(*args, **kwargs)	Enables/disables secondary gradient limiting for the energy calculations on coupled two-sided walls.
mesh_quality_limits(*args, **kwargs)	Defines the mesh quality limits used when applying secondary gradient limiting to faces on coupled two-sided walls.
uds(*args, **kwargs)	Enables/disables secondary gradient limiting for the user-defined scalar (UDS) calculations on coupled two-sided walls.

energy(*args, **kwargs)#

Enables/disables secondary gradient limiting for the energy calculations on coupled two-sided walls. This limiting can help prevent divergence when the cells on such walls have poor orthogonality.

mesh_quality_limits(*args, **kwargs)#

Defines the mesh quality limits used when applying secondary gradient limiting to faces on coupled two-sided walls. Shifting this range closer to 1 will decrease the risk of divergence, but at the cost of accuracy.

uds(*args, **kwargs)#

Enables/disables secondary gradient limiting for the user-defined scalar (UDS) calculations on coupled two-sided walls. This limiting can help prevent divergence when the cells on such walls have poor orthogonality.

show_all_discretization_schemes(*args, **kwargs)#

Enables/disables the availability of all applicable discretization schemes.

singhal_et_al_cavitation_model(*args, **kwargs)#

Enables/disables the availability of the Singhal et al. cavitation model option, which can then be enabled in the Multiphase Model dialog box or by using the following text command: define/phases/set-domain-properties/interaction-domain/heat-mass-reaction/cavitation/cavitation?.

skewness_correction_enhanced(*args, **kwargs)#

Enable enhanced skewness correction scheme.

class turbomachinery_specific_numerics(service, version, mode, path)#

Bases: TUIMenu

Enter turbomachinery specific numerics menu.

Methods:

enable(*args, **kwargs)	Activate/deactivate turbomachinery specific numerics.
settings(*args, **kwargs)	Adjust settings for turbomachinery specific numerics.

enable(*args, **kwargs)#

Activate/deactivate turbomachinery specific numerics.

settings(*args, **kwargs)#

Adjust settings for turbomachinery specific numerics.

volume_flux_for_single_phase(*args, **kwargs)#

Enable/disable volume flux formulation for single phase flows.

class amg_options(service, version, mode, path)#

Bases: TUIMenu

Enters the AMG options menu.

Methods:

aggressive_amg_coarsening(*args, **kwargs)	Enables / disables the use of a version of the AMG solver that is optimized for high coarsening rates.
amg_gpgpu_options(*args, **kwargs)	Set GPGPU AMG solver options.
conservative_amg_coarsening(*args, **kwargs)	Enables / disables the use of conservative coarsening techniques for scalar and/or coupled equations that can improve parallel performance and/or convergence for some difficult cases.
laplace_coarsening(*args, **kwargs)	Enables / disables Laplace coarsening for scalar and/or coupled equations.

aggressive_amg_coarsening(*args, **kwargs)#

Enables / disables the use of a version of the AMG solver that is optimized for high coarsening rates. This option is recommended if the AMG solver diverges with the default settings.

amg_gpgpu_options(*args, **kwargs)#

Set GPGPU AMG solver options.

conservative_amg_coarsening(*args, **kwargs)#

Enables / disables the use of conservative coarsening techniques for scalar and/or coupled equations that can improve parallel performance and/or convergence for some difficult cases.

laplace_coarsening(*args, **kwargs)#

Enables / disables Laplace coarsening for scalar and/or coupled equations.

bc_pressure_extrapolations(*args, **kwargs)#

Sets pressure extrapolations schemes on boundaries.

cfl_based_adaptive_time_stepping(*args, **kwargs)#

Set CFL-based adaptive time-stepping parameters.

class contact_solution_controls(service, version, mode, path)#

Bases: TUIMenu

Solver controls for contact marks method.

Classes:

amg(service, version, mode, path)	.
methods(service, version, mode, path)	.
miscellaneous(service, version, mode, path)	.
models(service, version, mode, path)	.
parameters(service, version, mode, path)	Parameters used in stabilization strategy.
spatial(service, version, mode, path)	.
transient(service, version, mode, path)	.

Methods:

set_settings_to_default(*args, **kwargs)	Set contact solution stabilization to default.
solution_stabilization(*args, **kwargs)	.
verbosity(*args, **kwargs)	.

class amg(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

coarsen_rate(*args, **kwargs)	.
enforce_laplace_coarsening(*args, **kwargs)	.
increase_pre_sweeps(*args, **kwargs)	.
pre_sweeps(*args, **kwargs)	.
specify_coarsening_rate(*args, **kwargs)	.

coarsen_rate(*args, **kwargs)#

.

enforce_laplace_coarsening(*args, **kwargs)#

.

increase_pre_sweeps(*args, **kwargs)#

.

pre_sweeps(*args, **kwargs)#

.

specify_coarsening_rate(*args, **kwargs)#

.

class methods(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

gradient_controls(*args, **kwargs)	.
pressure_velocity_coupling_controls(*args, ...)	.
pressure_velocity_coupling_method(*args, ...)	.
specify_gradient_method(*args, **kwargs)	.

gradient_controls(*args, **kwargs)#

.

pressure_velocity_coupling_controls(*args, **kwargs)#

.

pressure_velocity_coupling_method(*args, **kwargs)#

.

specify_gradient_method(*args, **kwargs)#

.

class miscellaneous(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

compute_statistics(*args, **kwargs)	.
statistics_level(*args, **kwargs)	.

compute_statistics(*args, **kwargs)#

.

statistics_level(*args, **kwargs)#

.

class models(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

model_ramping(*args, **kwargs)	.
ramp_flow(*args, **kwargs)	.
ramp_scalars(*args, **kwargs)	.
ramp_turbulence(*args, **kwargs)	.

model_ramping(*args, **kwargs)#

.

ramp_flow(*args, **kwargs)#

.

ramp_scalars(*args, **kwargs)#

.

ramp_turbulence(*args, **kwargs)#

.

class parameters(service, version, mode, path)#

Bases: TUIMenu

Parameters used in stabilization strategy.

Methods:

extrapolation_method(*args, **kwargs)	Solution extrapolation method for cells changing status from contact to non-contact [0-none, 1-local extrapolation].
iterations(*args, **kwargs)	.
persistence_fixed_duration(*args, **kwargs)	.
persistence_fixed_time_steps(*args, **kwargs)	.
solution_stabilization_persistence(*args, ...)	.

extrapolation_method(*args, **kwargs)#

Solution extrapolation method for cells changing status from contact to non-contact [0-none, 1-local extrapolation].

iterations(*args, **kwargs)#

.

persistence_fixed_duration(*args, **kwargs)#

.

persistence_fixed_time_steps(*args, **kwargs)#

.

solution_stabilization_persistence(*args, **kwargs)#

.

set_settings_to_default(*args, **kwargs)#

Set contact solution stabilization to default.

solution_stabilization(*args, **kwargs)#

.

class spatial(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

first_to_second_order_blending(*args, **kwargs)	.
first_to_second_order_blending_list(*args, ...)	.
flow_skew_diffusion_exclude(*args, **kwargs)	.
rhie_chow_flux_specify(*args, **kwargs)	.
rhie_chow_method(*args, **kwargs)	.
scalars_skew_diffusion_exclude(*args, **kwargs)	.
scheme(*args, **kwargs)	.

first_to_second_order_blending(*args, **kwargs)#

.

first_to_second_order_blending_list(*args, **kwargs)#

.

flow_skew_diffusion_exclude(*args, **kwargs)#

.

rhie_chow_flux_specify(*args, **kwargs)#

.

rhie_chow_method(*args, **kwargs)#

.

scalars_skew_diffusion_exclude(*args, **kwargs)#

.

scheme(*args, **kwargs)#

.

class transient(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

time_scale_modification_factor(*args, **kwargs)	.
time_scale_modification_method(*args, **kwargs)	.
transient_parameters_specify(*args, **kwargs)	.
transient_scheme(*args, **kwargs)	.

time_scale_modification_factor(*args, **kwargs)#

.

time_scale_modification_method(*args, **kwargs)#

.

transient_parameters_specify(*args, **kwargs)#

.

transient_scheme(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

.

convergence_acceleration_for_stretched_meshes(*args, **kwargs)#

Enables convergence acceleration for stretched meshes to improve the convergence of the implicit density based solver on meshes with high cell stretching.

correction_tolerance(*args, **kwargs)#

Enters the correction tolerance menu.

coupled_vof_expert(*args, **kwargs)#

Set coupled vof expert controls.

courant_number(*args, **kwargs)#

Sets the fine-grid Courant number (time step factor). This command is available only for the coupled solvers.

data_sampling(*args, **kwargs)#

Enables data sampling for steady or unsteady flow statistics.

class data_sampling_options(service, version, mode, path)#

Bases: TUIMenu

Enter the menu for specifying quantities and zones for steady and unsteady flow statistics.

Methods:

add_datasets(*args, **kwargs)	Add a dataset.
list_datasets(*args, **kwargs)	Lists the combinations of zones and quantities that are defined for sampling steady and unsteady flow statistics.
remove_dataset(*args, **kwargs)	Remove dataset.

Classes:

dft_datasets(service, version, mode, path)

Data sampling options for runtime discrete Fourier transform.

add_datasets(*args, **kwargs)#

Add a dataset. After providing the zones for a dataset, press [Enter] to move onto selecting quantities. Enter () to complete the quantity selection for this dataset.

class dft_datasets(service, version, mode, path)#

Bases: TUIMenu

Data sampling options for runtime discrete Fourier transform.

Methods:

add_band_datasets(*args, **kwargs)	Add DFT datasets for a frequency band.
add_tone_datasets(*args, **kwargs)	Add DFT datasets for a single tone.
dataset_properties(*args, **kwargs)	Print properties of a DFT dataset.
delete_dataset(*args, **kwargs)	Delete DFT datasets.
list_datasets(*args, **kwargs)	List DFT datasets.
quantities(*args, **kwargs)	Select quantities for a new DFT dataset.
window_function(*args, **kwargs)	Select window function for a DFT dataset.
zones(*args, **kwargs)	Select zones for a new DFT dataset.

add_band_datasets(*args, **kwargs)#

Add DFT datasets for a frequency band.

add_tone_datasets(*args, **kwargs)#

Add DFT datasets for a single tone.

dataset_properties(*args, **kwargs)#

Print properties of a DFT dataset.

delete_dataset(*args, **kwargs)#

Delete DFT datasets.

list_datasets(*args, **kwargs)#

List DFT datasets.

quantities(*args, **kwargs)#

Select quantities for a new DFT dataset. Enter () to complete the quantity selection.

window_function(*args, **kwargs)#

Select window function for a DFT dataset.

zones(*args, **kwargs)#

Select zones for a new DFT dataset.

list_datasets(*args, **kwargs)#

Lists the combinations of zones and quantities that are defined for sampling steady and unsteady flow statistics.

remove_dataset(*args, **kwargs)#

Remove dataset.

disable_reconstruction(*args, **kwargs)#

Completely disables reconstruction, resulting in totally first-order accuracy.

discretization_scheme(*args, **kwargs)#

Enters the discretization scheme menu. This allows you to select the discretization scheme for the convection terms in the solution equations. The following text commands can make a selection from a subset of the models in the following table:.

class divergence_prevention(service, version, mode, path)#

Bases: TUIMenu

Enters the divergence prevention menu. This menu is only available for the density-based solver.

Methods:

enable(*args, **kwargs)

Enables a divergence prevention option so that Fluent applies under-relaxation to the variables in select cells where the temperature and/or pressure values are approaching the minimum and/or maximum limits.

enable(*args, **kwargs)#

Enables a divergence prevention option so that Fluent applies under-relaxation to the variables in select cells where the temperature and/or pressure values are approaching the minimum and/or maximum limits.

enable_output_dp_dt(*args, **kwargs)#

Controls whether the output field variabledp-dt will be available for transient simulation postprocessing. If you select no, pressure fields at the previous time steps will not be stored in memory which reduces memory usage.

class enhanced_les_numerics(service, version, mode, path)#

Bases: TUIMenu

Enter enhanced LES options menu.

Methods:

optimized_advection(*args, **kwargs)	Use advection scheme optimized for LES.
optimized_algorithm(*args, **kwargs)	Use solver algorithm optimized for LES.
optimized_cd(*args, **kwargs)	Use optimized central difference discretization.

optimized_advection(*args, **kwargs)#

Use advection scheme optimized for LES.

optimized_algorithm(*args, **kwargs)#

Use solver algorithm optimized for LES.

optimized_cd(*args, **kwargs)#

Use optimized central difference discretization.

equation_ordering(*args, **kwargs)#

Sets the order in which the model equations are solved, which can affect the convergence speed when you are using the pressure-based solver. The standard method is enabled by default and corresponds to the ordering shown in and in the Theory Guide; alternatively, you can select theoptimized-for-volumetric-expansion method, which is recommended for flows in which the density is strongly dependent on thermal effects, chemical composition, and so on (such as combustion simulations). This text command is not available for steady simulations and/or when a multiphase model is enabled.

equations(*args, **kwargs)#

Selects the equations to be solved.

expert(*args, **kwargs)#

Sets expert options.

class fast_transient_settings(service, version, mode, path)#

Bases: TUIMenu

Enters the fast transient settings menu. This menu is only available for transient cases that use the density-based solver.

Methods:

rk2(*args, **kwargs)

Allows you to enable the use of a two-stage Runge-Kutta scheme for time integration, or revert to the default multi-stage Runge-Kutta scheme.

rk2(*args, **kwargs)#

Allows you to enable the use of a two-stage Runge-Kutta scheme for time integration, or revert to the default multi-stage Runge-Kutta scheme. This text command is only available for transient cases that use the density-based explicit formulation.

flow_warnings(*args, **kwargs)#

Specifies whether or not to print warning messages when reversed flow occurs at inlets and outlets, and when mass-flow inlets develop supersonic regions. By default, flow warnings are printed.

flux_type(*args, **kwargs)#

Enter the flux type.

gradient_scheme(*args, **kwargs)#

Sets gradient options.

heterogeneous_stiff_chemistry(*args, **kwargs)#

Sets the heterogeneous stiff-chemistry solver.

class high_order_term_relaxation(service, version, mode, path)#

Bases: TUIMenu

Enter High Order Relaxation Menu.

Methods:

enable(*args, **kwargs)

Enables/disables High Order Term Relaxation.

Classes:

options(service, version, mode, path)

High Order Term Relaxation Options.

enable(*args, **kwargs)#

Enables/disables High Order Term Relaxation.

class options(service, version, mode, path)#

Bases: TUIMenu

High Order Term Relaxation Options.

Methods:

relaxation_factor(*args, **kwargs)	Sets the relaxation factor.
type(*args, **kwargs)	Enter high order relaxation type.

Classes:

variables(service, version, mode, path)

Selects the variables.

relaxation_factor(*args, **kwargs)#

Sets the relaxation factor.

type(*args, **kwargs)#

Enter high order relaxation type.

class variables(service, version, mode, path)#

Bases: TUIMenu

Selects the variables.

Methods:

select(*args, **kwargs)

Select variables for high order term relaxation.

select(*args, **kwargs)#

Select variables for high order term relaxation.

class high_speed_numerics(service, version, mode, path)#

Bases: TUIMenu

Enter high-speed-numerics menu.

Methods:

enable(*args, **kwargs)	Enables/disables High Speed Numerics.
expert(*args, **kwargs)	Sets the level of stabilization used to achieve fast convergence.
visualize_pressure_discontinuity_sensor(...)	Makes available the Pressure Discontinuity Sensor which is a binary identifier equal to 1 if a cell is in proximity of a pressure discontinuity.

enable(*args, **kwargs)#

Enables/disables High Speed Numerics.

expert(*args, **kwargs)#

Sets the level of stabilization used to achieve fast convergence. Enter a number 0-5 corresponding to the Mach number range that best characterizes the flow.

visualize_pressure_discontinuity_sensor(*args, **kwargs)#

Makes available the Pressure Discontinuity Sensor which is a binary identifier equal to 1 if a cell is in proximity of a pressure discontinuity.

limiter_warnings(*args, **kwargs)#

Specifies whether or not to print warning messages when quantities are being limited. By default, limiter warnings are printed.

limits(*args, **kwargs)#

Sets solver limits for various solution variables, in order to improve the stability of the solution.

lock_solid_temperature(*args, **kwargs)#

Specifies whether you want to lock (or “freeze”) the temperature values for all the cells in solid zones (including those to which you have a hooked an energy source through a UDF) and in walls that have shell conduction enabled, so that the values do not change during further solver iterations.

material_property_warnings(*args, **kwargs)#

Control the display of material property warning diagnostics: 0 - off (no messages) 1 - messages per material 2 - messages per material and per property.

max_corrections(*args, **kwargs)#

Enters the max-corrections menu.

moving_mesh_numerics(*args, **kwargs)#

Transient options for sliding, moving, and/or dynamic mesh.

mp_mfluid_aniso_drag(*args, **kwargs)#

Sets anisotropic drag parameters for the Eulerian multiphase model.

mp_reference_density(*args, **kwargs)#

Sets the reference density method for the Eulerian multiphase model. The following options are available: 0 (default): Averaged density of the phase 1: Cell density of the phase 1: Constant value of 1 1: Cell density of the phase See for more information.

multi_grid_amg(*args, **kwargs)#

Sets the parameters that govern the algebraic multigrid procedure.

multi_grid_controls(*args, **kwargs)#

Sets multigrid parameters and termination criteria.

multi_grid_fas(*args, **kwargs)#

Sets the parameters that control the FAS multigrid solver. This command appears only when the explicit coupled solver is used.

multi_stage(*args, **kwargs)#

Sets the multi-stage coefficients and the dissipation and viscous evaluation stages. This command appears only when the explicit coupled solver is used.

class multiphase_numerics(service, version, mode, path)#

Bases: TUIMenu

Sets multiphase numerics options.

Classes:

advanced_stability_controls(service, ...)	Enters the menu for the stability controls for multiphase flows.
boiling_parameters(service, version, mode, path)	Enters the menu for the multiphase boiling model parameters.
compressible_flow(service, version, mode, path)	Enters the compressible multiphase flow numerics menu.
default_controls(service, version, mode, path)	Enters the default controls menu.
face_pressure_controls(service, version, ...)	Enter the face pressure expert controls menu.
heat_mass_transfer(service, version, mode, path)	Enters the menu for the multiphase heat mass transfer parameters.
porous_media(service, version, mode, path)	Enters the porous media numerics menu.
solution_stabilization(service, version, ...)	Enters the solution-stabilization numerics menu.
viscous_flow(service, version, mode, path)	Enters the viscous multiphase flow numerics menu.

Methods:

stable_vof_settings(*args, **kwargs)

Execute Stable VOF settings.

class advanced_stability_controls(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for the stability controls for multiphase flows. For more information about the below option, see and .

Classes:

anti_diffusion(service, version, mode, path)	Enters the anti-diffusion menu.
equation_order(service, version, mode, path)	Enters the equation order menu for homogeneous multiphase flow models.
hybrid_nita(service, version, mode, path)	Enters the equation order menu for homogeneous multiphase flow models.
num_ventilation(service, version, mode, path)	Numerical Ventilation Menu for VOF Model.
p_v_coupling(service, version, mode, path)	Enters the menu for the pressure-velocity coupling controls.
pseudo_time(service, version, mode, path)	Pseudo-Time stability controls for multiphase flow.
pseudo_transient(service, version, mode, path)	Enters the stability control menu for steady-state multiphase cases with the pseudo time method option enabled.
velocity_limiting(service, version, mode, path)	Velocity limiting related stabiity controls for multiphase flow.

class anti_diffusion(service, version, mode, path)#

Bases: TUIMenu

Enters the anti-diffusion menu. This item is available for VOF cases with the Interfacial Anti-Diffusion option enabled.

Methods:

enable_dynamic_strength(*args, **kwargs)	Enables dynamic strength to reduce compression in the direction tangential to the interface.
set_dynamic_strength_exponent(*args, **kwargs)	Sets the cosine exponent in the dynamic strength treatment in ).
set_maximum_dynamic_strength(*args, **kwargs)	Sets the maximum value of dynamic anti-diffusion strength in ).

enable_dynamic_strength(*args, **kwargs)#

Enables dynamic strength to reduce compression in the direction tangential to the interface.

set_dynamic_strength_exponent(*args, **kwargs)#

Sets the cosine exponent in the dynamic strength treatment in ).

set_maximum_dynamic_strength(*args, **kwargs)#

Sets the maximum value of dynamic anti-diffusion strength in ).

class equation_order(service, version, mode, path)#

Bases: TUIMenu

Enters the equation order menu for homogeneous multiphase flow models.

Methods:

solve_exp_vof_at_end(*args, **kwargs)	.
solve_flow_last(*args, **kwargs)	When enabled, solves the flow equation at the end of the iteration.

solve_exp_vof_at_end(*args, **kwargs)#

.

solve_flow_last(*args, **kwargs)#

When enabled, solves the flow equation at the end of the iteration. This improves the behavior at the start of new time-step if the solution does not converge properly.

class hybrid_nita(service, version, mode, path)#

Bases: TUIMenu

Enters the equation order menu for homogeneous multiphase flow models.

Methods:

initial_outer_iterations(*args, **kwargs)	Allows you to change the number of initial time-steps and the number of initial outer iterations to control solution stability.
outer_iterations(*args, **kwargs)	Sets the number of outer iterations.

Classes:

instability_detector(service, version, mode, ...)

Enters the menu for the instability detector controls.

initial_outer_iterations(*args, **kwargs)#

Allows you to change the number of initial time-steps and the number of initial outer iterations to control solution stability.

class instability_detector(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for the instability detector controls.

Methods:

enable_instability_detector(*args, **kwargs)	Enables/disables the instability detector to deal with possible instability problems.
set_cfl_limit(*args, **kwargs)	Sets the Courant number limit for detecting unstable events.
set_cfl_type(*args, **kwargs)	Selects the CFL number type for detection of an unstable event.
set_velocity_limit(*args, **kwargs)	Sets the velocity limit for detecting unstable events.
unstable_event_outer_iterations(*args, **kwargs)	Sets the number of outer iterations for an unstable event.

enable_instability_detector(*args, **kwargs)#

Enables/disables the instability detector to deal with possible instability problems. Once this option is enabled, additional instability detection options become available.

set_cfl_limit(*args, **kwargs)#

Sets the Courant number limit for detecting unstable events. This command becomes available once the enable-instability-detector? text option has been enabled.

set_cfl_type(*args, **kwargs)#

Selects the CFL number type for detection of an unstable event. This command becomes available once the enable-instability-detector? text option has been enabled.

set_velocity_limit(*args, **kwargs)#

Sets the velocity limit for detecting unstable events. This command becomes available once the enable-instability-detector? text option has been enabled.

unstable_event_outer_iterations(*args, **kwargs)#

Sets the number of outer iterations for an unstable event.

outer_iterations(*args, **kwargs)#

Sets the number of outer iterations.

class num_ventilation(service, version, mode, path)#

Bases: TUIMenu

Numerical Ventilation Menu for VOF Model.

Methods:

enable(*args, **kwargs)	Enable numerical ventilation treatment to remove trapped phase adjacent to wall.
near_wall_treatment_options(*args, **kwargs)	Set near wall treatment options.
tau_estimation_options(*args, **kwargs)	Set time step size option for numerical ventilation treatment.
trapped_phase_vof_max(*args, **kwargs)	Set trapped phase maximum volume fraction to activate numerical ventilation treatment for non-trapped phases.
trapped_phase_vof_min(*args, **kwargs)	Set trapped phase minimum volume fraction to activate numerical ventilation treatment for trapped phase.

enable(*args, **kwargs)#

Enable numerical ventilation treatment to remove trapped phase adjacent to wall.

near_wall_treatment_options(*args, **kwargs)#

Set near wall treatment options.

tau_estimation_options(*args, **kwargs)#

Set time step size option for numerical ventilation treatment.

trapped_phase_vof_max(*args, **kwargs)#

Set trapped phase maximum volume fraction to activate numerical ventilation treatment for non-trapped phases.

trapped_phase_vof_min(*args, **kwargs)#

Set trapped phase minimum volume fraction to activate numerical ventilation treatment for trapped phase.

class p_v_coupling(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for the pressure-velocity coupling controls.

Classes:

coupled_vof(service, version, mode, path)	Enters the stability control menu for VOF cases that involve the Coupled pressure-velocity coupling scheme.
pressure_interpolation(service, version, ...)	Enters the pressure interpolation menu.
rhie_chow_flux(service, version, mode, path)	Enters the stability controls menu for the Rhie-Chow interpolation.
skewness_correction(service, version, mode, path)	Enters the skewness correction menu.

class coupled_vof(service, version, mode, path)#

Bases: TUIMenu

Enters the stability control menu for VOF cases that involve the Coupled pressure-velocity coupling scheme.

Methods:

buoyancy_force_linearization(*args, **kwargs)

Allows you to use the linearized buoyancy force and the blended treatment for the buoyancy force.

buoyancy_force_linearization(*args, **kwargs)#

Allows you to use the linearized buoyancy force and the blended treatment for the buoyancy force.

class pressure_interpolation(service, version, mode, path)#

Bases: TUIMenu

Enters the pressure interpolation menu.

Methods:

modified_bfw_scheme(*args, **kwargs)

Enables/disables the modified body force weighted interpolation scheme.

modified_bfw_scheme(*args, **kwargs)#

Enables/disables the modified body force weighted interpolation scheme. See for more information about this option.

class rhie_chow_flux(service, version, mode, path)#

Bases: TUIMenu

Enters the stability controls menu for the Rhie-Chow interpolation.

Methods:

low_order_rhie_chow(*args, **kwargs)

Enables/disables the low-order velocity interpolation in the flux calculation.

low_order_rhie_chow(*args, **kwargs)#

Enables/disables the low-order velocity interpolation in the flux calculation.

class skewness_correction(service, version, mode, path)#

Bases: TUIMenu

Enters the skewness correction menu.

Methods:

limit_pressure_correction_gradient(*args, ...)

Enables/disables the limited pressure correction gradient in skewness terms for the PISO, SIMPLEC, or fractional step pressure-coupling schemes.

limit_pressure_correction_gradient(*args, **kwargs)#

Enables/disables the limited pressure correction gradient in skewness terms for the PISO, SIMPLEC, or fractional step pressure-coupling schemes.

class pseudo_time(service, version, mode, path)#

Bases: TUIMenu

Pseudo-Time stability controls for multiphase flow.

Classes:

auto_dt_advanced_controls(service, version, ...)

Set automatic time-stepping controls for better solution stability.

Methods:

false_time_step_linearization(*args, **kwargs)	.
smoothed_density_stabilization_method(*args, ...)	.

class auto_dt_advanced_controls(service, version, mode, path)#

Bases: TUIMenu

Set automatic time-stepping controls for better solution stability.

Methods:

dt_factor_max(*args, **kwargs)	.
dt_factor_min(*args, **kwargs)	.
dt_init_limit(*args, **kwargs)	.
dt_max(*args, **kwargs)	.
enable(*args, **kwargs)	.
max_velocity_ratio(*args, **kwargs)	.

dt_factor_max(*args, **kwargs)#

.

dt_factor_min(*args, **kwargs)#

.

dt_init_limit(*args, **kwargs)#

.

dt_max(*args, **kwargs)#

.

enable(*args, **kwargs)#

.

max_velocity_ratio(*args, **kwargs)#

.

false_time_step_linearization(*args, **kwargs)#

.

smoothed_density_stabilization_method(*args, **kwargs)#

.

class pseudo_transient(service, version, mode, path)#

Bases: TUIMenu

Enters the stability control menu for steady-state multiphase cases with the pseudo time method option enabled.

Classes:

auto_dt_advanced_controls(service, version, ...)

Set automatic time-stepping controls for better solution stability.

Methods:

false_time_step_linearization(*args, **kwargs)	When enabled, provides additional stability for buoyancy-driven flows with the pseudo time method option enabled by increasing the diagonal dominance using the false time step size.
smoothed_density_stabilization_method(*args, ...)	Smooths the cell density near the interface, therefore avoiding unphysical acceleration of the lighter phase in the vicinity of interface.

class auto_dt_advanced_controls(service, version, mode, path)#

Bases: TUIMenu

Set automatic time-stepping controls for better solution stability.

Methods:

dt_factor_max(*args, **kwargs)	.
dt_factor_min(*args, **kwargs)	.
dt_init_limit(*args, **kwargs)	.
dt_max(*args, **kwargs)	.
enable(*args, **kwargs)	.
max_velocity_ratio(*args, **kwargs)	.

dt_factor_max(*args, **kwargs)#

.

dt_factor_min(*args, **kwargs)#

.

dt_init_limit(*args, **kwargs)#

.

dt_max(*args, **kwargs)#

.

enable(*args, **kwargs)#

.

max_velocity_ratio(*args, **kwargs)#

.

false_time_step_linearization(*args, **kwargs)#

When enabled, provides additional stability for buoyancy-driven flows with the pseudo time method option enabled by increasing the diagonal dominance using the false time step size.

smoothed_density_stabilization_method(*args, **kwargs)#

Smooths the cell density near the interface, therefore avoiding unphysical acceleration of the lighter phase in the vicinity of interface. The default number of density smoothings is 2. In case of very large unphysical velocities across the interface, you can increase this number when prompted with Number of density smoothings.

class velocity_limiting(service, version, mode, path)#

Bases: TUIMenu

Velocity limiting related stabiity controls for multiphase flow.

Methods:

enable_velocity_limiting(*args, **kwargs)	.
set_damping_strength(*args, **kwargs)	.
set_damping_strengths(*args, **kwargs)	Set phase based damping strength.
set_velocity_and_vof_cutoffs(*args, **kwargs)	Set phase based velocity limiting controls.
set_velocity_cutoff(*args, **kwargs)	.
verbosity(*args, **kwargs)	.

enable_velocity_limiting(*args, **kwargs)#

.

set_damping_strength(*args, **kwargs)#

.

set_damping_strengths(*args, **kwargs)#

Set phase based damping strength.

set_velocity_and_vof_cutoffs(*args, **kwargs)#

Set phase based velocity limiting controls.

set_velocity_cutoff(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

.

class boiling_parameters(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for the multiphase boiling model parameters.

Methods:

liquid_vof_factor(*args, **kwargs)	When enabled, considers liquid volume fraction effects by multiplying the heat transfer coefficients by the local liquid volume fraction.
thin_film(*args, **kwargs)	When enabled, includes multiphase boiling thin film effects using .

liquid_vof_factor(*args, **kwargs)#

When enabled, considers liquid volume fraction effects by multiplying the heat transfer coefficients by the local liquid volume fraction.

thin_film(*args, **kwargs)#

When enabled, includes multiphase boiling thin film effects using .

class compressible_flow(service, version, mode, path)#

Bases: TUIMenu

Enters the compressible multiphase flow numerics menu.

Methods:

alternate_bc_formulation(*args, **kwargs)	Enables an alternative formulation for compressible phases at an inlet boundary.
enhanced_numerics(*args, **kwargs)	Enables an enhanced numerical treatment that provides better stability at startup and during calculation of compressible flows.

alternate_bc_formulation(*args, **kwargs)#

Enables an alternative formulation for compressible phases at an inlet boundary. This formulation calculates static temperature and pressure using an iterative method based on fundamental thermodynamic relations.

enhanced_numerics(*args, **kwargs)#

Enables an enhanced numerical treatment that provides better stability at startup and during calculation of compressible flows.

class default_controls(service, version, mode, path)#

Bases: TUIMenu

Enters the default controls menu. This menu is available only for multiphase flows.

Methods:

recommended_defaults_for_existing_cases(...)	Applies the multiphase defaults (version 2020 R1) to the loaded case file.
revert_to_pre_r20_point_1_default_settings(...)	.

recommended_defaults_for_existing_cases(*args, **kwargs)#

Applies the multiphase defaults (version 2020 R1) to the loaded case file.

revert_to_pre_r20_point_1_default_settings(*args, **kwargs)#

.

class face_pressure_controls(service, version, mode, path)#

Bases: TUIMenu

Enter the face pressure expert controls menu.

Methods:

face_pressure_options(*args, **kwargs)

Set face pressure options.

face_pressure_options(*args, **kwargs)#

Set face pressure options.

class heat_mass_transfer(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for the multiphase heat mass transfer parameters.

Methods:

alternative_energy_treatment(*args, **kwargs)

Enables the alternative treatment of the energy sources.

Classes:

area_density(service, version, mode, path)	Enters the menu for the area density.
boiling(service, version, mode, path)	Enters the menu for the advanced boiling options for the semi-mechanistic boiling model.
cavitation(service, version, mode, path)	Enters the cavitation heat mass transfer menu.
evaporation_condensation(service, version, ...)	Evaporation-condensation advanced options menu.

alternative_energy_treatment(*args, **kwargs)#

Enables the alternative treatment of the energy sources. For more information, see .

class area_density(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for the area density.

Methods:

ia_grad_sym(*args, **kwargs)	Enables/disables the interfacial area density Gradient-Symmetric model.
vof_min_seeding(*args, **kwargs)	Sets the minimum volume fraction for the area density and cavitation.

ia_grad_sym(*args, **kwargs)#

Enables/disables the interfacial area density Gradient-Symmetric model. For more information about this model, see .

vof_min_seeding(*args, **kwargs)#

Sets the minimum volume fraction for the area density and cavitation. This may be useful, for example, in cases when a species mass transfer model (such as the Symmetric model or Particle model) do not consider evaporation or condensation if the volume fraction of one of the phases is zero. The seeding allows for a phase change to occur in the fluid flow. The default value is 1e-6.

class boiling(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for the advanced boiling options for the semi-mechanistic boiling model.

Methods:

heat_flux_relaxation_factor(*args, **kwargs)	Sets the under-relaxation factor for boiling heat flux.
show_expert_options(*args, **kwargs)	Exposes the expert options for the semi-mechanistic boiling model.
two_resistance_boiling_framework(*args, **kwargs)	Enables/disables the two-resistance boiling framework to improve the robustness and accuracy of the solution of cases with multiple boiling mechanisms.

heat_flux_relaxation_factor(*args, **kwargs)#

Sets the under-relaxation factor for boiling heat flux. See for details.

show_expert_options(*args, **kwargs)#

Exposes the expert options for the semi-mechanistic boiling model. For more information about these options, see .

two_resistance_boiling_framework(*args, **kwargs)#

Enables/disables the two-resistance boiling framework to improve the robustness and accuracy of the solution of cases with multiple boiling mechanisms. For more information about this item, see .

class cavitation(service, version, mode, path)#

Bases: TUIMenu

Enters the cavitation heat mass transfer menu.

Methods:

display_clipped_pressure(*args, **kwargs)	.
max_vapor_pressure_ratio(*args, **kwargs)	Sets the maximum limit on the vapor pressure after the turbulence and thermal correction.
min_vapor_pressure(*args, **kwargs)	Sets the minimum vapor pressure limit for the cavitation mass-transfer model.
schnerr_cond_coeff(*args, **kwargs)	Sets the condensation coefficient for the Schnerr-Sauer model ( in ).
schnerr_evap_coeff(*args, **kwargs)	Sets the evaporation coefficient for the Schnerr-Sauer model ( in ).
turbulent_diffusion(*args, **kwargs)	Enables/disables the turbulent diffusion treatment for a cavitating turbulent flow.

display_clipped_pressure(*args, **kwargs)#

.

max_vapor_pressure_ratio(*args, **kwargs)#

Sets the maximum limit on the vapor pressure after the turbulence and thermal correction. The default value is five times the vapor pressure, with consideration of turbulent and thermal effects for each cell and phase.

min_vapor_pressure(*args, **kwargs)#

Sets the minimum vapor pressure limit for the cavitation mass-transfer model. The default value is 1 Pa.

schnerr_cond_coeff(*args, **kwargs)#

Sets the condensation coefficient for the Schnerr-Sauer model ( in ). The default and recommended value of 0.2.

schnerr_evap_coeff(*args, **kwargs)#

Sets the evaporation coefficient for the Schnerr-Sauer model ( in ). The default and recommended value of 1.

turbulent_diffusion(*args, **kwargs)#

Enables/disables the turbulent diffusion treatment for a cavitating turbulent flow. See for details.

class evaporation_condensation(service, version, mode, path)#

Bases: TUIMenu

Evaporation-condensation advanced options menu.

Methods:

ia_norm_min_limit(*args, **kwargs)	.
max_rel_humiditiy(*args, **kwargs)	.
vof_from_max_limit(*args, **kwargs)	.
vof_from_min_limit(*args, **kwargs)	.
vof_to_max_limit(*args, **kwargs)	.
vof_to_min_limit(*args, **kwargs)	.

ia_norm_min_limit(*args, **kwargs)#

.

max_rel_humiditiy(*args, **kwargs)#

.

vof_from_max_limit(*args, **kwargs)#

.

vof_from_min_limit(*args, **kwargs)#

.

vof_to_max_limit(*args, **kwargs)#

.

vof_to_min_limit(*args, **kwargs)#

.

class porous_media(service, version, mode, path)#

Bases: TUIMenu

Enters the porous media numerics menu.

Methods:

capillary_pressure_as_diffusion(*args, **kwargs)	.
relative_permeability(*args, **kwargs)	Allows you to fix the saturation (volume fraction) of the phase at its user-specified residual saturation value.

capillary_pressure_as_diffusion(*args, **kwargs)#

.

relative_permeability(*args, **kwargs)#

Allows you to fix the saturation (volume fraction) of the phase at its user-specified residual saturation value.

class solution_stabilization(service, version, mode, path)#

Bases: TUIMenu

Enters the solution-stabilization numerics menu. This item is available only for the VOF model.

Classes:

additional_stabilization_controls(service, ...)	Enters the menu for additional advanced stability controls.
velocity_limiting_treatment(service, ...)	Enters the menu for the velocity-limiting-treatment.

Methods:

execute_additional_stability_controls(*args, ...)	When enabled, uses additional controls for improved solution stability.
execute_advanced_stabilization(*args, **kwargs)	When enabled, modifies solver settings for improved solution stability.
execute_settings_optimization(*args, **kwargs)	.

class additional_stabilization_controls(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for additional advanced stability controls.

Methods:

blended_compressive_scheme(*args, **kwargs)	Enables/disables the blended compressive discretization scheme.
pseudo_time_stabilization(*args, **kwargs)	.
pseudo_transient_stabilization(*args, **kwargs)	Enables/disables the pseudo-transient momentum stabilization and false time step linearization methods.

blended_compressive_scheme(*args, **kwargs)#

Enables/disables the blended compressive discretization scheme.

pseudo_time_stabilization(*args, **kwargs)#

.

pseudo_transient_stabilization(*args, **kwargs)#

Enables/disables the pseudo-transient momentum stabilization and false time step linearization methods.

execute_additional_stability_controls(*args, **kwargs)#

When enabled, uses additional controls for improved solution stability.

execute_advanced_stabilization(*args, **kwargs)#

When enabled, modifies solver settings for improved solution stability.

execute_settings_optimization(*args, **kwargs)#

.

class velocity_limiting_treatment(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for the velocity-limiting-treatment.

Methods:

enable_velocity_limiting(*args, **kwargs)	Enables/disables the velocity limiting treatment.
set_damping_strength(*args, **kwargs)	.
set_damping_strengths(*args, **kwargs)	Set phase based damping strength.
set_velocity_and_vof_cutoffs(*args, **kwargs)	Set phase based velocity limiting controls.
set_velocity_cutoff(*args, **kwargs)	Specifies the maximum velocity magnitude.
verbosity(*args, **kwargs)	When enabled, the solver prints the number of velocity limited cells at each iteration.

enable_velocity_limiting(*args, **kwargs)#

Enables/disables the velocity limiting treatment.

set_damping_strength(*args, **kwargs)#

.

set_damping_strengths(*args, **kwargs)#

Set phase based damping strength.

set_velocity_and_vof_cutoffs(*args, **kwargs)#

Set phase based velocity limiting controls.

set_velocity_cutoff(*args, **kwargs)#

Specifies the maximum velocity magnitude.

verbosity(*args, **kwargs)#

When enabled, the solver prints the number of velocity limited cells at each iteration.

stable_vof_settings(*args, **kwargs)#

Execute Stable VOF settings.

class viscous_flow(service, version, mode, path)#

Bases: TUIMenu

Enters the viscous multiphase flow numerics menu.

Methods:

interfacial_artificial_viscosity(*args, **kwargs)	.
turb_visc_based_damping(*args, **kwargs)	Turbulence viscosity based damping controls.
viscosity_averaging(*args, **kwargs)	Forces harmonic averaging of cell viscosities to calculate face viscosity used in momentum equation.

interfacial_artificial_viscosity(*args, **kwargs)#

.

turb_visc_based_damping(*args, **kwargs)#

Turbulence viscosity based damping controls.

viscosity_averaging(*args, **kwargs)#

Forces harmonic averaging of cell viscosities to calculate face viscosity used in momentum equation. This can improve convergence for highly viscous flow applications (the VOF model only).

nb_gradient_boundary_option(*args, **kwargs)#

Switches between the modified treatment of node-based gradients at boundary cells and the legacy treatment (R14.5.7 and earlier). If using the density-based solver, you can also specify the extended treatment. For details, see .

class nita_expert_controls(service, version, mode, path)#

Bases: TUIMenu

Enters the NITA expert control menu.

Methods:

hybrid_nita_settings(*args, **kwargs)	Enables and sets hybrid NITA options.
skewness_neighbor_coupling(*args, **kwargs)	Enables/disables coupling of the neighbor and skewness corrections.
verbosity(*args, **kwargs)	.

hybrid_nita_settings(*args, **kwargs)#

Enables and sets hybrid NITA options. For more details, see .

skewness_neighbor_coupling(*args, **kwargs)#

Enables/disables coupling of the neighbor and skewness corrections.

verbosity(*args, **kwargs)#

.

number_of_iterations(*args, **kwargs)#

Sets the number of iterations for a steady-state simulation without starting the calculation.

numerical_beach_controls(*args, **kwargs)#

Sets damping function in flow direction. This command appears only when the VOF model is enabled. Select the damping function to be used: Index Damping Function 0 Linear 1 Quadratic 2 Cubic 3 Cosine.

numerics(*args, **kwargs)#

Sets numerics options.

open_channel_controls(*args, **kwargs)#

For flows that do not transition from sub-critical to super-critical, or vice-versa, you can speed-up the solution calculation by updating the frequency of Froude number during run time.

class open_channel_wave_options(service, version, mode, path)#

Bases: TUIMenu

Sets buffer layer height, verbosity, and open channel wave theory formulation.

Methods:

set_buffer_layer_ht(*args, **kwargs)	Sets the buffer layer height.
set_verbosity(*args, **kwargs)	Sets the open channel wave verbosity.
stokes_wave_variants(*args, **kwargs)	Specifies which open channel wave theory formulation Fluent uses.

set_buffer_layer_ht(*args, **kwargs)#

Sets the buffer layer height.

set_verbosity(*args, **kwargs)#

Sets the open channel wave verbosity.

stokes_wave_variants(*args, **kwargs)#

Specifies which open channel wave theory formulation Fluent uses.

class overset(service, version, mode, path)#

Bases: TUIMenu

Specifies overset meshing solver options.

Classes:

expert(service, version, mode, path)

Enter overset expert solver options menu.

Methods:

high_order_pressure(*args, **kwargs)	Uses the pressure gradient of the donor cell in the interpolation of pressure for its receptor cell.
interpolation_method(*args, **kwargs)	Selects the interpolation method for overset interfaces.
orphan_cell_treatment(*args, **kwargs)	Enables/disables a numerical treatment that attempts to assign reasonable data values to orphan cells.

class expert(service, version, mode, path)#

Bases: TUIMenu

Enter overset expert solver options menu.

Methods:

hybrid_mode_selection(*args, **kwargs)	Mode for hybrid interpolation.
mass_flux_correction_method(*args, **kwargs)	Enter mass flux correction option at overset interfaces.

hybrid_mode_selection(*args, **kwargs)#

Mode for hybrid interpolation.

mass_flux_correction_method(*args, **kwargs)#

Enter mass flux correction option at overset interfaces.

high_order_pressure(*args, **kwargs)#

Uses the pressure gradient of the donor cell in the interpolation of pressure for its receptor cell.

interpolation_method(*args, **kwargs)#

Selects the interpolation method for overset interfaces. Note that the least squares method is recommended for sliding mesh cases.

orphan_cell_treatment(*args, **kwargs)#

Enables/disables a numerical treatment that attempts to assign reasonable data values to orphan cells.

p_v_controls(*args, **kwargs)#

Sets pressure-velocity controls.

p_v_controls_advanced(*args, **kwargs)#

Set advanced pressure-velocity coupling controls.

p_v_coupling(*args, **kwargs)#

Selects which pressure-velocity coupling scheme is to be used. Five schemes are available:.

phase_based_vof_discretization(*args, **kwargs)#

Sets phase based slope limiter for VOF compressive scheme.

class poor_mesh_numerics(service, version, mode, path)#

Bases: TUIMenu

Enters the poor mesh numerics menu.

Methods:

cell_quality_based(*args, **kwargs)	Enables/disables the application of poor mesh numerics on cells with an orthogonal quality that is equal to or less than the threshold defined by the solve/set/poor-mesh-numerics/set-quality-threshold text command (which by default is set to 0.05).
enable(*args, **kwargs)	Enables/disables the application of poor mesh numerics on cells (those with an orthogonal quality of 0, as well as those identified by other enabled criteria), and defines whether the local solution correction is 0th, 1st, or 2nd order.
enhanced_pmn(*args, **kwargs)	This option is available with the density-based solver.
gradient_quality_based(*args, **kwargs)	Enables/disables the detection and treatment of poor cells using a criterion based on the cell gradient quality.
orthogonality_enhancing_cell_centroids(...)	Enables/disables the relocation of select cell centroids, to improve the orthogonality metrics and solution stability.
print_poor_elements_count(*args, **kwargs)	Prints out a listing of the poor cells for each criterion: default, cell quality, and user-defined, and (if enabled) cell gradient quality and solution and cell quality.
reset_poor_elements(*args, **kwargs)	Resets the list of poor cells included by the default, cell quality, user-defined, cell gradient quality, and solution and cell quality criteria.
set_quality_threshold(*args, **kwargs)	Sets the orthogonal quality threshold used for applying poor mesh numerics when the solve/set/poor-mesh-numerics/cell-quality-based? text command is enabled.
solution_and_quality_based(*args, **kwargs)	Enables/disables the detection and treatment of poor cells using a criterion based on the solution and cell quality.
turbulence_production_term(*args, **kwargs)	Enable/disable poor mesh numerics for turbulence production term.
user_defined_on_register(*args, **kwargs)	Includes a register for the poor mesh numerics or not.
user_defined_on_register_auto(*args, **kwargs)	Set up the application of poor mesh numerics to cells in registers during the calculation at a specified frequency.

Classes:

register_based(service, version, mode, path)	.
solution_based_pmn(service, version, mode, path)	Solution based poor-mesh numerics menu.

cell_quality_based(*args, **kwargs)#

Enables/disables the application of poor mesh numerics on cells with an orthogonal quality that is equal to or less than the threshold defined by the solve/set/poor-mesh-numerics/set-quality-threshold text command (which by default is set to 0.05).

enable(*args, **kwargs)#

Enables/disables the application of poor mesh numerics on cells (those with an orthogonal quality of 0, as well as those identified by other enabled criteria), and defines whether the local solution correction is 0th, 1st, or 2nd order.

enhanced_pmn(*args, **kwargs)#

This option is available with the density-based solver. When enabled, it will apply quality-based poor-mesh-numerics order=1 on any cells with a quality-measure below 0.2. In addition, their CFL number is limited to 1.0.

gradient_quality_based(*args, **kwargs)#

Enables/disables the detection and treatment of poor cells using a criterion based on the cell gradient quality. Poor mesh numerics are applied when the criterion value is equal to or less than a threshold value defined as part of this text command. This criterion is only available with the pressure-based solver, and is not supported for cases that have periodic boundaries.

orthogonality_enhancing_cell_centroids(*args, **kwargs)#

Enables/disables the relocation of select cell centroids, to improve the orthogonality metrics and solution stability. It is applied to cells when the criterion value is equal to or less than a threshold value defined as part of the text command. Note that the enhanced metrics are only apparent when reporting the quality in the solution mode of Fluent, and not in the meshing mode.

print_poor_elements_count(*args, **kwargs)#

Prints out a listing of the poor cells for each criterion: default, cell quality, and user-defined, and (if enabled) cell gradient quality and solution and cell quality.

class register_based(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

delete(*args, **kwargs)	Delete a definition for poor mesh numerics.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit a definition for poor mesh numerics.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
new(*args, **kwargs)	Add a new definition for poor mesh numerics.
rename(*args, **kwargs)	Rename register-based object.
set(*args, **kwargs)	.

delete(*args, **kwargs)#

Delete a definition for poor mesh numerics.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit a definition for poor mesh numerics.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

new(*args, **kwargs)#

Add a new definition for poor mesh numerics.

rename(*args, **kwargs)#

Rename register-based object.

set(*args, **kwargs)#

.

reset_poor_elements(*args, **kwargs)#

Resets the list of poor cells included by the default, cell quality, user-defined, cell gradient quality, and solution and cell quality criteria.

set_quality_threshold(*args, **kwargs)#

Sets the orthogonal quality threshold used for applying poor mesh numerics when the solve/set/poor-mesh-numerics/cell-quality-based? text command is enabled. By default, cells with an orthogonal quality of 0.05 or lower are corrected.

solution_and_quality_based(*args, **kwargs)#

Enables/disables the detection and treatment of poor cells using a criterion based on the solution and cell quality. Poor mesh numerics are applied when the criterion value is equal to or less than a threshold value defined as part of this text command, and at a specified frequency (of iterations or time steps). This criterion is only available with the pressure-based solver.

class solution_based_pmn(service, version, mode, path)#

Bases: TUIMenu

Solution based poor-mesh numerics menu.

Methods:

enable(*args, **kwargs)	Enable solution based treatment.
mark_cfl_jump(*args, **kwargs)	Mark cells exceeding cfl jump in neighborhood.
mark_cfl_limit(*args, **kwargs)	Mark cells exceeding cfl limit.
mark_primary_solution_limits(*args, **kwargs)	Mark cells violating solution limits.
mark_velocity_limit(*args, **kwargs)	Mark cells exceeding velocity limit.

enable(*args, **kwargs)#

Enable solution based treatment.

mark_cfl_jump(*args, **kwargs)#

Mark cells exceeding cfl jump in neighborhood.

mark_cfl_limit(*args, **kwargs)#

Mark cells exceeding cfl limit.

mark_primary_solution_limits(*args, **kwargs)#

Mark cells violating solution limits.

mark_velocity_limit(*args, **kwargs)#

Mark cells exceeding velocity limit.

turbulence_production_term(*args, **kwargs)#

Enable/disable poor mesh numerics for turbulence production term.

user_defined_on_register(*args, **kwargs)#

Includes a register for the poor mesh numerics or not.

user_defined_on_register_auto(*args, **kwargs)#

Set up the application of poor mesh numerics to cells in registers during the calculation at a specified frequency.

class previous_defaults(service, version, mode, path)#

Bases: TUIMenu

Provides text commands that allow you to undo enhancements to the default solver behavior.

Methods:

undo_2019r1_default_changes(*args, **kwargs)	Allows you to undo enhancements introduced in version 2019 R1 of ANSYS Fluent, including:.
undo_2019r3_default_changes(*args, **kwargs)	Allows you to undo enhancements introduced in version 2019 R3 of ANSYS Fluent, including:.
undo_2021r1_default_changes(*args, **kwargs)	Allows you to undo enhancements introduced in version 2021 R1 of ANSYS Fluent, including:.
undo_2021r2_default_changes(*args, **kwargs)	Allows you to undo the following enhancements introduced in version 2021 R2 of ANSYS Fluent:.
undo_2022r1_default_changes(*args, **kwargs)	Allows you to undo the following enhancements introduced in version 2022 R1 of ANSYS Fluent:.
undo_2023r1_default_changes(*args, **kwargs)	Undo default changes introduced in 2023R1.
undo_2023r2_default_changes(*args, **kwargs)	Undo default changes introduced in 2023R2.
undo_r19_point_0_default_changes(*args, **kwargs)	Undo default changes introduced in R19.0.

undo_2019r1_default_changes(*args, **kwargs)#

Allows you to undo enhancements introduced in version 2019 R1 of ANSYS Fluent, including:.

undo_2019r3_default_changes(*args, **kwargs)#

Allows you to undo enhancements introduced in version 2019 R3 of ANSYS Fluent, including:.

undo_2021r1_default_changes(*args, **kwargs)#

Allows you to undo enhancements introduced in version 2021 R1 of ANSYS Fluent, including:.

undo_2021r2_default_changes(*args, **kwargs)#

Allows you to undo the following enhancements introduced in version 2021 R2 of ANSYS Fluent:.

undo_2022r1_default_changes(*args, **kwargs)#

Allows you to undo the following enhancements introduced in version 2022 R1 of ANSYS Fluent:.

undo_2023r1_default_changes(*args, **kwargs)#

Undo default changes introduced in 2023R1.

undo_2023r2_default_changes(*args, **kwargs)#

Undo default changes introduced in 2023R2.

undo_r19_point_0_default_changes(*args, **kwargs)#

Undo default changes introduced in R19.0.

pseudo_relaxation_factor(*args, **kwargs)#

For backward compatibility, pseudo relaxation factor menu.

class pseudo_time_method(service, version, mode, path)#

Bases: TUIMenu

Enters the pseudo time method menu. This menu is only available for cases that use a pressure-based segregated solver (SIMPLE, SIMPLEC, or PISO) or for steady-state cases that use the pressure-based coupled solver or the density-based implicit solver.

Methods:

advanced_options(*args, **kwargs)	Enters the advanced options menu, which allows you to enable / disable the pseudo time method for individual equations and define their pseudo time scale factors or under-relaxation factors, respectively.
convergence_acceleration_for_stretched_meshes(...)	Enable convergence acceleration for stretched meshes to improve the convergence of the implicit pressure based solver on meshes with high cell stretching.
explicit_relaxation(*args, **kwargs)	Enable the explicit relaxation option for the pseudo time method.
formulation(*args, **kwargs)	Enables and sets the pseudo time step size formulation or disables the pseudo time method option.
global_time_step_settings(*args, **kwargs)	Defines the pseudo time settings for the calculation when the global time step formulation is selected.
local_time_step_settings(*args, **kwargs)	Defines the pseudo time Courant number when the local time step formulation is selected.
relaxation_bounds(*args, **kwargs)	Select relaxation bounding scheme for pseudo time method.
relaxation_factors(*args, **kwargs)	Enters the relaxation factors menu, where you can set the pseudo time explicit relaxation factors for individual equations.
relaxation_method(*args, **kwargs)	Select relaxation definition for pseudo time method.
verbosity(*args, **kwargs)	Sets the verbosity of the messages related to the pseudo time method.

advanced_options(*args, **kwargs)#

Enters the advanced options menu, which allows you to enable / disable the pseudo time method for individual equations and define their pseudo time scale factors or under-relaxation factors, respectively. These settings only apply when the global time step formulation is selected.

convergence_acceleration_for_stretched_meshes(*args, **kwargs)#

Enable convergence acceleration for stretched meshes to improve the convergence of the implicit pressure based solver on meshes with high cell stretching.

explicit_relaxation(*args, **kwargs)#

Enable the explicit relaxation option for the pseudo time method.

formulation(*args, **kwargs)#

Enables and sets the pseudo time step size formulation or disables the pseudo time method option.

global_time_step_settings(*args, **kwargs)#

Defines the pseudo time settings for the calculation when the global time step formulation is selected.

local_time_step_settings(*args, **kwargs)#

Defines the pseudo time Courant number when the local time step formulation is selected.

relaxation_bounds(*args, **kwargs)#

Select relaxation bounding scheme for pseudo time method.

relaxation_factors(*args, **kwargs)#

Enters the relaxation factors menu, where you can set the pseudo time explicit relaxation factors for individual equations. These factors only apply when the global time step formulation is selected.

relaxation_method(*args, **kwargs)#

Select relaxation definition for pseudo time method.

verbosity(*args, **kwargs)#

Sets the verbosity of the messages related to the pseudo time method.

pseudo_transient(*args, **kwargs)#

For backward compatibility, pseudo transient (global time-step) formulation setup.

pseudo_transient_expert(*args, **kwargs)#

For backward compatibility, pseudo transient expert usage control.

reactions(*args, **kwargs)#

Enables the species reaction sources and sets relaxation factor.

reduced_rank_extrapolation(*args, **kwargs)#

Enable Reduced Rank Extrapolation method to accelerate solution time.

reduced_rank_extrapolation_options(*args, **kwargs)#

Reduced Rank Extrapolation options.

relaxation_factor(*args, **kwargs)#

Enters the relaxation-factor menu.

relaxation_method(*args, **kwargs)#

Sets the solver relaxation method.

reporting_interval(*args, **kwargs)#

Sets the number of iterations for which convergence monitors are reported. The default is 1 (after every iteration).

residual_smoothing(*args, **kwargs)#

Sets the implicit residual smoothing parameters. This command is available only for the explicit coupled solver.

residual_tolerance(*args, **kwargs)#

Enters the residual tolerance menu.

residual_verbosity(*args, **kwargs)#

Sets the amount of residual information to be printed. A value of 0 (the default) prints residuals at the end of each fine grid iteration. A value of 1 prints residuals after every stage of the fine grid iteration. A value of 2 prints residuals after every stage on every grid level.

second_order_time_options(*args, **kwargs)#

Enables / disables the variable time step size formulation for second-order implicit transient formulations. If you disable the variable time step size formulation, note that any change in the time step size will introduce an error proportional to the change in the time step size ratio.

set_all_species_together(*args, **kwargs)#

Sets all species discretizations and URFs together.

set_controls_to_default(*args, **kwargs)#

Sets controls to default values.

set_solution_methods_to_default(*args, **kwargs)#

Sets the solution methods to the default settings.

set_solution_steering(*args, **kwargs)#

Sets solution steering parameters.

class slope_limiter_menu(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

direction(*args, **kwargs)	.
filter(*args, **kwargs)	.
type(*args, **kwargs)	.

direction(*args, **kwargs)#

.

filter(*args, **kwargs)#

.

type(*args, **kwargs)#

.

slope_limiter_set(*args, **kwargs)#

Selects a new Fluent solver slope limiter.

solution_steering(*args, **kwargs)#

Enables solution steering for the density-based solver.

stiff_chemistry(*args, **kwargs)#

Sets solver options for stiff chemistry solutions.

surface_tension(*args, **kwargs)#

Sets surface-tension calculation options.

surface_tension_expert(*args, **kwargs)#

Set surface-tension expert options.

time_step(*args, **kwargs)#

Set the time step.

class transient_controls(service, version, mode, path)#

Bases: TUIMenu

Enters the transient controls menu, which allows you to define settings related to time advancement for transient flow calculations.

Methods:

cfl_based_time_stepping(*args, **kwargs)	Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent as the calculation proceeds such that the Courant–Friedrichs–Lewy (CFL) condition is satisfied, using the specified Courant number.
cfl_based_time_stepping_advanced_options(...)	Set CFL-based adaptive time-stepping advanced parameters.
duration_specification_method(*args, **kwargs)	Sets the method by which you will specify the duration of the calculation.
error_based_time_stepping(*args, **kwargs)	Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the specified truncation error tolerance.
extrapolate_eqn_vars(*args, **kwargs)	Enters the extrapolation menu.
extrapolate_vars(*args, **kwargs)	Applies a predictor algorithm for computing initial conditions at time step n+1.
fixed_periodic(*args, **kwargs)	Allows you to specify that a fixed time stepping method is used in which a specified period or frequency is the basis for determining the time step size and number of time steps.
fixed_user_specified(*args, **kwargs)	Allows you to specify that a fixed time stepping method is used in which you directly specify the time step size and number of time steps.
incremental_time(*args, **kwargs)	Sets the amount of incremental (that is, additional) time to run the simulation, regardless of how much time has already been run in previous calculations.
max_flow_time(*args, **kwargs)	Sets the maximum flow time.
max_iterations_per_time_step(*args, **kwargs)	Sets the number of time steps for a transient simulation.
multiphase_specific_time_stepping(*args, ...)	Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the convective time scale (global Courant number): the time-step-size calculation depends on the mesh density and velocity in interfacial cells.
number_of_time_steps(*args, **kwargs)	Sets the number of time steps for a transient simulation without starting the calculation.
predict_next_time(*args, **kwargs)	Applies a predictor algorithm for computing the next time step.
rotating_mesh_flow_predictor(*args, **kwargs)	Enables / disables an option that allows for better prediction of the flow field in rotating fluid zones at every time step, in order to speed up the calculation.
solid_time_step_size(*args, **kwargs)	Allows you to specify that the time step size used for solid zones is independent from that used for fluid zones.
solution_status(*args, **kwargs)	Allows you to open theSimulation Status dialog box, which reports details about the simulation.
specified_time_step(*args, **kwargs)	Specifies whether to define the transient advancement either directly by entering a time step size / period / frequency (using the text commands available in thesolve/set/transient-controls menu) or indirectly by entering a Courant number value (using the solve/set/courant-number text command).
time_step_size(*args, **kwargs)	Sets the magnitude of the (physical) time step .
time_step_size_for_acoustic_export(*args, ...)	Specifies the time interval for acoustic data sampling.
total_number_of_time_steps(*args, **kwargs)	Sets the total number of time steps that the simulation will run (which includes any time steps that have already been run in previous calculations).
total_time(*args, **kwargs)	Sets the total amount of time that the simulation will be run (which includes any time that has already been run in previous calculations).
udf_based_time_stepping(*args, **kwargs)	Allows you to specify that the time step size is defined by a user-defined function (UDF) that uses theDEFINE_DELTAT macro.
undo_timestep(*args, **kwargs)	When enabled, if the truncation error within a time step exceeds the specified tolerance Fluent will automatically undo the current calculation and make another attempt with the time step reduced by 1/2.

Classes:

multiphase_specific_time_constraints(...)

Enters the menu for setting multiphase-specific time constraints.

cfl_based_time_stepping(*args, **kwargs)#

Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent as the calculation proceeds such that the Courant–Friedrichs–Lewy (CFL) condition is satisfied, using the specified Courant number.

cfl_based_time_stepping_advanced_options(*args, **kwargs)#

Set CFL-based adaptive time-stepping advanced parameters.

duration_specification_method(*args, **kwargs)#

Sets the method by which you will specify the duration of the calculation. The duration can be defined by the total time, the total number of time steps, the incremental time, or the number of incremental time steps. In this context, “total” indicates that Fluent will consider the amount of time / steps that have already been solved and stop appropriately, whereas “incremental” indicates that the solution will proceed for a specified amount of time / steps regardless of what has previously been calculated. This text command is only available when the time stepping is adaptive or based on a user-defined function.

error_based_time_stepping(*args, **kwargs)#

Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the specified truncation error tolerance.

extrapolate_eqn_vars(*args, **kwargs)#

Enters the extrapolation menu.

extrapolate_vars(*args, **kwargs)#

Applies a predictor algorithm for computing initial conditions at time step n+1. The predictor algorithm is a computation that sets a better initial condition for the time step.

fixed_periodic(*args, **kwargs)#

Allows you to specify that a fixed time stepping method is used in which a specified period or frequency is the basis for determining the time step size and number of time steps.

fixed_user_specified(*args, **kwargs)#

Allows you to specify that a fixed time stepping method is used in which you directly specify the time step size and number of time steps.

incremental_time(*args, **kwargs)#

Sets the amount of incremental (that is, additional) time to run the simulation, regardless of how much time has already been run in previous calculations. This text command is only available when the solve/set/transient-controls/duration-specification-method is set to3.

max_flow_time(*args, **kwargs)#

Sets the maximum flow time.

max_iterations_per_time_step(*args, **kwargs)#

Sets the number of time steps for a transient simulation. This option is available when automatic initialization and case modification is enabled.

class multiphase_specific_time_constraints(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for setting multiphase-specific time constraints.

Methods:

moving_mesh_cfl_constraint(*args, **kwargs)	.
physics_based_constraint(*args, **kwargs)	Enables/disables the physics-driven time-step constraints.
verbosity(*args, **kwargs)	When enabled, various time scales (depending on the selection) are printed to the console window at every time step.

Classes:

time_scale_options(service, version, mode, path)

Enters the menu for choosing the time-scale options.

moving_mesh_cfl_constraint(*args, **kwargs)#

.

physics_based_constraint(*args, **kwargs)#

Enables/disables the physics-driven time-step constraints.

class time_scale_options(service, version, mode, path)#

Bases: TUIMenu

Enters the menu for choosing the time-scale options. This menu becomes available after you enable the physics-driven time-step constraints using the solve/set/transient-controls/multiphase-specific-time-constraints/physics-based-constraint? text command.

Methods:

acoustic_scale(*args, **kwargs)	Allows you to Include the acoustic time scale.
gravity_scale(*args, **kwargs)	Allows you to Include the gravitational time scale.
surface_tension_scale(*args, **kwargs)	Allows you to Include the surface-tension-driven time scale.
viscous_scale(*args, **kwargs)	Allows you to Include the viscous time scale.

acoustic_scale(*args, **kwargs)#

Allows you to Include the acoustic time scale. This option is available only for compressible flows.

gravity_scale(*args, **kwargs)#

Allows you to Include the gravitational time scale. This option is available only if gravity is enabled.

surface_tension_scale(*args, **kwargs)#

Allows you to Include the surface-tension-driven time scale. This option is available only if the surface tension force modeling is enabled.

viscous_scale(*args, **kwargs)#

Allows you to Include the viscous time scale. This option is disabled by default. This command is not available with inviscid flows.

verbosity(*args, **kwargs)#

When enabled, various time scales (depending on the selection) are printed to the console window at every time step. This text command is available with the moving mesh CFL constraint and with the physics-based constraint.

multiphase_specific_time_stepping(*args, **kwargs)#

Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the convective time scale (global Courant number): the time-step-size calculation depends on the mesh density and velocity in interfacial cells. This method is available for all multiphase models using the implicit or explicit volume fraction formulation, except for the wet steam model.

number_of_time_steps(*args, **kwargs)#

Sets the number of time steps for a transient simulation without starting the calculation.

predict_next_time(*args, **kwargs)#

Applies a predictor algorithm for computing the next time step. The predictor algorithm is a computation that sets a better initial condition for the time step. It uses the rate of change between the prediction and the correction as an indicator for whether the next time step should be larger, smaller, or the same as the current one.

rotating_mesh_flow_predictor(*args, **kwargs)#

Enables / disables an option that allows for better prediction of the flow field in rotating fluid zones at every time step, in order to speed up the calculation. This text command is only available for transient simulations.

solid_time_step_size(*args, **kwargs)#

Allows you to specify that the time step size used for solid zones is independent from that used for fluid zones. This text command is only available when both a solid zone exists and energy is enabled.

solution_status(*args, **kwargs)#

Allows you to open theSimulation Status dialog box, which reports details about the simulation.

specified_time_step(*args, **kwargs)#

Specifies whether to define the transient advancement either directly by entering a time step size / period / frequency (using the text commands available in thesolve/set/transient-controls menu) or indirectly by entering a Courant number value (using the solve/set/courant-number text command). This text command is only available for the density-based solver when both the explicit formulation and explicit transient formulation are used.

time_step_size(*args, **kwargs)#

Sets the magnitude of the (physical) time step . This text command is only available when the solve/set/transient-controls/fixed-user-specified text command is set toyes.

time_step_size_for_acoustic_export(*args, **kwargs)#

Specifies the time interval for acoustic data sampling. This text command is only available when both the Ffowcs Williams and Hawkings model is selected and the density-based solver is used with the explicit formulation and explicit transient formulation.

total_number_of_time_steps(*args, **kwargs)#

Sets the total number of time steps that the simulation will run (which includes any time steps that have already been run in previous calculations). This text command is only available when the solve/set/transient-controls/duration-specification-method is set to1.

total_time(*args, **kwargs)#

Sets the total amount of time that the simulation will be run (which includes any time that has already been run in previous calculations). This text command is only available when the solve/set/transient-controls/duration-specification-method is set to2.

udf_based_time_stepping(*args, **kwargs)#

Allows you to specify that the time step size is defined by a user-defined function (UDF) that uses theDEFINE_DELTAT macro.

undo_timestep(*args, **kwargs)#

When enabled, if the truncation error within a time step exceeds the specified tolerance Fluent will automatically undo the current calculation and make another attempt with the time step reduced by 1/2. This will be attempted up to 5 times after which Fluent will accept the result and proceed to the next time step.

under_relaxation(*args, **kwargs)#

Enters the under-relaxation menu, which allows you to set the under-relaxation factor for each equation that is being solved in a segregated manner.

variable_time_stepping(*args, **kwargs)#

Set Multiphase-Specific Adaptive time stepping parameters.

vof_explicit_controls(*args, **kwargs)#

Sets the sub time step calculation method for VOF calculations.

vof_numerics(*args, **kwargs)#

Sets VOF numeric options.

class warped_face_gradient_correction(service, version, mode, path)#

Bases: TUIMenu

Enters the warped-face gradient correction menu.

Methods:

enable(*args, **kwargs)	Enables/disables gradient enhancement computations and specifies whether Fluent uses fast or memory saving mode.
turbulence_options(*args, **kwargs)	Set turbulence Warped Face Gradient Correction.

enable(*args, **kwargs)#

Enables/disables gradient enhancement computations and specifies whether Fluent uses fast or memory saving mode.

turbulence_options(*args, **kwargs)#

Set turbulence Warped Face Gradient Correction.

update_physical_time(*args, **kwargs)#

Advances the unsteady solution to the next physical time level. Using this command in conjunction with theiterate command allows you to manually advance the solution in time (rather than doing it automatically with the dual-time-iterate command).

class surface(service, version, mode, path)#

Bases: TUIMenu

Enter the data surface manipulation menu.

Methods:

circle_slice(*args, **kwargs)	Extracts a circular slice.
closest_point_search(*args, **kwargs)	Enable the point surface algorithm to look for the nearest point instead of reporting a creation failure.
cone_slice(*args, **kwargs)	Extract a cone slice.
create_imprint_surface(*args, **kwargs)	Imprint surface.
delete_surface(*args, **kwargs)	Removes a defined data surface.
edit_surface(*args, **kwargs)	Allows you to edit any of the listed available surfaces.
ellipsoid_slice(*args, **kwargs)	Extract a ellipsoid slice.
expression_volume(*args, **kwargs)	Create volume with boolean expression.
group_surfaces(*args, **kwargs)	Group a set of surfaces.
imprint_surface(*args, **kwargs)	Enters the list of surfaces to imprint from and the name of the new imprinted surface.
iso_clip(*args, **kwargs)	Clips a data surface (surface, curve, or point) between two isovalues.
iso_clip_multiple(*args, **kwargs)	Clip a data surface (surface, curve, or point) between two iso-values.
iso_surface(*args, **kwargs)	Extracts an iso-surface (surface, curve, or point) from the current data field.
line_slice(*args, **kwargs)	Extracts a linear slice in 2D, given the normal to the line and a distance from the origin.
line_surface(*args, **kwargs)	Defines a “line" surface by specifying the two endpoint coordinates.
list_surfaces(*args, **kwargs)	Displays the ID and name, and the number of point, curve, and surface facets of the current surfaces.
mouse_line(*args, **kwargs)	Extracts a line surface that you define by using the mouse to select the endpoints.
mouse_plane(*args, **kwargs)	Extracts a planar surface defined by selecting three points with the mouse.
mouse_rake(*args, **kwargs)	Extracts a “rake" surface that you define by using the mouse to select the endpoints.
multiple_iso_surfaces(*args, **kwargs)	Creates multiple iso-surfaces at once.
multiple_plane_surfaces(*args, **kwargs)	Creates multiple planes at once.
multiple_zone_surfaces(*args, **kwargs)	Creates multiple data surfaces at one time.
partition_surface(*args, **kwargs)	Defines a data surface consisting of mesh faces on the partition boundary.
plane(*args, **kwargs)	Create a plane given 3 points bounded by the domain.
plane_bounded(*args, **kwargs)	Create a bounded surface.
plane_point_n_normal(*args, **kwargs)	Create a plane from a point and normal.
plane_slice(*args, **kwargs)	Extracts a planar slice.
plane_surf_aligned(*args, **kwargs)	Create a plane aligned to a surface.
plane_surface(*args, **kwargs)	Create a plane from a coordinate plane, point and normal, or three points.
plane_view_plane_align(*args, **kwargs)	Create a plane aligned to a view-plane.
point_array(*args, **kwargs)	Extracts a rectangular array of data points.
point_surface(*args, **kwargs)	Defines a “point" surface by specifying the coordinates.
quadric_slice(*args, **kwargs)	Extracts a quadric slice.
rake_surface(*args, **kwargs)	Extracts a “rake" surface, given the coordinates of the endpoints.
rename_surface(*args, **kwargs)	Renames a defined data surface.
rendering_priority(*args, **kwargs)	Define Priority for given surface id.
reset_zone_surfaces(*args, **kwargs)	Recreates missing surface zones by resetting the case surface list.
sphere_slice(*args, **kwargs)	Extracts a spherical slice.
structural_point_surface(*args, **kwargs)	Defines a structural “point" surface by specifying the coordinates.
surface_cells(*args, **kwargs)	Extracts all cells intersected by a data surface.
transform_surface(*args, **kwargs)	Transforms surface.
ungroup_surface(*args, **kwargs)	Ungroup the surface(if grouped).
zone_surface(*args, **kwargs)	Creates a surface of a designated zone and gives it a specified name.

Classes:

post_processing_volume(service, version, ...)	Enter post-processing volume menu.
query(service, version, mode, path)	Enter surface query menu.

circle_slice(*args, **kwargs)#

Extracts a circular slice.

closest_point_search(*args, **kwargs)#

Enable the point surface algorithm to look for the nearest point instead of reporting a creation failure.

cone_slice(*args, **kwargs)#

Extract a cone slice.

create_imprint_surface(*args, **kwargs)#

Imprint surface.

delete_surface(*args, **kwargs)#

Removes a defined data surface.

edit_surface(*args, **kwargs)#

Allows you to edit any of the listed available surfaces.

ellipsoid_slice(*args, **kwargs)#

Extract a ellipsoid slice.

expression_volume(*args, **kwargs)#

Create volume with boolean expression.

group_surfaces(*args, **kwargs)#

Group a set of surfaces.

imprint_surface(*args, **kwargs)#

Enters the list of surfaces to imprint from and the name of the new imprinted surface.

iso_clip(*args, **kwargs)#

Clips a data surface (surface, curve, or point) between two isovalues.

iso_clip_multiple(*args, **kwargs)#

Clip a data surface (surface, curve, or point) between two iso-values.

iso_surface(*args, **kwargs)#

Extracts an iso-surface (surface, curve, or point) from the current data field.

line_slice(*args, **kwargs)#

Extracts a linear slice in 2D, given the normal to the line and a distance from the origin.

line_surface(*args, **kwargs)#

Defines a “line” surface by specifying the two endpoint coordinates.

list_surfaces(*args, **kwargs)#

Displays the ID and name, and the number of point, curve, and surface facets of the current surfaces.

mouse_line(*args, **kwargs)#

Extracts a line surface that you define by using the mouse to select the endpoints.

mouse_plane(*args, **kwargs)#

Extracts a planar surface defined by selecting three points with the mouse.

mouse_rake(*args, **kwargs)#

Extracts a “rake” surface that you define by using the mouse to select the endpoints.

multiple_iso_surfaces(*args, **kwargs)#

Creates multiple iso-surfaces at once. Accepts zone names, lists of zone ID’s, and wildcards.

multiple_plane_surfaces(*args, **kwargs)#

Creates multiple planes at once. Accepts zone names, lists of zone ID’s, and wildcards.

multiple_zone_surfaces(*args, **kwargs)#

Creates multiple data surfaces at one time. Accepts zone names, lists of zone ID’s, and wildcards.

partition_surface(*args, **kwargs)#

Defines a data surface consisting of mesh faces on the partition boundary.

plane(*args, **kwargs)#

Create a plane given 3 points bounded by the domain.

plane_bounded(*args, **kwargs)#

Create a bounded surface.

plane_point_n_normal(*args, **kwargs)#

Create a plane from a point and normal.

plane_slice(*args, **kwargs)#

Extracts a planar slice.

plane_surf_aligned(*args, **kwargs)#

Create a plane aligned to a surface.

plane_surface(*args, **kwargs)#

Create a plane from a coordinate plane, point and normal, or three points.

plane_view_plane_align(*args, **kwargs)#

Create a plane aligned to a view-plane.

point_array(*args, **kwargs)#

Extracts a rectangular array of data points.

point_surface(*args, **kwargs)#

Defines a “point” surface by specifying the coordinates.

class post_processing_volume(service, version, mode, path)#

Bases: TUIMenu

Enter post-processing volume menu.

Methods:

create_from_file(*args, **kwargs)	Read post-processing mesh from file.
create_octree(*args, **kwargs)	Create post-processing octree mesh based on current case.

create_from_file(*args, **kwargs)#

Read post-processing mesh from file.

create_octree(*args, **kwargs)#

Create post-processing octree mesh based on current case.

quadric_slice(*args, **kwargs)#

Extracts a quadric slice.

class query(service, version, mode, path)#

Bases: TUIMenu

Enter surface query menu.

Methods:

delete_query(*args, **kwargs)	Delete saved query.
list_named_selection(*args, **kwargs)	List named selection of surface type.
list_queries(*args, **kwargs)	List all saved queries.
list_surfaces(*args, **kwargs)	List surfaces.
named_surface_list(*args, **kwargs)	Create named list of surfaces.

delete_query(*args, **kwargs)#

Delete saved query.

list_named_selection(*args, **kwargs)#

List named selection of surface type.

list_queries(*args, **kwargs)#

List all saved queries.

list_surfaces(*args, **kwargs)#

List surfaces.

named_surface_list(*args, **kwargs)#

Create named list of surfaces.

rake_surface(*args, **kwargs)#

Extracts a “rake” surface, given the coordinates of the endpoints.

rename_surface(*args, **kwargs)#

Renames a defined data surface.

rendering_priority(*args, **kwargs)#

Define Priority for given surface id.

reset_zone_surfaces(*args, **kwargs)#

Recreates missing surface zones by resetting the case surface list.

sphere_slice(*args, **kwargs)#

Extracts a spherical slice.

structural_point_surface(*args, **kwargs)#

Defines a structural “point” surface by specifying the coordinates.

surface_cells(*args, **kwargs)#

Extracts all cells intersected by a data surface.

transform_surface(*args, **kwargs)#

Transforms surface.

ungroup_surface(*args, **kwargs)#

Ungroup the surface(if grouped).

zone_surface(*args, **kwargs)#

Creates a surface of a designated zone and gives it a specified name.

switch_to_meshing_mode(*args, **kwargs)#

Switches from the solution mode to the meshing mode. This text command is only available if you have not yet read a mesh or a case file.

class turbo_post(service, version, mode, path)#

Bases: TUIMenu

Enter the turbo menu.

Methods:

avg_contours(*args, **kwargs)	Displays average contours.
compute_report(*args, **kwargs)	Computes turbomachinery quantities.
current_topology(*args, **kwargs)	Sets the current turbo topology for global use.
two_d_contours(*args, **kwargs)	Display 2d contours.
write_report(*args, **kwargs)	Writes the turbo report to file.
xy_plot_avg(*args, **kwargs)	Displays average XY plots.

avg_contours(*args, **kwargs)#

Displays average contours.

compute_report(*args, **kwargs)#

Computes turbomachinery quantities.

current_topology(*args, **kwargs)#

Sets the current turbo topology for global use.

two_d_contours(*args, **kwargs)#

Display 2d contours.

write_report(*args, **kwargs)#

Writes the turbo report to file.

xy_plot_avg(*args, **kwargs)#

Displays average XY plots.

class turbo_workflow(service, version, mode, path)#

Bases: TUIMenu

Enter the turbo workflow menu.

Classes:

workflow(service, version, mode, path)

Enter the workflow menu.

class workflow(service, version, mode, path)#

Bases: TUIMenu

Enter the workflow menu.

Methods:

disable(*args, **kwargs)	Disable the workflow.
enable(*args, **kwargs)	Enable the workflow.
reset(*args, **kwargs)	Reset the workflow.

disable(*args, **kwargs)#

Disable the workflow.

enable(*args, **kwargs)#

Enable the workflow.

reset(*args, **kwargs)#

Reset the workflow.

class views(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

auto_scale(*args, **kwargs)	Scales and centers the current scene without changing its orientation.
default_view(*args, **kwargs)	Resets view to front and center.
delete_view(*args, **kwargs)	Removes a view from the list.
last_view(*args, **kwargs)	Returns to the camera position before the last manipulation.
list_views(*args, **kwargs)	Lists predefined and saved views.
next_view(*args, **kwargs)	.
read_views(*args, **kwargs)	Reads views from a view file.
restore_view(*args, **kwargs)	Uses a saved view.
save_view(*args, **kwargs)	Saves the current view to the view list.
write_views(*args, **kwargs)	Writes selected views to a view file.

Classes:

camera(service, version, mode, path)	Enters the camera menu to modify the current viewing parameters.
display_states(service, version, mode, path)	.

auto_scale(*args, **kwargs)#

Scales and centers the current scene without changing its orientation.

class camera(service, version, mode, path)#

Bases: TUIMenu

Enters the camera menu to modify the current viewing parameters.

Methods:

dolly_camera(*args, **kwargs)	Adjusts the camera position and target.
field(*args, **kwargs)	Sets the field of view (width and height).
orbit_camera(*args, **kwargs)	Adjusts the camera position without modifying the target.
pan_camera(*args, **kwargs)	Adjusts the camera target without modifying the position.
position(*args, **kwargs)	Sets the camera position.
projection(*args, **kwargs)	.
roll_camera(*args, **kwargs)	Adjusts the camera up-vector.
target(*args, **kwargs)	Sets the point to be the center of the camera view.
up_vector(*args, **kwargs)	Sets the camera up-vector.
zoom_camera(*args, **kwargs)	Adjusts the camera’s field of view.

dolly_camera(*args, **kwargs)#

Adjusts the camera position and target.

field(*args, **kwargs)#

Sets the field of view (width and height).

orbit_camera(*args, **kwargs)#

Adjusts the camera position without modifying the target.

pan_camera(*args, **kwargs)#

Adjusts the camera target without modifying the position.

position(*args, **kwargs)#

Sets the camera position.

projection(*args, **kwargs)#

.

roll_camera(*args, **kwargs)#

Adjusts the camera up-vector.

target(*args, **kwargs)#

Sets the point to be the center of the camera view.

up_vector(*args, **kwargs)#

Sets the camera up-vector.

zoom_camera(*args, **kwargs)#

Adjusts the camera’s field of view. This operation is similar to dollying the camera in or out of the scene. Dollying causes objects in front to move past you. Zooming changes the perspective effect in the scene (and can be disconcerting).

default_view(*args, **kwargs)#

Resets view to front and center.

delete_view(*args, **kwargs)#

Removes a view from the list.

class display_states(service, version, mode, path)#

Bases: TUIMenu

.

Methods:

copy(*args, **kwargs)	.
delete(*args, **kwargs)	Delete display-states object.
duplicate(*args, **kwargs)	.
edit(*args, **kwargs)	Edit display-states object.
list(*args, **kwargs)	.
list_properties(*args, **kwargs)	.
new(*args, **kwargs)	Create a new display-states object.
read(*args, **kwargs)	.
rename(*args, **kwargs)	Rename display-states object.
restore_state(*args, **kwargs)	.
use_active(*args, **kwargs)	.
write(*args, **kwargs)	.

copy(*args, **kwargs)#

.

delete(*args, **kwargs)#

Delete display-states object.

duplicate(*args, **kwargs)#

.

edit(*args, **kwargs)#

Edit display-states object.

list(*args, **kwargs)#

.

list_properties(*args, **kwargs)#

.

new(*args, **kwargs)#

Create a new display-states object.

read(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename display-states object.

restore_state(*args, **kwargs)#

.

use_active(*args, **kwargs)#

.

write(*args, **kwargs)#

.

last_view(*args, **kwargs)#

Returns to the camera position before the last manipulation.

list_views(*args, **kwargs)#

Lists predefined and saved views.

next_view(*args, **kwargs)#

.

read_views(*args, **kwargs)#

Reads views from a view file.

restore_view(*args, **kwargs)#

Uses a saved view.

save_view(*args, **kwargs)#

Saves the current view to the view list.

write_views(*args, **kwargs)#

Writes selected views to a view file.