`Design`#

class ansys.geometry.core.designer.design.Design(name: str, modeler: ansys.geometry.core.modeler.Modeler, read_existing_design: bool = False)#

Bases: ansys.geometry.core.designer.component.Component

Provides for organizing geometry assemblies.

This class synchronizes to a supporting Geometry service instance.

Parameters:

namestr: User-defined label for the design.
grpc_clientGrpcClient: Active supporting Geometry service instance for design modeling.
read_existing_designbool, default: False: Whether an existing design on the service should be read. This parameter is only valid when connecting to an existing service session. Otherwise, avoid using this optional parameter.

Overview#

Methods

`add_material`	Add a material to the design.
`save`	Save a design to disk on the active Geometry server instance.
`download`	Export and download the design from the server.
`export_to_scdocx`	Export the design to an scdocx file.
`export_to_parasolid_text`	Export the design to a Parasolid text file.
`export_to_parasolid_bin`	Export the design to a Parasolid binary file.
`export_to_fmd`	Export the design to an FMD file.
`export_to_step`	Export the design to a STEP file.
`export_to_iges`	Export the design to an IGES file.
`export_to_pmdb`	Export the design to a PMDB file.
`create_named_selection`	Create a named selection on the active Geometry server instance.
`delete_named_selection`	Delete a named selection on the active Geometry server instance.
`delete_component`	Delete a component (itself or its children).
`set_shared_topology`	Set the shared topology to apply to the component.
`add_beam_circular_profile`	Add a new beam circular profile under the design for creating beams.
`add_midsurface_thickness`	Add a mid-surface thickness to a list of bodies.
`add_midsurface_offset`	Add a mid-surface offset type to a list of bodies.
`delete_beam_profile`	Remove a beam profile on the active geometry server instance.
`insert_file`	Insert a file into the design.

Properties

`design_id`	The design’s object unique id.
`materials`	List of materials available for the design.
`named_selections`	List of named selections available for the design.
`beam_profiles`	List of beam profile available for the design.
`is_active`	Whether the design is currently active.

Special methods

__repr__

Represent the Design as a string.

Import detail#

from ansys.geometry.core.designer.design import Design

Property detail#

property Design.design_id: str#: The design’s object unique id.

property Design.materials: beartype.typing.List[ansys.geometry.core.materials.material.Material]#: List of materials available for the design.

property Design.named_selections: beartype.typing.List[ansys.geometry.core.designer.selection.NamedSelection]#: List of named selections available for the design.

property Design.beam_profiles: beartype.typing.List[ansys.geometry.core.designer.beam.BeamProfile]#: List of beam profile available for the design.

property Design.is_active: bool#: Whether the design is currently active.

Method detail#

Design.add_material(material: ansys.geometry.core.materials.material.Material) → None#

Add a material to the design.

Parameters:

materialMaterial: Material to add.

Design.save(file_location: beartype.typing.Union[pathlib.Path, str]) → None#

Save a design to disk on the active Geometry server instance.

Parameters:

file_locationUnion[Path, str]: Location on disk to save the file to.

Design.download(file_location: beartype.typing.Union[pathlib.Path, str], format: beartype.typing.Optional[DesignFileFormat] = DesignFileFormat.SCDOCX) → None#

Export and download the design from the server.

Parameters:

file_locationUnion[Path, str]: Location on disk to save the file to.
format :DesignFileFormat, default: DesignFileFormat.SCDOCX: Format for the file to save to.

Design.export_to_scdocx(location: beartype.typing.Union[pathlib.Path, str] = None) → str#

Export the design to an scdocx file.

Parameters:

locationUnion[Path, str], optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

str: The path to the saved file.

Design.export_to_parasolid_text(location: beartype.typing.Union[pathlib.Path, str] = None) → str#

Export the design to a Parasolid text file.

Parameters:

locationUnion[Path, str], optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

str: The path to the saved file.

Design.export_to_parasolid_bin(location: beartype.typing.Union[pathlib.Path, str] = None) → str#

Export the design to a Parasolid binary file.

Parameters:

locationUnion[Path, str], optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

str: The path to the saved file.

Design.export_to_fmd(location: beartype.typing.Union[pathlib.Path, str] = None) → str#

Export the design to an FMD file.

Parameters:

locationUnion[Path, str], optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

str: The path to the saved file.

Design.export_to_step(location: beartype.typing.Union[pathlib.Path, str] = None) → str#

Export the design to a STEP file.

Parameters:

locationUnion[Path, str], optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

str: The path to the saved file.

Design.export_to_iges(location: beartype.typing.Union[pathlib.Path, str] = None) → str#

Export the design to an IGES file.

Parameters:

locationUnion[Path, str], optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

str: The path to the saved file.

Design.export_to_pmdb(location: beartype.typing.Union[pathlib.Path, str] = None) → str#

Export the design to a PMDB file.

Parameters:

locationUnion[Path, str], optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

str: The path to the saved file.

