Maxwell3d#

class pyaedt.maxwell.Maxwell3d(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 Maxwell 3D app interface.

This class allows you to connect to an existing Maxwell 3D design or create a new Maxwell 3D 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 a 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. 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 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 on which to start the oDesktop communication on an already existing server. This parameter is ignored when a new server is created. 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 Maxwell 3D and open the specified project, which is named mymaxwell.aedt.

>>> from pyaedt import Maxwell3d
>>> m3d = Maxwell3d("mymaxwell.aedt")
PyAEDT INFO: Added design ...

Create an instance of Maxwell 3D using the 2024 R1 release and open the specified project, which is named mymaxwell2.aedt.

>>> m3d = Maxwell3d(specified_version="2024.1", projectname="mymaxwell2.aedt")
PyAEDT INFO: Added design ...

Methods

`Maxwell3d.activate_variable_optimization`(...)	Activate optimization analysis for a variable and optionally set up ranges.
`Maxwell3d.activate_variable_sensitivity`(...)	Activate sensitivity analysis for a variable and optionally set up ranges.
`Maxwell3d.activate_variable_statistical`(...)	Activate statitistical analysis for a variable and optionally set up ranges.
`Maxwell3d.activate_variable_tuning`(variable_name)	Activate tuning analysis for a variable and optionally set up ranges.
`Maxwell3d.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.
`Maxwell3d.add_from_toolkit`(toolkit_object[, ...])	Add a new toolkit to the current application.
`Maxwell3d.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.
`Maxwell3d.add_stackup_3d`()	Create a stackup 3D object.
`Maxwell3d.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.
`Maxwell3d.add_winding_coils`(assignment, coils)	Add coils to the winding.
`Maxwell3d.analyze`([name, cores, tasks, ...])	Solve the active design.
`Maxwell3d.analyze_from_zero`()	Force the next solve to start from time 0 for a given setup.
`Maxwell3d.analyze_setup`([name, cores, ...])	Analyze a design setup.
`Maxwell3d.apply_skew`([skew_type, skew_part, ...])	Apply skew to 2D model.
`Maxwell3d.archive_project`([project_file, ...])	Archive the AEDT project and add a message.
`Maxwell3d.assign_coil`(assignment[, ...])	Assign coils to a list of objects or face IDs.
`Maxwell3d.assign_current`(assignment[, ...])	Assign the source of the current.
`Maxwell3d.assign_current_density`(assignment)	Assign current density to a single or list of entities.
`Maxwell3d.assign_current_density_terminal`(...)	Assign current density terminal to a single or list of entities for an Eddy Current or Magnetostatic solver.
`Maxwell3d.assign_flux_tangential`(assignment)	Assign a flux tangential boundary for a transient A-Phi solver.
`Maxwell3d.assign_force`(assignment[, ...])	Assign a force to one or more objects.
`Maxwell3d.assign_impedance`(assignment[, ...])	Create an impedance boundary condition for Transient or Eddy Current solvers.
`Maxwell3d.assign_insulating`(assignment[, ...])	Create an insulating boundary condition.
`Maxwell3d.assign_layout_force`(net_layers, ...)	Assign the layout force to a component in a Transient A-Phi solver.
`Maxwell3d.assign_master_slave`(independent, ...)	Assign dependent and independent boundary conditions to two faces of the same object.
`Maxwell3d.assign_material`(obj, mat)	Assign a material to one or more objects.
`Maxwell3d.assign_matrix`(assignment[, ...])	Assign a matrix to the selection.
`Maxwell3d.assign_radiation`(assignment[, ...])	Assign radiation boundary to one or more objects.
`Maxwell3d.assign_rotate_motion`(assignment[, ...])	Assign a rotation motion to an object container.
`Maxwell3d.assign_symmetry`(assignment[, ...])	Assign symmetry boundary.
`Maxwell3d.assign_tangential_h_field`(assignment)	Assign a tangential H field boundary to a list of faces.
`Maxwell3d.assign_torque`(assignment[, ...])	Assign a torque to one or more objects.
`Maxwell3d.assign_translate_motion`(assignment)	Assign a translation motion to an object container.
`Maxwell3d.assign_voltage`(assignment[, ...])	Assign a voltage source to a list of faces in Maxwell 3D or a list of objects in Maxwell 2D.
`Maxwell3d.assign_voltage_drop`(assignment[, ...])	Assign a voltage drop across a list of faces to a specific value.
`Maxwell3d.assign_winding`([assignment, ...])	Assign a winding to a Maxwell design.
`Maxwell3d.assign_zero_tangential_h_field`(...)	Assign a zero tangential H field boundary to a list of faces.
`Maxwell3d.assignmaterial_from_sherlock_files`(...)	Assign material to objects in a design based on a CSV file obtained from Sherlock.
`Maxwell3d.autosave_disable`()	Disable autosave in AEDT.
`Maxwell3d.autosave_enable`()	Enable autosave in AEDT.
`Maxwell3d.change_automatically_use_causal_materials`([...])	Enable or disable the automatic use of causal materials for lossy dielectrics.
`Maxwell3d.change_design_settings`(settings)	Set Design Settings.
`Maxwell3d.change_inductance_computation`([...])	Enable the inductance computation for the transient analysis and set the incremental matrix.
`Maxwell3d.change_material_override`([...])	Enable or disable the material override in the project.
`Maxwell3d.change_property`(aedt_object, ...)	Change a property.
`Maxwell3d.change_symmetry_multiplier`([value])	Set the design symmetry multiplier to a specified value.
`Maxwell3d.change_validation_settings`([...])	Update the validation design settings.
`Maxwell3d.check_beta_option_enabled`(...)	Check if a beta option is enabled.
`Maxwell3d.check_if_project_is_loaded`(...)	Check if a project path is already loaded in active Desktop.
`Maxwell3d.clean_proj_folder`([directory, name])	Delete a project folder.
`Maxwell3d.cleanup_solution`([variations, ...])	Delete a set of Solution Variations or part of them.
`Maxwell3d.close_desktop`()	Close AEDT and release it.
`Maxwell3d.close_project`([name, save_project])	Close an AEDT project.
`Maxwell3d.copy_design_from`(project_fullname, ...)	Copy a design from a project into the active project.
`Maxwell3d.copy_project`(path, dest)	Copy the project to another destination.
`Maxwell3d.copy_solid_bodies_from`(design[, ...])	Copy a list of objects and user defined models from one design to the active design.
`Maxwell3d.create_dataset`(dsname, xlist, ylist)	Create a dataset.
`Maxwell3d.create_dataset1d_design`(dsname, ...)	Create a design dataset.
`Maxwell3d.create_dataset1d_project`(dsname, ...)	Create a project dataset.
`Maxwell3d.create_dataset3d`(dsname, xlist, ylist)	Create a 3D dataset.
`Maxwell3d.create_new_project`(proj_name)	Create a project within AEDT.
`Maxwell3d.create_output_variable`(variable, ...)	Create or modify an output variable.
`Maxwell3d.create_setup`([name, setup_type])	Create an analysis setup for Maxwell 3D or 2D.
`Maxwell3d.dataset_exists`(name[, ...])	Check if a dataset exists.
`Maxwell3d.deactivate_variable_optimization`(...)	Deactivate the optimization analysis for a variable.
`Maxwell3d.deactivate_variable_sensitivity`(...)	Deactivate the sensitivity analysis for a variable.
`Maxwell3d.deactivate_variable_statistical`(...)	Deactivate the statistical analysis for a variable.
`Maxwell3d.deactivate_variable_tuning`(...)	Deactivate the tuning analysis for a variable.
`Maxwell3d.delete_design`([name, fallback_design])	Delete a design from the current project.
`Maxwell3d.delete_project`(project_name)	Delete a project.
`Maxwell3d.delete_separator`(separator_name)	Delete a separator from either the active project or a design.
`Maxwell3d.delete_setup`(name)	Delete a setup.
`Maxwell3d.delete_unused_variables`()	Delete design and project unused variables.
`Maxwell3d.delete_variable`(sVarName)	Delete a variable.
`Maxwell3d.design_settings`()	Get design settings for the current AEDT app.
`Maxwell3d.design_variation`([variation_string])	Generate a string to specify a desired variation.
`Maxwell3d.duplicate_design`(label[, ...])	Copy a design to a new name.
`Maxwell3d.eddy_effects_on`(assignment[, ...])	Assign eddy effects on a list of objects.
`Maxwell3d.edit_external_circuit`(...)	Edit the external circuit for the winding.
`Maxwell3d.edit_setup`(name, properties)	Modify a setup.
`Maxwell3d.enable_harmonic_force`(assignment)	Enable the harmonic force calculation for the transient analysis.
`Maxwell3d.enable_harmonic_force_on_layout_component`(...)	Enable the harmonic force calculation for the transient analysis.
`Maxwell3d.evaluate_expression`(expression_string)	Evaluate a valid string expression and return the numerical value in SI units.
`Maxwell3d.export_3d_model`([file_name, ...])	Export the 3D model.
`Maxwell3d.export_convergence`(setup_name[, ...])	Export a solution convergence to a file.
`Maxwell3d.export_design_preview_to_jpg`(filename)	Export design preview image to a JPG file.
`Maxwell3d.export_element_based_harmonic_force`([...])	Export an element-based harmonic force data to a .csv file.
`Maxwell3d.export_mesh_stats`(setup[, ...])	Export mesh statistics to a file.
`Maxwell3d.export_parametric_results`(sweep, ...)	Export a list of all parametric variations solved for a sweep to a CSV file.
`Maxwell3d.export_profile`(setup_name[, ...])	Export a solution profile to a PROF file.
`Maxwell3d.export_results`([analyze, ...])	Export all available reports to a file, including profile, and convergence and sNp when applicable.
`Maxwell3d.export_rl_matrix`(matrix_name, ...)	Export R/L matrix after solving.
`Maxwell3d.export_variables_to_csv`(filename)	Export design properties, project variables, or both to a CSV file.
`Maxwell3d.flatten_3d_components`([...])	Flatten one or multiple 3d components in the actual layout.
`Maxwell3d.generate_temp_project_directory`(...)	Generate a unique directory string to save a project to.
`Maxwell3d.generate_unique_setup_name`([...])	Generate a new setup with an unique name.
`Maxwell3d.get_all_conductors_names`()	Retrieve all conductors in the active design.
`Maxwell3d.get_all_dielectrics_names`()	Retrieve all dielectrics in the active design.
`Maxwell3d.get_all_sources`()	Retrieve all setup sources.
`Maxwell3d.get_components3d_vars`(component3dname)	Read the A3DCOMP file and check for variables.
`Maxwell3d.get_conduction_paths`()	Get a dictionary of all conduction paths with relative objects.
`Maxwell3d.get_dxf_layers`(file_path)	Read a DXF file and return all layer names.
`Maxwell3d.get_evaluated_value`(variable_name)	Retrieve the evaluated value of a design property or project variable in SI units if no unit is provided.
`Maxwell3d.get_module`(module_name)	Aedt Module object.
`Maxwell3d.get_monitor_data`()	Check and get monitor data of an existing analysis.
`Maxwell3d.get_nominal_variation`([with_values])	Retrieve the nominal variation.
`Maxwell3d.get_object_material_properties`([...])	Retrieve the material properties for a list of objects and return them in a dictionary.
`Maxwell3d.get_oo_name`(aedt_object[, object_name])	Return the object-oriented AEDT property names.
`Maxwell3d.get_oo_object`(aedt_object, object_name)	Return the Object Oriented AEDT Object.
`Maxwell3d.get_oo_properties`(aedt_object, ...)	Return the Object Oriented AEDT Object Properties.
`Maxwell3d.get_oo_property_value`(aedt_object, ...)	Return the Object Oriented AEDT Object Properties.
`Maxwell3d.get_output_variable`(variable[, ...])	Retrieve the value of the output variable.
`Maxwell3d.get_property_value`(objectname, ...)	Retrieve a property value.
`Maxwell3d.get_registry_key_int`(key_full_name)	Get the value for the AEDT registry key if one exists.
`Maxwell3d.get_registry_key_string`(key_full_name)	Get the value for the AEDT registry key if one exists.
`Maxwell3d.get_setup`(name)	Get the setup from the current design.
`Maxwell3d.get_setups`()	Retrieve setups.
`Maxwell3d.get_sweeps`(name)	Retrieve all sweeps for a setup.
`Maxwell3d.get_traces_for_plot`([...])	Retrieve a list of traces of specified designs ready to use in plot reports.
`Maxwell3d.hidden_variable`(variable_name[, value])	Set the variable to a hidden or unhidden variable.
`Maxwell3d.identify_touching_conductors`([...])	Identify all touching components and group in a dictionary.
`Maxwell3d.import_dataset1d`(filename[, ...])	Import a 1D dataset.
`Maxwell3d.import_dataset3d`(filename[, ...])	Import a 3D dataset.
`Maxwell3d.import_dxf`(file_path, layers_list)	Import a DXF file.
`Maxwell3d.import_gds_3d`(input_file, ...[, ...])	Import a GDSII file.
`Maxwell3d.insert_design`([design_name, ...])	Add a design of a specified type.
`Maxwell3d.list_of_variations`([setup_name, ...])	Retrieve a list of active variations for input setup.
`Maxwell3d.load_project`(project_file[, ...])	Open an AEDT project based on a project and optional design.
`Maxwell3d.number_with_units`(value[, units])	Convert a number to a string with units.
`Maxwell3d.plot`([objects, show, export_path, ...])	Plot the model or a subset of objects.
`Maxwell3d.read_design_data`()	Read back the design data as a dictionary.
`Maxwell3d.read_only_variable`(variable_name)	Set the variable to a read-only or not read-only variable.
`Maxwell3d.release_desktop`([close_projects, ...])	Release AEDT.
`Maxwell3d.remove_all_unused_definitions`()	Remove all unused definitions in the project.
`Maxwell3d.rename_design`(new_name[, ...])	Rename the active design.
`Maxwell3d.save_project`([project_file, ...])	Save the project and add a message.
`Maxwell3d.set_active_design`(name)	Change the active design to another design.
`Maxwell3d.set_active_dso_config_name`([...])	Change a specific registry key to a new value.
`Maxwell3d.set_core_losses`(assignment[, ...])	Whether to enable core losses for a set of objects.
`Maxwell3d.set_initial_angle`(motion_setup, angle)	Set the initial angle.
`Maxwell3d.set_license_type`([license_type])	Change the license type between `"Pack"` and `"Pool"`.
`Maxwell3d.set_oo_property_value`(aedt_object, ...)	Change the property value of the object-oriented AEDT object.
`Maxwell3d.set_registry_from_file`(registry_file)	Apply desktop registry settings from an ACT file.
`Maxwell3d.set_registry_key`(key_full_name, ...)	Change a specific registry key to a new value.
`Maxwell3d.set_source_context`(sources[, ...])	Set the source context.
`Maxwell3d.set_temporary_directory`(temp_dir_path)	Set temporary directory path.
`Maxwell3d.setup_y_connection`([assignment])	Set up the Y connection.
`Maxwell3d.solve_in_batch`([filename, ...])	Analyze a design setup in batch mode.
`Maxwell3d.solve_inside`(name[, activate])	Solve inside to generate a solution inside an object.
`Maxwell3d.stop_simulations`([clean_stop])	Check if there are simulation running and stops them.
`Maxwell3d.submit_job`(clustername[, ...])	Submit a job to be solved on a cluster.
`Maxwell3d.validate_simple`([logfile])	Validate a design.
`Maxwell3d.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

`Maxwell3d.Position`	Position of the object.
`Maxwell3d.SimulationSetupTypes`	Simulation setup types.
`Maxwell3d.SolutionTypes`	Solution types.
`Maxwell3d.active_setup`	Get or Set the name of the active setup.
`Maxwell3d.aedt_version_id`	AEDT version.
`Maxwell3d.are_there_simulations_running`	Check if there are simulation running.
`Maxwell3d.available_variations`	Available variation object.
`Maxwell3d.boundaries`	Design boundaries and excitations.
`Maxwell3d.boundaries_by_type`	Design boundaries by type.
`Maxwell3d.components3d`	3D components.
`Maxwell3d.configurations`	Property to import and export configuration files.
`Maxwell3d.default_solution_type`	Default solution type.
`Maxwell3d.design_datasets`	Dictionary of Design Datasets.
`Maxwell3d.design_file`	Design file.
`Maxwell3d.design_list`	Design list.
`Maxwell3d.design_name`	Design name.
`Maxwell3d.design_properties`	Design properties.
`Maxwell3d.design_type`	Design type.
`Maxwell3d.desktop_class`	`Desktop` class.
`Maxwell3d.desktop_install_dir`	AEDT installation directory.
`Maxwell3d.dim`	Dimensions.
`Maxwell3d.excitation_objects`	Get all excitation.
`Maxwell3d.excitations`	Get all excitation names.
`Maxwell3d.excitations_by_type`	Design excitations by type.
`Maxwell3d.existing_analysis_setups`	Existing analysis setups.
`Maxwell3d.existing_analysis_sweeps`	Existing analysis sweeps.
`Maxwell3d.info`	Dictionary of the PyAEDT session information.
`Maxwell3d.layouteditor`	Return the Circuit Layout Editor.
`Maxwell3d.library_list`	Library list.
`Maxwell3d.lock_file`	Lock file.
`Maxwell3d.logger`	Logger for the design.
`Maxwell3d.materials`	Materials in the project.
`Maxwell3d.mesh`	Mesh.
`Maxwell3d.modeler`	Modeler.
`Maxwell3d.native_components`	Native Component dictionary.
`Maxwell3d.nominal_adaptive`	Nominal adaptive sweep.
`Maxwell3d.nominal_sweep`	Nominal sweep.
`Maxwell3d.o_component_manager`	Component manager object.
`Maxwell3d.o_maxwell_parameters`	AEDT Maxwell Parameter Setup Object.
`Maxwell3d.o_model_manager`	Model manager object.
`Maxwell3d.o_symbol_manager`	Aedt Symbol Manager.
`Maxwell3d.oanalysis`	Analysis AEDT Module.
`Maxwell3d.oboundary`	Boundary Object.
`Maxwell3d.odefinition_manager`	Definition Manager Module.
`Maxwell3d.odesign`	Design.
`Maxwell3d.odesktop`	AEDT instance containing all projects and designs.
`Maxwell3d.oeditor`	Oeditor Module.
`Maxwell3d.oexcitation`	Solution Module.
`Maxwell3d.ofieldsreporter`	Fields reporter.
`Maxwell3d.oimport_export`	Import/Export Manager Module.
`Maxwell3d.omaterial_manager`	Material Manager Module.
`Maxwell3d.omatrix`	Matrix Object.
`Maxwell3d.omeshmodule`	Icepak Mesh Module.
`Maxwell3d.omodelsetup`	AEDT Model Setup Object.
`Maxwell3d.omonitor`	AEDT Monitor Object.
`Maxwell3d.ooptimetrics`	AEDT Optimetrics Module.
`Maxwell3d.ooutput_variable`	AEDT Output Variable Module.
`Maxwell3d.opadstackmanager`	AEDT oPadstackManager.
`Maxwell3d.oproject`	Project property.
`Maxwell3d.optimizations`	Optimizations in the project.
`Maxwell3d.oradfield`	AEDT Radiation Field Object.
`Maxwell3d.oreportsetup`	Report setup.
`Maxwell3d.osolution`	Solution Module.
`Maxwell3d.output_variables`	List of output variables.
`Maxwell3d.parametrics`	Setups in the project.
`Maxwell3d.personallib`	PersonalLib directory.
`Maxwell3d.ports`	Design excitations.
`Maxwell3d.post`	PostProcessor.
`Maxwell3d.project_datasets`	Dictionary of project datasets.
`Maxwell3d.project_file`	Project name and path.
`Maxwell3d.project_list`	Project list.
`Maxwell3d.project_name`	Project name.
`Maxwell3d.project_path`	Project path.
`Maxwell3d.project_properties`	Project properties.
`Maxwell3d.project_time_stamp`	Return Project time stamp.
`Maxwell3d.project_timestamp_changed`	Return a bool if time stamp changed or not.
`Maxwell3d.pyaedt_dir`	PyAEDT directory.
`Maxwell3d.results_directory`	Results directory.
`Maxwell3d.settings`	Settings of the current Python/Pyaedt session.
`Maxwell3d.setup_names`	Setup names.
`Maxwell3d.setups`	Setups in the project.
`Maxwell3d.solution_type`	Solution type.
`Maxwell3d.src_dir`	Source directory for Python.
`Maxwell3d.symmetry_multiplier`	Symmetry multiplier.
`Maxwell3d.syslib`	SysLib directory.
`Maxwell3d.temp_directory`	Path to the temporary directory.
`Maxwell3d.toolkit_directory`	Path to the toolkit directory.
`Maxwell3d.userlib`	UserLib directory.
`Maxwell3d.valid_design`	Valid design.
`Maxwell3d.variable_manager`	Variable manager for creating and managing project design and postprocessing variables.
`Maxwell3d.windings`	Windings.
`Maxwell3d.working_directory`	Path to the working directory.