InitialCondition

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.InitialCondition

Bases: object

Defines a InitialCondition.

Overview

Methods

Activate	Activate the current object.
AddCommandSnippet	Creates a new child CommandSnippet.
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.
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.
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.

Properties

Children	Gets the list of children.
Comments	Gets the list of associated comments.
ContactStatus	Gets or sets the ContactStatus.
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.
DropDirection	Gets or sets the DropDirection.
DropHeight	Gets or sets the DropHeight.
DropTestDefineBy	Gets or sets the DropTestDefineBy.
ExplicitPreStressTime	Gets or sets the ExplicitPreStressTime.
Figures	Gets the list of associated figures.
Images	Gets the list of associated images.
ImpactVelocity	Gets or sets the ImpactVelocity.
InitialEnvironment	Gets or sets the InitialEnvironment.
InitialTemperature	Gets or sets the InitialTemperature.
InitialTemperatureValue	Gets or sets the InitialTemperatureValue.
InputType	Gets or sets the InputType.
InternalObject	Gets the internal object. For advanced usage only.
LoadControl	Gets or sets the LoadControl.
Location	Gets or sets the Location.
ModalEnvironmentHarmonicIC	Gets or sets the ModalEnvironmentHarmonicIC.
ModalEnvironmentPSDIC	Gets or sets the ModalEnvironmentPSDIC.
ModalEnvironmentRSIC	Gets or sets the ModalEnvironmentRSIC.
ModalEnvironmentTransientMSUPIC	Gets or sets the ModalEnvironmentTransientMSUPIC.
ModalICEnvironment	Gets or sets the ModalICEnvironment.
Mode	Gets or sets the Mode.
NewtonRaphsonOption	Gets the NewtonRaphsonOption.
PreStressDefineBy	Gets or sets the PreStressDefineBy.
PreStressEnvironmentHarmonicIC	Gets or sets the PreStressEnvironmentHarmonicIC.
PreStressEnvironmentHarmonicMSUPModal	Gets the PreStressEnvironmentHarmonicMSUPModal.
PreStressEnvironmentModalIC	Gets or sets the PreStressEnvironmentModalIC.
PreStressEnvironmentTransientIC	Gets or sets the PreStressEnvironmentTransientIC.
PreStressEnvironmentTransientMSUPModal	Gets the PreStressEnvironmentTransientMSUPModal.
PreStressICEnvironment	Gets or sets the PreStressICEnvironment.
PreStressLoadStep	Gets or sets the PreStressLoadStep.
PreStressTime	Gets or sets the PreStressTime.
PressureInitialization	Gets or sets the PressureInitialization.
Properties	Gets the list of properties for this object.
ReferenceTemperature	Gets or sets the ReferenceTemperature.
ReportedLoadStep	Gets the ReportedLoadStep.
ReportedSubStep	Gets the ReportedSubStep.
ReportedTime	Gets the ReportedTime.
Suppressed	Gets or sets the Suppressed.
Time	Gets or sets the Time.
TimeStepFactor	Gets or sets the TimeStepFactor.
TotalMagnitude	Gets or sets the Magnitude.
VisibleProperties	Gets the list of properties that are visible for this object.
XComponent	Gets or sets the XComponent.
YComponent	Gets or sets the YComponent.
ZComponent	Gets or sets the ZComponent.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

property InitialCondition.ContactStatus: Ansys.Mechanical.DataModel.Enums.PreStressContactStatus | None

Gets or sets the ContactStatus.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject's category.

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

Gets or sets the DefineBy.

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

Gets or sets the Direction.

property InitialCondition.DropDirection: Ansys.Mechanical.DataModel.Enums.DropDirection | None

Gets or sets the DropDirection.

property InitialCondition.DropHeight: Ansys.Core.Units.Quantity | None

Gets or sets the DropHeight.

property InitialCondition.DropTestDefineBy: Ansys.Mechanical.DataModel.Enums.DropTestDefineBy | None

Gets or sets the DropTestDefineBy.

property InitialCondition.ExplicitPreStressTime: Ansys.Core.Units.Quantity | None

Gets or sets the ExplicitPreStressTime.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property InitialCondition.ImpactVelocity: Ansys.Core.Units.Quantity | None

Gets or sets the ImpactVelocity.

property InitialCondition.InitialEnvironment: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the InitialEnvironment.

