LoadGroup
#
- class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.BoundaryConditions.LoadGroup#
Bases:
object
Defines a LoadGroup.
Overview#
Activate the current object. |
|
Creates a new child Comment. |
|
Creates a new Current |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Creates a new Voltage |
|
Copies all visible properties from this object to another. |
|
Creates a new parameter for a Property. |
|
Run the Delete action. |
|
Creates a copy of the current DataModelObject. |
|
Run the action to generate the remote loads from the source data. |
|
Gets the list of children, filtered by type. |
|
Gets the parameter corresponding to the given property. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Get a property by its API name. |
|
Get a property by its unique name. |
|
Removes the parameter from the parameter set corresponding to the given property. |
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets or sets the ConductingArea. |
|
Gets or sets the ConductorCurrent. |
|
Gets or sets the ConductorType. |
|
Gets the DataImportStatus. |
|
Gets the current DataModelObject's category. |
|
Gets the list of associated figures. |
|
Gets or sets whether imported remote loads are filtered by order. The order is specified in the Orders property. |
|
Gets or sets the GroupingType. |
|
Gets the list of associated images. |
|
Gets or sets the ImportedDataType. |
|
Gets the internal object. For advanced usage only. |
|
Gets or Sets the Interpolate RPM. |
|
Gets or sets the Location. |
|
Gets or sets the NumberOfFrequenciesToConsider. |
|
Gets or Sets the Number of Points. |
|
Gets or sets the NumberOfTurns. |
|
Gets or sets the OnDataRefreshOption. |
|
Gets or Sets the Orders. These orders are imported from the maxwell solution and the Analysis Settings will be synced with the orders specified. |
|
Gets or sets the PhaseAngle. |
|
Gets the list of properties for this object. |
|
Gets or Sets the File Selection (.csv) for User Defined RPM Interpolation. |
|
Gets or sets the SolutionId. |
|
Gets or sets the Suppressed. |
|
Gets or sets the TransferFileName. |
|
Gets or sets the UseInternalRemotePoints. |
|
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.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.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#
Gets the list of properties for this object.
Method detail#
- 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.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.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder #
Run the GroupSimilarObjects action.
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.