Skip to main content

Mechanical scripting interface

EnergyProbe

Last update: 14.01.2025

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

Bases: object

Defines a EnergyProbe.

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’.
By Gets or sets the By.
Children Gets the list of children.
Comments Gets the list of associated comments.
ContactEnergy Gets the ContactEnergy.
ContactRegionSelection Gets or sets the ContactRegionSelection.
CoordinateSystemSelection Gets or sets the CoordinateSystemSelection.
DampingEnergy Gets the DampingEnergy.
DataModelObjectCategory Gets the current DataModelObject’s category.
DisplayTime Gets or sets the DisplayTime.
DpfEvaluation Gets or sets the DpfEvaluation.
ExternalEnergy Gets the ExternalEnergy.
Figures Gets the list of associated figures.
Frequency Gets or sets the Frequency.
GeometryLocation Gets or sets the GeometryLocation.
HourglassEnergy Gets the HourglassEnergy.
Images Gets the list of associated images.
InternalEnergy Gets the InternalEnergy.
InternalObject Gets the internal object. For advanced usage only.
IsSolved Gets the IsSolved.
IterationNumber Gets the IterationNumber.
KineticEnergy Gets the KineticEnergy.
LoadStep Gets the LoadStep.
LoadStepNumber Gets or sets the LoadStepNumber.
LocationMethod Gets or sets the LocationMethod.
MagnetostaticCoEnergy Gets the MagnetostaticCoEnergy.
MaxMagnetostaticCoEnergyOverTime Gets the MaxMagnetostaticCoEnergyOverTime.
MaximumContactEnergy Gets the MaximumContactEnergy.
MaximumDampingEnergy Gets the MaximumDampingEnergy.
MaximumExternalEnergy Gets the MaximumExternalEnergy.
MaximumHourglassEnergy Gets the MaximumHourglassEnergy.
MaximumInternalEnergy Gets the MaximumInternalEnergy.
MaximumKineticEnergy Gets the MaximumKineticEnergy.
MaximumPlasticWork Gets the MaximumPlasticWork.
MaximumPotentialEnergy Gets the MaximumPotentialEnergy.
MaximumStrainEnergy Gets the MaximumStrainEnergy.
MaximumTotal Gets the MaximumTotal.
MaximumTotalEnergy Gets the MaximumTotalEnergy.
MaximumXAxis Gets the MaximumXAxis.
MaximumYAxis Gets the MaximumYAxis.
MaximumZAxis Gets the MaximumZAxis.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
MinMagnetostaticCoEnergyOverTime Gets the MinMagnetostaticCoEnergyOverTime.
MinimumContactEnergy Gets the MinimumContactEnergy.
MinimumDampingEnergy Gets the MinimumDampingEnergy.
MinimumExternalEnergy Gets the MinimumExternalEnergy.
MinimumHourglassEnergy Gets the MinimumHourglassEnergy.
MinimumInternalEnergy Gets the MinimumInternalEnergy.
MinimumKineticEnergy Gets the MinimumKineticEnergy.
MinimumPlasticWork Gets the MinimumPlasticWork.
MinimumPotentialEnergy Gets the MinimumPotentialEnergy.
MinimumStrainEnergy Gets the MinimumStrainEnergy.
MinimumTotal Gets the MinimumTotal.
MinimumTotalEnergy Gets the MinimumTotalEnergy.
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.
PlasticWork Gets the PlasticWork.
PotentialEnergy Gets the PotentialEnergy.
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.
ReportedFrequency Gets the ReportedFrequency.
ResultSelection Gets or sets the ResultSelection.
SetNumber Gets or sets the SetNumber.
SpatialResolution Gets or sets the SpatialResolution.
SpringSelection Gets or sets the SpringSelection.
StrainEnergy Gets the StrainEnergy.
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.
TotalEnergy Gets the TotalEnergy.
Type Gets the Type.
VisibleProperties Gets the list of properties that are visible for this object.
XAxis Gets the XAxis.
YAxis Gets the YAxis.
ZAxis Gets the ZAxis.

Property detail

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

Gets or sets the BeamSelection.

property EnergyProbe.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 EnergyProbe.By : Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None

Gets or sets the By.

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

Gets the list of children.

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

Gets the list of associated comments.

property EnergyProbe.ContactEnergy : Ansys.Core.Units.Quantity | None

Gets the ContactEnergy.

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

Gets or sets the ContactRegionSelection.

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

Gets or sets the CoordinateSystemSelection.

property EnergyProbe.DampingEnergy : Ansys.Core.Units.Quantity | None

Gets the DampingEnergy.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

property EnergyProbe.ExternalEnergy : Ansys.Core.Units.Quantity | None

Gets the ExternalEnergy.

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

Gets the list of associated figures.

property EnergyProbe.Frequency : Ansys.Core.Units.Quantity | None

Gets or sets the Frequency.

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

Gets or sets the GeometryLocation.

property EnergyProbe.HourglassEnergy : Ansys.Core.Units.Quantity | None

Gets the HourglassEnergy.

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

Gets the list of associated images.

property EnergyProbe.InternalEnergy : Ansys.Core.Units.Quantity | None

Gets the InternalEnergy.

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

Gets the internal object. For advanced usage only.

property EnergyProbe.IsSolved : bool | None

Gets the IsSolved.

property EnergyProbe.IterationNumber : int | None

Gets the IterationNumber.

property EnergyProbe.KineticEnergy : Ansys.Core.Units.Quantity | None

Gets the KineticEnergy.

property EnergyProbe.LoadStep : int | None

Gets the LoadStep.

property EnergyProbe.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the LocationMethod.

