solution

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

Bases: TUIMenu

Enter solution menu.

Classes:

calculation_activities(path, service)	Enter calculation activities menu.
cell_registers(path, service)	Manage Cell Registers.
controls(path, service)	Enter the controls menu.
expert(path, service)	Enter expert options for solution.
initialize(path, service)	Enter the flow initialization menu.
methods(path, service)	Enter the methods menu.
monitors(path, service)	Enter the monitors menu.
report_definitions(path, service)	Manage report definitions.
run_calculation(path, service)	Enter run calculation menu.

class calculation_activities(path, service)

Bases: TUIMenu

Enter calculation activities menu.

Classes:

animate(path, service)	Enter the animation menu.
auto_save(path, service)	Enter the auto save menu.
cell_register_operations(path, service)	Manage Cell Register Operations.
execute_commands(path, service)	Enter the execute-monitor-commands menu.
solution_strategy(path, service)	Enter the automatic initialization and case modification strategy menu.

class animate(path, service)

Bases: TUIMenu

Enter the animation menu.

Classes:

define(path, service)	Enter the animation definition menu.
objects(path, service)	Enter to define, edit, delete solution animation objects.

class define(path, service)

Bases: TUIMenu

Enter the animation definition menu.

Methods:

define_monitor(*args, **kwargs)	Define new animation.
edit_monitor(*args, **kwargs)	Change animation monitor attributes.

define_monitor(*args, **kwargs)

Define new animation.

edit_monitor(*args, **kwargs)

Change animation monitor attributes.

class objects(path, service)

Bases: TUIMenu

Enter to define, edit, delete solution animation objects.

Methods:

clear_history(*args, **kwargs)	Clear object history.
copy(*args, **kwargs)	Copy graphics object.
create(*args, **kwargs)	Create new graphics object.
delete(*args, **kwargs)	Delete graphics object.
edit(*args, **kwargs)	Edit graphics object.

clear_history(*args, **kwargs)

Clear object history.

copy(*args, **kwargs)

Copy graphics object.

create(*args, **kwargs)

Create new graphics object.

delete(*args, **kwargs)

Delete graphics object.

edit(*args, **kwargs)

Edit graphics object.

class auto_save(path, service)

Bases: TUIMenu

Enter the auto save menu.

Methods:

append_file_name_with(*args, **kwargs)	.
case_frequency(*args, **kwargs)	.
data_frequency(*args, **kwargs)	.
max_files(*args, **kwargs)	.
retain_most_recent_files(*args, **kwargs)	.
root_name(*args, **kwargs)	.
save_data_file_every(*args, **kwargs)	.

append_file_name_with(*args, **kwargs)

.

case_frequency(*args, **kwargs)

.

data_frequency(*args, **kwargs)

.

max_files(*args, **kwargs)

.

retain_most_recent_files(*args, **kwargs)

.

root_name(*args, **kwargs)

.

save_data_file_every(*args, **kwargs)

.

class cell_register_operations(path, service)

Bases: TUIMenu

Manage Cell Register Operations.

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.

class execute_commands(path, service)

Bases: TUIMenu

Enter the execute-monitor-commands menu.

Methods:

add_edit(*args, **kwargs)	Add or edit execute-commands.
copy(*args, **kwargs)	Copy an execute-command.
delete(*args, **kwargs)	Delete an execute-command.
disable(*args, **kwargs)	Disable an execute-command.
enable(*args, **kwargs)	Enable 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)

Add or edit execute-commands.

copy(*args, **kwargs)

Copy an execute-command.

delete(*args, **kwargs)

Delete an execute-command.

disable(*args, **kwargs)

Disable an execute-command.

enable(*args, **kwargs)

Enable an execute-command.

export(*args, **kwargs)

Export execute-commands to a TSV file.

import_(*args, **kwargs)

Import execute-commands from a TSV file.

class solution_strategy(path, service)

Bases: TUIMenu

Enter the automatic initialization and case modification strategy menu.

Methods:

add_edit_modification(*args, **kwargs)	Define a single case modification.
automatic_initialization(*args, **kwargs)	Define how the case is to be initialized automatically.
continue_strategy_execution(*args, **kwargs)	Continue execution of the automatic initialization and case modification strategy defined at present.
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)	Specify whether automatic initialization and case modification should be enabled.
execute_strategy(*args, **kwargs)	Execute the automatic initialization and case modification strategy defined at present.
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(path, service)

Define how the case is to be modified as the solution progresses.

add_edit_modification(*args, **kwargs)

Define a single case modification.

class automatic_case_modification(path, service)

Bases: TUIMenu

Define how the case is to be modified as the solution progresses.

Methods:

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

before_init_modification(*args, **kwargs)

Specify modification to be performed before initialization.

modifications(*args, **kwargs)

Specify modifications to be performed during solution.

original_settings(*args, **kwargs)

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

automatic_initialization(*args, **kwargs)

Define how the case is to be initialized automatically.

continue_strategy_execution(*args, **kwargs)

Continue execution of the automatic initialization and case modification strategy defined at present.

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)

Specify whether automatic initialization and case modification should be enabled.

execute_strategy(*args, **kwargs)

Execute the automatic initialization and case modification strategy defined at present.

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

Bases: TUIMenu

Manage Cell Registers.

Methods:

adapt(*args, **kwargs)	Adapt cell register objects.
add(*args, **kwargs)	Add a new object.
apply_poor_mesh_numerics(*args, **kwargs)	Apply poor mesh numerics to cell register objects.
coarsen(*args, **kwargs)	Coarsen cell register objects.
delete(*args, **kwargs)	Delete an object.
display(*args, **kwargs)	Display cell register objects.
edit(*args, **kwargs)	Edit an object.
list(*args, **kwargs)	List objects.
list_properties(*args, **kwargs)	List properties of an object.
refine(*args, **kwargs)	Refine cell register objects.

adapt(*args, **kwargs)

Adapt cell register objects.

add(*args, **kwargs)

Add a new object.

apply_poor_mesh_numerics(*args, **kwargs)

Apply poor mesh numerics to cell register objects.

coarsen(*args, **kwargs)

Coarsen cell register objects.

delete(*args, **kwargs)

Delete an object.

display(*args, **kwargs)

Display cell register objects.

edit(*args, **kwargs)

Edit an object.

list(*args, **kwargs)

List objects.

list_properties(*args, **kwargs)

List properties of an object.

refine(*args, **kwargs)

Refine cell register objects.

class controls(path, service)

Bases: TUIMenu

Enter the controls menu.

Classes:

acoustics_wave_equation_controls(path, service)	Enter menu for acoustics wave equation solver controls.
advanced(path, service)	Controls advanced options.
contact_solution_controls(path, service)	Solver controls for contact marks method.
query(path, service)	Enter controls query menu.

Methods:

courant_number(*args, **kwargs)	Set the fine mesh Courant number (time step factor).
equations(*args, **kwargs)	Enter the equations menu.
limits(*args, **kwargs)	Set solver limits for the values of various solution variables.
p_v_controls(*args, **kwargs)	Set P-V-Controls.
relaxation_factor(*args, **kwargs)	Enter the relaxation-factor menu.
set_controls_to_default(*args, **kwargs)	Set controls to default values.
under_relaxation(*args, **kwargs)	Enter the under-relaxation menu.

class acoustics_wave_equation_controls(path, service)

Bases: TUIMenu

Enter menu for acoustics wave equation solver controls.

Classes:

expert(path, service)

Enter menu for expert controls.

Methods:

max_iterations_per_timestep(*args, **kwargs)	Specify maximum number of iterations per timestep.
relative_convergence_criterion(*args, **kwargs)	Specify convergence tolerance for the timestep iterations as the target residual reduction factor.

class expert(path, service)

Bases: TUIMenu

Enter menu for expert controls.

Methods:

explicit_relaxation_factor(*args, **kwargs)	Specify explicit relaxation factor to be applied to the solution correction when updating solution in the timestep iterations.
under_relaxation_factor(*args, **kwargs)	Specify under-relaxation factor to be used in the diagonal matrix elements of implicit solver.

explicit_relaxation_factor(*args, **kwargs)

Specify explicit relaxation factor to be applied to the solution correction when updating solution in the timestep iterations.

under_relaxation_factor(*args, **kwargs)

Specify under-relaxation factor to be used in the diagonal matrix elements of implicit solver.

max_iterations_per_timestep(*args, **kwargs)

Specify maximum number of iterations per timestep.

relative_convergence_criterion(*args, **kwargs)

Specify convergence tolerance for the timestep iterations as the target residual reduction factor.

class advanced(path, service)

Bases: TUIMenu

Controls advanced options.

Classes:

amg_options(path, service)	Enter AMG options menu.
fast_transient_settings(path, service)	Enter the fast transient settings menu.

Methods:

correction_tolerance(*args, **kwargs)	Enter the correction tolerance menu.
multi_grid_amg(*args, **kwargs)	Set the parameters that govern the algebraic multigrid procedure.
multi_grid_controls(*args, **kwargs)	Enter the multi-grid-controls menu.
multi_grid_fas(*args, **kwargs)	Set the coefficients that govern the FAS multigrid procedure.
multi_stage(*args, **kwargs)	Set the multiple-stage time stepping scheme coefficients.
relaxation_method(*args, **kwargs)	Set the solver relaxation method.
slope_limiter_set(*args, **kwargs)	Enter the slope limiter set menu.

class amg_options(path, service)

Bases: TUIMenu

Enter AMG options menu.

Methods:

aggressive_amg_coarsening(*args, **kwargs)	Use aggressive AMG coarsening.
amg_gpgpu_options(*args, **kwargs)	Set GPGPU AMG solver options.
conservative_amg_coarsening(*args, **kwargs)	Use conservative AMG coarsening?.
laplace_coarsening(*args, **kwargs)	Set AMG laplace coarsening options.

aggressive_amg_coarsening(*args, **kwargs)

Use aggressive AMG coarsening.

amg_gpgpu_options(*args, **kwargs)

Set GPGPU AMG solver options.

conservative_amg_coarsening(*args, **kwargs)

Use conservative AMG coarsening?.

laplace_coarsening(*args, **kwargs)

Set AMG laplace coarsening options.

correction_tolerance(*args, **kwargs)

Enter the correction tolerance menu.

class fast_transient_settings(path, service)

Bases: TUIMenu

Enter the fast transient settings menu.

Methods:

rk2(*args, **kwargs)

Enable the use of a two-stage Runge-Kutta scheme for time integration.

rk2(*args, **kwargs)

Enable the use of a two-stage Runge-Kutta scheme for time integration.

multi_grid_amg(*args, **kwargs)

