Icepak#

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

This class allows you to connect to an existing Icepak design or create a new Icepak 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, 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 Script is launched within AEDT. Examples of input values are 232, 23.2,``2023.2``,``”2023.2”``.

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

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 connect the oDesktop session to. This works only in 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 also starts if not present.

portint, optional

Port number of 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_idint, optional

Process ID for the instance of AEDT to point PyAEDT at. The default is None. This parameter is only used when new_desktop_session = False.

Examples

Create an instance of Icepak and connect to an existing Icepak design or create a new Icepak design if one does not exist.

>>> from pyaedt import Icepak
>>> icepak = Icepak()
PyAEDT INFO: No project is defined. Project ...
PyAEDT INFO: Active design is set to ...

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

>>> icepak = Icepak("IcepakProject")
PyAEDT INFO: Project ...
PyAEDT INFO: Added design ...

Create an instance of Icepak and link to a design named IcepakDesign1 in a project named IcepakProject.

>>> icepak = Icepak("IcepakProject", "IcepakDesign1")
PyAEDT INFO: Added design 'IcepakDesign1' of type Icepak.

Create an instance of Icepak and open the specified project, which is myipk.aedt.

>>> icepak = Icepak("myipk.aedt")
PyAEDT INFO: Project myipk has been created.
PyAEDT INFO: No design is present. Inserting a new design.
PyAEDT INFO: Added design ...

Create an instance of Icepak using the 2023 R2 release and open the specified project, which is myipk2.aedt.

>>> icepak = Icepak(specified_version=2023.2, projectname="myipk2.aedt")
PyAEDT INFO: Project...
PyAEDT INFO: No design is present. Inserting a new design.
PyAEDT INFO: Added design...

Methods

Icepak.activate_variable_optimization(...[, ...])

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

Icepak.activate_variable_sensitivity(...[, ...])

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

Icepak.activate_variable_statistical(...[, ...])

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

Icepak.activate_variable_tuning(variable_name)

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

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

Icepak.add_from_toolkit(toolkit_object[, draw])

Add a new toolkit to the current application.

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

Icepak.add_stackup_3d()

Create a stackup 3D object.

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

Icepak.analyze([name, cores, tasks, gpus, ...])

Solve the active design.

Icepak.analyze_setup([name, cores, tasks, ...])

Analyze a design setup.

Icepak.apply_icepak_settings([ambienttemp, ...])

Apply Icepak default design settings.

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

Archive the AEDT project and add a message.

Icepak.assign_2way_coupling([setup, ...])

Assign two-way coupling to a setup.

Icepak.assign_adiabatic_plate(assignment[, ...])

Assign adiabatic plate boundary condition.

Icepak.assign_block_from_sherlock_file(csv_name)

Assign block power to components based on a CSV file from Sherlock.

Icepak.assign_blower_type1(faces, ...[, ...])

Assign blower type 1.

Icepak.assign_blower_type2(faces, ...[, ...])

Assign blower type 2.

Icepak.assign_conducting_plate(obj_plate[, ...])

Assign thermal boundary conditions to a conducting plate.

Icepak.assign_conducting_plate_with_conductance(...)

Assign thermal boundary conditions with conductance specification to a conducting plate.

Icepak.assign_conducting_plate_with_impedance(...)

Assign thermal boundary conditions with thermal impedance specification to a conducting plate.

Icepak.assign_conducting_plate_with_resistance(...)

Assign thermal boundary conditions with thermal resistance specification to a conducting plate.

Icepak.assign_conducting_plate_with_thickness(...)

Assign thermal boundary conditions with thickness specification to a conducting plate.

Icepak.assign_device_resistance(objects[, ...])

Assign resistance boundary condition using the device/approach model.

Icepak.assign_em_losses([design, setup, ...])

Map EM losses to an Icepak design.

Icepak.assign_free_opening(assignment[, ...])

Assign free opening boundary condition.

Icepak.assign_grille(air_faces[, ...])

Assign grille to a face or list of faces.

Icepak.assign_hollow_block(object_name, ...)

Assign block boundary for hollow objects.

Icepak.assign_loss_curve_resistance(objects)

Assign resistance boundary condition prescribing a loss curve.

Icepak.assign_mass_flow_free_opening(assignment)

