`ArtificialEnergyTracker`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.ResultTrackers.ArtificialEnergyTracker#

Bases: object

Defines a ArtificialEnergyTracker.

Overview#

Methods

`ExportAnimation`	Run the ExportAnimation action.
`ClearGeneratedData`	Run the ClearGeneratedData action.
`EvaluateAllResults`	Run the EvaluateAllResults action.
`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.
`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.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`IsSolved`	Gets the IsSolved.
`ChartDimensions`	Gets or sets the Chart Dimensions
`BoundaryCondition`	Gets or sets the BoundaryCondition.
`CutFrequency`	Gets or sets the CutFrequency.
`SectorNumber`	Gets or sets the SectorNumber.
`GeometrySelectionString`	Gets or sets the GeometrySelectionString.
`LoadStepNumber`	Gets or sets the LoadStepNumber.
`ReportedFrequency`	Gets the ReportedFrequency.
`Duration`	Gets or sets the Duration.
`FilterMaximum`	Gets the FilterMaximum.
`FilterMinimum`	Gets the FilterMinimum.
`FrequencyAtMaximumAmplitude`	Gets the FrequencyAtMaximumAmplitude.
`ImaginaryAtMaximumAmplitude`	Gets the ImaginaryAtMaximumAmplitude.
`MaximumAmplitude`	Gets the MaximumAmplitude.
`MaximumFrequency`	Gets or sets the MaximumFrequency.
`Maximum`	Gets the Maximum.
`MinimumFrequency`	Gets or sets the MinimumFrequency.
`Minimum`	Gets the Minimum.
`PhaseAngle`	Gets the PhaseAngle.
`RealAtMaximumAmplitude`	Gets the RealAtMaximumAmplitude.
`RequestedFrequency`	Gets or sets the RequestedFrequency.
`AccelerationType`	Gets or sets the AccelerationType.
`ChartViewingStyle`	Gets or sets the ChartViewingStyle.
`DeformationType`	Gets or sets the DeformationType.
`FilterType`	Gets or sets the FilterType.
`SpatialResolution`	Gets or sets the SpatialResolution.
`NormalOrientation`	Gets or sets the NormalOrientation.
`CurvesAppearanceDisplay`	Gets or sets the CurvesAppearanceDisplay.
`ResultChartType`	Gets the ResultChartType.
`DpfEvaluation`	Gets or sets the DpfEvaluation.
`XAxisValues`	Gets or sets the XAxisValues.
`ShearOrientation`	Gets or sets the ShearOrientation.
`StressStrainType`	Gets or sets the StressStrainType.
`TimeHistoryDisplay`	Gets or sets the TimeHistoryDisplay.
`VelocityType`	Gets or sets the VelocityType.
`Suppressed`	Gets or sets the Suppressed.
`EnhancedTracking`	Gets the EnhancedTracking.
`UseParentFrequencyRange`	Gets or sets the UseParentFrequencyRange.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`Spring`	Gets or sets the Spring.
`Location`	Gets or sets the Location.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`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 ArtificialEnergyTracker.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultChartAuto | None: Gets the internal object. For advanced usage only.

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

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

property ArtificialEnergyTracker.ChartDimensions: Ansys.Mechanical.DataModel.Enums.ChartDimensions | None: Gets or sets the Chart Dimensions

property ArtificialEnergyTracker.BoundaryCondition: Ansys.ACT.Automation.Mechanical.BoundaryConditions.GenericBoundaryCondition | None: Gets or sets the BoundaryCondition.

property ArtificialEnergyTracker.CutFrequency: System.Double | None: Gets or sets the CutFrequency.

property ArtificialEnergyTracker.SectorNumber: System.Int32 | None: Gets or sets the SectorNumber.

property ArtificialEnergyTracker.GeometrySelectionString: System.String | None: Gets or sets the GeometrySelectionString.

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

property ArtificialEnergyTracker.ReportedFrequency: Ansys.Core.Units.Quantity | None: Gets the ReportedFrequency.

property ArtificialEnergyTracker.Duration: Ansys.Core.Units.Quantity | None: Gets or sets the Duration.

property ArtificialEnergyTracker.FilterMaximum: Ansys.Core.Units.Quantity | None: Gets the FilterMaximum.

property ArtificialEnergyTracker.FilterMinimum: Ansys.Core.Units.Quantity | None: Gets the FilterMinimum.

property ArtificialEnergyTracker.FrequencyAtMaximumAmplitude: Ansys.Core.Units.Quantity | None: Gets the FrequencyAtMaximumAmplitude.

property ArtificialEnergyTracker.ImaginaryAtMaximumAmplitude: Ansys.Core.Units.Quantity | None: Gets the ImaginaryAtMaximumAmplitude.

property ArtificialEnergyTracker.MaximumAmplitude: Ansys.Core.Units.Quantity | None: Gets the MaximumAmplitude.

property ArtificialEnergyTracker.MaximumFrequency: Ansys.Core.Units.Quantity | None: Gets or sets the MaximumFrequency.

property ArtificialEnergyTracker.Maximum: Ansys.Core.Units.Quantity | None: Gets the Maximum.

property ArtificialEnergyTracker.MinimumFrequency: Ansys.Core.Units.Quantity | None: Gets or sets the MinimumFrequency.

property ArtificialEnergyTracker.Minimum: Ansys.Core.Units.Quantity | None: Gets the Minimum.

property ArtificialEnergyTracker.PhaseAngle: Ansys.Core.Units.Quantity | None: Gets the PhaseAngle.

property ArtificialEnergyTracker.RealAtMaximumAmplitude: Ansys.Core.Units.Quantity | None: Gets the RealAtMaximumAmplitude.

property ArtificialEnergyTracker.RequestedFrequency: Ansys.Core.Units.Quantity | None: Gets or sets the RequestedFrequency.

property ArtificialEnergyTracker.AccelerationType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None: Gets or sets the AccelerationType.

property ArtificialEnergyTracker.ChartViewingStyle: Ansys.Mechanical.DataModel.Enums.ChartAxisScaleType | None: Gets or sets the ChartViewingStyle.

property ArtificialEnergyTracker.DeformationType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None: Gets or sets the DeformationType.

property ArtificialEnergyTracker.FilterType: Ansys.Mechanical.DataModel.Enums.FilterType | None: Gets or sets the FilterType.

property ArtificialEnergyTracker.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MultipleNodeType | None: Gets or sets the SpatialResolution.

property ArtificialEnergyTracker.NormalOrientation: Ansys.Mechanical.DataModel.Enums.NormalOrientationType | None: Gets or sets the NormalOrientation.

property ArtificialEnergyTracker.CurvesAppearanceDisplay: Ansys.Mechanical.DataModel.Enums.ChartPlotStyle | None: Gets or sets the CurvesAppearanceDisplay.

property ArtificialEnergyTracker.ResultChartType: Ansys.Mechanical.DataModel.Enums.ChartResultType | None: Gets the ResultChartType.

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

property ArtificialEnergyTracker.XAxisValues: Ansys.Mechanical.DataModel.Enums.XAxisValues | None: Gets or sets the XAxisValues.

property ArtificialEnergyTracker.ShearOrientation: Ansys.Mechanical.DataModel.Enums.ShearOrientationType | None: Gets or sets the ShearOrientation.

property ArtificialEnergyTracker.StressStrainType: Ansys.Mechanical.DataModel.Enums.StressStrainType | None: Gets or sets the StressStrainType.

property ArtificialEnergyTracker.TimeHistoryDisplay: Ansys.Mechanical.DataModel.Enums.TimeHistoryDisplayType | None: Gets or sets the TimeHistoryDisplay.

property ArtificialEnergyTracker.VelocityType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None: Gets or sets the VelocityType.

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

property ArtificialEnergyTracker.EnhancedTracking: System.Boolean | None: Gets the EnhancedTracking.

property ArtificialEnergyTracker.UseParentFrequencyRange: System.Boolean | None: Gets or sets the UseParentFrequencyRange.

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

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

property ArtificialEnergyTracker.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

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

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

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

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

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

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

Method detail#

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

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

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

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

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

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

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

ArtificialEnergyTracker.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

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

ArtificialEnergyTracker.Activate() → System.Void: Activate the current object.

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

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

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

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

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

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

ArtificialEnergyTracker.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

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

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