Skip to main content

Mechanical scripting interface

Pressure

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.Pressure

Bases: object

Defines a Pressure.

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 CreateParameter method.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
GetActivateAtLoadStep Gets whether the pressure is active at the specified load step.
GetChildren Gets the list of children, filtered by type.
GetComponentActivateAtLoadStep GetComponentActivateAtLoadStep method.
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
PromoteToNamedSelection Run the PromoteToNamedSelection action.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
RemoveParameter RemoveParameter method.
SetActivateAtLoadStep Sets whether the pressure is active at the specified load step.
SetComponentActivateAtLoadStep SetComponentActivateAtLoadStep method.

Properties

Name Description
AppliedBy Gets or sets the AppliedBy.
ApplyTo Gets or Sets the Pressure ApplyTo type.
Children Gets the list of children.
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the CoordinateSystem.
CrackGrowth Gets or Sets the SMART CrackGrowthSelection.
DataModelObjectCategory Gets the current DataModelObject’s category.
DefineBy Gets or sets the DefineBy.
Direction Gets or sets the Direction.
DynamicRelaxationBehavior Gets or sets the DynamicRelaxationBehavior.
Figures Gets the list of associated figures.
GraphControlsXAxis Gets or sets the GraphControlsXAxis.
HarmonicIndex Gets or sets the HarmonicIndex.
Images Gets the list of associated images.
IndependentVariable Gets or sets the IndependentVariable.
InternalObject InternalObject property.
LoadVectorAssignment Gets or sets the LoadVectorAssignment.
LoadVectorNumber Gets or sets the LoadVectorNumber.
LoadedArea Gets or sets the LoadedArea.
Location Gets or sets the Location.
Magnitude Gets or sets the Magnitude.
MagnitudeImag Gets the MagnitudeImag.
NonCyclicLoadingType Gets or sets the NonCyclicLoadingType.
NumberOfSegments Gets or sets the NumberOfSegments.
PhaseAngle Gets the PhaseAngle.
Properties Gets the list of properties for this object.
RangeMaximum Gets or sets the RangeMaximum.
RangeMinimum Gets or sets the RangeMinimum.
ReadOnly Gets or sets the ReadOnly.
ScopingMethod Gets or sets the ScopingMethod.
SectorNumber Gets or sets the SectorNumber.
SharedRefBody Gets or sets the SharedRefBody.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.
XComponent Gets the XComponent.
XComponentImag Gets the XComponentImag.
XPhaseAngle Gets the XPhaseAngle.
XYZFunctionCoordinateSystem Gets or sets the XYZFunctionCoordinateSystem.
YComponent Gets the YComponent.
YComponentImag Gets the YComponentImag.
YPhaseAngle Gets the YPhaseAngle.
ZComponent Gets the ZComponent.
ZComponentImag Gets the ZComponentImag.
ZPhaseAngle Gets the ZPhaseAngle.

Property detail

property Pressure.AppliedBy : Ansys.Mechanical.DataModel.Enums.LoadAppliedBy | None

Gets or sets the AppliedBy.

property Pressure.ApplyTo : Ansys.Mechanical.DataModel.Enums.CrackSurfaceLoadApplyTo | None

Gets or Sets the Pressure ApplyTo type.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

property Pressure.CrackGrowth : Ansys.ACT.Automation.Mechanical.SMARTCrackGrowth | None

Gets or Sets the SMART CrackGrowthSelection.

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

Gets the current DataModelObject’s category.

property Pressure.DefineBy : Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None

Gets or sets the DefineBy.

property Pressure.Direction : Ansys.ACT.Math.Vector3D | None

Gets or sets the Direction.

property Pressure.DynamicRelaxationBehavior : Ansys.Mechanical.DataModel.Enums.DynamicRelaxationBehaviorType | None

Gets or sets the DynamicRelaxationBehavior.

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

Gets the list of associated figures.

property Pressure.GraphControlsXAxis : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the GraphControlsXAxis.

