Modeler3D#

class ansys.aedt.core.modeler.modeler_3d.Modeler3D(application)[source]#

Provides the Modeler 3D application interface.

This class is inherited in the caller application and is accessible through the modeler variable object. For example, hfss.modeler.

Parameters:
applicationansys.aedt.core.application.analysis_3d.FieldAnalysis3D

Examples

>>> from ansys.aedt.core import Hfss
>>> hfss = Hfss()
>>> my_modeler = hfss.modeler

Methods

Modeler3D.add_bird(input_dir[, speed, ...])

Add a Bird Multipart from 3D Components.

Modeler3D.add_environment(input_dir[, ...])

Add an Environment Multipart Component from JSON file.

Modeler3D.add_new_objects()

Add objects that have been created in the modeler by previous operations.

Modeler3D.add_new_points()

Add objects that have been created in the modeler by previous operations.

Modeler3D.add_new_solids()

Add objects that have been created in the modeler by previous operations.

Modeler3D.add_new_user_defined_component()

Add 3D components and user-defined models that have been created in the modeler by previous operations.

Modeler3D.add_person(input_dir[, speed, ...])

Add a Walking Person Multipart from 3D Components.

Modeler3D.add_vehicle(input_dir[, speed, ...])

Add a Moving Vehicle Multipart from 3D Components.

Modeler3D.automatic_thicken_sheets(...[, ...])

Create thickened sheets for a list of input faces.

Modeler3D.break_spaceclaim_connection()

Disconnect from the running SpaceClaim instance.

Modeler3D.change_region_coordinate_system([...])

Change region coordinate system.

Modeler3D.change_region_padding(...[, ...])

Change region padding settings.

Modeler3D.chassis_subtraction(chassis_part)

Subtract all non-vacuum objects from the main chassis object.

Modeler3D.check_choke_values(input_dir[, ...])

Verify the values in the json file and create another one with corrected values next to the first one.

Modeler3D.check_plane(assignment, face_location)

Check for the plane that is defined as the face for an object.

Modeler3D.clean_objects_name(main_part_name)

Clean the names of the objects for a main part.

Modeler3D.cleanup_objects()

Clean up objects that no longer exist in the modeler because they were removed by previous operations.

Modeler3D.cleanup_points()

Clean up points that no longer exist in the modeler because they were removed by previous operations.

Modeler3D.cleanup_solids()

Clean up solids that no longer exist in the modeler because they were removed by previous operations.

Modeler3D.clone(assignment)

Clone objects from a list of object IDs.

Modeler3D.connect(assignment)

Connect objects from a list.

Modeler3D.convert_segments_to_line(assignment)

Convert a CreatePolyline list of segments to lines.

Modeler3D.convert_to_selections(assignment)

Convert modeler objects.

Modeler3D.copy(assignment)

Copy objects to the clipboard.

Modeler3D.cover_faces(assignment)

Cover a face.

Modeler3D.cover_lines(assignment)

Cover closed lines and transform them to a sheet.

Modeler3D.create_3dcomponent(input_file[, ...])

Create a 3D component file.

Modeler3D.create_air_region([x_pos, y_pos, ...])

Create an air region.

Modeler3D.create_airbox([offset, ...])

Create an airbox that is as big as the bounding extension of the project.

Modeler3D.create_bondwire(start, end[, h1, ...])

Create a bondwire.

Modeler3D.create_box(origin, sizes[, name, ...])

Create a box.

Modeler3D.create_choke(input_file)

Create a choke from a JSON setting file.

Modeler3D.create_circle(orientation, origin, ...)

Create a circle.

Modeler3D.create_coaxial(origin, axis[, ...])

Create a coaxial.

Modeler3D.create_cone(orientation, origin, ...)

Create a cone.

Modeler3D.create_conical_rings(axis, origin, ...)

Create rings in a conical shape.

Modeler3D.create_coordinate_system([origin, ...])

