MatrixConvergenceData

class pyedb.grpc.database.simulation_setup.hfss_general_settings.MatrixConvergenceData(pedb, core)

Overview

Methods

add_entry	Add a matrix convergence data entry.
set_all_constant	Set all matrix convergence data entries to constant values.
set_all_diag_constant	Set all diagonal matrix convergence data entries to constant values.
set_all_off_diag_constant	Set all off-diagonal matrix convergence data entries to constant values.

Properties

all_constant	Indicates whether all matrix convergence data entries are constant.
all_diag_constant	Indicates whether all diagonal matrix convergence data entries are constant.
all_off_diag_constant	Indicates whether all off-diagonal matrix convergence data entries are constant.
entry_list	List of matrix convergence data entries.
mag_min_threshold	Magnitude minimum threshold for matrix convergence data.

Attributes

core

Import detail

from pyedb.grpc.database.simulation_setup.hfss_general_settings import MatrixConvergenceData

Property detail

property MatrixConvergenceData.all_constant: bool

Indicates whether all matrix convergence data entries are constant.

Returns:

bool

True if all entries are constant, False otherwise.

property MatrixConvergenceData.all_diag_constant: bool

Indicates whether all diagonal matrix convergence data entries are constant.

Returns:

bool

True if all diagonal entries are constant, False otherwise.

property MatrixConvergenceData.all_off_diag_constant: bool

Indicates whether all off-diagonal matrix convergence data entries are constant.

Returns:

bool

True if all off-diagonal entries are constant, False otherwise.

property MatrixConvergenceData.entry_list: list[MatrixConvergenceDataEntry]

List of matrix convergence data entries.

Returns:

list[MatrixConvergenceDataEntry]

List of matrix convergence data entries.

property MatrixConvergenceData.mag_min_threshold: float

Magnitude minimum threshold for matrix convergence data.

Returns:

float

Magnitude minimum threshold value.

Attribute detail

MatrixConvergenceData.core

Method detail

MatrixConvergenceData.add_entry(port_name_1, port_name_2, mag_limit, phase_limit)

Add a matrix convergence data entry.

Parameters:

port_name_1str

Name of the first port.

port_name_2str

Name of the second port.

mag_limitfloat

Magnitude limit.

phase_limitfloat

Phase limit.

MatrixConvergenceData.set_all_constant(mag_limit, phase_limit, port_names)

Set all matrix convergence data entries to constant values.

Parameters:

mag_limitfloat

Magnitude limit.

phase_limitfloat

Phase limit.

port_nameslist[str]

List of port names.

MatrixConvergenceData.set_all_diag_constant(mag_limit, phase_limit, port_names, clear_entries)

Set all diagonal matrix convergence data entries to constant values.

Parameters:

mag_limitfloat

Magnitude limit.

phase_limitfloat

Phase limit.

port_nameslist[str]

List of port names.

clear_entriesbool

Whether to clear existing entries.

MatrixConvergenceData.set_all_off_diag_constant(mag_limit, phase_limit, port_names, clear_entries)

Set all off-diagonal matrix convergence data entries to constant values.

Parameters:

mag_limitfloat

Magnitude limit.

phase_limitfloat

Phase limit.

port_nameslist[str]

List of port names.

clear_entriesbool

Whether to clear existing entries.