Skip to main content

Mechanical scripting interface

ImportedBodyTemperature

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedBodyTemperature

Bases: object

Defines a ImportedBodyTemperature.

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 Gets whether the imported body temperature is active at the specified load step.
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 Sets whether the imported body temperature is active at the specified load step.

Properties

Name Description
Algorithm Algorithm property.
ApplyAs This controls how the imported load is applied, either as a boundary condition or an initial condition.
ApplyToInitialMesh Gets or sets the ApplyToInitialMesh.
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.
LoadVectorAssignment Gets or sets the LoadVectorAssignment.
LoadVectorNumber Gets or sets the LoadVectorNumber.
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 ImportedBodyTemperature.Algorithm : Ansys.Mechanical.DataModel.Enums.MappingAlgorithm | None

Algorithm property.

property ImportedBodyTemperature.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 ImportedBodyTemperature.ApplyToInitialMesh : bool | None

Gets or sets the ApplyToInitialMesh.

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

BoundingBoxTolerance property.

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

Gets the list of children.

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

Gets the list of associated comments.

property ImportedBodyTemperature.CreateNameSelectionForMappedNodes : bool | None

CreateNameSelectionForMappedNodes property.

property ImportedBodyTemperature.CreateNameSelectionForOutsideNodes : bool | None

CreateNameSelectionForOutsideNodes property.

property ImportedBodyTemperature.CreateNameSelectionForUnmappedNodes : bool | None

CreateNameSelectionForUnmappedNodes property.

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

Gets the current DataModelObject’s category.

property ImportedBodyTemperature.DisplayInteriorPoints : bool | None

DisplayInteriorPoints property.

property ImportedBodyTemperature.DisplayProjectionPlane : bool | None

DisplayProjectionPlane property.

property ImportedBodyTemperature.DisplaySourcePointIds : bool | None

DisplaySourcePointIds property.

property ImportedBodyTemperature.DisplaySourcePoints : bool | None

DisplaySourcePoints property.

property ImportedBodyTemperature.ExtrapolationTolerancePercent : float | None

ExtrapolationTolerancePercent property.

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

Gets the list of associated figures.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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

Interpolation property.

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

KrigingCorrelationFunction property.

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

KrigingPolynom property.

property ImportedBodyTemperature.Limit : int | None

Limit property.

property ImportedBodyTemperature.LoadVectorAssignment : Ansys.Mechanical.DataModel.Enums.LoadVectorAssignment | None

Gets or sets the LoadVectorAssignment.

property ImportedBodyTemperature.LoadVectorNumber : int | None

Gets or sets the LoadVectorNumber.

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

Gets or sets the Location.

property ImportedBodyTemperature.MappedNodesName : str | None

MappedNodesName property.

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

Mapping property.

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

MappingControl property.

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

MaxOutsideDistance property.

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

Method property.

property ImportedBodyTemperature.NumberOfPoints : int | None

NumberOfPoints property.

property ImportedBodyTemperature.OrientationRealignment : bool | None

OrientationRealignment property.

property ImportedBodyTemperature.OutsideDistanceCheck : bool | None

OutsideDistanceCheck property.

property ImportedBodyTemperature.OutsideNodesName : str | None

OutsideNodesName property.

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

OutsideOption property.

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

Pinball property.

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

Projection property.

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

Gets the list of properties for this object.

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

RigidBodyTransformationType property.

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

RigidTransformSourceCoordinateSystem property.

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

RigidTransformTargetCoordinateSystem property.

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

Gets or sets the SharedRefBody.

property ImportedBodyTemperature.ShellThicknessFactor : float | None

ShellThicknessFactor property.

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

SourceMaximum property.

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

SourceMinimum property.

property ImportedBodyTemperature.Suppressed : bool | None

Gets or sets the Suppressed.

property ImportedBodyTemperature.UnmappedNodesName : str | None

UnmappedNodesName property.

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

VariableType property.

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

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

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

Weighting property.

Method detail

ImportedBodyTemperature.Activate()

Activate the current object.

ImportedBodyTemperature.AddComment()

Creates a new child Comment.

ImportedBodyTemperature.AddFigure()

Creates a new child Figure.

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

ImportedBodyTemperature.AddMappingValidation()

Creates a new MappingValidation

ImportedBodyTemperature.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

ImportedBodyTemperature.CreateParameter(propName: str)

Creates a new parameter for a Property.

ImportedBodyTemperature.Delete()

Run the Delete action.

ImportedBodyTemperature.Duplicate()

Creates a copy of the current DataModelObject.

ImportedBodyTemperature.ExportToTextFile(filePath: str)

Run the ExportToTextFile action.

ImportedBodyTemperature.GetActivateAtLoadStep(stepNumber: int)

Gets whether the imported body temperature is active at the specified load step.

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

Gets the list of children, filtered by type.

ImportedBodyTemperature.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ImportedBodyTemperature.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ImportedBodyTemperature.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ImportedBodyTemperature.Import()

Import.

ImportedBodyTemperature.ImportLoad()

Run the ImportLoad action.

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

ImportedBodyTemperature.PropertyByName(name: str)

Get a property by its unique name.

ImportedBodyTemperature.ReloadConfiguration()

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

ImportedBodyTemperature.RemoveParameter(propName: str)

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

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

Sets whether the imported body temperature is active at the specified load step.