FluidPenetrationPressure

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.BoundaryConditions.FluidPenetrationPressure(internalObject: Any)

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

Methods

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetActivateAtLoadStep	Gets whether the fluid penetration pressure is active at the specified load step.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetQuantityName	GetQuantityName method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
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 fluid penetration pressure is active at the specified load step.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
IndependentVariable	Gets or set the IndependentVariable.
InternalObject	Gets the internal object. For advanced usage only.
Magnitude	Gets the Magnitude.
Name	Name property.
NumberOfSegments	Gets or sets the NumberofSegments.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
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.
State	State property.
Suppressed	Gets or sets the Suppressed.
TransferableObjectId	TransferableObjectId property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property FluidPenetrationPressure.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property FluidPenetrationPressure.IconName: str | None

IconName property.

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

Gets the list of associated images.

property FluidPenetrationPressure.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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.Name: str | None

Name property.

property FluidPenetrationPressure.NumberOfSegments: int | None

Gets or sets the NumberofSegments.

property FluidPenetrationPressure.ObjectId: int | None

ObjectId property.

property FluidPenetrationPressure.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property FluidPenetrationPressure.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property FluidPenetrationPressure.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property FluidPenetrationPressure.Suppressed: bool | None

Gets or sets the Suppressed.

property FluidPenetrationPressure.TransferableObjectId: str | None

TransferableObjectId property.

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.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

FluidPenetrationPressure.GetAPIName(dispId: int) → str

Property name bound to dispId.

FluidPenetrationPressure.GetActivateAtLoadStep(stepNumber: int) → bool

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

FluidPenetrationPressure.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

FluidPenetrationPressure.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

FluidPenetrationPressure.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

FluidPenetrationPressure.GetHashCode() → int

GetHashCode method.

FluidPenetrationPressure.GetIconFile() → System.Byte

GetIconFile method.

FluidPenetrationPressure.GetLifetimeService() → Any

GetLifetimeService method.

FluidPenetrationPressure.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

FluidPenetrationPressure.GetPath() → str

GetPath method.

FluidPenetrationPressure.GetPropertyName(dispId: int) → str

GetPropertyName method.

FluidPenetrationPressure.GetPropertyValue(name: str) → Any

GetPropertyValue method.

FluidPenetrationPressure.GetQuantityName() → str

GetQuantityName method.

FluidPenetrationPressure.GetType() → type

GetType method.

FluidPenetrationPressure.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

FluidPenetrationPressure.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

FluidPenetrationPressure.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

FluidPenetrationPressure.InitializeLifetimeService() → Any

InitializeLifetimeService method.

FluidPenetrationPressure.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

FluidPenetrationPressure.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

FluidPenetrationPressure.ToString() → str

ToString method.