CfgFrequencySweep

class pyedb.configuration.cfg_setup.CfgSetupAC.CfgFrequencySweep(name: str = '', **kwargs)

Bases: pyedb.configuration.cfg_common.CfgBaseModel

Base Pydantic model used by typed configuration payload classes.

Overview

Methods

add_frequencies	Append a pre-built CfgFrequencies range to this sweep.
add_linear_count_frequencies	Append a linear-count frequency range to this sweep.
add_log_count_frequencies	Append a logarithmic-count frequency range to this sweep.
add_linear_scale_frequencies	Append a linear-step frequency range to this sweep.
add_log_scale_frequencies	Append a logarithmic-step frequency range to this sweep.
add_single_frequency	Append a single discrete frequency point to this sweep.

Attributes

name
type
frequencies
use_q3d_for_dc
compute_dc_point
enforce_causality
enforce_passivity
adv_dc_extrapolation
use_hfss_solver_regions
hfss_solver_region_setup_name
hfss_solver_region_sweep_name

Import detail

from pyedb.configuration.cfg_setup.CfgSetupAC import CfgFrequencySweep

Attribute detail

CfgFrequencySweep.name: str

CfgFrequencySweep.type: Literal['discrete', 'interpolation', 'interpolating'] = None

CfgFrequencySweep.frequencies: list[CfgFrequencies | str] = None

CfgFrequencySweep.use_q3d_for_dc: bool = None

CfgFrequencySweep.compute_dc_point: bool = None

CfgFrequencySweep.enforce_causality: bool = False

CfgFrequencySweep.enforce_passivity: bool = True

CfgFrequencySweep.adv_dc_extrapolation: bool = False

CfgFrequencySweep.use_hfss_solver_regions: bool = None

CfgFrequencySweep.hfss_solver_region_setup_name: str | None = ''

CfgFrequencySweep.hfss_solver_region_sweep_name: str | None = ''

Method detail

CfgFrequencySweep.add_frequencies(freq: CfgFrequencies)

Append a pre-built CfgFrequencies range to this sweep.

Parameters:

freqCfgFrequencies

Fully constructed frequency-range object to append.

CfgFrequencySweep.add_linear_count_frequencies(start, stop, count)

Append a linear-count frequency range to this sweep.

Parameters:

startstr or float

Start frequency, e.g. "1GHz" or 1e9.

stopstr or float

Stop frequency, e.g. "20GHz" or 20e9.

countint

Number of evenly spaced frequency points.

Returns:

CfgFrequencySweep

self — enables method chaining.

Examples

>>> sw = hfss.add_frequency_sweep("sw")
>>> sw.add_linear_count_frequencies("1GHz", "10GHz", 100)

CfgFrequencySweep.add_log_count_frequencies(start: str | float, stop: str | float, count: int)

Append a logarithmic-count frequency range to this sweep.

Parameters:

startstr or float

Start frequency, e.g. "1MHz".

stopstr or float

Stop frequency, e.g. "1GHz".

countint

Number of frequency points distributed on a log scale.

Returns:

CfgFrequencySweep

self — enables method chaining.

CfgFrequencySweep.add_linear_scale_frequencies(start: str | float, stop: str | float, step: str | float)

Append a linear-step frequency range to this sweep.

Parameters:

startstr or float

Start frequency, e.g. "0Hz".

stopstr or float

Stop frequency, e.g. "1GHz".

stepstr or float

Step size between consecutive points, e.g. "10MHz".

Returns:

CfgFrequencySweep

self — enables method chaining.

CfgFrequencySweep.add_log_scale_frequencies(start: str | float, stop: str | float, step: str | float)

Append a logarithmic-step frequency range to this sweep.

Parameters:

startstr or float

Start frequency.

stopstr or float

Stop frequency.

stepstr or float

Decade step size.

Returns:

CfgFrequencySweep

self — enables method chaining.

CfgFrequencySweep.add_single_frequency(freq: str | float)

Append a single discrete frequency point to this sweep.

Parameters:

freqstr or float

Frequency value, e.g. "5GHz" or 5e9.

Returns:

CfgFrequencySweep

self — enables method chaining.

Examples

>>> sw.add_single_frequency("0Hz")