Skip to main content

Mechanical scripting interface

HydrostaticPressure

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.HydrostaticPressure

Bases: object

Defines a HydrostaticPressure.

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.
GetActivateAtLoadStep Gets whether the hydrostatic 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 Removes the parameter from the parameter set corresponding to the given property.
SetActivateAtLoadStep Sets whether the hydrostatic pressure is active at the specified load step.
SetComponentActivateAtLoadStep SetComponentActivateAtLoadStep method.

Properties

Name Description
AppliedBy Gets or sets the AppliedBy.
Children Gets the list of children.
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the CoordinateSystem.
DataModelObjectCategory Gets the current DataModelObject’s category.
DefineBy Gets or sets the DefineBy.
Direction Gets or sets the Direction.
Figures Gets the list of associated figures.
FluidDensity Gets or sets the FluidDensity.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
Magnitude Gets the Magnitude.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
SharedRefBody Gets or sets the SharedRefBody.
ShellFace Gets or sets the ShellFace.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.
XComponent Gets the XComponent.
XCoordinate Gets or sets the XCoordinate.
YComponent Gets the YComponent.
YCoordinate Gets or sets the YCoordinate.
ZComponent Gets the ZComponent.
ZCoordinate Gets or sets the ZCoordinate.

Property detail

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

Gets or sets the AppliedBy.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DefineBy.

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

Gets or sets the Direction.

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

Gets the list of associated figures.

property HydrostaticPressure.FluidDensity : Ansys.Core.Units.Quantity | None

Gets or sets the FluidDensity.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property HydrostaticPressure.Magnitude : Ansys.ACT.Mechanical.Fields.Field | None

Gets the Magnitude.

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

Gets the list of properties for this object.

property HydrostaticPressure.ReadOnly : bool | None

Gets or sets the ReadOnly.

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

Gets or sets the SharedRefBody.

property HydrostaticPressure.ShellFace : Ansys.Mechanical.DataModel.Enums.ShellFaceType | None

Gets or sets the ShellFace.

property HydrostaticPressure.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

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

Gets the XComponent.

property HydrostaticPressure.XCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the XCoordinate.

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

Gets the YComponent.

property HydrostaticPressure.YCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the YCoordinate.

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

Gets the ZComponent.

property HydrostaticPressure.ZCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the ZCoordinate.

Method detail

HydrostaticPressure.Activate()

Activate the current object.

HydrostaticPressure.AddComment()

Creates a new child Comment.

HydrostaticPressure.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

HydrostaticPressure.CreateParameter(propName: str)

Creates a new parameter for a Property.

HydrostaticPressure.Delete()

Run the Delete action.

HydrostaticPressure.Duplicate()

Creates a copy of the current DataModelObject.

HydrostaticPressure.GetActivateAtLoadStep(stepNumber: int)

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

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

Gets the list of children, filtered by type.

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

GetComponentActivateAtLoadStep method.

HydrostaticPressure.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

HydrostaticPressure.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

HydrostaticPressure.GroupSimilarObjects()

Run the GroupSimilarObjects action.

HydrostaticPressure.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

HydrostaticPressure.PropertyByName(name: str)

Get a property by its unique name.

HydrostaticPressure.RemoveParameter(propName: str)

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

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

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

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

SetComponentActivateAtLoadStep method.