EquivalentPlasticStrain

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Results.StrainResults.EquivalentPlasticStrain

Bases: object

Defines a EquivalentPlasticStrain.

Overview

Methods

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.
BodyWhereMaximumOccurs	Gets the body that has the maximum result value.
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.
RetrieveResult	Evaluates the individual result without evaluating all the results in the same solution.

Properties

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.
RPMSelection	Gets or sets the RPM Selection value at which the results are evaluated.
ReportedFrequency	Gets the ReportedFrequency.
SaveAuxiliaryResult	Gets or sets the option to save auxiliary results to disk. This property is valid for results under Modal and Harmonic analyses with On Demand Expansion enabled. An exception is thrown otherwise.
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.
Total	Gets the Total.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property EquivalentPlasticStrain.Amplitude: bool | None

Gets or sets the Amplitude.

property EquivalentPlasticStrain.Average: Ansys.Core.Units.Quantity | None

Gets the Average.

property EquivalentPlasticStrain.AverageAcrossBodies: bool | None

Gets or sets the AverageAcrossBodies.

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

Gets or sets the By.

property EquivalentPlasticStrain.CalculateTimeHistory: bool | None

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property EquivalentPlasticStrain.CombinationNumber: int | None

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

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

Gets the list of associated comments.

property EquivalentPlasticStrain.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 EquivalentPlasticStrain.CrackFrontNumber: int | None

Gets or sets the CrackFrontNumber.

property EquivalentPlasticStrain.CyclicMode: int | None

Gets or sets the CyclicMode.

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

Gets the current DataModelObject's category.

property EquivalentPlasticStrain.DisplayOption: Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None

Gets or sets the DisplayOption.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

property EquivalentPlasticStrain.EnvironmentSelection: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the EnvironmentSelection.

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

Gets the list of associated figures.

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

Gets or sets the Frequency.

property EquivalentPlasticStrain.GlobalIDs: str | None

Gets or sets the GlobalIDs.

property EquivalentPlasticStrain.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None

Gets or sets the GraphControlsXAxis.

property EquivalentPlasticStrain.HarmonicIndex: int | None

Gets or sets the HarmonicIndex.

property EquivalentPlasticStrain.Identifier: str | None

Gets or sets the Identifier.

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

Gets the list of associated images.

property EquivalentPlasticStrain.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None

Gets the internal object. For advanced usage only.

property EquivalentPlasticStrain.IsSolved: bool | None

Gets the IsSolved.

property EquivalentPlasticStrain.ItemType: Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None

Gets or sets the ItemType.

property EquivalentPlasticStrain.IterationNumber: int | None

Gets the IterationNumber.

property EquivalentPlasticStrain.IterationStep: int | None

Gets or sets the IterationStep.

property EquivalentPlasticStrain.LoadMultiplier: float | None

Gets the LoadMultiplier.

property EquivalentPlasticStrain.LoadStep: int | None

Gets the LoadStep.

property EquivalentPlasticStrain.LoadStepForMaximumOfMaximumValues: int | None

Get the Load Step for the maximum of maximum values.

property EquivalentPlasticStrain.LoadStepForMaximumOfMinimumValues: int | None

Get the Load Step for the maximum of minimum values.

property EquivalentPlasticStrain.LoadStepForMinimumOfMaximumValues: int | None

Get the Load Step for the minimum of maximum values.

property EquivalentPlasticStrain.LoadStepForMinimumOfMinimumValues: int | None

Get the Load Step for the minimum of minimum values.

property EquivalentPlasticStrain.LoadStepNumber: int | None

Gets or sets the LoadStepNumber.

property EquivalentPlasticStrain.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property EquivalentPlasticStrain.Maximum: Ansys.Core.Units.Quantity | None

Gets the Maximum.

property EquivalentPlasticStrain.MaximumOccursOn: str | None

Gets the MaximumOccursOn.

property EquivalentPlasticStrain.MaximumOfMaximumOverTime: Ansys.Core.Units.Quantity | None

Gets the MaximumOfMaximumOverTime.

property EquivalentPlasticStrain.MaximumOfMinimumOverTime: Ansys.Core.Units.Quantity | None

Gets the MaximumOfMinimumOverTime.

property EquivalentPlasticStrain.Minimum: Ansys.Core.Units.Quantity | None

Gets the Minimum.

property EquivalentPlasticStrain.MinimumOccursOn: str | None

Gets the MinimumOccursOn.

property EquivalentPlasticStrain.MinimumOfMaximumOverTime: Ansys.Core.Units.Quantity | None

Gets the MinimumOfMaximumOverTime.

property EquivalentPlasticStrain.MinimumOfMinimumOverTime: Ansys.Core.Units.Quantity | None

Gets the MinimumOfMinimumOverTime.

property EquivalentPlasticStrain.Mode: int | None

Gets or sets the Mode.

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