Assign free opening boundary condition.

Icepak.assign_material(obj, mat)

Assign a material to one or more objects.

Icepak.assign_openings(air_faces)

Assign openings to a list of faces.

Icepak.assign_point_monitor(point_position)

Create and assign a point monitor.

Icepak.assign_point_monitor_in_object(name)

Assign a point monitor in the centroid of a specific object.

Icepak.assign_power_law_resistance(objects)

Assign resistance boundary condition prescribing a power law.

Icepak.assign_pressure_free_opening(assignment)

Assign free opening boundary condition.

Icepak.assign_priority_on_intersections([...])

Validate an Icepak design.

Icepak.assign_recirculation_opening(...[, ...])

Assign recirculation faces.

Icepak.assign_resistance(objects[, ...])

Assign resistance boundary condition.

Icepak.assign_solid_block(object_name, ...)

Assign block boundary for solid objects.

Icepak.assign_source(assignment, ...[, ...])

Create a source power for a face.

Icepak.assign_stationary_wall(geometry, ...)

Assign surface wall boundary condition.

Icepak.assign_stationary_wall_with_heat_flux(...)

Assign a surface wall boundary condition with specified heat flux.

Icepak.assign_stationary_wall_with_htc(geometry)

Assign a surface wall boundary condition with specified heat transfer coefficient.

Icepak.assign_stationary_wall_with_temperature(...)

Assign a surface wall boundary condition with specified temperature.

Icepak.assign_surface_material(obj, mat)

Assign a surface material to one or more objects.

Icepak.assign_surface_monitor(face_name[, ...])

Assign a surface monitor.

Icepak.assign_symmetry_wall(geometry[, ...])

Assign symmetry wall boundary condition.

Icepak.assign_velocity_free_opening(assignment)

Assign free opening boundary condition.

Icepak.assignmaterial_from_sherlock_files(...)

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

Icepak.autosave_disable()

Disable autosave in AEDT.

Icepak.autosave_enable()

Enable autosave in AEDT.

Icepak.change_automatically_use_causal_materials([...])

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

Icepak.change_design_settings(settings)

Set Design Settings.

Icepak.change_material_override([...])

Enable or disable the material override in the project.

Icepak.change_property(aedt_object, ...)

Change a property.

Icepak.change_validation_settings([...])

Update the validation design settings.

Icepak.check_beta_option_enabled(...)

Check if a beta option is enabled.

Icepak.check_if_project_is_loaded(project_path)

Check if a project path is already loaded in active Desktop.

Icepak.clean_proj_folder([directory, name])

Delete a project folder.

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

Delete a set of Solution Variations or part of them.

Icepak.close_desktop()

Close AEDT and release it.

Icepak.close_project([name, save_project])

Close an AEDT project.

Icepak.copyGroupFrom(group_name, source_design)

Copy a group from another design.

Icepak.copy_design_from(project_fullname, ...)

Copy a design from a project into the active project.

Icepak.copy_project(path, dest)

Copy the project to another destination.

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

Copy a list of objects and user defined models from one design to the active design.

Icepak.create_dataset(dsname, xlist, ylist)

Create a dataset.

Icepak.create_dataset1d_design(dsname, ...)

Create a design dataset.

Icepak.create_dataset1d_project(dsname, ...)

Create a project dataset.

Icepak.create_dataset3d(dsname, xlist, ylist)

Create a 3D dataset.

Icepak.create_dataset_transient_assignment(ds_name)

Create a transient assignment from a dataset.

Icepak.create_exponential_transient_assignment(...)

Create an object to assign the exponential transient condition to.

Icepak.create_fan([name, is_2d, shape, ...])

Create a fan component in Icepak that is linked to an HFSS 3D Layout object.

Icepak.create_ipk_3dcomponent_pcb(compName, ...)

Create a PCB component in Icepak that is linked to an HFSS 3D Layout object.

Icepak.create_linear_transient_assignment(...)

Create an object to assign the linear transient condition to.

Icepak.create_network_blocks(input_list, ...)

Create network blocks from CSV files.

Icepak.create_network_object([name, props, ...])

Create a thermal network.

Icepak.create_new_project(proj_name)

Create a project within AEDT.

