Hfss#
- class ansys.aedt.core.hfss.Hfss(project=None, design=None, solution_type=None, setup=None, version=None, non_graphical=False, new_desktop=False, close_on_exit=False, student_version=False, machine='', port=0, aedt_process_id=None, remove_lock=False)#
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:
- project
str
,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.- design
str
,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_type
str
,optional
Solution type to apply to the design. The default is
None
, in which case the user-defined default type is applied. Options are:“Terminal”
“Modal”
“SBR+”
“Transient”
“Eigenmode”
- setup
str
,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.- version
str
,int
,float
,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. Examples of input values are232
,23.2
,``2023.2``,``”2023.2”``.- 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_desktopbool,
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 isFalse
. 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.- machine
str
,optional
Machine name to connect the oDesktop session to. This parameter works only on 2022 R2 or later. The remote Server must be up and running with the command “ansysedt.exe -grpcsrv portnum”. If the machine is “localhost”, the server starts if it is not present.
- port
int
,optional
Port number on which to start the oDesktop communication on an already existing server. This parameter is ignored when creating a new server. It works only in 2022 R2 or later. The remote server must be up and running with the command “ansysedt.exe -grpcsrv portnum”.
- aedt_process_id
int
,optional
Process ID for the instance of AEDT to point PyAEDT at. The default is
None
. This parameter is only used whennew_desktop = False
.- remove_lockbool,
optional
Whether to remove lock to project before opening it or not. The default is
False
, which means to not unlock the existing project if needed and raise an exception.
- project
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 ansys.aedt.core 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 namedHfssProject
.>>> 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 2023 R2 release and open the specified project, which is named
"myfile2.aedt"
.>>> hfss = Hfss(version=232, project="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 2023 R2 student version and open the specified project, which is named
"myfile3.aedt"
.>>> hfss = Hfss(version="2023.2", project="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.activate_variable_optimization
(name[, ...])Activate optimization analysis for a variable and optionally set up ranges.
Hfss.activate_variable_sensitivity
(name[, ...])Activate sensitivity analysis for a variable and optionally set up ranges.
Hfss.activate_variable_statistical
(name[, ...])Activate statitistical analysis for a variable and optionally set up ranges.
Hfss.activate_variable_tuning
(name[, ...])Activate tuning analysis for a variable and optionally set up ranges.
Hfss.add_3d_component_array_from_json
(input_data)Add or edit a 3D component array from a JSON file, TOML file, or dictionary.
Hfss.add_error_message
(text[, level])Add a type 0 "Error" message to either the global, active project, or active design level of the message mmanager tree.
Hfss.add_from_toolkit
(toolkit[, draw])Add a new toolkit to the current application.
Hfss.add_info_message
(text[, level])Add a type 0 "Info" message to either the global, active project, or active design level of the message manager tree.
Create a stackup 3D object.
Hfss.add_warning_message
(text[, level])Add a type 0 "Warning" message to either the global, active project, or active design level of the message manager tree.
Hfss.analyze
([setup, cores, tasks, gpus, ...])Solve the active design.
Hfss.analyze_setup
([name, cores, tasks, ...])Analyze a design setup.
Hfss.archive_project
([project_path, ...])Archive the AEDT project and add a message.
Hfss.assign_coating
(assignment[, material, ...])Assign finite conductivity to one or more objects or faces of a given material.
Hfss.assign_current_source_to_sheet
(assignment)Create a current source taking one sheet.
Hfss.assign_febi
(assignment[, name])Assign an FE-BI region to one or more objects.
Hfss.assign_hybrid_region
(assignment[, ...])Assign a hybrid region to one or more objects.
Hfss.assign_impedance_to_sheet
(assignment[, ...])Create an impedance taking one sheet.
Hfss.assign_lattice_pair
(assignment[, ...])Assign a lattice pair to a couple of faces.
Hfss.assign_lumped_rlc_to_sheet
(assignment)Create a lumped RLC taking one sheet.
Hfss.assign_material
(assignment, material)Assign a material to one or more objects.
Hfss.assign_perfecte_to_sheets
(assignment[, ...])Create a Perfect E taking one sheet.
Hfss.assign_perfecth_to_sheets
(assignment[, ...])Assign a Perfect H to sheets.
Hfss.assign_primary
(assignment, u_start, u_end)Assign the primary boundary condition.
Assign a radiation boundary to one or more faces.
Assign a radiation boundary to one or more objects (usually airbox objects).
Hfss.assign_secondary
(assignment, primary, ...)Assign the secondary boundary condition.
Hfss.assign_symmetry
(assignment[, name, ...])Assign symmetry to planar entities.
Hfss.assign_voltage_source_to_sheet
(assignment)Create a voltage source taking one sheet.
Assign material to objects in a design based on a CSV file obtained from Sherlock.
Hfss.auto_assign_lattice_pairs
(assignment[, ...])Assign lattice pairs to a geometry automatically.
Disable autosave in AEDT.
Enable autosave in AEDT.
Enable or disable the automatic use of causal materials for lossy dielectrics.
Hfss.change_design_settings
(settings)Set Design Settings.
Enable or disable the material override in the project.
Hfss.change_property
(aedt_object, tab_name, ...)Change a property.
Update the validation design settings.
Hfss.check_beta_option_enabled
(beta_option)Check if a beta option is enabled.
Hfss.check_if_project_is_loaded
(input_file)Check if a project path is already loaded in active Desktop.
Hfss.circuit_port
(assignment, reference[, ...])Create a circuit port from two objects.
Hfss.clean_proj_folder
([directory, name])Delete a project folder.
Hfss.cleanup_solution
([variations, ...])Delete a set of Solution Variations or part of them.
Close AEDT and release it.
Hfss.close_project
([name, save])Close an AEDT project.
Hfss.copy_design_from
(project, design[, ...])Copy a design from a project into the active project.
Hfss.copy_project
(destination, name)Copy the project to another destination.
Hfss.copy_solid_bodies_from
(design[, ...])Copy a list of objects and user defined models from one design to the active design.
Hfss.create_boundary
([boundary_type, ...])Assign a boundary condition to a sheet or surface. This method is generally
Create a current source taking the closest edges of two objects.
Hfss.create_dataset
(name, x, y[, z, v, ...])Create a dataset.
Hfss.create_dataset1d_design
(name, x, y[, ...])Create a design dataset.
Hfss.create_dataset1d_project
(name, x, y[, ...])Create a project dataset.
Hfss.create_dataset3d
(name, x, y[, z, v, ...])Create a 3D dataset.
Hfss.create_floquet_port
(assignment[, ...])Create a floquet port on a face.
Hfss.create_impedance_between_objects
(...[, ...])Create an impedance taking the closest edges of two objects.
Hfss.create_linear_count_sweep
(setup, units, ...)Create a sweep with a specified number of points.
Hfss.create_linear_step_sweep
(setup, unit, ...)Create a sweep with a specified frequency step.
Create a lumped RLC taking the closest edges of two objects.
Hfss.create_new_project
(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
(...[, ...])Create a Perfect E taking the closest edges of two objects.
Hfss.create_perfecth_from_objects
(...[, ...])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 antennas in SBR+.
Create an SBR+ Chirp I setup.
Create an SBR+ Chirp IQ setup.
Create custom array file with sarr format.
Hfss.create_sbr_file_based_antenna
(...[, ...])Create a linked antenna.
Hfss.create_sbr_linked_antenna
(assignment[, ...])Create a linked antennas.
Create an SBR+ pulse Doppler setup.
Hfss.create_sbr_radar_from_json
(radar_file, name)Create an SBR+ radar setup from a JSON file.
Hfss.create_scattering
([plot, sweep, ports, ...])Create an S-parameter report.
Hfss.create_setup
([name, setup_type])Create an analysis setup for HFSS.
Hfss.create_single_point_sweep
(setup, unit, freq)Create a sweep with a single frequency point.
Hfss.create_source_excitation
(assignment, ...)Create a source excitation.
Hfss.create_spiral_lumped_port
(assignment, ...)Create a spiral lumped port between two adjacent objects.
Create a voltage source taking the closest edges of two objects.
Hfss.dataset_exists
(name[, is_project_dataset])Check if a dataset exists.
Deactivate the optimization analysis for a variable.
Deactivate the sensitivity analysis for a variable.
Deactivate the statistical analysis for a variable.
Deactivate the tuning analysis for a variable.
Hfss.delete_design
([name, fallback_design])Delete a design from the current project.
Hfss.delete_project
(name)Delete a project.
Hfss.delete_separator
(name)Delete a separator from either the active project or a design.
Hfss.delete_setup
(name)Delete a setup.
Delete design and project unused variables.
Hfss.delete_variable
(name)Delete a variable.
Hfss.design_variation
([variation])Generate a string to specify a desired variation.
Hfss.duplicate_design
(name[, ...])Copy a design to a new name.
Hfss.edit_notes
(text)Edit notes.
Hfss.edit_setup
(name, properties)Modify a setup.
Hfss.edit_source_from_file
(input_file[, ...])Edit a source from file data.
Hfss.edit_sources
(assignment[, ...])Set up the power loaded for HFSS postprocessing in multiple sources simultaneously.
Hfss.evaluate_expression
(expression)Evaluate a valid string expression and return the numerical value in SI units.
Hfss.export_3d_model
([file_name, file_path, ...])Export the 3D model.
Hfss.export_antenna_metadata
(frequencies, ...)Export the element pattern.
Hfss.export_convergence
(setup[, variations, ...])Export a solution convergence to a file.
Hfss.export_design_preview_to_jpg
(output_file)Export design preview image to a JPG file.
Hfss.export_element_pattern
(frequencies, ...)Export the element pattern.
Hfss.export_mesh_stats
(setup[, variations, ...])Export mesh statistics to a file.
Hfss.export_parametric_results
(sweep, ...[, ...])Export a list of all parametric variations solved for a sweep to a CSV file.
Hfss.export_profile
(setup[, variation, ...])Export a solution profile to a PROF file.
Hfss.export_results
([analyze, ...])Export all available reports to a file, including profile, and convergence and sNp when applicable.
Hfss.export_rl_matrix
(matrix_name, output_file)Export R/L matrix after solving.
Hfss.export_touchstone
([setup, sweep, ...])Export a Touchstone file.
Enable or disable the automatic export of the touchstone file after completing frequency sweep.
Hfss.export_variables_to_csv
(output_file[, ...])Export design properties, project variables, or both to a CSV file.
Hfss.flatten_3d_components
([components, ...])Flatten one or multiple 3d components in the actual layout.
Generate a unique directory string to save a project to.
Hfss.generate_unique_setup_name
([name])Generate a new setup with a unique name.
Retrieve all conductors in the active design.
Retrieve all dielectrics in the active design.
Hfss.get_all_insertion_loss_list
([drivers, ...])Get a list of all insertion losses from two lists of excitations (driver and receiver).
Hfss.get_all_return_loss_list
([excitations, ...])Get a list of all return losses for a list of excitations.
Retrieve all source modes.
Retrieve all setup sources.
Hfss.get_antenna_data
([frequencies, setup, ...])Export the antenna parameters to Far Field Data (FFD) files and return an instance of the
FfdSolutionDataExporter
object.Hfss.get_components3d_vars
(component_name)Read the A3DCOMP file and check for variables.
Hfss.get_dxf_layers
(file_path)Read a DXF file and return all layer names.
Hfss.get_evaluated_value
(name[, units])Retrieve the evaluated value of a design property or project variable in SI units if no unit is provided.
Hfss.get_fext_xtalk_list
([drivers, ...])Geta list of all the far end XTalks from two lists of excitations (driver and receiver).
Hfss.get_hdm_plotter
([file_name])Get the HDM plotter.
Hfss.get_module
(module_name)Aedt Module object.
Check and get monitor data of an existing analysis.
Hfss.get_next_xtalk_list
([drivers, ...])Get a list of all the near end XTalks from a list of excitations (driver and receiver).
Hfss.get_nominal_variation
([with_values])Retrieve the nominal variation.
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 property 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_profile
([name])Get profile information.
Hfss.get_property_value
(assignment, ...[, ...])Retrieve a property value.
Get the value for the AEDT registry key if one exists.
Get the value for the AEDT registry key if one exists.
Hfss.get_setup
(name)Get the setup from the current design.
Retrieve setups.
Hfss.get_sweeps
(name)Retrieve all sweeps for a setup.
Hfss.get_touchstone_data
([setup, sweep, ...])Return a Touchstone data plot.
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
(name[, value])Set the variable to a hidden or unhidden variable.
Hfss.identify_touching_conductors
([assignment])Identify all touching components and group in a dictionary.
Hfss.import_3d_cad
(input_file[, healing, ...])Import a CAD model.
Hfss.import_dataset1d
(input_file[, name, ...])Import a 1D dataset.
Hfss.import_dataset3d
(input_file[, name, ...])Import a 3D dataset.
Hfss.import_dxf
(file_path, layers[, ...])Import a DXF file.
Hfss.import_gds_3d
(input_file, mapping_layers)Import a GDSII file.
Hfss.insert_design
([name, solution_type])Add a design of a specified type.
Hfss.insert_infinite_sphere
([definition, ...])Create an infinite sphere.
Hfss.insert_near_field_box
([u_length, ...])Create a near field box.
Hfss.insert_near_field_line
(assignment[, ...])Create a near field line.
Hfss.insert_near_field_rectangle
([u_length, ...])Create a near field rectangle.
Hfss.insert_near_field_sphere
([radius, ...])Create a near field sphere.
Hfss.list_of_variations
([setup, sweep])Retrieve a list of active variations for input setup.
Hfss.load_project
(file_name[, design, ...])Open an AEDT project based on a project and optional design.
Hfss.lumped_port
(assignment[, reference, ...])Create a waveport taking the closest edges of two objects.
Hfss.number_with_units
(value[, units])Convert a number to a string with units.
Hfss.parse_hdm_file
(file_name)Parse an HFSS SBR+ or Creeping Waves
hdm
file.Hfss.plane_wave
([vector_format, origin, ...])Create a plane wave excitation.
Hfss.plot
([assignment, show, output_file, ...])Plot the model or a subset of objects.
Read back the design data as a dictionary.
Hfss.read_only_variable
(name[, value])Set the variable to a read-only or not read-only variable.
Hfss.release_desktop
([close_projects, ...])Release AEDT.
Remove all unused definitions in the project.
Hfss.rename_design
(name[, save])Rename the active design.
Hfss.sar_setup
([assignment, tissue_mass, ...])Define SAR settings.
Hfss.save_project
([file_name, overwrite, ...])Save the project and add a message.
Hfss.set_active_design
(name)Change the active design to another design.
Change a specific registry key to a new value.
Hfss.set_auto_open
([enable, opening_type])Set the HFSS auto open type.
Hfss.set_differential_pair
(assignment, reference)Add a differential pair definition.
Hfss.set_export_touchstone
([file_format, ...])Set or disable the automatic export of the touchstone file after completing frequency sweep.
Hfss.set_impedance_multiplier
(multiplier)Set impedance multiplier.
Hfss.set_license_type
([license_type])Change the license type between
"Pack"
and"Pool"
.Hfss.set_material_threshold
([threshold])Set the material conductivity threshold.
Hfss.set_mesh_fusion_settings
([assignment, ...])Set mesh fusion settings in HFSS.
Hfss.set_oo_property_value
(aedt_object, ...)Change the property value of the object-oriented AEDT object.
Set phase center per port.
Hfss.set_radiated_power_calc_method
([method])Set the radiated power calculation method in Hfss.
Hfss.set_registry_from_file
(registry_file[, ...])Apply desktop registry settings from an ACT file.
Hfss.set_registry_key
(name, value)Change a specific registry key to a new value.
Set SBR+ setup options for the current source.
Hfss.set_sbr_txrx_settings
(txrx_settings)Set SBR+ TX RX antennas settings.
Hfss.set_source_context
(sources[, ...])Set the source context.
Set temporary directory path.
Hfss.solve_in_batch
([file_name, machine, ...])Analyze a design setup in batch mode.
Hfss.stop_simulations
([clean_stop])Check if there are simulation running and stops them.
Hfss.submit_job
(cluster_name[, ...])Submit a job to be solved on a cluster.
Hfss.thicken_port_sheets
(assignment, value)Create thickened sheets over a list of input port sheets.
Hfss.validate_full_design
([design, ...])Validate a design based on an expected value and save information to the log file.
Hfss.validate_simple
([log_file])Validate a design.
Hfss.value_with_units
(value[, units, ...])Combine a number and a string containing the modeler length unit in a single string e.g. "1.2mm".
Hfss.wave_port
(assignment[, reference, ...])Create a waveport from a sheet (
start_object
) or taking the closest edges of two objects.Attributes
Position of the object.
Simulation setup types.
Solution types.
Get or Set the name of the active setup.
AEDT version.
Check if there are simulation running.
Available variation object.
Design boundaries and excitations.
Design boundaries by type.
3D components.
HFSS composite mode for the active solution.
Property to import and export configuration files.
Default solution type.
Dictionary of Design Datasets.
Design list.
Design name.
Design properties.
Design type.
Desktop
class.AEDT installation directory.
Get all excitation.
Get all excitation names.
Design excitations by type.
Existing analysis setups.
Existing analysis sweeps.
List of AEDT radiation field names.
List of AEDT radiation fields.
List of all S parameters for a list of excitations.
HFSS hybrid mode for the active solution.
Dictionary of the PyAEDT session information.
Return the Circuit Layout Editor.
Library list.
Lock file.
Logger for the design.
Materials in the project.
Mesh.
Modeler.
Native component names.
Native Component dictionary.
Nominal adaptive sweep.
Nominal sweep.
Component manager object.
AEDT Maxwell Parameter Setup Object.
Model manager object.
Aedt Symbol Manager.
Analysis AEDT Module.
Boundary Object.
Definition Manager Module.
Design.
AEDT instance containing all projects and designs.
Oeditor Module.
Solution Module.
Fields reporter.
Import/Export Manager Module.
Material Manager Module.
Matrix Object.
Icepak Mesh Module.
AEDT Model Setup Object.
AEDT Monitor Object.
AEDT Optimetrics Module.
AEDT Output Variable Module.
AEDT oPadstackManager.
Project property.
Optimizations in the project.
AEDT Radiation Field Object.
Report setup.
Solution Module.
List of output variables.
Setups in the project.
PersonalLib directory.
Design excitations.
PostProcessor.
Dictionary of project datasets.
Project name and path.
Project list.
Project name.
Project path.
Project properties.
Return Project time stamp.
Return a bool if time stamp changed or not.
PyAEDT directory.
Results directory.
Settings of the current Python/Pyaedt session.
Setup names.
Setups in the project.
Solution type.
Source directory for Python.
SysLib directory.
Path to the temporary directory.
Path to the toolkit directory.
UserLib directory.
Valid design.
Variable manager for creating and managing project design and postprocessing variables.
Path to the working directory.