EquivalentPlasticStrainRST#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.StrainResults.EquivalentPlasticStrainRST#

Bases: object

Defines a EquivalentPlasticStrainRST.

Overview#

Activate

Activate the current object.

AddAlert

Creates a new Alert

AddComment

Creates a new child Comment.

AddConvergence

Creates a new Convergence

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

CreateParameter method.

CreateResultsAtAllSets

Creates results at all sets for results under a solution.

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.

ExportToTextFile

Run the ExportToTextFile action.

FetchRemoteResults

Run the FetchRemoteResult 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.

PromoteToNamedSelection

Run the PromoteToNamedSelection 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.

Amplitude

Gets or sets the Amplitude.

Average

Gets the Average.

AverageAcrossBodies

Gets or sets the AverageAcrossBodies.

By

Gets or sets the By.

CalculateTimeHistory

Gets or sets the CalculateTimeHistory.

Children

Gets the list of children.

CombinationNumber

Gets or sets the Combination Number for a Solution Combination result.

Comments

Gets the list of associated comments.

CoordinateSystem

Gets or sets the Coordinate System.

CrackFrontNumber

Gets or sets the CrackFrontNumber.

CyclicMode

Gets or sets the CyclicMode.

DataModelObjectCategory

Gets the current DataModelObject's category.

DisplayOption

Gets or sets the DisplayOption.

DisplayTime

Gets or sets the DisplayTime.

DpfEvaluation

Gets or sets the DpfEvaluation.

EnvironmentSelection

Gets or sets the EnvironmentSelection.

Figures

Gets the list of associated figures.

Frequency

Gets or sets the Frequency.

GlobalIDs

Gets or sets the GlobalIDs.

GraphControlsXAxis

Gets or sets the GraphControlsXAxis.

HarmonicIndex

Gets or sets the HarmonicIndex.

Identifier

Gets or sets the Identifier.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

IsSolved

Gets the IsSolved.

ItemType

Gets or sets the ItemType.

IterationNumber

Gets the IterationNumber.

IterationStep

Gets or sets the IterationStep.

LoadMultiplier

Gets the LoadMultiplier.

LoadStep

Gets the LoadStep.

LoadStepForMaximumOfMaximumValues

Get the Load Step for the maximum of maximum values.

LoadStepForMaximumOfMinimumValues

Get the Load Step for the maximum of minimum values.

LoadStepForMinimumOfMaximumValues

Get the Load Step for the minimum of maximum values.

LoadStepForMinimumOfMinimumValues

Get the Load Step for the minimum of minimum values.

LoadStepNumber

Gets or sets the LoadStepNumber.

Location

Gets or sets the Location.

Maximum

Gets the Maximum.

MaximumOccursOn

Gets the MaximumOccursOn.

MaximumOfMaximumOverTime

Gets the MaximumOfMaximumOverTime.

MaximumOfMinimumOverTime

Gets the MaximumOfMinimumOverTime.

Minimum

Gets the Minimum.

MinimumOccursOn

Gets the MinimumOccursOn.

MinimumOfMaximumOverTime

Gets the MinimumOfMaximumOverTime.

MinimumOfMinimumOverTime

Gets the MinimumOfMinimumOverTime.

Mode

Gets or sets the Mode.

NamedSelections

Gets or sets the NamedSelections.

Path

Path property.

PhaseIncrement

Gets or sets the PhaseIncrement.

Plies

Plies property.

PlotData

Gets the result table.

Ply

Gets or sets the Ply selection.

Position

Gets or sets the Position.

Properties

Gets the list of properties for this object.

ReportedFrequency

Gets the ReportedFrequency.

ScopingMethod

Gets or sets the ScopingMethod.

SetNumber

Gets or sets the Set Number.

SolutionCombinationDriver

Gets or sets the SolutionCombinationDriver.

SolverComponentIDs

Gets or sets the SolverComponentIDs.

StressStrainType

Gets or sets the StressStrainType.

SubScopeBy

Gets or sets the SubScopeBy.

Substep

Gets the Substep.

Suppressed

Gets or sets the Suppressed.

Surface

Surface property.

SurfaceCoating

SurfaceCoating property.

SweepingPhase

Gets or sets the SweepingPhase.

Time

Gets the Time.

TimeForMaximumOfMaximumValues

Get the Time for the maximum of maximum values.

TimeForMaximumOfMinimumValues

Get the Time for the maximum of minimum values.

TimeForMinimumOfMaximumValues

Get the Time for the minimum of maximum values.

TimeForMinimumOfMinimumValues

Get the Time for the minimum of minimum values.

VisibleProperties

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

WaterfallShowTextOnMosaic

Gets or sets the Waterfall Mosaic Text Property.

Property detail#

property EquivalentPlasticStrainRST.Amplitude: bool | None#

Gets or sets the Amplitude.

property EquivalentPlasticStrainRST.Average: Ansys.Core.Units.Quantity | None#