Icepak.create_output_variable(variable, ...)

Create or modify an output variable.

Icepak.create_parametric_fin_heat_sink([...])

Create a parametric heat sink.

Icepak.create_parametric_heatsink_on_face(...)

Create a parametric heat sink.

Icepak.create_pcb_from_3dlayout(...[, ...])

Create a PCB component in Icepak that is linked to an HFSS 3DLayout object linking only to the geometry file.

Icepak.create_powerlaw_transient_assignment(...)

Create an object to assign the power law transient condition to.

Icepak.create_resistor_network_from_matrix(...)

Create a thermal network.

Icepak.create_setup([name, setup_type])

Create an analysis setup for Icepak.

Icepak.create_sinusoidal_transient_assignment(...)

Create an object to assign the sinusoidal transient condition to.

Icepak.create_source_blocks_from_list(...[, ...])

Assign to a box in Icepak the sources that come from the CSV file.

Icepak.create_square_wave_transient_assignment(...)

Create an object to assign the square wave transient condition to.

Icepak.create_temp_dep_assignment(ds_name[, ...])

Create a temperature-dependent assignment from a dataset.

Icepak.create_two_resistor_network_block(...)

Function to create 2-Resistor network object.

Icepak.dataset_exists(name[, is_project_dataset])

Check if a dataset exists.

Icepak.deactivate_variable_optimization(...)

Deactivate the optimization analysis for a variable.

Icepak.deactivate_variable_sensitivity(...)

Deactivate the sensitivity analysis for a variable.

Icepak.deactivate_variable_statistical(...)

Deactivate the statistical analysis for a variable.

Icepak.deactivate_variable_tuning(variable_name)

Deactivate the tuning analysis for a variable.

Icepak.delete_design([name, fallback_design])

Delete a design from the current project.

Icepak.delete_em_losses(bound_name)

Delete the EM losses boundary.

Icepak.delete_pcb_component(comp_name)

Delete a PCB component.

Icepak.delete_project(project_name)

Delete a project.

Icepak.delete_separator(separator_name)

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

Icepak.delete_setup(name)

Delete a setup.

Icepak.delete_unused_variables()

Delete design and project unused variables.

Icepak.delete_variable(sVarName)

Delete a variable.

Icepak.design_settings()

Get design settings for the current AEDT app.

Icepak.design_variation([variation_string])

Generate a string to specify a desired variation.

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

Copy a design to a new name.

Icepak.edit_design_settings([gravity_dir, ...])

Update the main settings of the design.

Icepak.edit_setup(name, properties)

Modify a setup.

Icepak.eval_surface_quantity_from_field_summary(...)

Export the field surface output.

Icepak.eval_volume_quantity_from_field_summary(...)

Export the field volume output.

Icepak.evaluate_expression(expression_string)

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

Icepak.export_3d_model([file_name, ...])

Export the 3D model.

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

Export a solution convergence to a file.

Icepak.export_design_preview_to_jpg(filename)

Export design preview image to a JPG file.

Icepak.export_mesh_stats(setup[, ...])

Export mesh statistics to a file.

Icepak.export_parametric_results(sweep, filename)

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

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

Export a solution profile to a PROF file.

Icepak.export_results([analyze, ...])

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

Icepak.export_rl_matrix(matrix_name, file_path)

Export R/L matrix after solving.

Icepak.export_summary([output_dir, ...])

Export a fields summary of all objects.

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

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

Icepak.find_top(gravityDir)

Find the top location of the layout given a gravity.

Icepak.flatten_3d_components([...])

Flatten one or multiple 3d components in the actual layout.

Icepak.generate_fluent_mesh([object_lists, ...])

Generate a Fluent mesh for a list of selected objects and assign the mesh automatically to the objects.

Icepak.generate_temp_project_directory(...)

Generate a unique directory string to save a project to.

Icepak.generate_unique_setup_name([setup_name])

Generate a new setup with an unique name.

Icepak.get_all_conductors_names()

Retrieve all conductors in the active design.

Icepak.get_all_dielectrics_names()

Retrieve all dielectrics in the active design.

Icepak.get_all_sources()

Retrieve all setup sources.

Icepak.get_components3d_vars(component3dname)

Read the A3DCOMP file and check for variables.