Set the parameters that govern the algebraic multigrid procedure.

multi_grid_controls(*args, **kwargs)

Enter the multi-grid-controls menu.

multi_grid_fas(*args, **kwargs)

Set the coefficients that govern the FAS multigrid procedure.

multi_stage(*args, **kwargs)

Set the multiple-stage time stepping scheme coefficients.

relaxation_method(*args, **kwargs)

Set the solver relaxation method.

slope_limiter_set(*args, **kwargs)

Enter the slope limiter set menu.

class contact_solution_controls(path, service)

Bases: TUIMenu

Solver controls for contact marks method.

Classes:

amg(path, service)	AMG control options.
methods(path, service)	Methods control options.
miscellaneous(path, service)	Miscellaneous.
models(path, service)	Model control options.
parameters(path, service)	Parameters used in stabilization strategy.
spatial(path, service)	Spatial discretization control options.
transient(path, service)	Transient discretization control options .

Methods:

set_settings_to_default(*args, **kwargs)	Set contact solution stabilization to default.
solution_stabilization(*args, **kwargs)	Automatic solver settings adjustment for solution stabilization during contact process.
verbosity(*args, **kwargs)	Specify verbosity level for contact solution controls.

class amg(path, service)

Bases: TUIMenu

AMG control options.

Methods:

coarsen_rate(*args, **kwargs)	Specify AMG coarsening rate.
enforce_laplace_coarsening(*args, **kwargs)	Enforce the use of laplace coarsening in AMG.
increase_pre_sweeps(*args, **kwargs)	Allow increase in AMG pre-sweep.
pre_sweeps(*args, **kwargs)	Specify the number of AMG pre-sweeps.
specify_coarsening_rate(*args, **kwargs)	Modify AMG coarsening rate.

coarsen_rate(*args, **kwargs)

Specify AMG coarsening rate.

enforce_laplace_coarsening(*args, **kwargs)

Enforce the use of laplace coarsening in AMG.

increase_pre_sweeps(*args, **kwargs)

Allow increase in AMG pre-sweep.

pre_sweeps(*args, **kwargs)

Specify the number of AMG pre-sweeps.

specify_coarsening_rate(*args, **kwargs)

Modify AMG coarsening rate.

class methods(path, service)

Bases: TUIMenu

Methods control options.

Methods:

gradient_controls(*args, **kwargs)	Modify gradient method for solver stability and accuracy.
pressure_velocity_coupling_controls(*args, ...)	Enable pressure-velocity coupling method change for solver stability and accuracy.
pressure_velocity_coupling_method(*args, ...)	Specify pressure-velocity coupling method change for solver stability and accuracy.
specify_gradient_method(*args, **kwargs)	Specify gradient method for solver stability and accuracy.

gradient_controls(*args, **kwargs)

Modify gradient method for solver stability and accuracy.

pressure_velocity_coupling_controls(*args, **kwargs)

Enable pressure-velocity coupling method change for solver stability and accuracy.

pressure_velocity_coupling_method(*args, **kwargs)

Specify pressure-velocity coupling method change for solver stability and accuracy.

specify_gradient_method(*args, **kwargs)

Specify gradient method for solver stability and accuracy.

class miscellaneous(path, service)

Bases: TUIMenu

Miscellaneous.

Methods:

compute_statistics(*args, **kwargs)	Compute solution statistics for contact updates.
statistics_level(*args, **kwargs)	Solution statistics level for contact updates.

compute_statistics(*args, **kwargs)

Compute solution statistics for contact updates.

statistics_level(*args, **kwargs)

Solution statistics level for contact updates.

class models(path, service)

Bases: TUIMenu

Model control options.

Methods:

model_ramping(*args, **kwargs)	Activate model ramping for solver stability and accuracy.
ramp_flow(*args, **kwargs)	Ramp flow for solver stability and accuracy.
ramp_scalars(*args, **kwargs)	Ramp all scalar transport equations for solver stability and accuracy.
ramp_turbulence(*args, **kwargs)	Ramp turbulence for solver stability and accuracy.

model_ramping(*args, **kwargs)

Activate model ramping for solver stability and accuracy.

ramp_flow(*args, **kwargs)

Ramp flow for solver stability and accuracy.

ramp_scalars(*args, **kwargs)

Ramp all scalar transport equations for solver stability and accuracy.

ramp_turbulence(*args, **kwargs)

Ramp turbulence for solver stability and accuracy.

class parameters(path, service)

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)	Specify additional iterations to accomodate contact solution stabilization.
persistence_fixed_duration(*args, **kwargs)	Specify fixed time for solution stabilization persistence after trigger.
persistence_fixed_time_steps(*args, **kwargs)	Specify fixed time-steps for solution stabilization persistence after trigger.
solution_stabilization_persistence(*args, ...)	Persistence of the solution stabilization based on events [0-contact based, 1-always on].

extrapolation_method(*args, **kwargs)

Solution extrapolation method for cells changing status from contact to non-contact [0-none, 1-local extrapolation].

iterations(*args, **kwargs)

Specify additional iterations to accomodate contact solution stabilization.

persistence_fixed_duration(*args, **kwargs)

Specify fixed time for solution stabilization persistence after trigger.

persistence_fixed_time_steps(*args, **kwargs)

Specify fixed time-steps for solution stabilization persistence after trigger.

solution_stabilization_persistence(*args, **kwargs)

Persistence of the solution stabilization based on events [0-contact based, 1-always on].

set_settings_to_default(*args, **kwargs)

Set contact solution stabilization to default.

solution_stabilization(*args, **kwargs)

Automatic solver settings adjustment for solution stabilization during contact process.

class spatial(path, service)

Bases: TUIMenu

Spatial discretization control options.

Methods:

first_to_second_order_blending(*args, **kwargs)	Set factor to control first order to second order blending.
first_to_second_order_blending_list(*args, ...)	List set factor to control first order to second order blending.
flow_skew_diffusion_exclude(*args, **kwargs)	Exclude skew diffusion discretization contribution for momentum.
rhie_chow_flux_specify(*args, **kwargs)	Allow specification of the the rhie-chow flux method.
rhie_chow_method(*args, **kwargs)	Enter the rhie-chow flux method.
scalars_skew_diffusion_exclude(*args, **kwargs)	Exclude skew diffusion discretization contribution for scalars.
scheme(*args, **kwargs)	Set advection scheme for contact event stability.

first_to_second_order_blending(*args, **kwargs)

Set factor to control first order to second order blending.

first_to_second_order_blending_list(*args, **kwargs)

List set factor to control first order to second order blending.

flow_skew_diffusion_exclude(*args, **kwargs)

Exclude skew diffusion discretization contribution for momentum.

rhie_chow_flux_specify(*args, **kwargs)

Allow specification of the the rhie-chow flux method.

rhie_chow_method(*args, **kwargs)

Enter the rhie-chow flux method.

scalars_skew_diffusion_exclude(*args, **kwargs)

Exclude skew diffusion discretization contribution for scalars.

scheme(*args, **kwargs)

Set advection scheme for contact event stability.

class transient(path, service)

Bases: TUIMenu

Transient discretization control options .

Methods:

time_scale_modification_factor(*args, **kwargs)	Specify time-scale modification factor.
time_scale_modification_method(*args, **kwargs)	Enter time scale modification method.
transient_parameters_specify(*args, **kwargs)	Allow transient parameter specification.
transient_scheme(*args, **kwargs)	Specify temporal scheme to be used.

time_scale_modification_factor(*args, **kwargs)

Specify time-scale modification factor.

time_scale_modification_method(*args, **kwargs)

Enter time scale modification method.

transient_parameters_specify(*args, **kwargs)

Allow transient parameter specification.

transient_scheme(*args, **kwargs)

Specify temporal scheme to be used.

verbosity(*args, **kwargs)

Specify verbosity level for contact solution controls.

courant_number(*args, **kwargs)

Set the fine mesh Courant number (time step factor).

equations(*args, **kwargs)

Enter the equations menu.

limits(*args, **kwargs)

Set solver limits for the values of various solution variables.

p_v_controls(*args, **kwargs)

Set P-V-Controls.

class query(path, service)

Bases: TUIMenu

Enter controls query menu.

Classes:

acoustics_wave_equation_controls(path, service)	Enter menu for acoustics wave equation solver controls.
advanced(path, service)	Controls advanced options.

Methods:

courant_number(*args, **kwargs)	Get the fine mesh Courant number (time step factor).
equations(*args, **kwargs)	Enter the equations menu.
limits(*args, **kwargs)	Get solver limits for the values of various solution variables.
p_v_controls(*args, **kwargs)	Get P-V-Controls.
relaxation_factor(*args, **kwargs)	Enter the relaxation-factor menu.
under_relaxation(*args, **kwargs)	Enter under relaxation menu.

class acoustics_wave_equation_controls(path, service)

Bases: TUIMenu

Enter menu for acoustics wave equation solver controls.

Classes:

expert(path, service)

Enter menu for expert controls.

Methods:

max_iterations_per_timestep(*args, **kwargs)	Specify maximum number of iterations per timestep.
relative_convergence_criterion(*args, **kwargs)	Specify convergence tolerance for the timestep iterations as the target residual reduction factor.

class expert(path, service)

Bases: TUIMenu

Enter menu for expert controls.

Methods:

explicit_relaxation_factor(*args, **kwargs)	Specify explicit relaxation factor to be applied to the solution correction when updating solution in the timestep iterations.
under_relaxation_factor(*args, **kwargs)	Specify under-relaxation factor to be used in the diagonal matrix elements of implicit solver.

explicit_relaxation_factor(*args, **kwargs)

Specify explicit relaxation factor to be applied to the solution correction when updating solution in the timestep iterations.

under_relaxation_factor(*args, **kwargs)

Specify under-relaxation factor to be used in the diagonal matrix elements of implicit solver.

max_iterations_per_timestep(*args, **kwargs)

Specify maximum number of iterations per timestep.

relative_convergence_criterion(*args, **kwargs)

Specify convergence tolerance for the timestep iterations as the target residual reduction factor.

class advanced(path, service)

Bases: TUIMenu

Controls advanced options.

Classes:

amg_options(path, service)

Enter AMG options menu.

Methods:

correction_tolerance(*args, **kwargs)	Enter the correction tolerance menu.
multi_grid_amg(*args, **kwargs)	Get the parameters that govern the algebraic multigrid procedure.
multi_grid_controls(*args, **kwargs)	Enter the multi-grid-controls menu.
multi_grid_fas(*args, **kwargs)	Get the coefficients that govern the FAS multigrid procedure.
multi_stage(*args, **kwargs)	Set the multiple-stage time stepping scheme coefficients.
relaxation_method(*args, **kwargs)	Set the solver relaxation method.

