TemperatureProbe#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.ProbeResults.TemperatureProbe#

Bases: object

Defines a TemperatureProbe.

Overview#

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.

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.

MaximumTemperature

Gets the MaximumTemperature.

MaximumTotal

Gets the MaximumTotal.

MaximumXAxis

Gets the MaximumXAxis.

MaximumYAxis

Gets the MaximumYAxis.

MaximumZAxis

Gets the MaximumZAxis.

MeshConnectionSelection

Gets or sets the MeshConnectionSelection.

MinimumTemperature

Gets the MinimumTemperature.

MinimumTotal

Gets the MinimumTotal.

MinimumXAxis

Gets the MinimumXAxis.

MinimumYAxis

Gets the MinimumYAxis.

MinimumZAxis

Gets the MinimumZAxis.

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.

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.

Temperature

Gets the Temperature.

Time

Gets the Time.

Total

Gets the Total.

Type

Gets the Type.

VisibleProperties

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

XAxis

Gets the XAxis.

XCoordinate

Gets the XCoordinate.

YAxis

Gets the YAxis.

YCoordinate

Gets the YCoordinate.

ZAxis

Gets the ZAxis.

ZCoordinate

Gets the ZCoordinate.

Property detail#

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

Gets or sets the BeamSelection.

property TemperatureProbe.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 TemperatureProbe.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ContactRegionSelection.

property TemperatureProbe.CoordinateSystemSelection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the CoordinateSystemSelection.

property TemperatureProbe.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property TemperatureProbe.DisplayTime: Ansys.Core.Units.Quantity | None#

Gets or sets the DisplayTime.

property TemperatureProbe.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

property TemperatureProbe.GeometryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

property TemperatureProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None#

Gets the internal object. For advanced usage only.

property TemperatureProbe.IsSolved: bool | None#

Gets the IsSolved.

property TemperatureProbe.IterationNumber: int | None#

Gets the IterationNumber.

property TemperatureProbe.LoadStep: int | None#

Gets the LoadStep.

property TemperatureProbe.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

property TemperatureProbe.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None#

Gets or sets the LocationMethod.

property TemperatureProbe.MaximumTemperature: Ansys.Core.Units.Quantity | None#

Gets the MaximumTemperature.

property TemperatureProbe.MaximumTotal: Ansys.Core.Units.Quantity | None#

Gets the MaximumTotal.

property TemperatureProbe.MaximumXAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumXAxis.

property TemperatureProbe.MaximumYAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumYAxis.

property TemperatureProbe.MaximumZAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumZAxis.

property TemperatureProbe.MeshConnectionSelection: Ansys.ACT.Automation.Mechanical.MeshConnection | None#

Gets or sets the MeshConnectionSelection.

property TemperatureProbe.MinimumTemperature: Ansys.Core.Units.Quantity | None#

Gets the MinimumTemperature.

property TemperatureProbe.MinimumTotal: Ansys.Core.Units.Quantity | None#

Gets the MinimumTotal.

property TemperatureProbe.MinimumXAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumXAxis.

property TemperatureProbe.MinimumYAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumYAxis.

property TemperatureProbe.MinimumZAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumZAxis.

property TemperatureProbe.Orientation: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

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

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

Gets the list of properties for this object.

property TemperatureProbe.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None#

Gets or sets the RemotePointSelection.

property TemperatureProbe.ResultSelection: Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None#

Gets or sets the ResultSelection.

property TemperatureProbe.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None#

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property TemperatureProbe.Substep: int | None#

Gets the Substep.

property TemperatureProbe.Summation: Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None#

Gets or sets the Summation.

property TemperatureProbe.Suppressed: bool | None#

Gets or sets the Suppressed.

property TemperatureProbe.SurfaceSelection: Ansys.ACT.Automation.Mechanical.Surface | None#

Gets or sets the MeshConnectionSelection.

property TemperatureProbe.Temperature: Ansys.Core.Units.Quantity | None#

Gets the Temperature.

property TemperatureProbe.Time: Ansys.Core.Units.Quantity | None#

Gets the Time.

property TemperatureProbe.Total: Ansys.Core.Units.Quantity | None#

Gets the Total.

property TemperatureProbe.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None#

Gets the Type.

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

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

property TemperatureProbe.XAxis: Ansys.Core.Units.Quantity | None#

Gets the XAxis.

property TemperatureProbe.XCoordinate: Ansys.Core.Units.Quantity | None#

Gets the XCoordinate.

property TemperatureProbe.YAxis: Ansys.Core.Units.Quantity | None#

Gets the YAxis.

property TemperatureProbe.YCoordinate: Ansys.Core.Units.Quantity | None#

Gets the YCoordinate.

property TemperatureProbe.ZAxis: Ansys.Core.Units.Quantity | None#

Gets the ZAxis.

property TemperatureProbe.ZCoordinate: Ansys.Core.Units.Quantity | None#

Gets the ZCoordinate.

Method detail#

TemperatureProbe.Activate() None#

Activate the current object.

TemperatureProbe.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

TemperatureProbe.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

TemperatureProbe.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.
TemperatureProbe.ClearGeneratedData() None#

Run the ClearGeneratedData action.

TemperatureProbe.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

TemperatureProbe.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

TemperatureProbe.Delete() None#

Run the Delete action.

TemperatureProbe.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

TemperatureProbe.DuplicateWithoutResults() Ansys.ACT.Automation.Mechanical.DataModelObject#

Run the DuplicateWithoutResults action.

TemperatureProbe.EvaluateAllResults() None#

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

TemperatureProbe.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

TemperatureProbe.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

TemperatureProbe.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

TemperatureProbe.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.
TemperatureProbe.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

TemperatureProbe.RemoveParameter(propName: str) None#

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

TemperatureProbe.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.

TemperatureProbe.SnapToMeshNodes() None#

Snap the coordinates of probe result to the mesh nodes.