`VolumeProbe`#

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

Bases: object

Defines a VolumeProbe.

Overview#

Methods

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

Properties

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

Property detail#

property VolumeProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None: Gets the internal object. For advanced usage only.

property VolumeProbe.XCoordinate: Ansys.Core.Units.Quantity | None: Gets the XCoordinate.

property VolumeProbe.YCoordinate: Ansys.Core.Units.Quantity | None: Gets the YCoordinate.

property VolumeProbe.ZCoordinate: Ansys.Core.Units.Quantity | None: Gets the ZCoordinate.

property VolumeProbe.MaximumVolume: Ansys.Core.Units.Quantity | None: Gets the MaximumVolume.

property VolumeProbe.MinimumVolume: Ansys.Core.Units.Quantity | None: Gets the MinimumVolume.

property VolumeProbe.VolumeResult: Ansys.Core.Units.Quantity | None: Gets the VolumeResult.

property VolumeProbe.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property VolumeProbe.Summation: Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None: Gets or sets the Summation.

property VolumeProbe.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None: Gets or sets the LocationMethod.

property VolumeProbe.GeometryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the GeometryLocation.

property VolumeProbe.CoordinateSystemSelection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the CoordinateSystemSelection.

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.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None: Gets or sets the ContactRegionSelection.

property VolumeProbe.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None: Gets or sets the RemotePointSelection.

property VolumeProbe.BeamSelection: Ansys.ACT.Automation.Mechanical.Connections.Beam | None: Gets or sets the BeamSelection.

property VolumeProbe.MeshConnectionSelection: Ansys.ACT.Automation.Mechanical.MeshConnection | None: Gets or sets the MeshConnectionSelection.

property VolumeProbe.SurfaceSelection: Ansys.ACT.Automation.Mechanical.Surface | None: Gets or sets the MeshConnectionSelection.

property VolumeProbe.SpringSelection: Ansys.ACT.Automation.Mechanical.Connections.Spring | None: Gets or sets the SpringSelection.

property VolumeProbe.IsSolved: System.Boolean | None: Gets the IsSolved.

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.IterationNumber: System.Int32 | None: Gets the IterationNumber.

property VolumeProbe.LoadStep: System.Int32 | None: Gets the LoadStep.

property VolumeProbe.LoadStepNumber: System.UInt32 | None: Gets or sets the LoadStepNumber.

property VolumeProbe.Substep: System.Int32 | None: Gets the Substep.

property VolumeProbe.DisplayTime: Ansys.Core.Units.Quantity | None: Gets or sets the DisplayTime.

property VolumeProbe.MaximumTotal: Ansys.Core.Units.Quantity | None: Gets the MaximumTotal.

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.MinimumTotal: Ansys.Core.Units.Quantity | None: Gets the MinimumTotal.

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.Time: Ansys.Core.Units.Quantity | None: Gets the Time.

property VolumeProbe.Total: Ansys.Core.Units.Quantity | None: Gets the Total.

property VolumeProbe.XAxis: Ansys.Core.Units.Quantity | None: Gets the XAxis.

property VolumeProbe.YAxis: Ansys.Core.Units.Quantity | None: Gets the YAxis.

property VolumeProbe.ZAxis: Ansys.Core.Units.Quantity | None: Gets the ZAxis.

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.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None: Gets the Type.

property VolumeProbe.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None: Gets or sets the DpfEvaluation.

property VolumeProbe.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property VolumeProbe.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property VolumeProbe.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property VolumeProbe.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property VolumeProbe.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property VolumeProbe.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property VolumeProbe.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property VolumeProbe.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

VolumeProbe.ExportAnimation(filePath: System.String, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) → System.Void: Run the ExportAnimation action.

VolumeProbe.ClearGeneratedData() → System.Void: Run the ClearGeneratedData action.

VolumeProbe.DuplicateWithoutResults() → Ansys.ACT.Automation.Mechanical.DataModelObject: Run the DuplicateWithoutResults action.

VolumeProbe.EvaluateAllResults() → System.Void: Run the EvaluateAllResults action.

VolumeProbe.SnapToMeshNodes() → System.Void: Snap the coordinates of probe result to the mesh nodes.

VolumeProbe.RenameBasedOnDefinition() → System.Void: Run the RenameBasedOnDefinition action.

VolumeProbe.Delete() → System.Void: Run the Delete action.

VolumeProbe.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

VolumeProbe.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

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: System.String) → 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.Activate() → System.Void: Activate the current object.

VolumeProbe.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

VolumeProbe.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

VolumeProbe.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

VolumeProbe.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

VolumeProbe.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

VolumeProbe.PropertyByAPIName(name: System.String) → 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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

VolumeProbe.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

VolumeProbe.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.