Gets or sets the NamedSelections.

property EquivalentPlasticStrain.Path: Ansys.ACT.Automation.Mechanical.Path | None

Path property.

property EquivalentPlasticStrain.PhaseIncrement: Ansys.Core.Units.Quantity | None

Gets or sets the PhaseIncrement.

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

Plies property.

property EquivalentPlasticStrain.PlotData: Ansys.Mechanical.DataModel.Results.ResultDataTable | None

Gets the result table.

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

Gets or sets the Ply selection.

property EquivalentPlasticStrain.Position: Ansys.Mechanical.DataModel.Enums.ShellFaceType | None

Gets or sets the Position.

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

Gets the list of properties for this object.

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

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

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

Gets the ReportedFrequency.

property EquivalentPlasticStrain.SaveAuxiliaryResult: bool | None

Gets or sets the option to save auxiliary results to disk. This property is valid for results under Modal and Harmonic analyses with On Demand Expansion enabled. An exception is thrown otherwise. Saving result data to disk improves result retrieval and display performance. Note: The project file size will increase.

property EquivalentPlasticStrain.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property EquivalentPlasticStrain.SetNumber: int | None

Gets or sets the Set Number.

property EquivalentPlasticStrain.SolutionCombinationDriver: Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None

Gets or sets the SolutionCombinationDriver.

property EquivalentPlasticStrain.SolverComponentIDs: str | None

Gets or sets the SolverComponentIDs.

property EquivalentPlasticStrain.StressStrainType: Ansys.Mechanical.DataModel.Enums.StressStrainType | None

Gets or sets the StressStrainType.

property EquivalentPlasticStrain.SubScopeBy: Ansys.Mechanical.DataModel.Enums.SubScopingDefineByType | None

Gets or sets the SubScopeBy.

property EquivalentPlasticStrain.Substep: int | None

Gets the Substep.

property EquivalentPlasticStrain.Suppressed: bool | None

Gets or sets the Suppressed.

property EquivalentPlasticStrain.Surface: Ansys.ACT.Automation.Mechanical.Surface | None

Surface property.

property EquivalentPlasticStrain.SurfaceCoating: Ansys.ACT.Automation.Mechanical.SurfaceCoating | None

SurfaceCoating property.

property EquivalentPlasticStrain.SweepingPhase: Ansys.Core.Units.Quantity | None

Gets or sets the SweepingPhase.

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

Gets the Time.

property EquivalentPlasticStrain.TimeForMaximumOfMaximumValues: Ansys.Core.Units.Quantity | None

Get the Time for the maximum of maximum values.

property EquivalentPlasticStrain.TimeForMaximumOfMinimumValues: Ansys.Core.Units.Quantity | None

Get the Time for the maximum of minimum values.

property EquivalentPlasticStrain.TimeForMinimumOfMaximumValues: Ansys.Core.Units.Quantity | None

Get the Time for the minimum of maximum values.

property EquivalentPlasticStrain.TimeForMinimumOfMinimumValues: Ansys.Core.Units.Quantity | None

Get the Time for the minimum of minimum values.

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

Gets the Total.

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

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

Method detail

EquivalentPlasticStrain.Activate() → None

Activate the current object.

EquivalentPlasticStrain.AddAlert() → Ansys.ACT.Automation.Mechanical.Results.Alert

Creates a new Alert

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

Creates a new child Comment.

EquivalentPlasticStrain.AddConvergence() → Ansys.ACT.Automation.Mechanical.Results.Convergence

Creates a new Convergence

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

Creates a new child Figure.

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

EquivalentPlasticStrain.BodyWhereMaximumOccurs() → Ansys.ACT.Automation.Mechanical.Body

Gets the body that has the maximum result value.
Throws an exception if body not found.

EquivalentPlasticStrain.ClearGeneratedData() → None

Run the ClearGeneratedData action.

EquivalentPlasticStrain.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

EquivalentPlasticStrain.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

CreateParameter method.

EquivalentPlasticStrain.CreateResultsAtAllSets() → List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Creates results at all sets for results under a solution.

EquivalentPlasticStrain.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

EquivalentPlasticStrain.DuplicateWithoutResults() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Run the DuplicateWithoutResults action.

EquivalentPlasticStrain.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

EquivalentPlasticStrain.ExportToTextFile(filePath: str) → None

Run the ExportToTextFile action.

EquivalentPlasticStrain.FetchRemoteResults() → None

Run the FetchRemoteResult action.

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

Gets the list of children, filtered by type.

EquivalentPlasticStrain.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

EquivalentPlasticStrain.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

EquivalentPlasticStrain.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

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

EquivalentPlasticStrain.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

EquivalentPlasticStrain.RemoveParameter(propName: str) → None

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

EquivalentPlasticStrain.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

EquivalentPlasticStrain.RetrieveResult() → None

Evaluates the individual result without evaluating all the results in the same solution.