PrimaryCriterion

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.PrimaryCriterion

Bases: object

Defines a PrimaryCriterion.

Overview

Methods

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.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
EvaluateAllResults	Run the EvaluateAllResults 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.
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

BaseResult	Gets or sets the BaseResult.
BoundaryCondition	Gets or sets the BoundaryCondition.
Children	Gets the list of children.
Comments	Gets the list of associated comments.
CoordinateSystem	Gets or sets the Coordinate System.
DataModelObjectCategory	Gets the current DataModelObject's category.
DirectionX	Gets or sets the DirectionX.
DirectionY	Gets or sets the DirectionY.
DirectionZ	Gets or sets the DirectionZ.
DiscretizationError	Gets or sets the DiscretizationError.
Figures	Gets the list of associated figures.
FrequencyRangeType	Gets or sets the FrequencyRangeType.
FrequencyReduction	Gets or sets the FrequencyReduction.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
LocationMethod	Gets or sets the LocationMethod.
MaximumFrequency	Gets or sets the MaximumFrequency.
MinimumFrequency	Gets or sets the MinimumFrequency.
ModeNumber	Gets or sets the ModeNumber.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
ReferenceType	Gets or sets the ReferenceType.
RemotePoint	Gets or sets the RemotePoint.
RobustFrequenciesReduction	Gets or sets the RobustFrequenciesReduction.
SpatialReduction	Gets or sets the SpatialReduction.
SpatialReductionMethod	Gets or sets the SpatialReductionMethod.
Step	Gets or sets the Step.
Suppressed	Gets or sets the Suppressed.
Value	Gets the Value.
VectorReduction	Gets or sets the VectorReduction.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property PrimaryCriterion.BaseResult: Ansys.Mechanical.DataModel.Enums.BaseResultType | None

Gets or sets the BaseResult.

property PrimaryCriterion.BoundaryCondition: Ansys.ACT.Automation.Mechanical.DataModelObject | None

Gets or sets the BoundaryCondition.

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

Gets the list of children.

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

Gets the list of associated comments.

property PrimaryCriterion.CoordinateSystem: Ansys.Mechanical.DataModel.Interfaces.ICoordinateSystemSelection | None

Gets or sets the Coordinate System.

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

Gets the current DataModelObject's category.

property PrimaryCriterion.DirectionX: float | None

Gets or sets the DirectionX.

property PrimaryCriterion.DirectionY: float | None

Gets or sets the DirectionY.

property PrimaryCriterion.DirectionZ: float | None

Gets or sets the DirectionZ.

property PrimaryCriterion.DiscretizationError: float | None

Gets or sets the DiscretizationError.

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

Gets the list of associated figures.

property PrimaryCriterion.FrequencyRangeType: Ansys.Mechanical.DataModel.Enums.CriterionFrequencyRangeType | None

Gets or sets the FrequencyRangeType.

property PrimaryCriterion.FrequencyReduction: Ansys.Mechanical.DataModel.Enums.FrequencyReductionType | None

Gets or sets the FrequencyReduction.

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

Gets the list of associated images.

property PrimaryCriterion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTopoCriterionAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property PrimaryCriterion.LocationMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the LocationMethod.

property PrimaryCriterion.MaximumFrequency: Ansys.Core.Units.Quantity | None

Gets or sets the MaximumFrequency.

property PrimaryCriterion.MinimumFrequency: Ansys.Core.Units.Quantity | None

Gets or sets the MinimumFrequency.

property PrimaryCriterion.ModeNumber: int | None

Gets or sets the ModeNumber.

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

Gets the list of properties for this object.

property PrimaryCriterion.ReadOnly: bool | None

Gets or sets the ReadOnly.

property PrimaryCriterion.ReferenceType: Ansys.Mechanical.DataModel.Enums.VectorReductionReferenceType | None

Gets or sets the ReferenceType.

property PrimaryCriterion.RemotePoint: Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePoint.

property PrimaryCriterion.RobustFrequenciesReduction: Ansys.Mechanical.DataModel.Enums.RobustFrequenciesReductionType | None

Gets or sets the RobustFrequenciesReduction.

property PrimaryCriterion.SpatialReduction: Ansys.Mechanical.DataModel.Enums.SpatialReductionType | None

Gets or sets the SpatialReduction.

property PrimaryCriterion.SpatialReductionMethod: Ansys.Mechanical.DataModel.Enums.SpatialReductionMethodType | None

Gets or sets the SpatialReductionMethod.

property PrimaryCriterion.Step: int | None

Gets or sets the Step.

property PrimaryCriterion.Suppressed: bool | None

Gets or sets the Suppressed.

property PrimaryCriterion.Value: Ansys.Core.Units.Quantity | None

Gets the Value.

property PrimaryCriterion.VectorReduction: Ansys.Mechanical.DataModel.Enums.VectorReductionType | None

Gets or sets the VectorReduction.

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

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

Method detail

PrimaryCriterion.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

PrimaryCriterion.ClearGeneratedData() → None

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

PrimaryCriterion.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

PrimaryCriterion.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

PrimaryCriterion.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

PrimaryCriterion.RemoveParameter(propName: str) → None

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

PrimaryCriterion.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.