StructuralError

class ansys.mechanical.stubs.Ansys.ACT.Automation.Mechanical.Results.StressResults.StructuralError

Bases: object

Defines a StructuralError.

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.
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.
AverageRadiusOfCurvature	Gets or sets the AverageRadiusOfCurvature.
BendingInside	Gets the BendingInside.
BendingOutside	Gets the BendingOutside.
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.
Layer	Gets or sets the Layer.
Linearized2DBehavior	Gets or sets the Linearized2DBehavior.
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.
Membrane	Gets the Membrane.
MembraneBendingCenter	Gets the MembraneBendingCenter.
MembraneBendingInside	Gets the MembraneBendingInside.
MembraneBendingOutside	Gets the MembraneBendingOutside.
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.
NormalOrientation	Gets or sets the NormalOrientation.
Path	Path property.
PeakCenter	Gets the PeakCenter.
PeakInside	Gets the PeakInside.
PeakOutside	Gets the PeakOutside.
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.
Probability	Gets the Probability.
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.
ScaleFactor	Gets or sets the ScaleFactor.
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.
Subtype	Gets or sets the Subtype.
Suppressed	Gets or sets the Suppressed.
Surface	Surface property.
SurfaceCoating	SurfaceCoating property.
SweepingPhase	Gets or sets the SweepingPhase.
ThroughThicknessBendingStress	Gets or sets the ThroughThicknessBendingStress.
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.
TotalCenter	Gets the TotalCenter.
TotalInside	Gets the TotalInside.
TotalOutside	Gets the TotalOutside.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property StructuralError.Amplitude: bool | None

Gets or sets the Amplitude.

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

Gets the Average.

property StructuralError.AverageAcrossBodies: bool | None

Gets or sets the AverageAcrossBodies.

property StructuralError.AverageRadiusOfCurvature: Ansys.Core.Units.Quantity | None

Gets or sets the AverageRadiusOfCurvature.

property StructuralError.BendingInside: Ansys.Core.Units.Quantity | None

Gets the BendingInside.

property StructuralError.BendingOutside: Ansys.Core.Units.Quantity | None

Gets the BendingOutside.

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

Gets or sets the By.

property StructuralError.CalculateTimeHistory: bool | None

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property StructuralError.CombinationNumber: int | None

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

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

Gets the list of associated comments.

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

Gets or sets the CrackFrontNumber.

property StructuralError.CyclicMode: int | None

Gets or sets the CyclicMode.

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

Gets the current DataModelObject's category.

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

Gets or sets the DisplayOption.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

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

Gets or sets the EnvironmentSelection.

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

Gets the list of associated figures.

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

Gets or sets the Frequency.

property StructuralError.GlobalIDs: str | None

Gets or sets the GlobalIDs.

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

Gets or sets the GraphControlsXAxis.

property StructuralError.HarmonicIndex: int | None

Gets or sets the HarmonicIndex.

property StructuralError.Identifier: str | None

Gets or sets the Identifier.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property StructuralError.IsSolved: bool | None

Gets the IsSolved.

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

Gets or sets the ItemType.

property StructuralError.IterationNumber: int | None

Gets the IterationNumber.

property StructuralError.IterationStep: int | None

Gets or sets the IterationStep.

property StructuralError.Layer: int | None

Gets or sets the Layer.

property StructuralError.Linearized2DBehavior: Ansys.Mechanical.DataModel.Enums.Linearized2DBehavior | None

Gets or sets the Linearized2DBehavior.

property StructuralError.LoadMultiplier: float | None

Gets the LoadMultiplier.

property StructuralError.LoadStep: int | None

Gets the LoadStep.

property StructuralError.LoadStepForMaximumOfMaximumValues: int | None

Get the Load Step for the maximum of maximum values.

property StructuralError.LoadStepForMaximumOfMinimumValues: int | None

Get the Load Step for the maximum of minimum values.

property StructuralError.LoadStepForMinimumOfMaximumValues: int | None

Get the Load Step for the minimum of maximum values.

property StructuralError.LoadStepForMinimumOfMinimumValues: int | None

Get the Load Step for the minimum of minimum values.

property StructuralError.LoadStepNumber: int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

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

Gets the Maximum.

property StructuralError.MaximumOccursOn: str | None