class amg_options(path, service)

Bases: TUIMenu

Enter AMG options menu.

Methods:

aggressive_amg_coarsening(*args, **kwargs)	Use aggressive AMG coarsening.
amg_gpgpu_options(*args, **kwargs)	Amg gpu options.
conservative_amg_coarsening(*args, **kwargs)	Use conservative AMG coarsening?.
laplace_coarsening(*args, **kwargs)	Get AMG laplace coarsening options.

aggressive_amg_coarsening(*args, **kwargs)

Use aggressive AMG coarsening.

amg_gpgpu_options(*args, **kwargs)

Amg gpu options.

conservative_amg_coarsening(*args, **kwargs)

Use conservative AMG coarsening?.

laplace_coarsening(*args, **kwargs)

Get AMG laplace coarsening options.

correction_tolerance(*args, **kwargs)

Enter the correction tolerance menu.

multi_grid_amg(*args, **kwargs)

Get the parameters that govern the algebraic multigrid procedure.

multi_grid_controls(*args, **kwargs)

Enter the multi-grid-controls menu.

multi_grid_fas(*args, **kwargs)

Get the coefficients that govern the FAS multigrid procedure.

multi_stage(*args, **kwargs)

Set the multiple-stage time stepping scheme coefficients.

relaxation_method(*args, **kwargs)

Set the solver relaxation method.

courant_number(*args, **kwargs)

Get the fine mesh Courant number (time step factor).

equations(*args, **kwargs)

Enter the equations menu.

limits(*args, **kwargs)

Get solver limits for the values of various solution variables.

p_v_controls(*args, **kwargs)

Get P-V-Controls.

relaxation_factor(*args, **kwargs)

Enter the relaxation-factor menu.

under_relaxation(*args, **kwargs)

Enter under relaxation menu.

relaxation_factor(*args, **kwargs)

Enter the relaxation-factor menu.

set_controls_to_default(*args, **kwargs)

Set controls to default values.

under_relaxation(*args, **kwargs)

Enter the under-relaxation menu.

class expert(path, service)

Bases: TUIMenu

Enter expert options for solution.

Methods:

alternate_wall_temp_formulation(*args, **kwargs)	Alternate formulation for wall temperatures?.
bc_pressure_extrapolations(*args, **kwargs)	Setting pressure extrapolations schemes on boundaries.
bcd_boundedness(*args, **kwargs)	BCD scheme boundedness strength, constant or expression (0 to 1).
bcd_weights_freeze(*args, **kwargs)	At each timestep, freeze BCD scheme weights after specified iteration in order to improve timestep convergence.
correction_form(*args, **kwargs)	Discretize momentum equations in correction form for the pressure-based solver.
disable_reconstruction(*args, **kwargs)	Enable/Disable reconstruction.
energy_numerical_noise_filter(*args, **kwargs)	The energy equation numerical noise filter can be enabled to eliminate non-physical numerical noise in the energy field.
equation_ordering(*args, **kwargs)	Set the equation order.
explicit_under_relaxation_value(*args, **kwargs)	Explicit under-relaxation value.
flow_warnings(*args, **kwargs)	Control the display of warning diagnostics for boundaries with reversed flow, etc.
limiter_warnings(*args, **kwargs)	Control the display of limiter warning diagnostics.
linearized_mass_transfer_udf(*args, **kwargs)	Use linearized mass transfer UDFs?.
lock_solid_temperature(*args, **kwargs)	Lock the temperature for all solid and shell cell zones in the domain.
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.
mp_mfluid_aniso_drag(*args, **kwargs)	Set anisotropic drag parameters for Eulerian multiphase.
mp_reference_density(*args, **kwargs)	Set reference density option for Eulerian multiphase.
numerical_beach_controls(*args, **kwargs)	Set damping function in flow direction.
open_channel_controls(*args, **kwargs)	Set additional open channel controls.
retain_cell_residuals(*args, **kwargs)	Retain cell residuals for postprocessing?.
retain_temporary_solver_mem(*args, **kwargs)	Retain temporary solver memory?.
set_all_species_together(*args, **kwargs)	Set all species discretizations and URFs together.
show_all_discretization_schemes(*args, **kwargs)	Allow selection of all applicable discretization schemes?.
singhal_et_al_cavitation_model(*args, **kwargs)	Use Singhal-et-al cavitation model?.
surface_tension(*args, **kwargs)	Set surface-tension calculation options.
surface_tension_expert(*args, **kwargs)	Set surface-tension expert options.
vof_explicit_controls(*args, **kwargs)	Set Explicit VOF controls.

Classes:

divergence_prevention(path, service)	Enter the divergence prevention menu.
high_speed_numerics(path, service)	Enter high-speed-numerics menu.
non_reflecting_boundary_treatment(path, service)	Enter non reflecting boundary treatment using minimal pressure reflection approach menu.
open_channel_wave_options(path, service)	Enter the open-channel-wave-options menu.
poor_mesh_numerics(path, service)	Enter Poor Mesh Numerics Menu.
previous_defaults(path, service)	Enter previous defaults menu.
secondary_gradient_limiting(path, service)	Enter the Secondary Gradient Limiting Menu.

alternate_wall_temp_formulation(*args, **kwargs)

Alternate formulation for wall temperatures?.

bc_pressure_extrapolations(*args, **kwargs)

Setting pressure extrapolations schemes on boundaries.

bcd_boundedness(*args, **kwargs)

BCD scheme boundedness strength, constant or expression (0 to 1).

bcd_weights_freeze(*args, **kwargs)

At each timestep, freeze BCD scheme weights after specified iteration in order to improve timestep convergence.

correction_form(*args, **kwargs)

Discretize momentum equations in correction form for the pressure-based solver.

disable_reconstruction(*args, **kwargs)

Enable/Disable reconstruction. When disabled, accuracy will be first-order.

class divergence_prevention(path, service)

Bases: TUIMenu

Enter the divergence prevention menu.

Methods:

enable(*args, **kwargs)

Enable divergence prevention.

enable(*args, **kwargs)

Enable divergence prevention.

energy_numerical_noise_filter(*args, **kwargs)

The energy equation numerical noise filter can be enabled to eliminate non-physical numerical noise in the energy field. The 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.

equation_ordering(*args, **kwargs)

Set the equation order.

explicit_under_relaxation_value(*args, **kwargs)

Explicit under-relaxation value.

flow_warnings(*args, **kwargs)

Control the display of warning diagnostics for boundaries with reversed flow, etc.

class high_speed_numerics(path, service)

Bases: TUIMenu

Enter high-speed-numerics menu.

Methods:

enable(*args, **kwargs)	Enable/disable high-speed-numerics.
expert(*args, **kwargs)	Expert high-speed-numerics.
visualize_pressure_discontinuity_sensor(...)	Enable/disable pressure-discontinuity-sensor visualization.

enable(*args, **kwargs)

Enable/disable high-speed-numerics.

expert(*args, **kwargs)

Expert high-speed-numerics.

visualize_pressure_discontinuity_sensor(*args, **kwargs)

Enable/disable pressure-discontinuity-sensor visualization.

limiter_warnings(*args, **kwargs)

Control the display of limiter warning diagnostics.

linearized_mass_transfer_udf(*args, **kwargs)

Use linearized mass transfer UDFs?.

lock_solid_temperature(*args, **kwargs)

Lock the temperature for all solid and shell cell zones in the domain.

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.

mp_mfluid_aniso_drag(*args, **kwargs)

Set anisotropic drag parameters for Eulerian multiphase.

mp_reference_density(*args, **kwargs)

Set reference density option for Eulerian multiphase.

class non_reflecting_boundary_treatment(path, service)

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.

numerical_beach_controls(*args, **kwargs)

Set damping function in flow direction.

open_channel_controls(*args, **kwargs)

Set additional open channel controls.

class open_channel_wave_options(path, service)

Bases: TUIMenu

Enter the open-channel-wave-options menu.

Methods:

set_buffer_layer_ht(*args, **kwargs)	Set bufer layer height between phases for segregated velocity inputs.
set_verbosity(*args, **kwargs)	Set open channel wave verbosity.
stokes_wave_variants(*args, **kwargs)	Set stokes wave theory variants.

set_buffer_layer_ht(*args, **kwargs)

Set bufer layer height between phases for segregated velocity inputs.

set_verbosity(*args, **kwargs)

Set open channel wave verbosity.

stokes_wave_variants(*args, **kwargs)

Set stokes wave theory variants.

class poor_mesh_numerics(path, service)

Bases: TUIMenu

Enter Poor Mesh Numerics Menu.

Methods:

cell_quality_based(*args, **kwargs)	Enable/disable poor mesh numerics on cells with low quality.
enable(*args, **kwargs)	Solution correction on meshes of poor quality.
enhanced_pmn(*args, **kwargs)	This option is available with the density-based solver.
gradient_quality_based(*args, **kwargs)	Enable/disable poor mesh numerics based on cell gradient quality.
orthogonality_enhancing_cell_centroids(...)	Relocate select cell centroids, to improve orthogonality metrics and solution stability.
print_poor_elements_count(*args, **kwargs)	Print poor cells count.
reset_poor_elements(*args, **kwargs)	Reset marking of poor cell elements.
set_quality_threshold(*args, **kwargs)	Set quality threshold.
solution_and_quality_based(*args, **kwargs)	Enable/disable poor mesh numerics based on solution and cell quality.
user_defined_on_register(*args, **kwargs)	Include cells in register in poor mesh numerics.
user_defined_on_register_auto(*args, **kwargs)	Set up the application of poor mesh numerics to cells in a register during the calculation at a specified frequency.

Classes:

solution_based_pmn(path, service)

Solution based poor-mesh numerics menu.

cell_quality_based(*args, **kwargs)

Enable/disable poor mesh numerics on cells with low quality.

enable(*args, **kwargs)

Solution correction on meshes of poor quality.

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)

Enable/disable poor mesh numerics based on cell gradient quality.

orthogonality_enhancing_cell_centroids(*args, **kwargs)

Relocate select cell centroids, to improve orthogonality metrics and solution stability.

print_poor_elements_count(*args, **kwargs)

Print poor cells count.

reset_poor_elements(*args, **kwargs)

Reset marking of poor cell elements.

set_quality_threshold(*args, **kwargs)

Set quality threshold.

solution_and_quality_based(*args, **kwargs)

Enable/disable poor mesh numerics based on solution and cell quality.

class solution_based_pmn(path, service)

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.

user_defined_on_register(*args, **kwargs)

Include cells in register in poor mesh numerics.

user_defined_on_register_auto(*args, **kwargs)

