HFSSGeneralSettings

class pyedb.grpc.database.simulation_setup.hfss_general_settings.HFSSGeneralSettings(pedb, core: ansys.edb.core.simulation_setup.hfss_simulation_settings.HFSSGeneralSettings)

PyEDB-core HFSS general settings class.

Overview

Properties

adapt_type	Adaptation type.
adaptive_solution_type	Adaptive solution type.
broadband_adaptive_solution	Settings for a broadband adaptive solution.
mesh_region_name	Name of the mesh region to use.
multi_frequency_adaptive_solution
save_fields	Indicates whether to save fields.
save_rad_field_only	Indicates whether to save radiation field only.
save_rad_fields_only	Indicates whether to save radiation fields only.
single_frequency_adaptive_solution
use_mesh_region	Indicates whether to use a mesh region.
use_parallel_refinement	Indicates whether to use parallel refinement.
max_refine_per_pass	Maximum refinement per pass.
min_passes	Minimum number of passes.
use_max_refinement	Indicates whether to use maximum refinement.

Attributes

core

Import detail

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

Property detail

property HFSSGeneralSettings.adapt_type: str

Adaptation type.

..deprecated:: 0.67.0

This property is deprecated and will be removed in future versions. Attribute added for dotnet compatibility. Use adaptive_solution_type instead.

property HFSSGeneralSettings.adaptive_solution_type: str

Adaptive solution type.

Returns:

str

Adaptive solution type name. Returned values are single, multi_frequencies, broad_band, or num_adapt_type.

property HFSSGeneralSettings.broadband_adaptive_solution: BroadbandAdaptiveSolution

Settings for a broadband adaptive solution.

Returns:

:class:`HFSSBroadbandAdaptiveSolution

`

Broadband adaptive solution settings object.

property HFSSGeneralSettings.mesh_region_name: str

Name of the mesh region to use.

Returns:

str

Mesh region name.

property HFSSGeneralSettings.multi_frequency_adaptive_solution: MultiFrequencyAdaptiveSolution

property HFSSGeneralSettings.save_fields: bool

Indicates whether to save fields.

Returns:

bool

True if fields are to be saved, False otherwise.

property HFSSGeneralSettings.save_rad_field_only: bool

Indicates whether to save radiation field only.

Deprecated since version 0.67.0: This property is deprecated and will be removed in future versions. Use save_rad_fields_only instead.

property HFSSGeneralSettings.save_rad_fields_only: bool

Indicates whether to save radiation fields only.

Returns:

bool

True if only radiation fields are to be saved, False otherwise.

property HFSSGeneralSettings.single_frequency_adaptive_solution

property HFSSGeneralSettings.use_mesh_region: bool

Indicates whether to use a mesh region.

Returns:

bool

True if a mesh region is used, False otherwise.

property HFSSGeneralSettings.use_parallel_refinement: bool

Indicates whether to use parallel refinement.

Returns:

bool

True if parallel refinement is used, False otherwise.

property HFSSGeneralSettings.max_refine_per_pass: float

Maximum refinement per pass.

Deprecated since version 0.67.0.

This property is deprecated and will be removed in future versions. use settings.options.max_refinement_per_pass instead.

property HFSSGeneralSettings.min_passes: int

Minimum number of passes.

Deprecated since version 0.67.0.

This property is deprecated and will be removed in future versions. use settings.options.min_passes instead.

property HFSSGeneralSettings.use_max_refinement: bool

Indicates whether to use maximum refinement.

Deprecated since version 0.67.0.

This property is deprecated and will be removed in future versions. use settings.options.use_max_refinement instead.

Attribute detail

HFSSGeneralSettings.core