UserDefinedResult#

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

Bases: object

Defines a UserDefinedResult.

Overview#

Activate

Activate the current object.

AddComment

Creates a new child Comment.

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

Creates a new parameter for a Property.

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.

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.

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.

Expression

Gets or sets the Expression.

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.

InputUnitSystem

Gets the InputUnitSystem.

InternalObject

Gets the internal object. For advanced usage only.

IsSolved

Gets the IsSolved.

ItemType

Gets or sets the ItemType.

IterationNumber

Gets the IterationNumber.

Layer

Gets or sets the Layer.

LoadMultiplier

Gets the LoadMultiplier.

LoadStep

Gets the LoadStep.

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 (Result Set Number).

OutputUnit

Gets or sets the OutputUnit.

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.

RequestedFrequency

Gets or sets the RequestedFrequency.

ResponseType

Gets or sets the ResponseType.

ScaleFactor

Gets or sets the ScaleFactor.

ScaleFactorValue

Gets or sets the ScaleFactorValue.

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.

SubScopeBy

Gets or sets the SubScopeBy.

Substep

Gets the Substep.

Suppressed

Gets or sets the Suppressed.

SweepingPhase

Gets or sets the SweepingPhase.

Time

Gets the Time.

Type

Gets the Type.

VisibleProperties

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

Property detail#

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

Gets the Average.

property UserDefinedResult.AverageAcrossBodies: bool | None#

Gets or sets the AverageAcrossBodies.

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

Gets or sets the By.

property UserDefinedResult.CalculateTimeHistory: bool | None#

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property UserDefinedResult.CombinationNumber: int | None#

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

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

Gets the list of associated comments.

property UserDefinedResult.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 UserDefinedResult.CyclicMode: int | None#

Gets or sets the CyclicMode.

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

Gets the current DataModelObject's category.

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

Gets or sets the DisplayOption.

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

Gets or sets the DisplayTime.

property UserDefinedResult.Expression: str | None#

Gets or sets the Expression.

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

Gets the list of associated figures.

property UserDefinedResult.GlobalIDs: str | None#

Gets or sets the GlobalIDs.

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

Gets or sets the GraphControlsXAxis.

property UserDefinedResult.Identifier: str | None#

Gets or sets the Identifier.

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

Gets the list of associated images.

property UserDefinedResult.InputUnitSystem: Ansys.Mechanical.DataModel.Enums.WBUnitSystemType | None#

Gets the InputUnitSystem.

property UserDefinedResult.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSCustomResultAuto | None#

Gets the internal object. For advanced usage only.

property UserDefinedResult.IsSolved: bool | None#

Gets the IsSolved.

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

Gets or sets the ItemType.

property UserDefinedResult.IterationNumber: int | None#

Gets the IterationNumber.

property UserDefinedResult.Layer: int | None#

Gets or sets the Layer.

property UserDefinedResult.LoadMultiplier: float | None#

Gets the LoadMultiplier.

property UserDefinedResult.LoadStep: int | None#

Gets the LoadStep.

property UserDefinedResult.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

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

Gets the Maximum.

property UserDefinedResult.MaximumOccursOn: str | None#

Gets the MaximumOccursOn.

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

Gets the MaximumOfMaximumOverTime.

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

Gets the MaximumOfMinimumOverTime.

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

Gets the Minimum.

property UserDefinedResult.MinimumOccursOn: str | None#

Gets the MinimumOccursOn.

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

Gets the MinimumOfMaximumOverTime.

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

Gets the MinimumOfMinimumOverTime.

property UserDefinedResult.Mode: int | None#

Gets or sets the Mode (Result Set Number).

property UserDefinedResult.OutputUnit: Ansys.Mechanical.DataModel.Enums.UnitCategoryType | None#

Gets or sets the OutputUnit.

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

Gets or sets the PhaseIncrement.

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

Plies property.

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

Gets the result table.

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

Gets or sets the Ply selection.

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

Gets or sets the Position.

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

Gets the list of properties for this object.

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

Gets the ReportedFrequency.

property UserDefinedResult.RequestedFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the RequestedFrequency.

property UserDefinedResult.ResponseType: Ansys.Mechanical.DataModel.Enums.CoreResultType | None#

Gets or sets the ResponseType.

property UserDefinedResult.ScaleFactor: Ansys.Mechanical.DataModel.Enums.ScaleFactorType | None#

Gets or sets the ScaleFactor.

property UserDefinedResult.ScaleFactorValue: float | None#

Gets or sets the ScaleFactorValue.

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

Gets or sets the ScopingMethod.

property UserDefinedResult.SetNumber: int | None#

Gets or sets the Set Number.

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

Gets or sets the SolutionCombinationDriver.

property UserDefinedResult.SolverComponentIDs: str | None#

Gets or sets the SolverComponentIDs.

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

Gets or sets the SubScopeBy.

property UserDefinedResult.Substep: int | None#

Gets the Substep.

property UserDefinedResult.Suppressed: bool | None#

Gets or sets the Suppressed.

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

Gets or sets the SweepingPhase.

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

Gets the Time.

property UserDefinedResult.Type: str | None#

Gets the Type.

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

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

Method detail#

UserDefinedResult.Activate() None#

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

UserDefinedResult.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.
UserDefinedResult.ClearGeneratedData() None#

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

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

Creates results at all sets for results under a solution.

UserDefinedResult.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Run the DuplicateWithoutResults action.

UserDefinedResult.EvaluateAllResults() None#

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

UserDefinedResult.ExportToTextFile(filePath: str) None#

Run the ExportToTextFile action.

UserDefinedResult.FetchRemoteResults() None#

Run the FetchRemoteResult action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

UserDefinedResult.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Run the PromoteToNamedSelection action.

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

Get a property by its unique name.

UserDefinedResult.RemoveParameter(propName: str) None#

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

UserDefinedResult.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.