.. vale off :class:`FluidPenetrationPressure` ================================= .. py:class:: ansys.mechanical.stubs.Ansys.ACT.Automation.Mechanical.BoundaryConditions.FluidPenetrationPressure Bases: :py:obj:`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. .. !! processed by numpydoc !! .. py:currentmodule:: FluidPenetrationPressure Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~GetActivateAtLoadStep` - Gets whether the fluid penetration pressure is active at the specified load step. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PromoteToNamedSelection` - Run the PromoteToNamedSelection action. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. * - :py:attr:`~SetActivateAtLoadStep` - Sets whether the fluid penetration pressure is active at the specified load step. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~ContactRegionSelection` - Gets or sets contact region. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~GraphControlsXAxis` - Gets or sets the GraphControlsXAxis. * - :py:attr:`~GraphDisplaySelection` - Gets or sets the GraphDisplaySelection which determines which variable to display in graph, Pressure or Criterion. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~IndependentVariable` - Gets or set the IndependentVariable. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Magnitude` - Gets the Magnitude. * - :py:attr:`~NumberOfSegments` - Gets or sets the NumberofSegments. * - :py:attr:`~PenetrationCriterion` - Gets the PenetrationCriterion. * - :py:attr:`~PenetrationCriterionDefinedBy` - Gets or sets the PenetrationCriterionDefinedBy which determines whether user define the criterion. * - :py:attr:`~PenetrationPathType` - Gets or sets the PenetrationPathType which determines whether path is history dependent or history independent. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~ReadOnly` - Gets or sets the ReadOnly. * - :py:attr:`~SharedRefBody` - Gets or sets the SharedRefBody. * - :py:attr:`~StartPointLocation` - Gets or sets the Start Point Location. * - :py:attr:`~StartPointScopingType` - Gets or set the StartPointScopingType which determines scoping method for stating point. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~UpdatePressureType` - Gets or sets the UpdatePressureType which determines when to update fluid pressure, each iteration or each substep. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. * - :py:attr:`~XYZFunctionCoordinateSystem` - Gets or sets the XYZFunctionCoordinateSystem. Property detail --------------- .. py:property:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: ContactRegionSelection :type: Optional[Ansys.ACT.Automation.Mechanical.Connections.ContactRegion] Gets or sets contact region. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: Figures :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: GraphControlsXAxis :type: Optional[Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType] Gets or sets the GraphControlsXAxis. .. !! processed by numpydoc !! .. py:property:: GraphDisplaySelection :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure.GraphDisplay] Gets or sets the GraphDisplaySelection which determines which variable to display in graph, Pressure or Criterion. .. !! processed by numpydoc !! .. py:property:: Images :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: IndependentVariable :type: Optional[Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType] Gets or set the IndependentVariable. .. !! processed by numpydoc !! .. py:property:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Magnitude :type: Optional[Ansys.ACT.Mechanical.Fields.Field] Gets the Magnitude. .. !! processed by numpydoc !! .. py:property:: NumberOfSegments :type: Optional[int] Gets or sets the NumberofSegments. .. !! processed by numpydoc !! .. py:property:: PenetrationCriterion :type: Optional[Ansys.ACT.Mechanical.Fields.Field] Gets the PenetrationCriterion. .. !! processed by numpydoc !! .. py:property:: PenetrationCriterionDefinedBy :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure.CriterionDefinedByType] Gets or sets the PenetrationCriterionDefinedBy which determines whether user define the criterion. .. !! processed by numpydoc !! .. py:property:: PenetrationPathType :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure.FluidPathType] Gets or sets the PenetrationPathType which determines whether path is history dependent or history independent. .. !! processed by numpydoc !! .. py:property:: Properties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: ReadOnly :type: Optional[bool] Gets or sets the ReadOnly. .. !! processed by numpydoc !! .. py:property:: SharedRefBody :type: Optional[Ansys.ACT.Automation.Mechanical.Body] Gets or sets the SharedRefBody. .. !! processed by numpydoc !! .. py:property:: StartPointLocation :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Start Point Location. .. !! processed by numpydoc !! .. py:property:: StartPointScopingType :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure.StartPointScopingType] Gets or set the StartPointScopingType which determines scoping method for stating point. .. !! processed by numpydoc !! .. py:property:: Suppressed :type: Optional[bool] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: UpdatePressureType :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure.PenetrationPressureUpdateType] Gets or sets the UpdatePressureType which determines when to update fluid pressure, each iteration or each substep. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! .. py:property:: XYZFunctionCoordinateSystem :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the XYZFunctionCoordinateSystem. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: Activate() -> None Activate the current object. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: str) -> Ansys.ACT.Automation.Mechanical.Image .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> None Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: Delete() -> None Run the Delete action. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: GetActivateAtLoadStep(stepNumber: int) -> bool Gets whether the fluid penetration pressure is active at the specified load step. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: bool, children: List[ChildrenType]) -> List[ChildrenType] Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> None Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PromoteToNamedSelection() -> Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection] Run the PromoteToNamedSelection action. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: str) -> Ansys.ACT.Automation.Mechanical.Property .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: str) -> Ansys.ACT.Automation.Mechanical.Property Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: str) -> None Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: SetActivateAtLoadStep(stepNumber: int, bActive: bool) -> None Sets whether the fluid penetration pressure is active at the specified load step. .. !! processed by numpydoc !! .. vale on