## On this page

  

 

 # `BeamTool`

 Last update: 16.07.2025 

<a id="ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.BeamToolResults.BeamTool"></a>

#### *class* Ansys.ACT.Automation.Mechanical.Results.BeamToolResults.BeamTool

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a BeamTool.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#BeamTool.Activate)Activate the current object.[`AddComment`](#BeamTool.AddComment)Creates a new child Comment.[`AddDirectStress`](#BeamTool.AddDirectStress)Creates a new DirectStress[`AddDirectionalDeformation`](#BeamTool.AddDirectionalDeformation)Creates a new DirectionalDeformation[`AddFigure`](#BeamTool.AddFigure)Creates a new child Figure.[`AddImage`](#BeamTool.AddImage)Creates a new child Image.[`AddMaximumBendingStress`](#BeamTool.AddMaximumBendingStress)Creates a new MaximumBendingStress[`AddMaximumCombinedStress`](#BeamTool.AddMaximumCombinedStress)Creates a new MaximumCombinedStress[`AddMinimumBendingStress`](#BeamTool.AddMinimumBendingStress)Creates a new MinimumBendingStress[`AddMinimumCombinedStress`](#BeamTool.AddMinimumCombinedStress)Creates a new MinimumCombinedStress[`AddTotalDeformation`](#BeamTool.AddTotalDeformation)Creates a new TotalDeformation[`CopyTo`](#BeamTool.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#BeamTool.CreateParameter)Creates a new parameter for a Property.[`Delete`](#BeamTool.Delete)Run the Delete action.[`Duplicate`](#BeamTool.Duplicate)Creates a copy of the current DataModelObject.[`EvaluateAllResults`](#BeamTool.EvaluateAllResults)Run the EvaluateAllResults action.[`GetChildren`](#BeamTool.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#BeamTool.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#BeamTool.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#BeamTool.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#BeamTool.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#BeamTool.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#BeamTool.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.### Properties

NameDescription[`Children`](#BeamTool.Children)Gets the list of children.[`Comments`](#BeamTool.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#BeamTool.DataModelObjectCategory)Gets the current DataModelObject’s category.[`Figures`](#BeamTool.Figures)Gets the list of associated figures.[`Images`](#BeamTool.Images)Gets the list of associated images.[`InternalObject`](#BeamTool.InternalObject)Gets the internal object. For advanced usage only.[`Location`](#BeamTool.Location)Gets or sets the Location.[`Properties`](#BeamTool.Properties)Gets the list of properties for this object.[`VisibleProperties`](#BeamTool.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="BeamTool.Children"></a>

### *property* BeamTool.Children *: List\[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="BeamTool.Comments"></a>

### *property* BeamTool.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](../../Comment.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="BeamTool.DataModelObjectCategory"></a>

### *property* BeamTool.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v242.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="BeamTool.Figures"></a>

### *property* BeamTool.Figures *: Iterable\[[Ansys.ACT.Automation.Mechanical.Figure](../../Figure.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Figure)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated figures.

<a id="BeamTool.Images"></a>

### *property* BeamTool.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](../../Image.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="BeamTool.InternalObject"></a>

### *property* BeamTool.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSBeamToolAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="BeamTool.Location"></a>

### *property* BeamTool.Location *: Ansys.ACT.Interfaces.Common.ISelectionInfo | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Location.

<a id="BeamTool.Properties"></a>

### *property* BeamTool.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="BeamTool.VisibleProperties"></a>

### *property* BeamTool.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties that are visible for this object.

<a id="method-detail"></a>

## Method detail

<a id="BeamTool.Activate"></a>

### BeamTool.Activate()

Activate the current object.

<a id="BeamTool.AddComment"></a>

### BeamTool.AddComment()

Creates a new child Comment.

<a id="BeamTool.AddDirectStress"></a>

### BeamTool.AddDirectStress()

Creates a new DirectStress

<a id="BeamTool.AddDirectionalDeformation"></a>

### BeamTool.AddDirectionalDeformation()

Creates a new DirectionalDeformation

<a id="BeamTool.AddFigure"></a>

### BeamTool.AddFigure()

Creates a new child Figure.

<a id="BeamTool.AddImage"></a>

### BeamTool.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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.

```

<a id="BeamTool.AddMaximumBendingStress"></a>

### BeamTool.AddMaximumBendingStress()

Creates a new MaximumBendingStress

<a id="BeamTool.AddMaximumCombinedStress"></a>

### BeamTool.AddMaximumCombinedStress()

Creates a new MaximumCombinedStress

<a id="BeamTool.AddMinimumBendingStress"></a>

### BeamTool.AddMinimumBendingStress()

Creates a new MinimumBendingStress

<a id="BeamTool.AddMinimumCombinedStress"></a>

### BeamTool.AddMinimumCombinedStress()

Creates a new MinimumCombinedStress

<a id="BeamTool.AddTotalDeformation"></a>

### BeamTool.AddTotalDeformation()

Creates a new TotalDeformation

<a id="BeamTool.CopyTo"></a>

### BeamTool.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

<a id="BeamTool.CreateParameter"></a>

### BeamTool.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

<a id="BeamTool.Delete"></a>

### BeamTool.Delete()

Run the Delete action.

<a id="BeamTool.Duplicate"></a>

### BeamTool.Duplicate()

Creates a copy of the current DataModelObject.

<a id="BeamTool.EvaluateAllResults"></a>

### BeamTool.EvaluateAllResults()

Run the EvaluateAllResults action.

<a id="BeamTool.GetChildren"></a>

### BeamTool.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\])

Gets the list of children, filtered by type.

<a id="BeamTool.GetParameter"></a>

### BeamTool.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

<a id="BeamTool.GroupAllSimilarChildren"></a>

### BeamTool.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

<a id="BeamTool.GroupSimilarObjects"></a>

### BeamTool.GroupSimilarObjects()

Run the GroupSimilarObjects action.

<a id="BeamTool.PropertyByAPIName"></a>

### BeamTool.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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.

```

<a id="BeamTool.PropertyByName"></a>

### BeamTool.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

<a id="BeamTool.RemoveParameter"></a>

### BeamTool.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Removes the parameter from the parameter set corresponding to the given property.