CompositeFailureResult
Last update: 14.01.2025
CompositeFailureResult
class Ansys.ACT.Automation.Mechanical.Results.CompositeFailureResults.CompositeFailureResult
Bases: object
CompositeFailureResult class.
Overview
Methods
Name | Description |
---|---|
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. |
Properties
Name | Description |
---|---|
Average |
Gets the Average. |
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. |
CriticalTextVisualizationMode |
Controls whether the Critical Text Visualization Threshold is defined automatically by the product or manually by the user. Default: F:Ansys.Mechanical.DataModel.Enums.AutomaticOrManual.Automatic |
CriticalTextVisualizationThreshold |
Gets or sets the text plot threshold value when CriticalTextVisualizationMode is set to Manual. Text will not be displayed for elements with result values below the threshold for Inverse Reserve Factor results or result values exceeding the threshold for Safety factor and Safety Margin results. |
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. |
Figures |
Gets the list of associated figures. |
GlobalIDs |
Gets or sets the GlobalIDs. |
GraphControlsXAxis |
Gets or sets the GraphControlsXAxis. |
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. |
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. |
NamedSelections |
Gets or sets the NamedSelections. |
Path |
Path property. |
PlotData |
Gets the result table. |
Ply |
Gets or sets the Ply selection. |
Properties |
Gets the list of properties for this object. |
RPMSelection |
Gets or sets the RPM Selection value at which the results are evaluated. |
ScopingMethod |
Gets or sets the ScopingMethod. |
SetNumber |
Gets or sets the Set Number. |
ShowCriticalFailureMode |
Controls whether to show the critical failure mode text plot in graphics. Default: true |
ShowCriticalLayer |
Controls whether to show the critical layer text plot in graphics. Default: false |
ShowCriticalLoadCase |
Controls whether to show the critical load case text plot in graphics. Only supported for Envelope Solution Combinations. Default: false |
ShowOnReferenceSurface |
Gets or sets the Show On Reference Surface property. |
SolutionCombinationDriver |
Gets or sets the SolutionCombinationDriver. |
SolverComponentIDs |
Gets or sets the SolverComponentIDs. |
Substep |
Gets the Substep. |
Suppressed |
Gets or sets the Suppressed. |
Surface |
Surface property. |
SurfaceCoating |
SurfaceCoating property. |
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 CompositeFailureResult.Average : Ansys.Core.Units.Quantity | None
Gets the Average.
property CompositeFailureResult.By : Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None
Gets or sets the By.
property CompositeFailureResult.CalculateTimeHistory : bool | None
Gets or sets the CalculateTimeHistory.
property CompositeFailureResult.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property CompositeFailureResult.CombinationNumber : int | None
Gets or sets the Combination Number for a Solution Combination result.
property CompositeFailureResult.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property CompositeFailureResult.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 CompositeFailureResult.CrackFrontNumber : int | None
Gets or sets the CrackFrontNumber.
property CompositeFailureResult.CriticalTextVisualizationMode : Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None
Controls whether the Critical Text Visualization Threshold is defined automatically by the product or manually by the user. Default: F:Ansys.Mechanical.DataModel.Enums.AutomaticOrManual.Automatic
property CompositeFailureResult.CriticalTextVisualizationThreshold : float | None
Gets or sets the text plot threshold value when CriticalTextVisualizationMode is set to Manual. Text will not be displayed for elements with result values below the threshold for Inverse Reserve Factor results or result values exceeding the threshold for Safety factor and Safety Margin results.
property CompositeFailureResult.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property CompositeFailureResult.DisplayOption : Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None
Gets or sets the DisplayOption.
property CompositeFailureResult.DisplayTime : Ansys.Core.Units.Quantity | None
Gets or sets the DisplayTime.
property CompositeFailureResult.DpfEvaluation : Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None
Gets or sets the DpfEvaluation.
property CompositeFailureResult.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property CompositeFailureResult.GlobalIDs : str | None
Gets or sets the GlobalIDs.
property CompositeFailureResult.GraphControlsXAxis : Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None
Gets or sets the GraphControlsXAxis.
property CompositeFailureResult.Identifier : str | None
Gets or sets the Identifier.
property CompositeFailureResult.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property CompositeFailureResult.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None
Gets the internal object. For advanced usage only.
property CompositeFailureResult.IsSolved : bool | None
Gets the IsSolved.
property CompositeFailureResult.ItemType : Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None
Gets or sets the ItemType.
property CompositeFailureResult.IterationNumber : int | None
Gets the IterationNumber.
property CompositeFailureResult.LoadStep : int | None
Gets the LoadStep.
property CompositeFailureResult.LoadStepForMaximumOfMaximumValues : int | None
Get the Load Step for the maximum of maximum values.
property CompositeFailureResult.LoadStepForMaximumOfMinimumValues : int | None
Get the Load Step for the maximum of minimum values.
property CompositeFailureResult.LoadStepForMinimumOfMaximumValues : int | None
Get the Load Step for the minimum of maximum values.
property CompositeFailureResult.LoadStepForMinimumOfMinimumValues : int | None
Get the Load Step for the minimum of minimum values.
property CompositeFailureResult.LoadStepNumber : int | None
Gets or sets the LoadStepNumber.
property CompositeFailureResult.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
property CompositeFailureResult.Maximum : Ansys.Core.Units.Quantity | None
Gets the Maximum.
property CompositeFailureResult.MaximumOccursOn : str | None
Gets the MaximumOccursOn.
property CompositeFailureResult.MaximumOfMaximumOverTime : Ansys.Core.Units.Quantity | None
Gets the MaximumOfMaximumOverTime.
property CompositeFailureResult.MaximumOfMinimumOverTime : Ansys.Core.Units.Quantity | None
Gets the MaximumOfMinimumOverTime.
property CompositeFailureResult.Minimum : Ansys.Core.Units.Quantity | None
Gets the Minimum.
property CompositeFailureResult.MinimumOccursOn : str | None
Gets the MinimumOccursOn.
property CompositeFailureResult.MinimumOfMaximumOverTime : Ansys.Core.Units.Quantity | None
Gets the MinimumOfMaximumOverTime.
property CompositeFailureResult.MinimumOfMinimumOverTime : Ansys.Core.Units.Quantity | None
Gets the MinimumOfMinimumOverTime.
property CompositeFailureResult.NamedSelections : Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets or sets the NamedSelections.
property CompositeFailureResult.Path : Ansys.ACT.Automation.Mechanical.Path | None
Path property.
property CompositeFailureResult.PlotData : Ansys.Mechanical.DataModel.Results.ResultDataTable | None
Gets the result table.
property CompositeFailureResult.Ply : Iterable[Ansys.ACT.Automation.Mechanical.AnalysisPly] | None
Gets or sets the Ply selection.
property CompositeFailureResult.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property CompositeFailureResult.RPMSelection : Ansys.Core.Units.Quantity | None
Gets or sets the RPM Selection value at which the results are evaluated.
property CompositeFailureResult.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None
Gets or sets the ScopingMethod.
property CompositeFailureResult.SetNumber : int | None
Gets or sets the Set Number.
property CompositeFailureResult.ShowCriticalFailureMode : bool | None
Controls whether to show the critical failure mode text plot in graphics. Default: true
property CompositeFailureResult.ShowCriticalLayer : bool | None
Controls whether to show the critical layer text plot in graphics. Default: false
property CompositeFailureResult.ShowCriticalLoadCase : bool | None
Controls whether to show the critical load case text plot in graphics. Only supported for Envelope Solution Combinations. Default: false
property CompositeFailureResult.ShowOnReferenceSurface : bool | None
Gets or sets the Show On Reference Surface property.
property CompositeFailureResult.SolutionCombinationDriver : Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None
Gets or sets the SolutionCombinationDriver.
property CompositeFailureResult.SolverComponentIDs : str | None
Gets or sets the SolverComponentIDs.
property CompositeFailureResult.Substep : int | None
Gets the Substep.
property CompositeFailureResult.Suppressed : bool | None
Gets or sets the Suppressed.
property CompositeFailureResult.Surface : Ansys.ACT.Automation.Mechanical.Surface | None
Surface property.
property CompositeFailureResult.SurfaceCoating : Ansys.ACT.Automation.Mechanical.SurfaceCoating | None
SurfaceCoating property.
property CompositeFailureResult.Time : Ansys.Core.Units.Quantity | None
Gets the Time.
property CompositeFailureResult.TimeForMaximumOfMaximumValues : Ansys.Core.Units.Quantity | None
Get the Time for the maximum of maximum values.
property CompositeFailureResult.TimeForMaximumOfMinimumValues : Ansys.Core.Units.Quantity | None
Get the Time for the maximum of minimum values.
property CompositeFailureResult.TimeForMinimumOfMaximumValues : Ansys.Core.Units.Quantity | None
Get the Time for the minimum of maximum values.
property CompositeFailureResult.TimeForMinimumOfMinimumValues : Ansys.Core.Units.Quantity | None
Get the Time for the minimum of minimum values.
property CompositeFailureResult.Total : Ansys.Core.Units.Quantity | None
Gets the Total.
property CompositeFailureResult.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
CompositeFailureResult.Activate()
Activate the current object.
CompositeFailureResult.AddAlert()
Creates a new Alert
CompositeFailureResult.AddComment()
Creates a new child Comment.
CompositeFailureResult.AddConvergence()
Creates a new Convergence
CompositeFailureResult.AddFigure()
Creates a new child Figure.
CompositeFailureResult.AddImage(filePath: str)
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.
CompositeFailureResult.ClearGeneratedData()
Run the ClearGeneratedData action.
CompositeFailureResult.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
CompositeFailureResult.CreateParameter(propName: str)
CreateParameter method.
CompositeFailureResult.CreateResultsAtAllSets()
Creates results at all sets for results under a solution.
CompositeFailureResult.Delete()
Run the Delete action.
CompositeFailureResult.Duplicate()
Creates a copy of the current DataModelObject.
CompositeFailureResult.DuplicateWithoutResults()
Run the DuplicateWithoutResults action.
CompositeFailureResult.EvaluateAllResults()
Run the EvaluateAllResults action.
CompositeFailureResult.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings)
Run the ExportAnimation action.
CompositeFailureResult.ExportToTextFile(filePath: str)
Run the ExportToTextFile action.
CompositeFailureResult.FetchRemoteResults()
Run the FetchRemoteResult action.
CompositeFailureResult.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
CompositeFailureResult.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
CompositeFailureResult.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
CompositeFailureResult.GroupSimilarObjects()
Run the GroupSimilarObjects action.
CompositeFailureResult.PromoteToNamedSelection()
Run the PromoteToNamedSelection action.
CompositeFailureResult.PropertyByAPIName(name: str)
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.
CompositeFailureResult.PropertyByName(name: str)
Get a property by its unique name.
CompositeFailureResult.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.
CompositeFailureResult.RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.