Set up the application of poor mesh numerics to cells in a register during the calculation at a specified frequency.

class previous_defaults(path, service)

Bases: TUIMenu

Enter previous defaults menu.

Methods:

undo_2019r1_default_changes(*args, **kwargs)	Undo default changes introduced in 2019R1.
undo_2019r3_default_changes(*args, **kwargs)	Undo default changes introduced in 2019R3.
undo_2021r1_default_changes(*args, **kwargs)	Undo default changes introduced in 2021R1.
undo_2021r2_default_changes(*args, **kwargs)	Undo default changes introduced in 2021R2.
undo_2022r1_default_changes(*args, **kwargs)	Undo default changes introduced in 2022R1.
undo_2023r1_default_changes(*args, **kwargs)	Undo default changes introduced in 2023R1.
undo_r19_point_0_default_changes(*args, **kwargs)	Undo default changes introduced in R19.0.

undo_2019r1_default_changes(*args, **kwargs)

Undo default changes introduced in 2019R1.

undo_2019r3_default_changes(*args, **kwargs)

Undo default changes introduced in 2019R3.

undo_2021r1_default_changes(*args, **kwargs)

Undo default changes introduced in 2021R1.

undo_2021r2_default_changes(*args, **kwargs)

Undo default changes introduced in 2021R2.

undo_2022r1_default_changes(*args, **kwargs)

Undo default changes introduced in 2022R1.

undo_2023r1_default_changes(*args, **kwargs)

Undo default changes introduced in 2023R1.

undo_r19_point_0_default_changes(*args, **kwargs)

Undo default changes introduced in R19.0.

retain_cell_residuals(*args, **kwargs)

Retain cell residuals for postprocessing?.

retain_temporary_solver_mem(*args, **kwargs)

Retain temporary solver memory?.

class secondary_gradient_limiting(path, service)

Bases: TUIMenu

Enter the Secondary Gradient Limiting Menu.

Methods:

energy(*args, **kwargs)	Enable/disable secondary gradient limiting at coupled walls for energy equation.
mesh_quality_limits(*args, **kwargs)	Specify minimum and maximum mesh quality limits.
uds(*args, **kwargs)	Enable/disable secondary gradient limiting at coupled walls for user-defined scalars.

energy(*args, **kwargs)

Enable/disable secondary gradient limiting at coupled walls for energy equation.

mesh_quality_limits(*args, **kwargs)

Specify minimum and maximum mesh quality limits.

uds(*args, **kwargs)

Enable/disable secondary gradient limiting at coupled walls for user-defined scalars.

set_all_species_together(*args, **kwargs)

Set all species discretizations and URFs together.

show_all_discretization_schemes(*args, **kwargs)

Allow selection of all applicable discretization schemes?.

singhal_et_al_cavitation_model(*args, **kwargs)

Use Singhal-et-al cavitation model?.

surface_tension(*args, **kwargs)

Set surface-tension calculation options.

surface_tension_expert(*args, **kwargs)

Set surface-tension expert options.

vof_explicit_controls(*args, **kwargs)

Set Explicit VOF controls.

class initialize(path, service)

Bases: TUIMenu

Enter the flow initialization menu.

Classes:

compute_defaults(path, service)	Enter the compute defaults menu.
mp_localized_turb_init(path, service)	Localized initialization of turbulent flow variables for VOF/Mixture multiphase flow models.
set_fmg_options(path, service)	Enter the full-multigrid option menu.
vof_patch_smooth_options(path, service)	Enter the vof patch/smooth options menu.

Methods:

dpm_reset(*args, **kwargs)	Reset discrete phase source terms to zero.
fmg_initialization(*args, **kwargs)	Initialize using the full-multigrid initialization (FMG).
hyb_initialization(*args, **kwargs)	Initialize using the hybrid initialization method.
init_acoustics_options(*args, **kwargs)	Specify number of timesteps for ramping of sources and initialize acoustics model variables.
init_flow_statistics(*args, **kwargs)	Initialize statistics.
init_turb_vel_fluctuations(*args, **kwargs)	Initialize turbulent velocity fluctuations.
initialize_flow(*args, **kwargs)	Initialize the flow field with the current default values.
levelset_auto_init(*args, **kwargs)	Levelset function automatic initialization.
list_defaults(*args, **kwargs)	List default values.
lwf_initialization(*args, **kwargs)	Delete wall film particles and initialize wall film variables to zero.
open_channel_auto_init(*args, **kwargs)	Open channel automatic initialization.
patch(*args, **kwargs)	Patch a value for a flow variable in the domain.
reference_frame(*args, **kwargs)	Set reference frame absolute or relative.
repair_wall_distance(*args, **kwargs)	Correct wall distance at very high aspect ratio hexahedral/polyhedral cells.
set_defaults(*args, **kwargs)	Enter the set defaults menu.
set_fmg_initialization(*args, **kwargs)	Enter the set full-multigrid for initialization menu.
set_hyb_initialization(*args, **kwargs)	Enter the settings for hybrid initialization method.
show_iterations_sampled(*args, **kwargs)	Display the amount of simulated iterations covered by the data sampled for steady statistics.
show_time_sampled(*args, **kwargs)	Display the amount of simulated time covered by the data sampled for unsteady statistics.

class compute_defaults(path, service)

Bases: TUIMenu

Enter the compute defaults menu.

Methods:

all_zones(*args, **kwargs)	Initialize 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)

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

Reset discrete phase source terms to zero.

fmg_initialization(*args, **kwargs)

Initialize using the full-multigrid initialization (FMG).

hyb_initialization(*args, **kwargs)

Initialize using the hybrid initialization method.

init_acoustics_options(*args, **kwargs)

Specify number of timesteps for ramping of sources and initialize acoustics model variables. During ramping the sound sources are multiplied by a factor smoothly growing from 0 to 1.

init_flow_statistics(*args, **kwargs)

Initialize statistics.

init_turb_vel_fluctuations(*args, **kwargs)

Initialize turbulent velocity fluctuations.

initialize_flow(*args, **kwargs)

Initialize the flow field with the current default values.

levelset_auto_init(*args, **kwargs)

Levelset function automatic initialization.

list_defaults(*args, **kwargs)

List default values.

lwf_initialization(*args, **kwargs)

Delete wall film particles and initialize wall film variables to zero.

class mp_localized_turb_init(path, service)

Bases: TUIMenu

Localized initialization of turbulent flow variables for VOF/Mixture multiphase flow models.

Methods:

enable(*args, **kwargs)	Localized initialization of turbulent flow variables for VOF/Mixture multiphase flow models.
turb_init_parameters(*args, **kwargs)	Turbulent flow parameters for localized initialization.

enable(*args, **kwargs)

Localized initialization of turbulent flow variables for VOF/Mixture multiphase flow models.

turb_init_parameters(*args, **kwargs)

Turbulent flow parameters for localized initialization.

open_channel_auto_init(*args, **kwargs)

Open channel automatic initialization.

patch(*args, **kwargs)

Patch a value for a flow variable in the domain.

reference_frame(*args, **kwargs)

Set reference frame absolute or relative.

repair_wall_distance(*args, **kwargs)

Correct wall distance at very high aspect ratio hexahedral/polyhedral cells.

set_defaults(*args, **kwargs)

Enter the set defaults menu.

set_fmg_initialization(*args, **kwargs)

Enter the set full-multigrid for initialization menu.

class set_fmg_options(path, service)

Bases: TUIMenu

Enter the full-multigrid option menu.

Methods:

set_turbulent_viscosity_ratio(*args, **kwargs)	Set turbulent viscosity ratio used during FMG initialization.
species_reactions(*args, **kwargs)	Enable/disable species volumetric reactions during FMG initialization.
viscous_terms(*args, **kwargs)	Enable/disable viscous terms during FMG initialization.

set_turbulent_viscosity_ratio(*args, **kwargs)

Set turbulent viscosity ratio used during FMG initialization.

species_reactions(*args, **kwargs)

Enable/disable species volumetric reactions during FMG initialization.

viscous_terms(*args, **kwargs)

Enable/disable viscous terms during FMG initialization.

set_hyb_initialization(*args, **kwargs)

Enter the settings for hybrid initialization method.

show_iterations_sampled(*args, **kwargs)

Display the amount of simulated iterations covered by the data sampled for steady statistics.

show_time_sampled(*args, **kwargs)

Display the amount of simulated time covered by the data sampled for unsteady statistics.

class vof_patch_smooth_options(path, service)

Bases: TUIMenu

Enter the vof patch/smooth options menu.

Methods:

execute_smoothing(*args, **kwargs)	Execute volumetric smoothing for volume fraction.
set_options(*args, **kwargs)	Patch and smoothing options for volume fraction.

execute_smoothing(*args, **kwargs)

Execute volumetric smoothing for volume fraction.

set_options(*args, **kwargs)

Patch and smoothing options for volume fraction.

class methods(path, service)

Bases: TUIMenu

Enter the methods menu.

Methods:

accelerated_non_iterative_time_marching(...)	Enable/disable accelerated non-iterative time marching.
convergence_acceleration_for_stretched_meshes(...)	Enable convergence acceleration for stretched meshes to improve the convergence of the implicit density based solver on meshes with high cell stretching.
discretization_scheme(*args, **kwargs)	Enter the discretization-scheme menu.
flux_type(*args, **kwargs)	Enter the flux type.
frozen_flux(*args, **kwargs)	Enable/disable frozen flux formulation for transient flows.
gradient_scheme(*args, **kwargs)	Set gradient options.
nb_gradient_boundary_option(*args, **kwargs)	Set ggnb options.
noniterative_time_advance(*args, **kwargs)	Enable/disable the noniterative time advancement scheme.
p_v_coupling(*args, **kwargs)	Select the pressure velocity coupling scheme.
phase_based_vof_discretization(*args, **kwargs)	Set phase based slope limiter for VOF compressive scheme.
reduced_rank_extrapolation(*args, **kwargs)	Enable Reduced Rank Extrapolation method to accelerate solution time.
reduced_rank_extrapolation_options(*args, ...)	Reduced Rank Extrapolation options.
residual_smoothing(*args, **kwargs)	Set residual smoothing factor and number of iterations.
set_solution_methods_to_default(*args, **kwargs)	Set solution methods to default values.
unsteady_1st_order(*args, **kwargs)	Enable/disable first-order unsteady solution model.
unsteady_2nd_order(*args, **kwargs)	Enable/disable the second-order unsteady solution model.
unsteady_2nd_order_bounded(*args, **kwargs)	Enable/disable bounded second-order unsteady formulation.
unsteady_global_time(*args, **kwargs)	Enable/disable the unsteady global-time-step solution model.
vof_numerics(*args, **kwargs)	Set VOF numeric options.

