Convection
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.Convection#
Bases:
object
Defines a Convection.
Overview#
Activate the current object. |
|
Creates a new child Comment. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Copies all visible properties from this object to another. |
|
Creates a new parameter for a Property. |
|
Run the Delete action. |
|
Creates a copy of the current DataModelObject. |
|
GetActivateAtLoadStep method. |
|
Gets the list of children, filtered by type. |
|
GetComponentActivateAtLoadStep method. |
|
Gets the parameter corresponding to the given property. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Run the PromoteToNamedSelection action. |
|
Get a property by its API name. |
|
Get a property by its unique name. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
SetActivateAtLoadStep method. |
|
SetComponentActivateAtLoadStep method. |
Gets the AmbientTemperature. |
|
Gets the list of children. |
|
Gets or sets the CoefficientType. |
|
Gets the list of associated comments. |
|
Gets or sets the ConvectionMatrix. |
|
Gets the current DataModelObject's category. |
|
Gets or sets the DisplayConnectionLines. |
|
Gets or sets the EditDataFor. |
|
Gets the list of associated figures. |
|
Gets the FilmCoefficient. |
|
Gets or sets the FluidFlowEdge. |
|
Gets or sets the FluidFlowSelection. |
|
Gets or sets the GraphControlsXAxis. |
|
Gets or sets the HasFluidFlow. |
|
Gets the list of associated images. |
|
Gets or sets the IndependentVariable. |
|
Gets the internal object. For advanced usage only. |
|
Gets or sets the Location. |
|
Gets or sets the NumberOfSegments. |
|
Gets the list of properties for this object. |
|
Gets or sets the RangeMaximum. |
|
Gets or sets the RangeMinimum. |
|
Gets or sets the ReadOnly. |
|
Gets or sets the SharedRefBody. |
|
Gets or sets the Suppressed. |
|
Gets the list of properties that are visible for this object. |
|
Gets or sets the XYZFunctionCoordinateSystem. |
Property detail#
- property Convection.AmbientTemperature: Ansys.ACT.Mechanical.Fields.Field | None#
Gets the AmbientTemperature.
- property Convection.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#
Gets the list of children.
- property Convection.CoefficientType: Ansys.Mechanical.DataModel.Enums.LoadVariationSubOption | None#
Gets or sets the CoefficientType.
- property Convection.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#
Gets the list of associated comments.
- property Convection.ConvectionMatrix: Ansys.Mechanical.DataModel.Enums.DiagonalOrConsistent | None#
Gets or sets the ConvectionMatrix.
- property Convection.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#
Gets the current DataModelObject's category.
- property Convection.EditDataFor: Ansys.Mechanical.DataModel.Enums.ConvectionTableSelection | None#
Gets or sets the EditDataFor.
- property Convection.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#
Gets the list of associated figures.
- property Convection.FilmCoefficient: Ansys.ACT.Mechanical.Fields.Field | None#
Gets the FilmCoefficient.
- property Convection.FluidFlowEdge: Ansys.ACT.Automation.Mechanical.NamedSelection | None#
Gets or sets the FluidFlowEdge.
- property Convection.FluidFlowSelection: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#
Gets or sets the FluidFlowSelection.
- property Convection.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None#
Gets or sets the GraphControlsXAxis.
- property Convection.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#
Gets the list of associated images.
- property Convection.IndependentVariable: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None#
Gets or sets the IndependentVariable.
- property Convection.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None#
Gets the internal object. For advanced usage only.
- property Convection.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#
Gets or sets the Location.
- property Convection.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#
Gets the list of properties for this object.
Gets or sets the SharedRefBody.
- property Convection.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#
Gets the list of properties that are visible for this object.
- property Convection.XYZFunctionCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#
Gets or sets the XYZFunctionCoordinateSystem.
Method detail#
- 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: 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.
- Convection.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None #
Copies all visible properties from this object to another.
- Convection.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter #
Creates a new parameter for a Property.
- Convection.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject #
Creates a copy of the current DataModelObject.
- Convection.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType] #
Gets the list of children, filtered by type.
- Convection.GetComponentActivateAtLoadStep(component: str, stepNumber: int) bool #
GetComponentActivateAtLoadStep method.
- Convection.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter #
Gets the parameter corresponding to the given property.
- Convection.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder #
Run the GroupSimilarObjects action.
- Convection.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection] #
Run the PromoteToNamedSelection action.
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.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property #
Get a property by its unique name.
- Convection.RemoveParameter(propName: str) None #
Removes the parameter from the parameter set corresponding to the given property.