`PhysicsRegion`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.PhysicsRegion#

Bases: object

Defines a PhysicsRegion.

Overview#

Methods

`SelectInvalidBodiesOnPhysicsRegion`	Run the SelectInvalidBodiesOnPhysicsRegion action to select bodies that are not valid.
`RenameBasedOnDefinition`	Run the RenameBasedOnDefinition action.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`InternalObject`	Gets the internal object. For advanced usage only.
`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.
`ReflectionCoefficient`	Gets or sets the ReflectionCoefficient.
`ReferencePressure`	Gets or sets the ReferencePressure.
`ReferenceStaticPressure`	Gets or sets the ReferenceStaticPressure.
`ArtificiallyMatchedLayers`	Gets or sets the ArtificiallyMatchedLayers.
`Electric`	Gets or sets the Electric.
`ElectrostaticForce`	Gets or sets the ElectrostaticForce.
`ElementMorphing`	Gets or sets the ElementMorphing.
`FluidBehavior`	Gets or sets the FluidBehavior.
`ReflectionCoefficientsType`	Gets or sets the ReflectionCoefficientsType.
`PMLOptions`	Gets or sets the PMLOptions.
`ThermalStrain`	Gets or sets the ThermalStrain.
`ThermoelasticDamping`	Gets or sets the ThermoelasticDamping.
`Acoustics`	Gets or sets the Acoustics.
`Piezoelectric`	Gets the Piezoelectric.
`EvanescentWaveAttenuation`	Gets or sets the EvanescentWaveAttenuation.
`Structural`	Gets or sets the Structural.
`Suppressed`	Gets or sets the Suppressed.
`Thermal`	Gets or sets the Thermal.
`PMLElementCoordinateSystem`	Gets or sets the PMLElementCoordinateSystem.
`Location`	Gets or sets the Location.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property PhysicsRegion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSPhysicsRegionAuto | None: Gets the internal object. For advanced usage only.

property PhysicsRegion.ReflectionCoefficientInNegativeXDirection: System.Double | None: Gets or sets the ReflectionCoefficientInNegativeXDirection.

property PhysicsRegion.ReflectionCoefficientInNegativeYDirection: System.Double | None: Gets or sets the ReflectionCoefficientInNegativeYDirection.

property PhysicsRegion.ReflectionCoefficientInNegativeZDirection: System.Double | None: Gets or sets the ReflectionCoefficientInNegativeZDirection.

property PhysicsRegion.ReflectionCoefficientInPositiveXDirection: System.Double | None: Gets or sets the ReflectionCoefficientInPositiveXDirection.

property PhysicsRegion.ReflectionCoefficientInPositiveYDirection: System.Double | None: Gets or sets the ReflectionCoefficientInPositiveYDirection.

property PhysicsRegion.ReflectionCoefficientInPositiveZDirection: System.Double | None: Gets or sets the ReflectionCoefficientInPositiveZDirection.

property PhysicsRegion.ReflectionCoefficient: System.Double | None: Gets or sets the ReflectionCoefficient.

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

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

property PhysicsRegion.ReflectionCoefficientsType: Ansys.Mechanical.DataModel.Enums.ReflectionCoefficientsType | None: Gets or sets the ReflectionCoefficientsType.

property PhysicsRegion.PMLOptions: Ansys.Mechanical.DataModel.Enums.PMLOptions | None: Gets or sets the PMLOptions.

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.Acoustics: System.Boolean | None: Gets or sets the Acoustics.

property PhysicsRegion.Piezoelectric: System.Boolean | None: Gets the Piezoelectric.

property PhysicsRegion.EvanescentWaveAttenuation: System.Boolean | None: Gets or sets the EvanescentWaveAttenuation.

property PhysicsRegion.Structural: System.Boolean | None: Gets or sets the Structural.

property PhysicsRegion.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property PhysicsRegion.Thermal: System.Boolean | None: Gets or sets the Thermal.

property PhysicsRegion.PMLElementCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the PMLElementCoordinateSystem.

property PhysicsRegion.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property PhysicsRegion.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property PhysicsRegion.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property PhysicsRegion.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property PhysicsRegion.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property PhysicsRegion.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property PhysicsRegion.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property PhysicsRegion.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property PhysicsRegion.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

PhysicsRegion.SelectInvalidBodiesOnPhysicsRegion() → System.Void: Run the SelectInvalidBodiesOnPhysicsRegion action to select bodies that are not valid.

PhysicsRegion.RenameBasedOnDefinition() → System.Void: Run the RenameBasedOnDefinition action.

PhysicsRegion.Delete() → System.Void: Run the Delete action.

PhysicsRegion.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

PhysicsRegion.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

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: System.String) → 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.Activate() → System.Void: Activate the current object.

PhysicsRegion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

PhysicsRegion.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

PhysicsRegion.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

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

PhysicsRegion.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

PhysicsRegion.PropertyByAPIName(name: System.String) → 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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

PhysicsRegion.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

PhysicsRegion.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.