Classes:

expert(path, service)	Enter expert menu.
high_order_term_relaxation(path, service)	Enter High Order Relaxation Menu.
multiphase_numerics(path, service)	Enter the multiphase numerics options menu.
nita_expert_controls(path, service)	Enter the nita expert controls menu.
overset(path, service)	Enter overset solver options menu.
pseudo_time_method(path, service)	Enter the pseudo time method menu.
query(path, service)	Enter methods query menu.
warped_face_gradient_correction(path, service)	Enter warped-face-gradient-correction menu.

accelerated_non_iterative_time_marching(*args, **kwargs)

Enable/disable accelerated non-iterative time marching.

convergence_acceleration_for_stretched_meshes(*args, **kwargs)

Enable convergence acceleration for stretched meshes to improve the convergence of the implicit density based solver on meshes with high cell stretching.

discretization_scheme(*args, **kwargs)

Enter the discretization-scheme menu.

class expert(path, service)

Bases: TUIMenu

Enter expert menu.

Methods:

numerics(*args, **kwargs)	Set numeric options.
reactions(*args, **kwargs)	Enable/disable the species reaction sources and set relaxation factor.

numerics(*args, **kwargs)

Set numeric options.

reactions(*args, **kwargs)

Enable/disable the species reaction sources and set relaxation factor.

flux_type(*args, **kwargs)

Enter the flux type.

frozen_flux(*args, **kwargs)

Enable/disable frozen flux formulation for transient flows.

gradient_scheme(*args, **kwargs)

Set gradient options.

class high_order_term_relaxation(path, service)

Bases: TUIMenu

Enter High Order Relaxation Menu.

Methods:

enable(*args, **kwargs)

Enable/Disable High Order Term Relaxation.

Classes:

options(path, service)

High Order Term Relaxation Options.

enable(*args, **kwargs)

Enable/Disable High Order Term Relaxation.

class options(path, service)

Bases: TUIMenu

High Order Term Relaxation Options.

Methods:

expert(*args, **kwargs)	Enter high order relaxation option with respect to diffusion gradient.
relaxation_factor(*args, **kwargs)	Sets relaxation factor.

Classes:

variables(path, service)

Select Variables.

expert(*args, **kwargs)

Enter high order relaxation option with respect to diffusion gradient.

relaxation_factor(*args, **kwargs)

Sets relaxation factor.

class variables(path, service)

Bases: TUIMenu

Select Variables.

Methods:

select(*args, **kwargs)

Select variables for high order term relaxation.

select(*args, **kwargs)

Select variables for high order term relaxation.

class multiphase_numerics(path, service)

Bases: TUIMenu

Enter the multiphase numerics options menu.

Classes:

advanced_stability_controls(path, service)	Stability controls for multiphase flow.
boiling_parameters(path, service)	Multiphase boiling parameters menu.
compressible_flow(path, service)	Multiphase compressible numerics options menu.
default_controls(path, service)	Multiphase default controls menu.
face_pressure_controls(path, service)	Enter the face pressure expert controls menu.
heat_mass_transfer(path, service)	Multiphase interphase heat and mass transfer numerics options menu.
porous_media(path, service)	Multiphase miscellaneous porous media numerics menu.
solution_stabilization(path, service)	VOF solution stabilization menu.
viscous_flow(path, service)	Multiphase viscous flow numerics options menu.

class advanced_stability_controls(path, service)

Bases: TUIMenu

Stability controls for multiphase flow.

Classes:

anti_diffusion(path, service)	Anti Diffusion Menu for VOF/Multi-Fluid VOF Models.
equation_order(path, service)	Equation Order Menu for Homogeneous Multiphase Flow Models.
hybrid_nita(path, service)	Hybrid NITA stability controls for multiphase flow.
num_ventilation(path, service)	Numerical Ventilation Menu for VOF Model.
p_v_coupling(path, service)	Pressure velocity coupling controls for multiphase flow.
pseudo_time(path, service)	Pseudo-Time stability controls for multiphase flow.

class anti_diffusion(path, service)

Bases: TUIMenu

Anti Diffusion Menu for VOF/Multi-Fluid VOF Models.

Methods:

enable_dynamic_strength(*args, **kwargs)	Enable dynamic strength to reduce compression in the tangential direction to the interface.
set_dynamic_strength_exponent(*args, **kwargs)	Set cosine exponent in dynamic strength treatment.
set_maximum_dynamic_strength(*args, **kwargs)	Set maximum value of dynamic anti-diffusion strength.

enable_dynamic_strength(*args, **kwargs)

Enable dynamic strength to reduce compression in the tangential direction to the interface.

set_dynamic_strength_exponent(*args, **kwargs)

Set cosine exponent in dynamic strength treatment.

set_maximum_dynamic_strength(*args, **kwargs)

Set maximum value of dynamic anti-diffusion strength.

class equation_order(path, service)

Bases: TUIMenu

Equation Order Menu for Homogeneous Multiphase Flow Models.

Methods:

solve_exp_vof_at_end(*args, **kwargs)	Solve Explicit VOF at the end of time-step as an alternative.
solve_flow_last(*args, **kwargs)	Solve flow equation at the end of iteration as an alternative.

solve_exp_vof_at_end(*args, **kwargs)

Solve Explicit VOF at the end of time-step as an alternative.

solve_flow_last(*args, **kwargs)

Solve flow equation at the end of iteration as an alternative.

class hybrid_nita(path, service)

Bases: TUIMenu

Hybrid NITA stability controls for multiphase flow.

Methods:

initial_outer_iterations(*args, **kwargs)	Set hybrid nita start-up controls.
outer_iterations(*args, **kwargs)	Set number of outer iterations in hybrid nita.

Classes:

instability_detector(path, service)

Set Hybrid NITA instability detector controls.

initial_outer_iterations(*args, **kwargs)

Set hybrid nita start-up controls.

class instability_detector(path, service)

Bases: TUIMenu

Set Hybrid NITA instability detector controls.

Methods:

enable_instability_detector(*args, **kwargs)	Enable instability detector for better stability.
set_cfl_limit(*args, **kwargs)	Set Courant Number limit for detection of unstable event.
set_cfl_type(*args, **kwargs)	Set Courant Number type for detection of unstable event.
set_velocity_limit(*args, **kwargs)	Set velocity limit for detection of unstable event.
unstable_event_outer_iterations(*args, **kwargs)	Set number of outer iterations for unstable event.

enable_instability_detector(*args, **kwargs)

Enable instability detector for better stability.

set_cfl_limit(*args, **kwargs)

Set Courant Number limit for detection of unstable event.

set_cfl_type(*args, **kwargs)

Set Courant Number type for detection of unstable event.

set_velocity_limit(*args, **kwargs)

Set velocity limit for detection of unstable event.

unstable_event_outer_iterations(*args, **kwargs)

Set number of outer iterations for unstable event.

outer_iterations(*args, **kwargs)

Set number of outer iterations in hybrid nita.

class num_ventilation(path, service)

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

Bases: TUIMenu

Pressure velocity coupling controls for multiphase flow.

Classes:

coupled_vof(path, service)	Set Coupled VOF stability controls.
rhie_chow_flux(path, service)	Set Rhie-Chow related stability controls.
skewness_correction(path, service)	Skewness correction related stabiity controls for multiphase flow.

class coupled_vof(path, service)

Bases: TUIMenu

Set Coupled VOF stability controls.

Methods:

buoyancy_force_linearization(*args, **kwargs)

Set buoynacy force linerization options in coupled vof.

buoyancy_force_linearization(*args, **kwargs)

Set buoynacy force linerization options in coupled vof.

class rhie_chow_flux(path, service)

Bases: TUIMenu

Set Rhie-Chow related stability controls.

Methods:

low_order_rhie_chow(*args, **kwargs)

Use low order velocity interpolation in flux calculation.

low_order_rhie_chow(*args, **kwargs)

Use low order velocity interpolation in flux calculation.

class skewness_correction(path, service)

Bases: TUIMenu

Skewness correction related stabiity controls for multiphase flow.

Methods:

limit_pressure_correction_gradient(*args, ...)

Use limited pressure correction gradient in skewness corrections for better stability.

limit_pressure_correction_gradient(*args, **kwargs)

Use limited pressure correction gradient in skewness corrections for better stability.

class pseudo_time(path, service)

Bases: TUIMenu

Pseudo-Time stability controls for multiphase flow.

Classes:

auto_dt_advanced_controls(path, service)

Set automatic time-stepping controls for better solution stability.

Methods:

false_time_step_linearization(*args, **kwargs)	Set false time-step linearization for added stability.
smoothed_density_stabilization_method(*args, ...)	Set smoothed density stabilization method.

class auto_dt_advanced_controls(path, service)

Bases: TUIMenu

Set automatic time-stepping controls for better solution stability.

Methods:

dt_factor_max(*args, **kwargs)	Set maximum limit for increase in pseudo time step size.
dt_factor_min(*args, **kwargs)	Set minimum limit for reduction in pseudo time step size.
dt_init_limit(*args, **kwargs)	Set maximum value for pseudo time step size during first iteration.
dt_max(*args, **kwargs)	Set maximum value for pseudo time step size.
enable(*args, **kwargs)	Enable advanced automatic time stepping for better stability.
max_velocity_ratio(*args, **kwargs)	Set velocity ratio to freeze the time step size for better solution stability.

dt_factor_max(*args, **kwargs)

Set maximum limit for increase in pseudo time step size.

dt_factor_min(*args, **kwargs)

Set minimum limit for reduction in pseudo time step size.

dt_init_limit(*args, **kwargs)

Set maximum value for pseudo time step size during first iteration.

dt_max(*args, **kwargs)

Set maximum value for pseudo time step size.

enable(*args, **kwargs)

Enable advanced automatic time stepping for better stability.

max_velocity_ratio(*args, **kwargs)

Set velocity ratio to freeze the time step size for better solution stability.

false_time_step_linearization(*args, **kwargs)

Set false time-step linearization for added stability.

smoothed_density_stabilization_method(*args, **kwargs)

Set smoothed density stabilization method.

class boiling_parameters(path, service)

Bases: TUIMenu

Multiphase boiling parameters menu.

Methods:

liquid_vof_factor(*args, **kwargs)	Multiphase boiling liquid volume fraction effects.
thin_film(*args, **kwargs)	Multiphase boiling thin film effects.

liquid_vof_factor(*args, **kwargs)

Multiphase boiling liquid volume fraction effects.

thin_film(*args, **kwargs)

Multiphase boiling thin film effects.

class compressible_flow(path, service)

Bases: TUIMenu

