solve_with_plot

class ansys.systemcoupling.core.adaptor.api_25_2.solve_with_plot.solve_with_plot(name=None, parent=None)

Bases: InjectedCommand

Solves, showing a live plot of transfer values and convergence for data transfers of a coupling interface.

Note

This functionality is experimental and is still being developed. The API and behavior are subject to change.

Note that although the optional arguments are somewhat complex to describe, the common use cases are relatively straightforward to use. The complexity exists to provide flexibility for more complex use cases.

If there is a single interface, and charts are needed on all transfers, then no arguments are needed. The transfer list can be filtered by optionally providing transfer_names, to specify a list of transfers to be included.

If there are multiple interfaces, then interface_name can be provided to select a single interface, and again transfer_names may be provided as a filter.

There are no other situations where it is valid to provide interface_name and/or transfer_names.

If there are multiple interfaces, and no filtering is required, no arguments are needed.

If there are multiple interfaces, and all transfers are needed on some interfaces, then interface_names may be provided to select those interfaces. In this case there is no filtering of transfers.

For full control, interface_and_transfer_names may be provided to specify exactly which interfaces and which transfers on those interfaces are needed. This takes the form of a dictionary, mapping an interface name either to a list of transfer names or to None. None here is a concise way to indicate that all transfers on that interface are needed.

Parameters:

interface_namestr, optional

Specification of which interface to plot. Defaults to None.

Cannot be used if interface_names or interface_and_transfer_names is provided.

interface_namesList, optional

Specification of which interfaces to plot. Defaults to None.

Cannot be used if interface_name or interface_and_transfer_names is provided.

transfer_namesList, optional

Specification of which data transfers to plot. Defaults to None, which means plot all data transfers.

Can only be used if there is a single interface in the analysis, or if a single interface is selected via interface_name or interface_names.

interface_and_transfer_namesDict, optional

Specification of which interfaces and data transfers to plot. Defaults to None.

Can only be used if interface_name, interface_names, and transfer_names are not provided and allows for full specification of which interfaces and which transfers to plot in the form of a dictionary mapping interface names to lists of transfer names. Additionally, the list of transfer names may be None to indicate that all transfers on that interface are to be plotted.

working_dirstr, optional

Working directory (defaults = “.”).

show_convergencebool, optional

Whether to show convergence plots (defaults to True).

show_transfer_valuesbool, optional

Whether to show transfer value plots (defaults to True).

Included in:

Parent	Summary
solution_root	‘root’ object