## On this page

  

 

 # `VolumeProbe`

 Last update: 16.07.2025 

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

#### *class* Ansys.ACT.Automation.Mechanical.Results.ProbeResults.VolumeProbe

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

Defines a VolumeProbe.

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

## Overview

### Methods

NameDescription[`Activate`](#VolumeProbe.Activate)Activate the current object.[`AddComment`](#VolumeProbe.AddComment)Creates a new child Comment.[`AddFigure`](#VolumeProbe.AddFigure)Creates a new child Figure.[`AddImage`](#VolumeProbe.AddImage)Creates a new child Image.[`ClearGeneratedData`](#VolumeProbe.ClearGeneratedData)Run the ClearGeneratedData action.[`CopyTo`](#VolumeProbe.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#VolumeProbe.CreateParameter)Creates a new parameter for a Property.[`Delete`](#VolumeProbe.Delete)Run the Delete action.[`Duplicate`](#VolumeProbe.Duplicate)Creates a copy of the current DataModelObject.[`DuplicateWithoutResults`](#VolumeProbe.DuplicateWithoutResults)Run the DuplicateWithoutResults action.[`EvaluateAllResults`](#VolumeProbe.EvaluateAllResults)Run the EvaluateAllResults action.[`ExportAnimation`](#VolumeProbe.ExportAnimation)Run the ExportAnimation action.[`GetChildren`](#VolumeProbe.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#VolumeProbe.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#VolumeProbe.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#VolumeProbe.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#VolumeProbe.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#VolumeProbe.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#VolumeProbe.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.[`RenameBasedOnDefinition`](#VolumeProbe.RenameBasedOnDefinition)Run the RenameBasedOnDefinition action.[`SnapToMeshNodes`](#VolumeProbe.SnapToMeshNodes)Snap the coordinates of probe result to the mesh nodes.### Properties

NameDescription[`BeamSelection`](#VolumeProbe.BeamSelection)Gets or sets the BeamSelection.[`BoundaryConditionSelection`](#VolumeProbe.BoundaryConditionSelection)Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.[`Children`](#VolumeProbe.Children)Gets the list of children.[`Comments`](#VolumeProbe.Comments)Gets the list of associated comments.[`ContactRegionSelection`](#VolumeProbe.ContactRegionSelection)Gets or sets the ContactRegionSelection.[`CoordinateSystemSelection`](#VolumeProbe.CoordinateSystemSelection)Gets or sets the CoordinateSystemSelection.[`DataModelObjectCategory`](#VolumeProbe.DataModelObjectCategory)Gets the current DataModelObject’s category.[`DisplayTime`](#VolumeProbe.DisplayTime)Gets or sets the DisplayTime.[`DpfEvaluation`](#VolumeProbe.DpfEvaluation)Gets or sets the DpfEvaluation.[`Figures`](#VolumeProbe.Figures)Gets the list of associated figures.[`GeometryLocation`](#VolumeProbe.GeometryLocation)Gets or sets the GeometryLocation.[`Images`](#VolumeProbe.Images)Gets the list of associated images.[`InternalObject`](#VolumeProbe.InternalObject)Gets the internal object. For advanced usage only.[`IsSolved`](#VolumeProbe.IsSolved)Gets the IsSolved.[`IterationNumber`](#VolumeProbe.IterationNumber)Gets the IterationNumber.[`LoadStep`](#VolumeProbe.LoadStep)Gets the LoadStep.[`LoadStepNumber`](#VolumeProbe.LoadStepNumber)Gets or sets the LoadStepNumber.[`LocationMethod`](#VolumeProbe.LocationMethod)Gets or sets the LocationMethod.[`MaximumTotal`](#VolumeProbe.MaximumTotal)Gets the MaximumTotal.[`MaximumVolume`](#VolumeProbe.MaximumVolume)Gets the MaximumVolume.[`MaximumXAxis`](#VolumeProbe.MaximumXAxis)Gets the MaximumXAxis.[`MaximumYAxis`](#VolumeProbe.MaximumYAxis)Gets the MaximumYAxis.[`MaximumZAxis`](#VolumeProbe.MaximumZAxis)Gets the MaximumZAxis.[`MeshConnectionSelection`](#VolumeProbe.MeshConnectionSelection)Gets or sets the MeshConnectionSelection.[`MinimumTotal`](#VolumeProbe.MinimumTotal)Gets the MinimumTotal.[`MinimumVolume`](#VolumeProbe.MinimumVolume)Gets the MinimumVolume.[`MinimumXAxis`](#VolumeProbe.MinimumXAxis)Gets the MinimumXAxis.[`MinimumYAxis`](#VolumeProbe.MinimumYAxis)Gets the MinimumYAxis.[`MinimumZAxis`](#VolumeProbe.MinimumZAxis)Gets the MinimumZAxis.[`Orientation`](#VolumeProbe.Orientation)Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.[`Properties`](#VolumeProbe.Properties)Gets the list of properties for this object.[`RemotePointSelection`](#VolumeProbe.RemotePointSelection)Gets or sets the RemotePointSelection.[`ResultSelection`](#VolumeProbe.ResultSelection)Gets or sets the ResultSelection.[`SpatialResolution`](#VolumeProbe.SpatialResolution)Gets or sets the SpatialResolution.[`SpringSelection`](#VolumeProbe.SpringSelection)Gets or sets the SpringSelection.[`Substep`](#VolumeProbe.Substep)Gets the Substep.[`Summation`](#VolumeProbe.Summation)Gets or sets the Summation.[`Suppressed`](#VolumeProbe.Suppressed)Gets or sets the Suppressed.[`SurfaceSelection`](#VolumeProbe.SurfaceSelection)Gets or sets the MeshConnectionSelection.[`Time`](#VolumeProbe.Time)Gets the Time.[`Total`](#VolumeProbe.Total)Gets the Total.[`Type`](#VolumeProbe.Type)Gets the Type.[`VisibleProperties`](#VolumeProbe.VisibleProperties)Gets the list of properties that are visible for this object.[`VolumeResult`](#VolumeProbe.VolumeResult)Gets the VolumeResult.[`XAxis`](#VolumeProbe.XAxis)Gets the XAxis.[`XCoordinate`](#VolumeProbe.XCoordinate)Gets the XCoordinate.[`YAxis`](#VolumeProbe.YAxis)Gets the YAxis.[`YCoordinate`](#VolumeProbe.YCoordinate)Gets the YCoordinate.[`ZAxis`](#VolumeProbe.ZAxis)Gets the ZAxis.[`ZCoordinate`](#VolumeProbe.ZCoordinate)Gets the ZCoordinate.<a id="property-detail"></a>

## Property detail

<a id="VolumeProbe.BeamSelection"></a>

### *property* VolumeProbe.BeamSelection *: [Ansys.ACT.Automation.Mechanical.Connections.Beam](../../Connections/Beam.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Connections.Beam) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BeamSelection.

<a id="VolumeProbe.BoundaryConditionSelection"></a>

### *property* VolumeProbe.BoundaryConditionSelection *: Ansys.ACT.Automation.Mechanical.DataModelObject | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.

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

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

Gets the list of children.

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

### *property* VolumeProbe.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="VolumeProbe.ContactRegionSelection"></a>

### *property* VolumeProbe.ContactRegionSelection *: [Ansys.ACT.Automation.Mechanical.Connections.ContactRegion](../../Connections/ContactRegion.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Connections.ContactRegion) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ContactRegionSelection.

<a id="VolumeProbe.CoordinateSystemSelection"></a>

### *property* VolumeProbe.CoordinateSystemSelection *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../../CoordinateSystem.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the CoordinateSystemSelection.

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

### *property* VolumeProbe.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="VolumeProbe.DisplayTime"></a>

### *property* VolumeProbe.DisplayTime *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DisplayTime.

<a id="VolumeProbe.DpfEvaluation"></a>

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

Gets or sets the DpfEvaluation.

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

### *property* VolumeProbe.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="VolumeProbe.GeometryLocation"></a>

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

Gets or sets the GeometryLocation.

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

### *property* VolumeProbe.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="VolumeProbe.InternalObject"></a>

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

Gets the internal object. For advanced usage only.

<a id="VolumeProbe.IsSolved"></a>

### *property* VolumeProbe.IsSolved *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the IsSolved.

<a id="VolumeProbe.IterationNumber"></a>

### *property* VolumeProbe.IterationNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the IterationNumber.

<a id="VolumeProbe.LoadStep"></a>

### *property* VolumeProbe.LoadStep *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the LoadStep.

<a id="VolumeProbe.LoadStepNumber"></a>

### *property* VolumeProbe.LoadStepNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LoadStepNumber.

<a id="VolumeProbe.LocationMethod"></a>

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

Gets or sets the LocationMethod.

<a id="VolumeProbe.MaximumTotal"></a>

### *property* VolumeProbe.MaximumTotal *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumTotal.

<a id="VolumeProbe.MaximumVolume"></a>

### *property* VolumeProbe.MaximumVolume *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumVolume.

<a id="VolumeProbe.MaximumXAxis"></a>

### *property* VolumeProbe.MaximumXAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumXAxis.

<a id="VolumeProbe.MaximumYAxis"></a>

### *property* VolumeProbe.MaximumYAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumYAxis.

<a id="VolumeProbe.MaximumZAxis"></a>

### *property* VolumeProbe.MaximumZAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumZAxis.

<a id="VolumeProbe.MeshConnectionSelection"></a>

### *property* VolumeProbe.MeshConnectionSelection *: [Ansys.ACT.Automation.Mechanical.MeshConnection](../../MeshConnection.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.MeshConnection) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MeshConnectionSelection.

<a id="VolumeProbe.MinimumTotal"></a>

### *property* VolumeProbe.MinimumTotal *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumTotal.

<a id="VolumeProbe.MinimumVolume"></a>

### *property* VolumeProbe.MinimumVolume *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumVolume.

<a id="VolumeProbe.MinimumXAxis"></a>

### *property* VolumeProbe.MinimumXAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumXAxis.

<a id="VolumeProbe.MinimumYAxis"></a>

### *property* VolumeProbe.MinimumYAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumYAxis.

<a id="VolumeProbe.MinimumZAxis"></a>

### *property* VolumeProbe.MinimumZAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumZAxis.

<a id="VolumeProbe.Orientation"></a>

### *property* VolumeProbe.Orientation *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../../CoordinateSystem.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.

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

### *property* VolumeProbe.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="VolumeProbe.RemotePointSelection"></a>

### *property* VolumeProbe.RemotePointSelection *: [Ansys.ACT.Automation.Mechanical.RemotePoint](../../RemotePoint.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.RemotePoint) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RemotePointSelection.

<a id="VolumeProbe.ResultSelection"></a>

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

Gets or sets the ResultSelection.

<a id="VolumeProbe.SpatialResolution"></a>

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

Gets or sets the SpatialResolution.

<a id="VolumeProbe.SpringSelection"></a>

### *property* VolumeProbe.SpringSelection *: [Ansys.ACT.Automation.Mechanical.Connections.Spring](../../Connections/Spring.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Connections.Spring) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SpringSelection.

<a id="VolumeProbe.Substep"></a>

### *property* VolumeProbe.Substep *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Substep.

<a id="VolumeProbe.Summation"></a>

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

Gets or sets the Summation.

<a id="VolumeProbe.Suppressed"></a>

### *property* VolumeProbe.Suppressed *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Suppressed.

<a id="VolumeProbe.SurfaceSelection"></a>

### *property* VolumeProbe.SurfaceSelection *: [Ansys.ACT.Automation.Mechanical.Surface](../../Surface.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Surface) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MeshConnectionSelection.

<a id="VolumeProbe.Time"></a>

### *property* VolumeProbe.Time *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Time.

<a id="VolumeProbe.Total"></a>

### *property* VolumeProbe.Total *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Total.

<a id="VolumeProbe.Type"></a>

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

Gets the Type.

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

### *property* VolumeProbe.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="VolumeProbe.VolumeResult"></a>

### *property* VolumeProbe.VolumeResult *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the VolumeResult.

<a id="VolumeProbe.XAxis"></a>

### *property* VolumeProbe.XAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XAxis.

<a id="VolumeProbe.XCoordinate"></a>

### *property* VolumeProbe.XCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XCoordinate.

<a id="VolumeProbe.YAxis"></a>

### *property* VolumeProbe.YAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the YAxis.

<a id="VolumeProbe.YCoordinate"></a>

### *property* VolumeProbe.YCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the YCoordinate.

<a id="VolumeProbe.ZAxis"></a>

### *property* VolumeProbe.ZAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ZAxis.

<a id="VolumeProbe.ZCoordinate"></a>

### *property* VolumeProbe.ZCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ZCoordinate.

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

## Method detail

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

### VolumeProbe.Activate()

Activate the current object.

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

### VolumeProbe.AddComment()

Creates a new child Comment.

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

### VolumeProbe.AddFigure()

Creates a new child Figure.

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

### VolumeProbe.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="VolumeProbe.ClearGeneratedData"></a>

### VolumeProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

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

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### VolumeProbe.Delete()

Run the Delete action.

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

### VolumeProbe.Duplicate()

Creates a copy of the current DataModelObject.

<a id="VolumeProbe.DuplicateWithoutResults"></a>

### VolumeProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

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

### VolumeProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

<a id="VolumeProbe.ExportAnimation"></a>

### VolumeProbe.ExportAnimation(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str), format: [Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat](../../../../../Mechanical/DataModel/Enums/GraphicsAnimationExportFormat.md#ansys.mechanical.stubs.v242.Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat), settings: [Ansys.Mechanical.Graphics.AnimationExportSettings](../../../../../Mechanical/Graphics/AnimationExportSettings.md#ansys.mechanical.stubs.v242.Ansys.Mechanical.Graphics.AnimationExportSettings))

Run the ExportAnimation action.

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

### VolumeProbe.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="VolumeProbe.GetParameter"></a>

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

Gets the parameter corresponding to the given property.

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

### VolumeProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### VolumeProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### VolumeProbe.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="VolumeProbe.PropertyByName"></a>

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

Get a property by its unique name.

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

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

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

<a id="VolumeProbe.RenameBasedOnDefinition"></a>

### VolumeProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

<a id="VolumeProbe.SnapToMeshNodes"></a>

### VolumeProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.