FluidPenetrationPressure#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.BoundaryConditions.FluidPenetrationPressure#

Bases: object

A class for fluid penetration pressure object in Mechanical. This load object is used to simulate surrounding fluid or air penetrating into the contact interface.

Users can apply this load to flexible-to-flexible or rigid-to-flexible contact pairs. This load object is available for static structural analysis.

Overview#

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

Returns whether fluid penetration pressure is active at the stepNumber.

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.

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 fluid penetration pressure is active at the stepNumber.

Children

Gets the list of children.

Comments

Gets the list of associated comments.

ContactRegionSelection

Gets or sets contact region.

DataModelObjectCategory

Gets the current DataModelObject's category.

Figures

Gets the list of associated figures.

GraphControlsXAxis

Gets or sets the GraphControlsXAxis.

GraphDisplaySelection

Gets or sets the GraphDisplaySelection which determines which variable to display in graph, Pressure or Criterion.

Images

Gets the list of associated images.

IndependentVariable

Gets or set the IndependentVariable.

InternalObject

Gets the internal object. For advanced usage only.

Magnitude

Gets the Magnitude.

NumberOfSegments

Gets or sets the NumberofSegments.

PenetrationCriterion

Gets the PenetrationCriterion.

PenetrationCriterionDefinedBy

Gets or sets the PenetrationCriterionDefinedBy which determines whether user define the criterion.

PenetrationPathType

Gets or sets the PenetrationPathType which determines whether path is history dependent or history independent.

Properties

Gets the list of properties for this object.

ReadOnly

Gets or sets the ReadOnly.

SharedRefBody

Gets or sets the SharedRefBody.

StartPointLocation

Gets or sets the Start Point Location.

StartPointScopingType

Gets or set the StartPointScopingType which determines scoping method for stating point.

Suppressed

Gets or sets the Suppressed.

UpdatePressureType

Gets or sets the UpdatePressureType which determines when to update fluid pressure, each iteration or each substep.

VisibleProperties

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

XYZFunctionCoordinateSystem

Gets or sets the XYZFunctionCoordinateSystem.

Property detail#

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

Gets the list of children.

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

Gets the list of associated comments.

property FluidPenetrationPressure.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None#

Gets or sets contact region.

property FluidPenetrationPressure.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property FluidPenetrationPressure.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None#

Gets or sets the GraphControlsXAxis.

property FluidPenetrationPressure.GraphDisplaySelection: Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure.GraphDisplay | None#

Gets or sets the GraphDisplaySelection which determines which variable to display in graph, Pressure or Criterion.

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

Gets the list of associated images.

property FluidPenetrationPressure.IndependentVariable: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None#

Gets or set the IndependentVariable.

property FluidPenetrationPressure.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None#

Gets the internal object. For advanced usage only.

property FluidPenetrationPressure.Magnitude: Ansys.ACT.Mechanical.Fields.Field | None#

Gets the Magnitude.

property FluidPenetrationPressure.NumberOfSegments: int | None#

Gets or sets the NumberofSegments.

property FluidPenetrationPressure.PenetrationCriterion: Ansys.ACT.Mechanical.Fields.Field | None#

Gets the PenetrationCriterion.

property FluidPenetrationPressure.PenetrationCriterionDefinedBy: Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure.CriterionDefinedByType | None#

Gets or sets the PenetrationCriterionDefinedBy which determines whether user define the criterion.

property FluidPenetrationPressure.PenetrationPathType: Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure.FluidPathType | None#

Gets or sets the PenetrationPathType which determines whether path is history dependent or history independent.

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

Gets the list of properties for this object.

property FluidPenetrationPressure.ReadOnly: bool | None#

Gets or sets the ReadOnly.

property FluidPenetrationPressure.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None#

Gets or sets the SharedRefBody.

property FluidPenetrationPressure.StartPointLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Start Point Location.

property FluidPenetrationPressure.StartPointScopingType: Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure.StartPointScopingType | None#

Gets or set the StartPointScopingType which determines scoping method for stating point.

property FluidPenetrationPressure.Suppressed: bool | None#

Gets or sets the Suppressed.

property FluidPenetrationPressure.UpdatePressureType: Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure.PenetrationPressureUpdateType | None#

Gets or sets the UpdatePressureType which determines when to update fluid pressure, each iteration or each substep.

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

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

property FluidPenetrationPressure.XYZFunctionCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the XYZFunctionCoordinateSystem.

Method detail#

FluidPenetrationPressure.Activate() None#

Activate the current object.

FluidPenetrationPressure.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

FluidPenetrationPressure.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

FluidPenetrationPressure.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.
FluidPenetrationPressure.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

FluidPenetrationPressure.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

FluidPenetrationPressure.Delete() None#

Run the Delete action.

FluidPenetrationPressure.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

FluidPenetrationPressure.GetActivateAtLoadStep(stepNumber: int) bool#

Returns whether fluid penetration pressure is active at the stepNumber.

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

Gets the list of children, filtered by type.

FluidPenetrationPressure.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

FluidPenetrationPressure.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

FluidPenetrationPressure.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

FluidPenetrationPressure.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#

Run the PromoteToNamedSelection action.

FluidPenetrationPressure.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.
FluidPenetrationPressure.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

FluidPenetrationPressure.RemoveParameter(propName: str) None#

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

FluidPenetrationPressure.SetActivateAtLoadStep(stepNumber: int, bActive: bool) None#

Sets whether fluid penetration pressure is active at the stepNumber.