HeatFlow
#
- class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.BoundaryConditions.HeatFlow#
Bases:
object
Defines a HeatFlow.
Overview#
|
GetActivateAtLoadStep method. |
|
SetActivateAtLoadStep method. |
|
GetComponentActivateAtLoadStep method. |
|
SetComponentActivateAtLoadStep method. |
|
Run the PromoteToNamedSelection action. |
|
Run the Delete action. |
|
Gets the list of children, filtered by type. |
|
Gets the list of children, filtered by type. |
|
Creates a new child Comment. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Activate the current object. |
|
Copies all visible properties from this object to another. |
|
Creates a copy of the current DataModelObject. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Get a property by its unique name. |
|
Get a property by its API name. |
|
Creates a new parameter for a Property. |
|
Gets the parameter corresponding to the given property. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Gets the internal object. For advanced usage only. |
|
Gets or sets the NumberOfSegments. |
|
Gets the Magnitude. |
|
Gets or sets the DefineAs. |
|
Gets or sets the Location. |
|
Gets the current DataModelObject’s category. |
|
Gets or sets the Suppressed. |
|
Gets or sets the SharedRefBody. |
|
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets the list of associated figures. |
|
Gets the list of associated images. |
|
Gets or sets the ReadOnly. |
|
Gets the internal object. For advanced usage only. |
|
Gets the list of properties for this object. |
|
Gets the list of properties that are visible for this object. |
Property detail#
- property HeatFlow.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None
Gets the internal object. For advanced usage only.
- property HeatFlow.NumberOfSegments: System.Int32 | None
Gets or sets the NumberOfSegments.
- property HeatFlow.Magnitude: Ansys.ACT.Mechanical.Fields.Field | None
Gets the Magnitude.
- property HeatFlow.DefineAs: Ansys.Mechanical.DataModel.Enums.LoadVariationType | None
Gets or sets the DefineAs.
- property HeatFlow.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
- property HeatFlow.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
- property HeatFlow.Suppressed: System.Boolean | None
Gets or sets the Suppressed.
- property HeatFlow.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None
Gets or sets the SharedRefBody.
- property HeatFlow.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
- property HeatFlow.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
- property HeatFlow.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
- property HeatFlow.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
- property HeatFlow.ReadOnly: System.Boolean | None
Gets or sets the ReadOnly.
- property HeatFlow.InternalObject: System.Object | None
Gets the internal object. For advanced usage only.
- property HeatFlow.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
- property HeatFlow.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail#
- HeatFlow.GetActivateAtLoadStep(stepNumber: System.UInt32) System.Boolean
GetActivateAtLoadStep method.
- HeatFlow.SetActivateAtLoadStep(stepNumber: System.UInt32, bActive: System.Boolean) System.Void
SetActivateAtLoadStep method.
- HeatFlow.GetComponentActivateAtLoadStep(component: System.String, stepNumber: System.UInt32) System.Boolean
GetComponentActivateAtLoadStep method.
- HeatFlow.SetComponentActivateAtLoadStep(component: System.String, stepNumber: System.UInt32, bActive: System.Boolean) System.Void
SetComponentActivateAtLoadStep method.
- HeatFlow.PromoteToNamedSelection() System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]
Run the PromoteToNamedSelection action.
- HeatFlow.Delete() System.Void
Run the Delete action.
- HeatFlow.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) System.Collections.Generic.IList[ChildrenType]
Gets the list of children, filtered by type.
- HeatFlow.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]
Gets the list of children, filtered by type.
- 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: System.String) 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.Activate() System.Void
Activate the current object.
- HeatFlow.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) System.Void
Copies all visible properties from this object to another.
- HeatFlow.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject
Creates a copy of the current DataModelObject.
- HeatFlow.GroupAllSimilarChildren() System.Void
Run the GroupAllSimilarChildren action.
- HeatFlow.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder
Run the GroupSimilarObjects action.
- HeatFlow.PropertyByName(name: System.String) Ansys.ACT.Automation.Mechanical.Property
Get a property by its unique name.
- HeatFlow.PropertyByAPIName(name: System.String) 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.CreateParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter
Creates a new parameter for a Property.
- HeatFlow.GetParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter
Gets the parameter corresponding to the given property.
- HeatFlow.RemoveParameter(propName: System.String) System.Void
Removes the parameter from the parameter set corresponding to the given property.