LoadGroup#

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

Bases: object

Defines a LoadGroup.

Overview#

Activate

Activate the current object.

AddComment

Creates a new child Comment.

AddCurrent

Creates a new Current

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

AddVoltage

Creates a new Voltage

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.

GenerateRemoteLoads

Run the action to generate the remote loads from the source data.

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.

Children

Gets the list of children.

Comments

Gets the list of associated comments.

ConductingArea

Gets or sets the ConductingArea.

ConductorCurrent

Gets or sets the ConductorCurrent.

ConductorType

Gets or sets the ConductorType.

DataImportStatus

Gets the DataImportStatus.

DataModelObjectCategory

Gets the current DataModelObject's category.

Figures

Gets the list of associated figures.

FilterByOrder

Gets or sets whether imported remote loads are filtered by order. The order is specified in the Orders property.

GroupingType

Gets or sets the GroupingType.

Images

Gets the list of associated images.

ImportedDataType

Gets or sets the ImportedDataType.

InternalObject

Gets the internal object. For advanced usage only.

InterpolateRPM

Gets or Sets the Interpolate RPM.

Location

Gets or sets the Location.

NumberOfFrequenciesToConsider

Gets or sets the NumberOfFrequenciesToConsider.

NumberOfPoints

Gets or Sets the Number of Points.

NumberOfTurns

Gets or sets the NumberOfTurns.

OnDataRefreshOption

Gets or sets the OnDataRefreshOption.

Orders

Gets or Sets the Orders. These orders are imported from the maxwell solution and the Analysis Settings will be synced with the orders specified.

PhaseAngle

Gets or sets the PhaseAngle.

Properties

Gets the list of properties for this object.

RPMFileSelection

Gets or Sets the File Selection (.csv) for User Defined RPM Interpolation.

SolutionId

Gets or sets the SolutionId.

Suppressed

Gets or sets the Suppressed.

TransferFileName

Gets or sets the TransferFileName.

UseInternalRemotePoints

Gets or sets the UseInternalRemotePoints.

VisibleProperties

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

Property detail#

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

Gets the list of children.

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

Gets the list of associated comments.

property LoadGroup.ConductingArea: Ansys.Core.Units.Quantity | None#

Gets or sets the ConductingArea.

property LoadGroup.ConductorCurrent: Ansys.Core.Units.Quantity | None#

Gets or sets the ConductorCurrent.

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.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property LoadGroup.FilterByOrder: bool | None#

Gets or sets whether imported remote loads are filtered by order. The order is specified in the Orders property.

property LoadGroup.GroupingType: Ansys.Mechanical.DataModel.Enums.LoadGroupingType | None#

Gets or sets the GroupingType.

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

Gets the list of associated images.

property LoadGroup.ImportedDataType: Ansys.Mechanical.DataModel.Enums.DataTypeOptions | None#

Gets or sets the ImportedDataType.

property LoadGroup.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadGroupAuto | None#

Gets the internal object. For advanced usage only.

property LoadGroup.InterpolateRPM: Ansys.Mechanical.DataModel.Enums.InterpolateRPM | None#

Gets or Sets the Interpolate RPM.

property LoadGroup.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

property LoadGroup.NumberOfFrequenciesToConsider: int | None#

Gets or sets the NumberOfFrequenciesToConsider.

property LoadGroup.NumberOfPoints: int | None#

Gets or Sets the Number of Points.

property LoadGroup.NumberOfTurns: int | None#

Gets or sets the NumberOfTurns.

property LoadGroup.OnDataRefreshOption: Ansys.Mechanical.DataModel.Enums.RemotePointUpdateOptions | None#

Gets or sets the OnDataRefreshOption.

property LoadGroup.Orders: str | None#

Gets or Sets the Orders. These orders are imported from the maxwell solution and the Analysis Settings will be synced with the orders specified.

property LoadGroup.PhaseAngle: Ansys.Core.Units.Quantity | None#

Gets or sets the PhaseAngle.

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

Gets the list of properties for this object.

property LoadGroup.RPMFileSelection: str | None#

Gets or Sets the File Selection (.csv) for User Defined RPM Interpolation.

property LoadGroup.SolutionId: int | None#

Gets or sets the SolutionId.

property LoadGroup.Suppressed: bool | None#

Gets or sets the Suppressed.

property LoadGroup.TransferFileName: str | None#

Gets or sets the TransferFileName.

property LoadGroup.UseInternalRemotePoints: bool | None#

Gets or sets the UseInternalRemotePoints.

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

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

Method detail#

LoadGroup.Activate() None#

Activate the current object.

LoadGroup.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

LoadGroup.AddCurrent() Ansys.ACT.Automation.Mechanical.BoundaryConditions.Current#

Creates a new Current

LoadGroup.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

LoadGroup.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.
LoadGroup.AddVoltage() Ansys.ACT.Automation.Mechanical.BoundaryConditions.Voltage#

Creates a new Voltage

LoadGroup.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

LoadGroup.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

LoadGroup.Delete() None#

Run the Delete action.

LoadGroup.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

LoadGroup.GenerateRemoteLoads() None#

Run the action to generate the remote loads from the source data.

LoadGroup.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

LoadGroup.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

LoadGroup.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

LoadGroup.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

LoadGroup.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.
LoadGroup.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

LoadGroup.RemoveParameter(propName: str) None#

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