PhysicsRegion

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

Bases: object

Defines a PhysicsRegion.

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.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.
SelectInvalidBodiesOnPhysicsRegion	Run the SelectInvalidBodiesOnPhysicsRegion action to select bodies that are not valid.
ToString	ToString method.

Properties

Acoustics	Gets or sets the Acoustics.
ArtificiallyMatchedLayers	Gets or sets the ArtificiallyMatchedLayers.
AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
Electric	Gets or sets the Electric.
ElectrostaticForce	Gets or sets the ElectrostaticForce.
ElementMorphing	Gets or sets the ElementMorphing.
EvanescentWaveAttenuation	Gets or sets the EvanescentWaveAttenuation.
Figures	Gets the list of associated figures.
FluidBehavior	Gets or sets the FluidBehavior.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
PMLElementCoordinateSystem	Gets or sets the PMLElementCoordinateSystem.
PMLOptions	Gets or sets the PMLOptions.
Parent	Parent property.
Piezoelectric	Gets the Piezoelectric.
Properties	Gets the list of properties for this object.
ReferencePressure	Gets or sets the ReferencePressure.
ReferenceStaticPressure	Gets or sets the ReferenceStaticPressure.
ReflectionCoefficient	Gets or sets the ReflectionCoefficient.
ReflectionCoefficientInNegativeXDirection	Gets or sets the ReflectionCoefficientInNegativeXDirection.
ReflectionCoefficientInNegativeYDirection	Gets or sets the ReflectionCoefficientInNegativeYDirection.
ReflectionCoefficientInNegativeZDirection	Gets or sets the ReflectionCoefficientInNegativeZDirection.
ReflectionCoefficientInPositiveXDirection	Gets or sets the ReflectionCoefficientInPositiveXDirection.
ReflectionCoefficientInPositiveYDirection	Gets or sets the ReflectionCoefficientInPositiveYDirection.
ReflectionCoefficientInPositiveZDirection	Gets or sets the ReflectionCoefficientInPositiveZDirection.
ReflectionCoefficientsType	Gets or sets the ReflectionCoefficientsType.
State	State property.
Structural	Gets or sets the Structural.
Suppressed	Gets or sets the Suppressed.
Thermal	Gets or sets the Thermal.
ThermalStrain	Gets or sets the ThermalStrain.
ThermoelasticDamping	Gets or sets the ThermoelasticDamping.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property PhysicsRegion.Acoustics: bool | None

Gets or sets the Acoustics.

property PhysicsRegion.ArtificiallyMatchedLayers: Ansys.Mechanical.DataModel.Enums.ArtificiallyMatchedLayers | None

Gets or sets the ArtificiallyMatchedLayers.

property PhysicsRegion.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property PhysicsRegion.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property PhysicsRegion.Electric: Ansys.Mechanical.DataModel.Enums.ElectricType | None

Gets or sets the Electric.

property PhysicsRegion.ElectrostaticForce: Ansys.Mechanical.DataModel.Enums.ElectrostaticForce | None

Gets or sets the ElectrostaticForce.

property PhysicsRegion.ElementMorphing: Ansys.Mechanical.DataModel.Enums.ElementMorphingType | None

Gets or sets the ElementMorphing.

property PhysicsRegion.EvanescentWaveAttenuation: bool | None

Gets or sets the EvanescentWaveAttenuation.

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

Gets the list of associated figures.

property PhysicsRegion.FluidBehavior: Ansys.Mechanical.DataModel.Enums.FluidBehavior | None

Gets or sets the FluidBehavior.

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

GroupingFolder property.

property PhysicsRegion.IconName: str | None

IconName property.

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

Gets the list of associated images.

property PhysicsRegion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSPhysicsRegionAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property PhysicsRegion.Name: str | None

Name property.

property PhysicsRegion.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property PhysicsRegion.PMLElementCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the PMLElementCoordinateSystem.

property PhysicsRegion.PMLOptions: Ansys.Mechanical.DataModel.Enums.PMLOptions | None

Gets or sets the PMLOptions.

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

Parent property.

property PhysicsRegion.Piezoelectric: bool | None

Gets the Piezoelectric.

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

Gets the list of properties for this object.

property PhysicsRegion.ReferencePressure: Ansys.Core.Units.Quantity | None

Gets or sets the ReferencePressure.

property PhysicsRegion.ReferenceStaticPressure: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceStaticPressure.

property PhysicsRegion.ReflectionCoefficient: float | None

Gets or sets the ReflectionCoefficient.

property PhysicsRegion.ReflectionCoefficientInNegativeXDirection: float | None

Gets or sets the ReflectionCoefficientInNegativeXDirection.

property PhysicsRegion.ReflectionCoefficientInNegativeYDirection: float | None

Gets or sets the ReflectionCoefficientInNegativeYDirection.

property PhysicsRegion.ReflectionCoefficientInNegativeZDirection: float | None

Gets or sets the ReflectionCoefficientInNegativeZDirection.

property PhysicsRegion.ReflectionCoefficientInPositiveXDirection: float | None

Gets or sets the ReflectionCoefficientInPositiveXDirection.

property PhysicsRegion.ReflectionCoefficientInPositiveYDirection: float | None

Gets or sets the ReflectionCoefficientInPositiveYDirection.

property PhysicsRegion.ReflectionCoefficientInPositiveZDirection: float | None

Gets or sets the ReflectionCoefficientInPositiveZDirection.

property PhysicsRegion.ReflectionCoefficientsType: Ansys.Mechanical.DataModel.Enums.ReflectionCoefficientsType | None

Gets or sets the ReflectionCoefficientsType.

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

State property.

property PhysicsRegion.Structural: bool | None

Gets or sets the Structural.

property PhysicsRegion.Suppressed: bool | None

Gets or sets the Suppressed.

property PhysicsRegion.Thermal: bool | None

Gets or sets the Thermal.

property PhysicsRegion.ThermalStrain: Ansys.Mechanical.DataModel.Enums.ThermalStrainType | None

Gets or sets the ThermalStrain.

property PhysicsRegion.ThermoelasticDamping: Ansys.Mechanical.DataModel.Enums.ThermoelasticDampingType | None

Gets or sets the ThermoelasticDamping.

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

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

Method detail

PhysicsRegion.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

PhysicsRegion.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

PhysicsRegion.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

PhysicsRegion.GetHashCode() → int

GetHashCode method.

PhysicsRegion.GetIconFile() → System.Byte

GetIconFile method.

PhysicsRegion.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

PhysicsRegion.GetPath() → str

GetPath method.

PhysicsRegion.GetPropertyName(dispId: int) → str

GetPropertyName method.

PhysicsRegion.GetPropertyValue(name: str) → Any

GetPropertyValue method.

PhysicsRegion.GetType() → type

GetType method.

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

GetVisibleProperties method.

PhysicsRegion.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

PhysicsRegion.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

PhysicsRegion.InitializeLifetimeService() → Any

InitializeLifetimeService method.

PhysicsRegion.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

PhysicsRegion.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

PhysicsRegion.RemoveParameter(propName: str) → None

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

PhysicsRegion.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

PhysicsRegion.SelectInvalidBodiesOnPhysicsRegion() → None

Run the SelectInvalidBodiesOnPhysicsRegion action to select bodies that are not valid.

PhysicsRegion.ToString() → str

ToString method.