pyaedt.modeler.Model2D.Modeler2D#

class pyaedt.modeler.Model2D.Modeler2D(application)[source]#

Provides the Modeler 2D application interface.

This class is inherited in the caller application and is accessible through the modeler variable object( eg. maxwell2d.modeler).

Parameters:
applicationpyaedt.application.Analysis2D.FieldAnalysis2D

Examples

>>> from pyaedt import Maxwell2d
>>> app = Maxwell2d()
>>> my_modeler = app.modeler

Methods

Modeler2D.add_new_objects()

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

Modeler2D.add_new_user_defined_component()

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

Modeler2D.automatic_thicken_sheets(...[, ...])

Create thickened sheets for a list of input faces.

Modeler2D.break_spaceclaim_connection()

Break the connection with SpaceClaim.

Modeler2D.calculate_radius_2D(object_name[, ...])

Calculate the extremity of an object in the radial direction.

Modeler2D.chassis_subtraction(chassis_part)

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

Modeler2D.check_plane(obj, faceposition[, ...])

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

Modeler2D.clean_objects_name(main_part_name)

Clean the names of the objects for a main part.

Modeler2D.cleanup_objects()

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

Modeler2D.clone(objid)

Clone objects from a list of object IDs.

Modeler2D.connect(theList)

Connect objects from a list.

Modeler2D.convert_to_selections(objtosplit)

Convert one or more object to selections.

Modeler2D.cover_lines(selection)

Cover a closed line and transform it to sheet.

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

Create an air region.

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

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

Modeler2D.create_circle(position, radius[, ...])

Create a circle.

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

Create a coordinate system.

Modeler2D.create_ellipse(position, ...[, ...])

Create an ellipse.

Modeler2D.create_face_coordinate_system(...)

Create a face coordinate system.

Modeler2D.create_face_list(face_list[, name])

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

Modeler2D.create_faceted_bondwire_from_true_surface(...)

Create a faceted bondwire from an existing true surface bondwire.

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

Group objects or groups into one group.

Modeler2D.create_object_from_edge(edge)

Create a line object from an edge ID or from an pyaedt.modeler.Object3d.EdgePrimitive object.

Modeler2D.create_object_from_face(face)

Create an object from a face.

Modeler2D.create_object_list(object_list[, name])

Create an object list given a list of object names.

Modeler2D.create_outer_facelist(externalobjects)

Create a face list from a list of outer objects.

Modeler2D.create_polyline(position_list[, ...])

Draw a polyline object in the 3D modeler.

Modeler2D.create_rectangle(position, ...[, ...])

Create a rectangle.

Modeler2D.create_region([pad_percent])

Create an air region.

Modeler2D.create_regular_polygon(position, ...)

Create a rectangle.

Modeler2D.create_sheet_to_ground(objectname)

Create a sheet between an object and a ground plane.

Modeler2D.create_spiral_on_face(face, poly_width)

Create a Spiral Polyline inside a face.

Modeler2D.create_udp(udp_dll_name, ...[, ...])

Create a user-defined primitive (UDP).

Modeler2D.delete([objects])

Delete objects or groups.

Modeler2D.delete_objects_containing(...[, ...])

Delete all objects with a given prefix.

Modeler2D.does_object_exists(object)

"Check to see if an object exists.

Modeler2D.duplicate_along_line(objid, vector)

Duplicate a selection along a line.

Modeler2D.duplicate_and_mirror(objid, ...[, ...])

Duplicate and mirror a selection.

Modeler2D.duplicate_around_axis(objid, cs_axis)

Duplicate a selection around an axis.

Modeler2D.edit_region_dimensions(listvalues)

Modify the dimensions of the region.

Modeler2D.explicitly_subtract(diellist, ...)

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

Modeler2D.find_closest_edges(start_obj, end_obj)

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

Modeler2D.find_new_objects()

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

Modeler2D.find_point_around(objectname, ...)

Find the point around an object.

Modeler2D.find_port_faces(port_sheets)

Find the vaccums given a list of input sheets.

Modeler2D.fit_all()

Fit all.

Modeler2D.flatten_assembly()

Flatten the assembly, removing all group trees.

Modeler2D.generate_object_history(objectname)

