AdaptiveSettings

class pyedb.dotnet.database.sim_setup_data.data.settings.AdaptiveSettings(parent)

Bases: object

Manages EDB methods for adaptive settings.

Overview

Methods

add_adaptive_frequency_data	Add a setup for frequency data.
add_broadband_adaptive_frequency_data	Add a setup for frequency data.
add_multi_frequency_adaptive_setup	Add a setup for frequency data.

Properties

adaptive_settings	Adaptive EDB settings.
adaptive_frequency_data_list	List of all adaptive frequency data.
adapt_type	Adaptive type.
basic	Whether if turn on basic adaptive.
do_adaptive	Whether if adaptive mesh is on.
max_refinement	Maximum number of mesh elements to be added per pass.
max_refine_per_pass	Maximum number of mesh elementat that can be added during an adaptive pass.
min_passes	Minimum number of passes.
min_converged_passes	Minimum number of converged passes.
save_fields	Whether to turn on save fields.
save_rad_field_only	Flag indicating if the saving of only radiated fields is turned on.
use_convergence_matrix	Whether to turn on the convergence matrix.
use_max_refinement	Whether to turn on maximum refinement.

Import detail

from pyedb.dotnet.database.sim_setup_data.data.settings import AdaptiveSettings

Property detail

property AdaptiveSettings.adaptive_settings

Adaptive EDB settings.

Returns:

pyedb.dotnet.database.edb_data.hfss_simulation_setup_data.AdaptiveSettings

property AdaptiveSettings.adaptive_frequency_data_list

List of all adaptive frequency data.

Returns:

pyedb.dotnet.database.edb_data.hfss_simulation_setup_data.AdaptiveFrequencyData

property AdaptiveSettings.adapt_type

Adaptive type. Options: 1- kSingle. 2- kMultiFrequencies. 3- kBroadband. 4- kNumAdaptTypes.

Returns:

str

property AdaptiveSettings.basic

Whether if turn on basic adaptive.

Returns:

True if basic adaptive is used, False otherwise.

property AdaptiveSettings.do_adaptive

Whether if adaptive mesh is on.

Returns:

bool

True if adaptive is used, False otherwise.

property AdaptiveSettings.max_refinement

Maximum number of mesh elements to be added per pass.

Returns:

int

property AdaptiveSettings.max_refine_per_pass

Maximum number of mesh elementat that can be added during an adaptive pass.

Returns:

int

property AdaptiveSettings.min_passes

Minimum number of passes.

Returns:

int

property AdaptiveSettings.min_converged_passes

Minimum number of converged passes.

Returns:

int

property AdaptiveSettings.save_fields

Whether to turn on save fields.

Returns:

bool

True if save fields is used, False otherwise.

property AdaptiveSettings.save_rad_field_only

Flag indicating if the saving of only radiated fields is turned on.

Returns:

bool

True if save radiated field only is used, False otherwise.

property AdaptiveSettings.use_convergence_matrix

Whether to turn on the convergence matrix.

Returns:

bool

True if convergence matrix is used, False otherwise.

property AdaptiveSettings.use_max_refinement

Whether to turn on maximum refinement.

Returns:

bool

True if maximum refinement is used, False otherwise.

Method detail

AdaptiveSettings.add_adaptive_frequency_data(frequency=0, max_num_passes=10, max_delta_s=0.02)

Add a setup for frequency data.

Parameters:

frequencystr, float

Frequency with units or float frequency (in Hz).

max_num_passesint, optional

Maximum number of passes. The default is 10.

max_delta_sfloat, optional

Maximum delta S. The default is 0.02.

Returns:

bool

True if method is successful, False otherwise.

AdaptiveSettings.add_broadband_adaptive_frequency_data(low_frequency=0, high_frequency=10000000000.0, max_num_passes=10, max_delta_s=0.02)

Add a setup for frequency data.

Parameters:

low_frequencystr, float

Frequency with units or float frequency (in Hz).

high_frequencystr, float

Frequency with units or float frequency (in Hz).

max_num_passesint, optional

Maximum number of passes. The default is 10.

max_delta_sfloat, optional

Maximum delta S. The default is 0.02.

Returns:

bool

True if method is successful, False otherwise.

AdaptiveSettings.add_multi_frequency_adaptive_setup(freq_list, max_num_passes=10, max_delta_s=0.02)

Add a setup for frequency data.

Parameters:

low_frequencystr, float

Frequency with units or float frequency (in Hz).

high_frequencystr, float

Frequency with units or float frequency (in Hz).

max_num_passesint, optional

Maximum number of passes. The default is 10.

max_delta_sfloat, optional

Maximum delta S. The default is 0.02.

Returns:

bool

True if method is successful, False otherwise.