`Convection`#

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

Bases: object

Defines a Convection.

Overview#

Methods

`GetActivateAtLoadStep`	GetActivateAtLoadStep method.
`SetActivateAtLoadStep`	SetActivateAtLoadStep method.
`GetComponentActivateAtLoadStep`	GetComponentActivateAtLoadStep method.
`SetComponentActivateAtLoadStep`	SetComponentActivateAtLoadStep method.
`PromoteToNamedSelection`	Run the PromoteToNamedSelection action.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`FluidFlowEdge`	Gets or sets the FluidFlowEdge.
`InternalObject`	Gets the internal object. For advanced usage only.
`NumberOfSegments`	Gets or sets the NumberOfSegments.
`FilmCoefficient`	Gets the FilmCoefficient.
`AmbientTemperature`	Gets the AmbientTemperature.
`RangeMaximum`	Gets or sets the RangeMaximum.
`RangeMinimum`	Gets or sets the RangeMinimum.
`CoefficientType`	Gets or sets the CoefficientType.
`ConvectionMatrix`	Gets or sets the ConvectionMatrix.
`EditDataFor`	Gets or sets the EditDataFor.
`GraphControlsXAxis`	Gets or sets the GraphControlsXAxis.
`IndependentVariable`	Gets or sets the IndependentVariable.
`DisplayConnectionLines`	Gets or sets the DisplayConnectionLines.
`HasFluidFlow`	Gets or sets the HasFluidFlow.
`XYZFunctionCoordinateSystem`	Gets or sets the XYZFunctionCoordinateSystem.
`FluidFlowSelection`	Gets or sets the FluidFlowSelection.
`Location`	Gets or sets the Location.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Suppressed`	Gets or sets the Suppressed.
`SharedRefBody`	Gets or sets the SharedRefBody.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`ReadOnly`	Gets or sets the ReadOnly.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property Convection.FluidFlowEdge: Ansys.ACT.Automation.Mechanical.NamedSelection | None: Gets or sets the FluidFlowEdge.

property Convection.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None: Gets the internal object. For advanced usage only.

property Convection.NumberOfSegments: System.Int32 | None: Gets or sets the NumberOfSegments.

property Convection.FilmCoefficient: Ansys.ACT.Mechanical.Fields.Field | None: Gets the FilmCoefficient.

property Convection.AmbientTemperature: Ansys.ACT.Mechanical.Fields.Field | None: Gets the AmbientTemperature.

property Convection.RangeMaximum: Ansys.Core.Units.Quantity | None: Gets or sets the RangeMaximum.

property Convection.RangeMinimum: Ansys.Core.Units.Quantity | None: Gets or sets the RangeMinimum.

property Convection.CoefficientType: Ansys.Mechanical.DataModel.Enums.LoadVariationSubOption | None: Gets or sets the CoefficientType.

property Convection.ConvectionMatrix: Ansys.Mechanical.DataModel.Enums.DiagonalOrConsistent | None: Gets or sets the ConvectionMatrix.

property Convection.EditDataFor: Ansys.Mechanical.DataModel.Enums.ConvectionTableSelection | None: Gets or sets the EditDataFor.

property Convection.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None: Gets or sets the GraphControlsXAxis.

property Convection.IndependentVariable: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None: Gets or sets the IndependentVariable.

property Convection.DisplayConnectionLines: System.Boolean | None: Gets or sets the DisplayConnectionLines.

property Convection.HasFluidFlow: System.Boolean | None: Gets or sets the HasFluidFlow.

property Convection.XYZFunctionCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the XYZFunctionCoordinateSystem.

property Convection.FluidFlowSelection: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the FluidFlowSelection.

property Convection.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property Convection.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property Convection.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property Convection.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None: Gets or sets the SharedRefBody.

property Convection.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property Convection.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property Convection.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property Convection.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property Convection.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property Convection.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property Convection.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property Convection.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

Convection.GetActivateAtLoadStep(stepNumber: System.UInt32) → System.Boolean: GetActivateAtLoadStep method.

Convection.SetActivateAtLoadStep(stepNumber: System.UInt32, bActive: System.Boolean) → System.Void: SetActivateAtLoadStep method.

Convection.GetComponentActivateAtLoadStep(component: System.String, stepNumber: System.UInt32) → System.Boolean: GetComponentActivateAtLoadStep method.

Convection.SetComponentActivateAtLoadStep(component: System.String, stepNumber: System.UInt32, bActive: System.Boolean) → System.Void: SetComponentActivateAtLoadStep method.

Convection.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]: Run the PromoteToNamedSelection action.

Convection.Delete() → System.Void: Run the Delete action.

Convection.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

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

Convection.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

Convection.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

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

Convection.Activate() → System.Void: Activate the current object.

Convection.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

Convection.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

Convection.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

Convection.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

Convection.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

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

Convection.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

Convection.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

Convection.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.