Gets the Average.

property EquivalentPlasticStrainRST.AverageAcrossBodies: bool | None#

Gets or sets the AverageAcrossBodies.

property EquivalentPlasticStrainRST.By: Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None#

Gets or sets the By.

property EquivalentPlasticStrainRST.CalculateTimeHistory: bool | None#

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property EquivalentPlasticStrainRST.CombinationNumber: int | None#

Gets or sets the Combination Number for a Solution Combination result.

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

Gets the list of associated comments.

property EquivalentPlasticStrainRST.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the Coordinate System. Accepts/Returns None for Solution Coordinate System in the general case (if applicable). Accepts/Returns None for Fiber Coordinate System for a result that is sub scoped by ply.

property EquivalentPlasticStrainRST.CrackFrontNumber: int | None#

Gets or sets the CrackFrontNumber.

property EquivalentPlasticStrainRST.CyclicMode: int | None#

Gets or sets the CyclicMode.

property EquivalentPlasticStrainRST.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property EquivalentPlasticStrainRST.DisplayOption: Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None#

Gets or sets the DisplayOption.

property EquivalentPlasticStrainRST.DisplayTime: Ansys.Core.Units.Quantity | None#

Gets or sets the DisplayTime.

property EquivalentPlasticStrainRST.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#

Gets or sets the DpfEvaluation.

property EquivalentPlasticStrainRST.EnvironmentSelection: Ansys.ACT.Automation.Mechanical.Analysis | None#

Gets or sets the EnvironmentSelection.

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

Gets the list of associated figures.

property EquivalentPlasticStrainRST.Frequency: Ansys.Core.Units.Quantity | None#

Gets or sets the Frequency.

property EquivalentPlasticStrainRST.GlobalIDs: str | None#

Gets or sets the GlobalIDs.

property EquivalentPlasticStrainRST.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None#

Gets or sets the GraphControlsXAxis.

property EquivalentPlasticStrainRST.HarmonicIndex: int | None#

Gets or sets the HarmonicIndex.

property EquivalentPlasticStrainRST.Identifier: str | None#

Gets or sets the Identifier.

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

Gets the list of associated images.

property EquivalentPlasticStrainRST.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None#

Gets the internal object. For advanced usage only.

property EquivalentPlasticStrainRST.IsSolved: bool | None#

Gets the IsSolved.

property EquivalentPlasticStrainRST.ItemType: Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None#

Gets or sets the ItemType.

property EquivalentPlasticStrainRST.IterationNumber: int | None#

Gets the IterationNumber.

property EquivalentPlasticStrainRST.IterationStep: int | None#

Gets or sets the IterationStep.

property EquivalentPlasticStrainRST.LoadMultiplier: float | None#

Gets the LoadMultiplier.

property EquivalentPlasticStrainRST.LoadStep: int | None#

Gets the LoadStep.

property EquivalentPlasticStrainRST.LoadStepForMaximumOfMaximumValues: int | None#

Get the Load Step for the maximum of maximum values.

property EquivalentPlasticStrainRST.LoadStepForMaximumOfMinimumValues: int | None#

Get the Load Step for the maximum of minimum values.

property EquivalentPlasticStrainRST.LoadStepForMinimumOfMaximumValues: int | None#

Get the Load Step for the minimum of maximum values.

property EquivalentPlasticStrainRST.LoadStepForMinimumOfMinimumValues: int | None#

Get the Load Step for the minimum of minimum values.

property EquivalentPlasticStrainRST.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

property EquivalentPlasticStrainRST.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

property EquivalentPlasticStrainRST.Maximum: Ansys.Core.Units.Quantity | None#

Gets the Maximum.

property EquivalentPlasticStrainRST.MaximumOccursOn: str | None#

Gets the MaximumOccursOn.

property EquivalentPlasticStrainRST.MaximumOfMaximumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MaximumOfMaximumOverTime.

property EquivalentPlasticStrainRST.MaximumOfMinimumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MaximumOfMinimumOverTime.

property EquivalentPlasticStrainRST.Minimum: Ansys.Core.Units.Quantity | None#

Gets the Minimum.

property EquivalentPlasticStrainRST.MinimumOccursOn: str | None#

Gets the MinimumOccursOn.

property EquivalentPlasticStrainRST.MinimumOfMaximumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MinimumOfMaximumOverTime.

property EquivalentPlasticStrainRST.MinimumOfMinimumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MinimumOfMinimumOverTime.

property EquivalentPlasticStrainRST.Mode: int | None#

Gets or sets the Mode.

property EquivalentPlasticStrainRST.NamedSelections: Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets or sets the NamedSelections.

property EquivalentPlasticStrainRST.Path: Ansys.ACT.Automation.Mechanical.Path | None#

Path property.

property EquivalentPlasticStrainRST.PhaseIncrement: Ansys.Core.Units.Quantity | None#

Gets or sets the PhaseIncrement.