Design.create_named_selection(name: str, bodies: beartype.typing.Optional[beartype.typing.List[ansys.geometry.core.designer.body.Body]] = None, faces: beartype.typing.Optional[beartype.typing.List[ansys.geometry.core.designer.face.Face]] = None, edges: beartype.typing.Optional[beartype.typing.List[ansys.geometry.core.designer.edge.Edge]] = None, beams: beartype.typing.Optional[beartype.typing.List[ansys.geometry.core.designer.beam.Beam]] = None, design_points: beartype.typing.Optional[beartype.typing.List[ansys.geometry.core.designer.designpoint.DesignPoint]] = None) → ansys.geometry.core.designer.selection.NamedSelection#

Create a named selection on the active Geometry server instance.

Parameters:

namestr: User-defined name for the named selection.
bodiesList[Body], default: None: All bodies to include in the named selection.
facesList[Face], default: None: All faces to include in the named selection.
edgesList[Edge], default: None: All edges to include in the named selection.
beamsList[Beam], default: None: All beams to include in the named selection.
design_pointsList[DesignPoint], default: None: All design points to include in the named selection.

Returns:

NamedSelection: Newly created named selection that maintains references to all target entities.

Design.delete_named_selection(named_selection: beartype.typing.Union[ansys.geometry.core.designer.selection.NamedSelection, str]) → None#

Delete a named selection on the active Geometry server instance.

Parameters:

named_selectionUnion[NamedSelection, str]: Name of the named selection or instance.

Design.delete_component(component: beartype.typing.Union[ansys.geometry.core.designer.component.Component, str]) → None#

Delete a component (itself or its children).

Parameters:

idUnion[Component, str]: Name of the component or instance to delete.

Raises:

ValueError: The design itself cannot be deleted.

Notes

If the component is not this component (or its children), it is not deleted.

Design.set_shared_topology(share_type: ansys.geometry.core.designer.component.SharedTopologyType) → None#

Set the shared topology to apply to the component.

Parameters:

share_typeSharedTopologyType: Shared topology type to assign.

Raises:

ValueError: Shared topology does not apply to a design.

Design.add_beam_circular_profile(name: str, radius: beartype.typing.Union[pint.Quantity, ansys.geometry.core.misc.measurements.Distance], center: beartype.typing.Union[numpy.ndarray, ansys.geometry.core.typing.RealSequence, ansys.geometry.core.math.point.Point3D] = ZERO_POINT3D, direction_x: beartype.typing.Union[numpy.ndarray, ansys.geometry.core.typing.RealSequence, ansys.geometry.core.math.vector.UnitVector3D, ansys.geometry.core.math.vector.Vector3D] = UNITVECTOR3D_X, direction_y: beartype.typing.Union[numpy.ndarray, ansys.geometry.core.typing.RealSequence, ansys.geometry.core.math.vector.UnitVector3D, ansys.geometry.core.math.vector.Vector3D] = UNITVECTOR3D_Y) → ansys.geometry.core.designer.beam.BeamCircularProfile#

Add a new beam circular profile under the design for creating beams.

Parameters:

namestr: User-defined label for the new beam circular profile.
radiusReal: Radius of the beam circular profile.
centerUnion[ndarray, RealSequence, Point3D]: Center of the beam circular profile.
direction_xUnion[ndarray, RealSequence, UnitVector3D, Vector3D]: X-plane direction.
direction_yUnion[ndarray, RealSequence, UnitVector3D, Vector3D]: Y-plane direction.

Design.add_midsurface_thickness(thickness: pint.Quantity, bodies: beartype.typing.List[ansys.geometry.core.designer.body.Body]) → None#

Add a mid-surface thickness to a list of bodies.

Parameters:

thicknessQuantity: Thickness to be assigned.
bodiesList[Body]: All bodies to include in the mid-surface thickness assignment.

Notes

Only surface bodies will be eligible for mid-surface thickness assignment.

Design.add_midsurface_offset(offset_type: ansys.geometry.core.designer.body.MidSurfaceOffsetType, bodies: beartype.typing.List[ansys.geometry.core.designer.body.Body]) → None#

Add a mid-surface offset type to a list of bodies.

Parameters:

offset_typeMidSurfaceOffsetType: Surface offset to be assigned.
bodiesList[Body]: All bodies to include in the mid-surface offset assignment.

Notes

Only surface bodies will be eligible for mid-surface offset assignment.

Design.delete_beam_profile(beam_profile: beartype.typing.Union[ansys.geometry.core.designer.beam.BeamProfile, str]) → None#

Remove a beam profile on the active geometry server instance.

Parameters:

beam_profileUnion[BeamProfile, str]: A beam profile name or instance that should be deleted.

Design.insert_file(file_location: beartype.typing.Union[pathlib.Path, str]) → ansys.geometry.core.designer.component.Component#

Insert a file into the design.

Parameters:

file_locationUnion[Path, str]: Location on disk where the file is located.

Returns:

Component: The newly inserted component.

Design.__repr__() → str#: Represent the Design as a string.

Design#

Overview#

Import detail#

Property detail#

Method detail#

`Design`#