`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#

Methods

`GetActivateAtLoadStep`	Returns whether fluid penetration pressure is active at the stepNumber.
`SetActivateAtLoadStep`	Sets whether fluid penetration pressure is active at the stepNumber.
`PromoteToNamedSelection`	Run the PromoteToNamedSelection action.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`ContactRegionSelection`	Gets or sets contact region.
`StartPointLocation`	Gets or sets the Start Point Location.
`InternalObject`	Gets the internal object. For advanced usage only.
`NumberOfSegments`	Gets or sets the NumberofSegments.
`Magnitude`	Gets the Magnitude.
`PenetrationCriterion`	Gets the PenetrationCriterion.
`GraphControlsXAxis`	Gets or sets the GraphControlsXAxis.
`GraphDisplaySelection`	Gets or sets the GraphDisplaySelection which determines which variable to display in graph, Pressure or Criterion.
`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.
`StartPointScopingType`	Gets or set the StartPointScopingType which determines scoping method for stating point.
`IndependentVariable`	Gets or set the IndependentVariable.
`UpdatePressureType`	Gets or sets the UpdatePressureType which determines when to update fluid pressure, each iteration or each substep.
`XYZFunctionCoordinateSystem`	Gets or sets the XYZFunctionCoordinateSystem.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Suppressed`	Gets or sets the Suppressed.
`SharedRefBody`	Gets or sets the SharedRefBody.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`ReadOnly`	Gets or sets the ReadOnly.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property FluidPenetrationPressure.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None: Gets or sets contact region.

property FluidPenetrationPressure.StartPointLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Start Point Location.

property FluidPenetrationPressure.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None: Gets the internal object. For advanced usage only.

property FluidPenetrationPressure.NumberOfSegments: System.Int32 | None: Gets or sets the NumberofSegments.

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

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

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.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.StartPointScopingType: Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure.StartPointScopingType | None: Gets or set the StartPointScopingType which determines scoping method for stating point.

property FluidPenetrationPressure.IndependentVariable: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None: Gets or set the IndependentVariable.

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.XYZFunctionCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the XYZFunctionCoordinateSystem.

property FluidPenetrationPressure.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property FluidPenetrationPressure.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property FluidPenetrationPressure.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None: Gets or sets the SharedRefBody.

property FluidPenetrationPressure.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property FluidPenetrationPressure.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property FluidPenetrationPressure.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property FluidPenetrationPressure.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property FluidPenetrationPressure.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property FluidPenetrationPressure.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property FluidPenetrationPressure.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property FluidPenetrationPressure.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

FluidPenetrationPressure.GetActivateAtLoadStep(stepNumber: System.UInt32) → System.Boolean: Returns whether fluid penetration pressure is active at the stepNumber.

FluidPenetrationPressure.SetActivateAtLoadStep(stepNumber: System.UInt32, bActive: System.Boolean) → System.Void: Sets whether fluid penetration pressure is active at the stepNumber.

FluidPenetrationPressure.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]: Run the PromoteToNamedSelection action.

FluidPenetrationPressure.Delete() → System.Void: Run the Delete action.

FluidPenetrationPressure.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

FluidPenetrationPressure.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

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: System.String) → 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.Activate() → System.Void: Activate the current object.

FluidPenetrationPressure.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

FluidPenetrationPressure.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

FluidPenetrationPressure.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

FluidPenetrationPressure.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

FluidPenetrationPressure.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

FluidPenetrationPressure.PropertyByAPIName(name: System.String) → 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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

FluidPenetrationPressure.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

FluidPenetrationPressure.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.