Skip to main content

Mechanical scripting interface

HeatFluxProbe

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.ProbeResults.HeatFluxProbe

Bases: object

Defines a HeatFluxProbe.

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.
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.
DuplicateWithoutResults Run the DuplicateWithoutResults action.
EvaluateAllResults Run the EvaluateAllResults action.
ExportAnimation Run the ExportAnimation action.
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.
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.
RenameBasedOnDefinition Run the RenameBasedOnDefinition action.
SnapToMeshNodes Snap the coordinates of probe result to the mesh nodes.

Properties

Name Description
BeamSelection Gets or sets the BeamSelection.
BoundaryConditionSelection Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.
Children Gets the list of children.
Comments Gets the list of associated comments.
ContactRegionSelection Gets or sets the ContactRegionSelection.
CoordinateSystemSelection Gets or sets the CoordinateSystemSelection.
DataModelObjectCategory Gets the current DataModelObject’s category.
DisplayTime Gets or sets the DisplayTime.
DpfEvaluation Gets or sets the DpfEvaluation.
Figures Gets the list of associated figures.
GeometryLocation Gets or sets the GeometryLocation.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
IsSolved Gets the IsSolved.
IterationNumber Gets the IterationNumber.
LoadStep Gets the LoadStep.
LoadStepNumber Gets or sets the LoadStepNumber.
LocationMethod Gets or sets the LocationMethod.
MaximumTotal Gets the MaximumTotal.
MaximumTotalHeatFlux Gets the MaximumTotalHeatFlux.
MaximumXAxis Gets the MaximumXAxis.
MaximumXAxisHeatFlux Gets the MaximumXAxisHeatFlux.
MaximumYAxis Gets the MaximumYAxis.
MaximumYAxisHeatFlux Gets the MaximumYAxisHeatFlux.
MaximumZAxis Gets the MaximumZAxis.
MaximumZAxisHeatFlux Gets the MaximumZAxisHeatFlux.
MeshConnectionSelection Gets or sets the MeshConnectionSelection.
MinimumTotal Gets the MinimumTotal.
MinimumTotalHeatFlux Gets the MinimumTotalHeatFlux.
MinimumXAxis Gets the MinimumXAxis.
MinimumXAxisHeatFlux Gets the MinimumXAxisHeatFlux.
MinimumYAxis Gets the MinimumYAxis.
MinimumYAxisHeatFlux Gets the MinimumYAxisHeatFlux.
MinimumZAxis Gets the MinimumZAxis.
MinimumZAxisHeatFlux Gets the MinimumZAxisHeatFlux.
Orientation Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.
Properties Gets the list of properties for this object.
RPMSelection Gets or sets the RPM Selection value at which the results are evaluated.
RemotePointSelection Gets or sets the RemotePointSelection.
ResultSelection Gets or sets the ResultSelection.
SpatialResolution Gets or sets the SpatialResolution.
SpringSelection Gets or sets the SpringSelection.
Substep Gets the Substep.
Summation Gets or sets the Summation.
Suppressed Gets or sets the Suppressed.
SurfaceSelection Gets or sets the MeshConnectionSelection.
Time Gets the Time.
Total Gets the Total.
TotalHeatFlux Gets the TotalHeatFlux.
Type Gets the Type.
VisibleProperties Gets the list of properties that are visible for this object.
XAxis Gets the XAxis.
XAxisHeatFlux Gets the XAxisHeatFlux.
XCoordinate Gets the XCoordinate.
YAxis Gets the YAxis.
YAxisHeatFlux Gets the YAxisHeatFlux.
YCoordinate Gets the YCoordinate.
ZAxis Gets the ZAxis.
ZAxisHeatFlux Gets the ZAxisHeatFlux.
ZCoordinate Gets the ZCoordinate.

Property detail

property HeatFluxProbe.BeamSelection : Ansys.ACT.Automation.Mechanical.Connections.Beam | None

Gets or sets the BeamSelection.

property HeatFluxProbe.BoundaryConditionSelection : Ansys.ACT.Automation.Mechanical.DataModelObject | None

Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.

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

Gets the list of children.

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

Gets the list of associated comments.

property HeatFluxProbe.ContactRegionSelection : Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None

Gets or sets the ContactRegionSelection.

property HeatFluxProbe.CoordinateSystemSelection : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystemSelection.

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

Gets the current DataModelObject’s category.

property HeatFluxProbe.DisplayTime : Ansys.Core.Units.Quantity | None

Gets or sets the DisplayTime.

property HeatFluxProbe.DpfEvaluation : Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

property HeatFluxProbe.GeometryLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

property HeatFluxProbe.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None

Gets the internal object. For advanced usage only.

property HeatFluxProbe.IsSolved : bool | None

Gets the IsSolved.

property HeatFluxProbe.IterationNumber : int | None

Gets the IterationNumber.

property HeatFluxProbe.LoadStep : int | None

Gets the LoadStep.

property HeatFluxProbe.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

property HeatFluxProbe.LocationMethod : Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None

Gets or sets the LocationMethod.

property HeatFluxProbe.MaximumTotal : Ansys.Core.Units.Quantity | None

Gets the MaximumTotal.

property HeatFluxProbe.MaximumTotalHeatFlux : Ansys.Core.Units.Quantity | None

Gets the MaximumTotalHeatFlux.