property EnergyProbe.MagnetostaticCoEnergy : Ansys.Core.Units.Quantity | None

Gets the MagnetostaticCoEnergy.

property EnergyProbe.MaxMagnetostaticCoEnergyOverTime : Ansys.Core.Units.Quantity | None

Gets the MaxMagnetostaticCoEnergyOverTime.

property EnergyProbe.MaximumContactEnergy : Ansys.Core.Units.Quantity | None

Gets the MaximumContactEnergy.

property EnergyProbe.MaximumDampingEnergy : Ansys.Core.Units.Quantity | None

Gets the MaximumDampingEnergy.

property EnergyProbe.MaximumExternalEnergy : Ansys.Core.Units.Quantity | None

Gets the MaximumExternalEnergy.

property EnergyProbe.MaximumHourglassEnergy : Ansys.Core.Units.Quantity | None

Gets the MaximumHourglassEnergy.

property EnergyProbe.MaximumInternalEnergy : Ansys.Core.Units.Quantity | None

Gets the MaximumInternalEnergy.

property EnergyProbe.MaximumKineticEnergy : Ansys.Core.Units.Quantity | None

Gets the MaximumKineticEnergy.

property EnergyProbe.MaximumPlasticWork : Ansys.Core.Units.Quantity | None

Gets the MaximumPlasticWork.

property EnergyProbe.MaximumPotentialEnergy : Ansys.Core.Units.Quantity | None

Gets the MaximumPotentialEnergy.

property EnergyProbe.MaximumStrainEnergy : Ansys.Core.Units.Quantity | None

Gets the MaximumStrainEnergy.

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

Gets the MaximumTotal.

property EnergyProbe.MaximumTotalEnergy : Ansys.Core.Units.Quantity | None

Gets the MaximumTotalEnergy.

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

Gets the MaximumXAxis.

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

Gets the MaximumYAxis.

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

Gets the MaximumZAxis.

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

Gets or sets the MeshConnectionSelection.

property EnergyProbe.MinMagnetostaticCoEnergyOverTime : Ansys.Core.Units.Quantity | None

Gets the MinMagnetostaticCoEnergyOverTime.

property EnergyProbe.MinimumContactEnergy : Ansys.Core.Units.Quantity | None

Gets the MinimumContactEnergy.

property EnergyProbe.MinimumDampingEnergy : Ansys.Core.Units.Quantity | None

Gets the MinimumDampingEnergy.

property EnergyProbe.MinimumExternalEnergy : Ansys.Core.Units.Quantity | None

Gets the MinimumExternalEnergy.

property EnergyProbe.MinimumHourglassEnergy : Ansys.Core.Units.Quantity | None

Gets the MinimumHourglassEnergy.

property EnergyProbe.MinimumInternalEnergy : Ansys.Core.Units.Quantity | None

Gets the MinimumInternalEnergy.

property EnergyProbe.MinimumKineticEnergy : Ansys.Core.Units.Quantity | None

Gets the MinimumKineticEnergy.

property EnergyProbe.MinimumPlasticWork : Ansys.Core.Units.Quantity | None

Gets the MinimumPlasticWork.

property EnergyProbe.MinimumPotentialEnergy : Ansys.Core.Units.Quantity | None

Gets the MinimumPotentialEnergy.

property EnergyProbe.MinimumStrainEnergy : Ansys.Core.Units.Quantity | None

Gets the MinimumStrainEnergy.

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

Gets the MinimumTotal.

property EnergyProbe.MinimumTotalEnergy : Ansys.Core.Units.Quantity | None

Gets the MinimumTotalEnergy.

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

Gets the MinimumXAxis.

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

Gets the MinimumYAxis.

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

Gets the MinimumZAxis.

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

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

property EnergyProbe.PlasticWork : Ansys.Core.Units.Quantity | None

Gets the PlasticWork.

property EnergyProbe.PotentialEnergy : Ansys.Core.Units.Quantity | None

Gets the PotentialEnergy.

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

Gets the list of properties for this object.

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

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

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

Gets or sets the RemotePointSelection.

property EnergyProbe.ReportedFrequency : Ansys.Core.Units.Quantity | None

Gets the ReportedFrequency.

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

Gets or sets the ResultSelection.

property EnergyProbe.SetNumber : int | None

Gets or sets the SetNumber.

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

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property EnergyProbe.StrainEnergy : Ansys.Core.Units.Quantity | None

Gets the StrainEnergy.

property EnergyProbe.Substep : int | None

Gets the Substep.

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

Gets or sets the Summation.

property EnergyProbe.Suppressed : bool | None

Gets or sets the Suppressed.

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

Gets or sets the MeshConnectionSelection.

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

Gets the Time.

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

Gets the Total.

property EnergyProbe.TotalEnergy : Ansys.Core.Units.Quantity | None

Gets the TotalEnergy.

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

Gets the Type.

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

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

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

Gets the XAxis.

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

Gets the YAxis.

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

Gets the ZAxis.

Method detail

EnergyProbe.Activate()

Activate the current object.

EnergyProbe.AddComment()

Creates a new child Comment.

EnergyProbe.AddFigure()

Creates a new child Figure.

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

EnergyProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

EnergyProbe.CreateParameter(propName: str)

Creates a new parameter for a Property.

EnergyProbe.Delete()

Run the Delete action.

EnergyProbe.Duplicate()

Creates a copy of the current DataModelObject.

EnergyProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

EnergyProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

EnergyProbe.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

EnergyProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

EnergyProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

EnergyProbe.PropertyByName(name: str)

Get a property by its unique name.

EnergyProbe.RemoveParameter(propName: str)

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

EnergyProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

EnergyProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.