Icepak.get_dxf_layers(file_path)

Read a DXF file and return all layer names.

Icepak.get_evaluated_value(variable_name[, ...])

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

Icepak.get_fans_operating_point([...])

Get operating point of the fans in the design.

Icepak.get_gas_objects()

Get gas objects.

Icepak.get_link_data(links_data, **kwargs)

Get a list of linked data.

Icepak.get_liquid_objects()

Get liquid material objects.

Icepak.get_module(module_name)

Aedt Module object.

Icepak.get_monitor_data()

Check and get monitor data of an existing analysis.

Icepak.get_nominal_variation([with_values])

Retrieve the nominal variation.

Icepak.get_object_material_properties([...])

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

Icepak.get_oo_name(aedt_object[, object_name])

Return the object-oriented AEDT property names.

Icepak.get_oo_object(aedt_object, object_name)

Return the Object Oriented AEDT Object.

Icepak.get_oo_properties(aedt_object, ...)

Return the Object Oriented AEDT Object Properties.

Icepak.get_oo_property_value(aedt_object, ...)

Return the Object Oriented AEDT Object Properties.

Icepak.get_output_variable(variable[, solution])

Retrieve the value of the output variable.

Icepak.get_property_value(objectname, property)

Retrieve a property value.

Icepak.get_radiation_settings(radiation)

Get radiation settings.

Icepak.get_registry_key_int(key_full_name)

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

Icepak.get_registry_key_string(key_full_name)

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

Icepak.get_setup(name)

Get the setup from the current design.

Icepak.get_setups()

Retrieve setups.

Icepak.get_sweeps(name)

Retrieve all sweeps for a setup.

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

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

Icepak.globalMeshSettings(meshtype[, ...])

Create a custom mesh tailored on a PCB design.

Icepak.hidden_variable(variable_name[, value])

Set the variable to a hidden or unhidden variable.

Icepak.identify_touching_conductors([...])

Identify all touching components and group in a dictionary.

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

Import a 1D dataset.

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

Import a 3D dataset.

Icepak.import_dxf(file_path, layers_list[, ...])

Import a DXF file.

Icepak.import_gds_3d(input_file, mapping_layers)

Import a GDSII file.

Icepak.import_idf(board_path[, ...])

Import an IDF file into an Icepak design.

Icepak.insert_design([design_name, ...])

Add a design of a specified type.

Icepak.list_of_variations([setup_name, ...])

Retrieve a list of active variations for input setup.

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

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

Icepak.number_with_units(value[, units])

Convert a number to a string with units.

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

Plot the model or a subset of objects.

Icepak.read_design_data()

Read back the design data as a dictionary.

Icepak.read_only_variable(variable_name[, value])

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

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

Release AEDT.

Icepak.remove_all_unused_definitions()

Remove all unused definitions in the project.

Icepak.rename_design(new_name[, ...])

Rename the active design.

Icepak.save_project([project_file, ...])

Save the project and add a message.

Icepak.set_active_design(name)

Change the active design to another design.

Icepak.set_active_dso_config_name([...])

Change a specific registry key to a new value.

Icepak.set_license_type([license_type])

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

Icepak.set_oo_property_value(aedt_object, ...)

Change the property value of the object-oriented AEDT object.

Icepak.set_registry_from_file(registry_file)

Apply desktop registry settings from an ACT file.

Icepak.set_registry_key(key_full_name, key_value)

Change a specific registry key to a new value.

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

Set the source context.

Icepak.set_temporary_directory(temp_dir_path)

Set temporary directory path.

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

Analyze a design setup in batch mode.

Icepak.stop_simulations([clean_stop])

Check if there are simulation running and stops them.

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

Submit a job to be solved on a cluster.

Icepak.validate_simple([logfile])

Validate a design.

Icepak.value_with_units(value[, units, ...])

Combine a number and a string containing the modeler length unit in a single string e.g. "1.2mm".

Attributes

Icepak.Position

Position of the object.

Icepak.SimulationSetupTypes

Simulation setup types.

Icepak.SolutionTypes

Solution types.

Icepak.active_setup

Get or Set the name of the active setup.

Icepak.aedt_version_id

AEDT version.

Icepak.are_there_simulations_running

Check if there are simulation running.