Multiphase compressible numerics options menu.

Methods:

alternate_bc_formulation(*args, **kwargs)	Multiphase compressible flow BC alternate method.
enhanced_numerics(*args, **kwargs)	Multiphase enhanced compressible flow numerics options.

alternate_bc_formulation(*args, **kwargs)

Multiphase compressible flow BC alternate method.

enhanced_numerics(*args, **kwargs)

Multiphase enhanced compressible flow numerics options.

class default_controls(path, service)

Bases: TUIMenu

Multiphase default controls menu.

Methods:

recommended_defaults_for_existing_cases(...)	Activate multiphase defaults for loaded case.
revert_to_pre_r20_point_1_default_settings(...)	Revert to pre-R20.1 multiphase flow default settings.

recommended_defaults_for_existing_cases(*args, **kwargs)

Activate multiphase defaults for loaded case.

revert_to_pre_r20_point_1_default_settings(*args, **kwargs)

Revert to pre-R20.1 multiphase flow default settings.

class face_pressure_controls(path, service)

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

Bases: TUIMenu

Multiphase interphase heat and mass transfer numerics options menu.

Methods:

alternative_energy_treatment(*args, **kwargs)

Alternative treatment of latent heat source due to mass transfer.

Classes:

area_density(path, service)	Interfacial area density menu.
boiling(path, service)	Boiling advanced options menu.
cavitation(path, service)	Cavitation numerics options menu.
evaporation_condensation(path, service)	Evaporation-condensation advanced options menu.

alternative_energy_treatment(*args, **kwargs)

Alternative treatment of latent heat source due to mass transfer.

class area_density(path, service)

Bases: TUIMenu

Interfacial area density menu.

Methods:

ia_grad_sym(*args, **kwargs)	Interfacial area density gradient-symmetric mechanism.
vof_min_seeding(*args, **kwargs)	Minimum vof seeding for non-zero area density in heat and mass transfer.

ia_grad_sym(*args, **kwargs)

Interfacial area density gradient-symmetric mechanism.

vof_min_seeding(*args, **kwargs)

Minimum vof seeding for non-zero area density in heat and mass transfer.

class boiling(path, service)

Bases: TUIMenu

Boiling advanced options menu.

Methods:

heat_flux_relaxation_factor(*args, **kwargs)	Under-relaxation factor for boiling heat flux.
show_expert_options(*args, **kwargs)	Exposes expert options of min/max superheat along with wetting fraction controls.
two_resistance_boiling_framework(*args, **kwargs)	Allow generalized two-resistance framework for boiling model.

heat_flux_relaxation_factor(*args, **kwargs)

Under-relaxation factor for boiling heat flux.

show_expert_options(*args, **kwargs)

Exposes expert options of min/max superheat along with wetting fraction controls.

two_resistance_boiling_framework(*args, **kwargs)

Allow generalized two-resistance framework for boiling model.

class cavitation(path, service)

Bases: TUIMenu

Cavitation numerics options menu.

Methods:

display_clipped_pressure(*args, **kwargs)	Clipped pressure is just used for the properties evaluation.
max_vapor_pressure_ratio(*args, **kwargs)	Maximum limit on vapor pressure after turbulence and thermal correction.
min_vapor_pressure(*args, **kwargs)	Minimum vapor pressure limit for cavitation model.
schnerr_cond_coeff(*args, **kwargs)	Condensation coefficient for Schnerr-Sauer model.
schnerr_evap_coeff(*args, **kwargs)	Evaporation coefficient for Schnerr-Sauer model.
turbulent_diffusion(*args, **kwargs)	Enable/disable turbulent diffusion treatment between phases participating in cavitation.

display_clipped_pressure(*args, **kwargs)

Clipped pressure is just used for the properties evaluation. Mass Transfer Rate uses unclipped pressure.

max_vapor_pressure_ratio(*args, **kwargs)

Maximum limit on vapor pressure after turbulence and thermal correction.

min_vapor_pressure(*args, **kwargs)

Minimum vapor pressure limit for cavitation model.

schnerr_cond_coeff(*args, **kwargs)

Condensation coefficient for Schnerr-Sauer model.

schnerr_evap_coeff(*args, **kwargs)

Evaporation coefficient for Schnerr-Sauer model.

turbulent_diffusion(*args, **kwargs)

Enable/disable turbulent diffusion treatment between phases participating in cavitation. This treatment is generally recommended for better solution stability. However, in case of numerical difficulties, it can be disabled.

class evaporation_condensation(path, service)

Bases: TUIMenu

Evaporation-condensation advanced options menu.

Methods:

ia_norm_min_limit(*args, **kwargs)	Minimum normalized area density below which mass transfer rate is set to zero.
max_rel_humidity(*args, **kwargs)	Maximum value of relative humidity to limit condensation rate.
vof_from_max_limit(*args, **kwargs)	Maximum volume fraction above which mass transfer rate is set to zero.
vof_from_min_limit(*args, **kwargs)	Minimum volume fraction below which mass transfer rate is set to zero.
vof_to_max_limit(*args, **kwargs)	Maximum volume fraction above which mass transfer rate is set to zero.
vof_to_min_limit(*args, **kwargs)	Minimum volume fraction below which mass transfer rate is set to zero.

ia_norm_min_limit(*args, **kwargs)

Minimum normalized area density below which mass transfer rate is set to zero.

max_rel_humidity(*args, **kwargs)

Maximum value of relative humidity to limit condensation rate.

vof_from_max_limit(*args, **kwargs)

Maximum volume fraction above which mass transfer rate is set to zero.

vof_from_min_limit(*args, **kwargs)

Minimum volume fraction below which mass transfer rate is set to zero.

vof_to_max_limit(*args, **kwargs)

Maximum volume fraction above which mass transfer rate is set to zero.

vof_to_min_limit(*args, **kwargs)

Minimum volume fraction below which mass transfer rate is set to zero.

class porous_media(path, service)

Bases: TUIMenu

Multiphase miscellaneous porous media numerics menu.

Methods:

capillary_pressure_as_diffusion(*args, **kwargs)	Model capillary pressure as diffusion.
relative_permeability(*args, **kwargs)	Multiphase relative permeability fix option.

capillary_pressure_as_diffusion(*args, **kwargs)

Model capillary pressure as diffusion.

relative_permeability(*args, **kwargs)

Multiphase relative permeability fix option.

class solution_stabilization(path, service)

Bases: TUIMenu

VOF solution stabilization menu.

Classes:

additional_stabilization_controls(path, service)	Additional advanced stability controls for VOF.
velocity_limiting_treatment(path, service)	Velocity limiting related stabiity controls for VOF.

Methods:

execute_additional_stability_controls(*args, ...)	Execute additional stability controls for VOF.
execute_advanced_stabilization(*args, **kwargs)	Execute advanced stabilization for VOF.
execute_settings_optimization(*args, **kwargs)	Execute optimized settings for VOF.

class additional_stabilization_controls(path, service)

Bases: TUIMenu

Additional advanced stability controls for VOF.

Methods:

blended_compressive_scheme(*args, **kwargs)	Blended Compressive discretization scheme for VOF.
pseudo_time_stabilization(*args, **kwargs)	Pseudo-Time Momentum stabilization and False Time Step Linearization methods for VOF.

blended_compressive_scheme(*args, **kwargs)

Blended Compressive discretization scheme for VOF.

pseudo_time_stabilization(*args, **kwargs)

Pseudo-Time Momentum stabilization and False Time Step Linearization methods for VOF.

execute_additional_stability_controls(*args, **kwargs)

Execute additional stability controls for VOF.

execute_advanced_stabilization(*args, **kwargs)

Execute advanced stabilization for VOF.

execute_settings_optimization(*args, **kwargs)

Execute optimized settings for VOF.

class velocity_limiting_treatment(path, service)

Bases: TUIMenu

Velocity limiting related stabiity controls for VOF.

Methods:

enable_velocity_limiting(*args, **kwargs)	Enable velocity limiting treatment.
set_damping_strength(*args, **kwargs)	Enter damping strength.
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)	Enter max velocity magnitude.
verbosity(*args, **kwargs)	Enable verbosity to print number of velocity limited cells during iterations.

enable_velocity_limiting(*args, **kwargs)

Enable velocity limiting treatment.

set_damping_strength(*args, **kwargs)

Enter damping strength.

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)

Enter max velocity magnitude.

verbosity(*args, **kwargs)

Enable verbosity to print number of velocity limited cells during iterations.

class viscous_flow(path, service)

Bases: TUIMenu

Multiphase viscous flow numerics options menu.

Methods:

interfacial_artificial_viscosity(*args, **kwargs)	Interfacial artifical viscosity controls.
turb_visc_based_damping(*args, **kwargs)	Turbulence viscosity based damping controls.
viscosity_averaging(*args, **kwargs)	Multiphase options for viscosity averaging.

interfacial_artificial_viscosity(*args, **kwargs)

Interfacial artifical viscosity controls.

turb_visc_based_damping(*args, **kwargs)

Turbulence viscosity based damping controls.

viscosity_averaging(*args, **kwargs)

Multiphase options for viscosity averaging.

nb_gradient_boundary_option(*args, **kwargs)

Set ggnb options.

class nita_expert_controls(path, service)

Bases: TUIMenu

Enter the nita expert controls menu.

Methods:

hybrid_nita_settings(*args, **kwargs)	Select a hybrid NITA settings option for faster performance and better robustness.
set_verbosity(*args, **kwargs)	Set nita verbosity option.
skewness_neighbor_coupling(*args, **kwargs)	Set skewness neighbor coupling for nita.

hybrid_nita_settings(*args, **kwargs)

Select a hybrid NITA settings option for faster performance and better robustness.

set_verbosity(*args, **kwargs)

Set nita verbosity option.

skewness_neighbor_coupling(*args, **kwargs)

Set skewness neighbor coupling for nita.

noniterative_time_advance(*args, **kwargs)

Enable/disable the noniterative time advancement scheme.

class overset(path, service)

Bases: TUIMenu

Enter overset solver options menu.

Classes:

expert(path, service)

Enter overset expert solver options menu.

Methods:

high_order_pressure(*args, **kwargs)	High order pressure extrapolation at overset interface.
interpolation_method(*args, **kwargs)	Choose the interpolation method for overset interface(s).
orphan_cell_treatment(*args, **kwargs)	Enable solver to run with orphans present.

class expert(path, service)

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)

High order pressure extrapolation at overset interface.

interpolation_method(*args, **kwargs)

Choose the interpolation method for overset interface(s).

orphan_cell_treatment(*args, **kwargs)

Enable solver to run with orphans present.

p_v_coupling(*args, **kwargs)