property HeatFluxProbe.MaximumXAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumXAxis.

property HeatFluxProbe.MaximumXAxisHeatFlux : Ansys.Core.Units.Quantity | None

Gets the MaximumXAxisHeatFlux.

property HeatFluxProbe.MaximumYAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumYAxis.

property HeatFluxProbe.MaximumYAxisHeatFlux : Ansys.Core.Units.Quantity | None

Gets the MaximumYAxisHeatFlux.

property HeatFluxProbe.MaximumZAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumZAxis.

property HeatFluxProbe.MaximumZAxisHeatFlux : Ansys.Core.Units.Quantity | None

Gets the MaximumZAxisHeatFlux.

property HeatFluxProbe.MeshConnectionSelection : Ansys.ACT.Automation.Mechanical.MeshConnection | None

Gets or sets the MeshConnectionSelection.

property HeatFluxProbe.MinimumTotal : Ansys.Core.Units.Quantity | None

Gets the MinimumTotal.

property HeatFluxProbe.MinimumTotalHeatFlux : Ansys.Core.Units.Quantity | None

Gets the MinimumTotalHeatFlux.

property HeatFluxProbe.MinimumXAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumXAxis.

property HeatFluxProbe.MinimumXAxisHeatFlux : Ansys.Core.Units.Quantity | None

Gets the MinimumXAxisHeatFlux.

property HeatFluxProbe.MinimumYAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumYAxis.

property HeatFluxProbe.MinimumYAxisHeatFlux : Ansys.Core.Units.Quantity | None

Gets the MinimumYAxisHeatFlux.

property HeatFluxProbe.MinimumZAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumZAxis.

property HeatFluxProbe.MinimumZAxisHeatFlux : Ansys.Core.Units.Quantity | None

Gets the MinimumZAxisHeatFlux.

property HeatFluxProbe.Orientation : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.

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

Gets the list of properties for this object.

property HeatFluxProbe.RPMSelection : Ansys.Core.Units.Quantity | None

Gets or sets the RPM Selection value at which the results are evaluated.

property HeatFluxProbe.RemotePointSelection : Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePointSelection.

property HeatFluxProbe.ResultSelection : Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None

Gets or sets the ResultSelection.

property HeatFluxProbe.SpatialResolution : Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None

Gets or sets the SpatialResolution.

property HeatFluxProbe.SpringSelection : Ansys.ACT.Automation.Mechanical.Connections.Spring | None

Gets or sets the SpringSelection.

property HeatFluxProbe.Substep : int | None

Gets the Substep.

property HeatFluxProbe.Summation : Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None

Gets or sets the Summation.

property HeatFluxProbe.Suppressed : bool | None

Gets or sets the Suppressed.

property HeatFluxProbe.SurfaceSelection : Ansys.ACT.Automation.Mechanical.Surface | None

Gets or sets the MeshConnectionSelection.

property HeatFluxProbe.Time : Ansys.Core.Units.Quantity | None

Gets the Time.

property HeatFluxProbe.Total : Ansys.Core.Units.Quantity | None

Gets the Total.

property HeatFluxProbe.TotalHeatFlux : Ansys.Core.Units.Quantity | None

Gets the TotalHeatFlux.

property HeatFluxProbe.Type : Ansys.Mechanical.DataModel.Enums.ProbeResultType | None

Gets the Type.

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

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

property HeatFluxProbe.XAxis : Ansys.Core.Units.Quantity | None

Gets the XAxis.

property HeatFluxProbe.XAxisHeatFlux : Ansys.Core.Units.Quantity | None

Gets the XAxisHeatFlux.

property HeatFluxProbe.XCoordinate : Ansys.Core.Units.Quantity | None

Gets the XCoordinate.

property HeatFluxProbe.YAxis : Ansys.Core.Units.Quantity | None

Gets the YAxis.

property HeatFluxProbe.YAxisHeatFlux : Ansys.Core.Units.Quantity | None

Gets the YAxisHeatFlux.

property HeatFluxProbe.YCoordinate : Ansys.Core.Units.Quantity | None

Gets the YCoordinate.

property HeatFluxProbe.ZAxis : Ansys.Core.Units.Quantity | None

Gets the ZAxis.

property HeatFluxProbe.ZAxisHeatFlux : Ansys.Core.Units.Quantity | None

Gets the ZAxisHeatFlux.

property HeatFluxProbe.ZCoordinate : Ansys.Core.Units.Quantity | None

Gets the ZCoordinate.

Method detail

HeatFluxProbe.Activate()

Activate the current object.

HeatFluxProbe.AddComment()

Creates a new child Comment.

HeatFluxProbe.AddFigure()

Creates a new child Figure.

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

HeatFluxProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

HeatFluxProbe.CreateParameter(propName: str)

Creates a new parameter for a Property.

HeatFluxProbe.Delete()

Run the Delete action.

HeatFluxProbe.Duplicate()

Creates a copy of the current DataModelObject.

HeatFluxProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

HeatFluxProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

HeatFluxProbe.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings)

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

HeatFluxProbe.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

HeatFluxProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

HeatFluxProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

HeatFluxProbe.PropertyByName(name: str)

Get a property by its unique name.

HeatFluxProbe.RemoveParameter(propName: str)

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

HeatFluxProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

HeatFluxProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.