Create a coordinate system.

Modeler3D.create_cylinder(orientation, ...)

Create a cylinder.

Modeler3D.create_ellipse(orientation, ...[, ...])

Create an ellipse.

Modeler3D.create_equationbased_curve([x_t, ...])

Create an equation-based curve.

Modeler3D.create_equationbased_surface([...])

Create an equation-based surface.

Modeler3D.create_face_coordinate_system(...)

Create a face coordinate system.

Modeler3D.create_face_list(assignment[, name])

Create a list of faces given a list of face ID or a list of objects.

Modeler3D.create_faceted_bondwire_from_true_surface(...)

Create a faceted bondwire from an existing true surface bondwire.

Modeler3D.create_group([objects, ...])

Group objects or groups into one group.

Modeler3D.create_helix(assignment, origin, ...)

Create an helix from a polyline.

Modeler3D.create_object_coordinate_system(...)

Create an object coordinate system.

Modeler3D.create_object_from_edge(assignment)

Create an object from one or multiple edges.

Modeler3D.create_object_from_face(assignment)

Create an object from one or multiple face.

Modeler3D.create_object_list(assignment[, name])

Create an object list given a list of object names.

Modeler3D.create_outer_facelist(assignment)

Create a face list from a list of outer objects.

Modeler3D.create_plane([name, plane_base_x, ...])

Create a plane.

Modeler3D.create_point(position[, name, color])

Create a point.

Modeler3D.create_polyhedron([orientation, ...])

Create a regular polyhedron.

Modeler3D.create_polyline(points[, ...])

Draw a polyline object in the 3D modeler.

Modeler3D.create_rectangle(orientation, ...)

Create a rectangle.

Modeler3D.create_region([pad_value, ...])

Create an air region.

Modeler3D.create_sheet_to_ground(assignment)

Create a sheet between an object and a ground plane.

Modeler3D.create_sphere(origin, radius[, ...])

Create a sphere.

Modeler3D.create_spiral([internal_radius, ...])

Create a spiral inductor from a polyline.

Modeler3D.create_spiral_on_face(assignment, ...)

Create a Spiral Polyline inside a face.

Modeler3D.create_subregion(padding_values, ...)

Create a subregion.

Modeler3D.create_torus(origin, major_radius, ...)

Create a torus.

Modeler3D.create_udm(udm_full_name, parameters)

Create a user-defined model.

Modeler3D.create_udp(dll, parameters[, ...])

Create a user-defined primitive (UDP).

Modeler3D.create_waveguide(origin, ...[, ...])

Create a standard waveguide and optionally parametrize W and H.

Modeler3D.delete([assignment])

Delete objects or groups.

Modeler3D.delete_objects_containing(...[, ...])

Delete all objects with a given prefix.

Modeler3D.detach_faces(assignment, faces)

Section the object.

Modeler3D.does_object_exists(assignment)

Check to see if an object exists.

Modeler3D.duplicate_along_line(assignment, ...)

Duplicate a selection along a line.

Modeler3D.duplicate_and_mirror(assignment, ...)

Duplicate and mirror a selection.

Modeler3D.duplicate_around_axis(assignment, axis)

Duplicate a selection around an axis.

Modeler3D.duplicate_coordinate_system_to_global(...)

Create a duplicate coordinate system referenced to the global coordinate system.

Modeler3D.edit_region_dimensions(values)

Modify the dimensions of the region.

Modeler3D.explicitly_subtract(tool_parts, ...)

Explicitly subtract all elements in a SolveInside list and a SolveSurface list.

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

Export the 3D model.

Modeler3D.find_closest_edges(start_object, ...)

Retrieve the two closest edges that are not perpendicular for two objects.

Modeler3D.find_new_objects()

Find any new objects in the modeler that were created by previous operations.

Modeler3D.find_point_around(assignment, ...)

Find the point around an object.

