Skip to main content

Mechanical scripting interface

PreMeshedCyclicRegion

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.PreMeshedCyclicRegion

Bases: object

Defines a PreMeshedCyclicRegion.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
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.
FlipHighLow Flips the High and Low Boundaries.
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.

Properties

Name Description
BoundaryDOFOrientation Gets or sets the BoundaryDOFOrientation.
Children Gets the list of children.
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the CoordinateSystem.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
HighBoundaryLocation Gets or sets the HighBoundaryLocation.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
LowBoundaryLocation Gets or sets the LowBoundaryLocation.
NumberOfSectors Gets or sets the NumberOfSectors.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
RelativeDistanceTolerance Gets or sets the RelativeDistanceTolerance.
ScopeMode Gets the ScopeMode.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property PreMeshedCyclicRegion.BoundaryDOFOrientation : Ansys.Mechanical.DataModel.Enums.SymmetryBoundaryDOFOrientation | None

Gets or sets the BoundaryDOFOrientation.

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

Gets the list of children.

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

Gets the list of associated comments.

property PreMeshedCyclicRegion.CoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

property PreMeshedCyclicRegion.HighBoundaryLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the HighBoundaryLocation.

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

Gets the list of associated images.

property PreMeshedCyclicRegion.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSSymmetryGeneralAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property PreMeshedCyclicRegion.LowBoundaryLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the LowBoundaryLocation.

property PreMeshedCyclicRegion.NumberOfSectors : int | None

Gets or sets the NumberOfSectors.

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

Gets the list of properties for this object.

property PreMeshedCyclicRegion.ReadOnly : bool | None

Gets or sets the ReadOnly.

property PreMeshedCyclicRegion.RelativeDistanceTolerance : float | None

Gets or sets the RelativeDistanceTolerance.

property PreMeshedCyclicRegion.ScopeMode : Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None

Gets the ScopeMode.

property PreMeshedCyclicRegion.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

PreMeshedCyclicRegion.Activate()

Activate the current object.

PreMeshedCyclicRegion.AddComment()

Creates a new child Comment.

PreMeshedCyclicRegion.AddFigure()

Creates a new child Figure.

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

PreMeshedCyclicRegion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

PreMeshedCyclicRegion.CreateParameter(propName: str)

Creates a new parameter for a Property.

PreMeshedCyclicRegion.Delete()

Run the Delete action.

PreMeshedCyclicRegion.Duplicate()

Creates a copy of the current DataModelObject.

PreMeshedCyclicRegion.FlipHighLow()

Flips the High and Low Boundaries.

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

Gets the list of children, filtered by type.

PreMeshedCyclicRegion.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

PreMeshedCyclicRegion.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

PreMeshedCyclicRegion.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

PreMeshedCyclicRegion.PropertyByName(name: str)

Get a property by its unique name.

PreMeshedCyclicRegion.RemoveParameter(propName: str)

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