`InitialCondition`#

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

Bases: object

Defines a InitialCondition.

Overview#

Methods

`AddCommandSnippet`	Creates a new child CommandSnippet.
`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

`Direction`	Gets or sets the Direction.
`TotalMagnitude`	Gets or sets the Magnitude.
`InitialEnvironment`	Gets or sets the InitialEnvironment.
`PreStressEnvironmentModalIC`	Gets or sets the PreStressEnvironmentModalIC.
`ModalEnvironmentRSIC`	Gets or sets the ModalEnvironmentRSIC.
`ModalEnvironmentPSDIC`	Gets or sets the ModalEnvironmentPSDIC.
`PreStressEnvironmentHarmonicIC`	Gets or sets the PreStressEnvironmentHarmonicIC.
`ModalEnvironmentHarmonicIC`	Gets or sets the ModalEnvironmentHarmonicIC.
`PreStressEnvironmentTransientIC`	Gets or sets the PreStressEnvironmentTransientIC.
`ModalEnvironmentTransientMSUPIC`	Gets or sets the ModalEnvironmentTransientMSUPIC.
`ModalICEnvironment`	Gets or sets the ModalICEnvironment.
`PreStressICEnvironment`	Gets or sets the PreStressICEnvironment.
`InternalObject`	Gets the internal object. For advanced usage only.
`ReportedLoadStep`	Gets the ReportedLoadStep.
`ReportedSubStep`	Gets the ReportedSubStep.
`ReportedTime`	Gets the ReportedTime.
`TimeStepFactor`	Gets or sets the TimeStepFactor.
`PreStressLoadStep`	Gets or sets the PreStressLoadStep.
`DropHeight`	Gets or sets the DropHeight.
`ImpactVelocity`	Gets or sets the ImpactVelocity.
`Time`	Gets or sets the Time.
`InitialTemperatureValue`	Gets or sets the InitialTemperatureValue.
`ExplicitPreStressTime`	Gets or sets the ExplicitPreStressTime.
`PreStressTime`	Gets or sets the PreStressTime.
`ReferenceTemperature`	Gets or sets the ReferenceTemperature.
`XComponent`	Gets or sets the XComponent.
`YComponent`	Gets or sets the YComponent.
`ZComponent`	Gets or sets the ZComponent.
`DropTestDefineBy`	Gets or sets the DropTestDefineBy.
`DropDirection`	Gets or sets the DropDirection.
`InitialTemperature`	Gets or sets the InitialTemperature.
`PressureInitialization`	Gets or sets the PressureInitialization.
`ContactStatus`	Gets or sets the ContactStatus.
`LoadControl`	Gets or sets the LoadControl.
`Mode`	Gets or sets the Mode.
`NewtonRaphsonOption`	Gets the NewtonRaphsonOption.
`PreStressDefineBy`	Gets or sets the PreStressDefineBy.
`InputType`	Gets or sets the InputType.
`DefineBy`	Gets or sets the DefineBy.
`Suppressed`	Gets or sets the Suppressed.
`PreStressEnvironmentHarmonicMSUPModal`	Gets the PreStressEnvironmentHarmonicMSUPModal.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`PreStressEnvironmentTransientMSUPModal`	Gets the PreStressEnvironmentTransientMSUPModal.
`Location`	Gets or sets the Location.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`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.
`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 InitialCondition.Direction: Ansys.ACT.Math.Vector3D | None: Gets or sets the Direction.

property InitialCondition.TotalMagnitude: Ansys.Core.Units.Quantity | None: Gets or sets the Magnitude.

property InitialCondition.InitialEnvironment: Ansys.ACT.Automation.Mechanical.Analysis | None: Gets or sets the InitialEnvironment.

property InitialCondition.PreStressEnvironmentModalIC: Ansys.ACT.Automation.Mechanical.Analysis | None: Gets or sets the PreStressEnvironmentModalIC.

property InitialCondition.ModalEnvironmentRSIC: Ansys.ACT.Automation.Mechanical.Analysis | None: Gets or sets the ModalEnvironmentRSIC.

property InitialCondition.ModalEnvironmentPSDIC: Ansys.ACT.Automation.Mechanical.Analysis | None: Gets or sets the ModalEnvironmentPSDIC.

property InitialCondition.PreStressEnvironmentHarmonicIC: Ansys.ACT.Automation.Mechanical.Analysis | None: Gets or sets the PreStressEnvironmentHarmonicIC.

property InitialCondition.ModalEnvironmentHarmonicIC: Ansys.ACT.Automation.Mechanical.Analysis | None: Gets or sets the ModalEnvironmentHarmonicIC.

property InitialCondition.PreStressEnvironmentTransientIC: Ansys.ACT.Automation.Mechanical.Analysis | None: Gets or sets the PreStressEnvironmentTransientIC.

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

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

property InitialCondition.ReportedLoadStep: System.Int32 | None: Gets the ReportedLoadStep.

property InitialCondition.ReportedSubStep: System.Int32 | None: Gets the ReportedSubStep.

property InitialCondition.ReportedTime: System.Double | None: Gets the ReportedTime.

property InitialCondition.TimeStepFactor: System.Double | None: Gets or sets the TimeStepFactor.

property InitialCondition.PreStressLoadStep: System.Double | None: Gets or sets the PreStressLoadStep.

property InitialCondition.DropHeight: Ansys.Core.Units.Quantity | None: Gets or sets the DropHeight.

property InitialCondition.ImpactVelocity: Ansys.Core.Units.Quantity | None: Gets or sets the ImpactVelocity.

property InitialCondition.Time: Ansys.Core.Units.Quantity | None: Gets or sets the Time.

property InitialCondition.InitialTemperatureValue: Ansys.Core.Units.Quantity | None: Gets or sets the InitialTemperatureValue.

property InitialCondition.ExplicitPreStressTime: Ansys.Core.Units.Quantity | None: Gets or sets the ExplicitPreStressTime.

property InitialCondition.PreStressTime: Ansys.Core.Units.Quantity | None: Gets or sets the PreStressTime.

property InitialCondition.ReferenceTemperature: Ansys.Core.Units.Quantity | None: Gets or sets the ReferenceTemperature.

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.

property InitialCondition.DropTestDefineBy: Ansys.Mechanical.DataModel.Enums.DropTestDefineBy | None: Gets or sets the DropTestDefineBy.

property InitialCondition.DropDirection: Ansys.Mechanical.DataModel.Enums.DropDirection | None: Gets or sets the DropDirection.

property InitialCondition.InitialTemperature: Ansys.Mechanical.DataModel.Enums.InitialTemperatureType | None: Gets or sets the InitialTemperature.

property InitialCondition.PressureInitialization: Ansys.Mechanical.DataModel.Enums.PressureInitializationType | None: Gets or sets the PressureInitialization.

property InitialCondition.ContactStatus: Ansys.Mechanical.DataModel.Enums.PreStressContactStatus | None: Gets or sets the ContactStatus.

property InitialCondition.LoadControl: Ansys.Mechanical.DataModel.Enums.PreStressLoadControl | None: Gets or sets the LoadControl.

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.InputType: Ansys.Mechanical.DataModel.Enums.InitialConditionsType | None: Gets or sets the InputType.

property InitialCondition.DefineBy: Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None: Gets or sets the DefineBy.

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

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

property InitialCondition.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the CoordinateSystem.

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

property InitialCondition.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

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

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

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

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

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

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

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

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

Method detail#

InitialCondition.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet: Creates a new child CommandSnippet.

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

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

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

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

InitialCondition.Activate() → System.Void: Activate the current object.

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

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

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

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

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

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

InitialCondition.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

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

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