controls#

class ansys.fluent.core.solver.tui_231.main_menu.solution.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.