Gets the MaximumOccursOn.

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

Gets the MaximumOfMaximumOverTime.

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

Gets the MaximumOfMinimumOverTime.

property StructuralError.Membrane: Ansys.Core.Units.Quantity | None

Gets the Membrane.

property StructuralError.MembraneBendingCenter: Ansys.Core.Units.Quantity | None

Gets the MembraneBendingCenter.

property StructuralError.MembraneBendingInside: Ansys.Core.Units.Quantity | None

Gets the MembraneBendingInside.

property StructuralError.MembraneBendingOutside: Ansys.Core.Units.Quantity | None

Gets the MembraneBendingOutside.

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

Gets the Minimum.

property StructuralError.MinimumOccursOn: str | None

Gets the MinimumOccursOn.

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

Gets the MinimumOfMaximumOverTime.

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

Gets the MinimumOfMinimumOverTime.

property StructuralError.Mode: int | None

Gets or sets the Mode.

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

Gets or sets the NamedSelections.

property StructuralError.NormalOrientation: Ansys.Mechanical.DataModel.Enums.NormalOrientationType | None

Gets or sets the NormalOrientation.

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

Path property.

property StructuralError.PeakCenter: Ansys.Core.Units.Quantity | None

Gets the PeakCenter.

property StructuralError.PeakInside: Ansys.Core.Units.Quantity | None

Gets the PeakInside.

property StructuralError.PeakOutside: Ansys.Core.Units.Quantity | None

Gets the PeakOutside.

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

Gets or sets the PhaseIncrement.

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

Plies property.

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

Gets the result table.

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

Gets or sets the Ply selection.

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

Gets or sets the Position.

property StructuralError.Probability: float | None

Gets the Probability.

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

Gets the list of properties for this object.

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

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

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

Gets the ReportedFrequency.

property StructuralError.ScaleFactor: Ansys.Mechanical.DataModel.Enums.ScaleFactorType | None

Gets or sets the ScaleFactor.

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

Gets or sets the ScopingMethod.

property StructuralError.SetNumber: int | None

Gets or sets the Set Number.

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

Gets or sets the SolutionCombinationDriver.

property StructuralError.SolverComponentIDs: str | None

Gets or sets the SolverComponentIDs.

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

Gets or sets the StressStrainType.

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

Gets or sets the SubScopeBy.

property StructuralError.Substep: int | None

Gets the Substep.

property StructuralError.Subtype: Ansys.Mechanical.DataModel.Enums.LinearizedSubtype | None

Gets or sets the Subtype.

property StructuralError.Suppressed: bool | None

Gets or sets the Suppressed.

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

Surface property.

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

SurfaceCoating property.

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

Gets or sets the SweepingPhase.

property StructuralError.ThroughThicknessBendingStress: Ansys.Mechanical.DataModel.Enums.ThroughThicknessBendingStress | None

Gets or sets the ThroughThicknessBendingStress.

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

Gets the Time.

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

Get the Time for the maximum of maximum values.

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

Get the Time for the maximum of minimum values.

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

Get the Time for the minimum of maximum values.

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

Get the Time for the minimum of minimum values.

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

Gets the Total.

property StructuralError.TotalCenter: Ansys.Core.Units.Quantity | None

Gets the TotalCenter.

property StructuralError.TotalInside: Ansys.Core.Units.Quantity | None

Gets the TotalInside.

property StructuralError.TotalOutside: Ansys.Core.Units.Quantity | None

Gets the TotalOutside.

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

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

Method detail

StructuralError.Activate() → None

Activate the current object.

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

Creates a new Alert

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

Creates a new child Comment.

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

Creates a new Convergence

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

Creates a new child Figure.

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

StructuralError.ClearGeneratedData() → None

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

CreateParameter method.

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

Creates results at all sets for results under a solution.

StructuralError.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Run the DuplicateWithoutResults action.

StructuralError.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

StructuralError.ExportToTextFile(filePath: str) → None

Run the ExportToTextFile action.

StructuralError.FetchRemoteResults() → None

Run the FetchRemoteResult action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

StructuralError.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Run the PromoteToNamedSelection action.

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

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

Get a property by its unique name.

StructuralError.RemoveParameter(propName: str) → None

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

StructuralError.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

StructuralError.RetrieveResult() → None

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