Skip to main content

Mechanical scripting interface

ElectricVoltageProbe

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.ProbeResults.ElectricVoltageProbe

Bases: object

Defines a ElectricVoltageProbe.

Overview

Methods

Name Description
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.

Properties

Name Description
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.
MaximumVoltageProbe Gets the MaximumVoltageProbe.
MaximumXAxis Gets the MaximumXAxis.
MaximumYAxis Gets the MaximumYAxis.
MaximumZAxis Gets the MaximumZAxis.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
MinimumTotal Gets the MinimumTotal.
MinimumVoltageProbe Gets the MinimumVoltageProbe.
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.
RPMSelection Gets or sets the RPM Selection value at which the results are evaluated.
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.
VoltageProbe Gets the VoltageProbe.
XAxis Gets the XAxis.
YAxis Gets the YAxis.
ZAxis Gets the ZAxis.

Property detail

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

Gets or sets the BeamSelection.

property ElectricVoltageProbe.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 ElectricVoltageProbe.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ContactRegionSelection.

property ElectricVoltageProbe.CoordinateSystemSelection : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystemSelection.

property ElectricVoltageProbe.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property ElectricVoltageProbe.DisplayTime : Ansys.Core.Units.Quantity | None

Gets or sets the DisplayTime.

property ElectricVoltageProbe.DpfEvaluation : Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

property ElectricVoltageProbe.GeometryLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

property ElectricVoltageProbe.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None

Gets the internal object. For advanced usage only.

property ElectricVoltageProbe.IsSolved : bool | None

Gets the IsSolved.

property ElectricVoltageProbe.IterationNumber : int | None

Gets the IterationNumber.

property ElectricVoltageProbe.LoadStep : int | None

Gets the LoadStep.

property ElectricVoltageProbe.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

property ElectricVoltageProbe.LocationMethod : Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None

Gets or sets the LocationMethod.

property ElectricVoltageProbe.MaximumTotal : Ansys.Core.Units.Quantity | None

Gets the MaximumTotal.

property ElectricVoltageProbe.MaximumVoltageProbe : Ansys.Core.Units.Quantity | None

Gets the MaximumVoltageProbe.

property ElectricVoltageProbe.MaximumXAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumXAxis.

property ElectricVoltageProbe.MaximumYAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumYAxis.

property ElectricVoltageProbe.MaximumZAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumZAxis.

property ElectricVoltageProbe.MeshConnectionSelection : Ansys.ACT.Automation.Mechanical.MeshConnection | None

Gets or sets the MeshConnectionSelection.

property ElectricVoltageProbe.MinimumTotal : Ansys.Core.Units.Quantity | None

Gets the MinimumTotal.

property ElectricVoltageProbe.MinimumVoltageProbe : Ansys.Core.Units.Quantity | None

Gets the MinimumVoltageProbe.

property ElectricVoltageProbe.MinimumXAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumXAxis.

property ElectricVoltageProbe.MinimumYAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumYAxis.

property ElectricVoltageProbe.MinimumZAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumZAxis.

property ElectricVoltageProbe.Orientation : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

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

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

Gets the list of properties for this object.

property ElectricVoltageProbe.RPMSelection : Ansys.Core.Units.Quantity | None

Gets or sets the RPM Selection value at which the results are evaluated.

property ElectricVoltageProbe.RemotePointSelection : Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePointSelection.

property ElectricVoltageProbe.ResultSelection : Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None

Gets or sets the ResultSelection.

property ElectricVoltageProbe.SpatialResolution : Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property ElectricVoltageProbe.Substep : int | None

Gets the Substep.

property ElectricVoltageProbe.Summation : Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None

Gets or sets the Summation.

property ElectricVoltageProbe.Suppressed : bool | None

Gets or sets the Suppressed.

property ElectricVoltageProbe.SurfaceSelection : Ansys.ACT.Automation.Mechanical.Surface | None

Gets or sets the MeshConnectionSelection.

property ElectricVoltageProbe.Time : Ansys.Core.Units.Quantity | None

Gets the Time.

property ElectricVoltageProbe.Total : Ansys.Core.Units.Quantity | None

Gets the Total.

property ElectricVoltageProbe.Type : Ansys.Mechanical.DataModel.Enums.ProbeResultType | None

Gets the Type.

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

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

property ElectricVoltageProbe.VoltageProbe : Ansys.Core.Units.Quantity | None

Gets the VoltageProbe.

property ElectricVoltageProbe.XAxis : Ansys.Core.Units.Quantity | None

Gets the XAxis.

property ElectricVoltageProbe.YAxis : Ansys.Core.Units.Quantity | None

Gets the YAxis.

property ElectricVoltageProbe.ZAxis : Ansys.Core.Units.Quantity | None

Gets the ZAxis.

Method detail

ElectricVoltageProbe.Activate()

Activate the current object.

ElectricVoltageProbe.AddComment()

Creates a new child Comment.

ElectricVoltageProbe.AddFigure()

Creates a new child Figure.

ElectricVoltageProbe.AddImage(filePath: str)

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.

ElectricVoltageProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

ElectricVoltageProbe.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

ElectricVoltageProbe.CreateParameter(propName: str)

Creates a new parameter for a Property.

ElectricVoltageProbe.Delete()

Run the Delete action.

ElectricVoltageProbe.Duplicate()

Creates a copy of the current DataModelObject.

ElectricVoltageProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

ElectricVoltageProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

ElectricVoltageProbe.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ElectricVoltageProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ElectricVoltageProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ElectricVoltageProbe.PropertyByAPIName(name: str)

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.

ElectricVoltageProbe.PropertyByName(name: str)

Get a property by its unique name.

ElectricVoltageProbe.RemoveParameter(propName: str)

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

ElectricVoltageProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

ElectricVoltageProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.