Mechanical scripting interface 2026 R1

`ImportedLoadGroup`

Last update: 09.03.2026

class Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedLoadGroup

Bases: object

Defines a ImportedLoadGroup.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
AddImportedBodyForceDensity Creates a new ImportedBodyForceDensity
AddImportedBodyTemperature Creates a new ImportedBodyTemperature
AddImportedCFDPressure Creates a new Imported CFD Pressure object to map pressure loading read from a Fluent-Mechanical coupling data (.cgns) file.
AddImportedConvection Creates a new ImportedConvection
AddImportedCutBoundaryConstraint Creates a new ImportedDisplacement
AddImportedCutBoundaryRemoteConstraint Creates a new ImportedCutBoundaryRemoteConstraint
AddImportedCutBoundaryRemoteForce Creates a new ImportedCutBoundaryRemoteForce
AddImportedDisplacement Creates a new ImportedDisplacement
AddImportedElementOrientation Creates a new ImportedElementOrientation
AddImportedFiberRatio Creates a new ImportedFiberRatio
AddImportedForce Creates a new ImportedForce
AddImportedHeatFlux Creates a new ImportedHeatFlux
AddImportedHeatGeneration Creates a new ImportedHeatGeneration
AddImportedInitialStrain Creates a new ImportedInitialStrain
AddImportedInitialStress Creates a new ImportedInitialStress
AddImportedMaterialField Creates a new ImportedMaterialField
AddImportedPressure Creates a new ImportedPressure
AddImportedSurfaceForceDensity Creates a new ImportedSurfaceForceDensity
AddImportedTemperature Creates a new ImportedTemperature
AddImportedThickness Creates a new ImportedThickness
AddImportedTrace Creates a new ImportedTrace
AddImportedVelocity Creates a new ImportedVelocity
AddImportedWarpWeftRatio Creates a new ImportedWarpWeftRatio
AddImportedYarnAngle Creates a new ImportedYarnAngle
ClearGeneratedData Run the ClearGeneratedData action.
CopyTo Copies all visible properties from this object to another.
CreateBodyForceDensitiesAndSyncAnalysisSettings Create body force densities for all RPMs.
CreateExternalLoadVelocitiesAndSyncAnalysisSettings Run the CreateExternalLoadVelocitiesAndSyncAnalysisSettings action.
CreateParameter Creates a new parameter for a Property.
CreateSurfaceForceDensitiesAndSyncAnalysisSettings Create surface force densities for all RPMs.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
GetChildren Gets the list of children, filtered by type.
GetExternalDataFiles
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
ImportExternalDataFiles
ImportLoad Run the ImportLoad action.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
RefreshImportedLoad Run the RefreshImportedLoad action.
ReloadExternalDataFiles Reloads the external data files for current Imported Load Group.
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.
SetResultFile Sets the ResultFile with unitSystem supplied. For MAPDL Results File without a unit system.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject's category.
DeleteMappedDataFilesAfterImport Gets or sets the DeleteMappedDataFilesAfterImport.
Figures Gets the list of associated figures.
FilesDirectory Gets the FilesDirectory.
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.
ResultFile Gets or sets the ResultFile.
ResultFileTimestamp Gets the ResultFileTimestamp.
ResultFileUnitSystem Gets or sets the ResultFileUnitSystem.
Source Gets the Source.
SourceDimension Gets or sets the SourceDimension.
Suppressed Gets or sets the Suppressed.
TransferStep Controls which additive simulation step is used for the data transfer.
TransferTemperaturesDuringSolve Gets or sets the TransferTemperaturesDuringSolve.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property ImportedLoadGroup.DeleteMappedDataFilesAfterImport : bool | None

Gets or sets the DeleteMappedDataFilesAfterImport.

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

Gets the list of associated figures.

property ImportedLoadGroup.FilesDirectory : str | None

Gets the FilesDirectory.

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

Gets the list of associated images.

property ImportedLoadGroup.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSExternalLoadGroupAuto | None

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property ImportedLoadGroup.ResultFile : str | None

Gets or sets the ResultFile.

property ImportedLoadGroup.ResultFileTimestamp : str | None

Gets the ResultFileTimestamp.

property ImportedLoadGroup.ResultFileUnitSystem : Ansys.Mechanical.DataModel.Enums.WBUnitSystemType | None

Gets or sets the ResultFileUnitSystem.

property ImportedLoadGroup.Source : str | None

Gets the Source.

property ImportedLoadGroup.SourceDimension : Ansys.Mechanical.DataModel.Enums.SourceDimension | None

Gets or sets the SourceDimension.

property ImportedLoadGroup.Suppressed : bool | None

Gets or sets the Suppressed.

property ImportedLoadGroup.TransferStep : int | None

Controls which additive simulation step is used for the data transfer.

property ImportedLoadGroup.TransferTemperaturesDuringSolve : bool | None

