NonlinearAdaptiveRegion

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.BoundaryConditions.NonlinearAdaptiveRegion(internalObject: Any)

Bases: object

Defines a NonlinearAdaptiveRegion.

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.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
BufferElements	Gets or sets the BufferElements.
BufferLayers	Gets or sets the BufferLayers.
CheckAt	Gets or sets the CheckAt.
CheckAtValue	Gets or sets the CheckAtValue.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
CoordinateSystem	Gets or sets the CoordinateSystem.
Criterion	Gets or sets the Criterion.
DamageThreshold	Gets or sets the Damage Threshold for Cohesive Zone Material. Default: 0. Valid range is between 0 and 1, exclusive of 1.
DataModelObjectCategory	Gets the current DataModelObject's category.
EndTime	Gets or sets the EndTime.
EnergyCoefficient	Gets or sets the EnergyCoefficient.
EnergyThreshold	Gets or sets the Energy Threshold for Cohesive Zone Material. Default: 0. Valid range is greater than equal to 0.
Figures	Gets the list of associated figures.
GroupingFolder	GroupingFolder property.
HexDomCheckAt	Gets or sets the HexDomCheckAt.
HexDomCheckAtValue	Gets or sets the HexDomCheckAtValue.
HexDomEndTime	Gets or sets the HexDomEndTime.
HexDomStartTime	Gets or sets the HexDomStartTime.
HexDomTimeRange	Gets or sets the HexDomTimeRange.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
JacobianRatioValue	Gets or sets the JacobianRatioValue.
LengthX	Gets or sets the LengthX.
LengthY	Gets or sets the LengthY.
LengthZ	Gets or sets the LengthZ.
Location	Gets or sets the Location.
MaximumCornerAngle	Gets or sets the MaximumCornerAngle.
MaximumValue	Gets or sets the Maximum Value for Maximum Equivalent Strain and Maximum Principal Strain. Default: -1. Valid range is greater than or equal to -1.
MinimumNumberOfElements	Gets or sets the Minimum Number Of Elements for Contact Elements. Default: 0. Valid range is greater than 0.
MinimumValue	Gets or sets the Minimum Value for Maximum Equivalent Strain and Maximum Principal Strain. Default: -1. Valid range is greater than or equal to -1.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Option	Gets or sets the Option.
Parent	Parent property.
Properties	Gets the list of properties for this object.
RemeshLayerEnd	Gets or sets the RemeshLayerEnd.
RemeshLayerFrequency	Gets or sets the RemeshLayerFrequency.
RemeshLayerStart	Gets or sets the RemeshLayerStart.
SkewnessValue	Gets or sets the SkewnessValue.
StartTime	Gets or sets the StartTime.
State	State property.
Suppressed	Gets or sets the Suppressed.
TimeRange	Gets or sets the TimeRange.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property NonlinearAdaptiveRegion.AttachedRefs: List[int] | None

AttachedRefs property.

property NonlinearAdaptiveRegion.BufferElements: int | None

Gets or sets the BufferElements.

property NonlinearAdaptiveRegion.BufferLayers: int | None

Gets or sets the BufferLayers.

property NonlinearAdaptiveRegion.CheckAt: Ansys.Mechanical.DataModel.Enums.NonlinearAdaptivityUpdateType | None

Gets or sets the CheckAt.

property NonlinearAdaptiveRegion.CheckAtValue: int | None

Gets or sets the CheckAtValue.

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

Gets the list of children.

property NonlinearAdaptiveRegion.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

property NonlinearAdaptiveRegion.Criterion: Ansys.Mechanical.DataModel.Enums.NonlinearAdaptivityCriterionType | None

Gets or sets the Criterion.

property NonlinearAdaptiveRegion.DamageThreshold: float | None

Gets or sets the Damage Threshold for Cohesive Zone Material. Default: 0. Valid range is between 0 and 1, exclusive of 1.

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

Gets the current DataModelObject's category.

property NonlinearAdaptiveRegion.EndTime: Ansys.Core.Units.Quantity | None

Gets or sets the EndTime.

property NonlinearAdaptiveRegion.EnergyCoefficient: float | None

Gets or sets the EnergyCoefficient.

property NonlinearAdaptiveRegion.EnergyThreshold: float | None

Gets or sets the Energy Threshold for Cohesive Zone Material. Default: 0. Valid range is greater than equal to 0.

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

Gets the list of associated figures.

property NonlinearAdaptiveRegion.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property NonlinearAdaptiveRegion.HexDomCheckAt: Ansys.Mechanical.DataModel.Enums.NonlinearAdaptivityUpdateType | None

Gets or sets the HexDomCheckAt.

property NonlinearAdaptiveRegion.HexDomCheckAtValue: int | None

Gets or sets the HexDomCheckAtValue.

property NonlinearAdaptiveRegion.HexDomEndTime: Ansys.Core.Units.Quantity | None

Gets or sets the HexDomEndTime.

property NonlinearAdaptiveRegion.HexDomStartTime: Ansys.Core.Units.Quantity | None