property InitialCondition.InitialTemperature: Ansys.Mechanical.DataModel.Enums.InitialTemperatureType | None

Gets or sets the InitialTemperature.

property InitialCondition.InitialTemperatureValue: Ansys.Core.Units.Quantity | None

Gets or sets the InitialTemperatureValue.

property InitialCondition.InputType: Ansys.Mechanical.DataModel.Enums.InitialConditionsType | None

Gets or sets the InputType.

property InitialCondition.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSInitialConditionsAuto | None

Gets the internal object. For advanced usage only.

property InitialCondition.LoadControl: Ansys.Mechanical.DataModel.Enums.PreStressLoadControl | None

Gets or sets the LoadControl.

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

Gets or sets the Location.

property InitialCondition.ModalEnvironmentHarmonicIC: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the ModalEnvironmentHarmonicIC.

property InitialCondition.ModalEnvironmentPSDIC: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the ModalEnvironmentPSDIC.

property InitialCondition.ModalEnvironmentRSIC: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the ModalEnvironmentRSIC.

property InitialCondition.ModalEnvironmentTransientMSUPIC: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the ModalEnvironmentTransientMSUPIC.

property InitialCondition.ModalICEnvironment: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the ModalICEnvironment.

property InitialCondition.Mode: Ansys.Mechanical.DataModel.Enums.PreStressMode | None

Gets or sets the Mode.

property InitialCondition.NewtonRaphsonOption: Ansys.Mechanical.DataModel.Enums.NewtonRaphsonType | None

Gets the NewtonRaphsonOption.

property InitialCondition.PreStressDefineBy: Ansys.Mechanical.DataModel.Enums.PreStressStateType | None

Gets or sets the PreStressDefineBy.

property InitialCondition.PreStressEnvironmentHarmonicIC: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the PreStressEnvironmentHarmonicIC.

property InitialCondition.PreStressEnvironmentHarmonicMSUPModal: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets the PreStressEnvironmentHarmonicMSUPModal.

property InitialCondition.PreStressEnvironmentModalIC: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the PreStressEnvironmentModalIC.

property InitialCondition.PreStressEnvironmentTransientIC: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the PreStressEnvironmentTransientIC.

property InitialCondition.PreStressEnvironmentTransientMSUPModal: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets the PreStressEnvironmentTransientMSUPModal.

property InitialCondition.PreStressICEnvironment: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the PreStressICEnvironment.

property InitialCondition.PreStressLoadStep: float | None

Gets or sets the PreStressLoadStep.

property InitialCondition.PreStressTime: Ansys.Core.Units.Quantity | None

Gets or sets the PreStressTime.

property InitialCondition.PressureInitialization: Ansys.Mechanical.DataModel.Enums.PressureInitializationType | None

Gets or sets the PressureInitialization.

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

Gets the list of properties for this object.

property InitialCondition.ReferenceTemperature: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceTemperature.

property InitialCondition.ReportedLoadStep: int | None

Gets the ReportedLoadStep.

property InitialCondition.ReportedSubStep: int | None

Gets the ReportedSubStep.

property InitialCondition.ReportedTime: float | None

Gets the ReportedTime.

property InitialCondition.Suppressed: bool | None

Gets or sets the Suppressed.

property InitialCondition.Time: Ansys.Core.Units.Quantity | None

Gets or sets the Time.

property InitialCondition.TimeStepFactor: float | None

Gets or sets the TimeStepFactor.

property InitialCondition.TotalMagnitude: Ansys.Core.Units.Quantity | None

Gets or sets the Magnitude.

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

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

property InitialCondition.XComponent: Ansys.Core.Units.Quantity | None

Gets or sets the XComponent.

property InitialCondition.YComponent: Ansys.Core.Units.Quantity | None

Gets or sets the YComponent.

property InitialCondition.ZComponent: Ansys.Core.Units.Quantity | None

Gets or sets the ZComponent.

Method detail

InitialCondition.Activate() → None

Activate the current object.

InitialCondition.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet

Creates a new child CommandSnippet.

InitialCondition.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

InitialCondition.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

InitialCondition.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

InitialCondition.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

InitialCondition.Delete() → None

Run the Delete action.

InitialCondition.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

InitialCondition.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

InitialCondition.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

InitialCondition.RemoveParameter(propName: str) → None

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