Icepak.available_variations

Available variation object.

Icepak.boundaries

Design boundaries and excitations.

Icepak.boundaries_by_type

Design boundaries by type.

Icepak.components3d

3D components.

Icepak.configurations

Property to import and export configuration files.

Icepak.default_solution_type

Default solution type.

Icepak.design_datasets

Dictionary of Design Datasets.

Icepak.design_list

Design list.

Icepak.design_name

Design name.

Icepak.design_properties

Design properties.

Icepak.design_type

Design type.

Icepak.desktop_class

Desktop class.

Icepak.desktop_install_dir

AEDT installation directory.

Icepak.excitation_objects

Get all excitation.

Icepak.excitations

Get all excitation names.

Icepak.excitations_by_type

Design excitations by type.

Icepak.existing_analysis_setups

Existing analysis setups.

Icepak.existing_analysis_sweeps

Existing analysis setups.

Icepak.info

Dictionary of the PyAEDT session information.

Icepak.layouteditor

Return the Circuit Layout Editor.

Icepak.library_list

Library list.

Icepak.lock_file

Lock file.

Icepak.logger

Logger for the design.

Icepak.materials

Materials in the project.

Icepak.mesh

Mesh.

Icepak.modeler

Modeler.

Icepak.monitor

Property to handle monitor objects.

Icepak.native_components

Native Component dictionary.

Icepak.nominal_adaptive

Nominal adaptive sweep.

Icepak.nominal_sweep

Nominal sweep.

Icepak.o_component_manager

Component manager object.

Icepak.o_maxwell_parameters

AEDT Maxwell Parameter Setup Object.

Icepak.o_model_manager

Model manager object.

Icepak.o_symbol_manager

Aedt Symbol Manager.

Icepak.oanalysis

Analysis AEDT Module.

Icepak.oboundary

Boundary Object.

Icepak.odefinition_manager

Definition Manager Module.

Icepak.odesign

Design.

Icepak.odesktop

AEDT instance containing all projects and designs.

Icepak.oeditor

Oeditor Module.

Icepak.oexcitation

Solution Module.

Icepak.ofieldsreporter

Fields reporter.

Icepak.oimport_export

Import/Export Manager Module.

Icepak.omaterial_manager

Material Manager Module.

Icepak.omatrix

Matrix Object.

Icepak.omeshmodule

Icepak Mesh Module.

Icepak.omodelsetup

AEDT Model Setup Object.

Icepak.omonitor

AEDT Monitor Object.

Icepak.ooptimetrics

AEDT Optimetrics Module.

Icepak.ooutput_variable

AEDT Output Variable Module.

Icepak.opadstackmanager

AEDT oPadstackManager.

Icepak.oproject

Project property.

Icepak.optimizations

Optimizations in the project.

Icepak.oradfield

AEDT Radiation Field Object.

Icepak.oreportsetup

Report setup.

Icepak.osolution

Solution Module.

Icepak.output_variables

List of output variables.

Icepak.parametrics

Setups in the project.

Icepak.personallib

PersonalLib directory.

Icepak.ports

Design excitations.

Icepak.post

PostProcessor.

Icepak.problem_type

Problem type of the Icepak design.

Icepak.project_datasets

Dictionary of project datasets.

Icepak.project_file

Project name and path.

Icepak.project_list

Project list.

Icepak.project_name

Project name.

Icepak.project_path

Project path.

Icepak.project_properties

Project properties.

Icepak.project_time_stamp

Return Project time stamp.

Icepak.project_timestamp_changed

Return a bool if time stamp changed or not.

Icepak.pyaedt_dir

PyAEDT directory.

Icepak.results_directory

Results directory.

Icepak.settings

Settings of the current Python/Pyaedt session.

Icepak.setup_names

Setup names.

Icepak.setups

Setups in the project.

Icepak.solution_type

Solution type.

Icepak.src_dir

Source directory for Python.

Icepak.syslib

SysLib directory.

Icepak.temp_directory

Path to the temporary directory.

Icepak.toolkit_directory

Path to the toolkit directory.

Icepak.userlib

UserLib directory.

Icepak.valid_design

Valid design.

Icepak.variable_manager

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

Icepak.working_directory

Path to the working directory.