Skip to main content

Mechanical scripting interface

ImportedConvection

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedConvection

Bases: object

Defines a ImportedConvection.

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 convection 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 convection 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.
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.
DisplayConnectionLines Gets or sets the DisplayConnectionLines.
DisplayInteriorPoints DisplayInteriorPoints property.
DisplayProjectionPlane DisplayProjectionPlane property.
DisplaySourcePointIds DisplaySourcePointIds property.
DisplaySourcePoints DisplaySourcePoints property.
ExtrapolationTolerancePercent ExtrapolationTolerancePercent property.
Figures Gets the list of associated figures.
FluidFlow Gets or sets the FluidFlow.
FluidFlowLocation Gets or sets the FluidFlowLocation.
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 ImportedConvection.Algorithm : Ansys.Mechanical.DataModel.Enums.MappingAlgorithm | None

Algorithm property.

property ImportedConvection.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 ImportedConvection.BoundingBoxTolerance : Ansys.Core.Units.Quantity | None

BoundingBoxTolerance property.

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

Gets the list of children.

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

Gets the list of associated comments.

property ImportedConvection.CreateNameSelectionForMappedNodes : bool | None

CreateNameSelectionForMappedNodes property.

property ImportedConvection.CreateNameSelectionForOutsideNodes : bool | None

CreateNameSelectionForOutsideNodes property.

property ImportedConvection.CreateNameSelectionForUnmappedNodes : bool | None

CreateNameSelectionForUnmappedNodes property.

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

Gets the current DataModelObject’s category.

property ImportedConvection.DisplayConnectionLines : bool | None

Gets or sets the DisplayConnectionLines.

property ImportedConvection.DisplayInteriorPoints : bool | None

DisplayInteriorPoints property.

property ImportedConvection.DisplayProjectionPlane : bool | None

DisplayProjectionPlane property.

property ImportedConvection.DisplaySourcePointIds : bool | None

DisplaySourcePointIds property.

property ImportedConvection.DisplaySourcePoints : bool | None

DisplaySourcePoints property.

property ImportedConvection.ExtrapolationTolerancePercent : float | None

ExtrapolationTolerancePercent property.

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

Gets the list of associated figures.

property ImportedConvection.FluidFlow : bool | None

Gets or sets the FluidFlow.

property ImportedConvection.FluidFlowLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the FluidFlowLocation.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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

Interpolation property.

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

KrigingCorrelationFunction property.

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

KrigingPolynom property.

property ImportedConvection.Limit : int | None

Limit property.

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

Gets or sets the Location.

property ImportedConvection.MappedNodesName : str | None

MappedNodesName property.

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

Mapping property.

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

MappingControl property.

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

MaxOutsideDistance property.

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

Method property.

property ImportedConvection.NumberOfPoints : int | None

NumberOfPoints property.

property ImportedConvection.OrientationRealignment : bool | None

OrientationRealignment property.

property ImportedConvection.OutsideDistanceCheck : bool | None

OutsideDistanceCheck property.

property ImportedConvection.OutsideNodesName : str | None

OutsideNodesName property.

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

OutsideOption property.

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

Pinball property.

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

Projection property.

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

Gets the list of properties for this object.

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

RigidBodyTransformationType property.

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

RigidTransformSourceCoordinateSystem property.

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

RigidTransformTargetCoordinateSystem property.

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

Gets or sets the SharedRefBody.

property ImportedConvection.ShellThicknessFactor : float | None

ShellThicknessFactor property.

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

SourceMaximum property.

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

SourceMinimum property.

property ImportedConvection.Suppressed : bool | None

Gets or sets the Suppressed.

property ImportedConvection.UnmappedNodesName : str | None

UnmappedNodesName property.

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

VariableType property.

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

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

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

Weighting property.

Method detail

ImportedConvection.Activate()

Activate the current object.

ImportedConvection.AddComment()

Creates a new child Comment.

ImportedConvection.AddFigure()

Creates a new child Figure.

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

ImportedConvection.AddMappingValidation()

Creates a new MappingValidation

ImportedConvection.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

ImportedConvection.CreateParameter(propName: str)

Creates a new parameter for a Property.

ImportedConvection.Delete()

Run the Delete action.

ImportedConvection.Duplicate()

Creates a copy of the current DataModelObject.

ImportedConvection.ExportToTextFile(filePath: str)

Run the ExportToTextFile action.

ImportedConvection.GetActivateAtLoadStep(stepNumber: int)

Gets whether the imported convection is active at the specified load step.

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

Gets the list of children, filtered by type.

ImportedConvection.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ImportedConvection.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ImportedConvection.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ImportedConvection.Import()

Import.

ImportedConvection.ImportLoad()

Run the ImportLoad action.

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

ImportedConvection.PropertyByName(name: str)

Get a property by its unique name.

ImportedConvection.ReloadConfiguration()

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

ImportedConvection.RemoveParameter(propName: str)

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

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

Sets whether the imported convection is active at the specified load step.