pyaedt.Hfss3dLayout#

class pyaedt.Hfss3dLayout(projectname=None, designname=None, solution_type=None, setup_name=None, specified_version=None, non_graphical=False, new_desktop_session=False, close_on_exit=False, student_version=False, machine='', port=0, aedt_process_id=None)[source]#

Provides the HFSS 3D Layout application interface.

This class inherits all objects that belong to HFSS 3D Layout, including EDB API queries.

Parameters:

projectnamestr, optional: Name of the project to select or the full path to the project or AEDTZ archive to open or the path to aedb folder or edb.def file. The default is None, in which case an attempt is made to get an active project. If no projects are present, an empty project is created.
designnamestr, optional: Name of the design to select. The default is None, in which case an attempt is made to get an active design. If no designs are present, an empty design is created.
solution_typestr, optional: Solution type to apply to the design. The default is None, in which case the default type is applied.
setup_namestr, optional: Name of the setup to use as the nominal. The default is None, in which case the active setup is used or nothing is used.
specified_versionstr, optional: Version of AEDT to use. The default is None, in which case the active version or latest installed version is used.
non_graphicalbool, optional: Whether to launch AEDT in non-graphical mode. The default is False`, in which case AEDT is launched in graphical mode. This parameter is ignored when a script is launched within AEDT.
new_desktop_sessionbool, optional: Whether to launch an instance of AEDT in a new thread, even if another instance of the specified_version is active on the machine. The default is True.
close_on_exitbool, optional: Whether to release AEDT on exit.
student_versionbool, optional: Whether to open the AEDT student version. The default is False.
machinestr, optional: Machine name to which connect the oDesktop Session. Works only on 2022R2. Remote Server must be up and running with command “ansysedt.exe -grpcsrv portnum”. If machine is “localhost” the server will also start if not present.
portint, optional: Port number of which start the oDesktop communication on already existing server. This parameter is ignored in new server creation. It works only on 2022R2. Remote Server must be up and running with command “ansysedt.exe -grpcsrv portnum”.
aedt_process_idint, optional: Only used when new_desktop_session = False, specifies by process ID which instance of Electronics Desktop to point PyAEDT at.

Examples

Create an Hfss3dLayout object and connect to an existing HFSS design or create a new HFSS design if one does not exist.

>>> from pyaedt import Hfss3dLayout
>>> aedtapp = Hfss3dLayout()

Create an Hfss3dLayout object and link to a project named projectname. If this project does not exist, create one with this name.

>>> aedtapp = Hfss3dLayout(projectname)

Create an Hfss3dLayout object and link to a design named designname in a project named projectname.

>>> aedtapp = Hfss3dLayout(projectname,designame)

Create an Hfss3dLayout object and open the specified project.

>>> aedtapp = Hfss3dLayout("myfile.aedt")

Create an AEDT 2021 R1 object and then create a Hfss3dLayout object and open the specified project.

>>> aedtapp = Hfss3dLayout(specified_version="2021.2", projectname="myfile.aedt")

Methods

`Hfss3dLayout.activate_variable_optimization`(...)	Activate optimization analysis for a variable and optionally set up ranges.
`Hfss3dLayout.activate_variable_sensitivity`(...)	Activate sensitivity analysis for a variable and optionally set up ranges.
`Hfss3dLayout.activate_variable_statistical`(...)	Activate statitistical analysis for a variable and optionally set up ranges.
`Hfss3dLayout.activate_variable_tuning`(...[, ...])	Activate tuning analysis for a variable and optionally set up ranges.
`Hfss3dLayout.add_error_message`(message_text)	Add a type 0 "Error" message to either the global, active project, or active design level of the message mmanager tree.
`Hfss3dLayout.add_info_message`(message_text)	Add a type 0 "Info" message to either the global, active project, or active design level of the message manager tree.
`Hfss3dLayout.add_warning_message`(message_text)	Add a type 0 "Warning" message to either the global, active project, or active design level of the message manager tree.
`Hfss3dLayout.analyse_nominal`()	Solve the nominal design.
`Hfss3dLayout.analyze_all`()	Analyze all setups in a design.
`Hfss3dLayout.analyze_from_initial_mesh`()	Revert the solution to the initial mesh and re-run the solve.
`Hfss3dLayout.analyze_nominal`([num_cores, ...])	Solve the nominal design.
`Hfss3dLayout.analyze_setup`(name[, ...])	Analyze a design setup.
`Hfss3dLayout.archive_project`([project_file, ...])	Archive the AEDT project and add a message.
`Hfss3dLayout.autosave_disable`()	Disable autosave in AEDT.
`Hfss3dLayout.autosave_enable`()	Enable autosave in AEDT.
`Hfss3dLayout.change_automatically_use_causal_materials`([...])	Enable or disable the automatic use of causal materials for lossy dielectrics.
`Hfss3dLayout.change_design_settings`(settings)	Set Design Settings.
`Hfss3dLayout.change_material_override`([...])	Enable or disable the material override in the project.
`Hfss3dLayout.change_validation_settings`([...])	Update the validation design settings.
`Hfss3dLayout.check_beta_option_enabled`(...)	Check if a beta option is enabled.
`Hfss3dLayout.clean_proj_folder`([directory, name])	Delete a project folder.
`Hfss3dLayout.close_desktop`()	Close AEDT and release it.
`Hfss3dLayout.close_project`([name, saveproject])	Close an AEDT project.
`Hfss3dLayout.copy_design_from`(...)	Copy a design from a project into the active design.
`Hfss3dLayout.copy_project`(path, dest)	Copy the project to another destination.
`Hfss3dLayout.create_coax_port`(vianame, ...)	Create a new coax port.
`Hfss3dLayout.create_dataset`(dsname, xlist, ylist)	Create a dataset.
`Hfss3dLayout.create_dataset1d_design`(dsname, ...)	Create a design dataset.
`Hfss3dLayout.create_dataset1d_project`(...[, ...])	Create a project dataset.
`Hfss3dLayout.create_dataset3d`(dsname, xlist, ...)	Create a 3D dataset.
`Hfss3dLayout.create_edge_port`(...[, ...])	Create an edge port.
`Hfss3dLayout.create_frequency_sweep`(...[, ...])	Create a frequency sweep.
`Hfss3dLayout.create_linear_count_sweep`(...)	Create a sweep with the specified number of points.
`Hfss3dLayout.create_linear_step_sweep`(...[, ...])	Create a sweep with the specified frequency step.
`Hfss3dLayout.create_new_project`(proj_name)	Create a project within AEDT.
`Hfss3dLayout.create_output_variable`(...[, ...])	Create or modify an output variable.
`Hfss3dLayout.create_pin_port`(name[, xpos, ...])	Create a pin port.
`Hfss3dLayout.create_scattering`([plot_name, ...])	Create a scattering report.
`Hfss3dLayout.create_setup`([setupname, ...])	Create a setup.
`Hfss3dLayout.create_single_point_sweep`(...)	Create a sweep with a single frequency point.
`Hfss3dLayout.create_wave_port_from_two_conductors`([...])	Create a wave port.
`Hfss3dLayout.dataset_exists`(name[, ...])	Check if a dataset exists.
`Hfss3dLayout.deactivate_variable_optimization`(...)	Deactivate the optimization analysis for a variable.
`Hfss3dLayout.deactivate_variable_sensitivity`(...)	Deactivate the sensitivity analysis for a variable.
`Hfss3dLayout.deactivate_variable_statistical`(...)	Deactivate the statistical analysis for a variable.
`Hfss3dLayout.deactivate_variable_tuning`(...)	Deactivate the tuning analysis for a variable.
`Hfss3dLayout.delete_design`([name, ...])	Delete a design from the current project.
`Hfss3dLayout.delete_port`(portname)	Delete a port.
`Hfss3dLayout.delete_project`(project_name)	Delete a project.
`Hfss3dLayout.delete_separator`(separator_name)	Delete a separator from either the active project or a design.
`Hfss3dLayout.delete_setup`(setupname)	Delete a setup.
`Hfss3dLayout.delete_variable`(sVarName)	Delete a variable.
`Hfss3dLayout.design_variation`([variation_string])	Generate a string to specify a desired variation.
`Hfss3dLayout.duplicate_design`(label[, ...])	Copy a design to a new name.
`Hfss3dLayout.edit_cosim_options`([...])	Edit cosimulation options.
`Hfss3dLayout.edit_setup`(setupname, ...)	Modify a setup.
`Hfss3dLayout.enable_rigid_flex`()	Enable/Disable the rigid flex of a board with bending if available.
`Hfss3dLayout.evaluate_expression`(...)	Evaluate a valid string expression and return the numerical value in SI units.
`Hfss3dLayout.export_3d_model`([file_name])	Export the Ecad model to an ACIS 3D File.
`Hfss3dLayout.export_convergence`(setup_name)	Export a solution convergence to a file.
`Hfss3dLayout.export_design_preview_to_jpg`(...)	Export design preview image to a JPG file.
`Hfss3dLayout.export_mesh_stats`(setup_name[, ...])	Export mesh statistics to a file.
`Hfss3dLayout.export_parametric_results`(...)	Export a list of all parametric variations solved for a sweep to a CSV file.
`Hfss3dLayout.export_profile`(setup_name[, ...])	Export a solution profile to a PROF file.
`Hfss3dLayout.export_results`([analyze, ...])	Export all available reports to a file, including sNp, profile, and convergence.
`Hfss3dLayout.export_touchstone`([...])	Export a Touchstone file.
`Hfss3dLayout.export_variables_to_csv`(filename)	Export design properties, project variables, or both to a CSV file.
`Hfss3dLayout.generate_temp_project_directory`(...)	Generate a unique directory string to save a project to.
`Hfss3dLayout.generate_unique_setup_name`([...])	Generate a new setup with an unique name.
`Hfss3dLayout.get_all_insertion_loss_list`([...])	Retrieve a list of all insertion losses from two lists of excitations (driver and receiver).
`Hfss3dLayout.get_all_return_loss_list`([...])	Retrieve a list of all return losses for a list of excitations.
`Hfss3dLayout.get_evaluated_value`(variable_name)	Retrieve the evaluated value of a design property or project variable in SI units if no unit is provided.
`Hfss3dLayout.get_fext_xtalk_list`([trlist, ...])	Retrieve a list of all the far end XTalks from two lists of exctitations (driver and receiver).
`Hfss3dLayout.get_module`(module_name)	Aedt Module object.
`Hfss3dLayout.get_next_xtalk_list`([trlist, ...])	Retrieve a list of all the near end XTalks from a list of excitations (driver and receiver).
`Hfss3dLayout.get_nominal_variation`()	Retrieve the nominal variation.
`Hfss3dLayout.get_object_material_properties`([...])	Retrieve the material properties for a list of objects and return them in a dictionary.
`Hfss3dLayout.get_oo_name`(aedt_object[, ...])	Return the Object Oriented AEDT Properties names.
`Hfss3dLayout.get_oo_object`(aedt_object, ...)	Return the Object Oriented AEDT Object.
`Hfss3dLayout.get_oo_properties`(aedt_object, ...)	Return the Object Oriented AEDT Object Properties.
`Hfss3dLayout.get_oo_property_value`(...)	Return the Object Oriented AEDT Object Properties.
`Hfss3dLayout.get_output_variable`(variable[, ...])	Retrieve the value of the output variable.
`Hfss3dLayout.get_registry_key_int`(key_full_name)	Get the value for the AEDT registry key if one exists.
`Hfss3dLayout.get_registry_key_string`(...)	Get the value for the AEDT registry key if one exists.
`Hfss3dLayout.get_setup`(setupname[, setuptype])	Retrieve a setup.
`Hfss3dLayout.get_setups`()	Retrieve setups.
`Hfss3dLayout.get_sweeps`(name)	Retrieve all sweeps for a setup.
`Hfss3dLayout.get_traces_for_plot`([...])	Retrieve a list of traces of specified designs ready to use in plot reports.
`Hfss3dLayout.hidden_variable`(variable_name)	Set the variable to a hidden or unhidden variable.
`Hfss3dLayout.import_awr`(input_file[, ...])	Import AWR Microwave Office file into HFSS 3D Layout and assign the stackup from an XML file if present.
`Hfss3dLayout.import_brd`(input_file[, ...])	Import brd into HFSS 3D Layout and assign the stackup from an XML file if present.
`Hfss3dLayout.import_dataset1d`(filename[, ...])	Import a 1D dataset.
`Hfss3dLayout.import_dataset3d`(filename[, ...])	Import a 3D dataset.
`Hfss3dLayout.import_dxf`(dxf_path[, ...])	Import DXf file into HFSS 3D Layout and assign the stackup from an XML file if present.
`Hfss3dLayout.import_edb`(edb_full_path)	Import EDB.
`Hfss3dLayout.import_gds`(gds_path[, ...])	Import GDS file into HFSS 3D Layout and assign the stackup from an XML file if present.
`Hfss3dLayout.import_gerber`(gerber_path[, ...])	Import Gerber zip into HFSS 3D Layout and assign the stackup from an XML file if present.
`Hfss3dLayout.import_ipc2581`(input_file[, ...])	Import IPC2581 file into HFSS 3D Layout and assign the stackup from an XML file if present.
`Hfss3dLayout.import_odb`(input_file[, ...])	Import ODB++ file into HFSS 3D Layout and assign the stackup from an XML file if present.
`Hfss3dLayout.insert_design`([design_name, ...])	Add a design of a specified type.
`Hfss3dLayout.list_of_variations`([...])	Retrieve a list of active variations for input setup.
`Hfss3dLayout.load_diff_pairs_from_file`(filename)	Load differtential pairs definition from file.
`Hfss3dLayout.load_project`(project_file[, ...])	Open an AEDT project based on a project and optional design.
`Hfss3dLayout.read_design_data`()	Read back the design data as a dictionary.
`Hfss3dLayout.read_only_variable`(variable_name)	Set the variable to a read-only or not read-only variable.
`Hfss3dLayout.release_desktop`([...])	Release AEDT.
`Hfss3dLayout.rename_design`(new_name)	Rename the active design.
`Hfss3dLayout.save_diff_pairs_to_file`(filename)	Save differtential pairs definition to file.
`Hfss3dLayout.save_project`([project_file, ...])	Save the project and add a message.
`Hfss3dLayout.set_active_design`(name)	Change the active design to another design.
`Hfss3dLayout.set_active_dso_config_name`([...])	Change a specific registry key to a new value.
`Hfss3dLayout.set_differential_pair`(...[, ...])	Add a differential pair definition.
`Hfss3dLayout.set_export_touchstone`(activate)	Export the Touchstone file automatically if the simulation is successful.
`Hfss3dLayout.set_license_type`([license_type])	Change the license type between `"Pack"` and `"Pool"`.
`Hfss3dLayout.set_registry_from_file`(...[, ...])	Apply desktop registry settings from an ACT file.
`Hfss3dLayout.set_registry_key`(key_full_name, ...)	Change a specific registry key to a new value.
`Hfss3dLayout.solve_in_batch`([filename, ...])	Analyze a design setup in batch mode.
`Hfss3dLayout.submit_job`(clustername[, ...])	Submit a job to be solved on a cluster.
`Hfss3dLayout.validate_full_design`([name, ...])	Validate the design based on the expected value and save the information in the log file.
`Hfss3dLayout.validate_simple`([logfile])	Validate a design.
`Hfss3dLayout.value_with_units`(value[, units])	Combine a number and a string containing the unit in a single string e.g.

Attributes

`Hfss3dLayout.aedt_version_id`	AEDT version.
`Hfss3dLayout.analysis_setup`	Analysis setup.
`Hfss3dLayout.available_variations`	Available variation object.
`Hfss3dLayout.boundaries`	Design boundaries and excitations.
`Hfss3dLayout.default_solution_type`	Default solution type.
`Hfss3dLayout.design_datasets`	Dictionary of Design Datasets.
`Hfss3dLayout.design_list`	Design list.
`Hfss3dLayout.design_name`	Design name.
`Hfss3dLayout.design_properties`	Design properties.
`Hfss3dLayout.design_type`	Design type.
`Hfss3dLayout.desktop_install_dir`	AEDT installation directory.
`Hfss3dLayout.excitations`	Excitation names.
`Hfss3dLayout.existing_analysis_setups`	Existing analysis setups in the design.
`Hfss3dLayout.existing_analysis_sweeps`	Existing analysis sweeps.
`Hfss3dLayout.get_all_sparameter_list`	List of all S parameters for a list of excitations.
`Hfss3dLayout.get_excitations_name`	Excitation names.
`Hfss3dLayout.layouteditor`	Return the Circuit Layout Editor.
`Hfss3dLayout.library_list`	Library list.
`Hfss3dLayout.lock_file`	Lock file.
`Hfss3dLayout.logger`	Logger for the design.
`Hfss3dLayout.materials`	Materials in the project.
`Hfss3dLayout.mesh`	Mesh.
`Hfss3dLayout.modeler`	Modeler object.
`Hfss3dLayout.native_components`	Native Component dictionary.
`Hfss3dLayout.nominal_adaptive`	Nominal adaptive sweep.
`Hfss3dLayout.nominal_sweep`	Nominal sweep.
`Hfss3dLayout.o_component_manager`	Component manager object.
`Hfss3dLayout.o_maxwell_parameters`	AEDT Maxwell Parameter Setup Object.
`Hfss3dLayout.o_model_manager`	Model manager object.
`Hfss3dLayout.o_symbol_manager`	Aedt Simbol Manager.
`Hfss3dLayout.oanalysis`	Analysis AEDT Module.
`Hfss3dLayout.oboundary`	Boundary Object.
`Hfss3dLayout.odefinition_manager`	Definition Manager Module.
`Hfss3dLayout.odesign`	Design.
`Hfss3dLayout.odesktop`	AEDT instance containing all projects and designs.
`Hfss3dLayout.oeditor`	Oeditor Module.
`Hfss3dLayout.oexcitation`	Solution Module.
`Hfss3dLayout.ofieldsreporter`	Fields reporter.
`Hfss3dLayout.oimport_export`	Import/Export Manager Module.
`Hfss3dLayout.omaterial_manager`	Material Manager Module.
`Hfss3dLayout.omatrix`	Matrix Object.
`Hfss3dLayout.omeshmodule`	Icepak Mesh Module.
`Hfss3dLayout.omodelsetup`	AEDT Model Setup Object.
`Hfss3dLayout.omonitor`	AEDT Monitor Object.
`Hfss3dLayout.ooptimetrics`	AEDT Optimetrics Module.
`Hfss3dLayout.ooutput_variable`	AEDT Output Variable Module.
`Hfss3dLayout.opadstackmanager`	AEDT oPadstackManager.
`Hfss3dLayout.oproject`	Project property.
`Hfss3dLayout.oradfield`	AEDT Radiation Field Object.
`Hfss3dLayout.oreportsetup`	Report setup.
`Hfss3dLayout.osolution`	Solution Module.
`Hfss3dLayout.output_variables`	List of output variables.
`Hfss3dLayout.personallib`	PersonalLib directory.
`Hfss3dLayout.port_list`	Port list.
`Hfss3dLayout.post`	PostProcessor.
`Hfss3dLayout.project_datasets`	Dictionary of Project Datasets.
`Hfss3dLayout.project_file`	Project name and path.
`Hfss3dLayout.project_list`	Project list.
`Hfss3dLayout.project_name`	Project name.
`Hfss3dLayout.project_path`	Project path.
`Hfss3dLayout.project_properies`	Project properties.
`Hfss3dLayout.project_time_stamp`	Return Project time stamp.
`Hfss3dLayout.project_timestamp_changed`	Return a bool if time stamp changed or not.
`Hfss3dLayout.pyaedt_dir`	PyAEDT directory.
`Hfss3dLayout.results_directory`	Results directory.
`Hfss3dLayout.setup_names`	Setup names.
`Hfss3dLayout.solution_type`	Solution type.
`Hfss3dLayout.src_dir`	Source directory for Python.
`Hfss3dLayout.syslib`	SysLib directory.
`Hfss3dLayout.temp_directory`	Path to the temporary directory.
`Hfss3dLayout.toolkit_directory`	Path to the toolkit directory.
`Hfss3dLayout.userlib`	UserLib directory.
`Hfss3dLayout.valid_design`	Valid design.
`Hfss3dLayout.variable_manager`	Variable manager for creating and managing project design and postprocessing variables.
`Hfss3dLayout.working_directory`	Path to the working directory.