pyaedt.Icepak

class pyaedt.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)[source]

Provides the Icepak application interface.

This class allows you to connect to an existing Icepack 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, 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 launch 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.

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 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 2021 R1 release and open the specified project, which is myipk2.aedt.

>>> icepak = Icepak(specified_version="2021.2", projectname="myipk2.aedt")
pyaedt info: Project...
pyaedt info: No design is present. Inserting a new design.
pyaedt info: Added design...

Methods

Icepak.UniteFieldsSummaryReports(savedir, …)

Unite the files created by a fields summary for the variations.

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 global, active project or active design level of the Message Manager tree.

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

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

Icepak.analyse_nominal()

Solve the nominal design.

Icepak.analyze_all()

Analyze all setup in an actual design.

Icepak.analyze_from_initial_mesh()

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

Icepak.analyze_nominal([num_cores, …])

Solve the nominal design.

Icepak.analyze_setup(name[, num_cores, …])

Analyze a specific 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_name, …])

Assign two-way coupling to a setup.

Icepak.assign_block_from_sherlock_file(csv_name)

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

Icepak.assign_em_losses([designname, …])

Map EM losses to an Icepak design.

Icepak.assign_grille(air_faces[, …])

Assign grille to a face or list of faces.

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_priority_on_intersections([…])

Validate an Icepak design.

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.assignmaterial_from_sherlock_files(…)

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

Icepak.autosave_disable()

Disable the Desktop Autosave.

Icepak.autosave_enable()

Enable the Desktop Autosave.

Icepak.change_automatically_use_causal_materials([…])

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

Icepak.change_material_override([…])

Enable or disable the material override in the project.

Icepak.change_validation_settings([…])

Update the validation design settings.

Icepak.check_beta_option_enabled(…)

Check if a Beta Option is enabled.

Icepak.clean_proj_folder([directory, name])

Delete a project folder.

Icepak.close_desktop()

Close the desktop and release AEDT.

Icepak.close_project([name, saveproject])

Close an AEDT project.

Icepak.copyGroupFrom(groupName, sourceDesign)

Copy a group from another design.

Icepak.copy_design_from(project_fullname, …)

Copy a design from a project into the active design.

Icepak.copy_project(path, dest)

Copy the project to another destination.

Icepak.copy_solid_bodies_from(design[, …])

Copy a list of objects 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_ipk_3dcomponent_pcb(compName, …)

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

Icepak.create_meshregion_component([…])

Create a bounding box to be used as a mesh region in Icepak.

Icepak.create_network_block(object_name, …)

Create a network block.

Icepak.create_network_blocks(input_list, …)

Create network blocks from CSV files.

Icepak.create_new_project(proj_name)

Create a project within the desktop.

Icepak.create_output_variable(variable, …)

Create or modify an output variable.

Icepak.create_parametric_fin_heat_sink([…])

Create a parametric heat sink.

Icepak.create_pcb_from_3dlayout(…[, …])

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

Icepak.create_setup([setupname, setuptype, …])

Create a setup.

Icepak.create_source_block(object_name, …)

Create a source block for an object.

Icepak.create_source_blocks_from_list(…[, …])

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

Icepak.create_source_power(face_id[, …])

Create a source power for a face.

Icepak.create_temp_point_monitor(point_name)

Create a temperature monitor for the simulation.

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

Delete a setup.

Icepak.delete_variable(sVarName)

Delete a variable.

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

Update the main settings of the design.

Icepak.edit_setup(setupname, properties_dict)

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(fileName, filePath[, …])

Export the 3D model.

Icepak.export_convergence(setup_name[, …])

Export a solution convergence to file.

Icepak.export_design_preview_to_jpg(filename)

Export design preview image to a jpg file.

Icepak.export_parametric_results(sweepname, …)

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

Icepak.export_results([analyze, export_folder])

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

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.generate_fluent_mesh([object_lists])

Generate a Fluent Mesh for selected objects list and assign it 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_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_excitations_name()

Get all excitation names.

Icepak.get_gas_objects()

Return the gas materials objects.

Icepak.get_link_data(linkData)

