Beam#

class ansys.geometry.core.designer.beam.Beam(id: str, start: ansys.geometry.core.math.point.Point3D, end: ansys.geometry.core.math.point.Point3D, profile: BeamProfile, parent_component: ansys.geometry.core.designer.component.Component)#

Represents a simplified solid body with an assigned 2D cross-section.

This body synchronizes to a design within a supporting Geometry service instance.

Parameters:
idstr

Server-defined ID for the body.

namestr

User-defined label for the body.

startPoint3D

Start of the beam line segment.

endPoint3D

End of the beam line segment.

profileBeamProfile

Beam profile to use to create the beam.

parent_componentComponent

Parent component to nest the new beam under within the design assembly.

Overview#

id

Service-defined ID of the beam.

start

Start of the beam line segment.

end

End of the beam line segment.

profile

Beam profile of the beam line segment.

parent_component

Component node that the beam is under.

is_alive

Flag indicating whether the beam is still alive on the server side.

__repr__

Represent the beam as a string.

Import detail#

from ansys.geometry.core.designer.beam import Beam

Property detail#

property Beam.id: str#

Service-defined ID of the beam.

property Beam.start: ansys.geometry.core.math.point.Point3D#

Start of the beam line segment.

property Beam.end: ansys.geometry.core.math.point.Point3D#

End of the beam line segment.

property Beam.profile: BeamProfile#

Beam profile of the beam line segment.

property Beam.parent_component: beartype.typing.Union[ansys.geometry.core.designer.component.Component, None]#

Component node that the beam is under.

property Beam.is_alive: bool#

Flag indicating whether the beam is still alive on the server side.

Method detail#

Beam.__repr__() str#

Represent the beam as a string.