EigenmodeSim

class EigenmodeSim(design: Optional[qiskit_metal.designs.design_base.QDesign] = None, renderer_name: str = 'hfss')

Compute eigenmode, then derive from it using the epr method.

Default Setup:

• name (str): Name of eigenmode setup. Defaults to “Setup”.

• min_freq_ghz (int): Minimum frequency in GHz. Defaults to 1.

• max_delta_f (float): Absolute value of maximum difference in

  frequency. Defaults to 0.5.

• max_passes (int): Maximum number of passes. Defaults to 10.

• min_passes (int): Minimum number of passes. Defaults to 1.

• min_converged (int): Minimum number of converged passes. Defaults to 1.

• pct_refinement (int): Percent refinement. Defaults to 30.

• basis_order (int): Basis order. Defaults to 1.

• vars (Dict): Variables (key) and values (value) to define in the renderer.

Data Labels:

• convergence_f (pd.DataFrame): Convergence of the eigenmode frequency.

• convergence_t (pd.DataFrame): Convergence of the eigenmode frequency.

Compute eigenmode, then derive from it using the epr method.

Parameters

• design (QDesign) – Pointer to the main qiskit-metal design. Used to access the QRenderer. Defaults to None.

• renderer_name (str, optional) – Which renderer to use. Defaults to ‘hfss’.

Attributes

EigenmodeSim.convergence_f	Getter
EigenmodeSim.convergence_t	Getter
EigenmodeSim.data_labels	Default data labels.
EigenmodeSim.default_setup	Default setup.
EigenmodeSim.logger	Returns the logger.
EigenmodeSim.renderer_initialized	Reports whether the renderer is initialized or stopped.
EigenmodeSim.setup	Dictionary intended to be used to modify the analysis behavior.
EigenmodeSim.sim_setup_name	Getter
EigenmodeSim.supported_data	Set that contains the names of the variables supported from the analysis.

Methods

EigenmodeSim.clear_data([data_name])	Clear data.
EigenmodeSim.clear_fields([names])	Delete field plots from renderer.
EigenmodeSim.close()	Stops the renderer by executing the routine of the selected renderer.
EigenmodeSim.compute_convergences([variation])	Convergence plots are computed as part of run().
EigenmodeSim.get_data([data_name])	Retrieves the analysis module data.
EigenmodeSim.get_data_labels()	Retrieves the list of data labels currently set.
EigenmodeSim.plot_convergences([...])	Creates 3 plots, useful to determin the convergence achieved by the renderer: * convergence frequency vs.
EigenmodeSim.plot_fields(object_name[, ...])	Plots electro(magnetic) fields in the renderer.
EigenmodeSim.print_run_args()	Prints the args and kwargs that were used in the last run() of this Analysis instance.
EigenmodeSim.run(*args, **kwargs)	Alias for run_sim() necessary to implement super-class method, while preventing method name collision when sim and non-sim QAnalysis classes are inherited.
EigenmodeSim.run_sim([name, components, ...])	Executes the entire eigenmode analysis and convergence result export.
EigenmodeSim.run_sweep(*args, **kwargs)	User requests sweeper based on arguments from Sweeper.run_sweep().
EigenmodeSim.save_run_args(**kwargs)	Intended to be used to store the kwargs passed to the run() method, for repeatability and for later identification of the QAnalysis instance.
EigenmodeSim.save_screenshot()	Saves the screenshot.
EigenmodeSim.select_renderer(renderer_name)	Makes sure the renderer exists in qiskit-metal.
EigenmodeSim.set_data(data_name, data)	Stores data in a structure for later retrieval.
EigenmodeSim.setup_update([section])	Intended to modify multiple setup settings at once, while retaining previous settings.
EigenmodeSim.start()	Starts the renderer by executing the routine of the selected renderer.