Select the pressure velocity coupling scheme.

phase_based_vof_discretization(*args, **kwargs)

Set phase based slope limiter for VOF compressive scheme.

class pseudo_time_method(path, service)

Bases: TUIMenu

Enter the pseudo time method menu.

Methods:

advanced_options(*args, **kwargs)	Enter the advanced options menu to define pseudo time settings for equations.
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.
formulation(*args, **kwargs)	Select the pseudo time step size formulation for the pseudo time method.
global_time_step_settings(*args, **kwargs)	Adjust the settings for the global time step formulation.
local_time_step_settings(*args, **kwargs)	Adjust the settings for the local time step formulation.
relaxation_bounds(*args, **kwargs)	Select relaxation bounding scheme for pseudo time method.
relaxation_factors(*args, **kwargs)	Enter the relaxation factors menu to set the pseudo time explicit relaxation factors for equations.
relaxation_method(*args, **kwargs)	Select relaxation definition for pseudo time method.
verbosity(*args, **kwargs)	Set the verbosity for the pseudo time method.

advanced_options(*args, **kwargs)

Enter the advanced options menu to define pseudo time settings for equations.

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.

formulation(*args, **kwargs)

Select the pseudo time step size formulation for the pseudo time method.

global_time_step_settings(*args, **kwargs)

Adjust the settings for the global time step formulation.

local_time_step_settings(*args, **kwargs)

Adjust the settings for the local time step formulation.

relaxation_bounds(*args, **kwargs)

Select relaxation bounding scheme for pseudo time method.

relaxation_factors(*args, **kwargs)

Enter the relaxation factors menu to set the pseudo time explicit relaxation factors for equations.

relaxation_method(*args, **kwargs)

Select relaxation definition for pseudo time method.

verbosity(*args, **kwargs)

Set the verbosity for the pseudo time method.

class query(path, service)

Bases: TUIMenu

Enter methods query menu.

Methods:

discretization_scheme(*args, **kwargs)	Enter the discretization-scheme menu.
p_v_coupling(*args, **kwargs)	Get the pressure velocity coupling scheme.

discretization_scheme(*args, **kwargs)

Enter the discretization-scheme menu.

p_v_coupling(*args, **kwargs)

Get the pressure velocity coupling scheme.

reduced_rank_extrapolation(*args, **kwargs)

Enable Reduced Rank Extrapolation method to accelerate solution time.

reduced_rank_extrapolation_options(*args, **kwargs)

Reduced Rank Extrapolation options.

residual_smoothing(*args, **kwargs)

Set residual smoothing factor and number of iterations.

set_solution_methods_to_default(*args, **kwargs)

Set solution methods to default values.

unsteady_1st_order(*args, **kwargs)

Enable/disable first-order unsteady solution model.

unsteady_2nd_order(*args, **kwargs)

Enable/disable the second-order unsteady solution model.

unsteady_2nd_order_bounded(*args, **kwargs)

Enable/disable bounded second-order unsteady formulation.

unsteady_global_time(*args, **kwargs)

Enable/disable the unsteady global-time-step solution model.

vof_numerics(*args, **kwargs)

Set VOF numeric options.

class warped_face_gradient_correction(path, service)

Bases: TUIMenu

Enter warped-face-gradient-correction menu.

Methods:

enable(*args, **kwargs)	Enable Warped-Face Gradient Correction.
turbulence_options(*args, **kwargs)	Set turbulence Warped Face Gradient Correction.

enable(*args, **kwargs)

Enable Warped-Face Gradient Correction.

turbulence_options(*args, **kwargs)

Set turbulence Warped Face Gradient Correction.

class monitors(path, service)

Bases: TUIMenu

Enter the monitors menu.

Methods:

convergence_conditions(*args, **kwargs)	Manage convergence report.
set_average_over(*args, **kwargs)	Set the average over input for monitors.

Classes:

report_files(path, service)	Manage report files.
report_plots(path, service)	Manage report plots.
residual(path, service)	Enter the residual monitors menu.

convergence_conditions(*args, **kwargs)

Manage convergence report.

class report_files(path, service)

Bases: TUIMenu

Manage report files.

Methods:

add(*args, **kwargs)	Add a new object.
clear_data(*args, **kwargs)	Delete the report file from the system.
delete(*args, **kwargs)	Delete an object.
delete_all(*args, **kwargs)	Delete all report file objects.
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.

clear_data(*args, **kwargs)

Delete the report file from the system.

delete(*args, **kwargs)

Delete an object.

delete_all(*args, **kwargs)

Delete all report file objects.

edit(*args, **kwargs)

Edit an object.

list(*args, **kwargs)

List objects.

list_properties(*args, **kwargs)

List properties of an object.

class report_plots(path, service)

Bases: TUIMenu

Manage report plots.

Methods:

add(*args, **kwargs)	Add a new object.
axes(*args, **kwargs)	Set axes options of an object.
clear_data(*args, **kwargs)	Clear report plot data.
curves(*args, **kwargs)	Set curves options of an object.
delete(*args, **kwargs)	Delete an object.
delete_all(*args, **kwargs)	Delete all plot objects.
edit(*args, **kwargs)	Edit an object.
list(*args, **kwargs)	List objects.
list_properties(*args, **kwargs)	List properties of an object.
plot(*args, **kwargs)	Plot.

add(*args, **kwargs)

Add a new object.

axes(*args, **kwargs)

Set axes options of an object.

clear_data(*args, **kwargs)

Clear report plot data.

curves(*args, **kwargs)

Set curves options of an object.

delete(*args, **kwargs)

Delete an object.

delete_all(*args, **kwargs)

Delete all plot objects.

edit(*args, **kwargs)

Edit an object.

list(*args, **kwargs)

List objects.

list_properties(*args, **kwargs)

List properties of an object.

plot(*args, **kwargs)

Plot.

class residual(path, service)

Bases: TUIMenu

Enter the residual monitors menu.

Methods:

check_convergence(*args, **kwargs)	Choose which currently-monitored residuals should be checked for convergence.
convergence_criteria(*args, **kwargs)	Set convergence criteria for residuals which are currently being both monitored and checked.
criterion_type(*args, **kwargs)	Set convergence criterion type.
enhanced_continuity_residual(*args, **kwargs)	Scale the continuity residuals locally based on the enhanced formulation.
monitor(*args, **kwargs)	Choose which residuals to monitor as printed and/or plotted output.
n_display(*args, **kwargs)	Set the number of most recent residuals to display in plots.
n_maximize_norms(*args, **kwargs)	Set the number of iterations through which normalization factors will be maximized.
n_save(*args, **kwargs)	Set number of residuals to be saved with data.
normalization_factors(*args, **kwargs)	Set normalization factors for currently-monitored residuals.
normalize(*args, **kwargs)	Choose whether or not to normalize residuals in printed and plotted output.
plot(*args, **kwargs)	Choose whether or not residuals will be plotted during iteration.
print(*args, **kwargs)	Choose whether or not residuals will be printed during iteration.
re_normalize(*args, **kwargs)	Renormalize residuals by maximum values.
relative_conv_criteria(*args, **kwargs)	Set relative convergence criteria for residuals which are currently being both monitored and checked.
reset(*args, **kwargs)	Delete the residual history and reset iteration counter to unity.
scale_by_coefficient(*args, **kwargs)	Enable/disable scaling of residuals by coefficient sum in printed and plotted output.

check_convergence(*args, **kwargs)

Choose which currently-monitored residuals should be checked for convergence.

convergence_criteria(*args, **kwargs)

Set convergence criteria for residuals which are currently being both monitored and checked.

criterion_type(*args, **kwargs)

Set convergence criterion type.

enhanced_continuity_residual(*args, **kwargs)

Scale the continuity residuals locally based on the enhanced formulation.

monitor(*args, **kwargs)

Choose which residuals to monitor as printed and/or plotted output.

n_display(*args, **kwargs)

Set the number of most recent residuals to display in plots.

n_maximize_norms(*args, **kwargs)

Set the number of iterations through which normalization factors will be maximized.

n_save(*args, **kwargs)

Set number of residuals to be saved with data. History is automatically compacted when buffer becomes full.

normalization_factors(*args, **kwargs)

Set normalization factors for currently-monitored residuals.

normalize(*args, **kwargs)

Choose whether or not to normalize residuals in printed and plotted output.

plot(*args, **kwargs)

Choose whether or not residuals will be plotted during iteration.

print(*args, **kwargs)

Choose whether or not residuals will be printed during iteration.

re_normalize(*args, **kwargs)

Renormalize residuals by maximum values.

relative_conv_criteria(*args, **kwargs)

Set relative convergence criteria for residuals which are currently being both monitored and checked.

reset(*args, **kwargs)

Delete the residual history and reset iteration counter to unity.

scale_by_coefficient(*args, **kwargs)

Enable/disable scaling of residuals by coefficient sum in printed and plotted output.

set_average_over(*args, **kwargs)

Set the average over input for monitors.

class report_definitions(path, service)

Bases: TUIMenu

Manage report definitions.

Methods:

add(*args, **kwargs)	Add a new object.
compute(*args, **kwargs)	Computes selected report definition.
copy(*args, **kwargs)	Makes a copy of selected report definition with new name.
delete(*args, **kwargs)	Delete an object.
delete_all(*args, **kwargs)	Delete all report definition objects.
edit(*args, **kwargs)	Edit an object.
list(*args, **kwargs)	List objects.
list_properties(*args, **kwargs)	List properties of an object.
rename(*args, **kwargs)	Rename selected report definition with new name.

add(*args, **kwargs)

Add a new object.

compute(*args, **kwargs)

Computes selected report definition.

copy(*args, **kwargs)

Makes a copy of selected report definition with new name.

delete(*args, **kwargs)

Delete an object.

delete_all(*args, **kwargs)

Delete all report definition objects.

edit(*args, **kwargs)

Edit an object.

list(*args, **kwargs)

List objects.

list_properties(*args, **kwargs)

List properties of an object.

rename(*args, **kwargs)

Rename selected report definition with new name.

class run_calculation(path, service)

Bases: TUIMenu

Enter run calculation menu.

Methods:

