residual#
Bases:
TUIMenuEnters the residual monitors menu.
Methods:
__init__(service, version, mode, path)__init__ method of TUIMenu class.
Classes:
check_convergence(service, version, mode, path)Chooses which currently monitored residuals should be checked for convergence.
convergence_criteria(service, version, mode, ...)Sets convergence criteria for residuals that are currently being both monitored and checked.
criterion_type(service, version, mode, path)Sets convergence criterion type.
enhanced_continuity_residual(service, ...)Enables/disables an enhanced formulation for the local scaling of the continuity residuals with the pressure-based solver, so that the absolute mass flow rate at each cell is used.
monitor(service, version, mode, path)Chooses which residuals to monitor as printed and/or plotted output.
n_display(service, version, mode, path)Sets the number of most recent residuals to display in plots.
n_maximize_norms(service, version, mode, path)Sets the number of iterations through which normalization factors will be maximized.
n_save(service, version, mode, path)Sets number of residuals to be saved with data.
normalization_factors(service, version, ...)Sets normalization factors for currently monitored residuals (if normalize? is set to yes).
normalize(service, version, mode, path)Chooses whether to normalize residuals in printed and plotted output.
plot(service, version, mode, path)Chooses whether residuals will be plotted during iteration.
print(service, version, mode, path)Chooses whether residuals will be printed during iteration.
re_normalize(service, version, mode, path)Re-normalize residuals by maximum values.
relative_conv_criteria(service, version, ...)Sets relative convergence criteria for residuals that are currently being both monitored and checked.
reset(service, version, mode, path)Chooses whether to delete the residual history and reset iteration counter to 1.
scale_by_coefficient(service, version, mode, ...)Chooses whether to scale residuals by coefficient sum in printed and plotted output.
window(service, version, mode, path)Specifies window in which residuals will be plotted during iteration.
__init__ method of TUIMenu class.
Bases:
TUIMethodChooses which currently monitored residuals should be checked for convergence.
Bases:
TUIMethodSets convergence criteria for residuals that are currently being both monitored and checked.
Bases:
TUIMethodSets convergence criterion type.
Bases:
TUIMethodEnables/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.
Bases:
TUIMethodChooses which residuals to monitor as printed and/or plotted output.
Bases:
TUIMethodSets the number of most recent residuals to display in plots.
Bases:
TUIMethodSets the number of iterations through which normalization factors will be maximized.
Bases:
TUIMethodSets number of residuals to be saved with data. History is automatically compacted when buffer becomes full.
Bases:
TUIMethodSets normalization factors for currently monitored residuals (if normalize? is set to yes).
Bases:
TUIMethodChooses whether to normalize residuals in printed and plotted output.
Bases:
TUIMethodChooses whether residuals will be plotted during iteration.
Bases:
TUIMethodChooses whether residuals will be printed during iteration.
Bases:
TUIMethodRe-normalize residuals by maximum values.
Bases:
TUIMethodSets relative convergence criteria for residuals that are currently being both monitored and checked.
Bases:
TUIMethodChooses whether to delete the residual history and reset iteration counter to 1.
Bases:
TUIMethodChooses whether to scale residuals by coefficient sum in printed and plotted output.
Bases:
TUIMethodSpecifies window in which residuals will be plotted during iteration.