monitors#
Bases:
TUIMenu
Enter the monitors menu.
Methods:
convergence_conditions
(*args, **kwargs)Manage convergence report.
set_average_over
(*args, **kwargs)Set the average over input for monitors.
Classes:
report_files
(path, service)Manage report files.
report_plots
(path, service)Manage report plots.
residual
(path, service)Enter the residual monitors menu.
Manage convergence report.
Bases:
TUIMenu
Manage report files.
Methods:
add
(*args, **kwargs)Add a new object.
clear_data
(*args, **kwargs)Delete the report file from the system.
delete
(*args, **kwargs)Delete an object.
delete_all
(*args, **kwargs)Delete all report file objects.
edit
(*args, **kwargs)Edit an object.
list
(*args, **kwargs)List objects.
list_properties
(*args, **kwargs)List properties of an object.
Add a new object.
Delete the report file from the system.
Delete an object.
Delete all report file objects.
Edit an object.
List objects.
List properties of an object.
Bases:
TUIMenu
Manage report plots.
Methods:
add
(*args, **kwargs)Add a new object.
axes
(*args, **kwargs)Set axes options of an object.
clear_data
(*args, **kwargs)Clear report plot data.
curves
(*args, **kwargs)Set curves options of an object.
delete
(*args, **kwargs)Delete an object.
delete_all
(*args, **kwargs)Delete all plot objects.
edit
(*args, **kwargs)Edit an object.
list
(*args, **kwargs)List objects.
list_properties
(*args, **kwargs)List properties of an object.
plot
(*args, **kwargs)Plot.
Add a new object.
Set axes options of an object.
Clear report plot data.
Set curves options of an object.
Delete an object.
Delete all plot objects.
Edit an object.
List objects.
List properties of an object.
Plot.
Bases:
TUIMenu
Enter the residual monitors menu.
Methods:
check_convergence
(*args, **kwargs)Choose which currently-monitored residuals should be checked for convergence.
convergence_criteria
(*args, **kwargs)Set convergence criteria for residuals which are currently being both monitored and checked.
criterion_type
(*args, **kwargs)Set convergence criterion type.
enhanced_continuity_residual
(*args, **kwargs)Scale the continuity residuals locally based on the enhanced formulation.
monitor
(*args, **kwargs)Choose which residuals to monitor as printed and/or plotted output.
n_display
(*args, **kwargs)Set the number of most recent residuals to display in plots.
n_maximize_norms
(*args, **kwargs)Set the number of iterations through which normalization factors will be maximized.
n_save
(*args, **kwargs)Set number of residuals to be saved with data.
normalization_factors
(*args, **kwargs)Set normalization factors for currently-monitored residuals.
normalize
(*args, **kwargs)Choose whether or not to normalize residuals in printed and plotted output.
plot
(*args, **kwargs)Choose whether or not residuals will be plotted during iteration.
print
(*args, **kwargs)Choose whether or not residuals will be printed during iteration.
re_normalize
(*args, **kwargs)Renormalize residuals by maximum values.
relative_conv_criteria
(*args, **kwargs)Set relative convergence criteria for residuals which are currently being both monitored and checked.
reset
(*args, **kwargs)Delete the residual history and reset iteration counter to unity.
scale_by_coefficient
(*args, **kwargs)Enable/disable scaling of residuals by coefficient sum in printed and plotted output.
Choose which currently-monitored residuals should be checked for convergence.
Set convergence criteria for residuals which are currently being both monitored and checked.
Set convergence criterion type.
Scale the continuity residuals locally based on the enhanced formulation.
Choose which residuals to monitor as printed and/or plotted output.
Set the number of most recent residuals to display in plots.
Set the number of iterations through which normalization factors will be maximized.
Set number of residuals to be saved with data. History is automatically compacted when buffer becomes full.
Set normalization factors for currently-monitored residuals.
Choose whether or not to normalize residuals in printed and plotted output.
Choose whether or not residuals will be plotted during iteration.
Choose whether or not residuals will be printed during iteration.
Renormalize residuals by maximum values.
Set relative convergence criteria for residuals which are currently being both monitored and checked.
Delete the residual history and reset iteration counter to unity.
Enable/disable scaling of residuals by coefficient sum in printed and plotted output.
Set the average over input for monitors.