Skip to main content

Mechanical scripting interface

ImportedForce

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedForce

Bases: object

Defines a ImportedForce.

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.
AddMappingValidation Creates a new MappingValidation
ClearGeneratedData Run the ClearGeneratedData action.
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.
ExportToTextFile Run the ExportToTextFile action.
GetActivateAtLoadStep GetActivateAtLoadStep method.
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.
Import Import.
ImportLoad Run the ImportLoad action.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
ReloadConfiguration Reload the Imported Load’s setup from its associated configuration file (if available).
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.
SetActivateAtLoadStep SetActivateAtLoadStep method.

Properties

Name Description
Algorithm Algorithm property.
ApplyAs This controls how the imported load is applied, either as a boundary condition or an initial condition.
BoundingBoxTolerance BoundingBoxTolerance property.
Children Gets the list of children.
Comments Gets the list of associated comments.
CreateNameSelectionForMappedNodes CreateNameSelectionForMappedNodes property.
CreateNameSelectionForOutsideNodes CreateNameSelectionForOutsideNodes property.
CreateNameSelectionForUnmappedNodes CreateNameSelectionForUnmappedNodes property.
DataModelObjectCategory Gets the current DataModelObject’s category.
DisplayInteriorPoints DisplayInteriorPoints property.
DisplayProjectionPlane DisplayProjectionPlane property.
DisplaySourcePointIds DisplaySourcePointIds property.
DisplaySourcePoints DisplaySourcePoints property.
ExtrapolationTolerancePercent ExtrapolationTolerancePercent property.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Interpolation Interpolation property.
KrigingCorrelationFunction KrigingCorrelationFunction property.
KrigingPolynom KrigingPolynom property.
Limit Limit property.
Location Gets or sets the Location.
MappedNodesName MappedNodesName property.
Mapping Mapping property.
MappingControl MappingControl property.
MaxOutsideDistance MaxOutsideDistance property.
Method Method property.
NumberOfPoints NumberOfPoints property.
OrientationRealignment OrientationRealignment property.
OutsideDistanceCheck OutsideDistanceCheck property.
OutsideNodesName OutsideNodesName property.
OutsideOption OutsideOption property.
Pinball Pinball property.
Projection Projection property.
Properties Gets the list of properties for this object.
RigidBodyTransformationType RigidBodyTransformationType property.
RigidTransformSourceCoordinateSystem RigidTransformSourceCoordinateSystem property.
RigidTransformTargetCoordinateSystem RigidTransformTargetCoordinateSystem property.
SharedRefBody Gets or sets the SharedRefBody.
ShellThicknessFactor ShellThicknessFactor property.
SourceMaximum SourceMaximum property.
SourceMinimum SourceMinimum property.
Suppressed Gets or sets the Suppressed.
UnmappedNodesName UnmappedNodesName property.
VariableType VariableType property.
VisibleProperties Gets the list of properties that are visible for this object.
Weighting Weighting property.

Property detail

property ImportedForce.Algorithm : Ansys.Mechanical.DataModel.Enums.MappingAlgorithm | None

Algorithm property.

property ImportedForce.ApplyAs : Ansys.Mechanical.DataModel.Enums.ExternalLoadApplicationType | None

This controls how the imported load is applied, either as a boundary condition or an initial condition.

property ImportedForce.BoundingBoxTolerance : Ansys.Core.Units.Quantity | None

BoundingBoxTolerance property.

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

Gets the list of children.

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

Gets the list of associated comments.

property ImportedForce.CreateNameSelectionForMappedNodes : bool | None

CreateNameSelectionForMappedNodes property.

property ImportedForce.CreateNameSelectionForOutsideNodes : bool | None

CreateNameSelectionForOutsideNodes property.

property ImportedForce.CreateNameSelectionForUnmappedNodes : bool | None

CreateNameSelectionForUnmappedNodes property.

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

Gets the current DataModelObject’s category.

property ImportedForce.DisplayInteriorPoints : bool | None

DisplayInteriorPoints property.

property ImportedForce.DisplayProjectionPlane : bool | None

DisplayProjectionPlane property.

property ImportedForce.DisplaySourcePointIds : bool | None

DisplaySourcePointIds property.

property ImportedForce.DisplaySourcePoints : bool | None

DisplaySourcePoints property.

property ImportedForce.ExtrapolationTolerancePercent : float | None

ExtrapolationTolerancePercent property.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property ImportedForce.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSExternalLoadAuto | None

Gets the internal object. For advanced usage only.

