Skip to main content

Mechanical scripting interface

Convection

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.Convection

Bases: object

Defines a Convection.

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.
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.
GetActivateAtLoadStep Gets whether the convection is active at the specified load step.
GetChildren Gets the list of children, filtered by type.
GetComponentActivateAtLoadStep GetComponentActivateAtLoadStep method.
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
PromoteToNamedSelection Run the PromoteToNamedSelection action.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.
SetActivateAtLoadStep Sets whether the convection is active at the specified load step.
SetComponentActivateAtLoadStep SetComponentActivateAtLoadStep method.

Properties

Name Description
AmbientTemperature Property used to get and set the ambient temperature data
AmbientTemperatureCoordinateSystem The coordinate system id used currently to determinine the position of the points of the ambient temperature variable
Children Gets the list of children.
CoefficientType Gets or sets the CoefficientType.
Comments Gets the list of associated comments.
ConvectionCoefficientCoordinateSystem The coordinate system id used currently to determinine the position of the points of the convection coefficient variable
ConvectionMatrix Gets or sets the ConvectionMatrix.
DataModelObjectCategory Gets the current DataModelObject’s category.
DisplayConnectionLines Gets or sets the DisplayConnectionLines.
EditDataFor Gets or sets the EditDataFor.
ElementAPDLName Gets or Sets the ElementAPDLName which stores the element type number of the convection load. This you can reference and use in Command Snippets.
Figures Gets the list of associated figures.
FilmCoefficient Property used to get and set the film coefficient data
FluidFlowSelection Gets or sets the FluidFlowSelection.
GraphControlsXAxis Gets or sets the GraphControlsXAxis.
HasFluidFlow Gets or sets the HasFluidFlow.
Images Gets the list of associated images.
IndependentVariable Gets or sets the IndependentVariable.
InternalObject InternalObject property.
Location Gets or sets the Location.
NumberOfSegments Gets or sets the NumberOfSegments.
Properties Gets the list of properties for this object.
RangeMaximum Gets or sets the RangeMaximum.
RangeMinimum Gets or sets the RangeMinimum.
ReadOnly Gets or sets the ReadOnly.
SharedRefBody Gets or sets the SharedRefBody.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.
XYZFunctionCoordinateSystem Gets or sets the XYZFunctionCoordinateSystem.

Property detail

property Convection.AmbientTemperature : Any | None

Property used to get and set the ambient temperature data The setter allows the use of a table T:Ansys.ACT.Automation.Mechanical.Table object, an expression contained in a string or a quantity T:Ansys.Core.Units.Quantity object as a data source. Depending on the representation T:Ansys.Mechanical.DataModel.MechanicalEnums.BoundaryConditions.DataRepresentation type, the getter return type is a field T:Ansys.ACT.Mechanical.Fields.Field object or an object which type depends on the source of the ambient temperature data:

  • On table assignment mode, it returns the source table T:Ansys.ACT.Automation.Mechanical.Table object.
  • On function mode, it returns a string containing the expression evaluated to obtain the data.
  • On constant mode, it returns a quantity T:Ansys.Core.Units.Quantity object containg the value and the units currently assigned to the ambient temperature.
  • On tabular mode, it returns a tabularDataTable T:Ansys.ACT.Automation.Mechanical.TabularDataTable object.

property Convection.AmbientTemperatureCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

The coordinate system id used currently to determinine the position of the points of the ambient temperature variable

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

Gets the list of children.

property Convection.CoefficientType : Ansys.Mechanical.DataModel.Enums.LoadVariationSubOption | None

Gets or sets the CoefficientType.

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

Gets the list of associated comments.

property Convection.ConvectionCoefficientCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

The coordinate system id used currently to determinine the position of the points of the convection coefficient variable

property Convection.ConvectionMatrix : Ansys.Mechanical.DataModel.Enums.DiagonalOrConsistent | None

Gets or sets the ConvectionMatrix.

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

Gets the current DataModelObject’s category.

property Convection.DisplayConnectionLines : bool | None

Gets or sets the DisplayConnectionLines.

property Convection.EditDataFor : Ansys.Mechanical.DataModel.Enums.ConvectionTableSelection | None

Gets or sets the EditDataFor.

property Convection.ElementAPDLName : str | None

Gets or Sets the ElementAPDLName which stores the element type number of the convection load. This you can reference and use in Command Snippets.

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

Gets the list of associated figures.

property Convection.FilmCoefficient : Any | None

Property used to get and set the film coefficient data The setter allows the use of a table T:Ansys.ACT.Automation.Mechanical.Table object, an expression contained in a string or a quantity T:Ansys.Core.Units.Quantity object as a data source. Depending on the representation T:Ansys.Mechanical.DataModel.MechanicalEnums.BoundaryConditions.DataRepresentation type, the getter return type is a field T:Ansys.ACT.Mechanical.Fields.Field object or an object which type depends on the source of the film coefficient data:

  • On table assignment mode, it returns the source table T:Ansys.ACT.Automation.Mechanical.Table object.
  • On function mode, it returns a string containing the expression evaluated to obtain the data.
  • On constant mode, it returns a quantity T:Ansys.Core.Units.Quantity object containg the value and the units currently assigned to the film coefficient.
  • On tabular mode, it returns a tabularDataTable T:Ansys.ACT.Automation.Mechanical.TabularDataTable object.

property Convection.FluidFlowSelection : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the FluidFlowSelection.

property Convection.GraphControlsXAxis : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the GraphControlsXAxis.

property Convection.HasFluidFlow : bool | None

Gets or sets the HasFluidFlow.

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

Gets the list of associated images.

property Convection.IndependentVariable : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the IndependentVariable.

property Convection.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None

InternalObject property.

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

Gets or sets the Location.

property Convection.NumberOfSegments : int | None

Gets or sets the NumberOfSegments.

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

Gets the list of properties for this object.

property Convection.RangeMaximum : Ansys.Core.Units.Quantity | None

Gets or sets the RangeMaximum.

property Convection.RangeMinimum : Ansys.Core.Units.Quantity | None

Gets or sets the RangeMinimum.

property Convection.ReadOnly : bool | None

Gets or sets the ReadOnly.

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

Gets or sets the SharedRefBody.

property Convection.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

property Convection.XYZFunctionCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the XYZFunctionCoordinateSystem.

Method detail

Convection.Activate()

Activate the current object.

Convection.AddComment()

Creates a new child Comment.

Convection.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

Convection.CreateParameter(propName: str)

Creates a new parameter for a Property.

Convection.Delete()

Run the Delete action.

Convection.Duplicate()

Creates a copy of the current DataModelObject.

Convection.GetActivateAtLoadStep(stepNumber: int)

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

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

Gets the list of children, filtered by type.

Convection.GetComponentActivateAtLoadStep(component: str, stepNumber: int)

GetComponentActivateAtLoadStep method.

Convection.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

Convection.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

Convection.GroupSimilarObjects()

Run the GroupSimilarObjects action.

Convection.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

Convection.PropertyByName(name: str)

Get a property by its unique name.

Convection.RemoveParameter(propName: str)

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

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

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

Convection.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool)

SetComponentActivateAtLoadStep method.