set#
Bases:
TUIMenuEnters the set solution parameters menu.
Methods:
Enables a modified NITA scheme and other setting changes that can speed up the simulation.
adaptive_time_stepping(*args, **kwargs)Set Error-based adaptive time-stepping parameters.
bc_pressure_extrapolations(*args, **kwargs)Sets pressure extrapolations schemes on boundaries.
cfl_based_adaptive_time_stepping(*args, **kwargs)Set CFL-based adaptive time-stepping parameters.
Enables convergence acceleration for stretched meshes to improve the convergence of the implicit density based solver on meshes with high cell stretching.
correction_tolerance(*args, **kwargs)Enters the correction tolerance menu.
courant_number(*args, **kwargs)Sets the fine-grid Courant number (time step factor).
data_sampling(*args, **kwargs)Enables data sampling for steady or unsteady flow statistics.
disable_reconstruction(*args, **kwargs)Completely disables reconstruction, resulting in totally first-order accuracy.
discretization_scheme(*args, **kwargs)Enters the discretization scheme menu.
enable_output_dp_dt(*args, **kwargs)Controls whether the output field variabledp-dt will be available for transient simulation postprocessing.
equation_ordering(*args, **kwargs)Sets the order in which the model equations are solved, which can affect the convergence speed when you are using the pressure-based solver.
equations(*args, **kwargs)Selects the equations to be solved.
expert(*args, **kwargs)Sets expert options.
flow_warnings(*args, **kwargs)Specifies whether or not to print warning messages when reversed flow occurs at inlets and outlets, and when mass-flow inlets develop supersonic regions.
flux_type(*args, **kwargs)Enter the flux type.
gradient_scheme(*args, **kwargs)Sets gradient options.
heterogeneous_stiff_chemistry(*args, **kwargs)Sets the heterogeneous stiff-chemistry solver.
limiter_warnings(*args, **kwargs)Specifies whether or not to print warning messages when quantities are being limited.
limits(*args, **kwargs)Sets solver limits for various solution variables, in order to improve the stability of the solution.
lock_solid_temperature(*args, **kwargs)Specifies whether you want to lock (or “freeze”) the temperature values for all the cells in solid zones (including those to which you have a hooked an energy source through a UDF) and in walls that have shell conduction enabled, so that the values do not change during further solver iterations.
material_property_warnings(*args, **kwargs)Control the display of material property warning diagnostics: 0 - off (no messages) 1 - messages per material 2 - messages per material and per property.
max_corrections(*args, **kwargs)Enters the max-corrections menu.
moving_mesh_numerics(*args, **kwargs)Transient options for sliding, moving, and/or dynamic mesh.
mp_mfluid_aniso_drag(*args, **kwargs)Sets anisotropic drag parameters for the Eulerian multiphase model.
mp_reference_density(*args, **kwargs)Sets the reference density method for the Eulerian multiphase model.
multi_grid_amg(*args, **kwargs)Sets the parameters that govern the algebraic multigrid procedure.
multi_grid_controls(*args, **kwargs)Sets multigrid parameters and termination criteria.
multi_grid_fas(*args, **kwargs)Sets the parameters that control the FAS multigrid solver.
multi_stage(*args, **kwargs)Sets the multi-stage coefficients and the dissipation and viscous evaluation stages.
nb_gradient_boundary_option(*args, **kwargs)Switches between the modified treatment of node-based gradients at boundary cells and the legacy treatment (R14.5.7 and earlier).
number_of_iterations(*args, **kwargs)Sets the number of iterations for a steady-state simulation without starting the calculation.
numerical_beach_controls(*args, **kwargs)Sets damping function in flow direction.
numerics(*args, **kwargs)Sets numerics options.
open_channel_controls(*args, **kwargs)For flows that do not transition from sub-critical to super-critical, or vice-versa, you can speed-up the solution calculation by updating the frequency of Froude number during run time.
p_v_controls(*args, **kwargs)Sets pressure-velocity controls.
p_v_controls_advanced(*args, **kwargs)Set advanced pressure-velocity coupling controls.
p_v_coupling(*args, **kwargs)Selects which pressure-velocity coupling scheme is to be used.
phase_based_vof_discretization(*args, **kwargs)Sets phase based slope limiter for VOF compressive scheme.
reactions(*args, **kwargs)Enables the species reaction sources and sets relaxation factor.
reduced_rank_extrapolation(*args, **kwargs)Enable Reduced Rank Extrapolation method to accelerate solution time.
reduced_rank_extrapolation_options(*args, ...)Reduced Rank Extrapolation options.
relaxation_factor(*args, **kwargs)Enters the relaxation-factor menu.
relaxation_method(*args, **kwargs)Sets the solver relaxation method.
reporting_interval(*args, **kwargs)Sets the number of iterations for which convergence monitors are reported.
residual_smoothing(*args, **kwargs)Sets the implicit residual smoothing parameters.
residual_tolerance(*args, **kwargs)Enters the residual tolerance menu.
residual_verbosity(*args, **kwargs)Sets the amount of residual information to be printed.
second_order_time_options(*args, **kwargs)Enables / disables the variable time step size formulation for second-order implicit transient formulations.
set_all_species_together(*args, **kwargs)Sets all species discretizations and URFs together.
set_controls_to_default(*args, **kwargs)Sets controls to default values.
set_solution_methods_to_default(*args, **kwargs)Sets the solution methods to the default settings.
set_solution_steering(*args, **kwargs)Sets solution steering parameters.
slope_limiter_set(*args, **kwargs)Selects a new Fluent solver slope limiter.
solution_steering(*args, **kwargs)Enables solution steering for the density-based solver.
stiff_chemistry(*args, **kwargs)Sets solver options for stiff chemistry solutions.
surface_tension(*args, **kwargs)Sets surface-tension calculation options.
surface_tension_expert(*args, **kwargs)Set surface-tension expert options.
time_step(*args, **kwargs)Set the time step.
under_relaxation(*args, **kwargs)Enters the under-relaxation menu, which allows you to set the under-relaxation factor for each equation that is being solved in a segregated manner.
variable_time_stepping(*args, **kwargs)Set Multiphase-Specific Adaptive time stepping parameters.
vof_explicit_controls(*args, **kwargs)Sets the sub time step calculation method for VOF calculations.
vof_numerics(*args, **kwargs)Sets VOF numeric options.
Classes:
acoustics_wave_equation_controls(path, service)Enters the menu to specify parameters of the acoustics wave equation solver.
advanced(path, service)Enters the advanced settings menu.
amg_options(path, service)Enters the AMG options menu.
contact_solution_controls(path, service)Solver controls for contact marks method.
data_sampling_options(path, service)Enter the menu for specifying quantities and zones for steady and unsteady flow statistics.
divergence_prevention(path, service)Enters the divergence prevention menu.
enhanced_les_numerics(path, service)Enter enhanced LES options menu.
fast_transient_settings(path, service)Enters the fast transient settings menu.
high_order_term_relaxation(path, service)Enter High Order Relaxation Menu.
high_speed_numerics(path, service)Enter high-speed-numerics menu.
multiphase_numerics(path, service)Sets multiphase numerics options.
nita_expert_controls(path, service)Enters the NITA expert control menu.
open_channel_wave_options(path, service)Sets buffer layer height, verbosity, and open channel wave theory formulation.
overset(path, service)Specifies overset meshing solver options.
poor_mesh_numerics(path, service)Enters the poor mesh numerics menu.
previous_defaults(path, service)Provides text commands that allow you to undo enhancements to the default solver behavior.
pseudo_time_method(path, service)Enters the pseudo time method menu.
transient_controls(path, service)Enters the transient controls menu, which allows you to define settings related to time advancement for transient flow calculations.
warped_face_gradient_correction(path, service)Enters the warped-face gradient correction menu.
Enables a modified NITA scheme and other setting changes that can speed up the simulation. This option is only available with the Large Eddy Simulation (LES) turbulence model, and is intended for unreacting flow simulations that use a constant-density fluid.
Bases:
TUIMenuEnters the menu to specify parameters of the acoustics wave equation solver.
Classes:
expert(path, service)Enters the menu to specify the expert parameters.
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.
Bases:
TUIMenuEnters the menu to specify the expert parameters.
Methods:
explicit_relaxation_factor(*args, **kwargs)Specifies the explicit relaxation factor.
under_relaxation_factor(*args, **kwargs)Specifies the implicit under-relaxation factor.
Specifies the explicit relaxation factor. Should be used only with bad meshes, when iterations do not converge.
Specifies the implicit under-relaxation factor. Should be used only with bad meshes, when the AMG linear solver does not converge.
Specify maximum number of iterations per timestep.
Specify convergence tolerance for the timestep iterations as the target residual reduction factor.
Set Error-based adaptive time-stepping parameters.
Bases:
TUIMenuEnters the advanced settings menu.
Methods:
alternate_wall_temp_formulation(*args, **kwargs)Enables/disables an alternate formulation for wall temperatures.
anisotropic_solid_heat_transfer(*args, **kwargs)Set up the heat transfer for anisotropic solid zones.
bcd_boundedness(*args, **kwargs)Specifies the BCD scheme parameter, which controls the boundedness strength of the BCD scheme in the pressure-based solver, as described in .
bcd_weights_freeze(*args, **kwargs)Enables/disables freezing of weighting coefficients of the central differencing and the upwind components of the BCD scheme.
correction_form(*args, **kwargs)energy_numerical_noise_filter(*args, **kwargs)Enables/disables a filter to eliminate non-physical numerical noise in the energy field.
Enable limiting of reconstruction gradient for the energy equation.
explicit_under_relaxation_value(*args, **kwargs)Explicit under-relaxation value.
linearized_mass_transfer_udf(*args, **kwargs)Enables/disables the use of a linearized mass transfer user-defined function (that is, the DEFINE_LINEARIZED_MASS_TRANSFER macro), as opposed to a mass transfer user-defined function (that is, the DEFINE_MASS_TRANSFER macro).
retain_cell_residuals(*args, **kwargs)Enables/disables the retention of cell residuals for postprocessing.
retain_temporary_solver_mem(*args, **kwargs)Enables/disables the retention of temporary solver memory, which retains gradient data and makes some advanced options available for postprocessing.
show_all_discretization_schemes(*args, **kwargs)Enables/disables the availability of all applicable discretization schemes.
singhal_et_al_cavitation_model(*args, **kwargs)Enables/disables the availability of the Singhal et al. cavitation model option, which can then be enabled in the Multiphase Model dialog box or by using the following text command: define/phases/set-domain-properties/interaction-domain/heat-mass-reaction/cavitation/cavitation?.
skewness_correction_enhanced(*args, **kwargs)Enable enhanced skewness correction scheme.
Classes:
non_reflecting_boundary_treatment(path, service)Enter non reflecting boundary treatment using minimal pressure reflection approach menu.
secondary_gradient_limiting(path, service)Enters the secondary gradient limiting menu.
turbomachinery_specific_numerics(path, service)Enter turbomachinery specific numerics menu.
Enables/disables an alternate formulation for wall temperatures.
Set up the heat transfer for anisotropic solid zones.
Specifies the BCD scheme parameter, which controls the boundedness strength of the BCD scheme in the pressure-based solver, as described in .
Enables/disables freezing of weighting coefficients of the central differencing and the upwind components of the BCD scheme. This dialog command requires the iteration number, after which the BCD scheme weights are to be frozen at each timestep. Freezing the BCD weighting coefficients may help to improve convergence of the timestep iterations as described in .
Enables/disables a filter to eliminate non-physical numerical noise in the energy field. Numerical noise can appear in solution fields where large variations in specific heat or combustion with phase change are present. Using the energy equation numerical noise filter increases robustness, but may make the solution slightly more diffusive. This text command is only available with the pressure-based solver.
Enable limiting of reconstruction gradient for the energy equation.
Explicit under-relaxation value.
Enables/disables the use of a linearized mass transfer user-defined function (that is, the DEFINE_LINEARIZED_MASS_TRANSFER macro), as opposed to a mass transfer user-defined function (that is, the DEFINE_MASS_TRANSFER macro).
Bases:
TUIMenuEnter 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.
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.
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.
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.
Enables/disables the retention of cell residuals for postprocessing.
Enables/disables the retention of temporary solver memory, which retains gradient data and makes some advanced options available for postprocessing.
Bases:
TUIMenuEnters the secondary gradient limiting menu. This menu is only available when the define/models/solver/pressure-based text command is enabled.
Methods:
energy(*args, **kwargs)Enables/disables secondary gradient limiting for the energy calculations on coupled two-sided walls.
mesh_quality_limits(*args, **kwargs)Defines the mesh quality limits used when applying secondary gradient limiting to faces on coupled two-sided walls.
uds(*args, **kwargs)Enables/disables secondary gradient limiting for the user-defined scalar (UDS) calculations on coupled two-sided walls.
Enables/disables secondary gradient limiting for the energy calculations on coupled two-sided walls. This limiting can help prevent divergence when the cells on such walls have poor orthogonality.
Defines the mesh quality limits used when applying secondary gradient limiting to faces on coupled two-sided walls. Shifting this range closer to 1 will decrease the risk of divergence, but at the cost of accuracy.
Enables/disables secondary gradient limiting for the user-defined scalar (UDS) calculations on coupled two-sided walls. This limiting can help prevent divergence when the cells on such walls have poor orthogonality.
Enables/disables the availability of all applicable discretization schemes.
Enables/disables the availability of the Singhal et al. cavitation model option, which can then be enabled in the Multiphase Model dialog box or by using the following text command: define/phases/set-domain-properties/interaction-domain/heat-mass-reaction/cavitation/cavitation?.
Enable enhanced skewness correction scheme.
Bases:
TUIMenuEnter turbomachinery specific numerics menu.
Methods:
enable(*args, **kwargs)Activate/deactivate turbomachinery specific numerics.
settings(*args, **kwargs)Adjust settings for turbomachinery specific numerics.
Activate/deactivate turbomachinery specific numerics.
Adjust settings for turbomachinery specific numerics.
Bases:
TUIMenuEnters the AMG options menu.
Methods:
aggressive_amg_coarsening(*args, **kwargs)Enables / disables the use of a version of the AMG solver that is optimized for high coarsening rates.
amg_gpgpu_options(*args, **kwargs)Set GPGPU AMG solver options.
conservative_amg_coarsening(*args, **kwargs)Enables / disables the use of conservative coarsening techniques for scalar and/or coupled equations that can improve parallel performance and/or convergence for some difficult cases.
laplace_coarsening(*args, **kwargs)Enables / disables Laplace coarsening for scalar and/or coupled equations.
Enables / disables the use of a version of the AMG solver that is optimized for high coarsening rates. This option is recommended if the AMG solver diverges with the default settings.
Set GPGPU AMG solver options.
Enables / disables the use of conservative coarsening techniques for scalar and/or coupled equations that can improve parallel performance and/or convergence for some difficult cases.
Enables / disables Laplace coarsening for scalar and/or coupled equations.
Sets pressure extrapolations schemes on boundaries.
Set CFL-based adaptive time-stepping parameters.
Bases:
TUIMenuSolver 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.
Bases:
TUIMenuAMG 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.
Specify AMG coarsening rate.
Enforce the use of laplace coarsening in AMG.
Allow increase in AMG pre-sweep.
Specify the number of AMG pre-sweeps.
Modify AMG coarsening rate.
Bases:
TUIMenuMethods 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.
Modify gradient method for solver stability and accuracy.
Enable pressure-velocity coupling method change for solver stability and accuracy.
Specify pressure-velocity coupling method change for solver stability and accuracy.
Specify gradient method for solver stability and accuracy.
Bases:
TUIMenuMiscellaneous.
Methods:
compute_statistics(*args, **kwargs)Compute solution statistics for contact updates.
statistics_level(*args, **kwargs)Solution statistics level for contact updates.
Compute solution statistics for contact updates.
Solution statistics level for contact updates.
Bases:
TUIMenuModel 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.
Activate model ramping for solver stability and accuracy.
Ramp flow for solver stability and accuracy.
Ramp all scalar transport equations for solver stability and accuracy.
Ramp turbulence for solver stability and accuracy.
Bases:
TUIMenuParameters 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].
Solution extrapolation method for cells changing status from contact to non-contact [0-none, 1-local extrapolation].
Specify additional iterations to accomodate contact solution stabilization.
Specify fixed time for solution stabilization persistence after trigger.
Specify fixed time-steps for solution stabilization persistence after trigger.
Persistence of the solution stabilization based on events [0-contact based, 1-always on].
Set contact solution stabilization to default.
Automatic solver settings adjustment for solution stabilization during contact process.
Bases:
TUIMenuSpatial 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.
Set factor to control first order to second order blending.
List set factor to control first order to second order blending.
Exclude skew diffusion discretization contribution for momentum.
Allow specification of the the rhie-chow flux method.
Enter the rhie-chow flux method.
Exclude skew diffusion discretization contribution for scalars.
Set advection scheme for contact event stability.
Bases:
TUIMenuTransient 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.
Specify time-scale modification factor.
Enter time scale modification method.
Allow transient parameter specification.
Specify temporal scheme to be used.
Specify verbosity level for contact solution controls.
Enables convergence acceleration for stretched meshes to improve the convergence of the implicit density based solver on meshes with high cell stretching.
Enters the correction tolerance menu.
Sets the fine-grid Courant number (time step factor). This command is available only for the coupled solvers.
Enables data sampling for steady or unsteady flow statistics.
Bases:
TUIMenuEnter the menu for specifying quantities and zones for steady and unsteady flow statistics.
Methods:
add_datasets(*args, **kwargs)Add a dataset.
add_rtdft_datasets(*args, **kwargs)Specify zone and quantity combinations for sampling Fourier coefficients of unsteady flows.
list_datasets(*args, **kwargs)Lists the combinations of zones and quantities that are defined for sampling steady and unsteady flow statistics.
remove_dataset(*args, **kwargs)Remove dataset.
Classes:
dft_datasets(path, service)Data sampling options for runtime discrete Fourier transform.
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.
Specify zone and quantity combinations for sampling Fourier coefficients of unsteady flows.
Bases:
TUIMenuData 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 DFT datasets.
Specify, whether a new dataset is for DFT in a frequency band resolved by many harmonics or for a single tone.
Specify the minimum and the maximum frequency for a band.
Specify either the band resolution or the sampling timesteps number. The other value will be computed consistently.
Specify single tone frequency and sampling duration as the number of tone periods.
Select quantities for a new DFT dataset. Enter () to complete the quantity selection.
Select zones for a new DFT dataset.
Lists the combinations of zones and quantities that are defined for sampling steady and unsteady flow statistics.
Remove dataset.
Completely disables reconstruction, resulting in totally first-order accuracy.
Enters the discretization scheme menu. This allows you to select the discretization scheme for the convection terms in the solution equations. The following text commands can make a selection from a subset of the models in the following table:.
Bases:
TUIMenuEnters the divergence prevention menu. This menu is only available for the density-based solver.
Methods:
enable(*args, **kwargs)Enables a divergence prevention option so that Fluent applies under-relaxation to the variables in select cells where the temperature and/or pressure values are approaching the minimum and/or maximum limits.
Enables a divergence prevention option so that Fluent applies under-relaxation to the variables in select cells where the temperature and/or pressure values are approaching the minimum and/or maximum limits.
Controls whether the output field variabledp-dt will be available for transient simulation postprocessing. If you select no, pressure fields at the previous time steps will not be stored in memory which reduces memory usage.
Bases:
TUIMenuEnter enhanced LES options menu.
Methods:
optimized_advection(*args, **kwargs)Use advection scheme optimized for LES.
optimized_algorithm(*args, **kwargs)Use solver algorithm optimized for LES.
optimized_cd(*args, **kwargs)Use optimized central difference discretization.
Use advection scheme optimized for LES.
Use solver algorithm optimized for LES.
Use optimized central difference discretization.
Sets the order in which the model equations are solved, which can affect the convergence speed when you are using the pressure-based solver. The standard method is enabled by default and corresponds to the ordering shown in and in the Theory Guide; alternatively, you can select theoptimized-for-volumetric-expansion method, which is recommended for flows in which the density is strongly dependent on thermal effects, chemical composition, and so on (such as combustion simulations). This text command is not available for steady simulations and/or when a multiphase model is enabled.
Selects the equations to be solved.
Sets expert options.
Bases:
TUIMenuEnters the fast transient settings menu. This menu is only available for transient cases that use the density-based solver.
Methods:
rk2(*args, **kwargs)Allows you to enable the use of a two-stage Runge-Kutta scheme for time integration, or revert to the default multi-stage Runge-Kutta scheme.
Allows you to enable the use of a two-stage Runge-Kutta scheme for time integration, or revert to the default multi-stage Runge-Kutta scheme. This text command is only available for transient cases that use the density-based explicit formulation.
Specifies whether or not to print warning messages when reversed flow occurs at inlets and outlets, and when mass-flow inlets develop supersonic regions. By default, flow warnings are printed.
Enter the flux type.
Sets gradient options.
Sets the heterogeneous stiff-chemistry solver.
Bases:
TUIMenuEnter High Order Relaxation Menu.
Methods:
enable(*args, **kwargs)Enables/disables High Order Term Relaxation.
Classes:
options(path, service)High Order Term Relaxation Options.
Enables/disables High Order Term Relaxation.
Bases:
TUIMenuHigh Order Term Relaxation Options.
Methods:
expert(*args, **kwargs)Enter high order relaxation option with respect to diffusion gradient.
relaxation_factor(*args, **kwargs)Sets the relaxation factor.
Classes:
variables(path, service)Selects the variables.
Enter high order relaxation option with respect to diffusion gradient.
Sets the relaxation factor.
Bases:
TUIMenuSelects the variables.
Methods:
select(*args, **kwargs)Select variables for high order term relaxation.
Select variables for high order term relaxation.
Bases:
TUIMenuEnter high-speed-numerics menu.
Methods:
enable(*args, **kwargs)Enables/disables High Speed Numerics.
expert(*args, **kwargs)Sets the level of stabilization used to achieve fast convergence.
Makes available the Pressure Discontinuity Sensor which is a binary identifier equal to 1 if a cell is in proximity of a pressure discontinuity.
Enables/disables High Speed Numerics.
Sets the level of stabilization used to achieve fast convergence. Enter a number 0-5 corresponding to the Mach number range that best characterizes the flow.
Makes available the Pressure Discontinuity Sensor which is a binary identifier equal to 1 if a cell is in proximity of a pressure discontinuity.
Specifies whether or not to print warning messages when quantities are being limited. By default, limiter warnings are printed.
Sets solver limits for various solution variables, in order to improve the stability of the solution.
Specifies whether you want to lock (or “freeze”) the temperature values for all the cells in solid zones (including those to which you have a hooked an energy source through a UDF) and in walls that have shell conduction enabled, so that the values do not change during further solver iterations.
Control the display of material property warning diagnostics: 0 - off (no messages) 1 - messages per material 2 - messages per material and per property.
Enters the max-corrections menu.
Transient options for sliding, moving, and/or dynamic mesh.
Sets anisotropic drag parameters for the Eulerian multiphase model.
Sets the reference density method for the Eulerian multiphase model. The following options are available: 0 (default): Averaged density of the phase 1: Cell density of the phase 1: Constant value of 1 1: Cell density of the phase See for more information.
Sets the parameters that govern the algebraic multigrid procedure.
Sets multigrid parameters and termination criteria.
Sets the parameters that control the FAS multigrid solver. This command appears only when the explicit coupled solver is used.
Sets the multi-stage coefficients and the dissipation and viscous evaluation stages. This command appears only when the explicit coupled solver is used.
Bases:
TUIMenuSets multiphase numerics options.
Classes:
advanced_stability_controls(path, service)Enters the menu for the stability controls for multiphase flows.
boiling_parameters(path, service)Enters the menu for the multiphase boiling model parameters.
compressible_flow(path, service)Enters the compressible multiphase flow numerics menu.
default_controls(path, service)Enters the default controls menu.
face_pressure_controls(path, service)Enter the face pressure expert controls menu.
heat_mass_transfer(path, service)Enters the menu for the multiphase heat mass transfer parameters.
porous_media(path, service)Enters the porous media numerics menu.
solution_stabilization(path, service)Enters the solution-stabilization numerics menu.
viscous_flow(path, service)Enters the viscous multiphase flow numerics menu.
Bases:
TUIMenuEnters the menu for the stability controls for multiphase flows. For more information about the below option, see and .
Classes:
anti_diffusion(path, service)Enters the anti-diffusion menu.
equation_order(path, service)Enters the equation order menu for homogeneous multiphase flow models.
hybrid_nita(path, service)Enters the equation order menu for homogeneous multiphase flow models.
num_ventilation(path, service)Numerical Ventilation Menu for VOF Model.
p_v_coupling(path, service)Enters the menu for the pressure-velocity coupling controls.
pseudo_time(path, service)Pseudo-Time stability controls for multiphase flow.
Bases:
TUIMenuEnters the anti-diffusion menu. This item is available for VOF cases with the Interfacial Anti-Diffusion option enabled.
Methods:
enable_dynamic_strength(*args, **kwargs)Enables dynamic strength to reduce compression in the direction tangential to the interface.
set_dynamic_strength_exponent(*args, **kwargs)Sets the cosine exponent in the dynamic strength treatment in ).
set_maximum_dynamic_strength(*args, **kwargs)Sets the maximum value of dynamic anti-diffusion strength in ).
Enables dynamic strength to reduce compression in the direction tangential to the interface.
Sets the cosine exponent in the dynamic strength treatment in ).
Sets the maximum value of dynamic anti-diffusion strength in ).
Bases:
TUIMenuEnters the 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)When enabled, solves the flow equation at the end of the iteration.
Solve Explicit VOF at the end of time-step as an alternative.
When enabled, solves the flow equation at the end of the iteration. This improves the behavior at the start of new time-step if the solution does not converge properly.
Bases:
TUIMenuEnters the equation order menu for homogeneous multiphase flow models.
Methods:
initial_outer_iterations(*args, **kwargs)Allows you to change the number of initial time-steps and the number of initial outer iterations to control solution stability.
outer_iterations(*args, **kwargs)Sets the number of outer iterations.
Classes:
instability_detector(path, service)Enters the menu for the instability detector controls.
Allows you to change the number of initial time-steps and the number of initial outer iterations to control solution stability.
Bases:
TUIMenuEnters the menu for the instability detector controls.
Methods:
enable_instability_detector(*args, **kwargs)Enables/disables the instability detector to deal with possible instability problems.
set_cfl_limit(*args, **kwargs)Sets the Courant number limit for detecting unstable events.
set_cfl_type(*args, **kwargs)Selects the CFL number type for detection of an unstable event.
set_velocity_limit(*args, **kwargs)Sets the velocity limit for detecting unstable events.
unstable_event_outer_iterations(*args, **kwargs)Sets the number of outer iterations for an unstable event.
Enables/disables the instability detector to deal with possible instability problems. Once this option is enabled, additional instability detection options become available.
Sets the Courant number limit for detecting unstable events. This command becomes available once the enable-instability-detector? text option has been enabled.
Selects the CFL number type for detection of an unstable event. This command becomes available once the enable-instability-detector? text option has been enabled.
Sets the velocity limit for detecting unstable events. This command becomes available once the enable-instability-detector? text option has been enabled.
Sets the number of outer iterations for an unstable event.
Sets the number of outer iterations.
Bases:
TUIMenuNumerical 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 numerical ventilation treatment to remove trapped phase adjacent to wall.
Set near wall treatment options.
Set time step size option for numerical ventilation treatment.
Set trapped phase maximum volume fraction to activate numerical ventilation treatment for non-trapped phases.
Set trapped phase minimum volume fraction to activate numerical ventilation treatment for trapped phase.
Bases:
TUIMenuEnters the menu for the pressure-velocity coupling controls.
Classes:
coupled_vof(path, service)Enters the stability control menu for VOF cases that involve the Coupled pressure-velocity coupling scheme.
rhie_chow_flux(path, service)Enters the stability controls menu for the Rhie-Chow interpolation.
skewness_correction(path, service)Enters the skewness correction menu.
Bases:
TUIMenuEnters the stability control menu for VOF cases that involve the Coupled pressure-velocity coupling scheme.
Methods:
buoyancy_force_linearization(*args, **kwargs)Allows you to use the linearized buoyancy force and the blended treatment for the buoyancy force.
Allows you to use the linearized buoyancy force and the blended treatment for the buoyancy force.
Bases:
TUIMenuEnters the stability controls menu for the Rhie-Chow interpolation.
Methods:
low_order_rhie_chow(*args, **kwargs)Enables/disables the low-order velocity interpolation in the flux calculation.
Enables/disables the low-order velocity interpolation in the flux calculation.
Bases:
TUIMenuEnters the skewness correction menu.
Methods:
limit_pressure_correction_gradient(*args, ...)Enables/disables the limited pressure correction gradient in skewness terms for the PISO, SIMPLEC, or fractional step pressure-coupling schemes.
Enables/disables the limited pressure correction gradient in skewness terms for the PISO, SIMPLEC, or fractional step pressure-coupling schemes.
Bases:
TUIMenuPseudo-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.
Bases:
TUIMenuSet 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.
Set maximum limit for increase in pseudo time step size.
Set minimum limit for reduction in pseudo time step size.
Set maximum value for pseudo time step size during first iteration.
Set maximum value for pseudo time step size.
Enable advanced automatic time stepping for better stability.
Set velocity ratio to freeze the time step size for better solution stability.
Set false time-step linearization for added stability.
Set smoothed density stabilization method.
Bases:
TUIMenuEnters the menu for the multiphase boiling model parameters.
Methods:
liquid_vof_factor(*args, **kwargs)When enabled, considers liquid volume fraction effects by multiplying the heat transfer coefficients by the local liquid volume fraction.
thin_film(*args, **kwargs)When enabled, includes multiphase boiling thin film effects using .
When enabled, considers liquid volume fraction effects by multiplying the heat transfer coefficients by the local liquid volume fraction.
When enabled, includes multiphase boiling thin film effects using .
Bases:
TUIMenuEnters the compressible multiphase flow numerics menu.
Methods:
alternate_bc_formulation(*args, **kwargs)Enables an alternative formulation for compressible phases at an inlet boundary.
enhanced_numerics(*args, **kwargs)Enables an enhanced numerical treatment that provides better stability at startup and during calculation of compressible flows.
Enables an alternative formulation for compressible phases at an inlet boundary. This formulation calculates static temperature and pressure using an iterative method based on fundamental thermodynamic relations.
Enables an enhanced numerical treatment that provides better stability at startup and during calculation of compressible flows.
Bases:
TUIMenuEnters the default controls menu. This menu is available only for multiphase flows.
Methods:
Applies the multiphase defaults (version 2020 R1) to the loaded case file.
Revert to pre-R20.1 multiphase flow default settings.
Applies the multiphase defaults (version 2020 R1) to the loaded case file.
Revert to pre-R20.1 multiphase flow default settings.
Bases:
TUIMenuEnter the face pressure expert controls menu.
Methods:
face_pressure_options(*args, **kwargs)Set face pressure options.
Set face pressure options.
Bases:
TUIMenuEnters the menu for the multiphase heat mass transfer parameters.
Methods:
alternative_energy_treatment(*args, **kwargs)Enables the alternative treatment of the energy sources.
Classes:
area_density(path, service)Enters the menu for the area density.
boiling(path, service)Enters the menu for the advanced boiling options for the semi-mechanistic boiling model.
cavitation(path, service)Enters the cavitation heat mass transfer menu.
evaporation_condensation(path, service)Evaporation-condensation advanced options menu.
Enables the alternative treatment of the energy sources. For more information, see .
Bases:
TUIMenuEnters the menu for the area density.
Methods:
ia_grad_sym(*args, **kwargs)Enables/disables the interfacial area density Gradient-Symmetric model.
vof_min_seeding(*args, **kwargs)Sets the minimum volume fraction for the area density and cavitation.
Enables/disables the interfacial area density Gradient-Symmetric model. For more information about this model, see .
Sets the minimum volume fraction for the area density and cavitation. This may be useful, for example, in cases when a species mass transfer model (such as the Symmetric model or Particle model) do not consider evaporation or condensation if the volume fraction of one of the phases is zero. The seeding allows for a phase change to occur in the fluid flow. The default value is 1e-6.
Bases:
TUIMenuEnters the menu for the advanced boiling options for the semi-mechanistic boiling model.
Methods:
heat_flux_relaxation_factor(*args, **kwargs)Sets the under-relaxation factor for boiling heat flux.
show_expert_options(*args, **kwargs)Exposes the expert options for the semi-mechanistic boiling model.
two_resistance_boiling_framework(*args, **kwargs)Enables/disables the two-resistance boiling framework to improve the robustness and accuracy of the solution of cases with multiple boiling mechanisms.
Sets the under-relaxation factor for boiling heat flux. See for details.
Exposes the expert options for the semi-mechanistic boiling model. For more information about these options, see .
Enables/disables the two-resistance boiling framework to improve the robustness and accuracy of the solution of cases with multiple boiling mechanisms. For more information about this item, see .
Bases:
TUIMenuEnters the cavitation heat mass transfer menu.
Methods:
display_clipped_pressure(*args, **kwargs)Clipped pressure is just used for the properties evaluation.
max_vapor_pressure_ratio(*args, **kwargs)Sets the maximum limit on the vapor pressure after the turbulence and thermal correction.
min_vapor_pressure(*args, **kwargs)Sets the minimum vapor pressure limit for the cavitation mass-transfer model.
schnerr_cond_coeff(*args, **kwargs)Sets the condensation coefficient for the Schnerr-Sauer model ( in ).
schnerr_evap_coeff(*args, **kwargs)Sets the evaporation coefficient for the Schnerr-Sauer model ( in ).
turbulent_diffusion(*args, **kwargs)Enables/disables the turbulent diffusion treatment for a cavitating turbulent flow.
Clipped pressure is just used for the properties evaluation. Mass Transfer Rate uses unclipped pressure.
Sets the maximum limit on the vapor pressure after the turbulence and thermal correction. The default value is five times the vapor pressure, with consideration of turbulent and thermal effects for each cell and phase.
Sets the minimum vapor pressure limit for the cavitation mass-transfer model. The default value is 1 Pa.
Sets the condensation coefficient for the Schnerr-Sauer model ( in ). The default and recommended value of 0.2.
Sets the evaporation coefficient for the Schnerr-Sauer model ( in ). The default and recommended value of 1.
Enables/disables the turbulent diffusion treatment for a cavitating turbulent flow. See for details.
Bases:
TUIMenuEvaporation-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.
Minimum normalized area density below which mass transfer rate is set to zero.
Maximum value of relative humidity to limit condensation rate.
Maximum volume fraction above which mass transfer rate is set to zero.
Minimum volume fraction below which mass transfer rate is set to zero.
Maximum volume fraction above which mass transfer rate is set to zero.
Minimum volume fraction below which mass transfer rate is set to zero.
Bases:
TUIMenuEnters the porous media numerics menu.
Methods:
capillary_pressure_as_diffusion(*args, **kwargs)Model capillary pressure as diffusion.
relative_permeability(*args, **kwargs)Allows you to fix the saturation (volume fraction) of the phase at its user-specified residual saturation value.
Model capillary pressure as diffusion.
Allows you to fix the saturation (volume fraction) of the phase at its user-specified residual saturation value.
Bases:
TUIMenuEnters the solution-stabilization numerics menu. This item is available only for the VOF model.
Classes:
additional_stabilization_controls(path, service)Enters the menu for additional advanced stability controls.
velocity_limiting_treatment(path, service)Enters the menu for the velocity-limiting-treatment.
Methods:
execute_additional_stability_controls(*args, ...)When enabled, uses additional controls for improved solution stability.
execute_advanced_stabilization(*args, **kwargs)When enabled, modifies solver settings for improved solution stability.
execute_settings_optimization(*args, **kwargs)Execute optimized settings for VOF.
Bases:
TUIMenuEnters the menu for additional advanced stability controls.
Methods:
blended_compressive_scheme(*args, **kwargs)Enables/disables the blended compressive discretization scheme.
pseudo_time_stabilization(*args, **kwargs)Pseudo-Time Momentum stabilization and False Time Step Linearization methods for VOF.
Enables/disables the blended compressive discretization scheme.
Pseudo-Time Momentum stabilization and False Time Step Linearization methods for VOF.
When enabled, uses additional controls for improved solution stability.
When enabled, modifies solver settings for improved solution stability.
Execute optimized settings for VOF.
Bases:
TUIMenuEnters the menu for the velocity-limiting-treatment.
Methods:
enable_velocity_limiting(*args, **kwargs)Enables/disables the 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)Specifies the maximum velocity magnitude.
verbosity(*args, **kwargs)When enabled, the solver prints the number of velocity limited cells at each iteration.
Enables/disables the velocity limiting treatment.
Enter damping strength.
Set phase based damping strength.
Set phase based velocity limiting controls.
Specifies the maximum velocity magnitude.
When enabled, the solver prints the number of velocity limited cells at each iteration.
Bases:
TUIMenuEnters the viscous multiphase flow numerics 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)Forces harmonic averaging of cell viscosities to calculate face viscosity used in momentum equation.
Interfacial artifical viscosity controls.
Turbulence viscosity based damping controls.
Forces harmonic averaging of cell viscosities to calculate face viscosity used in momentum equation. This can improve convergence for highly viscous flow applications (the VOF model only).
Switches between the modified treatment of node-based gradients at boundary cells and the legacy treatment (R14.5.7 and earlier). If using the density-based solver, you can also specify the extended treatment. For details, see .
Bases:
TUIMenuEnters the NITA expert control menu.
Methods:
hybrid_nita_settings(*args, **kwargs)Enables and sets hybrid NITA options.
set_verbosity(*args, **kwargs)Setting this to 1, enables the verbosity for NITA diagnostics.
skewness_neighbor_coupling(*args, **kwargs)Enables/disables coupling of the neighbor and skewness corrections.
Enables and sets hybrid NITA options. For more details, see .
Setting this to 1, enables the verbosity for NITA diagnostics. The default value of 0 disables verbosity output for NITA diagnostics.
Enables/disables coupling of the neighbor and skewness corrections.
Sets the number of iterations for a steady-state simulation without starting the calculation.
Sets damping function in flow direction. This command appears only when the VOF model is enabled. Select the damping function to be used: Index Damping Function 0 Linear 1 Quadratic 2 Cubic 3 Cosine.
Sets numerics options.
For flows that do not transition from sub-critical to super-critical, or vice-versa, you can speed-up the solution calculation by updating the frequency of Froude number during run time.
Bases:
TUIMenuSets buffer layer height, verbosity, and open channel wave theory formulation.
Methods:
set_buffer_layer_ht(*args, **kwargs)Sets the buffer layer height.
set_verbosity(*args, **kwargs)Sets the open channel wave verbosity.
stokes_wave_variants(*args, **kwargs)Specifies which open channel wave theory formulation Fluent uses.
Sets the buffer layer height.
Sets the open channel wave verbosity.
Specifies which open channel wave theory formulation Fluent uses.
Bases:
TUIMenuSpecifies overset meshing solver options.
Classes:
expert(path, service)Enter overset expert solver options menu.
Methods:
high_order_pressure(*args, **kwargs)Uses the pressure gradient of the donor cell in the interpolation of pressure for its receptor cell.
interpolation_method(*args, **kwargs)Selects the interpolation method for overset interfaces.
orphan_cell_treatment(*args, **kwargs)Enables/disables a numerical treatment that attempts to assign reasonable data values to orphan cells.
Bases:
TUIMenuEnter 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.
Mode for hybrid interpolation.
Enter mass flux correction option at overset interfaces.
Uses the pressure gradient of the donor cell in the interpolation of pressure for its receptor cell.
Selects the interpolation method for overset interfaces. Note that the least squares method is recommended for sliding mesh cases.
Enables/disables a numerical treatment that attempts to assign reasonable data values to orphan cells.
Sets pressure-velocity controls.
Set advanced pressure-velocity coupling controls.
Selects which pressure-velocity coupling scheme is to be used. Five schemes are available:.
Sets phase based slope limiter for VOF compressive scheme.
Bases:
TUIMenuEnters the poor mesh numerics menu.
Methods:
cell_quality_based(*args, **kwargs)Enables/disables the application of poor mesh numerics on cells with an orthogonal quality that is equal to or less than the threshold defined by the solve/set/poor-mesh-numerics/set-quality-threshold text command (which by default is set to 0.05).
enable(*args, **kwargs)Enables/disables the application of poor mesh numerics on cells (those with an orthogonal quality of 0, as well as those identified by other enabled criteria), and defines whether the local solution correction is 0th, 1st, or 2nd order.
enhanced_pmn(*args, **kwargs)This option is available with the density-based solver.
gradient_quality_based(*args, **kwargs)Enables/disables the detection and treatment of poor cells using a criterion based on the cell gradient quality.
Enables/disables the relocation of select cell centroids, to improve the orthogonality metrics and solution stability.
print_poor_elements_count(*args, **kwargs)Prints out a listing of the poor cells for each criterion: default, cell quality, and user-defined, and (if enabled) cell gradient quality and solution and cell quality.
reset_poor_elements(*args, **kwargs)Resets the list of poor cells included by the default, cell quality, user-defined, cell gradient quality, and solution and cell quality criteria.
set_quality_threshold(*args, **kwargs)Sets the orthogonal quality threshold used for applying poor mesh numerics when the solve/set/poor-mesh-numerics/cell-quality-based? text command is enabled.
solution_and_quality_based(*args, **kwargs)Enables/disables the detection and treatment of poor cells using a criterion based on the solution and cell quality.
user_defined_on_register(*args, **kwargs)Includes a register for the poor mesh numerics or not.
user_defined_on_register_auto(*args, **kwargs)Set up the application of poor mesh numerics to cells in a register during the calculation at a specified frequency.
Classes:
solution_based_pmn(path, service)Solution based poor-mesh numerics menu.
Enables/disables the application of poor mesh numerics on cells with an orthogonal quality that is equal to or less than the threshold defined by the solve/set/poor-mesh-numerics/set-quality-threshold text command (which by default is set to 0.05).
Enables/disables the application of poor mesh numerics on cells (those with an orthogonal quality of 0, as well as those identified by other enabled criteria), and defines whether the local solution correction is 0th, 1st, or 2nd order.
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.
Enables/disables the detection and treatment of poor cells using a criterion based on the cell gradient quality. Poor mesh numerics are applied when the criterion value is equal to or less than a threshold value defined as part of this text command. This criterion is only available with the pressure-based solver, and is not supported for cases that have periodic boundaries.
Enables/disables the relocation of select cell centroids, to improve the orthogonality metrics and solution stability. It is applied to cells when the criterion value is equal to or less than a threshold value defined as part of the text command. Note that the enhanced metrics are only apparent when reporting the quality in the solution mode of Fluent, and not in the meshing mode.
Prints out a listing of the poor cells for each criterion: default, cell quality, and user-defined, and (if enabled) cell gradient quality and solution and cell quality.
Resets the list of poor cells included by the default, cell quality, user-defined, cell gradient quality, and solution and cell quality criteria.
Sets the orthogonal quality threshold used for applying poor mesh numerics when the solve/set/poor-mesh-numerics/cell-quality-based? text command is enabled. By default, cells with an orthogonal quality of 0.05 or lower are corrected.
Enables/disables the detection and treatment of poor cells using a criterion based on the solution and cell quality. Poor mesh numerics are applied when the criterion value is equal to or less than a threshold value defined as part of this text command, and at a specified frequency (of iterations or time steps). This criterion is only available with the pressure-based solver.
Bases:
TUIMenuSolution 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 solution based treatment.
Mark cells exceeding cfl jump in neighborhood.
Mark cells exceeding cfl limit.
Mark cells violating solution limits.
Mark cells exceeding velocity limit.
Includes a register for the poor mesh numerics or not.
Set up the application of poor mesh numerics to cells in a register during the calculation at a specified frequency.
Bases:
TUIMenuProvides text commands that allow you to undo enhancements to the default solver behavior.
Methods:
undo_2019r1_default_changes(*args, **kwargs)Allows you to undo enhancements introduced in version 2019 R1 of ANSYS Fluent, including:.
undo_2019r3_default_changes(*args, **kwargs)Allows you to undo enhancements introduced in version 2019 R3 of ANSYS Fluent, including:.
undo_2021r1_default_changes(*args, **kwargs)Allows you to undo enhancements introduced in version 2021 R1 of ANSYS Fluent, including:.
undo_2021r2_default_changes(*args, **kwargs)Allows you to undo the following enhancements introduced in version 2021 R2 of ANSYS Fluent:.
undo_2022r1_default_changes(*args, **kwargs)Allows you to undo the following enhancements introduced in version 2022 R1 of ANSYS Fluent:.
undo_2023r1_default_changes(*args, **kwargs)Undo default changes introduced in 2023R1.
undo_r19_point_0_default_changes(*args, **kwargs)Undo default changes introduced in R19.0.
Allows you to undo enhancements introduced in version 2019 R1 of ANSYS Fluent, including:.
Allows you to undo enhancements introduced in version 2019 R3 of ANSYS Fluent, including:.
Allows you to undo enhancements introduced in version 2021 R1 of ANSYS Fluent, including:.
Allows you to undo the following enhancements introduced in version 2021 R2 of ANSYS Fluent:.
Allows you to undo the following enhancements introduced in version 2022 R1 of ANSYS Fluent:.
Undo default changes introduced in 2023R1.
Undo default changes introduced in R19.0.
Bases:
TUIMenuEnters the pseudo time method menu. This menu is only available for cases that use a pressure-based segregated solver (SIMPLE, SIMPLEC, or PISO) or for steady-state cases that use the pressure-based coupled solver or the density-based implicit solver.
Methods:
advanced_options(*args, **kwargs)Enters the advanced options menu, which allows you to enable / disable the pseudo time method for individual equations and define their pseudo time scale factors or under-relaxation factors, respectively.
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)Enables and sets the pseudo time step size formulation or disables the pseudo time method option.
global_time_step_settings(*args, **kwargs)Defines the pseudo time settings for the calculation when the global time step formulation is selected.
local_time_step_settings(*args, **kwargs)Defines the pseudo time Courant number when the local time step formulation is selected.
relaxation_bounds(*args, **kwargs)Select relaxation bounding scheme for pseudo time method.
relaxation_factors(*args, **kwargs)Enters the relaxation factors menu, where you can set the pseudo time explicit relaxation factors for individual equations.
relaxation_method(*args, **kwargs)Select relaxation definition for pseudo time method.
verbosity(*args, **kwargs)Sets the verbosity of the messages related to the pseudo time method.
Enters the advanced options menu, which allows you to enable / disable the pseudo time method for individual equations and define their pseudo time scale factors or under-relaxation factors, respectively. These settings only apply when the global time step formulation is selected.
Enable convergence acceleration for stretched meshes to improve the convergence of the implicit pressure based solver on meshes with high cell stretching.
Enables and sets the pseudo time step size formulation or disables the pseudo time method option.
Defines the pseudo time settings for the calculation when the global time step formulation is selected.
Defines the pseudo time Courant number when the local time step formulation is selected.
Select relaxation bounding scheme for pseudo time method.
Enters the relaxation factors menu, where you can set the pseudo time explicit relaxation factors for individual equations. These factors only apply when the global time step formulation is selected.
Select relaxation definition for pseudo time method.
Sets the verbosity of the messages related to the pseudo time method.
Enables the species reaction sources and sets relaxation factor.
Enable Reduced Rank Extrapolation method to accelerate solution time.
Reduced Rank Extrapolation options.
Enters the relaxation-factor menu.
Sets the solver relaxation method.
Sets the number of iterations for which convergence monitors are reported. The default is 1 (after every iteration).
Sets the implicit residual smoothing parameters. This command is available only for the explicit coupled solver.
Enters the residual tolerance menu.
Sets the amount of residual information to be printed. A value of 0 (the default) prints residuals at the end of each fine grid iteration. A value of 1 prints residuals after every stage of the fine grid iteration. A value of 2 prints residuals after every stage on every grid level.
Enables / disables the variable time step size formulation for second-order implicit transient formulations. If you disable the variable time step size formulation, note that any change in the time step size will introduce an error proportional to the change in the time step size ratio.
Sets all species discretizations and URFs together.
Sets controls to default values.
Sets the solution methods to the default settings.
Sets solution steering parameters.
Selects a new Fluent solver slope limiter.
Enables solution steering for the density-based solver.
Sets solver options for stiff chemistry solutions.
Sets surface-tension calculation options.
Set surface-tension expert options.
Set the time step.
Bases:
TUIMenuEnters the transient controls menu, which allows you to define settings related to time advancement for transient flow calculations.
Methods:
cfl_based_time_stepping(*args, **kwargs)Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent as the calculation proceeds such that the Courant–Friedrichs–Lewy (CFL) condition is satisfied, using the specified Courant number.
Set CFL-based adaptive time-stepping advanced parameters.
duration_specification_method(*args, **kwargs)Sets the method by which you will specify the duration of the calculation.
error_based_time_stepping(*args, **kwargs)Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the specified truncation error tolerance.
extrapolate_eqn_vars(*args, **kwargs)Enters the extrapolation menu.
extrapolate_vars(*args, **kwargs)Applies a predictor algorithm for computing initial conditions at time step n+1.
fixed_periodic(*args, **kwargs)Allows you to specify that a fixed time stepping method is used in which a specified period or frequency is the basis for determining the time step size and number of time steps.
fixed_user_specified(*args, **kwargs)Allows you to specify that a fixed time stepping method is used in which you directly specify the time step size and number of time steps.
incremental_time(*args, **kwargs)Sets the amount of incremental (that is, additional) time to run the simulation, regardless of how much time has already been run in previous calculations.
max_flow_time(*args, **kwargs)Sets the maximum flow time.
max_iterations_per_time_step(*args, **kwargs)Sets the number of time steps for a transient simulation.
multiphase_specific_time_stepping(*args, ...)Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the convective time scale (global Courant number): the time-step-size calculation depends on the mesh density and velocity in interfacial cells.
number_of_time_steps(*args, **kwargs)Sets the number of time steps for a transient simulation without starting the calculation.
predict_next_time(*args, **kwargs)Applies a predictor algorithm for computing the next time step.
rotating_mesh_flow_predictor(*args, **kwargs)Enables / disables an option that allows for better prediction of the flow field in rotating fluid zones at every time step, in order to speed up the calculation.
solid_time_step_size(*args, **kwargs)Allows you to specify that the time step size used for solid zones is independent from that used for fluid zones.
solution_status(*args, **kwargs)Allows you to open theSimulation Status dialog box, which reports details about the simulation.
specified_time_step(*args, **kwargs)Specifies whether to define the transient advancement either directly by entering a time step size / period / frequency (using the text commands available in thesolve/set/transient-controls menu) or indirectly by entering a Courant number value (using the solve/set/courant-number text command).
time_step_size(*args, **kwargs)Sets the magnitude of the (physical) time step .
time_step_size_for_acoustic_export(*args, ...)Specifies the time interval for acoustic data sampling.
total_number_of_time_steps(*args, **kwargs)Sets the total number of time steps that the simulation will run (which includes any time steps that have already been run in previous calculations).
total_time(*args, **kwargs)Sets the total amount of time that the simulation will be run (which includes any time that has already been run in previous calculations).
udf_based_time_stepping(*args, **kwargs)Allows you to specify that the time step size is defined by a user-defined function (UDF) that uses theDEFINE_DELTAT macro.
undo_timestep(*args, **kwargs)When enabled, if the truncation error within a time step exceeds the specified tolerance Fluent will automatically undo the current calculation and make another attempt with the time step reduced by 1/2.
Classes:
multiphase_specific_time_constraints(path, ...)Enters the menu for setting multiphase-specific time constraints.
Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent as the calculation proceeds such that the Courant–Friedrichs–Lewy (CFL) condition is satisfied, using the specified Courant number.
Set CFL-based adaptive time-stepping advanced parameters.
Sets the method by which you will specify the duration of the calculation. The duration can be defined by the total time, the total number of time steps, the incremental time, or the number of incremental time steps. In this context, “total” indicates that Fluent will consider the amount of time / steps that have already been solved and stop appropriately, whereas “incremental” indicates that the solution will proceed for a specified amount of time / steps regardless of what has previously been calculated. This text command is only available when the time stepping is adaptive or based on a user-defined function.
Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the specified truncation error tolerance.
Enters the extrapolation menu.
Applies a predictor algorithm for computing initial conditions at time step n+1. The predictor algorithm is a computation that sets a better initial condition for the time step.
Allows you to specify that a fixed time stepping method is used in which a specified period or frequency is the basis for determining the time step size and number of time steps.
Allows you to specify that a fixed time stepping method is used in which you directly specify the time step size and number of time steps.
Sets the amount of incremental (that is, additional) time to run the simulation, regardless of how much time has already been run in previous calculations. This text command is only available when the solve/set/transient-controls/duration-specification-method is set to3.
Sets the maximum flow time.
Sets the number of time steps for a transient simulation. This option is available when automatic initialization and case modification is enabled.
Bases:
TUIMenuEnters the menu for setting 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)Enables/disables the physics-driven time-step constraints.
verbosity(*args, **kwargs)When enabled, various time scales (depending on the selection) are printed to the console window at every time step.
Classes:
time_scale_options(path, service)Enters the menu for choosing the time-scale options.
Enable time step size constraints based on moving mesh courant number.
Enables/disables the physics-driven time-step constraints.
Bases:
TUIMenuEnters the menu for choosing the time-scale options. This menu becomes available after you enable the physics-driven time-step constraints using the solve/set/transient-controls/multiphase-specific-time-constraints/physics-based-constraint? text command.
Methods:
acoustic_scale(*args, **kwargs)Allows you to Include the acoustic time scale.
gravity_scale(*args, **kwargs)Allows you to Include the gravitational time scale.
surface_tension_scale(*args, **kwargs)Allows you to Include the surface-tension-driven time scale.
viscous_scale(*args, **kwargs)Allows you to Include the viscous time scale.
Allows you to Include the acoustic time scale. This option is available only for compressible flows.
Allows you to Include the gravitational time scale. This option is available only if gravity is enabled.
Allows you to Include the surface-tension-driven time scale. This option is available only if the surface tension force modeling is enabled.
Allows you to Include the viscous time scale. This option is disabled by default. This command is not available with inviscid flows.
When enabled, various time scales (depending on the selection) are printed to the console window at every time step. This text command is available with the moving mesh CFL constraint and with the physics-based constraint.
Allows you to specify that an adaptive time stepping method is used in which the time step gets modified by ANSYS Fluent based on the convective time scale (global Courant number): the time-step-size calculation depends on the mesh density and velocity in interfacial cells. This method is available for all multiphase models using the implicit or explicit volume fraction formulation, except for the wet steam model.
Sets the number of time steps for a transient simulation without starting the calculation.
Applies a predictor algorithm for computing the next time step. The predictor algorithm is a computation that sets a better initial condition for the time step. It uses the rate of change between the prediction and the correction as an indicator for whether the next time step should be larger, smaller, or the same as the current one.
Enables / disables an option that allows for better prediction of the flow field in rotating fluid zones at every time step, in order to speed up the calculation. This text command is only available for transient simulations.
Allows you to specify that the time step size used for solid zones is independent from that used for fluid zones. This text command is only available when both a solid zone exists and energy is enabled.
Allows you to open theSimulation Status dialog box, which reports details about the simulation.
Specifies whether to define the transient advancement either directly by entering a time step size / period / frequency (using the text commands available in thesolve/set/transient-controls menu) or indirectly by entering a Courant number value (using the solve/set/courant-number text command). This text command is only available for the density-based solver when both the explicit formulation and explicit transient formulation are used.
Sets the magnitude of the (physical) time step . This text command is only available when the solve/set/transient-controls/fixed-user-specified text command is set toyes.
Specifies the time interval for acoustic data sampling. This text command is only available when both the Ffowcs Williams and Hawkings model is selected and the density-based solver is used with the explicit formulation and explicit transient formulation.
Sets the total number of time steps that the simulation will run (which includes any time steps that have already been run in previous calculations). This text command is only available when the solve/set/transient-controls/duration-specification-method is set to1.
Sets the total amount of time that the simulation will be run (which includes any time that has already been run in previous calculations). This text command is only available when the solve/set/transient-controls/duration-specification-method is set to2.
Allows you to specify that the time step size is defined by a user-defined function (UDF) that uses theDEFINE_DELTAT macro.
When enabled, if the truncation error within a time step exceeds the specified tolerance Fluent will automatically undo the current calculation and make another attempt with the time step reduced by 1/2. This will be attempted up to 5 times after which Fluent will accept the result and proceed to the next time step.
Enters the under-relaxation menu, which allows you to set the under-relaxation factor for each equation that is being solved in a segregated manner.
Set Multiphase-Specific Adaptive time stepping parameters.
Sets the sub time step calculation method for VOF calculations.
Sets VOF numeric options.
Bases:
TUIMenuEnters the warped-face gradient correction menu.
Methods:
enable(*args, **kwargs)Enables/disables gradient enhancement computations and specifies whether Fluent uses fast or memory saving mode.
turbulence_options(*args, **kwargs)Set turbulence Warped Face Gradient Correction.
Enables/disables gradient enhancement computations and specifies whether Fluent uses fast or memory saving mode.
Set turbulence Warped Face Gradient Correction.