`NonlinearAdaptiveRegion`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.BoundaryConditions.NonlinearAdaptiveRegion#

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.
`CreateParameter`	Creates a new parameter for a Property.
`Delete`	Run the Delete action.
`Duplicate`	Creates a copy of the current DataModelObject.
`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

`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.
`Comments`	Gets the list of associated comments.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`Criterion`	Gets or sets the Criterion.
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`EndTime`	Gets or sets the EndTime.
`EnergyCoefficient`	Gets or sets the EnergyCoefficient.
`Figures`	Gets the list of associated figures.
`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.
`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.
`Option`	Gets or sets the Option.
`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.
`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.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.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.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.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

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.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.Option: Ansys.Mechanical.DataModel.Enums.NonlinearAdaptivityOptionType | None#: Gets or sets the Option.

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.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.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.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

NonlinearAdaptiveRegion.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Gets the parameter corresponding to the given property.

NonlinearAdaptiveRegion.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

NonlinearAdaptiveRegion.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#: Run the GroupSimilarObjects action.

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