kqcircuits.simulations.export.ansys.ansys_solution
- class kqcircuits.simulations.export.ansys.ansys_solution.AnsysSolution(name: str = '', ansys_tool: str = 'hfss', frequency_units: str = 'GHz', frequency: float | List[float] = 5, max_delta_s: float = 0.1, max_delta_e: float = 0.1, percent_error: float = 1, percent_refinement: float = 30.0, maximum_passes: int = 12, minimum_passes: int = 1, minimum_converged_passes: int = 1, sweep_enabled: bool = True, sweep_start: float = 0, sweep_end: float = 10, sweep_count: int = 101, sweep_type: str = 'interpolating', max_delta_f: float = 0.1, n_modes: int = 2, mesh_size: dict | None = None, simulation_flags: List[str] | None = None, ansys_project_template: str | None = None, integrate_energies: bool = False, integrate_magnetic_flux: bool = False, hfss_capacitance_export: bool = False)[source]
Bases:
Solution
A Base class for Ansys Solution and export parameters
- Parameters:
ansys_tool – Determines whether to use ‘hfss’ (s-parameters), ‘q3d’, ‘current’, ‘voltage’, or ‘eigenmode’.
frequency_units – Units of frequency.
frequency – Frequency for mesh refinement. To set up multifrequency analysis in HFSS use list of numbers.
max_delta_s – Stopping criterion in HFSS simulation.
max_delta_e – Stopping criterion in current or voltage excitation simulation.
percent_error – Stopping criterion in Q3D simulation.
percent_refinement – Percentage of mesh refinement on each iteration.
maximum_passes – Maximum number of iterations in simulation.
minimum_passes – Minimum number of iterations in simulation.
minimum_converged_passes – Determines how many iterations have to meet the stopping criterion to stop simulation.
sweep_enabled – Determines if HFSS frequency sweep is enabled.
sweep_start – The lowest frequency in the sweep.
sweep_end – The highest frequency in the sweep.
sweep_count – Number of frequencies in the sweep.
sweep_type – choices are “interpolating”, “discrete” or “fast”
max_delta_f – Maximum allowed relative difference in eigenfrequency (%). Used when
ansys_tool
is eigenmode.n_modes – Number of eigenmodes to solve. Used when
ansys_tool
is ‘eigenmode’.mesh_size – Dictionary to determine manual mesh refinement on layers. Set key as the layer name and value as the maximal mesh element length inside the layer.
simulation_flags – Optional export processing, given as list of strings. See Simulation Export in docs.
ansys_project_template – path to the simulation template
integrate_energies – Calculate energy integrals over each layer and save them into a file
integrate_magnetic_flux – Integrate magnetic fluxes through each non-pec sheet and save them into a file
hfss_capacitance_export – If True, the capacitance matrices are exported from HFSS simulations
- ansys_tool: str = 'hfss'
- frequency_units: str = 'GHz'
- frequency: float | List[float] = 5
- max_delta_s: float = 0.1
- max_delta_e: float = 0.1
- percent_error: float = 1
- percent_refinement: float = 30.0
- maximum_passes: int = 12
- minimum_passes: int = 1
- minimum_converged_passes: int = 1
- sweep_enabled: bool = True
- sweep_start: float = 0
- sweep_end: float = 10
- sweep_count: int = 101
- sweep_type: str = 'interpolating'
- max_delta_f: float = 0.1
- n_modes: int = 2
- mesh_size: dict | None = None
- simulation_flags: List[str] | None = None
- ansys_project_template: str | None = None
- integrate_energies: bool = False
- integrate_magnetic_flux: bool = False
- hfss_capacitance_export: bool = False