Generate history for the object.

Modeler2D.get_bodynames_from_position(position)

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

Modeler2D.get_boundaries_name()

Retrieve all boundary names.

Modeler2D.get_bounding_dimension()

Retrieve the dimension array of the bounding box.

Modeler2D.get_closest_edgeid_to_position(...)

Get the edge ID closest to a given position.

Modeler2D.get_edge_length(edgeID)

Get the length of an edge.

Modeler2D.get_edge_midpoint(partID)

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

Modeler2D.get_edge_vertices(edgeID)

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

Modeler2D.get_edgeid_from_position(position)

Get an edge ID from a position.

Modeler2D.get_edgeids_from_vertexid(...)

Retrieve edge IDs for a vertex ID.

Modeler2D.get_edges_for_circuit_port(face_id)

Retrieve two edge IDs suitable for the circuit port.

Modeler2D.get_edges_for_circuit_port_from_sheet(sheet)

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

Modeler2D.get_edges_on_bounding_box(sheets)

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

Modeler2D.get_entitylist_id(name)

Retrieve the ID of an entity list.

Modeler2D.get_equivalent_parallel_edges(edgelist)

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

Modeler2D.get_existing_polyline(object)

Retrieve a polyline object to manipulate it.

Modeler2D.get_face_area(face_id)

Retrieve the area of a given face ID.

Modeler2D.get_face_center(face_id)

Retrieve the center position for a given planar face ID.

Modeler2D.get_face_edges(partId)

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

Modeler2D.get_face_vertices(face_id)

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

Modeler2D.get_faceid_from_position(position)

Retrieve a face ID from a position.

Modeler2D.get_faces_from_materials(mats)

Select all outer faces given a list of materials.

Modeler2D.get_group_bounding_box(group)

Retrieve the bounding box of a group.

Modeler2D.get_line_ids()

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

Modeler2D.get_matched_object_name(search_string)

Retrieve the name of the matched object.

Modeler2D.get_mid_points_on_dir(sheet, axisdir)

Retrieve midpoints on a given axis direction.

Modeler2D.get_model_bounding_box()

Retrieve the model bounding box.

Modeler2D.get_obj_id(objname)

Return the object ID from an object name.

Modeler2D.get_object_edges(partId)

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

Modeler2D.get_object_faces(partId)

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

Modeler2D.get_object_from_name(objname)

Return the object from an object name.

Modeler2D.get_object_name_from_edge_id(edge_id)

Retrieve the object name for a predefined edge ID.

Modeler2D.get_object_vertices(partID)

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

Modeler2D.get_objects_by_material(materialname)

Retrieve a list of the IDs for objects of a specified material.

Modeler2D.get_objects_in_group(group)

Retrieve a list of objects belonging to a group.

Modeler2D.get_objects_w_string(stringname[, ...])

Retrieve all objects with a given string in their names.

Modeler2D.get_solving_volume()

Generate a mesh for a setup.

Modeler2D.get_vertex_position(vertex_id)

Retrieve a vector of vertex coordinates.

Modeler2D.get_vertices_of_line(sLineName)

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

Modeler2D.global_to_cs(point, ref_cs)

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

Modeler2D.import_3d_cad(filename[, healing, ...])

Import a CAD model.

Modeler2D.import_spaceclaim_document(SCFile)

Import a SpaceClaim document.

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

Imprin an object list on another object list.

Modeler2D.imprint_normal_projection(tool_list)

Imprint the normal projection of objects over a sheet.

Modeler2D.imprint_vector_projection(...[, ...])

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

Modeler2D.intersect(theList[, keep_originals])

Intersect objects from a list.

Modeler2D.load_hfss(cadfile)

Load HFSS.

Modeler2D.load_objects_bytype(obj_type)

Load all objects of a specified type.

Modeler2D.load_scdm_in_hfss(SpaceClaimFile)

Load a SpaceClaim file in HFSS.

Modeler2D.mirror(objid, position, vector)

Mirror a selection.

Modeler2D.modeler_variable(value)

Modeler variable.

Modeler2D.move(objid, vector)

Move objects from a list.

Modeler2D.move_edge(edges[, offset])

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

Modeler2D.move_face(faces[, offset])

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

