VolumeProbe#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.ProbeResults.VolumeProbe#

Bases: object

Defines a VolumeProbe.

Overview#

Activate

Activate the current object.

AddComment

Creates a new child Comment.

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

ClearGeneratedData

Run the ClearGeneratedData action.

CopyTo

Copies all visible properties from this object to another.

CreateParameter

Creates a new parameter for a Property.

Delete

Run the Delete action.

Duplicate

Creates a copy of the current DataModelObject.

DuplicateWithoutResults

Run the DuplicateWithoutResults action.

EvaluateAllResults

Run the EvaluateAllResults action.

ExportAnimation

Run the ExportAnimation action.

GetChildren

Gets the list of children, filtered by type.

GetParameter

Gets the parameter corresponding to the given property.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

PropertyByAPIName

Get a property by its API name.

PropertyByName

Get a property by its unique name.

RemoveParameter

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

RenameBasedOnDefinition

Run the RenameBasedOnDefinition action.

SnapToMeshNodes

Snap the coordinates of probe result to the mesh nodes.

BeamSelection

Gets or sets the BeamSelection.

BoundaryConditionSelection

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

Children

Gets the list of children.

Comments

Gets the list of associated comments.

ContactRegionSelection

Gets or sets the ContactRegionSelection.

CoordinateSystemSelection

Gets or sets the CoordinateSystemSelection.

DataModelObjectCategory

Gets the current DataModelObject's category.

DisplayTime

Gets or sets the DisplayTime.

DpfEvaluation

Gets or sets the DpfEvaluation.

Figures

Gets the list of associated figures.

GeometryLocation

Gets or sets the GeometryLocation.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

IsSolved

Gets the IsSolved.

IterationNumber

Gets the IterationNumber.

LoadStep

Gets the LoadStep.

LoadStepNumber

Gets or sets the LoadStepNumber.

LocationMethod

Gets or sets the LocationMethod.

MaximumTotal

Gets the MaximumTotal.

MaximumVolume

Gets the MaximumVolume.

MaximumXAxis

Gets the MaximumXAxis.

MaximumYAxis

Gets the MaximumYAxis.

MaximumZAxis

Gets the MaximumZAxis.

MeshConnectionSelection

Gets or sets the MeshConnectionSelection.

MinimumTotal

Gets the MinimumTotal.

MinimumVolume

Gets the MinimumVolume.

MinimumXAxis

Gets the MinimumXAxis.

MinimumYAxis

Gets the MinimumYAxis.

MinimumZAxis

Gets the MinimumZAxis.

Orientation

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

Properties

Gets the list of properties for this object.

RemotePointSelection

Gets or sets the RemotePointSelection.

ResultSelection

Gets or sets the ResultSelection.

SpatialResolution

Gets or sets the SpatialResolution.

SpringSelection

Gets or sets the SpringSelection.

Substep

Gets the Substep.

Summation

Gets or sets the Summation.

Suppressed

Gets or sets the Suppressed.

SurfaceSelection

Gets or sets the MeshConnectionSelection.

Time

Gets the Time.

Total

Gets the Total.

Type

Gets the Type.

VisibleProperties

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

VolumeResult

Gets the VolumeResult.

XAxis

Gets the XAxis.

XCoordinate

Gets the XCoordinate.

YAxis

Gets the YAxis.

YCoordinate

Gets the YCoordinate.

ZAxis

Gets the ZAxis.

ZCoordinate

Gets the ZCoordinate.

Property detail#

property VolumeProbe.BeamSelection: Ansys.ACT.Automation.Mechanical.Connections.Beam | None#

Gets or sets the BeamSelection.

property VolumeProbe.BoundaryConditionSelection: Ansys.ACT.Automation.Mechanical.DataModelObject | None#

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

property VolumeProbe.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets the list of children.

property VolumeProbe.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#

Gets the list of associated comments.

property VolumeProbe.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None#

Gets or sets the ContactRegionSelection.

property VolumeProbe.CoordinateSystemSelection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the CoordinateSystemSelection.

property VolumeProbe.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property VolumeProbe.DisplayTime: Ansys.Core.Units.Quantity | None#

Gets or sets the DisplayTime.

property VolumeProbe.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#

Gets or sets the DpfEvaluation.

property VolumeProbe.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#

Gets the list of associated figures.

property VolumeProbe.GeometryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the GeometryLocation.

property VolumeProbe.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#

Gets the list of associated images.

property VolumeProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None#

Gets the internal object. For advanced usage only.