Gets or sets the TransferTemperaturesDuringSolve.

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

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

Method detail

ImportedLoadGroup.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

ImportedLoadGroup.AddImportedBodyForceDensity() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedBodyForceDensity

Creates a new ImportedBodyForceDensity

ImportedLoadGroup.AddImportedBodyTemperature() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedBodyTemperature

Creates a new ImportedBodyTemperature

ImportedLoadGroup.AddImportedCFDPressure() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedPressure

Creates a new Imported CFD Pressure object to map pressure loading read from a Fluent-Mechanical coupling data (.cgns) file.

ImportedLoadGroup.AddImportedConvection() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedConvection

Creates a new ImportedConvection

ImportedLoadGroup.AddImportedCutBoundaryConstraint() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedDisplacement

Creates a new ImportedDisplacement

ImportedLoadGroup.AddImportedCutBoundaryRemoteConstraint() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedCutBoundaryRemoteConstraint

Creates a new ImportedCutBoundaryRemoteConstraint

ImportedLoadGroup.AddImportedCutBoundaryRemoteForce() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedCutBoundaryRemoteForce

Creates a new ImportedCutBoundaryRemoteForce

ImportedLoadGroup.AddImportedDisplacement() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedDisplacement

Creates a new ImportedDisplacement

ImportedLoadGroup.AddImportedElementOrientation() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedElementOrientation

Creates a new ImportedElementOrientation

ImportedLoadGroup.AddImportedFiberRatio() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedFiberRatio

Creates a new ImportedFiberRatio

ImportedLoadGroup.AddImportedForce() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedForce

Creates a new ImportedForce

ImportedLoadGroup.AddImportedHeatFlux() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedHeatFlux

Creates a new ImportedHeatFlux

ImportedLoadGroup.AddImportedHeatGeneration() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedHeatGeneration

Creates a new ImportedHeatGeneration

ImportedLoadGroup.AddImportedInitialStrain() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedInitialStrain

Creates a new ImportedInitialStrain

ImportedLoadGroup.AddImportedInitialStress() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedInitialStress

Creates a new ImportedInitialStress

ImportedLoadGroup.AddImportedMaterialField() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedMaterialField

Creates a new ImportedMaterialField

ImportedLoadGroup.AddImportedPressure() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedPressure

Creates a new ImportedPressure

ImportedLoadGroup.AddImportedSurfaceForceDensity() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedSurfaceForceDensity

Creates a new ImportedSurfaceForceDensity

ImportedLoadGroup.AddImportedTemperature() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedTemperature

Creates a new ImportedTemperature

ImportedLoadGroup.AddImportedThickness() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedThickness

Creates a new ImportedThickness

ImportedLoadGroup.AddImportedTrace() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedTrace

Creates a new ImportedTrace

ImportedLoadGroup.AddImportedVelocity() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedVelocity

Creates a new ImportedVelocity

ImportedLoadGroup.AddImportedWarpWeftRatio() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedWarpWeftRatio

Creates a new ImportedWarpWeftRatio

ImportedLoadGroup.AddImportedYarnAngle() → Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedYarnAngle

Creates a new ImportedYarnAngle

ImportedLoadGroup.ClearGeneratedData() → None

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

ImportedLoadGroup.CreateBodyForceDensitiesAndSyncAnalysisSettings() → None

Create body force densities for all RPMs.

ImportedLoadGroup.CreateExternalLoadVelocitiesAndSyncAnalysisSettings() → None

Run the CreateExternalLoadVelocitiesAndSyncAnalysisSettings action.

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

Creates a new parameter for a Property.

ImportedLoadGroup.CreateSurfaceForceDensitiesAndSyncAnalysisSettings() → None

Create surface force densities for all RPMs.

ImportedLoadGroup.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

ImportedLoadGroup.GetExternalDataFiles() → Ansys.Mechanical.ExternalData.ExternalDataFileCollection

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

Gets the parameter corresponding to the given property.

ImportedLoadGroup.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

ImportedLoadGroup.ImportExternalDataFiles(externalDataFiles: Ansys.Mechanical.ExternalData.ExternalDataFileCollection) → None

ImportedLoadGroup.ImportLoad() → None

Run the ImportLoad action.

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

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

Get a property by its unique name.

ImportedLoadGroup.RefreshImportedLoad() → None

Run the RefreshImportedLoad action.

ImportedLoadGroup.ReloadExternalDataFiles() → None

Reloads the external data files for current Imported Load Group.

ImportedLoadGroup.RemoveParameter(propName: str) → None

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

ImportedLoadGroup.SetResultFile(resultFile: str, unitSystem: Ansys.Mechanical.DataModel.Enums.WBUnitSystemType) → None

Sets the ResultFile with unitSystem supplied. For MAPDL Results File without a unit system.

Connect with Ansys