CompositeFailureResult#
- class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Results.CompositeFailureResults.CompositeFailureResult(internalObject: Any)#
Bases:
object
Overview#
Activate the current object. |
|
Creates a new Alert |
|
Creates a new child Comment. |
|
Creates a new Convergence |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Gets the body that has the maximum result value. |
|
Run the ClearGeneratedData action. |
|
Copies all visible properties from this object to another. |
|
CreateObjRef method. |
|
CreateParameter method. |
|
Creates results at all sets for results under a solution. |
|
Run the Delete action. |
|
Creates a copy of the current DataModelObject. |
|
Run the DuplicateWithoutResults action. |
|
Equals method. |
|
Run the EvaluateAllResults action. |
|
Run the ExportAnimation action. |
|
ExportToSTLFile method. |
|
ExportToTextFile method. |
|
Run the FetchRemoteResult action. |
|
Run the FetchRemoteResult action. |
|
GetAPIName method. |
|
GetAllProperties method. |
|
Gets the list of children, filtered by type. |
|
GetDetailsView method. |
|
Enum name bound to value |
|
GetHashCode method. |
|
GetIconFile method. |
|
GetLifetimeService method. |
|
GetNodalValues method. |
|
GetObjectData method. |
|
Gets the parameter corresponding to the given property. |
|
GetPath method. |
|
GetPropertyName method. |
|
GetPropertyValue method. |
|
GetQuantityName method. |
|
GetType method. |
|
GetVisibleProperties method. |
|
GetVisiblePropertyNames method. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
InitializeLifetimeService method. |
|
IsPropertyEditable method. |
|
IsPropertyVisible method. |
|
Run the PromoteToNamedSelection action. |
|
Get a property by its API name. |
|
PropertyById method. |
|
Get a property by its unique name. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Run the RenameBasedOnDefinition action. |
|
RetrieveRemoteDPFResults method. |
|
Evaluates the individual result without evaluating all the results in the same solution. |
|
ToString method. |
AttachedRefs property. |
|
Gets the Average. |
|
Gets or sets the By. |
|
Gets or sets the CalculateTimeHistory. |
|
Gets the list of children. |
|
ClsId property. |
|
Gets or sets the Combination Number for a Solution Combination result. |
|
Gets the list of associated comments. |
|
Gets or sets the Coordinate System. |
|
Gets or sets the CrackFrontNumber. |
|
Controls whether the Critical Text Visualization Threshold is defined automatically by the product or manually by the user. Default: |
|
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. |
|
Gets the current DataModelObject's category. |
|
Gets or sets the DisplayOption. |
|
Gets or sets the DisplayTime. |
|
Gets or sets the DpfEvaluation. |
|
Gets the list of associated figures. |
|
Gets or sets the GlobalIDs. |
|
Gets or sets the GraphControlsXAxis. |
|
GroupingFolder property. |
|
IconName property. |
|
Gets or sets the Identifier. |
|
Gets the list of associated images. |
|
Gets the internal object. For advanced usage only. |
|
Gets the IsSolved. |
|
Gets or sets the ItemType. |
|
Gets the IterationNumber. |
|
Gets the LoadStep. |
|
Get the Load Step for the maximum of maximum values. |
|
Get the Load Step for the maximum of minimum values. |
|
Get the Load Step for the minimum of maximum values. |
|
Get the Load Step for the minimum of minimum values. |
|
Gets or sets the LoadStepNumber. |
|
Gets or sets the Location. |
|
Gets the Maximum. |
|
Gets the MaximumOccursOn. |
|
Gets the MaximumOfMaximumOverTime. |
|
Gets the MaximumOfMinimumOverTime. |
|
Gets the Minimum. |
|
Gets the MinimumOccursOn. |
|
Gets the MinimumOfMaximumOverTime. |
|
Gets the MinimumOfMinimumOverTime. |
|
Name property. |
|
Gets or sets the NamedSelections. |
|
ObjectId property. |
|
ObjectState property. |
|
ObjectTags property. |
|
Parent property. |
|
Path property. |
|
Gets the result table. |
|
Gets or sets the Ply selection. |
|
Gets the list of properties for this object. |
|
Gets or sets the RPM Selection value at which the results are evaluated. |
|
Gets or sets the ResultType. |
|
Gets or sets the RpmSetNumber. |
|
Gets or sets the ScopingMethod. |
|
Gets or sets the SeparateDataByEntity. |
|
Gets or sets the Set Number. |
|
Controls whether to show the critical failure mode text plot in graphics. Default: true |
|
Controls whether to show the critical layer text plot in graphics. Default: false |
|
Controls whether to show the critical load case text plot in graphics. Only supported for Envelope Solution Combinations. Default: false |
|
Gets or sets the Show On Reference Surface property. |
|
Gets or sets the SolutionCombinationDriver. |
|
Gets or sets the SolverComponentIDs. |
|
State property. |
|
Gets the Substep. |
|
Gets or sets the Suppressed. |
|
Surface property. |
|
SurfaceCoating property. |
|
Gets the tabular data of the result. Use a to get index to each column of the tabular data. |
|
Gets the Time. |
|
Get the Time for the maximum of maximum values. |
|
Get the Time for the maximum of minimum values. |
|
Get the Time for the minimum of maximum values. |
|
Get the Time for the minimum of minimum values. |
|
Gets the Total. |
|
Gets the list of properties that are visible for this object. |
|
Gets or sets the Filer in Waterfall. |
|
Gets or sets the Frequency Selection. |
|
Gets or sets the Interpolate Data Property. |
|
Gets or sets the Lower Band Value. |
|
Gets or sets the Display Max RPM. |
|
Gets or sets the Display Min RPM. |
|
Gets or sets the Mode Selection. |
|
Gets or sets the Order Selection. |
|
Gets or sets the RPM Selection. |
|
Gets or sets the Scope to Order Lines Property. |
|
Gets or sets the Time Selection. |
|
Gets or sets the Upper Band Value. |
|
Gets or sets the Maximum X-Axis Value. |
|
Gets or sets the Minimum X-Axis Value. |
|
Gets or sets the Maximum Y-Axis Value. |
|
Gets or sets the Minimum Y-Axis Value. |
|
Gets or sets the Waterfall Mosaic Text Property. |
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.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:
- 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.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None#
Gets or sets the GraphControlsXAxis.
- property CompositeFailureResult.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#
GroupingFolder property.
- 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.ItemType: Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None#
Gets or sets the ItemType.
- 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.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.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.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.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#
ObjectState property.
- property CompositeFailureResult.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None#
ObjectTags property.
- property CompositeFailureResult.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#
Parent property.
- 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.ResultType: Ansys.Mechanical.DataModel.Enums.ResultType | None#
Gets or sets the ResultType.
- property CompositeFailureResult.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#
Gets or sets the ScopingMethod.
- property CompositeFailureResult.SeparateDataByEntity: bool | None#
Gets or sets the SeparateDataByEntity.
- 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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#
State property.
- property CompositeFailureResult.Surface: Ansys.ACT.Automation.Mechanical.Surface | None#
Surface property.
- property CompositeFailureResult.SurfaceCoating: Ansys.ACT.Automation.Mechanical.SurfaceCoating | None#
SurfaceCoating property.
- property CompositeFailureResult.TabularData: Ansys.Mechanical.Interfaces.ITable | None#
Gets the tabular data of the result. Use a to get index to each column of the tabular data.
- 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.
- property CompositeFailureResult.WaterfallDisplayFilterBy: Ansys.Mechanical.DataModel.Enums.WaterfallDisplayFilterBy | None#
Gets or sets the Filer in Waterfall.
- property CompositeFailureResult.WaterfallDisplayFrequencySelection: str | None#
Gets or sets the Frequency Selection.
- property CompositeFailureResult.WaterfallDisplayInterpolateData: bool | None#
Gets or sets the Interpolate Data Property.
- property CompositeFailureResult.WaterfallDisplayLowerBand: float | None#
Gets or sets the Lower Band Value.
- property CompositeFailureResult.WaterfallDisplayMaxRPM: Ansys.Core.Units.Quantity | None#
Gets or sets the Display Max RPM.
- property CompositeFailureResult.WaterfallDisplayMinRPM: Ansys.Core.Units.Quantity | None#
Gets or sets the Display Min RPM.
- property CompositeFailureResult.WaterfallDisplayModeSelection: str | None#
Gets or sets the Mode Selection.
- property CompositeFailureResult.WaterfallDisplayOrderSelection: str | None#
Gets or sets the Order Selection.
- property CompositeFailureResult.WaterfallDisplayRpmSelection: str | None#
Gets or sets the RPM Selection.
- property CompositeFailureResult.WaterfallDisplayScopeToOrderLines: bool | None#
Gets or sets the Scope to Order Lines Property.
- property CompositeFailureResult.WaterfallDisplayTimeSelection: str | None#
Gets or sets the Time Selection.
- property CompositeFailureResult.WaterfallDisplayUpperBand: float | None#
Gets or sets the Upper Band Value.
- property CompositeFailureResult.WaterfallDisplayXAxisMaximum: float | None#
Gets or sets the Maximum X-Axis Value.
- property CompositeFailureResult.WaterfallDisplayXAxisMinimum: float | None#
Gets or sets the Minimum X-Axis Value.
- property CompositeFailureResult.WaterfallDisplayYAxisMaximum: float | None#
Gets or sets the Maximum Y-Axis Value.
Method detail#
- CompositeFailureResult.AddAlert() Ansys.ACT.Automation.Mechanical.Results.Alert#
Creates a new Alert
- CompositeFailureResult.AddComment() Ansys.ACT.Automation.Mechanical.Comment#
Creates a new child Comment.
- CompositeFailureResult.AddConvergence() Ansys.ACT.Automation.Mechanical.Results.Convergence#
Creates a new Convergence
- CompositeFailureResult.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#
Creates a new child Figure.
- CompositeFailureResult.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.
- CompositeFailureResult.BodyWhereMaximumOccurs() Ansys.ACT.Automation.Mechanical.Body#
Gets the body that has the maximum result value.
Throws an exception if body not found.
- CompositeFailureResult.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#
Copies all visible properties from this object to another.
- CompositeFailureResult.CreateObjRef(requestedType: type) System.Runtime.Remoting.ObjRef#
CreateObjRef method.
- CompositeFailureResult.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#
CreateParameter method.
- CompositeFailureResult.CreateResultsAtAllSets() List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]#
Creates results at all sets for results under a solution.
- CompositeFailureResult.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#
Creates a copy of the current DataModelObject.
- CompositeFailureResult.DuplicateWithoutResults() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#
Run the DuplicateWithoutResults action.
- CompositeFailureResult.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) bool#
Equals method.
- CompositeFailureResult.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) None#
Run the ExportAnimation action.
- CompositeFailureResult.ExportToTextFile(bIgnoreExcelPreference: bool, filePath: str) None#
ExportToTextFile method.
- CompositeFailureResult.GetAllProperties() List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#
GetAllProperties method.
- CompositeFailureResult.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#
Gets the list of children, filtered by type.
- CompositeFailureResult.GetDetailsView() Ansys.ACT.Automation.Mechanical.DetailsViewData#
GetDetailsView method.
- CompositeFailureResult.GetEnumName(enumType: type, value: int, dispId: int) str#
Enum name bound to value
- CompositeFailureResult.GetIconFile() System.Byte#
GetIconFile method.
- CompositeFailureResult.GetLifetimeService() Any#
GetLifetimeService method.
- CompositeFailureResult.GetNodalValues(bodyRefId: int) System.Collections.Generic.Dictionary[int, float]#
GetNodalValues method.
- CompositeFailureResult.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) None#
GetObjectData method.
- CompositeFailureResult.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#
Gets the parameter corresponding to the given property.
- CompositeFailureResult.GetQuantityName(obj: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto) str#
GetQuantityName method.
- CompositeFailureResult.GetVisibleProperties() List[System.Reflection.PropertyInfo]#
GetVisibleProperties method.
- CompositeFailureResult.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#
Run the GroupSimilarObjects action.
- CompositeFailureResult.InitializeLifetimeService() Any#
InitializeLifetimeService method.
- CompositeFailureResult.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#
Run the PromoteToNamedSelection action.
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.PropertyById(dispId: int) Ansys.ACT.Automation.Mechanical.Property#
PropertyById method.
- CompositeFailureResult.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#
Get a property by its unique name.
- CompositeFailureResult.RemoveParameter(propName: str) None#
Removes the parameter from the parameter set corresponding to the given property.