solver.tui.solve.monitors.residual#

class main_menu.solve.monitors.residual(path, service)#

Enters the residual monitors menu.

check_convergence(*args, **kwargs)#

Chooses which currently monitored residuals should be checked for convergence.

convergence_criteria(*args, **kwargs)#

Sets convergence criteria for residuals that are currently being both monitored and checked.

criterion_type(*args, **kwargs)#

Sets convergence criterion type.

enhanced_continuity_residual(*args, **kwargs)#

Enables/disables an enhanced formulation for the local scaling of the continuity residuals with the pressure-based solver, so that the absolute mass flow rate at each cell is used. This text command is only available when the computing of the local scale is enabled through the solve/monitors/residual/scale-by-coefficient? text command.

monitor(*args, **kwargs)#

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

n_display(*args, **kwargs)#

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

n_maximize_norms(*args, **kwargs)#

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

n_save(*args, **kwargs)#

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

normalization_factors(*args, **kwargs)#

Sets normalization factors for currently monitored residuals (if normalize? is set to yes).

normalize(*args, **kwargs)#

Chooses whether to normalize residuals in printed and plotted output.

plot(*args, **kwargs)#

Chooses whether residuals will be plotted during iteration.

print(*args, **kwargs)#

Chooses whether residuals will be printed during iteration.

re_normalize(*args, **kwargs)#

Re-normalize residuals by maximum values.

relative_conv_criteria(*args, **kwargs)#

Sets relative convergence criteria for residuals that are currently being both monitored and checked.

reset(*args, **kwargs)#

Chooses whether to delete the residual history and reset iteration counter to 1.

scale_by_coefficient(*args, **kwargs)#

Chooses whether to scale residuals by coefficient sum in printed and plotted output.