Modeler3D.find_port_faces(assignment)

Find the vacuums given a list of input sheets.

Modeler3D.fit_all()

Fit all.

Modeler3D.flatten_assembly()

Flatten the assembly, removing all group trees.

Modeler3D.generate_object_history(assignment)

Generate history for the object.

Modeler3D.get_3d_component_object_list(name)

Retrieve all objects belonging to a 3D component.

Modeler3D.get_bodynames_from_position(position)

Retrieve the names of the objects that are in contact with a given point.

Modeler3D.get_boundaries_name()

Retrieve all boundary names.

Modeler3D.get_bounding_dimension()

Retrieve the x, y and z size of the bounding box for the model.

Modeler3D.get_closest_edgeid_to_position(...)

Get the edge ID closest to a given position.

Modeler3D.get_edge_length(assignment)

Get the length of an edge.

Modeler3D.get_edge_midpoint(assignment)

Retrieve the midpoint coordinates of a given edge ID or edge name.

Modeler3D.get_edge_vertices(assignment)

Retrieve the vertex IDs of a given edge ID or edge name.

Modeler3D.get_edgeid_from_position(position)

Get an edge ID from a position.

Modeler3D.get_edgeids_from_vertexid(vertex, ...)

Retrieve edge IDs for a vertex ID.

Modeler3D.get_edges_for_circuit_port(assignment)

Retrieve two edge IDs suitable for the circuit port.

Modeler3D.get_edges_for_circuit_port_from_sheet(...)

Retrieve two edge IDs that are suitable for a circuit port from a sheet.

Modeler3D.get_edges_on_bounding_box(assignment)

Retrieve the edges of the sheets passed in the input that are lying on the bounding box.

Modeler3D.get_entitylist_id(name)

Retrieve the ID of an entity list.

Modeler3D.get_equivalent_parallel_edges(...)

Create two new edges that are parallel and equal to the smallest edge given a parallel couple of edges.

Modeler3D.get_existing_polyline(assignment)

Retrieve a polyline object to manipulate it.

Modeler3D.get_face_area(assignment)

Retrieve the area of a given face ID.

Modeler3D.get_face_by_id(assignment)

Get the face object given its ID.

Modeler3D.get_face_center(assignment)

Retrieve the center position for a given planar face ID.

Modeler3D.get_face_edges(assignment)

Retrieve the edge IDs of a given face name or face ID.

Modeler3D.get_face_vertices(assignment)

Retrieve the vertex IDs of a given face ID or face name.

Modeler3D.get_faceid_from_position(position)

Retrieve a face ID from a position.

Modeler3D.get_faces_from_materials(...)

Select all outer faces given a list of materials.

Modeler3D.get_group_bounding_box(group)

Retrieve the bounding box of a group.

Modeler3D.get_line_ids()

Create a dictionary of object IDs for the lines in the design with the line name as the key.

Modeler3D.get_matched_object_name(search_string)

Retrieve the name of the matched object.

Modeler3D.get_mid_points_on_dir(assignment, axis)

Retrieve midpoints on a given axis direction.

Modeler3D.get_model_bounding_box()

Retrieve the model bounding box.

Modeler3D.get_obj_id(assignment)

Return the object ID from an object name.

Modeler3D.get_object_edges(assignment)

Retrieve the edge IDs of a given object ID or object name.

Modeler3D.get_object_faces(assignment)

Retrieve the face IDs of a given object ID or object name.

Modeler3D.get_object_from_name(assignment)

Return the object from an object name.

Modeler3D.get_object_name_from_edge_id(...)

Retrieve the object name for a predefined edge ID.

Modeler3D.get_object_vertices(assignment)

Retrieve the vertex IDs of a given object name or object ID.

Modeler3D.get_objects_by_material([material])

Get a list of objects either of a specified material or classified by material.

Modeler3D.get_objects_in_group(group)