property VolumeProbe.IsSolved: bool | None#

Gets the IsSolved.

property VolumeProbe.IterationNumber: int | None#

Gets the IterationNumber.

property VolumeProbe.LoadStep: int | None#

Gets the LoadStep.

property VolumeProbe.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

property VolumeProbe.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None#

Gets or sets the LocationMethod.

property VolumeProbe.MaximumTotal: Ansys.Core.Units.Quantity | None#

Gets the MaximumTotal.

property VolumeProbe.MaximumVolume: Ansys.Core.Units.Quantity | None#

Gets the MaximumVolume.

property VolumeProbe.MaximumXAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumXAxis.

property VolumeProbe.MaximumYAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumYAxis.

property VolumeProbe.MaximumZAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumZAxis.

property VolumeProbe.MeshConnectionSelection: Ansys.ACT.Automation.Mechanical.MeshConnection | None#

Gets or sets the MeshConnectionSelection.

property VolumeProbe.MinimumTotal: Ansys.Core.Units.Quantity | None#

Gets the MinimumTotal.

property VolumeProbe.MinimumVolume: Ansys.Core.Units.Quantity | None#

Gets the MinimumVolume.

property VolumeProbe.MinimumXAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumXAxis.

property VolumeProbe.MinimumYAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumYAxis.

property VolumeProbe.MinimumZAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumZAxis.

property VolumeProbe.Orientation: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

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

property VolumeProbe.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties for this object.

property VolumeProbe.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None#

Gets or sets the RemotePointSelection.

property VolumeProbe.ResultSelection: Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None#

Gets or sets the ResultSelection.

property VolumeProbe.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None#

Gets or sets the SpatialResolution.

property VolumeProbe.SpringSelection: Ansys.ACT.Automation.Mechanical.Connections.Spring | None#

Gets or sets the SpringSelection.

property VolumeProbe.Substep: int | None#

Gets the Substep.

property VolumeProbe.Summation: Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None#

Gets or sets the Summation.

property VolumeProbe.Suppressed: bool | None#

Gets or sets the Suppressed.

property VolumeProbe.SurfaceSelection: Ansys.ACT.Automation.Mechanical.Surface | None#

Gets or sets the MeshConnectionSelection.

property VolumeProbe.Time: Ansys.Core.Units.Quantity | None#

Gets the Time.

property VolumeProbe.Total: Ansys.Core.Units.Quantity | None#

Gets the Total.

property VolumeProbe.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None#

Gets the Type.

property VolumeProbe.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

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

property VolumeProbe.VolumeResult: Ansys.Core.Units.Quantity | None#

Gets the VolumeResult.

property VolumeProbe.XAxis: Ansys.Core.Units.Quantity | None#

Gets the XAxis.

property VolumeProbe.XCoordinate: Ansys.Core.Units.Quantity | None#

Gets the XCoordinate.

property VolumeProbe.YAxis: Ansys.Core.Units.Quantity | None#

Gets the YAxis.

property VolumeProbe.YCoordinate: Ansys.Core.Units.Quantity | None#

Gets the YCoordinate.

property VolumeProbe.ZAxis: Ansys.Core.Units.Quantity | None#

Gets the ZAxis.

property VolumeProbe.ZCoordinate: Ansys.Core.Units.Quantity | None#

Gets the ZCoordinate.

Method detail#

VolumeProbe.Activate() None#

Activate the current object.

VolumeProbe.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

VolumeProbe.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

VolumeProbe.AddImage(filePath: str) Ansys.ACT.Automation.Mechanical.Image#
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.
VolumeProbe.ClearGeneratedData() None#

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

VolumeProbe.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

VolumeProbe.Delete() None#

Run the Delete action.

VolumeProbe.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

VolumeProbe.DuplicateWithoutResults() Ansys.ACT.Automation.Mechanical.DataModelObject#

Run the DuplicateWithoutResults action.

VolumeProbe.EvaluateAllResults() None#

Run the EvaluateAllResults action.

VolumeProbe.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) None#

Run the ExportAnimation action.

VolumeProbe.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

VolumeProbe.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

VolumeProbe.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

VolumeProbe.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

VolumeProbe.PropertyByAPIName(name: str) Ansys.ACT.Automation.Mechanical.Property#
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.
VolumeProbe.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

VolumeProbe.RemoveParameter(propName: str) None#

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

VolumeProbe.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.

VolumeProbe.SnapToMeshNodes() None#

Snap the coordinates of probe result to the mesh nodes.