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)[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 script is launched within AEDT.

NGbool, optional

Whether to run AEDT in the non-graphical mode. The default is False, in which case AEDT is launched in the graphical mode. This parameter is ignored when 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. This parameter is ignored when 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 script is launched within AEDT.

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_error_message(message_text[, …])

Add a type 0 “Error” message to either global, active project or active design level of the Message Manager tree.

Hfss.add_info_message(message_text[, …])

Add a type 0 “Info” message to either global, active project or active design level of the Message Manager tree.

Hfss.add_warning_message(message_text[, …])

Add a type 0 “Warning” message to either global, active project or active design level of the Message Manager tree.

Hfss.analyse_nominal()

Solve the nominal design.

Hfss.analyze_all()

Analyze all setup in an actual 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 specific 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 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 Secondary 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 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.auto_assign_lattice_pairs(object_to_assign)

Auto Assign Lattice Pairs to geometry.

Hfss.autosave_disable()

Disable the Desktop Autosave.

Hfss.autosave_enable()

Enable the Desktop Autosave.

Hfss.change_automatically_use_causal_materials([…])

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

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.close_desktop()

Close the desktop and release AEDT.

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 the 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 the desktop.

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 IQ 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_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 to the filter for thermal analysis.

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

Hfss.export_results([analyze, export_folder])

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

Hfss.export_touchstone(solutionname, sweepname)

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_components3d_vars(component3dname)

Read the A3DCOMP file and check for variables.

Hfss.get_evaluated_value(variable_name[, …])

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_nominal_variation()

Retrieve the nominal variation.

Hfss.get_object_material_properties([…])

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

Hfss.get_output_variable(variable)

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 Desktop Registry Key Value if exists, otherwise 0.

Hfss.get_registry_key_string(key_full_name)

Get Desktop Registry Key Value if exists, otherwise ‘’.

Hfss.get_setup(setupname)

Get the setup from the current design.

Hfss.get_setups()

Retrieve setups.

Hfss.get_sweeps(name)

Retrieve all sweep for a setup.

Hfss.insert_design([design_name])

Add a design of a specified type.

Hfss.insert_infinite_sphere([definition, …])

Create a new infinite Sphere.

Hfss.list_of_variations([setup_name, sweep_name])

Return list of active variation for input setup.

Hfss.load_project(project_file[, …])

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

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

Plot the model or a substet of objects.

Hfss.read_design_data()

Read back the design data as a dictionary.

Hfss.release_desktop([close_projects, …])

Release the desktop.

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 AEDT 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 new value.

Hfss.set_auto_open([enable, boundary_type])

Set Hfss auto open type.

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 acf file.

Hfss.set_registry_key(key_full_name, key_value)

Change a specific registry key to new value.

Hfss.set_sbr_current_sources_options([…])

Set Current Sources SBR+ Setup Options.

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.

Attributes

Hfss.aedt_version_id

AEDT version.

Hfss.analysis_setup

Analysis setup.

Hfss.available_variations

Available variation object.

Hfss.components3d

Components 3D.

Hfss.composite

Get/Set Hfss composite mode for the active solution.

Hfss.default_solution_type

Default solution type.

Hfss.design_list

Design list.

Hfss.design_name

Design name.

Hfss.design_properties

Design properties.

Hfss.design_type

Design type.

Hfss.desktop_install_dir

Desktop installation directory.

Hfss.existing_analysis_setups

Existing analysis setups.

Hfss.existing_analysis_sweeps

Existing analysis sweeps.

Hfss.hybrid

Get/Set Hfss hybrid mode for the active solution.

Hfss.library_list

Library list.

Hfss.lock_file

Lock file.

Hfss.logger

Logger for the Design.

Hfss.materials

Manages materials in the project.

Hfss.mesh

Mesh.

Hfss.modeler

Modeler.

Hfss.nominal_adaptive

Nominal adaptive sweep.

Hfss.nominal_sweep

Nominal sweep.

Hfss.oanalysis

Analysis AEDT Module.

Hfss.oboundary

Boundary Module.

Hfss.odefinition_manager

Definition Manager Module.

Hfss.odesign

Design.

Hfss.odesktop

Desktop instance containing all projects and designs.

Hfss.oimport_export

Import Export Manager Module.

Hfss.omaterial_manager

Material Manager Module.

Hfss.omodelsetup

AEDT Model Setup Object.

Hfss.ooptimetrics

Optimetrics AEDT Module.

Hfss.ooutput_variable

Output Variable AEDT Module.

Hfss.oproject

Property.

Hfss.oradfield

AEDT Radiation Field Object.

Hfss.osolution

Solution Module.

Hfss.output_variables

List of Output variables.

Hfss.personallib

PersonalLib directory.

Hfss.post

PostProcessor.

Hfss.project_file

Project file.

Hfss.project_list

Project list.

Hfss.project_name

Project name.

Hfss.project_path

Project path.

Hfss.project_properies

Project properties.

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.