HeatFlow

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.BoundaryConditions.HeatFlow

Bases: object

Defines a HeatFlow.

Overview

Methods

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	GetActivateAtLoadStep method.
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	SetActivateAtLoadStep method.
SetComponentActivateAtLoadStep	SetComponentActivateAtLoadStep method.

Properties

Children	Gets the list of children.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
DefineAs	Gets or sets the DefineAs.
Figures	Gets the list of associated figures.
Images	Gets the list of associated images.
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.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property HeatFlow.DefineAs: Ansys.Mechanical.DataModel.Enums.LoadVariationType | None

Gets or sets the DefineAs.

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

Gets the list of associated figures.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

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

Gets the Magnitude.

property HeatFlow.NumberOfSegments: int | None

Gets or sets the NumberOfSegments.

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

Gets the list of properties for this object.

property HeatFlow.ReadOnly: bool | None

Gets or sets the ReadOnly.

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

Gets or sets the SharedRefBody.

property HeatFlow.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

Method detail

HeatFlow.Activate() → None

Activate the current object.

HeatFlow.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

HeatFlow.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

HeatFlow.AddImage(filePath: str) → Ansys.ACT.Automation.Mechanical.Image

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.

HeatFlow.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

HeatFlow.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

HeatFlow.Delete() → None

Run the Delete action.

HeatFlow.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

HeatFlow.GetActivateAtLoadStep(stepNumber: int) → bool

GetActivateAtLoadStep method.

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

Gets the list of children, filtered by type.

HeatFlow.GetComponentActivateAtLoadStep(component: str, stepNumber: int) → bool

GetComponentActivateAtLoadStep method.

HeatFlow.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

HeatFlow.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

HeatFlow.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

HeatFlow.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

HeatFlow.PropertyByAPIName(name: str) → Ansys.ACT.Automation.Mechanical.Property

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.

HeatFlow.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

HeatFlow.RemoveParameter(propName: str) → None

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

HeatFlow.SetActivateAtLoadStep(stepNumber: int, bActive: bool) → None

SetActivateAtLoadStep method.

HeatFlow.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool) → None

SetComponentActivateAtLoadStep method.