Skip to main content

Mechanical scripting interface

HeatFlux

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.HeatFlux

Bases: object

Defines a HeatFlux.

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 heat flux 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 heat flux is active at the specified load step.
SetComponentActivateAtLoadStep SetComponentActivateAtLoadStep method.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
GraphControlsXAxis Gets or sets the GraphControlsXAxis.
Images Gets the list of associated images.
IndependentVariable Gets or sets the IndependentVariable.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
Magnitude Gets the Magnitude.
NumberOfSegments Gets or sets the NumberOfSegments.
Properties Gets the list of properties for this object.
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 HeatFlux.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets or sets the GraphControlsXAxis.

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

Gets the list of associated images.

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

Gets or sets the IndependentVariable.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property HeatFlux.Magnitude : Ansys.ACT.Mechanical.Fields.Field | None

Gets the Magnitude.

property HeatFlux.NumberOfSegments : int | None

Gets or sets the NumberOfSegments.

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

Gets the list of properties for this object.

property HeatFlux.ReadOnly : bool | None

Gets or sets the ReadOnly.

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

Gets or sets the SharedRefBody.

property HeatFlux.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

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

Gets or sets the XYZFunctionCoordinateSystem.

Method detail

HeatFlux.Activate()

Activate the current object.

HeatFlux.AddComment()

Creates a new child Comment.

HeatFlux.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

HeatFlux.CreateParameter(propName: str)

Creates a new parameter for a Property.

HeatFlux.Delete()

Run the Delete action.

HeatFlux.Duplicate()

Creates a copy of the current DataModelObject.

HeatFlux.GetActivateAtLoadStep(stepNumber: int)

Gets whether the heat flux is active at the specified load step.

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

Gets the list of children, filtered by type.

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

GetComponentActivateAtLoadStep method.

HeatFlux.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

HeatFlux.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

HeatFlux.GroupSimilarObjects()

Run the GroupSimilarObjects action.

HeatFlux.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

HeatFlux.PropertyByName(name: str)

Get a property by its unique name.

HeatFlux.RemoveParameter(propName: str)

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

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

Sets whether the heat flux is active at the specified load step.

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

SetComponentActivateAtLoadStep method.