.. vale off :class:`BodyInteractions` ========================= .. py:class:: ansys.mechanical.stubs.Ansys.ACT.Automation.Mechanical.Connections.BodyInteractions Bases: :py:obj:`object` Defines a BodyInteractions. .. !! processed by numpydoc !! .. py:currentmodule:: BodyInteractions Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~AddBodyInteraction` - Creates a new child BodyInteraction. * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~BodySelfContact` - Gets or sets the BodySelfContact. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~ContactDetection` - Gets or sets the ContactDetection. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~EdgeOnEdgeContact` - Gets or sets the EdgeOnEdgeContact. * - :py:attr:`~ElementSelfContact` - Gets or sets the ElementSelfContact. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~Formulation` - Gets or sets the Formulation. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~LimitingTimestepVelocity` - Gets or sets the LimitingTimestepVelocity. * - :py:attr:`~ManualContactTreatment` - Gets or sets the ManualContactTreatment. * - :py:attr:`~NodalShellThickness` - Gets or sets the NodalShellThickness. * - :py:attr:`~PinballFactor` - Gets or sets the PinballFactor. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~ShellThicknessFactor` - Gets or sets the ShellThicknessFactor. * - :py:attr:`~SlidingContact` - Gets or sets the SlidingContact. * - :py:attr:`~TimestepSafetyFactor` - Gets or sets the TimestepSafetyFactor. * - :py:attr:`~Tolerance` - Gets or sets the Tolerance. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: BodySelfContact :type: Optional[Ansys.Mechanical.DataModel.Enums.YesNoProgrammedControlled] Gets or sets the BodySelfContact. .. !! processed by numpydoc !! .. py:property:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: ContactDetection :type: Optional[Ansys.Mechanical.DataModel.Enums.ContactDetection] Gets or sets the ContactDetection. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: EdgeOnEdgeContact :type: Optional[bool] Gets or sets the EdgeOnEdgeContact. .. !! processed by numpydoc !! .. py:property:: ElementSelfContact :type: Optional[Ansys.Mechanical.DataModel.Enums.YesNoProgrammedControlled] Gets or sets the ElementSelfContact. .. !! processed by numpydoc !! .. py:property:: Figures :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: Formulation :type: Optional[Ansys.Mechanical.DataModel.Enums.BodyInteractionFormulation] Gets or sets the Formulation. .. !! processed by numpydoc !! .. py:property:: Images :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSBodyInteractionGroupAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: LimitingTimestepVelocity :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the LimitingTimestepVelocity. .. !! processed by numpydoc !! .. py:property:: ManualContactTreatment :type: Optional[Ansys.Mechanical.DataModel.Enums.ManualContactTreatmentType] Gets or sets the ManualContactTreatment. .. !! processed by numpydoc !! .. py:property:: NodalShellThickness :type: Optional[Ansys.Mechanical.DataModel.Enums.YesNoProgrammedControlled] Gets or sets the NodalShellThickness. .. !! processed by numpydoc !! .. py:property:: PinballFactor :type: Optional[float] Gets or sets the PinballFactor. .. !! processed by numpydoc !! .. py:property:: Properties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: ShellThicknessFactor :type: Optional[float] Gets or sets the ShellThicknessFactor. .. !! processed by numpydoc !! .. py:property:: SlidingContact :type: Optional[Ansys.Mechanical.DataModel.Enums.SlidingContactType] Gets or sets the SlidingContact. .. !! processed by numpydoc !! .. py:property:: TimestepSafetyFactor :type: Optional[float] Gets or sets the TimestepSafetyFactor. .. !! processed by numpydoc !! .. py:property:: Tolerance :type: Optional[float] Gets or sets the Tolerance. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: Activate() -> None Activate the current object. .. !! processed by numpydoc !! .. py:method:: AddBodyInteraction() -> Ansys.ACT.Automation.Mechanical.Connections.BodyInteraction Creates a new child BodyInteraction. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: str) -> Ansys.ACT.Automation.Mechanical.Image .. code-block:: text Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the image will be a screen capture of the Geometry window. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> None Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: Delete() -> None Run the Delete action. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: bool, children: List[ChildrenType]) -> List[ChildrenType] Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> None Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: str) -> Ansys.ACT.Automation.Mechanical.Property .. code-block:: text Get a property by its API name. If multiple properties have the same API Name, only the first property with that name will be returned. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: str) -> Ansys.ACT.Automation.Mechanical.Property Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: str) -> None Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on