Retrieve a list of objects belonging to a group.

Modeler3D.get_objects_w_string(string_name)

Retrieve all objects with a given string in their names.

Modeler3D.get_solving_volume()

Generate a mesh for a setup.

Modeler3D.get_vertex_position(assignment)

Retrieve a vector of vertex coordinates.

Modeler3D.get_vertices_of_line(assignment)

Generate a list of vertex positions for a line object from AEDT in model units.

Modeler3D.get_working_coordinate_system()

Get the active coordinate system.

Modeler3D.global_to_cs(point, coordinate_system)

Transform a point from the global coordinate system to another coordinate system.

Modeler3D.heal_objects(assignment[, ...])

Repair invalid geometry entities for the selected objects within the specified tolerance settings.

Modeler3D.import_3d_cad(input_file[, ...])

Import a CAD model.

Modeler3D.import_discovery_model(input_file)

Import a Discovery file.

Modeler3D.import_from_openstreet_map(...[, ...])

Import OpenStreet Maps into AEDT.

Modeler3D.import_nastran(file_path[, ...])

Import Nastran file into 3D Modeler by converting the faces to stl and reading it.

Modeler3D.import_primitives_from_file([...])

Import and create primitives from a JSON file or dictionary of properties.

Modeler3D.import_spaceclaim_document(input_file)

Import a SpaceClaim document.

Modeler3D.imprint(blank_list, tool_list[, ...])

Imprin an object list on another object list.

Modeler3D.imprint_normal_projection(assignment)

Imprint the normal projection of objects over a sheet.

Modeler3D.imprint_vector_projection(...[, ...])

Imprint the projection of objects over a sheet with a specified vector and distance.

Modeler3D.insert_3d_component(input_file[, ...])

Insert a new 3D component.

Modeler3D.insert_layout_component(input_file)

Insert a new layout component.

Modeler3D.intersect(assignment[, keep_originals])

Intersect objects from a list.

Modeler3D.invert_cs(coordinate_system[, ...])

Get the inverse translation and the conjugate quaternion of the input coordinate system.

Modeler3D.load_scdm_in_hfss(input_file)

Load a SpaceClaim file in HFSS.

Modeler3D.mirror(assignment, origin, vector)

Mirror a selection.

Modeler3D.modeler_variable(value)

Modeler variable.

Modeler3D.move(assignment, vector)

Move objects from a list.

Modeler3D.move_edge(assignment[, offset])

Move an input edge or a list of input edges of a specific object.

Modeler3D.move_face(assignment[, offset])

Move an input face or a list of input faces of a specific object.

Modeler3D.objects_in_bounding_box(bounding_box)

Given a bounding box checks if objects, sheets and lines are inside it.

Modeler3D.objects_segmentation(assignment[, ...])

Get segmentation of an object given the segmentation thickness or number of segments.

Modeler3D.paste()

Paste objects from the clipboard.

Modeler3D.polyline_segment(type[, num_seg, ...])

New segment of a polyline.

Modeler3D.purge_history(assignment)

Purge history objects from object names.

Modeler3D.reassign_subregion(region, parts)

Modify parts in the subregion.

Modeler3D.reference_cs_to_global(...)

Get the origin and quaternion defining the coordinate system in the global coordinates.

Modeler3D.refresh()

Refresh this object.

Modeler3D.refresh_all_ids()

Refresh all IDs.

Modeler3D.replace_3dcomponent([name, ...])

Replace with 3D component.

Modeler3D.rotate(assignment, axis[, angle, ...])

Rotate the selection.

Modeler3D.scale(assignment[, x, y, z])

Scale a list of objects.

Modeler3D.section(assignment, plane[, ...])

Section the selection.

Modeler3D.select_allfaces_fromobjects(assignment)

Select all outer faces given a list of objects.

Modeler3D.separate_bodies(assignment[, ...])

Separate bodies of the selection.