Retrieve a list of linked data.

Icepak.get_liquid_objects()

Return the liquid materials objects.

Icepak.get_nominal_variation()

Retrieve the nominal variation.

Icepak.get_object_material_properties([…])

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

Icepak.get_output_variable(variable)

Retrieve the value of the output variable.

Icepak.get_property_value(objectname, property)

Retrieve a design property value for an object.

Icepak.get_radiation_settings(radiation)

Retrieve radiation settings.

Icepak.get_registry_key_int(key_full_name)

Get Desktop Registry Key Value if exists, otherwise 0.

Icepak.get_registry_key_string(key_full_name)

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

Icepak.get_setup(setupname)

Get the setup from the current design.

Icepak.get_setups()

Retrieve setups.

Icepak.get_sweeps(name)

Retrieve all sweep for a setup.

Icepak.globalMeshSettings(meshtype[, …])

Create a custom mesh tailored on a PCB design.

Icepak.import_idf(board_path[, …])

Import an IDF file to Icepak Design.

Icepak.insert_design([design_name])

Add a design of a specified type.

Icepak.list_of_variations([setup_name, …])

Return list of active variation for input setup.

Icepak.load_project(project_file[, …])

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

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

Plot the model or a substet of objects.

Icepak.read_design_data()

Read back the design data as a dictionary.

Icepak.release_desktop([close_projects, …])

Release the desktop.

Icepak.rename_design(new_name)

Rename the active design.

Icepak.save_project([project_file, …])

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

Icepak.set_license_type([license_type])

Change the License Type between Pack and Pool.

Icepak.set_registry_from_file(registry_file)

Apply desktop Registry settings from acf file.

Icepak.set_registry_key(key_full_name, key_value)

Change a specific registry key to new value.

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

Analyze a design setup in batch mode.

Icepak.submit_job(clustername[, …])

Submit a job to be solved on a cluster.

Icepak.validate_simple([logfile])

Validate a design.

Attributes

Icepak.aedt_version_id

AEDT version.

Icepak.analysis_setup

Analysis setup.

Icepak.available_variations

Available variation object.

Icepak.default_solution_type

Default solution type.

Icepak.design_list

Design list.

Icepak.design_name

Design name.

Icepak.design_properties

Design properties.

Icepak.design_type

Design type.

Icepak.desktop_install_dir

Desktop installation directory.

Icepak.existing_analysis_setups

Existing analysis setups.

Icepak.existing_analysis_sweeps

Existing analysis setups.

Icepak.library_list

Library list.

Icepak.lock_file

Lock file.

Icepak.logger

Logger for the Design.

Icepak.materials

Manages materials in the project.

Icepak.mesh

Mesh.

Icepak.modeler

Modeler.

Icepak.nominal_adaptive

Nominal adaptive sweep.

Icepak.nominal_sweep

Nominal sweep.

Icepak.oanalysis

Analysis AEDT Module.

Icepak.oboundary

Boundary Module.

Icepak.odefinition_manager

Definition Manager Module.

Icepak.odesign

Design.

Icepak.odesktop

Desktop instance containing all projects and designs.

Icepak.oimport_export

Import Export Manager Module.

Icepak.omaterial_manager

Material Manager Module.

Icepak.omodelsetup

AEDT Model Setup Object.

Icepak.ooptimetrics

Optimetrics AEDT Module.

Icepak.ooutput_variable

Output Variable AEDT Module.

Icepak.oproject

Property.

Icepak.osolution

Solution Module.

Icepak.output_variables

List of Output variables.

Icepak.personallib

PersonalLib directory.

Icepak.post

PostProcessor.

Icepak.problem_type

Get/Set the problem type of the icepak Design. It can be any of`”TemperatureAndFlow”, `”TemperatureOnly”,`”FlowOnly”`.

Icepak.project_file

Project file.

Icepak.project_list

Project list.

Icepak.project_name

Project name.

Icepak.project_path

Project path.

Icepak.project_properies

Project properties.

Icepak.pyaedt_dir

PyAEDT directory.

Icepak.results_directory

Results directory.

Icepak.setup_names

Setup names.

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.