property ImportedForce.Interpolation : Ansys.Mechanical.DataModel.Enums.InterpolationType | None

Interpolation property.

property ImportedForce.KrigingCorrelationFunction : Ansys.Mechanical.DataModel.Enums.KrigingCorrFuncType | None

KrigingCorrelationFunction property.

property ImportedForce.KrigingPolynom : Ansys.Mechanical.DataModel.Enums.KrigingPolynomType | None

KrigingPolynom property.

property ImportedForce.Limit : int | None

Limit property.

property ImportedForce.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property ImportedForce.MappedNodesName : str | None

MappedNodesName property.

property ImportedForce.Mapping : Ansys.Mechanical.DataModel.Enums.MappingInterpolationType | None

Mapping property.

property ImportedForce.MappingControl : Ansys.Mechanical.DataModel.Enums.MappingControlType | None

MappingControl property.

property ImportedForce.MaxOutsideDistance : Ansys.Core.Units.Quantity | None

MaxOutsideDistance property.

property ImportedForce.Method : Ansys.Mechanical.DataModel.Enums.MappingMethod | None

Method property.

property ImportedForce.NumberOfPoints : int | None

NumberOfPoints property.

property ImportedForce.OrientationRealignment : bool | None

OrientationRealignment property.

property ImportedForce.OutsideDistanceCheck : bool | None

OutsideDistanceCheck property.

property ImportedForce.OutsideNodesName : str | None

OutsideNodesName property.

property ImportedForce.OutsideOption : Ansys.Mechanical.DataModel.Enums.MappingOutsideOption | None

OutsideOption property.

property ImportedForce.Pinball : Ansys.Core.Units.Quantity | None

Pinball property.

property ImportedForce.Projection : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Projection property.

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

Gets the list of properties for this object.

property ImportedForce.RigidBodyTransformationType : Ansys.Mechanical.DataModel.Enums.RigidBodyTransformationType | None

RigidBodyTransformationType property.

property ImportedForce.RigidTransformSourceCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

RigidTransformSourceCoordinateSystem property.

property ImportedForce.RigidTransformTargetCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

RigidTransformTargetCoordinateSystem property.

property ImportedForce.SharedRefBody : Ansys.ACT.Automation.Mechanical.Body | None

Gets or sets the SharedRefBody.

property ImportedForce.ShellThicknessFactor : float | None

ShellThicknessFactor property.

property ImportedForce.SourceMaximum : Ansys.Core.Units.Quantity | None

SourceMaximum property.

property ImportedForce.SourceMinimum : Ansys.Core.Units.Quantity | None

SourceMinimum property.

property ImportedForce.Suppressed : bool | None

Gets or sets the Suppressed.

property ImportedForce.UnmappedNodesName : str | None

UnmappedNodesName property.

property ImportedForce.VariableType : Ansys.Mechanical.DataModel.Enums.MappingVariableType | None

VariableType property.

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

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

property ImportedForce.Weighting : Ansys.Mechanical.DataModel.Enums.WeightingType | None

Weighting property.

Method detail

ImportedForce.Activate()

Activate the current object.

ImportedForce.AddComment()

Creates a new child Comment.

ImportedForce.AddFigure()

Creates a new child Figure.

ImportedForce.AddImage(filePath: str)

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.

ImportedForce.AddMappingValidation()

Creates a new MappingValidation

ImportedForce.ClearGeneratedData()

Run the ClearGeneratedData action.

ImportedForce.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

ImportedForce.CreateParameter(propName: str)

Creates a new parameter for a Property.

ImportedForce.Delete()

Run the Delete action.

ImportedForce.Duplicate()

Creates a copy of the current DataModelObject.

ImportedForce.ExportToTextFile(filePath: str)

Run the ExportToTextFile action.

ImportedForce.GetActivateAtLoadStep(stepNumber: int)

GetActivateAtLoadStep method.

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

Gets the list of children, filtered by type.

ImportedForce.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ImportedForce.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ImportedForce.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ImportedForce.Import()

Import.

ImportedForce.ImportLoad()

Run the ImportLoad action.

ImportedForce.PropertyByAPIName(name: str)

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.

ImportedForce.PropertyByName(name: str)

Get a property by its unique name.

ImportedForce.ReloadConfiguration()

Reload the Imported Load’s setup from its associated configuration file (if available).

ImportedForce.RemoveParameter(propName: str)

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

ImportedForce.SetActivateAtLoadStep(stepNumber: int, bActive: bool)

SetActivateAtLoadStep method.