pyaedt.Hfss#

class pyaedt.Hfss(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 application interface.

This class allows you to create an interactive instance of HFSS and connect to an existing HFSS design or create a new HFSS design if one does not exist.

Parameters:
projectnamestr, optional

Name of the project to select or the full path to the project or AEDTZ archive to open. 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. This parameter is ignored when a script is launched within AEDT.

non_graphicalbool, optional

Whether to run 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 False. This parameter is ignored when a script is launched within AEDT.

close_on_exitbool, optional

Whether to release AEDT on exit. The default is False.

student_versionbool, optional

Whether to open the AEDT student version. The default is False. This parameter is ignored when a script is launched within AEDT.

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 instance of HFSS and connect to an existing HFSS design or create a new HFSS design if one does not exist.

>>> from pyaedt import Hfss
>>> hfss = Hfss()
pyaedt info: No project is defined...
pyaedt info: Active design is set to...

Create an instance of HFSS and link to a project named HfssProject. If this project does not exist, create one with this name.

>>> hfss = Hfss("HfssProject")
pyaedt info: Project HfssProject has been created.
pyaedt info: No design is present. Inserting a new design.
pyaedt info: Added design ...

Create an instance of HFSS and link to a design named HfssDesign1 in a project named HfssProject.

>>> hfss = Hfss("HfssProject","HfssDesign1")
pyaedt info: Added design 'HfssDesign1' of type HFSS.

Create an instance of HFSS and open the specified project, which is named "myfile.aedt".

>>> hfss = Hfss("myfile.aedt")
pyaedt info: Project myfile has been created.
pyaedt info: No design is present. Inserting a new design.
pyaedt info: Added design...

Create an instance of HFSS using the 2021 R1 release and open the specified project, which is named "myfile2.aedt".

>>> hfss = Hfss(specified_version="2021.2", projectname="myfile2.aedt")
pyaedt info: Project myfile2 has been created.
pyaedt info: No design is present. Inserting a new design.
pyaedt info: Added design...

Create an instance of HFSS using the 2021 R2 student version and open the specified project, which is named "myfile3.aedt".

>>> hfss = Hfss(specified_version="2021.2", projectname="myfile3.aedt", student_version=True)
pyaedt info: Project myfile3 has been created.
pyaedt info: No design is present. Inserting a new design.
pyaedt info: Added design...

Methods

Hfss.SARSetup(Tissue_object_List_ID[, ...])

Define SAR settings.

Hfss.activate_variable_optimization(...[, ...])

Activate optimization analysis for a variable and optionally set up ranges.

Hfss.activate_variable_sensitivity(variable_name)

Activate sensitivity analysis for a variable and optionally set up ranges.

Hfss.activate_variable_statistical(variable_name)

Activate statitistical analysis for a variable and optionally set up ranges.

Hfss.activate_variable_tuning(variable_name)

Activate tuning analysis for a variable and optionally set up ranges.

Hfss.add_3d_component_array_from_json(json_file)

Add/edit a new 3d Component Array from json file.

Hfss.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.

Hfss.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.

Hfss.add_stackup_3d()

Create a stackup 3D object.

Hfss.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.

Hfss.analyse_nominal()

Solve the nominal design.

Hfss.analyze_all()

Analyze all setups in a design.

Hfss.analyze_from_initial_mesh()

Revert the solution to the initial mesh and re-run the solve.

Hfss.analyze_nominal([num_cores, num_tasks, ...])

Solve the nominal design.

Hfss.analyze_setup(name[, num_cores, ...])

Analyze a design setup.

Hfss.archive_project([project_file, ...])

Archive the AEDT project and add a message.

Hfss.assig_voltage_source_to_sheet(sheet_name)

Create a voltage source taking one sheet.

Hfss.assign_coating(obj[, mat, cond, perm, ...])

Assign finite conductivity to one or more objects of a given material.

Hfss.assign_current_source_to_sheet(sheet_name)

Create a current source taking one sheet.

Hfss.assign_impedance_to_sheet(sheet_name[, ...])

Create an impedance taking one sheet.

Hfss.assign_lattice_pair(face_couple[, ...])

Assign a lattice pair to a couple of faces.

Hfss.assign_lumped_rlc_to_sheet(sheet_name)

Create a lumped RLC taking one sheet.

Hfss.assign_material(obj, mat)

Assign a material to one or more objects.

Hfss.assign_perfecte_to_sheets(sheet_list[, ...])

Create a Perfect E taking one sheet.

Hfss.assign_perfecth_to_sheets(sheet_list[, ...])

Assign a Perfect H to sheets.

Hfss.assign_primary(face, u_start, u_end[, ...])

Assign the primary boundary condition.

Hfss.assign_radiation_boundary_to_faces(faces_id)

Assign a radiation boundary to one or more faces.

Hfss.assign_radiation_boundary_to_objects(...)

Assign a radiation boundary to one or more objects (usually airbox objects).

Hfss.assign_secondary(face, primary_name, ...)

Assign the secondary boundary condition.

Hfss.assign_voltage_source_to_sheet(sheet_name)

Create a voltage source taking one sheet.

Hfss.assigncoating(obj[, mat, cond, perm, ...])

Assign finite conductivity to one or more objects of a given material.

Hfss.assignmaterial_from_sherlock_files(...)

Assign material to objects in a design based on a CSV file obtained from Sherlock.

Hfss.auto_assign_lattice_pairs(object_to_assign)

Assign lattice pairs to a geometry automatically.

Hfss.autosave_disable()

Disable autosave in AEDT.

Hfss.autosave_enable()

Enable autosave in AEDT.

Hfss.change_automatically_use_causal_materials([...])

Enable or disable the automatic use of causal materials for lossy dielectrics.

Hfss.change_design_settings(settings)

Set Design Settings.

Hfss.change_material_override([...])

Enable or disable the material override in the project.

Hfss.change_validation_settings([...])

Update the validation design settings.

Hfss.check_beta_option_enabled(beta_option_name)

Check if a beta option is enabled.

Hfss.clean_proj_folder([directory, name])

Delete a project folder.

Hfss.cleanup_solution([variations, ...])

Delete a set of Solution Variations or part of them.

Hfss.close_desktop()

Close AEDT and release it.

Hfss.close_project([name, saveproject])

Close an AEDT project.

Hfss.copy_design_from(project_fullname, ...)

Copy a design from a project into the active design.

Hfss.copy_project(path, dest)

Copy the project to another destination.

Hfss.copy_solid_bodies_from(design[, ...])

Copy a list of objects from one design to the active design.

Hfss.create_boundary([boundary_type, ...])

Create a boundary given specific inputs.

Hfss.create_circuit_port_between_objects(...)

Create a circuit port taking the closest edges of two objects.

Hfss.create_circuit_port_from_edges(...[, ...])

Create a circuit port from two edges.

Hfss.create_current_source_from_objects(...)

Create a current source taking the closest edges of two objects.

Hfss.create_dataset(dsname, xlist, ylist[, ...])

Create a dataset.

Hfss.create_dataset1d_design(dsname, xlist, ...)

Create a design dataset.

Hfss.create_dataset1d_project(dsname, xlist, ...)

Create a project dataset.

Hfss.create_dataset3d(dsname, xlist, ylist)

Create a 3D dataset.

Hfss.create_floquet_port(face[, ...])

Create a floquet port on a face.

Hfss.create_frequency_sweep(setupname[, ...])

Create a frequency sweep.

Hfss.create_impedance_between_objects(...[, ...])

Create an impedance taking the closest edges of two objects.

Hfss.create_linear_count_sweep(setupname, ...)

Create a sweep with a specified number of points.

Hfss.create_linear_step_sweep(setupname, ...)

Create a sweep with a specified frequency step.

Hfss.create_lumped_port_between_objects(...)

Create a lumped port taking the closest edges of two objects.

Hfss.create_lumped_port_to_sheet(sheet_name)

Create a lumped port taking one sheet.

Hfss.create_lumped_rlc_between_objects(...)

Create a lumped RLC taking the closest edges of two objects.

Hfss.create_new_project(proj_name)

Create a project within AEDT.

Hfss.create_open_region([Frequency, ...])

Create an open region on the active editor.

Hfss.create_output_variable(variable, expression)

Create or modify an output variable.

Hfss.create_perfecte_from_objects(startobj, ...)

Create a Perfect E taking the closest edges of two objects.

Hfss.create_perfecth_from_objects(startobj, ...)

Create a Perfect H taking the closest edges of two objects.

Hfss.create_qfactor_report(project_dir, ...)

Export a CSV file of the EigenQ plot.

Hfss.create_sbr_antenna([antenna_type, ...])

Create a parametric beam antenna in SBR+.

Hfss.create_sbr_chirp_i_doppler_setup([...])

Create an SBR+ Chirp I Setup.

Hfss.create_sbr_chirp_iq_doppler_setup([...])

Create an SBR+ Chirp IQ Setup.

Hfss.create_sbr_file_based_antenna(ffd_full_path)

Create a linked antenna.

Hfss.create_sbr_linked_antenna(source_object)

Create a linked antenna.

Hfss.create_sbr_pulse_doppler_setup([...])

Create an SBR+ pulse Doppler setup.

Hfss.create_sbr_radar_from_json(radar_file, ...)

Create an SBR+ radar from a JSON file.

Hfss.create_scattering([plot_name, ...])

Create a scattering report.

Hfss.create_setup([setupname, setuptype, props])

Create a setup.

Hfss.create_single_point_sweep(setupname, ...)

Create a sweep with a single frequency point.

Hfss.create_source_excitation(sheet_name, ...)

Create a source excitation.

Hfss.create_spiral_lumped_port(start_object, ...)

Create a spiral lumped port between two adjacent objects.

Hfss.create_voltage_source_from_objects(...)

Create a voltage source taking the closest edges of two objects.

Hfss.create_wave_port_between_objects(...[, ...])

Create a waveport taking the closest edges of two objects.

Hfss.create_wave_port_from_sheet(sheet[, ...])

Create a waveport on sheet objects created starting from sheets.

Hfss.create_wave_port_microstrip_between_objects(...)

Create a waveport taking the closest edges of two objects.

Hfss.dataset_exists(name[, is_project_dataset])

Check if a dataset exists.

Hfss.deactivate_variable_optimization(...)

Deactivate the optimization analysis for a variable.

Hfss.deactivate_variable_sensitivity(...)

Deactivate the sensitivity analysis for a variable.

Hfss.deactivate_variable_statistical(...)

Deactivate the statistical analysis for a variable.

Hfss.deactivate_variable_tuning(variable_name)

Deactivate the tuning analysis for a variable.

Hfss.delete_design([name, fallback_design])

Delete a design from the current project.

Hfss.delete_project(project_name)

Delete a project.

Hfss.delete_separator(separator_name)

Delete a separator from either the active project or a design.

Hfss.delete_setup(setupname)

Delete a setup.

Hfss.delete_variable(sVarName)

Delete a variable.

Hfss.design_variation([variation_string])

Generate a string to specify a desired variation.

Hfss.duplicate_design(label[, ...])

Copy a design to a new name.

Hfss.edit_setup(setupname, properties_dict)

Modify a setup.

Hfss.edit_source([portandmode, powerin, phase])

Set up the power loaded for Hfss Post-Processing.

Hfss.edit_sources(excitations[, ...])

Set up the power loaded for Hfss Post-Processing in multiple sources simultaneously.

Hfss.evaluate_expression(expression_string)

Evaluate a valid string expression and return the numerical value in SI units.

Hfss.export3DModel(fileName, filePath[, ...])

Export the 3D model.

Hfss.export_3d_model(fileName, filePath[, ...])

Export the 3D model.

Hfss.export_convergence(setup_name[, ...])

Export a solution convergence to a file.

Hfss.export_design_preview_to_jpg(filename)

Export design preview image to a JPG file.

Hfss.export_mesh_stats(setup_name[, ...])

Export mesh statistics to a file.

Hfss.export_parametric_results(sweepname, ...)

Export a list of all parametric variations solved for a sweep to a CSV file.

Hfss.export_profile(setup_name[, ...])

Export a solution profile to a PROF file.

Hfss.export_results([analyze, export_folder])

Export all available reports to a file, including sNp, profile, and convergence.

Hfss.export_touchstone([solution_name, ...])

Export the Touchstone file to a local folder.

Hfss.export_variables_to_csv(filename[, ...])

Export design properties, project variables, or both to a CSV file.

Hfss.generate_temp_project_directory(subdir_name)

Generate a unique directory string to save a project to.

Hfss.generate_unique_setup_name([setup_name])

Generate a new setup with an unique name.

Hfss.get_all_conductors_names()

Retrieve all conductors in the active design.

Hfss.get_all_dielectrics_names()

Retrieve all dielectrics in the active design.

Hfss.get_all_sources()

Retrieve all setup sources.

Hfss.get_antenna_ffd_solution_data(frequencies)

Export Antenna Parameters to ffd files and return the FfdSolutionData object.

Hfss.get_components3d_vars(component3dname)

Read the A3DCOMP file and check for variables.

Hfss.get_evaluated_value(variable_name[, units])

Retrieve the evaluated value of a design property or project variable in SI units if no unit is provided.

Hfss.get_excitations_name()

Get all excitation names.

Hfss.get_module(module_name)

Aedt Module object.

Hfss.get_nominal_variation()

Retrieve the nominal variation.

Hfss.get_object_material_properties([...])

Retrieve the material properties for a list of objects and return them in a dictionary.

Hfss.get_oo_name(aedt_object[, object_name])

Return the Object Oriented AEDT Properties names.

Hfss.get_oo_object(aedt_object, object_name)

Return the Object Oriented AEDT Object.

Hfss.get_oo_properties(aedt_object, object_name)

Return the Object Oriented AEDT Object Properties.

Hfss.get_oo_property_value(aedt_object, ...)

Return the Object Oriented AEDT Object Properties.

Hfss.get_output_variable(variable[, solution])

Retrieve the value of the output variable.

Hfss.get_property_value(objectname, property)

Retrieve a property value.

Hfss.get_registry_key_int(key_full_name)

Get the value for the AEDT registry key if one exists.

Hfss.get_registry_key_string(key_full_name)

Get the value for the AEDT registry key if one exists.

Hfss.get_setup(setupname)

Get the setup from the current design.

Hfss.get_setups()

Retrieve setups.

Hfss.get_sweeps(name)

Retrieve all sweeps for a setup.

Hfss.get_traces_for_plot([get_self_terms, ...])

Retrieve a list of traces of specified designs ready to use in plot reports.

Hfss.hidden_variable(variable_name[, value])

Set the variable to a hidden or unhidden variable.

Hfss.import_dataset1d(filename[, dsname, ...])

Import a 1D dataset.

Hfss.import_dataset3d(filename[, dsname, ...])

Import a 3D dataset.

Hfss.insert_design([design_name, solution_type])

Add a design of a specified type.

Hfss.insert_infinite_sphere([definition, ...])

Create an infinite sphere.

Hfss.list_of_variations([setup_name, sweep_name])

Retrieve a list of active variations for input setup.

Hfss.load_project(project_file[, ...])

Open an AEDT project based on a project and optional design.

Hfss.plot([objects, show, export_path, ...])

Plot the model or a subset of objects.

Hfss.read_design_data()

Read back the design data as a dictionary.

Hfss.read_only_variable(variable_name[, value])

Set the variable to a read-only or not read-only variable.

Hfss.release_desktop([close_projects, ...])

Release AEDT.

Hfss.rename_design(new_name)

Rename the active design.

Hfss.sar_setup(Tissue_object_List_ID[, ...])

Define SAR settings.

Hfss.save_project([project_file, overwrite, ...])

Save the project and add a message.

Hfss.set_active_design(name)

Change the active design to another design.

Hfss.set_active_dso_config_name([...])

Change a specific registry key to a new value.

Hfss.set_auto_open([enable, boundary_type])

Set the HFSS auto open type.

Hfss.set_differential_pair(...[, ...])

Add a differential pair definition.

Hfss.set_export_touchstone(activate[, ...])

Set automatic export of the Touchstone file after simulation.

Hfss.set_license_type([license_type])

Change the license type between "Pack" and "Pool".

Hfss.set_registry_from_file(registry_file[, ...])

Apply desktop registry settings from an ACT file.

Hfss.set_registry_key(key_full_name, key_value)

Change a specific registry key to a new value.

Hfss.set_sbr_current_sources_options([...])

Set SBR+ setup options for the current source.

Hfss.set_sbr_txrx_settings(txrx_settings)

Set SBR+ TX RX antenna settings.

Hfss.set_source_context(sources[, ...])

Set the source context.

Hfss.solve_in_batch([filename, machine, ...])

Analyze a design setup in batch mode.

Hfss.submit_job(clustername[, ...])

Submit a job to be solved on a cluster.

Hfss.thicken_port_sheets(inputlist, value[, ...])

Create thickened sheets over a list of input port sheets.

Hfss.validate_full_design([dname, ...])

Validate a design based on an expected value and save information to the log file.

Hfss.validate_simple([logfile])

Validate a design.

Hfss.value_with_units(value[, units])

Combine a number and a string containing the unit in a single string e.g.

Attributes

Hfss.aedt_version_id

AEDT version.

Hfss.analysis_setup

Analysis setup.

Hfss.available_variations

Available variation object.

Hfss.boundaries

Design boundaries and excitations.

Hfss.components3d

3D components.

Hfss.composite

HFSS composite mode for the active solution.

Hfss.configurations

Property to import and export configuration files.

Hfss.default_solution_type

Default solution type.

Hfss.design_datasets

Dictionary of Design Datasets.

Hfss.design_list

Design list.

Hfss.design_name

Design name.

Hfss.design_properties

Design properties.

Hfss.design_type

Design type.

Hfss.desktop_install_dir

AEDT installation directory.

Hfss.excitations

Get all excitation names.

Hfss.existing_analysis_setups

Existing analysis setups.

Hfss.existing_analysis_sweeps

Existing analysis sweeps.

Hfss.field_setups

List of AEDT Radiation Fields.

Hfss.hybrid

HFSS hybrid mode for the active solution.

Hfss.layouteditor

Return the Circuit Layout Editor.

Hfss.library_list

Library list.

Hfss.lock_file

Lock file.

Hfss.logger

Logger for the design.

Hfss.materials

Materials in the project.

Hfss.mesh

Mesh.

Hfss.modeler

Modeler.

Hfss.native_components

Native Component dictionary.

Hfss.nominal_adaptive

Nominal adaptive sweep.

Hfss.nominal_sweep

Nominal sweep.

Hfss.o_component_manager

Component manager object.

Hfss.o_maxwell_parameters

AEDT Maxwell Parameter Setup Object.

Hfss.o_model_manager

Model manager object.

Hfss.o_symbol_manager

Aedt Simbol Manager.

Hfss.oanalysis

Analysis AEDT Module.

Hfss.oboundary

Boundary Object.

Hfss.odefinition_manager

Definition Manager Module.

Hfss.odesign

Design.

Hfss.odesktop

AEDT instance containing all projects and designs.

Hfss.oeditor

Oeditor Module.

Hfss.oexcitation

Solution Module.

Hfss.ofieldsreporter

Fields reporter.

Hfss.oimport_export

Import/Export Manager Module.

Hfss.omaterial_manager

Material Manager Module.

Hfss.omatrix

Matrix Object.

Hfss.omeshmodule

Icepak Mesh Module.

Hfss.omodelsetup

AEDT Model Setup Object.

Hfss.omonitor

AEDT Monitor Object.

Hfss.ooptimetrics

AEDT Optimetrics Module.

Hfss.ooutput_variable

AEDT Output Variable Module.

Hfss.opadstackmanager

AEDT oPadstackManager.

Hfss.oproject

Project property.

Hfss.oradfield

AEDT Radiation Field Object.

Hfss.oreportsetup

Report setup.

Hfss.osolution

Solution Module.

Hfss.output_variables

List of output variables.

Hfss.personallib

PersonalLib directory.

Hfss.post

PostProcessor.

Hfss.project_datasets

Dictionary of Project Datasets.

Hfss.project_file

Project name and path.

Hfss.project_list

Project list.

Hfss.project_name

Project name.

Hfss.project_path

Project path.

Hfss.project_properies

Project properties.

Hfss.project_time_stamp

Return Project time stamp.

Hfss.project_timestamp_changed

Return a bool if time stamp changed or not.

Hfss.pyaedt_dir

PyAEDT directory.

Hfss.results_directory

Results directory.

Hfss.setup_names

Setup names.

Hfss.solution_type

Solution type.

Hfss.src_dir

Source directory for Python.

Hfss.syslib

SysLib directory.

Hfss.temp_directory

Path to the temporary directory.

Hfss.toolkit_directory

Path to the toolkit directory.

Hfss.userlib

UserLib directory.

Hfss.valid_design

Valid design.

Hfss.variable_manager

Variable manager for creating and managing project design and postprocessing variables.

Hfss.working_directory

Path to the working directory.