adaptive_time_stepping(*args, **kwargs)	Set Error-based adaptive time-stepping parameters.
cfl_based_adaptive_time_stepping(*args, **kwargs)	Set CFL-based adaptive time-stepping parameters.
data_sampling(*args, **kwargs)	Set iteration options.
dual_time_iterate(*args, **kwargs)	Perform unsteady iterations.
iterate(*args, **kwargs)	Perform a specified number of iterations.
max_corrections(*args, **kwargs)	Enter the max-corrections menu.
mesh_motion(*args, **kwargs)	Perform mesh motion.
multistage_time_iterate(*args, **kwargs)	Perform unsteady iterations.
number_of_iterations(*args, **kwargs)	Set number of iterations.
reporting_interval(*args, **kwargs)	Set number of solver iterations before returning to scheme.
residual_tolerance(*args, **kwargs)	Enter the residual tolerance menu.
residual_verbosity(*args, **kwargs)	Set the residual report verbosity.
second_order_time_options(*args, **kwargs)	Set options for second-order time formulation.
set_solution_steering(*args, **kwargs)	Set Solution Steering Parameters.
solution_steering(*args, **kwargs)	Enable solution steering for density-based solver.
summary(*args, **kwargs)	Print report summary.
time_step(*args, **kwargs)	Set the time step.
update_physical_time(*args, **kwargs)	Update the solution to the next physical time level.
variable_time_stepping(*args, **kwargs)	Set Multiphase-Specific Adaptive time stepping parameters.

Classes:

data_sampling_options(path, service)	Data sampling options for statistics.
transient_controls(path, service)	Enter into the transient controls menu.

adaptive_time_stepping(*args, **kwargs)

Set Error-based adaptive time-stepping parameters.

cfl_based_adaptive_time_stepping(*args, **kwargs)

Set CFL-based adaptive time-stepping parameters.

data_sampling(*args, **kwargs)

Set iteration options.

class data_sampling_options(path, service)

Bases: TUIMenu

Data sampling options for statistics.

Methods:

add_datasets(*args, **kwargs)	Add a dataset.
add_rtdft_datasets(*args, **kwargs)	Add a dataset.
list_datasets(*args, **kwargs)	List dataset.
remove_dataset(*args, **kwargs)	Remove dataset.

Classes:

dft_datasets(path, service)

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.

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

Bases: TUIMenu

Data sampling options for runtime discrete Fourier transform.

Methods:

add_datasets(*args, **kwargs)	Add DFT datasets.
band_or_tone(*args, **kwargs)	Specify, whether a new dataset is for DFT in a frequency band resolved by many harmonics or for a single tone.
freq_min_max(*args, **kwargs)	Specify the minimum and the maximum frequency for a band.
freq_step_and_sampling(*args, **kwargs)	Specify either the band resolution or the sampling timesteps number.
freq_tone_and_sampling(*args, **kwargs)	Specify single tone frequency and sampling duration as the number of tone periods.
quantities(*args, **kwargs)	Select quantities for a new DFT dataset.
zones(*args, **kwargs)	Select zones for a new DFT dataset.

add_datasets(*args, **kwargs)

Add DFT datasets.

band_or_tone(*args, **kwargs)

Specify, whether a new dataset is for DFT in a frequency band resolved by many harmonics or for a single tone.

freq_min_max(*args, **kwargs)

Specify the minimum and the maximum frequency for a band.

freq_step_and_sampling(*args, **kwargs)

Specify either the band resolution or the sampling timesteps number. The other value will be computed consistently.

freq_tone_and_sampling(*args, **kwargs)

Specify single tone frequency and sampling duration as the number of tone periods.

quantities(*args, **kwargs)

Select quantities for a new DFT dataset. Enter () to complete the quantity selection.

zones(*args, **kwargs)

Select zones for a new DFT dataset.

list_datasets(*args, **kwargs)

List dataset.

remove_dataset(*args, **kwargs)

Remove dataset.

dual_time_iterate(*args, **kwargs)

Perform unsteady iterations.

iterate(*args, **kwargs)

Perform a specified number of iterations.

max_corrections(*args, **kwargs)

Enter the max-corrections menu.

mesh_motion(*args, **kwargs)

Perform mesh motion.

multistage_time_iterate(*args, **kwargs)

Perform unsteady iterations.

number_of_iterations(*args, **kwargs)

Set number of iterations.

reporting_interval(*args, **kwargs)

Set number of solver iterations before returning to scheme.

residual_tolerance(*args, **kwargs)

Enter the residual tolerance menu.

residual_verbosity(*args, **kwargs)

Set the residual report verbosity.

second_order_time_options(*args, **kwargs)

Set options for second-order time formulation.

set_solution_steering(*args, **kwargs)

Set Solution Steering Parameters.

solution_steering(*args, **kwargs)

Enable solution steering for density-based solver.

summary(*args, **kwargs)

Print report summary.

time_step(*args, **kwargs)

Set the time step.

class transient_controls(path, service)

Bases: TUIMenu

Enter into the transient controls menu.

Methods:

cfl_based_time_stepping(*args, **kwargs)	Set CFL-based adaptive time-stepping parameters.
cfl_based_time_stepping_advanced_options(...)	Set CFL-based adaptive time-stepping advanced parameters.
duration_specification_method(*args, **kwargs)	Set Duration Specification Method: [0] Incremental Time Steps, [1] Total Time Steps, [2] Total Time, [3] Incremental Time.
error_based_time_stepping(*args, **kwargs)	Set Error-based adaptive time-stepping parameters.
extrapolate_eqn_vars(*args, **kwargs)	Enter the extrapolation menu.
extrapolate_vars(*args, **kwargs)	Applies a predictor algorithm for computing initial condition at time step n+1.
fixed_periodic(*args, **kwargs)	Set period- or frequency-based fixed time-stepping parameters.
fixed_user_specified(*args, **kwargs)	Enable user-specified fixed time stepping method.
incremental_time(*args, **kwargs)	Set Incremental Time.
max_flow_time(*args, **kwargs)	Set maximum flow time.
max_iterations_per_time_step(*args, **kwargs)	Set Max Iterations/Time step.
multiphase_specific_time_stepping(*args, ...)	Set Multiphase-specific adaptive time stepping parameters.
number_of_time_steps(*args, **kwargs)	Set inceremtal number of Time steps.
predict_next_time(*args, **kwargs)	Applies a predictor algorithm for computing initial condition at time step n+1.
rotating_mesh_flow_predictor(*args, **kwargs)	Improve prediction of flow field at time step n+1 for rotating mesh.
solid_time_step_size(*args, **kwargs)	Specify a different time step size for solid zones.
solution_status(*args, **kwargs)	Activate the simulation status panel.
specified_time_step(*args, **kwargs)	Use specified time step or courant number.
time_step_size(*args, **kwargs)	Set the physical time step size.
time_step_size_for_acoustic_export(*args, ...)	Set number of time step size for acoustic export.
total_number_of_time_steps(*args, **kwargs)	Set total number of Time steps.
total_time(*args, **kwargs)	Set Total Simulation Time.
udf_based_time_stepping(*args, **kwargs)	Set the time-stepping parameters for user-defined time stepping method.
undo_timestep(*args, **kwargs)	Undo the previous time step.

Classes:

multiphase_specific_time_constraints(path, ...)

Set Multiphase-specific time constraints.

cfl_based_time_stepping(*args, **kwargs)

Set CFL-based adaptive time-stepping parameters.

cfl_based_time_stepping_advanced_options(*args, **kwargs)

Set CFL-based adaptive time-stepping advanced parameters.

duration_specification_method(*args, **kwargs)

Set Duration Specification Method: [0] Incremental Time Steps, [1] Total Time Steps, [2] Total Time, [3] Incremental Time.

error_based_time_stepping(*args, **kwargs)

Set Error-based adaptive time-stepping parameters.

extrapolate_eqn_vars(*args, **kwargs)

Enter the extrapolation menu.

extrapolate_vars(*args, **kwargs)

Applies a predictor algorithm for computing initial condition at time step n+1.

fixed_periodic(*args, **kwargs)

Set period- or frequency-based fixed time-stepping parameters.

fixed_user_specified(*args, **kwargs)

Enable user-specified fixed time stepping method.

incremental_time(*args, **kwargs)

Set Incremental Time.

max_flow_time(*args, **kwargs)

Set maximum flow time.

max_iterations_per_time_step(*args, **kwargs)

Set Max Iterations/Time step.

class multiphase_specific_time_constraints(path, service)

Bases: TUIMenu

Set Multiphase-specific time constraints.

Methods:

moving_mesh_cfl_constraint(*args, **kwargs)	Enable time step size constraints based on moving mesh courant number.
physics_based_constraint(*args, **kwargs)	Include physics driven time-step constraints.
verbosity(*args, **kwargs)	Set verbosity to print multiphase specific time scales.

Classes:

time_scale_options(path, service)

Set physics based time scale options.

moving_mesh_cfl_constraint(*args, **kwargs)

Enable time step size constraints based on moving mesh courant number.

physics_based_constraint(*args, **kwargs)

Include physics driven time-step constraints.

class time_scale_options(path, service)

Bases: TUIMenu

Set physics based time scale options.

Methods:

acoustic_scale(*args, **kwargs)	Include acoustic time scale.
gravity_scale(*args, **kwargs)	Include gravity based time scale.
surface_tension_scale(*args, **kwargs)	Include surface tension based time scale.
viscous_scale(*args, **kwargs)	Include viscous time scale.

acoustic_scale(*args, **kwargs)

Include acoustic time scale.

gravity_scale(*args, **kwargs)

Include gravity based time scale.

surface_tension_scale(*args, **kwargs)

Include surface tension based time scale.

viscous_scale(*args, **kwargs)

Include viscous time scale.

verbosity(*args, **kwargs)

Set verbosity to print multiphase specific time scales.

multiphase_specific_time_stepping(*args, **kwargs)

Set Multiphase-specific adaptive time stepping parameters.

number_of_time_steps(*args, **kwargs)

Set inceremtal number of Time steps.

predict_next_time(*args, **kwargs)

Applies a predictor algorithm for computing initial condition at time step n+1.

rotating_mesh_flow_predictor(*args, **kwargs)

Improve prediction of flow field at time step n+1 for rotating mesh.

solid_time_step_size(*args, **kwargs)

Specify a different time step size for solid zones.

solution_status(*args, **kwargs)

Activate the simulation status panel.

specified_time_step(*args, **kwargs)

Use specified time step or courant number.

time_step_size(*args, **kwargs)

Set the physical time step size.

time_step_size_for_acoustic_export(*args, **kwargs)

Set number of time step size for acoustic export.

total_number_of_time_steps(*args, **kwargs)

Set total number of Time steps.

total_time(*args, **kwargs)

Set Total Simulation Time.

udf_based_time_stepping(*args, **kwargs)

Set the time-stepping parameters for user-defined time stepping method.

undo_timestep(*args, **kwargs)

Undo the previous time step.

update_physical_time(*args, **kwargs)

Update the solution to the next physical time level.

variable_time_stepping(*args, **kwargs)

Set Multiphase-Specific Adaptive time stepping parameters.