use_matrix_convergence

SetupHFSS.use_matrix_convergence(entry_selection=0, ignore_phase_when_mag_is_less_than=0.01, all_diagonal_entries=True, max_delta=0.02, max_delta_phase=5, all_offdiagonal_entries=True, off_diagonal_mag=0.02, off_diagonal_phase=5, custom_entries=None)

Enable Matrix Convergence criteria.

Parameters:

entry_selectionint

Entry Selection. 0 for All, 1 for Diagonal Entries, 2 for custom entries.

ignore_phase_when_mag_is_less_thanfloat

Value of magnitude when phase is ignored.

all_diagonal_entriesbool

Whether diagonal entries has to be included in convergence or not. Default is True.

max_deltafloat

Maximum Delta S.

max_delta_phasefloat, str

Maximum delta phase in degree.

all_offdiagonal_entriesbool

Whether off-diagonal entries has to be included in convergence or not. Default is True.

off_diagonal_magfloat

Maximum offdiagonal Delta S.

off_diagonal_phasefloat, str

Maximum off-diagonal delta phase in degree.

custom_entrieslist, optional

Custom entry mapping list. Every item of the lists hall be a list with 4 elements: [port 1 name, port 2 name, max_delta_s, max_delta_angle].

Returns:

bool