ThermalCondition

class ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.BoundaryConditions.ThermalCondition(internalObject: Any)

Bases: object

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.
CreateObjRef	CreateObjRef method.
CreateParameter	CreateParameter method.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetActivateAtLoadStep	Gets whether the thermal condition is active at the specified load step.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetComponentActivateAtLoadStep	GetComponentActivateAtLoadStep method.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	RemoveParameter method.
SetActivateAtLoadStep	Sets whether the thermal condition is active at the specified load step.
SetComponentActivateAtLoadStep	SetComponentActivateAtLoadStep method.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
IndependentVariable	Gets or sets the IndependentVariable.
InternalObject	InternalObject property.
LoadVectorAssignment	Gets or sets the LoadVectorAssignment.
LoadVectorNumber	Gets or sets the LoadVectorNumber.
Location	Gets or sets the Location.
Magnitude	Gets or sets the Magnitude.
Name	Name property.
NumberOfSegments	Gets or sets the NumberOfSegments.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
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.
State	State property.
Suppressed	Gets or sets the Suppressed.
TableAssignment	Gets or sets the TableAssignment.
TransferableObjectId	TransferableObjectId property.
VisibleProperties	Gets the list of properties that are visible for this object.
XYZFunctionCoordinateSystem	Gets or sets the XYZFunctionCoordinateSystem.

Property detail

property ThermalCondition.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property ThermalCondition.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property ThermalCondition.DefineBy: Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None

Gets the DefineBy.

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

Gets the list of associated figures.

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

Gets or sets the GraphControlsXAxis.

property ThermalCondition.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property ThermalCondition.IconName: str | None

IconName property.

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

Gets the list of associated images.

property ThermalCondition.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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

Gets or sets the IndependentVariable.

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

InternalObject property.

property ThermalCondition.LoadVectorAssignment: Ansys.Mechanical.DataModel.Enums.LoadVectorAssignment | None

Gets or sets the LoadVectorAssignment.

property ThermalCondition.LoadVectorNumber: int | None

Gets or sets the LoadVectorNumber.

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

Gets or sets the Location.

property ThermalCondition.Magnitude: Any | None

Gets or sets the Magnitude.

property ThermalCondition.Name: str | None

Name property.

property ThermalCondition.NumberOfSegments: int | None

Gets or sets the NumberOfSegments.

property ThermalCondition.ObjectId: int | None

ObjectId property.

property ThermalCondition.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property ThermalCondition.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property ThermalCondition.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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

Gets the list of properties for this object.

property ThermalCondition.RangeMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the RangeMaximum.

property ThermalCondition.RangeMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the RangeMinimum.

property ThermalCondition.ReadOnly: bool | None

Gets or sets the ReadOnly.

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

Gets or sets the SharedRefBody.

property ThermalCondition.ShellFace: Ansys.Mechanical.DataModel.Enums.ShellFaceType | None

Gets or sets the ShellFace.

property ThermalCondition.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property ThermalCondition.Suppressed: bool | None

Gets or sets the Suppressed.

property ThermalCondition.TableAssignment: Ansys.ACT.Automation.Mechanical.Table | None

Gets or sets the TableAssignment.

property ThermalCondition.TransferableObjectId: str | None

TransferableObjectId property.

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

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

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

Gets or sets the XYZFunctionCoordinateSystem.

Method detail

ThermalCondition.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

ThermalCondition.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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

CreateParameter method.

ThermalCondition.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

ThermalCondition.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

ThermalCondition.GetAPIName(dispId: int) → str

Property name bound to dispId.

ThermalCondition.GetActivateAtLoadStep(stepNumber: int) → bool

Gets whether the thermal condition is active at the specified load step.

ThermalCondition.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetComponentActivateAtLoadStep method.

ThermalCondition.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

ThermalCondition.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

ThermalCondition.GetHashCode() → int

GetHashCode method.

ThermalCondition.GetIconFile() → System.Byte

GetIconFile method.

ThermalCondition.GetLifetimeService() → Any

GetLifetimeService method.

ThermalCondition.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

ThermalCondition.GetPath() → str

GetPath method.

ThermalCondition.GetPropertyName(dispId: int) → str

GetPropertyName method.

ThermalCondition.GetPropertyValue(name: str) → Any

GetPropertyValue method.

ThermalCondition.GetType() → type

GetType method.

ThermalCondition.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

ThermalCondition.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

ThermalCondition.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

ThermalCondition.InitializeLifetimeService() → Any

InitializeLifetimeService method.

ThermalCondition.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

ThermalCondition.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

Run the PromoteToNamedSelection action.

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

ThermalCondition.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

ThermalCondition.RemoveParameter(propName: str) → None

RemoveParameter method.

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

Sets whether the thermal condition is active at the specified load step.

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

SetComponentActivateAtLoadStep method.

ThermalCondition.ToString() → str

ToString method.