property Pressure.HarmonicIndex : Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the HarmonicIndex.

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

Gets the list of associated images.

property Pressure.IndependentVariable : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the IndependentVariable.

property Pressure.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None

InternalObject property.

property Pressure.LoadVectorAssignment : Ansys.Mechanical.DataModel.Enums.LoadVectorAssignment | None

Gets or sets the LoadVectorAssignment.

property Pressure.LoadVectorNumber : int | None

Gets or sets the LoadVectorNumber.

property Pressure.LoadedArea : Ansys.Mechanical.DataModel.Enums.LoadedArea | None

Gets or sets the LoadedArea.

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

Gets or sets the Location.

property Pressure.Magnitude : Any | None

Gets or sets the Magnitude.

property Pressure.MagnitudeImag : Ansys.ACT.Mechanical.Fields.Field | None

Gets the MagnitudeImag.

property Pressure.NonCyclicLoadingType : Ansys.Mechanical.DataModel.Enums.NonCyclicLoadingType | None

Gets or sets the NonCyclicLoadingType.

property Pressure.NumberOfSegments : int | None

Gets or sets the NumberOfSegments.

property Pressure.PhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None

Gets the PhaseAngle.

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

Gets the list of properties for this object.

property Pressure.RangeMaximum : Ansys.Core.Units.Quantity | None

Gets or sets the RangeMaximum.

property Pressure.RangeMinimum : Ansys.Core.Units.Quantity | None

Gets or sets the RangeMinimum.

property Pressure.ReadOnly : bool | None

Gets or sets the ReadOnly.

property Pressure.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property Pressure.SectorNumber : Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the SectorNumber.

property Pressure.SharedRefBody : Ansys.ACT.Automation.Mechanical.Body | None

Gets or sets the SharedRefBody.

property Pressure.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

property Pressure.XComponent : Ansys.ACT.Mechanical.Fields.Field | None

Gets the XComponent.

property Pressure.XComponentImag : Ansys.ACT.Mechanical.Fields.Field | None

Gets the XComponentImag.

property Pressure.XPhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None

Gets the XPhaseAngle.

property Pressure.XYZFunctionCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the XYZFunctionCoordinateSystem.

property Pressure.YComponent : Ansys.ACT.Mechanical.Fields.Field | None

Gets the YComponent.

property Pressure.YComponentImag : Ansys.ACT.Mechanical.Fields.Field | None

Gets the YComponentImag.

property Pressure.YPhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None

Gets the YPhaseAngle.

property Pressure.ZComponent : Ansys.ACT.Mechanical.Fields.Field | None

Gets the ZComponent.

property Pressure.ZComponentImag : Ansys.ACT.Mechanical.Fields.Field | None

Gets the ZComponentImag.

property Pressure.ZPhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None

Gets the ZPhaseAngle.

Method detail

Pressure.Activate()

Activate the current object.

Pressure.AddComment()

Creates a new child Comment.

Pressure.AddFigure()

Creates a new child Figure.

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

Pressure.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

Pressure.CreateParameter(propName: str)

CreateParameter method.

Pressure.Delete()

Run the Delete action.

Pressure.Duplicate()

Creates a copy of the current DataModelObject.

Pressure.GetActivateAtLoadStep(stepNumber: int)

Gets whether the pressure is active at the specified load step.

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

Gets the list of children, filtered by type.

Pressure.GetComponentActivateAtLoadStep(component: str, stepNumber: int)

GetComponentActivateAtLoadStep method.

Pressure.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

Pressure.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

Pressure.GroupSimilarObjects()

Run the GroupSimilarObjects action.

Pressure.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

Pressure.PropertyByName(name: str)

Get a property by its unique name.

Pressure.RemoveParameter(propName: str)

RemoveParameter method.

Pressure.SetActivateAtLoadStep(stepNumber: int, bActive: bool)

Sets whether the pressure is active at the specified load step.

Pressure.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool)

SetComponentActivateAtLoadStep method.