Gets or sets the HexDomStartTime.

property NonlinearAdaptiveRegion.HexDomTimeRange: Ansys.Mechanical.DataModel.Enums.NonlinearAdaptivityTimeRange | None

Gets or sets the HexDomTimeRange.

property NonlinearAdaptiveRegion.IconName: str | None

IconName property.

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

Gets the list of associated images.

property NonlinearAdaptiveRegion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSNonlinearAdaptivityAuto | None

Gets the internal object. For advanced usage only.

property NonlinearAdaptiveRegion.JacobianRatioValue: float | None

Gets or sets the JacobianRatioValue.

property NonlinearAdaptiveRegion.LengthX: Ansys.Core.Units.Quantity | None

Gets or sets the LengthX.

property NonlinearAdaptiveRegion.LengthY: Ansys.Core.Units.Quantity | None

Gets or sets the LengthY.

property NonlinearAdaptiveRegion.LengthZ: Ansys.Core.Units.Quantity | None

Gets or sets the LengthZ.

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

Gets or sets the Location.

property NonlinearAdaptiveRegion.MaximumCornerAngle: Ansys.Core.Units.Quantity | None

Gets or sets the MaximumCornerAngle.

property NonlinearAdaptiveRegion.MaximumValue: float | None

Gets or sets the Maximum Value for Maximum Equivalent Strain and Maximum Principal Strain. Default: -1. Valid range is greater than or equal to -1.

property NonlinearAdaptiveRegion.MinimumNumberOfElements: int | None

Gets or sets the Minimum Number Of Elements for Contact Elements. Default: 0. Valid range is greater than 0.

property NonlinearAdaptiveRegion.MinimumValue: float | None

Gets or sets the Minimum Value for Maximum Equivalent Strain and Maximum Principal Strain. Default: -1. Valid range is greater than or equal to -1.

property NonlinearAdaptiveRegion.Name: str | None

Name property.

property NonlinearAdaptiveRegion.ObjectId: int | None

ObjectId property.

property NonlinearAdaptiveRegion.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property NonlinearAdaptiveRegion.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property NonlinearAdaptiveRegion.Option: Ansys.Mechanical.DataModel.Enums.NonlinearAdaptivityOptionType | None

Gets or sets the Option.

property NonlinearAdaptiveRegion.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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

Gets the list of properties for this object.

property NonlinearAdaptiveRegion.RemeshLayerEnd: int | None

Gets or sets the RemeshLayerEnd.

property NonlinearAdaptiveRegion.RemeshLayerFrequency: int | None

Gets or sets the RemeshLayerFrequency.

property NonlinearAdaptiveRegion.RemeshLayerStart: int | None

Gets or sets the RemeshLayerStart.

property NonlinearAdaptiveRegion.SkewnessValue: float | None

Gets or sets the SkewnessValue.

property NonlinearAdaptiveRegion.StartTime: Ansys.Core.Units.Quantity | None

Gets or sets the StartTime.

property NonlinearAdaptiveRegion.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property NonlinearAdaptiveRegion.Suppressed: bool | None

Gets or sets the Suppressed.

property NonlinearAdaptiveRegion.TimeRange: Ansys.Mechanical.DataModel.Enums.NonlinearAdaptivityTimeRange | None

Gets or sets the TimeRange.

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

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

Method detail

NonlinearAdaptiveRegion.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

NonlinearAdaptiveRegion.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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

Creates a new parameter for a Property.

NonlinearAdaptiveRegion.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

NonlinearAdaptiveRegion.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

NonlinearAdaptiveRegion.GetAPIName(dispId: int) → str

Property name bound to dispId.

NonlinearAdaptiveRegion.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

NonlinearAdaptiveRegion.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

NonlinearAdaptiveRegion.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

NonlinearAdaptiveRegion.GetHashCode() → int

GetHashCode method.

NonlinearAdaptiveRegion.GetIconFile() → System.Byte

GetIconFile method.

NonlinearAdaptiveRegion.GetLifetimeService() → Any

GetLifetimeService method.

NonlinearAdaptiveRegion.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

NonlinearAdaptiveRegion.GetPath() → str

GetPath method.

NonlinearAdaptiveRegion.GetPropertyName(dispId: int) → str

GetPropertyName method.

NonlinearAdaptiveRegion.GetPropertyValue(name: str) → Any

GetPropertyValue method.

NonlinearAdaptiveRegion.GetType() → type

GetType method.

NonlinearAdaptiveRegion.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

NonlinearAdaptiveRegion.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

NonlinearAdaptiveRegion.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

NonlinearAdaptiveRegion.InitializeLifetimeService() → Any

InitializeLifetimeService method.

NonlinearAdaptiveRegion.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

NonlinearAdaptiveRegion.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

NonlinearAdaptiveRegion.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

NonlinearAdaptiveRegion.RemoveParameter(propName: str) → None

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

NonlinearAdaptiveRegion.ToString() → str

ToString method.