`LoadGroup`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.LoadGroup#

Bases: object

Defines a LoadGroup.

Overview#

Methods

`GenerateRemoteLoads`	Run the action to generate the remote loads from the source data.
`AddCurrent`	Creates a new Current
`AddVoltage`	Creates a new Voltage
`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

`InternalObject`	Gets the internal object. For advanced usage only.
`SolutionId`	Gets or sets the SolutionId.
`NumberOfFrequenciesToConsider`	Gets or sets the NumberOfFrequenciesToConsider.
`NumberOfTurns`	Gets or sets the NumberOfTurns.
`TransferFileName`	Gets or sets the TransferFileName.
`ConductorCurrent`	Gets or sets the ConductorCurrent.
`ConductingArea`	Gets or sets the ConductingArea.
`PhaseAngle`	Gets or sets the PhaseAngle.
`GroupingType`	Gets or sets the GroupingType.
`ImportedDataType`	Gets or sets the ImportedDataType.
`OnDataRefreshOption`	Gets or sets the OnDataRefreshOption.
`ConductorType`	Gets or sets the ConductorType.
`DataImportStatus`	Gets the DataImportStatus.
`UseInternalRemotePoints`	Gets or sets the UseInternalRemotePoints.
`Suppressed`	Gets or sets the Suppressed.
`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 LoadGroup.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadGroupAuto | None: Gets the internal object. For advanced usage only.

property LoadGroup.SolutionId: System.Int32 | None: Gets or sets the SolutionId.

property LoadGroup.NumberOfFrequenciesToConsider: System.UInt32 | None: Gets or sets the NumberOfFrequenciesToConsider.

property LoadGroup.NumberOfTurns: System.UInt32 | None: Gets or sets the NumberOfTurns.

property LoadGroup.TransferFileName: System.String | None: Gets or sets the TransferFileName.

property LoadGroup.ConductorCurrent: Ansys.Core.Units.Quantity | None: Gets or sets the ConductorCurrent.

property LoadGroup.ConductingArea: Ansys.Core.Units.Quantity | None: Gets or sets the ConductingArea.

property LoadGroup.PhaseAngle: Ansys.Core.Units.Quantity | None: Gets or sets the PhaseAngle.

property LoadGroup.GroupingType: Ansys.Mechanical.DataModel.Enums.LoadGroupingType | None: Gets or sets the GroupingType.

property LoadGroup.ImportedDataType: Ansys.Mechanical.DataModel.Enums.DataTypeOptions | None: Gets or sets the ImportedDataType.

property LoadGroup.OnDataRefreshOption: Ansys.Mechanical.DataModel.Enums.RemotePointUpdateOptions | None: Gets or sets the OnDataRefreshOption.

property LoadGroup.ConductorType: Ansys.Mechanical.DataModel.Enums.SourceConductorType | None: Gets or sets the ConductorType.

property LoadGroup.DataImportStatus: Ansys.Mechanical.DataModel.Enums.DataImportStatus | None: Gets the DataImportStatus.

property LoadGroup.UseInternalRemotePoints: System.Boolean | None: Gets or sets the UseInternalRemotePoints.

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

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

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

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

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

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

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

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

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

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

Method detail#

LoadGroup.GenerateRemoteLoads() → System.Void: Run the action to generate the remote loads from the source data.

LoadGroup.AddCurrent() → Ansys.ACT.Automation.Mechanical.BoundaryConditions.Current: Creates a new Current

LoadGroup.AddVoltage() → Ansys.ACT.Automation.Mechanical.BoundaryConditions.Voltage: Creates a new Voltage

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

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

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

LoadGroup.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

LoadGroup.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

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

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

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

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

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

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

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

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

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

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

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