Modeler3D.set_object_model_state(assignment)

Set a list of objects to either models or non-models.

Modeler3D.set_objects_deformation(assignment)

Assign deformation objects to a Workbench link.

Modeler3D.set_objects_temperature(assignment)

Assign temperatures to objects.

Modeler3D.set_working_coordinate_system(name)

Set the working coordinate system to another coordinate system.

Modeler3D.setunassigned_mats()

Find unassagned objects and set them to non-model.

Modeler3D.simplify_objects(assignment[, ...])

Simplify command to converts complex objects into simpler primitives which are easy to mesh and solve.

Modeler3D.split(assignment[, plane, sides, ...])

Split a list of objects.

Modeler3D.subtract(blank_list, tool_list[, ...])

Subtract objects.

Modeler3D.sweep_along_normal(assignment, faces)

Sweep the selection along the vector.

Modeler3D.sweep_along_path(assignment, ...)

Sweep the selection along a path.

Modeler3D.sweep_along_vector(assignment, ...)

Sweep the selection along a vector.

Modeler3D.sweep_around_axis(assignment, axis)

Sweep the selection around the axis.

Modeler3D.thicken_sheet(assignment, thickness)

Thicken the sheet of the selection.

Modeler3D.ungroup(groups)

Ungroup one or more groups.

Modeler3D.unite(assignment[, purge, ...])

Unite objects from a list.

Modeler3D.update_object(assignment)

Update any ansys.aedt.core.modeler.Object3d.Object3d derivatives that have potentially been modified by a modeler operation.

Modeler3D.update_udp(assignment, operation, ...)

Update an existing geometrical object that was originally created using a user-defined primitive (UDP).

Modeler3D.value_in_object_units(value)

Convert one or more strings for numerical lengths to floating point values.

Modeler3D.vertex_data_of_lines([text_filter])

Generate a dictionary of line vertex data for all lines contained within the design.

Modeler3D.wrap_sheet(sheet, object[, imprinted])

Execute the sheet wrapping around an object.

Attributes

Modeler3D.coordinate_systems

Coordinate systems.

Modeler3D.defaultmaterial

Default material.

Modeler3D.design_type

Design type.

Modeler3D.dimension

Dimensions.

Modeler3D.geometry_mode

Geometry mode.

Modeler3D.layout_component_names

List of the names of all Layout component objects.

Modeler3D.line_names

List of the names of all line objects.

Modeler3D.line_objects

List of all line objects.

Modeler3D.logger

Logger.

Modeler3D.materials

Material library used in the project.

Modeler3D.model_consistency_report

Summary of detected inconsistencies between the AEDT modeler and PyAEDT structures.

Modeler3D.model_objects

List of the names of all model objects.

Modeler3D.model_units

Model units as a string.

Modeler3D.non_model_objects

List of objects of all non-model objects.

Modeler3D.object_list

List of all objects.

Modeler3D.object_names

List of the names of all objects.

Modeler3D.objects_by_name

Object dictionary organized by name.

Modeler3D.obounding_box

Bounding box.

Modeler3D.oeditor

AEDT oEditor module.

Modeler3D.planes

Planes.

Modeler3D.point_names

List of the names of all points.

Modeler3D.point_objects

List of points objects.

Modeler3D.projdir

Project directory.

Modeler3D.selections

Selections.

Modeler3D.sheet_names

List of the names of all sheet objects.

Modeler3D.sheet_objects

List of all sheet objects.

Modeler3D.solid_bodies

List of object names.

Modeler3D.solid_names

List of the names of all solid objects.

Modeler3D.solid_objects

List of all solid objects.

Modeler3D.unclassified_names

List of the names of all unclassified objects.

Modeler3D.unclassified_objects

List of all unclassified objects.

Modeler3D.user_defined_component_names

List of the names of all 3D component objects.

Modeler3D.user_lists

User lists.

Modeler3D.version

Version.