:class:`AdvancedSettings` ========================= .. py:class:: pyedb.dotnet.database.sim_setup_data.io.siwave.AdvancedSettings(parent) Bases: :py:obj:`SettingsBase` Provide base settings. .. !! processed by numpydoc !! .. py:currentmodule:: AdvancedSettings Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~set_si_slider` - * - :py:attr:`~set_pi_slider` - .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~include_inter_plane_coupling` - Whether to turn on InterPlane Coupling. * - :py:attr:`~xtalk_threshold` - XTalk threshold. * - :py:attr:`~min_void_area` - Minimum void area to include. * - :py:attr:`~min_pad_area_to_mesh` - Minimum void pad area to mesh to include. * - :py:attr:`~min_plane_area_to_mesh` - Minimum plane area to mesh to include. * - :py:attr:`~snap_length_threshold` - Snapping length threshold. * - :py:attr:`~return_current_distribution` - Whether to enable the return current distribution. * - :py:attr:`~ignore_non_functional_pads` - Exclude non-functional pads. * - :py:attr:`~include_coplane_coupling` - Whether to enable coupling between traces and adjacent plane edges. * - :py:attr:`~include_fringe_coupling` - Whether to include the effect of fringe field coupling between stacked cavities. * - :py:attr:`~include_split_plane_coupling` - Whether to account for coupling between adjacent parallel plane edges. * - :py:attr:`~include_infinite_ground` - Whether to Include a ground plane to serve as a voltage reference for traces and planes * - :py:attr:`~include_trace_coupling` - Whether to model coupling between adjacent traces. * - :py:attr:`~include_vi_sources` - Whether to include the effect of parasitic elements from voltage and * - :py:attr:`~infinite_ground_location` - Elevation of the infinite unconnected ground plane placed under the design. * - :py:attr:`~max_coupled_lines` - Maximum number of coupled lines to build the new coupled transmission line model. * - :py:attr:`~automatic_mesh` - Whether to automatically pick a suitable mesh refinement frequency, * - :py:attr:`~mesh_automatic` - Whether to automatically pick a suitable mesh refinement frequency, * - :py:attr:`~perform_erc` - Whether to perform an electrical rule check while generating the solver input. * - :py:attr:`~mesh_frequency` - Mesh size based on the effective wavelength at the specified frequency. .. tab-item:: Attributes .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~defaults` - * - :py:attr:`~si_defaults` - * - :py:attr:`~pi_defaults` - Import detail ------------- .. code-block:: python from pyedb.dotnet.database.sim_setup_data.io.siwave import AdvancedSettings Property detail --------------- .. py:property:: include_inter_plane_coupling Whether to turn on InterPlane Coupling. The setter will also enable custom settings. :Returns: :ref:`bool ` ``True`` if interplane coupling is used, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: xtalk_threshold XTalk threshold. The setter enables custom settings. :Returns: :class:`python:str` .. .. !! processed by numpydoc !! .. py:property:: min_void_area Minimum void area to include. :Returns: :ref:`bool ` .. .. !! processed by numpydoc !! .. py:property:: min_pad_area_to_mesh Minimum void pad area to mesh to include. :Returns: :ref:`bool ` .. .. !! processed by numpydoc !! .. py:property:: min_plane_area_to_mesh Minimum plane area to mesh to include. :Returns: :ref:`bool ` .. .. !! processed by numpydoc !! .. py:property:: snap_length_threshold Snapping length threshold. :Returns: :class:`python:str` .. .. !! processed by numpydoc !! .. py:property:: return_current_distribution Whether to enable the return current distribution. This option is used to accurately model the change of the characteristic impedance of transmission lines caused by a discontinuous ground plane. Instead of injecting the return current of a trace into a single point on the ground plane, the return current for a high impedance trace is spread out. The trace return current is not distributed when all traces attached to a node have a characteristic impedance less than 75 ohms or if the difference between two connected traces is less than 25 ohms. :Returns: :ref:`bool ` ``True`` if return current distribution is used, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: ignore_non_functional_pads Exclude non-functional pads. :Returns: :ref:`bool ` `True`` if functional pads have to be ignored, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: include_coplane_coupling Whether to enable coupling between traces and adjacent plane edges. This option provides a model for crosstalk between signal lines and planes. Plane edges couple to traces when they are parallel. Traces and coplanar edges that are oblique to each other do not overlap and cannot be considered for coupling. :Returns: :ref:`bool ` ``True`` if coplane coupling is used, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: include_fringe_coupling Whether to include the effect of fringe field coupling between stacked cavities. :Returns: :ref:`bool ` ``True`` if fringe coupling is used, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: include_split_plane_coupling Whether to account for coupling between adjacent parallel plane edges. Primarily, two different cases are being considered: - Plane edges that form a split. - Plane edges that form a narrow trace-like plane. The former leads to crosstalk between adjacent planes for which a specific coupling model is applied. For the latter, fringing effects are considered to model accurately the propagation characteristics of trace-like cavities. Further, the coupling between narrow planes is also modeled by enabling this feature. :Returns: :ref:`bool ` ``True`` if split plane coupling is used, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: include_infinite_ground Whether to Include a ground plane to serve as a voltage reference for traces and planes if they are not defined in the layout. :Returns: :ref:`bool ` ``True`` if infinite ground is used, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: include_trace_coupling Whether to model coupling between adjacent traces. Coupling is considered for parallel and almost parallel trace segments. :Returns: :ref:`bool ` ``True`` if trace coupling is used, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: include_vi_sources Whether to include the effect of parasitic elements from voltage and current sources. :Returns: :ref:`bool ` ``True`` if vi sources is used, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: infinite_ground_location Elevation of the infinite unconnected ground plane placed under the design. :Returns: :class:`python:str` .. .. !! processed by numpydoc !! .. py:property:: max_coupled_lines Maximum number of coupled lines to build the new coupled transmission line model. :Returns: :class:`python:int` .. .. !! processed by numpydoc !! .. py:property:: automatic_mesh Whether to automatically pick a suitable mesh refinement frequency, depending on drawing size, number of modes, and/or maximum sweep frequency. .. deprecated:: 0.54.0 Use :func:`automatic_mesh` instead. :Returns: :ref:`bool ` ``True`` if automatic mesh is used, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: mesh_automatic Whether to automatically pick a suitable mesh refinement frequency, depending on drawing size, number of modes, and/or maximum sweep frequency. :Returns: :ref:`bool ` ``True`` if automatic mesh is used, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: perform_erc Whether to perform an electrical rule check while generating the solver input. In some designs, the same net may be divided into multiple nets with separate names. These nets are connected at a "star" point. To simulate these nets, the error checking for DC shorts must be turned off. All overlapping nets are then internally united during simulation. :Returns: :ref:`bool ` ``True`` if perform erc is used, ``False`` otherwise. .. !! processed by numpydoc !! .. py:property:: mesh_frequency Mesh size based on the effective wavelength at the specified frequency. :Returns: :class:`python:str` .. .. !! processed by numpydoc !! Attribute detail ---------------- .. py:attribute:: defaults .. py:attribute:: si_defaults .. py:attribute:: pi_defaults Method detail ------------- .. py:method:: set_si_slider(value) .. py:method:: set_pi_slider(value)