Modeler2D.objects_in_bounding_box(bounding_box)

Given a 2D bounding box, check if sheets and lines are inside it.

Modeler2D.purge_history(theList)

Purge history objects from object names.

Modeler2D.radial_split_2D(radius, name)

Split the stator and rotor for mesh refinement.

Modeler2D.refresh()

Refresh this object.

Modeler2D.refresh_all_ids()

Refresh all IDs.

Modeler2D.remove_point(name)

Remove a point.

Modeler2D.rotate(objid, cs_axis[, angle, unit])

Rotate the selection.

Modeler2D.section(object_list, plane[, ...])

Section the selection.

Modeler2D.select_allfaces_fromobjects(elements)

Select all outer faces given a list of objects.

Modeler2D.separate_bodies(object_list[, ...])

Separate bodies of the selection.

Modeler2D.set_object_model_state(obj_list[, ...])

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

Modeler2D.set_objects_deformation(objects)

Assign deformation objects to a Workbench link.

Modeler2D.set_objects_temperature(objects[, ...])

Assign temperatures to objects.

Modeler2D.set_working_coordinate_system(name)

Set the working coordinate system to another coordinate system.

Modeler2D.setunassigned_mats()

Find unassagned objects and set them to non-model.

Modeler2D.split(objects, plane[, sides])

Split a list of objects.

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

Subtract objects.

Modeler2D.sweep_along_normal(obj_name, face_id)

Sweep the selection along the vector.

Modeler2D.sweep_along_path(objid, sweep_object)

Sweep the selection along a path.

Modeler2D.sweep_along_vector(objid, sweep_vector)

Sweep the selection along a vector.

Modeler2D.sweep_around_axis(objid, cs_axis)

Sweep the selection around the axis.

Modeler2D.thicken_sheet(objid, thickness[, ...])

Thicken the sheet of the selection.

Modeler2D.translate(objid, vector)

Translate objects from a list.

Modeler2D.ungroup(groups)

Ungroup one or more groups.

Modeler2D.unite(theList)

Unite objects from a list.

Modeler2D.update_object(obj)

Update any pyaedt.modeler.Object3d.Object3d derivatives that have potentially been modified by a modeler operation.

Modeler2D.update_udp(object_name, ...)

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

Modeler2D.value_in_object_units(value)

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

Modeler2D.vertex_data_of_lines([txtfilter])

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

Attributes

Modeler2D.coordinate_systems

Coordinate Systems.

Modeler2D.defaultmaterial

Default material.

Modeler2D.design_type

Design type.

Modeler2D.dimension

Dimensions.

Modeler2D.geometry_mode

Geometry mode.

Modeler2D.line_names

List of the names of all line objects.

Modeler2D.line_objects

List of all line objects.

Modeler2D.logger

Logger.

Modeler2D.materials

Material library used in the project.

Modeler2D.model_consistency_report

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

Modeler2D.model_objects

List of the names of all model objects.

Modeler2D.model_units

Model units as a string.

Modeler2D.modeler

Modeler.

Modeler2D.non_model_objects

List of names of all non-model objects.

Modeler2D.object_list

List of all objects.

Modeler2D.object_names

List of the names of all objects.

Modeler2D.obounding_box

Bounding box.

Modeler2D.oeditor

Aedt oEditor Module.

Modeler2D.plane2d

Create a 2D plane.

Modeler2D.points

List of points.

Modeler2D.points_by_name

Dictionary containing all points where the keys are the name of the points.

Modeler2D.primitives

Primitives.

Modeler2D.projdir

Project directory.

Modeler2D.selections

Selections.

Modeler2D.sheet_names

List of the names of all sheet objects.

Modeler2D.sheet_objects

List of all sheet objects.

Modeler2D.solid_bodies

List of Object Names.

Modeler2D.solid_names

List of the names of all solid objects.

Modeler2D.solid_objects

List of all solid objects.

Modeler2D.unclassified_names

List of the names of all unclassified objects.

Modeler2D.unclassified_objects

List of all unclassified objects.

Modeler2D.user_defined_component_names

List of the names of all 3D component objects.

Modeler2D.user_lists

User Lists.

Modeler2D.version

Version.