Temperature#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.Temperature#

Bases: object

Defines a Temperature.

Overview#

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.

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.

ApplyToEntireBody

Gets or sets the ApplyToEntireBody.

Children

Gets the list of children.

Comments

Gets the list of associated comments.

DataModelObjectCategory

Gets the current DataModelObject's category.

DefineBy

Gets the DefineBy.

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.

RangeMaximum

Gets or sets the RangeMaximum.

RangeMinimum

Gets or sets the RangeMinimum.

ReadOnly

Gets or sets the ReadOnly.

SharedRefBody

Gets or sets the SharedRefBody.

ShellFace

Gets or sets the ShellFace.

Suppressed

Gets or sets the Suppressed.

TableAssignment

Gets or sets the TableAssignment.

VisibleProperties

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

XYZFunctionCoordinateSystem

Gets or sets the XYZFunctionCoordinateSystem.

Property detail#

property Temperature.ApplyToEntireBody: bool | None#

Gets or sets the ApplyToEntireBody.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property Temperature.DefineBy: Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None#

Gets the DefineBy.

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

Gets the list of associated figures.

property Temperature.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None#

Gets or sets the GraphControlsXAxis.

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

Gets the list of associated images.

property Temperature.IndependentVariable: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None#

Gets or sets the IndependentVariable.

property Temperature.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None#

Gets the internal object. For advanced usage only.

property Temperature.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

property Temperature.Magnitude: Ansys.ACT.Mechanical.Fields.Field | None#

Gets the Magnitude.

property Temperature.NumberOfSegments: int | None#

Gets or sets the NumberOfSegments.

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

Gets the list of properties for this object.

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

Gets or sets the RangeMaximum.

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

Gets or sets the RangeMinimum.

property Temperature.ReadOnly: bool | None#

Gets or sets the ReadOnly.

property Temperature.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None#

Gets or sets the SharedRefBody.

property Temperature.ShellFace: Ansys.Mechanical.DataModel.Enums.ShellFaceType | None#

Gets or sets the ShellFace.

property Temperature.Suppressed: bool | None#

Gets or sets the Suppressed.

property Temperature.TableAssignment: Ansys.ACT.Automation.Mechanical.Table | None#

Gets or sets the TableAssignment.

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

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

property Temperature.XYZFunctionCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the XYZFunctionCoordinateSystem.

Method detail#

Temperature.Activate() None#

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

Temperature.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.
Temperature.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

Temperature.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

Temperature.GetActivateAtLoadStep(stepNumber: int) bool#

GetActivateAtLoadStep method.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

Temperature.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Temperature.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#

Run the PromoteToNamedSelection action.

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

Get a property by its unique name.

Temperature.RemoveParameter(propName: str) None#

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

Temperature.SetActivateAtLoadStep(stepNumber: int, bActive: bool) None#

SetActivateAtLoadStep method.