property EquivalentPlasticStrainRST.Plies: Iterable[Ansys.ACT.Automation.Mechanical.ImportedPliesCollection] | None#

Plies property.

property EquivalentPlasticStrainRST.PlotData: Ansys.Mechanical.DataModel.Results.ResultDataTable | None#

Gets the result table.

property EquivalentPlasticStrainRST.Ply: Iterable[Ansys.ACT.Automation.Mechanical.AnalysisPly] | None#

Gets or sets the Ply selection.

property EquivalentPlasticStrainRST.Position: Ansys.Mechanical.DataModel.Enums.ShellFaceType | None#

Gets or sets the Position.

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

Gets the list of properties for this object.

property EquivalentPlasticStrainRST.ReportedFrequency: Ansys.Core.Units.Quantity | None#

Gets the ReportedFrequency.

property EquivalentPlasticStrainRST.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#

Gets or sets the ScopingMethod.

property EquivalentPlasticStrainRST.SetNumber: int | None#

Gets or sets the Set Number.

property EquivalentPlasticStrainRST.SolutionCombinationDriver: Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None#

Gets or sets the SolutionCombinationDriver.

property EquivalentPlasticStrainRST.SolverComponentIDs: str | None#

Gets or sets the SolverComponentIDs.

property EquivalentPlasticStrainRST.StressStrainType: Ansys.Mechanical.DataModel.Enums.StressStrainType | None#

Gets or sets the StressStrainType.

property EquivalentPlasticStrainRST.SubScopeBy: Ansys.Mechanical.DataModel.Enums.SubScopingDefineByType | None#

Gets or sets the SubScopeBy.

property EquivalentPlasticStrainRST.Substep: int | None#

Gets the Substep.

property EquivalentPlasticStrainRST.Suppressed: bool | None#

Gets or sets the Suppressed.

property EquivalentPlasticStrainRST.Surface: Ansys.ACT.Automation.Mechanical.Surface | None#

Surface property.

property EquivalentPlasticStrainRST.SurfaceCoating: Ansys.ACT.Automation.Mechanical.SurfaceCoating | None#

SurfaceCoating property.

property EquivalentPlasticStrainRST.SweepingPhase: Ansys.Core.Units.Quantity | None#

Gets or sets the SweepingPhase.

property EquivalentPlasticStrainRST.Time: Ansys.Core.Units.Quantity | None#

Gets the Time.

property EquivalentPlasticStrainRST.TimeForMaximumOfMaximumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the maximum of maximum values.

property EquivalentPlasticStrainRST.TimeForMaximumOfMinimumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the maximum of minimum values.

property EquivalentPlasticStrainRST.TimeForMinimumOfMaximumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the minimum of maximum values.

property EquivalentPlasticStrainRST.TimeForMinimumOfMinimumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the minimum of minimum values.

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

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

property EquivalentPlasticStrainRST.WaterfallShowTextOnMosaic: bool | None#

Gets or sets the Waterfall Mosaic Text Property.

Method detail#

EquivalentPlasticStrainRST.Activate() None#

Activate the current object.

EquivalentPlasticStrainRST.AddAlert() Ansys.ACT.Automation.Mechanical.Results.Alert#

Creates a new Alert

EquivalentPlasticStrainRST.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

EquivalentPlasticStrainRST.AddConvergence() Ansys.ACT.Automation.Mechanical.Results.Convergence#

Creates a new Convergence

EquivalentPlasticStrainRST.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

EquivalentPlasticStrainRST.AddImage(filePath: str) 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.
EquivalentPlasticStrainRST.ClearGeneratedData() None#

Run the ClearGeneratedData action.

EquivalentPlasticStrainRST.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

EquivalentPlasticStrainRST.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

CreateParameter method.

EquivalentPlasticStrainRST.CreateResultsAtAllSets() List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]#

Creates results at all sets for results under a solution.

EquivalentPlasticStrainRST.Delete() None#

Run the Delete action.

EquivalentPlasticStrainRST.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

EquivalentPlasticStrainRST.DuplicateWithoutResults() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Run the DuplicateWithoutResults action.

EquivalentPlasticStrainRST.EvaluateAllResults() None#

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

EquivalentPlasticStrainRST.ExportToTextFile(filePath: str) None#

Run the ExportToTextFile action.

EquivalentPlasticStrainRST.FetchRemoteResults() None#

Run the FetchRemoteResult action.

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

Gets the list of children, filtered by type.

EquivalentPlasticStrainRST.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

EquivalentPlasticStrainRST.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

EquivalentPlasticStrainRST.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

EquivalentPlasticStrainRST.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#

Run the PromoteToNamedSelection action.

EquivalentPlasticStrainRST.PropertyByAPIName(name: str) 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.
EquivalentPlasticStrainRST.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

EquivalentPlasticStrainRST.RemoveParameter(propName: str) None#

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

EquivalentPlasticStrainRST.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.