SetupHFSS

class ansys.aedt.core.modules.solve_setup.SetupHFSS(app, solution_type, name='MySetupAuto', is_new_setup=True)

Initializes, creates, and updates an HFSS setup.

Parameters:

appansys.aedt.core.application.analysis.Analysis

Inherited app object.

solution_typeint, str

Type of the setup.

namestr, optional

Name of the setup. The default is "MySetupAuto".

is_new_setupbool, optional

Whether to create the setup from a template. The default is True. If False, access is to the existing setup.

Methods

SetupHFSS.add_derivatives(derivative_list)	Add derivatives to the setup.
SetupHFSS.add_mesh_link(design[, solution, ...])	Import mesh from a source design solution to the target design.
SetupHFSS.add_sweep([name, sweep_type])	Add a sweep to the project.
SetupHFSS.analyze([cores, tasks, gpus, ...])	Solve the active design.
SetupHFSS.create()	Add a new setup based on class settings in AEDT.
SetupHFSS.create_frequency_sweep([unit, ...])	Create a sweep with the specified number of points.
SetupHFSS.create_linear_step_sweep([unit, ...])	Create a Sweep with a specified frequency step.
SetupHFSS.create_report([expressions, ...])	Create a report in AEDT.
SetupHFSS.create_single_point_sweep([unit, ...])	Create a Sweep with a single frequency point.
SetupHFSS.delete()	Delete actual Setup.
SetupHFSS.delete_sweep(name)	Delete a sweep.
SetupHFSS.disable([name])	Disable a setup.
SetupHFSS.enable([name])	Enable a setup.
SetupHFSS.enable_adaptive_setup_broadband(...)	Enable HFSS broadband setup.
SetupHFSS.enable_adaptive_setup_multifrequency(...)	Enable HFSS multi-frequency setup.
SetupHFSS.enable_adaptive_setup_single([...])	Enable HFSS single frequency setup.
SetupHFSS.enable_expression_cache(expressions)	Enable an expression cache.
SetupHFSS.get_derivative_variables()	Return Derivative Enabled variables.
SetupHFSS.get_profile()	Solution profile.
SetupHFSS.get_solution_data([expressions, ...])	Get a simulation result from a solved setup and cast it in a SolutionData object.
SetupHFSS.get_sweep([name])	Return frequency sweep object of a given sweep.
SetupHFSS.get_sweep_names()	Get the names of all sweeps in a given analysis setup.
SetupHFSS.jsonalize_tree()	Create dictionary from the Binary Tree.
SetupHFSS.set_tuning_offset(offsets)	Set derivative variable to a specific offset value.
SetupHFSS.start_continue_from_previous_setup(...)	Start or continue from a previously solved setup.
SetupHFSS.suppress_all(app)	Activate suppress option for all the operations contained in the binary tree node.
SetupHFSS.unsuppress_all(app)	Disable suppress option for all the operations contained in the binary tree node.
SetupHFSS.update([properties])	Update the setup based on either the class argument or a dictionary.
SetupHFSS.update_property(prop_name, prop_value)	Update the property of the binary tree node.
SetupHFSS.use_matrix_convergence([...])	Enable Matrix Convergence criteria.

Attributes

SetupHFSS.available_properties	Available properties.
SetupHFSS.children
SetupHFSS.command	Command of the modeler hystory if available.
SetupHFSS.default_intrinsics	Retrieve default intrinsic for actual setup.
SetupHFSS.is_solved	Verify if solutions are available for given setup.
SetupHFSS.name	Name.
SetupHFSS.omodule	Analysis module.
SetupHFSS.p_app	Parent.
SetupHFSS.properties	Properties data.
SetupHFSS.props
SetupHFSS.sweeps