EnergyProbe

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

Bases: object

Defines a EnergyProbe.

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.
SetNumber	Gets or sets the SetNumber.
ReportedFrequency	Gets the ReportedFrequency.
ContactEnergy	Gets the ContactEnergy.
DampingEnergy	Gets the DampingEnergy.
ExternalEnergy	Gets the ExternalEnergy.
Frequency	Gets or sets the Frequency.
HourglassEnergy	Gets the HourglassEnergy.
InternalEnergy	Gets the InternalEnergy.
KineticEnergy	Gets the KineticEnergy.
MagnetostaticCoEnergy	Gets the MagnetostaticCoEnergy.
MaximumContactEnergy	Gets the MaximumContactEnergy.
MaximumDampingEnergy	Gets the MaximumDampingEnergy.
MaximumExternalEnergy	Gets the MaximumExternalEnergy.
MaximumHourglassEnergy	Gets the MaximumHourglassEnergy.
MaximumInternalEnergy	Gets the MaximumInternalEnergy.
MaximumKineticEnergy	Gets the MaximumKineticEnergy.
MaxMagnetostaticCoEnergyOverTime	Gets the MaxMagnetostaticCoEnergyOverTime.
MaximumPlasticWork	Gets the MaximumPlasticWork.
MaximumPotentialEnergy	Gets the MaximumPotentialEnergy.
MaximumStrainEnergy	Gets the MaximumStrainEnergy.
MaximumTotalEnergy	Gets the MaximumTotalEnergy.
MinimumContactEnergy	Gets the MinimumContactEnergy.
MinimumDampingEnergy	Gets the MinimumDampingEnergy.
MinimumExternalEnergy	Gets the MinimumExternalEnergy.
MinimumHourglassEnergy	Gets the MinimumHourglassEnergy.
MinimumInternalEnergy	Gets the MinimumInternalEnergy.
MinimumKineticEnergy	Gets the MinimumKineticEnergy.
MinMagnetostaticCoEnergyOverTime	Gets the MinMagnetostaticCoEnergyOverTime.
MinimumPlasticWork	Gets the MinimumPlasticWork.
MinimumPotentialEnergy	Gets the MinimumPotentialEnergy.
MinimumStrainEnergy	Gets the MinimumStrainEnergy.
MinimumTotalEnergy	Gets the MinimumTotalEnergy.
PlasticWork	Gets the PlasticWork.
PotentialEnergy	Gets the PotentialEnergy.
StrainEnergy	Gets the StrainEnergy.
TotalEnergy	Gets the TotalEnergy.
By	Gets or sets the By.
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 EnergyProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None

Gets the internal object. For advanced usage only.

property EnergyProbe.SetNumber: System.UInt32 | None

Gets or sets the SetNumber.

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

Gets the ReportedFrequency.

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

Gets the ContactEnergy.

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

Gets the DampingEnergy.

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

Gets the ExternalEnergy.

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

Gets or sets the Frequency.

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

Gets the HourglassEnergy.

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

Gets the InternalEnergy.

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

Gets the KineticEnergy.

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

Gets the MagnetostaticCoEnergy.

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.MaxMagnetostaticCoEnergyOverTime: Ansys.Core.Units.Quantity | None

Gets the MaxMagnetostaticCoEnergyOverTime.

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.MaximumTotalEnergy: Ansys.Core.Units.Quantity | None

Gets the MaximumTotalEnergy.

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.MinMagnetostaticCoEnergyOverTime: Ansys.Core.Units.Quantity | None

Gets the MinMagnetostaticCoEnergyOverTime.

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.MinimumTotalEnergy: Ansys.Core.Units.Quantity | None

Gets the MinimumTotalEnergy.

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

Gets the PlasticWork.

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

Gets the PotentialEnergy.

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

Gets the StrainEnergy.

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

Gets the TotalEnergy.

property EnergyProbe.By: Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None

Gets or sets the By.

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

Gets the current DataModelObject’s category.

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

Gets or sets the Summation.

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

Gets or sets the LocationMethod.

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

Gets or sets the GeometryLocation.

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

Gets or sets the CoordinateSystemSelection.

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

Gets or sets the ContactRegionSelection.

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

Gets or sets the RemotePointSelection.

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

Gets or sets the BeamSelection.

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

Gets or sets the MeshConnectionSelection.

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

Gets or sets the MeshConnectionSelection.

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

Gets or sets the SpringSelection.

property EnergyProbe.IsSolved: System.Boolean | None

Gets the IsSolved.

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

Gets the IterationNumber.

property EnergyProbe.LoadStep: System.Int32 | None

Gets the LoadStep.

property EnergyProbe.LoadStepNumber: System.UInt32 | None

Gets or sets the LoadStepNumber.

property EnergyProbe.Substep: System.Int32 | None

Gets the Substep.

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

Gets or sets the DisplayTime.

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

Gets the MaximumTotal.

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

Gets the MinimumTotal.

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

Gets the Time.

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

Gets the Total.

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.

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

Gets or sets the ResultSelection.

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

Gets or sets the SpatialResolution.

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

Gets the Type.

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

Gets or sets the DpfEvaluation.

property EnergyProbe.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

property EnergyProbe.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property EnergyProbe.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property EnergyProbe.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property EnergyProbe.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property EnergyProbe.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property EnergyProbe.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property EnergyProbe.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

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

Run the ExportAnimation action.

EnergyProbe.ClearGeneratedData() → System.Void

Run the ClearGeneratedData action.

EnergyProbe.DuplicateWithoutResults() → Ansys.ACT.Automation.Mechanical.DataModelObject

Run the DuplicateWithoutResults action.

EnergyProbe.EvaluateAllResults() → System.Void

Run the EvaluateAllResults action.

EnergyProbe.SnapToMeshNodes() → System.Void

Snap the coordinates of probe result to the mesh nodes.

EnergyProbe.RenameBasedOnDefinition() → System.Void

Run the RenameBasedOnDefinition action.

EnergyProbe.Delete() → System.Void

Run the Delete action.

EnergyProbe.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

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

EnergyProbe.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

EnergyProbe.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

EnergyProbe.Activate() → System.Void

Activate the current object.

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

Copies all visible properties from this object to another.

EnergyProbe.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

EnergyProbe.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

EnergyProbe.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

EnergyProbe.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

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

EnergyProbe.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

EnergyProbe.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

EnergyProbe.RemoveParameter(propName: System.String) → System.Void

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