PhysicsRegion
Last update: 14.01.2025
PhysicsRegion
class Ansys.ACT.Automation.Mechanical.PhysicsRegion
Bases: object
Defines a PhysicsRegion.
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. |
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. |
RenameBasedOnDefinition |
Run the RenameBasedOnDefinition action. |
SelectInvalidBodiesOnPhysicsRegion |
Run the SelectInvalidBodiesOnPhysicsRegion action to select bodies that are not valid. |
Properties
Name | Description |
---|---|
Acoustics |
Gets or sets the Acoustics. |
ArtificiallyMatchedLayers |
Gets or sets the ArtificiallyMatchedLayers. |
Children |
Gets the list of children. |
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. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
Location |
Gets or sets the Location. |
PMLElementCoordinateSystem |
Gets or sets the PMLElementCoordinateSystem. |
PMLOptions |
Gets or sets the PMLOptions. |
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. |
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.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
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.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.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.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.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()
Activate the current object.
PhysicsRegion.AddComment()
Creates a new child Comment.
PhysicsRegion.AddFigure()
Creates a new child Figure.
PhysicsRegion.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.
PhysicsRegion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
PhysicsRegion.CreateParameter(propName: str)
Creates a new parameter for a Property.
PhysicsRegion.Delete()
Run the Delete action.
PhysicsRegion.Duplicate()
Creates a copy of the current DataModelObject.
PhysicsRegion.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
PhysicsRegion.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
PhysicsRegion.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
PhysicsRegion.GroupSimilarObjects()
Run the GroupSimilarObjects action.
PhysicsRegion.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.
PhysicsRegion.PropertyByName(name: str)
Get a property by its unique name.
PhysicsRegion.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.
PhysicsRegion.RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.
PhysicsRegion.SelectInvalidBodiesOnPhysicsRegion()
Run the SelectInvalidBodiesOnPhysicsRegion action to select bodies that are not valid.